General - 010001

Acoustic Signals - 01000100073

Not Supported: MPOS Size M MPOS Size S

AcousticSignalConfig

Parameter Name Migration Data Type, Range Description Default
enabled Boolean It defines whether the acoustic signal is enabled. true
signalType type ScannerBeep

PCSpeaker

SoundFile

ToneIndicator

ToolkitBeep

It defines the signal type:
  • ScannerBeep: Signal via scanner (requires a scanner that is able to beep)
  • PCSpeaker: Signal via PC speaker (requires a PC speaker)
  • SoundFile: Signal via configured sound file (sound file defined in the parameter soundFile)
  • ToneIndicator: Device from UPOS Standard
  • ToolkitBeep: Beep via Java Toolkit Beep Method
PCSpeaker
soundFile String This parameter defines the path to the sound file that should be played.
count count Integer This parameter defines how often the signal should be triggered. 1
id id String This parameter defines the ID of the signal.
interSignalWaitInMilliseconds Long This parameter defines the time period in seconds after which the signal is performed. 0
deviceId String This parameter defines the Device ID.

Adapter Event Service - 01000100017

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

EventServiceConfigs

Parameter Name Data Type, Range Description Default
eventServiceEnabled Boolean It defines whether the event service is enabled. false
eventServiceDeviceGroup String It defines the device group of the device. defaultGroup
eventServiceCommandDestination String Defines the destination the POS Client needs to subscribe to in order to receive commands.
eventServiceEventsDestination String Defines the destination to which the POS Client will send all events.
eventServiceRetainedTimeout int The number of seconds after which this event needs to be forgotten / ignored by the mobile assistant. 300
txMonitoringTimeout long The amount of time in seconds the sending of transaction delta updates will continue until the next heartbeat event is received from the remote device.

If this time expires and no heartbeat event is received, no further transaction updates will be sent to the event service.

If the timeout value is equal or less than zero, the transaction deltas will continue to be sent regardless of the state of heartbeats.

1800

WebServiceServerConfig

Parameter Name Data Type, Range Description Default
address String This parameter defines the address for establishing the connection. wss://localhost:8443/event-service/services/stomp/
connectionTimeout Integer This parameter defines the timeout for establishing the connection. 10000
timeout Integer This parameter defines the timeout for responding after establishing the connection. 15000
username String This parameter defines the username for establishing the connection. ${CommonHttpBasicAuthenticationConfig.username}
password String This parameter defines the password for establishing the connection. ${CommonHttpBasicAuthenticationConfig.password}
passwordencryptorclass String This parameter defines the password encryption class of the password. AES

End Program - 01000101206

EndProgramConfig

Parameter Name Migration Data Type, Range Description Default
warnDialogFunctionNotAllowed MessageDialogConfig
warnDialogErrorRequest MessageDialogConfig
confirmDialog MessageDialogConfig
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
passwordEndingRequired PASSWORD_ENDING_REQUIRED Boolean It specifies whether the user is prompted to enter a password.

True: The password query occurs.

False: The password query does not occur.

true
password PASSWORD String It contains the password for ending the program. 321
confirmRequired CONFIRM_REQUIRED Boolean It specifies whether a confirmation dialog is displayed when exiting the program.

True: The confirm dialog is shown.

False: The confirm dialog is not shown.

true
exitCode EXIT_CODE Integer It defines the value of the exit code by ending the program.

The following exit codes are currently defined:

100 Restart the program

101 Reboot the cash register

102 Access the operating system

102

Input Domains - 01000100005

InputDomainsConfig

Parameter Name Data Type, Range Description
defaultInputDomain InputDomain It defines the default input domain.
inputDomains InputDomain [0..*] List of input domains
validatorDataTypeBeanMapping String This is a development parameter to set the mapping to validators.
formatterDataTypeBeanMapping String This is a development parameter to set the mapping to formatters.

InputDomain

Parameter Name Data Type, Range Description
id String ID of the input domain
name String Name of the input domain
dataType Enumeration

COMMON_TEXT as "COMMON_TEXT",

INTEGER_NUMBER as "INTEGER_NUMBER",

DECIMAL_NUMBER as "DECIMAL_NUMBER",

PRICE as "PRICE",

PRICE_WITH_CURRENCY as "PRICE_WITH_CURRENCY",

DATE as "DATE",

DATETIME as "DATETIME",

TIME as "TIME",

BOOLEAN as "BOOLEAN",

GIFT_CERTIFICATE_ITEM as "GIFT_CERTIFICATE_ITEM",

GIFT_CERTIFICATE_AMOUNT as "GIFT_CERTIFICATE_AMOUNT",

GIFT_CERTIFICATE_RETURN_AMOUNT as "GIFT_CERTIFICATE_RETURN_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_NUMBER as "GIFT_CERTIFICATE_PAYMENT_NUMBER",

GIFT_CERTIFICATE_PAYMENT_AMOUNT as "GIFT_CERTIFICATE_PAYMENT_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_QUANTITY as "GIFT_CERTIFICATE_PAYMENT_QUANTITY",

TERMINAL_KEYBOARD_REQUEST as "TERMINAL_KEYBOARD_REQUEST",

TERMINAL_CONFIRMED_STRING_REQUEST as "TERMINAL_CONFIRMED_STRING_REQUEST",

TERMINAL_CONFIRMED_DATETIME_REQUEST as "TERMINAL_CONFIRMED_DATETIME_REQUEST"

EMAIL as "EMAIL"

CASHRECYCLER_CASH_EXCHANGE_INTEGER_NUMBER as "CASHRECYCLER_CASH_EXCHANGE_INTEGER_NUMBER"

GIFT_CERTIFICATE_AMOUNT_WITH_CURRENCY as "GIFT_CERTIFICATE_AMOUNT_WITH_CURRENCY"

NUMERIC_TEXT as "NUMERIC_TEXT"

TRANSLATION_KEY as "TRANSLATION_KEY"

PLU_ENTRY as "PLU_NUMBER"

It defines the data type of this input domain.
hardwareProfile HardwareProfile It defines the hardware settings for this input domain.
formatting Formatting It defines the formatting rules for this input domain.
validation Validation It defines the input validation rules for this input domain.

HardwareProfile

Parameter Name Data Type, Range Description Default
scannerEnabled Boolean It defines whether the scanner can be used for data input. false
msrEnabled Boolean It defines whether the MSR can be used for data input. false
scaleEnabled Boolean It defines whether the scale can be used for data input. false
scannerValidationEnabled Boolean It defines whether scanner inputs are validated by input domain. false

Formatting

Parameter Name Data Type, Range Description
dataType Enumeration

COMMON_TEXT as "COMMON_TEXT",

INTEGER_NUMBER as "INTEGER_NUMBER",

DECIMAL_NUMBER as "DECIMAL_NUMBER",

PRICE as "PRICE",

PRICE_WITH_CURRENCY as "PRICE_WITH_CURRENCY",

DATE as "DATE",

DATETIME as "DATETIME",

TIME as "TIME",

BOOLEAN as "BOOLEAN",

GIFT_CERTIFICATE_ITEM as "GIFT_CERTIFICATE_ITEM",

GIFT_CERTIFICATE_AMOUNT as "GIFT_CERTIFICATE_AMOUNT",

GIFT_CERTIFICATE_RETURN_AMOUNT as "GIFT_CERTIFICATE_RETURN_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_NUMBER as "GIFT_CERTIFICATE_PAYMENT_NUMBER",

GIFT_CERTIFICATE_PAYMENT_AMOUNT as "GIFT_CERTIFICATE_PAYMENT_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_QUANTITY as "GIFT_CERTIFICATE_PAYMENT_QUANTITY",

TERMINAL_KEYBOARD_REQUEST as "TERMINAL_KEYBOARD_REQUEST",

TERMINAL_CONFIRMED_STRING_REQUEST as "TERMINAL_CONFIRMED_STRING_REQUEST",

TERMINAL_CONFIRMED_DATETIME_REQUEST as "TERMINAL_CONFIRMED_DATETIME_REQUEST"

It defines the formatting data type.

Validation

Parameter Name Data Type, Range Description
dataType Enumeration

COMMON_TEXT as "COMMON_TEXT",

INTEGER_NUMBER as "INTEGER_NUMBER",

DECIMAL_NUMBER as "DECIMAL_NUMBER",

PRICE as "PRICE",

PRICE_WITH_CURRENCY as "PRICE_WITH_CURRENCY",

DATE as "DATE",

DATETIME as "DATETIME",

TIME as "TIME",

BOOLEAN as "BOOLEAN",

GIFT_CERTIFICATE_ITEM as "GIFT_CERTIFICATE_ITEM",

GIFT_CERTIFICATE_AMOUNT as "GIFT_CERTIFICATE_AMOUNT",

GIFT_CERTIFICATE_RETURN_AMOUNT as "GIFT_CERTIFICATE_RETURN_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_NUMBER as "GIFT_CERTIFICATE_PAYMENT_NUMBER",

GIFT_CERTIFICATE_PAYMENT_AMOUNT as "GIFT_CERTIFICATE_PAYMENT_AMOUNT",

GIFT_CERTIFICATE_PAYMENT_QUANTITY as "GIFT_CERTIFICATE_PAYMENT_QUANTITY",

TERMINAL_KEYBOARD_REQUEST as "TERMINAL_KEYBOARD_REQUEST",

TERMINAL_CONFIRMED_STRING_REQUEST as "TERMINAL_CONFIRMED_STRING_REQUEST",

TERMINAL_CONFIRMED_DATETIME_REQUEST as "TERMINAL_CONFIRMED_DATETIME_REQUEST"

It defines the validation data type.
textValidation TextValidation It defines the rules for text validation.
dateTimeValidation DateTimeValidation It defines the rules for date/time validation.
numberValidation NumberValidation It defines the rules for number validation.
giftCertValidation GiftCertValidation It defines the rules for gift certificate validation.
inputAllowedPattern String It defines a regular expression pattern for the allowed inputs
validationPattern String It defines a regular expression pattern to validate the final value

TextValidation

Parameter Name Data Type, Range Description
minLength Int It defines the minimum length of the text.
maxLength Int It defines the maximum length of the text.
checkDigitRule Enumeration

MOD10_1 as "MOD10_1",

MOD10_2 as "MOD10_2",

MOD10_3 as "MOD10_3",

MOD10_4 as "MOD10_4",

MOD7_1 as "MOD7_1",

MOD7_2 as "MOD7_2",

LUHN as "LUHN",

GC_1 as "GC_1",

GC_2 as "GC_2",

GC_3 as "GC_3",

MOD11_1 as "MOD11_1",

MOD97_1 as "MOD97_1"

It defines a rule for validation of a check digit optionally included in the entered character string. The corresponding methods are described under:

Check Digit Algorithms - 010100004

DateTimeValidation

Parameter Name Data Type, Range Description
style DateTimeFormatStyle
autoFill Boolean Defines the behavior of filling the date input field:
  • false: The date (current date or any other date) is not automatically set if the field is empty or not completely filled
  • true:
    • The current date is automatically set if the field is not filled by user input
    • The date is automatically completed if the user input is incomplete
pattern String

NumberValidation

Parameter Name Data Type, Range Description Default
minimumIntegerDigits Int It defines the minimum number of digits before a decimal point. 1
maximumIntegerDigits Int It defines the maximum number of digits before a decimal point. 40
minimumFractionDigits Int It defines the minimum number of decimal places. 0
maximumFractionDigits Int It defines the maximum number of decimal places. 0
minimumValue Double It defines the minimum value.
maximumValue Double It defines the maximum value.
autoDecimalPoint Boolean Only used for a decimal number, e.g. data_type="DECIMAL_NUMBER" | "PRICE" | "PRICE_WITH_CURRENCY" | ...

It defines whether the decimal point is set automatically.

true: The decimal point is set automatically (requires minimumFractionDigits = maximumFractionDigits).

false: The user must enter the decimal point, if applicable (if maximumFractionDigits > 0).

true
validateDenomination Boolean Only used for a decimal number, e.g. data_type="DECIMAL_NUMBER" | "PRICE" | "PRICE_WITH_CURRENCY" | ...

true: The input amount is validated against the smallest denomination of the currency used.

false: The input amount is not validated.

false
validateRoundPaymentAmount Boolean Only used for a decimal number, e.g. data_type="DECIMAL_NUMBER" | "PRICE" | "PRICE_WITH_CURRENCY" | ...

true: The input amount is validated against the smallest denomination defined for rounding payment amounts, which is defined in the RoundPaymentAmount of the currency rounding rule. It is independent from the smallest denomination of the currency.

false: The input amount is not validated.

false

GiftCertValidation

Parameter Name Data Type, Range Description Default
validateDenomination Boolean Defines whether the gift certificate amount is validated against the allowed denomination. false

Item Consolidation - 01000100014

Parameter Name Data Type, Range Description Default
consolidateReturnItems Boolean The parameter controls whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not. false

Language Settings - 01000100026

LocalizationServiceConfig

Parameter Name Data Type, Range Description Default
defaultLocale Locale, String(128) It defines the default POS system locale. en_US
defaultCustomerLocale Locale, String(128) It defines the default customer locale and it falls back to the default POS system locale if it is not defined.
customerLocalesList String This parameter defines a list of customer locales separated by a semicolon. de_DE;en_US
localeConfigs LocaleConfig[ 0 .. * ] It defines the locale-specific configurations.
currencyGroups CurrencyGroup[ 0 .. * ] It defines the currency group definitions.
translationResourceBasenames Url[ 0 .. * ], String(256) It defines the base names of the resources with the translation files.
addressModelUSLocalesList Locale[ 0 .. * ], String(128) It defines a list of locales which should be treated as 'US' locales (locales that use the US address model).

LocaleConfig

Parameter Name Data Type, Range Description
locale Locale, String(128) It defines the locale to configure.
fallbackLocales Locale, String(128)[1..*] It defines the fallback locales.
localeOverrides LocaleOverrides It defines the locale overrides.

LocaleOverrides

Parameter Name Data Type, Range Description
dateFormatShort String
dateFormatMedium String
dateFormatLong String
dateFormatFull String
dateTimeFormatShort String
dateTimeFormatMedium String
dateTimeFormatLong String
dateTimeFormatFull String
timeFormatShort String
timeFormatMedium String
timeFormatLong String
timeFormatFull String
textOrientation TextOrientationType [RIGHTTOLEFT, LEFTTORIGHT]
  • RightToLeft as "RTL",
  • LeftToRight as "LTR"
numberFormat NumberFormat, String(128)

CurrencyGroup

Parameter Name Data Type, Range Description
id String
localeCurrencyPatternOverrides LocaleCurrencyPatternOverride[ 0 .. * ] It defines the pattern overrides for different locales in currency groups.

LocaleCurrencyPatternOverride

Parameter Name Data Type, Range
name String
pattern String

Left-Hand Mode - 01000100019

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

ToggleLeftHandedModeConfigs

Parameter Name Data Type, Range Description Default
checkLeftHandedOperatorFlag Boolean The parameter describes whether the left-hand flag of the operator (Operator.leftHandedFlag) should be validated or not. true

Media Panels - 01000100032

MediaPanelConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
channels MediaChannel [1 .. *] This parameter defines the media channels available on the POS.
schedulers MediaScheduler [1 .. *] This parameter defines the collection of schedulers.

Media channels without a flag default need to have an assigned scheduler to determine when the given channel should be activated.

MediaChannel

Parameter Name Data Type, Range Description
id String This parameter defines a unique channel identification. In the standard POS, this ID is supposed to be a number because each channel represents a media program for a particular week. Therefore, the ID is meant to be the week number.
description String This parameter provides additional channel information.
panels MediaPanel [1...*] Media panel collection ID - used by the configuration reader (internal).

MediaPanel

Parameter Name Data Type, Range Description
id String The media panel ID is the unique identification hash of the particular panel. In the standard POS, the ID is supposed to be the same as the GUI component ID.

Standard media panels

  • welcomeMediaPanel
  • breakMediaPanel
  • posClosedMediaPanel
  • registrationMediaPanel1
  • registrationMediaPanel2
  • registrationMediaPanel3
  • paymentMediaPanel1
  • paymentMediaPanel2
  • paymentMediaPanel3
media MediaGroup [1 .. *] Available media groups.

MediaGroup

Parameter Name Data Type, Range Description Default
id String Unique group ID
schedulerId String Associated scheduler
movies MoviePresentation [0 .. *] List of available movies
slideShows SlideShowPresentation [0 .. *] List of available slide shows
images ImagePresentation[0 .. *] List of available images

MoviePresentation

Parameter Name Data Type, Range Description Default
fileName String This parameter defines a file name.
repeat Integer Number of movie repeats. 1

SlideShowPresentation

Parameter Name Data Type, Range Description Default
directoryName String This parameter defines a directory name.
displayTimeInSeconds Integer How long the slide show should be displayed for [seconds] 60
frameDuration Integer Defines the duration of a frame before the transition for two consecutive frames is invoked [seconds] 10
effectType SlideShowEffectType: Enum with type String:
  • FadeOut as "FadeOut",
  • WipeUp as "WipeUp",
  • WipeDown as "WipeDown",
  • WipeLeft as "WipeLeft",
  • WipeRight as "WipeRight"
This parameter defines the type of slide show effect used. Possible values are:
  • FadeOut
  • WipeUp
  • WipeDown
  • WipeLeft
  • WipeRight
FadeOut
effectDuration Integer This parameter defines the duration of a slide show effect for two consecutive frames [seconds] 5

ImagePresentation

Parameter Name Data Type, Range Description Default
fileName String This parameter defines a file name.
displayTimeInSeconds Integer How long the slide show should be displayed for [seconds] 60

MediaScheduler

Parameter Name Data Type, Range Description
ID String This parameter defines a unique scheduler ID
plans MediaSchedulerPlan [1 .. *] Day plans

MediaSchedulerPlan

Parameter Name Data Type, Range Description
weekDay WeekDayType : enum with type String
  • Monday as "Monday",
  • Tuesday as "Tuesday",
  • Wednesday as "Wednesday",
  • Thursday as "Thursday",
  • Friday as "Friday",
  • Saturday as "Saturday",
  • Sunday as "Sunday",
  • All as "All"
This parameter defines a day of the week. Possible values:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
  • All
startTime String: Representation of the time in the form hh:mm:ss

min. value: 00:00:00

max. value: 23:59:59

The presentation should be planned from this point – i.e. the presentation could be started.

It could be the case that the presentation start will be postponed because another presentation might be running, which exceeded the last planned time range.

endTime String: Representation of the time in the form hh:mm:ss

min. value: 00:00:00

max. value: 23:59:59

The presentation should be planned until this point – i.e. the presentation will no longer be planned after this time.

It could be the case that the presentation end will be postponed because another presentation might be running, which exceeded the last planned time range.

POS End Of Day - 01000101406

EndOfDayConfig

Parameter Name Data Type, Range Description Default
reboot Boolean It specifies whether a reboot of the system will be performed. false
eodZvtDayClosure Boolean It specifies whether the terminal end of day will be processed automatically. true
eodZvtDayClosureRepeat Integer It counts the retries if the terminal end of day fails. 3
cashDrawerConfig CashDrawerConfig It describes the config for opening the cash drawer.
terminalAdminEndOfDayConfig TerminalAdminEndOfDayConfig It defines the config for the terminal admin end of day process.
endProgramConfig EndProgramConfig It describes the config for ending the program.
silentMode Boolean It defines whether error dialogs and confirmation dialogs are displayed to the operator. false
scheduledEod Boolean It specifies whether the POS EOD is triggered by the EOD command (false) or by scheduler (true).

If Flow Service is enabled (i.e. Mobile POS Clients are used), it is highly recommended to use the value "true". If "false" is used in this case, it has to be ensured by organizational means that the POS Client is used during the financial period. (If a POS Client is not used, no command is sent from the POS Server).

false
scheduledCronExpression String The scheduler cron pattern that specifies when the scheduler should start the scheduled EOD. 0 0 2 ? * * *

(Once a day at 2 a.m.)

CashDrawerConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
deviceName String It defines the device name, e.g. action.openDrawer.deviceName=VirtualCashDrawer
openAction ALWAYS, NEVER, TENDER It defines the cash drawer open action.
messageKey String It defines the message key for the display message during the cash drawer open state.
deviceNotPresentErrorDialog MessageDialogConfig
deviceOutOfOrderErrorDialog MessageDialogConfig

TerminalAdminEndOfDayConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
terminalDeviceId String It defines the terminal device ID.
silentMode Boolean It defines whether error dialogs are displayed to the operator.
confirmEnabled Boolean It controls whether a confirmation prompt is displayed.
confirmStart MessageDialogConfig It defines the configuration of the confirm end of day dialog.
terminalStateBeforeOperation TerminalStateChange [NONE, LOGIN, LOGOUT] It specifies the operation to be performed by the terminal before the function starts:

NONE: No operation.

LOGIN: The terminal is logged in.

LOGOUT: The terminal is logged out.

terminalStateAfterOperation TerminalStateChange [NONE, LOGIN, LOGOUT] It specifies the operation to be performed by the terminal after the function ends:

NONE: The terminal status changes back to the status as it was before the function started.

LOGIN: The terminal is logged in.

LOGOUT: The terminal is logged out.

allActiveTerminals Boolean Defines whether the Terminal EOD process should be run for all active terminals or for one configured terminal (defined by terminalDeviceId or the default from configuration).

EndProgramConfig

Parameter Name Data Type, Range Description Default
warnDialogFunctionNotAllowed MessageDialogConfig
warnDialogErrorRequest MessageDialogConfig
confirmDialog MessageDialogConfig
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
passwordEndingRequired Boolean It specifies whether the user is prompted to enter a password.

True: The password query occurs.

False: The password query does not occur.

true
password String It contains the password for ending the program. 321
confirmRequired Boolean It specifies whether a confirmation dialog is displayed when exiting the program.

True: The confirm dialog is shown.

False: The confirm dialog is not shown.

true
exitCode Integer It defines the value of the exit code by ending the program.

The following exit codes are currently defined:

100 Restart the program

101 Reboot the cash register

102 Access the operating system

102

POS Tableaus - 01000100045

Limited Support: MPOS Size M MPOS Size S ONEX Stationary POS

TableauConfig

Parameter Name Data Type, Range Description Default
variantId String[0..*] Defines the currently active variants by name, for which the tableau generator will search for effective tableau slot assignments.

Note: Tableau slot IDs must be unique (across all layout types).

The tableau generator will search within ALL configured variants for an effective assignment of a given tableau slot ID.

TableauSetConfig

Parameter Name Data Type, Range Description Default
tableausSets TableauSet[0..*] List of tableau sets.

TableauSet

Parameter Name Data Type, Range Description Default
tableauSetId String Unique identifier for the tableau set
priority Integer Defines the priority of the tableau assignment. 0
criteriaType
  • Default
  • ScaleDepartment
Defines the type of criteria that is used to detect the tableau.

Default= Criteria is not checked.

ScaleDepartment: The criteria value must match the currently active scale department.

Default
criteriaValue String Defines the criteria value that is used to detect the tableau.
tableauId String Unique identifier of the tableau that should be displayed

Program Start - 01000100008

StartupScreenConfig

Parameter Name Data Type, Range Description Default
initRetryCount Integer It defines the maximum number of retries if device/component initialization was not successful. 2
initRetryTime Integer It defines the time in milliseconds until a failed device/component initialization is repeated. 2000
initFailActionDefault CONTINUE

OPTIONAL

MANDATORY

ABORT

It defines what happens when a device/component cannot be initialized.

Default fail action for all devices/components that do not have a specific defined fail action via the "initFailActions" parameter.

CONTINUE ... Program continues without the device/component.

OPTIONAL ... The device/component is optional. The operator decides how to continue (abort, retry, continue).

MANDATORY ... The device/component is mandatory. The operator decides how to continue (abort, retry).

ABORT ... The device/component cannot be reinitialized via retry. The operator needs to abort the program (for general program start errors).

MANDATORY
initFailActions CONTINUE

OPTIONAL

MANDATORY

ABORT

This configuration overrides the "initFailActionDefault" for the configured device/component Entry-ID.

Entry-IDs:

  • "PosClient" for general errors (should be ABORT)
  • "PosService" for the POS Service initialization entry, only in the Thin POS scenario
  • "<DeviceEntryType-ID"> for device initialization entries, e.g. "VirtualJPOSPrinter", "HPap5000LineDisplay"

Recover Session - 01000100010

FlowServiceConfig

Parameter Description Default
sessionReadOnlyDuration The duration of the read-only session flag in milliseconds. 30000

Recovery Process - 01000100009

RecoveryConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
recoverTransaction Boolean It defines a flag to enable/disable the recovery of transactions.

Screen Food - 01000100015

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

ScreenFoodConfig

Parameter Name Migration Data Type, Range Description Default
enable Boolean Defines whether the Screen Food Service is enabled. false
statusFileAddress String Defines the output file path where the status should be written. C:/sysmgt/sw/screenFOOD/Data/Settings/status.txt
defaultStatusID Int Defines the default Screen Food Status ID that is written during initialization of Screen Food. It will be overwritten with the first POS event from ScreenFoodStatusConfig. 1
screenFoodStatusConfig ScreenFoodStatusConfig Defines the Screen Food Status configuration that should be used.

ScreenFoodStatusConfig

Parameter Name Migration Data Type, Range Description Default
screenFoodStatus ScreenFoodStatus[0..*] List of Screen Food Status that should be written.

ScreenFoodStatus

Parameter Name Migration Data Type, Range Description Default
posEvent String Defines the POS Event that should trigger a status update for the Screen Food Service.
statusID Int Defines the Screen Food Status ID that should be written for the POS Event.

Start and Leave Left-Hand Mode - 01000100020

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

ToggleLeftHandedModeConfigs

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
checkLeftHandedOperatorFlag Boolean The parameter describes whether the left-hand flag of the operator (Operator.leftHandedFlag) should be validated or not. true

Training Mode - 01000101403

Not Supported: MPOS Size M MPOS Size S ONEX Stationary POS

CashDrawerConfig

Parameter Name Migration Data Type, Range Description Default
keepDrawerClosedInTrainingMode Boolean It defines whether the cash drawer should be kept closed in training mode. true

Mobile POS Reconnect/Failover - 01000100081

Not Supported: OPOS

FlowServiceConfig

Parameter Data Type Description Default
FlowServiceConfig.flowServiceClientData.serverConnectionRetryCount Number Number of reconnect attempts when reconnecting to the original Flow Service instance.

The reconnect attempts are counted first after a user action or if the last scene is a waiting dialog.

3

Mobile POS Recover User Session after Login - 01000100012

Not Supported: OPOS

FlowServiceConfig

Parameter Description Default
oldSessionTimePeriod Time period after which the session is considered as old and the user is asked if this old session should be recovered.

Value -1: The check for an old session is skipped.

1h

Mobile POS Device Categories

FlowServiceConfig

Parameter Data Type Description Default
FlowServiceConfig.workstationDeviceCategories.MOB.entries.[0..n].enabled Boolean Defines whether the device category is enabled or disabled.
FlowServiceConfig.workstationDeviceCategories.MOB.entries.[0..n].deviceCategory PRINTER

GRAPHICAL_PRINTER

TERMINAL

Defines the device category.
FlowServiceConfig.workstationDeviceCategories.MOB.entries.[0..n].defaultDeviceLogicalName String Defines the logical name of the corresponding default device for the device category.
FlowServiceConfig.workstationDeviceCategories.MOB.entries.[0..n].deviceCategoryTranslation String Defines the translation key for the device category.
FlowServiceConfig.workstationDeviceCategories.MOB.entries.[0..n].selectDeviceConfigId String Defines the configuration instance for the device selection.