Use this event to
Add steps to be displayed at the mobile device when collecting values for each individual document line.
Description
New steps defined at line level (collected for each individual line) are merged with steps from your existing workflow defined in application.cfg
You may add custom steps using either the _Steps-parameter or a ConfigurationKey (to be declared in Reference Data).
Using the _Steps-parameter is the easiest and most flexible, but you may consider using a ConfigurationKey when performance or backwards compatibility with older Android Apps is more important to you.
| Using _Steps-parameter | Using ConfigurationKey from ReferenceData |
|---|---|
| Easier syntax (Steps defined on-the-fly) | More difficult to use (requires ConfigurationKey in ReferenceData) |
| Multiple subscribers to same OnAddSteps event is possible | Only a single subscriber must exist to same OnAddSteps event |
| Performance cost per step added to order lines | No performance cost per additional step |
| Minimum requirements are Mobile WMS 5.39 and Android App 1.8 | Minimum requirement is Mobile WMS 5.11 |
Template
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Receive", 'OnGetReceiveOrderLines_OnAddStepsToAnyLine', '', true, true)]
local procedure OnGetReceiveOrderLines_OnAddStepsToAnyLine(_RecRef: RecordRef; var _BaseOrderLineElement: Record "MOB Ns BaseDataModel Element"; var _Steps: Record "MOB Steps Element")
begin
end;
Example 1: Add line steps by using _Steps-parameter
// Prerequisites: Mobile WMS 5.39 and Android App 1.8
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Receive", 'OnGetReceiveOrderLines_OnAddStepsToAnyLine', '', true, true)]
local procedure My01OnGetReceiveOrderLines_OnAddStepsToAnyLine(_RecRef: RecordRef; var _BaseOrderLineElement: Record "MOB NS BaseDataModel Element"; var _Steps: Record "MOB Steps Element")
begin
// if not (_BaseOrderLineElement.Get_UnitOfMeasure() in ['KG', 'GR']) then // Example: Condition based on input
// exit;
_Steps.Create_DecimalStep(10000, 'CustomGrossWeightGrams');
_Steps.Set_header('Gross Weight (Grams)');
_Steps.Set_label('Gross Weight (Grams):');
_Steps.Set_helpLabel('Gross Weight in Grams per Base Unit of Measure');
_Steps.Set_minValue(0);
_Steps.Set_maxValue(100000);
_Steps.Set_performCalculation(true);
end;
Example 2: Add line steps by referencing a ConfigurationKey from ReferenceData
Currently only one (custom) key per Order Line is supported, meaning only one customization may create StepsByReferenceDataKey at any time.
This single subscriber must set a Key that includes all steps for all other intended subscribers as well. This can only be done by knowing other customizations are in place and manually create a new RegistrationCollectorConfigurationKey that includes all steps.
// [Example 02]: Append line steps by referencing a RegistrationCollectorConfiguration-Key (ReferenceData)
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Receive", 'OnGetReceiveOrderLines_OnAddStepsToAnyLine', '', true, true)]
local procedure My02OnGetReceiveOrderLines_OnAddStepsToAnyLine(_RecRef: RecordRef; var _BaseOrderLineElement: Record "MOB NS BaseDataModel Element")
begin
_BaseOrderLineElement.Create_StepsByReferenceDataKey('CustomReceiveSteps');
// Example: Modify attribute values for steps defined by the ReferenceDataKey used above (i.e. defaultValue)
// See: https://docs.taskletfactory.com/display/TFSK/How-to:+Modify+Custom+Line+Step+dynamically
end;
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Reference Data", 'OnGetReferenceData_OnAddRegistrationCollectorConfigurations', '', true, true)]
local procedure My02OnGetReferenceData_OnAddRegistrationCollectorConfigurations(var _Steps: Record "MOB Steps Element")
begin
_Steps.InitConfigurationKey('CustomReceiveSteps');
_Steps.Create_DecimalStep(20000, 'CustomNetWeightGrams');
_Steps.Set_header('Net Weight (Grams)');
_Steps.Set_label('Net Weight (Grams):');
_Steps.Set_helpLabel('Net Weight in Grams per Base Unit of Measure');
_Steps.Set_minValue(0);
_Steps.Set_maxValue(100000);
_Steps.Set_performCalculation(true);
end;
Event: OnGetReferenceData_OnAddRegistrationCollectorConfigurations
- _Steps
- Accessor table "MOB Steps Element"
- Use this to create at new Reference Data "ConfigurationKey" that holds a number of steps.
- Add the steps using "Create_..."-functions.
- Change/Set step-properties using "Set_..."-functions
- Accessor table "MOB Steps Element"
Create Step Example
- Add the steps using "Create_..."-functions.
- Create_TextStep = Create a new step to collect Text
- Create_TextStep_ItemNumber = Create a new Text step prepared to collect an Item No.
- Create_DateStep = Create a new step to collect Date
- Create_DateStep_ExpirationDate = Create a new Date step prepared to collect an expiration date
- Create_ListStep_Variant = Create a new List step prepared to display available Variants of an Item
- Create_ListStep_UoM = Create a new List step prepared to display available Units of Measure of an Item
- And many more. Use the VS Code to explore all the options
Set Step Properties Example
- Set_header('Text header')
- Set_label('Text label');
- Set_helpLabel('Text helpLabel');
- Set_optional(false);
- Set_defaultValue(1);
- And many more. Use the VS Code to explore all the options
Sorting Steps for order lines
Steps are generally sorted by Id. This can be changed using the <orderLineConfiguration><extraInformationConfiguration stepSorting="ById"/><orderLineConfiguration/> in application.cfg
More examples
-
How-to: Add Line Step — Add Steps to be displayed during a line registration on planned functions
-
Case: Scan ExpirationDate in custom format — Scan ExpirationDate as custom format YYYYMM when goods is received from any Vendor.
Version History
| Version | Changes |
|---|---|
| MOB5.11 | Introduced |
| MOB5.39 | New _Steps parameter introduced |