Part Measurements and Generic Codes

DsPrdMeasurementColumn can now be registered for a specific package, and dsUnitConvertFactor(distanceUnit, str) provides string-based measurement conversion alongside the existing enum overload.

Multi-racking framework changes

Rows in the multi-racking framework are now meant to also contain back-to-back layouts. In the normal framework, a back-to-back layout is typically represented with two rows of bays connected with a flue gap row in between them. In the multi-racking framework, they will now be represented with a single row containing a multi-bay of at least two bays facing opposite directions. Due to this, we have added new row layout classes that utilizes a MhMultiRowPopulator instead that can handle different row layouts for the front and back.

public class MhMultiRowLayout extends MhRowLayout { }
public class MhSingleEndMultiRowLayout extends MhMultiRowLayout { }
public class MhSingleAllMultiRowLayout extends MhMultiRowLayout { }
public class MhDoubleAllMultiRowLayout extends MhMultiRowLayout { }

public class MhMultiRowPopulator extends MhRowEntryLayoutPopulator { }

We have also added a new MhMultiRowAnimationInfo to properly calculate the minimum row depth required for a given row layout during insert animation.

public class MhMultiRowAnimationBehavior extends MhRowAnimationBehavior {

    public SnapperAnimationBehaviour snapperAnimationBehavior() {
        return MhMultiRowSnapperAnimationBehavior();
    }
}


public class MhMultiRowSnapperAnimationBehavior extends MhRowSnapperAnimationBehavior {

    public MhRowAnimationInfo rowInfo(Snapper z) {
        return MhMultiRowAnimationInfo();
    }

}

public class MhMultiRowAnimationInfo extends MhRowAnimationInfo { }

Other new behaviors:

MhMultiFrameEngineBehavior
MhMultiRowAnimationEngineBehavior

New engine functions:

MhMultiRowSystemPopulateFunction
MhMultiEntryArrangeFunction
MhMultiLevelConstructionalPopulateFunction

New spawners:

MhFramelineSpawner
MhOuterFramelineSpawner
MhOuterFramelineSpawnerB2B
MhMultiBaySpawner

Added support to constructing spanning levels (levels that belong to the multi-bay) on row insertion through MhMultiLevelConstructionalPopulateFunction. This function "multiLevelConstruction" is meant to replace the generic MhLevelConstructionalPopulateFunction "levelConstruction". The "multiLevelConstruction" function operates on the multi-bay and will construct levels for the multi-bay as well as all the child-bays within the multi-bay.

public class MhMultiLevelConstructionalPopulateFunction extends MhSystemEngineFunction { }

res << MhMultiLevelConstructionalPopulateFunction("multiLevelConstruction");

When constructing levels, for each iteration it will retrieve the next level entry (ideally from a bay entry layout that already contains predefined level information) and inspects the entry's childDepth, a new field introduced in MhEngineLevelConstructionEntryInfo. childDepth identifies which bay does that level entry belong to (multi-bay or child-bay). As an example, with a structure of

Row
|---MultiBay
|   |---Level
|   |---ChildBay
|       |---Level

Levels with a childDepth = 1 will belong to the MultiBay while levels with a childDepth = 2 will belong to the ChildBay. Similar to "levelConstruction", the generated levels will be updated to match the width and depth dimensions of the parent bay.

To properly utilize this new function, you will need to set up level entries with a childDepth assigned to them. Our way of setting this up has been through compartment types and compartment props (introduced as a new feature in 17.0 Major migration guide). The compartment prop has a childDepth() method that defines the child depth of a level. This information is used in MhBaySpawner.entryLayout(MhEntryLayoutEnv env) through MhStorageConfiguration in order to generate level entries for the bay entry layout. The layout is then accessed by "multiLevelConstruction" to look up those generated level entries for the relevant info. For an example implementation, refer to the under development Essential Racking extension (base.custom.materialHandling.products.essentialRack).

Schemes

Added support for prop schemes to work with storage systems. This is an optional feature and there is some overlap in terms of functionality with the Pre Configurator dialog. An example implementation can be found in the Essential Shelving extension Retail Shelving product line, which we use to handle our material properties for that product line instead of in the pre configurator. It allows the user to more quickly apply material changes to existing drawing snappers without worrying about modifying the other properties that can be found in the pre configurator.

Here is what is needed to implement it in your storage system.

1. Add behavior MhSchemeSnapperApplyBehavior or MhSchemeShapeApplyBehavior to spawner, depending on what holds your properties (snapper or shape). This behavior is in charge of pushing and pulling between scheme and snapper/shape.

2. Implement translation between scheme property keys and snapper/shape property keys in order for MhSchemeApplyBehavior to work properly. There are two ways of doing so:

   1. Extend Object lookupValue(str key, Object env=null)in your shape class or extend Object xlookupValue(str key) in your snapper class and handle the case for key cMhSchemeTranslationMapPK. This should return a map, containing both "scheme property key -> snapper/shape property key" and "snapper/shape property key -> scheme property key" cases.

   2. Extend str translateShapePropKey(str propKey) in your snapper or shape class and handle translating each related scheme property key or snapper/shape property key.

3. Subclass MhBasePropsSchemeData. Add the relevant properties as you would a normal scheme. If using shapes, ensure extend MhSnapperShape[] shapes() with instances of shapes that are related to the properties in scheme. If retrieving property domains from the shape, you will need to update str translateSchemePropKey(str key) with the same "scheme property key -> shape property key" translations as well.

4. Extend str propsSchemeSystemKey() in your snapper or shape class to return the same key that is used in your scheme.systemKey().

5. Override void initAfterInstantiate() in your snapper class and call initFromPropsScheme().

MH Debug tools revamp

We have consolidated most of the existing MH debug dialogs into a single dialog. Each of the old dialogs now exist as a window (tab) in the new Debug Dialog.

If you wish to register your own debug window within this dialog, you can do so with void mhRegisterDebugWindow(str cardKey, str cardLabel, function(Window):Window func) and void mhUnregisterDebugWindow(str cardKey).

The existing class MhDebugDialog was used to simply build the debug library toolbox. We have re-used this class to be a proper dialog containing all of the debug tools, while still having the library toolbox on the left part of the dialog.

If you wish to register your own debug library toolbox within this dialog, you can do so with void mhRegisterDebugLibrary(Library lib) and void mhUnregisterDebugLibrary(Library lib).

Additionally, several new debug toggles have been added.

1. Enable Engine Cache - exposes mhEngineCacheEnabled()

This cache is used for a variety of different objects during engine execution (e.g. engine entries, entry layout, spawned snappers, etc).

2. Enable Spawner Behavior Collection Cache - exposes mhSpawnerBehaviorCollCacheEnabled().

Every spawner has a cache statelessCollection of stateless behaviors. Disable this if modifying the behaviors of a spawner to force it to gather new behaviors.

3. Enable Assort. Spawner Cache - exposes mhSpawnerCacheEnabled()

The spawner selector has a cache of classification to spawner. Disable this to force selector to always search for the current best matching spawner, useful when adding/remove spawners or modifying the classification of spawners.

4. Enable Assort. Engine Func Library Cache - exposes mhAssEngineFuncLibCacheEnabled

Every assortment has a cached engine library that is built once and re-used, so engine functions are typically only collected once when the assortment is first constructured. Disable this to always rebuild your assortment's engine library before running the engine. Useful when you have changed the class of an engine function and don't want to modify the cached library or restart your CET instance to refresh the cached library. If utilizing MhAssortment.overrideFunctions, you still need to manually clear it as this toggle doesn't modify that field.

Generic Codes and Base Part XML Export

OFDA exports now include a part's generic code as DiscountCategory and as a UserDefined value with type Generic Code. Measurement and user-defined export hooks are called for all Part objects, allowing non-ProdPart implementations to participate.

OFDA XML 04.02.00 Export Compatibility

The Calculations export option is now labeled OFDA XML Purchase Order 04.02.00, and the generated XML has been updated to follow the element structure and ordering expected by the OFDA 04.02.00 schema.

Extensible Type Elevation Merging

TypeElevation now exposes collectMergers() so extensions can control which split type elevations are combined by mergeAll():

Added: extend public void collectMergers(TypeElevation{} mergers)

The default implementation collects split TypeElevation objects. PanelTypeElevation overrides the method to collect only split PanelTypeElevation objects.

Extensions can override the method when their elevation type needs more specific filtering:

public void collectMergers(TypeElevation{} mergers) {
    for (MyTypeElevation elevation in space.snappers) {
        if (elevation.splitKey) {
            mergers << elevation;
        }
    }
}

Part Dimensions and Special Creation

AbsPart now defines volume(), depth(), height(), and width() as physical measurements in meters. The default value for each method is 0.

ProdPartCreator can now apply option overrides or additions according to its public optionHandling value. The new containsAnySpecials(PropObj) helper checks both part specials and option specials.

Readable Picklist Item Values

PicklistItem._partNo and PicklistItem._qty are now public readable, allowing extensions to inspect a picklist item's part number and quantity without adding subclass accessors.

class LockSnapperPositionInstruction

Emulates Right-click on snapper -> Lock Position. In other words, it calls setLocked() on the specified snapper.

class SetViewOrientationInstruction

Sets the view orientation to for example, front, right, left, back or top. Commonly used in combination with SetViewProjectionInstruction and SwitchToViewInstruction(viewOption.threeD).

class SetViewProjectionInstruction

Sets the view projection to perspective, orthogonal or isometric. Commonly used in combination with SetViewOrientationInstruction and SwitchToViewInstruction(viewOption.threeD).

class ValidateAnimationPropDomainInstruction

Validates that the domain of a specified property in the currently active animation, contains the expected members. Complements the existing ValidateAnimationPropValueInstruction.

Preserving Part Adjustments When Resetting Item Tags

An overload of makeYesNoDialog() now uses FlexDialog and supports a dialog icon and formatted question text:

Added: public int makeYesNoDialog(Window parent, str label, str question,
                                  int defaultButtonNo=1,
                                  dialogIcon icon=dialogIcon.none,
                                  bool formatText=false,
                                  function(Window dialog) positionCallback=null)

UrlField button background brush

UrlField now exposes extend public Brush buttonBgBrush(). Override this method to customize the browse button's background, including hover or selected-state highlighting, without replacing drawUrlButton().