Assign step icons and titles for the Warehouse Management mobile app
This article describes how to assign step icons and step titles for new or customized task flows for the Warehouse Management mobile app.
The following illustrations shows how step icons and titles appear in the Warehouse Management mobile app.
Turn this feature on or off
To use the functionality described in this article, the User settings, icons, and step titles for the new warehouse app feature must be turned on for your system. As of Supply Chain Management 10.0.25, this feature is mandatory and can't be turned off. If you're running a version older than 10.0.25, then admins can turn this functionality on or off by searching for the User settings, icons, and step titles for the new warehouse app feature in the Feature management workspace.
Standard step IDs, classes, and icons
Each step in a task flow is identified by a step ID, and each step ID has a corresponding step class. The step icon and title are specified in each step class.
Step IDs and step classes
The following table lists every step ID that is currently available, and its corresponding step class. The control name of the primary input field is used as the step ID.
For an example that shows how these step IDs and classes are used, see the implementation of the WHSMobileAppStepInfoBuilder.stepId() method in the Example: Assign step icons and titles for a custom flow section later in this article.
| Step ID | Step Class |
|---|---|
| BatchDisposition | WHSMobileAppStepBatchDisposition |
| Carrier | WHSMobileAppStepCarrier |
| CatchWeight | WHSMobileAppStepCatchWeight |
| CatchWeightQtyOutboundWeight | WHSMobileAppStepCatchWeight |
| CatchWeightTag | WHSMobileAppStepCatchWeightTag |
| CatchWeightTagWeight | WHSMobileAppStepCatchWeightTagWeight |
| ChangeWarehouseSuccess | WHSMobileAppStepChangeWarehouseSuccess |
| CheckDigit | WHSMobileAppStepCheckDigit |
| ClusterId | WHSMobileAppStepClusterId |
| ClusterPickQtyVerification | WHSMobileAppStepQtyVerification |
| ClusterPosition | WHSMobileAppStepClusterPosition |
| ConfigId | WHSMobileAppStepConfigId |
| Confirmation | WHSMobileAppStepConfirmation |
| ConsolidateFromLicensePlateId | WHSMobileAppStepConsolidateFromLicensePlateId |
| ConsolidateLPConfirmation | WHSMobileAppStepConsolidateLPConfirmation |
| ConsolidateToLicensePlateId | WHSMobileAppStepConsolidateToLicensePlateId |
| ContainerType | WHSMobileAppStepContainerType |
| CountingReasonCode | WHSMobileAppStepCountingReasonCode |
| CycleCountingAddLPOrFinish | WHSMobileAppStepCycleCountingAddLPOrFinish |
| CycleCountQty1 | WHSMobileAppStepCycleCountQty |
| CycleCountQty2 | WHSMobileAppStepCycleCountQty |
| CycleCountQty3 | WHSMobileAppStepCycleCountQty |
| CycleCountQty4 | WHSMobileAppStepCycleCountQty |
| Disposition | WHSMobileAppStepDisposition |
| DriverCheckInConfirmation | WHSMobileAppStepDriverCheckInConfirmation |
| DriverCheckInId | WHSMobileAppStepDriverCheckInId |
| DriverCheckOutConfirmation | WHSMobileAppStepDriverCheckOutConfirmation |
| DriverCheckOutId | WHSMobileAppStepDriverCheckOutId |
| ExpDate | WHSMobileAppStepExpDate |
| FromBatchDisposition | WHSMobileAppStepFromBatchDisposition |
| FromInventoryStatus | WHSMobileAppStepInventoryStatusFrom |
| FullQty | WHSMobileAppStepFullQty |
| InboundPut | WHSMobileAppStepInboundPut |
| InventBatchId | WHSMobileAppStepBatch |
| InventColorId | WHSMobileAppStepInventColorId |
| InventLocation | WHSMobileAppStepInventLocation |
| InventLocationId | WHSMobileAppStepWarehouse |
| InventSerialId | WHSMobileAppStepInventSerialId |
| InventSizeId | WHSMobileAppStepInventSizeId |
| InventStatusId | WHSMobileAppStepInventStatus |
| InventStyleId | WHSMobileAppStepInventStyleId |
| InventVersionId | WHSMobileAppStepInventVersionId |
| ItemId | WHSMobileAppStepItem |
| ITMContainerID | ITMMobileAppStepContainerId |
| ITMShipmentID | ITMMobileAppStepShipmentId |
| KanbanCardId | WHSMobileAppStepKanbanCard |
| KanbanCardToEmpty | WHSMobileAppStepKanbanCardToEmpty |
| KanbanOrCardId | WHSMobileAppStepKanbanCard |
| LicensePlateId | WHSMobileAppStepLicensePlate |
| LoadId | WHSMobileAppStepLoadId |
| LocationLicensePlatePosition | WHSMobileAppStepLocationLicensePlatePosition |
| LocOrLP | WHSMobileAppStepLocOrLP |
| LocOrLP_From | WHSMobileAppStepLocOrLPFrom |
| LocOrLP_To | WHSMobileAppStepLocOrLPTo |
| LocOrLPCheck | WHSMobileAppStepLocOrLPCheck |
| LocVerification | WHSMobileAppStepLocVerification |
| LPAdjustIn | WHSMobileAppStepLPAdjustIn |
| LPBreakChildLP | WHSMobileAppStepLPBreakChildLP |
| LPBreakParentLP | WHSMobileAppStepLPBreakParentLP |
| LPBuildChildLP | WHSMobileAppStepLPBuildChildLP |
| LPBuildParentLP | WHSMobileAppStepLPBuildParentLP |
| LPVerification | WHSMobileAppStepLPVerification |
| MergeContainerId | WHSMobileAppStepMergeContainerId |
| MixedLPLineNum | WHSMobileAppStepMixedLPLineNum |
| MobileDeviceQueueMessageCollectionIdentifierId | WHSMobileAppStepSelectOrder |
| MovementConfirmCancel | WHSMobileAppStepMovementConfirmCancel |
| NewCaptureWeight | WHSMobileAppStepCatchWeight |
| NewQty | WHSMobileAppStepNewQty |
| OutboundCatchWeightTag | WHSMobileAppStepCatchWeightTag |
| OutboundPut | WHSMobileAppStepOutboundPut |
| OutboundWeight | WHSMobileAppStepCatchWeight |
| OverridePutNewLocation | WHSMobileAppStepOverridePutNewLocation |
| PieceByPieceConfirmation | WHSMobileAppStepQtyVerification |
| POLineNum | WHSMobileAppStepPOLineNum |
| PONum | WHSMobileAppStepPONum |
| PositionFull | WHSMobileAppStepPositionFull |
| PositionFullQty | WHSMobileAppStepPositionFullQty |
| Potency | WHSMobileAppStepPotency |
| PrinterName | WHSMobileAppStepPrinterName |
| ProdId | WHSMobileAppStepProdId |
| ProdLastPalletConfirmation | WHSMobileAppStepProdLastPalletConfirmation |
| ProductConfirmation | WHSMobileAppStepProductConfirmation |
| ProductionScrapConfirmation | WHSMobileAppStepProductionScrapConfirmation |
| Put | WHSMobileAppStepPut |
| PutawayClusterId | WHSMobileAppStepPutawayClusterId |
| Qty | WHSMobileAppStepQty |
| QtyAdjust | WHSMobileAppStepQtyAdjust |
| QtyShort | WHSMobileAppStepQtyShort |
| QtyToConsume | WHSMobileAppStepQtyToConsume |
| QtyToPick | WHSMobileAppStepQtyToPick |
| QtyToPut | WHSMobileAppStepQtyToPut |
| QtyToScrap | WHSMobileAppStepQtyToScrap |
| QtyVerification | WHSMobileAppStepQtyVerification |
| QtyWithScanningLimit | WHSMobileAppStepQtyAdjust |
| ReasonString | WHSMobileAppStepReasonString |
| RecvLocationId | WHSMobileAppStepRecvLocationId |
| RemoveContainerId | WHSMobileAppStepRemoveContainerId |
| ReprintLabelConfirmation | WHSMobileAppStepReprintLabelConfirmation |
| RMANum | WHSMobileAppStepRMANum |
| ShortPickReason | WHSMobileAppStepShortPickReason |
| SortConOrLP | WHSMobileAppStepSortConOrLP |
| SortLicensePlateId | WHSMobileAppStepSortLicensePlateId |
| SortPositionId | WHSMobileAppStepSortPositionId |
| SortVerification | WHSMobileAppStepSortVerification |
| StartLocationId | WHSMobileAppStepStartLocationId |
| StartProdOrderConfirmation | WHSMobileAppStepStartProdOrderConfirmation |
| TargetLicensePlateId | WHSMobileAppStepTargetLicensePlateId |
| TOLineNum | WHSMobileAppStepTOLineNum |
| ToLocation | WHSMobileAppStepToLocation |
| TONum | WHSMobileAppStepTONum |
| ToWarehouse | WHSMobileAppStepWarehouseTo |
| TransportLoadId | WHSMobileAppStepTransportLoadId |
| WaveLabelId | WHSMobileAppStepWaveLabelId |
| WaveLblQty | WHSMobileAppStepWaveLblQty |
| Weight | WHSMobileAppStepWeight |
| WeightToConsume | WHSMobileAppStepWeightToConsume |
| WHSAdjustmentType | WHSMobileAppStepWHSAdjustmentType |
| WHSReceivingException | WHSMobileAppStepWHSReceivingException |
| WHSWorkException | WHSMobileAppStepWHSWorkException |
| WHSWorkLicensePlateId | WHSMobileAppStepWorkLicensePlateId |
| WMSLocationId | WHSMobileAppStepLocation |
| WorkId | WHSMobileAppStepWorkId |
| WorkIdToCancel | WHSMobileAppStepWorkIdToCancel |
| WorkLPIdPutawayCluster | WHSMobileAppStepWorkLPIdPutawayCluster |
| WorkPoolId | WHSMobileAppStepWorkPoolId |
| ZoneId | WHSMobileAppStepZoneId |
Available step icons
The system includes a collection of standard step icons that you can also use for your custom steps. You can't currently upload custom step icons. Therefore, you must always select one of the standard step icons.
The following table shows every standard step icon that is currently available, and its name.
 About |
 AddLpOrItem |
 BatchDisposition |
 Carrier |
 CatchWeightTag |
 CatchWeightTagWeight |
 CheckDigit |
 CheckInOutId |
 ChildLP |
 ClusterId |
 ClusterPosition |
 ConfigId |
 ConfiguredField |
 ConOrLP |
 ConsolidateFromLicensePlateID |
 ConsolidateToLicensePlateID |
 ContainerType |
 Counting |
 CountingReasonCode |
 CountryOfOrigin |
 Disposition |
 Done |
 DriverCheckInConfirmation |
 DriverCheckInId |
 DriverCheckOutId |
 ExpDate |
 Field |
 FromBatchDisposition |
 FromInventoryStatus |
 IdAttribute |
 InventBatchID |
 InventColorID |
 InventLocation |
 InventSerialID |
 InventSizeID |
 InventStatusID |
 InventStyleID |
 InventVersionID |
 ItemID |
 ITMContainerID |
 ITMShipmentID |
 KanbanCardID |
 KanbanOrCardID |
 LicensePlateID |
 LoadId |
 LocationLicensePlatePosition |
 LocOrLP |
 LocOrLPCheck |
 LocOrLPFrom |
 LocOrLPTo |
 LongProcessCompleted |
 LPBreakParentLP |
 MergeContainerId |
 MixedLPLineNum |
 OutboundWeight |
 Owner |
 ParentLP |
 PleaseConfirm |
 POLineNum |
 PONum |
 PositionFull |
 Potency |
 PrinterName |
 ProdId |
 ProductConfirmation |
 Put |
 PutawayClusterId |
 Qty |
 QtyAdjustIn |
 QtyShort |
 QtyToConsume |
 QtyToPut |
 QtyToScrap |
 QuantityConfirmation |
 RAFEndJob |
 RecvLocationID |
 RemoveContainerID |
 RMANum |
 SelectOrder |
 ShortPickReason |
 SortPositionId |
 TargetLicensePlateId |
 ToLineNum |
 ToLocation |
 ToNum |
 ToWarehouse |
 TransportLoadId |
 VendBatchId |
 WaveLabelId |
 WaveLblQty |
 Weight |
 WeightToConsume |
 WHSAdjustmentType |
 WHSReceivingException |
 WMSLocationID |
 WorkId |
 WorkIdToCancel |
 WorkLicensePlateId |
 WorkLPIDPutawayCluster |
 WorkPoolID |
 ZoneID |
Example: Assign step icons and titles for a custom flow
This example explains how to set up step icons and titles for a custom task flow. The scenario is built on an example of a custom task flow that is presented and explored in more detail in the following blog post: Customizing the Warehousing Mobile App. The task flow works in the following way:
- The app shows a page that prompts the worker to provide a container ID (for example, by scanning a bar code).
- If the container ID is valid, the app opens a new page that prompts the worker for the weight. (If the container ID isn't valid, the worker is returned to the first page.)
- When the worker enters a valid weight, the system stores the weight and returns the worker to the first page.
The following illustration shows this task flow.
Create a step class for the container input page
The container input page lets the worker scan or enter a container ID.
On the container input page, the control name of the input field is ContainerId. Because this control name isn't in the list of step IDs, you won't find an existing step that is based on it. Therefore, you must create a step class that represents the step. Here is an example.
[WHSMobileAppStepId('ContainerId')]
final internal class WHSMobileAppStepContainerId extends WHSMobileAppStep
{
private const WHSMobileAppStepIcon PopulationIcon = 'InventBatchID';
private const WHSMobileAppStepTitle InputNotFilledTitle = "@WAX:WHSMobileAppStepContainerID_InputNotFilled"; //Scan a container
protected void initValues()
{
defaultStepIcon = PopulationIcon;
defaultStepTitle = InputNotFilledTitle;
}
}
The identifier of the step icon is stored in the defaultStepIcon class member, and the step title is stored in the defaultStepTitle class member.
To assign a step icon, set defaultStepIcon to one of the icon IDs that are listed in the Available step icons section earlier in this article.
Use a standard or custom step icon and title for the weight input
The weight input page lets the worker enter a weight.
On the weight input page, the control name of the input field is Weight, which is in the list of step IDs. Therefore, if the step icon and title that are defined in the WHSMobileAppStepWeight class are acceptable to you, you don't have to change anything for this step.
However, if you prefer to use a different icon or title for this step, you can override either the stepId() method or the stepInfo() method in the builder class. Each task flow has its own step info builder.
Override the stepId() method
The following example shows one way that you can modify a builder class by overriding the stepId() method.
[WHSWorkExecuteMode(WHSWorkExecuteMode:: WeighContainer)]
public class WHSMobileAppStepInfoBuilderWeighContainer extends WHSMobileAppStepInfoBuilder
{
protected WHSMobileAppStepId stepId()
{
WHSMobileAppStepId stepIdLocal = super();
if (stepIdLocal == 'Weight')
{
return 'NewWeight';
}
return stepIdLocal;
}
}
You then create a step class for the NewWeight step. The code should resemble the code for the ContainerId example that was shown earlier in this article.
Override the stepInfo() method
The following example shows one way that you can modify a builder class by overriding the stepInfo() method.
[WHSWorkExecuteMode(WHSWorkExecuteMode:: WeighContainer)]
public class WHSMobileAppStepInfoBuilderWeighContainer extends WHSMobileAppStepInfoBuilder
{
protected WHSMobileAppStepInfo stepInfo()
{
if (stepId != 'Weight')
{
return super();
}
WHSMobileAppStepInfo stepInfo = WHSMobileAppStepInfo::construct();
stepInfo.parmStepIcon('NewIcon');
stepInfo.parmStepTitle('NewTitle');
return stepInfo;
}
}
You then construct a WHSMobileAppStepInfo object, and set the icon and/or title directly.
Additional resources
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for