Devices - 010601
Barcode Processor - 01060100001
BarcodeProcessorConfig
| Parameter | Data Type, Range |
Description |
|---|---|---|
| barcodes | BarcodeConfig | This parameter defines the barcodes. |
Example of pattern configuration
{
id=144 name="Return with transaction" type=TWO_OF_FIVE length=22
templates = [{ index=0 name="prefix" value="001" }]
posStates = [{ id=1 processName="ReturnWithTransaction"}
{ id=2 processName="ItemRegistration"}
]
actions = [{
id=1
processReactions = [
{ processName="ItemRegistration" reactionName="returnsWithTransaction" }
{ processName="ReturnWithTransaction" reactionName="REINIT" }
]
configParameters = [
{ name="findTransactionConfig.promptReceiptDataConfig.businessUnitIdPredefined" patternStart=3 patternEnd=6 trimZeroesLeft=true}
{ name="findTransactionConfig.promptReceiptDataConfig.businessDayDatePredefined" patternStart=7 patternEnd=12 datePattern="ddMMyy"}
{ name="findTransactionConfig.promptReceiptDataConfig.workstationIdPredefined" patternStart=13 patternEnd=15 trimZeroesLeft=true}
{ name="findTransactionConfig.promptReceiptDataConfig.receiptNumberPredefined" patternStart=16 patternEnd=21 trimZeroesLeft=true}
]
configId="ReturnWithTransactionConfigs.Default"
}]
}
Example of GS1 barcode
{
id=147 name="GS1 DataBar serial number" type=RSS14 length=-1
templates = [{ index=0 name="list" value="GS1OBJECT.GTIN" }
{ index=0 name="list" value="GS1OBJECT.SERIAL" }]
posStates = [{ id=1 processName="ItemRegistration"}
]
actions = [{
id=1
processReactions = [
{ processName="ItemRegistration" reactionName="registerItem" }
]
configParameters = [
{ name="itemNrEan" value="GS1OBJECT.GTIN" trimZeroesLeft=true}
{ name="serialNumber" value="GS1OBJECT.SERIAL"}
]
configId="ItemEntryConfigs.Default"
}]
}
BarcodeConfig
Definition of the barcode. Basic conditions for the barcode are listed below.
| Parameter | Data Type, Range | Description |
|---|---|---|
| id | Integer | This parameter defines the unique number of the barcode. |
| name | String | This parameter defines the name of the barcode processing rule, e.g. "Operator Sign-On". |
| type |
BarcodeType [EAN8, EAN8_S, EAN13, EAN13_S, EAN128, CODE39, CODE93, CODE128, UPCA, UPCA_S, UPCE, UPCE_S, UPCD1, UPCD2, UPCD3, UPCD4, UPCD5, TWO_OF_FIVE, RSS14, RSS_EXPANDED, GS1, PDF417, MAXICODE, DATAMATRIX, QRCODE, UQRCODE, AZTEC, GS1DATABAR_E, GS1DATABAR, UPDF417] |
If this information is missing, e.g. in the case of keyboard entries, the entries are assigned to predefined barcode types by means of their lengths.
|
| length | Integer | This parameter defines the barcode length. |
| verify | String | This parameter specifies the algorithm to verify the check digit (see Check Digit Algorithms - 01000100004). |
| errorMessage | String | This parameter defines an error message. It is logged if a barcode rule does not match and throws an error. |
Templates
List of conditions for the read barcode. All included conditions must be fulfilled to select the configuration. Includes elements of type TEMPLATE.
| Parameter | Data Type, Range |
|---|---|
| templates | Template |
Template
Description of the conditions indicating the data which must be included in the used barcode to use this configuration. The following condition types are possible:
- Check of a prefix/substring
- Check of a number range
- Check whether an element exists in an enumeration
- Check whether a list of elements exists in GS1OBJECT
| Parameter | Data Type, Range | Description |
|---|---|---|
| name | String | This parameter defines the template type. Allowed values are:
|
| value | String | This parameter defines the value which should be checked. Examples:
|
| index | Integer | This parameter defines the position which is the starting point of the identification. |
posStates
List of processes in which the configuration is allowed. To select the configuration, one of the mentioned functions must be enabled. Includes elements of type POS_STATE.
Additionally, it must be possible to define the permissible cash register status by further conditions (constraints).
| Parameter | Data Type, Range |
|---|---|
| posStates | PosState |
PosState
Cash register status in which the user barcode can be evaluated. This status is represented by the process. Several processes are also possible.
| Parameter | Data Type, Range |
Description |
|---|---|---|
| id | Integer | This parameter defines the unique number of the POS function representing the status which is accepted by the current user barcode. The number is defined in the list of all functions (gk_functions.xml or user_functions.xml). |
| processName | String | This parameter defines the process for which this rule is valid. |
| stepNames | String | This parameter defines the step names of the process which must be active so that the rule is valid. |
| exactMatch | Boolean | This parameter defines whether a barcode rule has to match the PosState exactly. |
stepVariants
Additional step variants that are allowed to process the event within the current process.
Example: For processing a barcode rule containing chained actions (setQuantityScan and registerItem to be executed from the Welcome Step, which can register an item just like in the Main Step from the ItemRegistration process), the following rule could be defined:
instance BARCODE_113 {
id = 113
name = "Quantity coded barcode"
type = EAN13
length = 13
templates = [ {index=0 name="prefix" value="26"} ]
posStates = [ {id=1 processName="ItemRegistration"} ]
stepVariants = ["Main"]
actions = [
{
id = 1
processReactions = [ {processName="ItemRegistration" reactionName="setQuantityScan"} ]
configParameters = [
{name="xXCustom01" patternStart=7 patternEnd=11 decPointPosition=2}
{name="xXCustom02" value="QUANTITY_CODED_EAN"}
]
configId = "SetQuantityForLineItemConfigs.Quantity_CST"
}
{
id = 2
processReactions = [ {processName="ItemRegistration" reactionName="registerItem"} ]
configParameters = [
{ name="registrationNumber" patternStart=0 patternEnd=12 }
{name="itemNrEan" patternStart=2 patternEnd=6 trimZeroesLeft=false}
{name="xXCustom01" value="QUANTITY_CODED_EAN"}
]
configId = "ItemEntryConfigs.Default"
}
]
}
In this case, if the POS is at the Welcome Step and starts to process this barcode rule, the pending actions would be executed also when the Main Step from the same process is reached.
Actions
The actions element defines process actions which should be executed within a given state.
| Parameter | Data Type, Range |
|---|---|
| actions | BarcodeAction |
BarcodeAction
| Parameter | Data Type, Range |
Description |
|---|---|---|
| processReactions | ProcessReaction | This parameter defines the reaction/transition to be executed. |
| parameters | Parameter | This parameter defines a list of transition parameters to be set. See description of parameters for details. |
| configId | String | This parameter defines the ID of the config which should be used when the action is executed. Example: SetPriceForLineItemConfigs.PressItem |
| configParameters | Parameter | This parameter defines a list of config parameters which should be overridden. See description of parameters for details. |
ProcessReaction
Defines a process action to execute.
The given transition/reaction is executed if the process name matches.
| Parameter | Data Type, Range |
Description | Default |
|---|---|---|---|
| processName | String | This parameter defines the process name. | |
| reactionName | String | This parameter defines the transition/reaction name to be executed. | |
| reactionType | ReactionType |
|
Available |
Parameter
Parameter to be transferred to the respective function. The content results from the barcode or can be permanently stored.
| Parameter | Migration | Data Type, Range |
Description | Default |
|---|---|---|---|---|
| name | name | String | This parameter defines the parameter name to be transferred to the config or set as the parameter to the transition/reaction. | |
| value | value | String | A parameter value or an element of GS1OBJECT can be defined. | |
| patternStart | pattern_start | Integer | This parameter defines the index in the barcode which is the starting point of the parameter string. | -1 |
| patternEnd | pattern_end | Integer | This parameter defines the index in the barcode which is the ending point of the parameter string. | -1 |
| datePattern | datePattern | String | This parameter allows the date pattern to be set for parsing to the data type value. Examples
|
|
| decPointPosition | dec_point_position | Integer | This parameter defines the position of the decimal point for the numeric information. Examples:
|
-1 |
| dcdParameter | dcd_parameter | String | This parameter defines the dcd class for additional information which is not part of the barcode number. | |
| dcdClass | dcd_class | String | This parameter defines the name of the decoding class. This class is called before actually starting the function. It processes the read barcode and prepares a result for the function to be called. Allowed values "checksum"
|
| Parameter | Migration | Data Type, Range |
Description | Default |
|---|---|---|---|---|
| replaceStart | replace_start | String | This parameter defines a list of start positions of the strings to be replaced. The separator is the semicolon. |
-1 |
| replaceEnd | replace_end | String | This parameter defines a list of end positions of the strings to be replaced. The separator is the semicolon. |
-1 |
| replaceChar | replace_char | String | This parameter defines a list of characters which are used to overwrite the respective part of the parameter string. The separator is the semicolon. |
Example:
- replace_start="1;5;10" replace_end="3;7;11" replace_char="0;1;2"
- Replaces the positions 1-3 by 0.
- Replaces the positions 5-7 by 1.
- Replaces the positions 10-11 by 2.
| Parameter | Migration | Data Type, Range |
Description |
|---|---|---|---|
| appendStrLeft | append_str_left | String | This parameter defines the character string to be appended to the left of the parameter string. |
| appendStrRight | append_str_right | String | This parameter defines the character string to be appended to the right of the parameter string. |
| Parameter | Migration | Data Type, Range |
Description | Default |
|---|---|---|---|---|
| insertStr | insert_str | String | This parameter defines a list of character strings to be inserted. The separator is the semicolon. |
|
| insertPosition | insert_position | String | This parameter defines lists of positions where character strings should be inserted. The separator is the semicolon. |
-1 |
Example:
- insert_str="777;88" insert_position="2;4"
- Parameter string before: 012345
- Parameter string after: 01777238845
| Parameter | Migration | Data Type, Range |
Description | Default |
|---|---|---|---|---|
| trimZeroesLeft | trim_zeroes_left | Boolean | This parameter removes all zeros. | false |
| trimZeroesRight | trim_zeroes_right | Boolean | This parameter removes all zeros at the end of the parameter string. | false |
ProcessBarcodeConfig
| Parameter Name | Data Type, Range | Description |
|---|---|---|
| barcodeTypes | String [ 0 .. * ] | This parameter defines a list of barcode types for the evaluation of manual barcode inputs (for inputs by scanners, the barcode type is provided by the scanner itself). |
MSR Processor - 01060100002
Not Supported:
MsrProcessorConfig
| Parameter | Data Type, Range | Description |
|---|---|---|
| msrs | MsrConfig | This parameter defines the msrs. |
Examples
{
id=6 name="Loyalty card"
templates = [{ index=0 name="prefix" value="60884" track=1 }]
posStates = [{ id=1 processName="CustomerRegistration"}
{ id=2 processName="ItemRegistration"}
{ id=3 processName="Payment"}
]
actions = [{
id=1
processReactions = [
{ processName="Payment" reactionName="customerRegistration" }
{ processName="ItemRegistration" reactionName="customerRegistration" }
{ processName="CustomerRegistration" reactionName="REINIT" }
]
configParameters = [
{ name="customerOperationConfig.customerId" patternStart=5 patternEnd=14 trimZeroesLeft=true track=1}
]
configId="CustomerRegistrationConfigs.CustomerRegistrationBonusCard"
}]
}
MsrConfig
Defines an MSR rule. Includes the elements templates, verifications, posStates and actions.
| Parameter | Data Type, Range |
Description |
|---|---|---|
| id | Integer | This parameter defines the unique number of the MSR rule. |
| name | String | This parameter defines name of MSR processing rule, e.g. "Operator Sign-On". |
| errorMessage | String | This parameter defines an error message. It is logged if an MSR rule does not match and throws an error. |
templates
List of conditions for the data read from the card. All included conditions must be fulfilled to select the configuration. Includes elements of type MsrTemplate.
| Parameter | Data Type, Range |
|---|---|
| templates | MsrTemplate |
MsrTemplate
Condition indicating the data which must be included in the used card to use this configuration. Three condition types are possible: check the substring, check a number range, check whether an element exists in an enumeration.
| Parameter | Data Type, Range |
Description |
|---|---|---|
| track | Integer | This parameter defines the number of the track where the data is located (track 1 to 4). |
Template
| Parameter | Data Type, Range | Description |
|---|---|---|
| name | String | This parameter defines the name of the condition. Allowed values are:
|
| value | String | This parameter defines the value which should be checked. Examples:
|
| index | Integer | This parameter defines the position which is the starting point of the identification. |
verifications
List of track data contents to be checked with a check digit algorithm.
| Parameter | Data Type, Range |
|---|---|
| verifications | Verification |
Verification
| Parameter | Migration | Data Type, Range | Description |
|---|---|---|---|
| track | Integer | This parameter defines the number of the track where the data is located (track 1 to 4). | |
| name | String | This parameter defines the name of the list element. | |
| index | Integer | This parameter defines the start value of the character string to be checked. | |
| endIndex | end_index | Integer | This parameter defines the end value of the character string to be checked. |
| algorithm | String | This parameter defines the check algorithm to be applied (see Check Digit Algorithms - 01000100004). |
posStates
List of functions in which the configuration is allowed. To select the configuration, one of the mentioned functions must be enabled. Includes elements of type PosState.
| Parameter | Data Type, Range |
|---|---|
| posStates | PosState |
PosState
Cash register status in which the user barcode can be evaluated. This status is represented by the process. Several processes are also possible.
| Parameter | Data Type, Range | Description |
|---|---|---|
| id | Integer | This parameter defines the unique number of the state. |
| processName | String | This parameter defines the process for which this rule is valid. |
| stepNames | String | This parameter defines the step names of the process which must be active so that the rule is valid. |
| exactMatch | Boolean | This parameter defines whether a barcode rule has to exactly match the PosState. |
actions
| Parameter | Data Type, Range |
|---|---|
| actions | MsrAction |
MsrAction
| Parameter | Data Type, Range | Description |
|---|---|---|
| processReactions | ProcessReaction | This parameter defines the reaction/transition to be executed. |
| parameters | MsrParameter | This parameter defines a list of transition parameters to be set. See description of parameters for details. |
| configId | String | This parameter defines the ID of the config which should be used when the action is executed. Example: SetPriceForLineItemConfigs.PressItem |
| configParameters | MsrParameter | This parameter defines the list of config parameters which should be overridden. See description of parameters for details. |
ProcessReaction
| Parameter | Data Type, Range | Description | Default |
|---|---|---|---|
| processName | String | This parameter defines the process name. | |
| reactionName | String | This parameter defines the transition/reaction name to be executed. | |
| reactionType | ReactionType | This parameter defines the type of reaction. Depending on the type, the execution process checks the occurrence of a configure reaction in a list of possible reactions or transitions or both.
|
Available |
MsrParameter
| Parameter | Data Type, Range | Description | Default |
|---|---|---|---|
| track | Integer | This parameter defines the number of the track where the data is located (track 1 to 4). |
Parameter
Parameter to be transferred to the respective process/transitions. Read card data or fixed values are used as data for this parameter.
| Parameter | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| name | name | String | This parameter defines the parameter name to be transferred to the function. | |
| value | value | String | A parameter value or an element of GS1OBJECT can be defined. | |
| patternStart | pattern_start | Integer | This parameter defines the index in the card data which is the starting point of the parameter string. | -1 |
| patternEnd | pattern_end | Integer | This parameter defines the index in the card data which is the ending point of the parameter string. | -1 |
| datePattern | pattern | String |
This parameter allows the pattern to be set for parsing to the data type value. Examples
|
|
| decPointPosition | dec_point_position | Integer |
This parameter defines the position of the decimal point for the numeric information. Examples:
|
-1 |
| dcdParameter | dcd_parameter | String | This parameter defines the parameter for the dcd class for additional information which is not part of the barcode number. | |
| dcdClass | dcd_class | String | This parameter defines the name of the decoding class. This class is called before actually starting the function. It processes the read barcode and prepares a result for the function to be called. Allowed values "checksum"
|
| Parameter | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| replaceStart | replace_start | String | This parameter defines a list of start positions of the strings to be replaced. The separator is the semicolon. |
-1 |
| replaceEnd | replace_end | String | This parameter defines a list of end positions of the strings to be replaced. The separator is the semicolon. |
-1 |
| replaceChar | replace_char | String | This parameter defines a list of characters which are used to overwrite the respective part of the parameter string. The separator is the semicolon. |
Example:
- replace_start="1;5;10" replace_end="3;7;11" replace_char="0;1;2"
- Replaces the positions 1-3 by 0.
- Replaces the positions 5-7 by 1.
- Replaces the positions 10-11 by 2.
| Parameter | Migration | Data Type, Range | Description |
|---|---|---|---|
| appendStrLeft | append_str_left | String | This parameter defines the character string to be appended to the left of the parameter string. |
| appendStrRight | append_str_right | String | This parameter defines the character string to be appended to the right of the parameter string. |
| Parameter | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| insertStr | insert_str | String | This parameter defines a list of character strings to be inserted. The separator is the semicolon. |
|
| insertPosition | insert_position | String | This parameter defines lists of positions where character strings should be inserted. The separator is the semicolon. |
-1 |
Example:
- insert_str="777;88" insert_position="2;4"
- Parameter string before: 012345
- Parameter string after: 01777238845
| Parameter | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| trimZeroesLeft | trim_zeroes_left | Boolean | This parameter removes all leading zeros. | false |
| trimZeroesRight | trim_zeroes_right | Boolean | This parameter removes all zeros at the end of the parameter string. | false |
Graphical Customer Display - 01060100003
Not Supported:
EventTimerConfig, EventTimerConfigs.CustomerFlowPaymentEndTimer
| Parameter Name | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| timeout | paymendEndScreenDisplayTime | Long | Display time of the payment end screen in milliseconds. | 300 |
CustomerFlowConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| transactionPreviewContextConfig Registration.showVoidedLineItems transactionPreviewContextConfig Registration.showLineItems |
Boolean | It defines whether voided line items are displayed on the graphical customer display. | true |
| transactionPreviewContextConfig Payment.showVoidedLineItems transactionPreviewContextConfig Payment.showLineItems |
Boolean | It defines whether voided tender line items are displayed on the graphical customer display. | true |
| paymendEndTransaction FinishedScreenEnabled |
Integer | It defines whether the "payment end transaction finished" screen should be displayed or not. The display time can be configured via the "EventTimerConfigs.CustomerFlowPaymentEndTimer.timeout" configuration. | true |
Device Service - 01060100007
DeviceServiceConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| excludedDeviceDescriptionKeys | String [ 0 .. * ] | Defines which devices should be excluded from the view. The description key is the ID of the device entry type which can be found in hal.properties for each device | JournalPrinter |
Interface RFID - 01060100010
Not Supported:
DeviceEntryTypes
The RFID features are enabled if there is a device with type RFID enabled. Example:
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| DeviceEntryTypes.DETEGO_JPOS.enabled | Boolean | Defines whether the Detego RFID device is enabled | false |
| DeviceEntryTypes.DETEGO_JPOS.active | Boolean | Defines whether the Detego RFID device is active | false |
RfidServiceConfig
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| rfidItemTypes | String[...] | The parameter defines a list of item types (based on values from SaleReturnLineItem.itemType), which are relevant for RFID. If the item type of an item matches the item type defined in this list and the other preconditions are fulfilled, the item is booked against RFID middleware in the corresponding process. If the list is empty, the parameter will be ignored. | CO |
Printer Error Handling - 01060100011
UiConfig
| Parameter Name | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| errorOverlayScreenConfig.manualConfirmationAllowedForErrorCodeList | String [ 0 .. * ] | Defines a list of error codes for which manual confirmation is allowed (via the confirm button or ENTER message). By default, manual confirmation is NOT allowed (if the error code is not in the list). | ||
| errorOverlayScreenConfig.skipDeregisterFromMessageBusErrorCodeLis | String [ 0 .. * ] | Defines a list of error codes for which the underlying step lifecycle will not be de-registered from the message bus. This only works in combination with the manualConfirmationAllowed* setting. |
Select Device - 01060100012
Not Supported:
SelectDeviceConfig
| Parameter Name | Data Type | Description | Default for FlowService |
|---|---|---|---|
| enableDeviceSelection | Boolean | Defines whether the device selection is enabled. Enabled for mobile POS and disabled for stationary POS. | true |
| alwaysShowDeviceSelection | Boolean | Specifies whether the printer selection should be displayed even if a device has already been selected. | true |
| skipSelectionForNoResult | Boolean | Skip device selection if there is no device available. | false |
| skipSelectionForOneResult | Boolean | Skip device selection if there is only one device available. | false |
| mappedDefaultDeviceId | String | Default device ID to which the selected device will be mapped. | Empty, filled for a specific usage, see below. |
| showDeviceCategoryDevices | List of DeviceCategoryType | Specifies devices with category codes which will be shown in the device selection. | Empty, filled for a specific usage, see below. |
| hideSubCategoryDevices | List of String | Specifies devices with sub-category codes which will be excluded from the device selection. | Empty, filled for a specific usage, see below. |
| pageTitleKey | String | Translation key for the page title | Empty, filled for a specific usage, see below. |
Configuration for specific device categories and specific cases
| Receipt Printers |
|---|
| SelectDeviceConfigs.PrinterInReport.alwaysShowDeviceSelection=false |
| SelectDeviceConfigs.PrinterInReport.skipSelectionForNoResult=true |
| SelectDeviceConfigs.PrinterInReport.skipSelectionForOneResult=true |
| SelectDeviceConfigs.Printer.mappedDefaultDeviceId=DefaultPrinter |
| SelectDeviceConfigs.Printer.showDeviceCategoryDevices.0=PRINTER |
| SelectDeviceConfigs.Printer.showDeviceCategoryDevices.1=FISCAL_PRINTER |
| SelectDeviceConfigs.Printer.hideSubCategoryDevices.0=JOURNAL |
| SelectDeviceConfigs.Printer.hideSubCategoryDevices.1=KITCHEN |
| SelectDeviceConfigs.Printer.hideSubCategoryDevices.2=BAR |
| Graphical Printers |
|---|
| SelectDeviceConfigs.GraphicalPrinter.showDeviceCategoryDevices.0=GRAPHICAL_PRINTER |
| SelectDeviceConfigs.GraphicalPrinter.hideSubCategoryDevices.0=JOURNAL |
| Payment Terminals |
|---|
| SelectDeviceConfigs.Terminal.mappedDefaultDeviceId=DefaultTerminal |
| SelectDeviceConfigs.Terminal.showDeviceCategoryDevices.0=TERMINAL |
| SelectDeviceConfigs.TerminalInPayment.alwaysShowDeviceSelection=false |
| SelectDeviceConfigs.TerminalInPayment.skipSelectionForNoResult=true |
| SelectDeviceConfigs.TerminalInPayment.skipSelectionForOneResult=true |