- Created by Johannes Sebastian Nielsen, last modified on Oct 30, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 9 Next »
Child pages
Order Line response
When the mobile device sends a request to get the order lines for a particular order it expects the following information for each line:
- OrderBackendID [string100]
The unique identifier of the order in the backend system. - LineNumber [string50]
The line number of the order line in the backend system. - FromBin [string50]
This is where the item should be taken from. E.g. a bin code (NAV) or a location (AX). - ToBin [string50]
This is where the item should be placed. E.g. a bin code (NAV) or a location (AX). - ValidateFromBin [boolean]
True: The mobile user must scan the correct FromBin value before he is allowed to perform the registration.
False: The mobile user can start the registration without validating the FromBin - ValidateToBin [boolean]
True: The mobile user must scan the correct ToBin value before he is allowed to perform the registration. If the ToBin element is blank the user can scan any value. This will make the user register where the items are placed (the user decides).
False: The mobile user can start the registration without validating the ToBin - ItemNumber [string50]
This is the unique identifier of the item in the backend system. The user can scan this value on the order lines screen to select the line. - Description [string50]
The (short) description of the item. - ItemBarcode [string1000]
This is the unique barcode value for this item. The user can scan this value on the order lines screen to select the line. If multiple barcodes are associated with the item a list of barcodes can be transferred. The default separator for barcodes is “;”.
E.g. barcode1;barcode2;barcode3
This can be helpful if items are packaged inside a box and the item barcodes are not visible unless the box is opened. Typically the box will have another barcode on it (because it’s a different unit of measure). If this barcode is also sent out it can be used to select the order line. - RegisterSerialNumber [boolean]
True: The mobile user must scan the serial numbers of the items to handle. Each scan of increments the registered quantity by one.
False: A quantity can be entered directly. - RegisterLotNumber [boolean]
True: The mobile user must first scan a lot number and then enter a quantity.
False: A quantity can be entered directly.
- RegisterExpirationDate [boolean]
This flag is used in combination with the RegisterLotNumber flag. If the lot is associated with an expiration date then this date can be captured on the mobile device by setting this flag.
The mobile user is allowed to register the expiration date in the short date format of the current regional settings on the mobile device, but the date format on the registration is always:
dd-MM-yyyy (e.g. 24-12-2009)
True: The mobile user must enter the expiration date after entering the lot number (before entering the quantity).
False: The user does not have to enter an expiration date
- RegisterQuantityByScan
- True: The user must scan the item number / barcode to register a quantity. Every scan adds 1 to the total quantity.
This setting is used in scenarios where it is very important that the handled items are correct.
An example of this is when picking medicine that does not use item tracking. Here the user must scan each individual packet / bag to verify that they match the ordered. - False: The user is allowed to enter a quantity.
- True: The user must scan the item number / barcode to register a quantity. Every scan adds 1 to the total quantity.
- SerialNumber [string50]
If the RegisterSerialNumber element is true and this element holds a value, the mobile application will verify that the user handles this particular serial number. - LotNumber [string50]
If the RegisterLotNumber element is true and this element holds a value, the mobile application will verify that the user handles this particular lot number. - Quantity [decimal]
The quantity to handle on the mobile device. - RegisteredQuantity [decimal]
Not used at the moment – always set this value to 0. - UnitOfMeasure [string10]
The unit of measure. - Status [int]
Not used at the moment – always set this value to 0. - Sorting [int]
When the order lines are displayed they are sorted by this column. - DisplayLine1 [string100]
This value is displayed on line 1 on the ”Order Lines” screen. The line is displayed in bold. - DisplayLine2 [string100]
This value is displayed on line 2 on the ”Order Lines” screen. - DisplayLine3 [string100]
This value is displayed on line 3 on the ”Order Lines” screen. - UnderDeliveryValidation [string]
This element determines how the application behaves when the user tries to post the order. It determines if the user will receive a warning or be blocked if an incomplete order is being posted. You can also turn off validation completely. The valid values are:
None
The order lines are not checked before posting.
Warn
The user is warned if incomplete lines are discovered. The user can ignore the warning and post anyway. This setting is useful as a check to see if the user has missed a line unintentionally.
Block
The user cannot post orders with unfinished lines. This setting is useful if posting of an incomplete order will cause problems in other work processes. E.g. picking for a production order.
- OverDeliveryValidation [string]
- This element determines how the application behaves when the user tries to register a greater quantity on an item than the Quantity element dictates. The valid values are:
- None
- The user is allowed to proceed with the over delivery without any interference.
- Warn
- The user is warned and asked whether to proceed when trying to register a quantity that exceeds the expected. This is to make sure the user is doing so intentionally.
- Block
- The user is not allowed to proceed with the over delivery and a warning message is displayed.
- The user is not allowed to proceed with the over delivery and a warning message is displayed.
- AllowBinChange [boolean]
This flag determines if the user is allowed to register other bins / locations than specified by the ERP system.
True: The user is allowed to use other bin / locations. When another bin / location is scanned the user will get a warning message, but he can ignore the warning and proceed with the registration.
False: The user is not allowed to use other bins / location. When another bin / location is scanned the user will get a message telling that changing bin / location is not allowed.
Example XML
<?xml version="1.0" encoding="utf-16"?> <response messageid="147db121-f664-4fb7-8d08-019ddf7405b1" status="Completed" xmlns="http://schemas.microsoft.com/Dynamics/Mobile/2007/04/Documents/Response"> <description /> <responseData> <BaseOrderLine xmlns="http://schemas.taskletfactory.com/MobileWMS/BaseDataModel"> <OrderBackendID>RE000007</OrderBackendID> <LineNumber>10000</LineNumber> <FromBin /> <ToBin /> <ValidateFromBin>false</ValidateFromBin> <ValidateToBin>false</ValidateToBin> <ItemNumber>1150</ItemNumber> <ItemBarcode>1150</ItemBarcode> <RegisterSerialNumber>false</RegisterSerialNumber> <RegisterLotNumber>false</RegisterLotNumber> <RegisterQuantityByScan>false</RegisterQuantityByScan> <SerialNumber /> <LotNumber /> <Description>Front Hub</Description> <Quantity>100</Quantity> <RegisteredQuantity>0</RegisteredQuantity> <UnitOfMeasure>PCS</UnitOfMeasure> <Status>0</Status> <Sorting>0</Sorting> <DisplayLine1>1150</DisplayLine1> <DisplayLine2>Front Hub</DisplayLine2> <DisplayLine3>UoM: PCS</DisplayLine3> <UnderDeliveryValidation>Warn</UnderDeliveryValidation> <OverDeliveryValidation>Warn</OverDeliveryValidation> <RegisterExpirationDate>false</RegisterExpirationDate> <AllowBinChange>true</AllowBinChange> </BaseOrderLine> </responseData> </response>
Registration Data
When the mobile device is finished with an order it sends the registrations in this format. There can be several registrations related to a particular order line. The registrations are grouped under each order line.
- UnitOfMeasure [string10]
The unit of measure of the registration. - Quantity [decimal]
The registrered quantity. - LotNumber [string50]
The registered lot number. If the RegisterExpirationDate flag is set on the order line the field will contain both the lot number and the expiration date (separated by a ”,” [can be changed in the configuration file]). The mobile user is allowed to register the expiration date in the short date format of the current regional settings on the mobile device, but the date format on the registration is always: dd-MM-yyyy - SerialNumber [string50]
The registered serial number. If the RegisterExpirationDate flag is set on the order line the field will contain both the serial number and the expiration date (separated by a ”,” [can be changed in the configuration file]). The mobile user is allowed to register the expiration date in the short date format of the current regional settings on the mobile device, but the date format on the registration is always: dd-MM-yyyy - ToBin [string50]
The bin where the handled item was placed. - FromBin [string50]
The bin where the handled item was taken from. - ActionType [string: TAKE / PLACE]
The action type tells if the registration was related to taking the item or to placing it. Depending on how the order line was setup regarding the ”ValidateFromBin” and ”ValidateToBin” flags, there will either be just a TAKE / PLACE registration or a TAKE / PLACE pair.
Example XML
<?xml version="1.0" encoding="utf-8"?> <Order backendID="backendID1" xmlns="http://schemas.taskletfactory.com/MobileWMS/RegistrationData"> <Line lineNumber="10000"> <Registration> <UnitOfMeasure>PCS</UnitOfMeasure> <Quantity>1</Quantity> <LotNumber></LotNumber> <SerialNumber>XYZ00101</SerialNumber> <ToBin></ToBin> <FromBin>W-01-02-09</FromBin> <ActionType>TAKE</ActionType> </Registration> <Registration> <UnitOfMeasure>PCS</UnitOfMeasure> <Quantity>1</Quantity> <LotNumber></LotNumber> <SerialNumber>XYZ00102</SerialNumber> <ToBin></ToBin> <FromBin>W-01-02-09</FromBin> <ActionType>TAKE</ActionType> </Registration> </Line> <Line lineNumber="20000"> <Registration> <UnitOfMeasure>BOX</UnitOfMeasure> <Quantity>3</Quantity> <LotNumber>25022009</LotNumber> <SerialNumber></SerialNumber> <ToBin></ToBin> <FromBin>W-03-03-05</FromBin> <ActionType>TAKE</ActionType> </Registration> </Line> <Line lineNumber="30000"> <Registration> <UnitOfMeasure>BOX</UnitOfMeasure> <Quantity>3</Quantity> <LotNumber></LotNumber> <SerialNumber></SerialNumber> <ToBin></ToBin> <FromBin>W-03-03-06</FromBin> <ActionType>TAKE</ActionType> </Registration> <Registration> <UnitOfMeasure>BOX</UnitOfMeasure> <Quantity>3</Quantity> <LotNumber></LotNumber> <SerialNumber></SerialNumber> <ToBin>P-01-01-03</ToBin> <FromBin></FromBin> <ActionType>PLACE</ActionType> </Registration> </Line> </Order>
Order Lines list
- No labels