Order Lines GetOrderLines Response

Basic information

OrderBackendID

Reference to the order no.

String, Mandatory

LineNumber

Reference to the order line no.

String. Mandatory. Unique.

Sorting

Sorting of all lines, ranked after lower numbers first

Integer, Mandatory

Display values

Comment

Text information
Defined as nvarchar(max) so can contain a lot of text

String

Description

Text information
The (short) description of the item

String

Destination

Grouping used for Tote functionality. Collector Step Tote

String

DisplayLine1

This value is displayed on line 1. This line is displayed in bold by default

String

DisplayLine2

This value is displayed on line 2

String

DisplayLine3

This value is displayed on line 3

String

DisplayLine4

This value is displayed on line 4

String

DisplayLine5

This value is displayed on line 5. This line is disabled by default

String

UnitOfMeasure

In which unit is there to be registered in.

Note: This is a display value only as mobile does not know of item units. See Register Quantity By Scan

String

Additional values

FromBin

Bin to Take items from

String

ToBin

Bin to place items into

String

ItemBarcode

A list of barcodes identifying the item, e.g. Barcode1;Barcode2;Barcode3

Useful 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. 

Note:

• Mandatory for "RegisterQuantityByScan" to work See Select Line by scan (scanToSelectBehaviour)

• Scanning the barcodes can select an order line for the user

Semicolon separated
string list

ItemNumber

Item number

Note: Scanning this, can select an order line for the user.

String, Mandatory

LotNumber

LotNumber of the Item

String

SerialNumber

SerialNumber of the item

String

Quantity

Quantity to register

Note: Mobile does not know the item units. See Register Quantity By Scan for another solution to this

Decimal

Priority

Configuration

RegisterQuantityByScan

True: Quantity is collected by scanning one of the valid item barcodes.

Note: Requires "ItemBarcode" or "BarcodeQuantity" is specified. See See Register Quantity By Scan 

Boolean

BarcodeFormat

Special field to specify a RegEx - for barcode validation

Example: <BarcodeFormat>{[frombin][^\w{1,10}$]}</BarcodeFormat>

Field FromBin the barcode must be validated against the specified RegEx. String (RegEx), control field. Vaild fields to add regex: frombin, lot, serial, tobin, tote It it possible to specify multiple reg.ex for one field

Example: {[serial][regex1]}{[serial][regex2]}{[lot][regex3]}{[bin][regex4]}

String

BarcodeQuantity

See Barcode Quantity (enableMultiplier) for explanation

String, encoded

RegisterSerialNumber

True: User is prompted for specifying serialnumber(s).
Each input/scan increments the registered quantity by one

Boolean

RegisterLotNumber

True: User is prompted for specifying a lotnumber

Boolean

RegisterExpirationDate

True: User is prompted for specifying an Expiration Date

Boolean

RegisterExtraInfo

This is a control - to add extra steps to the current line.
Example: <RegisterExtraInfo>ReturnDisposition{[CauseId][defaultValue][51]}</RegisterExtraInfo>
It has a special setup, "ReturnDisposition" is a reference to a registrationCollectorConfiguration defined in GetReferenceData. The "CauseId" is a reference to a step in the collector - and "51" is the value to set. The field is not fully described here.
The collected values is returned in a "ExtraInfo" element per Line/Registration.

String

AllowBinChange

True: The end-user is allowed to change the bin 

Boolean

RewindToStepOnIncompleteLine

Use this element to have the registration collector return to a named step in the registration collector after performing a registration which is below the Quantity of the order line.
If set to LotNumber, and there is a remaining Quantity on the order line after completing a registration, the registration collector will not close, but return to the LotNumber step.

Boolean

Status

Used to control image/icons

Integer

OverDeliveryValidation

If user registers a higher value than the suggested "Quantity" value, this setting determines the mobile behavior: 

None: User is allowed to register a higher value

Warn: Warn the user if a higher value is entered. A warning is displayed

Block: User is not allowed to register a higher value. A error is displayed

See Register unexpected Quantity (overDeliveryValidation / underDeliveryValidation)

Enum "None","Warn","Block"

UnderDeliveryValidation

If user registers a lower value than the suggested "Quantity" value , this setting determines the mobile behavior: 

None: User is allowed to register a higher/lower value

Warn: Warn the user if a lower value is entered. A warning is displayed

Block: User is not allowed to register a lower value. A error is displayed

See Register unexpected Quantity (overDeliveryValidation / underDeliveryValidation)

Enum "None","Warn","Block"

ValidateFromBin

True: User is prompted for specifying bin where items are taken

• User must scan a value matching "FromBin" value

• if "FromBin" value is blank,  the user can scan any value

If both ValidateFromBin and ValidateToBin are both enabled at the same time, the Movement flow is used.

Boolean

ValidateToBin

True: User is prompted for specifying Bin where items are placed

• User must scan a value matching "ToBin" value

• if "ToBin" value is blank,  the user can scan any value

If both ValidateFromBin and ValidateToBin are both enabled at the same time, the Movement flow is used.

Boolean

PriorityValidation

Step collection

Workflow

Replaces the workflow defined for the planned service in application.cfg, with another workflow.
This can be done:

• either by referencing the id of another workflow defined in application.cfg

• or by sending out a complete workflow wrapped in a CDATA element

From version 1.8.0 the workflow configuration from the order line can be merged with the workflow defined in the service section. The key to merging instead of replacing is adding the attribute tweak="Append" to the registration collector configuration. <registrationCollectorConfiguration tweak="Append">

XML

registrationCollectorConfiguration

This is an optional section, used to specify extra steps to perform after the "Post" has been choosen
These are also called "Header Steps". One collection is collected for all lines

See Whitepaper Understanding Steps

XML

Context

ActionDefinedQuantity

The quantity already registered. 

Note: This field always shows the same value as either "RegisteredQuantity" and "PlacedQuantity" 

Decimal

RegisteredQuantity

The quantity already registered

Used when taking items

Decimal.

PlacedQuantity

The quantity already registered

Used when placing items

Decimal.

Only Windows Handheld Embedded

RegisterSerialNumberQuantity

The default behavior of the mobile device when registering serial numbers is to assume a quantity of 1.
In some cases it may prove desirable to have a different quantity associated with the serial number.
Note: Replaced in Android by online validation serialnumber.

Boolean