Scanning
While being on site at a customer, barcode scanning is by default possible until the task is closed. Barcode scanning can be used to increase counters of planned items or to document items related to the visit.
To generally surpress the barcode icon to appear when being on site, the preference showBarcodeIcon
can be set to false. One may define the visibility of the barcode button as being dependent on the process flow of a task.
showBarcodeIcon | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | true | false | + | + |
By default, barcode scanning is still possible after the signature has been received from the customer. In that case, the barcodes will only be stored for documentation purposes. It will not effect the quantities that have already been confirmed by the customer. To turn off barcode scanning after signature, the preference showBarcodeIconWhenSigned
can be set to true.
showBarcodeIconWhenSigned | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | true | false | + | - |
When used for quantity counting, the following constraints must apply:
- All relevant products need to be marked with their scan code
- All relevant non-SBS products need to be related to the corresponding task type(s)
- The
scanRequired
flag needs to be set up on the relevant products - The rule for reading the article number from a scancode must be configured properly (see below)
- The process flow preference
scanRequired
must be set correctly per related process flow - If required, a scanCount must be specified on the relevant slider widgets.
- The ERP system must understand the provided scan details
scanRequired | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | false | true | + | - |
When a scancode has been read and the scanCheckReference
preference is set, OMD Mobile will try to find an attachment of the current task with a matching reference value, i.e. the reference field is equal to the scancode. If an attachment is found, the specified Mobile UI as stated in the processFlow
field of the attachment is started. Note that references should not occur twice within the same task if the scanCheckReference
preference is turned on.
scanCheckReference | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | false | true | + | - |
When a scancode has been read, OMD Mobile can try to identify the article/product code from the scancode. Usually, the product code is part of the scancode. OMD Mobile will use the preferences scanProductCodeStart
and scanProductCodeLength
. For example, a value of scanProductCodeStart
= 0 and scanProductCodeLength
= 6 means, that positions 0 to 5 of the scancode provide the product code. OMD Mobile will use this fragment to search for the product in the product list of the configuration.
scanProductCodeStart | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Integer | Undefined | 0 | + | - |
scanProductCodeLength | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Integer | Undefined | 6 | + | - |
The flow preference multipleBarcodeSeparator
defines the separator string, which divides multiple scanned barcodes in a task attachment of the subtype "barcode".
multipleBarcodeSeparator | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
String | , | ; | + | - |
Barcode scanning can be used to add items with reference to products and to planned or unplanned delivery information. The flow preference scanBarcodeToItemsDelivered
enables the app to lookup a scanned code, or portions of the code, in the list of product codes.
See scanProductCodeStart
and scanProductCodeLength
for details about defining a portion of the barcode that matches the beginning of a product code, if required. Also, scan categories must be defined, as option
widget in the -OMD-
MobileUI.
After scanning barcodes and finding their products, the current tasks are searched for a corresponding itemsPlanned
, matching the processFlow
with the selected scan category and the reference
with the product code (or portion of code). See the flow preference scanBarcodeMatchesReference
to control whether or not the reference
should not be taken into account for matching the itemsPlanned
.
The scanned item is added to the delivery information, along with product details, if defined. Extending the usual widget defaults, the following defaultsValue settings are available in this context as well: prefix
(the portion of the scan code), scanCode
(the barcode as String), productCategory
, productCode
, productDescription
(translated). See the section about MobileUIs and Widgets for more details about the defaultValue
field of a Widget.
If no existing itemsPlanned
could be found, delivery information is added to the current task, without further relation to a planned delivery. Scanned barcodes that couldn't be mapped to products remain in the list of scan codes of a barcode
attachment under the current task.
scanBarcodeToItemsDelivered | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | false | true | + | - |
The flow preference scanBarcodeMatchesReference
controls, whether or not the product code should match the reference
field, when the app searches the current tasks for an itemsPlanned
, related to the scanned barcode. This preference can be used in conjunction with scanBarcodeToItemsDelivered
. If scanBarcodeMatchesReference
is false
, then the itemsPlanned
is identified through the processFlow
only, which matches the scan category. Furthermore, the defaultValue prefix
contains the scan category and not the product code (or its prefix).
scanBarcodeMatchesReference | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | true | false | + | - |
The flow preference scanBarcodeDeleteMatched
defines, whether or not a code should be removed from the list of the latest scanned barcodes, if scanBarcodeToItemsDelivered
is configured and the app was able to assign the code to existing, or to create new related delivery information.
scanBarcodeDeleteMatched | ||||
---|---|---|---|---|
Type | Default Value | Example | Android | HTML 5 |
Boolean | true | false | + | - |