User Management - 010101

Authorization - 01010101205

Functional Parameters

Table 1. AuthorizationConfig
Parameter Name Data Type, Range Description Default
authorizationRequired Boolean It defines whether authorization is required. true
requiredRight String It defines the resource ID.
authorizationMode AuthorizationMode

[SINGLE, FOUREYES]

 It specifies the authorization mode.
  • Single: single authorization

    (Single as "SINGLE")

  • FourEyes - four-eyes authorization

    (FourEyes as "FOUR_EYES")

 Single
cancellationAllowed Boolean It specifies whether authorization can be canceled. true
passwordRequired Boolean It specifies whether password entry is required. false
dialogType AuthorizationDialogType

[MANUAL, SCAN]

 It specifies the dialog type.
  • Manual: The user entries can be done manually, by a scanner or via MSR.

    (Manual as "INPUT_FIELD")

  • Scan: The user entries are only possible via MSR or a scanner.

    (Scan as "SCAN_EXPECT")

 Manual
checkSecondUserRights Boolean It specifies whether the second operator must be allowed to execute the POS function.

This parameter is only relevant for the four-eyes authorization (authorizationMode = FourEyes).

 true
loginName String It defines the input parameter of the operator number.
authorizingProcessNameKey String It defines a translation key for the name of the authorizing process.
authorizingReasonText String It defines the reason text of the authorizing process.
authorizingReasonTextKey String It defines the translation key for the reason text of the authorizing process.
authorizingReasonTextParameters String [0 .. *] It defines the placeholder parameters for the reason text of the authorizing process.
askIfAlreadyAuthorized Boolean It defines whether an authorization should be carried out again or not:

True: Regardless of whether authorization has already been carried out in the current receipt, the authorization should be carried out.

False: If sufficient authorization has already been carried out, then this authorization is used.
lineItemRelevant Boolean It defines whether the resourceId will be stored to the line item or not.
retailTransactionRelevant Boolean If the parameter is set to false, the resourceId will be not stored in the RetailTransaction.
activeOperatorRequired Boolean It defines whether an active operator group is required:

True: Error if no POS Group operator is active.

Null/False: No activate POS Group operator check.
Table 2. AuthenticationConfig
Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether the password is needed or not.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
passwordBypassAllowedInOnline Boolean It specifies whether the password entry can be skipped by authorization in online mode. true
passwordBypassAllowedInOffline Boolean It specifies whether the password entry can be skipped by authorization in offline mode. true
loginName String It defines the input parameter of the cashier number.
tillBarcode String It defines a predefined drawer barcode.

Internal parameters

Parameter Name Configuration Details Data Type, Range Description Default
firstUserNumber String It defines the operator number of the operator who wants to execute the function.

If it is filled, this operator is used instead of the logged-in operator.

Break - 01010101203

Timeout configuration

Parameter Name Configuration Details Data Type, Range Description Default
reaction autoLockreaction autoLogout RegistrationBase.promoj BREAKSIGNOFF It specifies the action to be performed if the operator is inactive for a configurable time period (INPUT_TIMEOUT).

BREAK – The "Break" function is called

SIGNOFF – The "Logout" function is called

 BREAK

EventTimerConfig, EventTimerConfigs.InactivityTimer

Parameter Name Data Type, Range Description Default
timeout Long, only > 0 It defines the time period in seconds after which an automatic action (TIMEOUT_ACTION) is performed. 300
initEventKeys String [1..*]
cancelEventKeys String [1..*]
resetEventKeys String [1..*]
timeoutEventKey String

TimeOutConfig (for self checkout only)

Parameter Name Data Type, Range Description Default
action TimeoutAction [

BREAK as "BREAK",

SIGNOFF as "SIGNOFF",

WELCOME as "WELCOME"]

 It specifies the action to be performed if the operator is inactive for a configurable time period (INPUT_TIMEOUT).

BREAK – The "Break" function is called

SIGNOFF – The "Logout" function is called

WELCOME – The welcome screen is displayed

 BREAK

LockConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
defaultLockOperationConfig LockOperationConfig It defines the configuration entity for configurations related to the lock process.
defaultUnLockOperationConfig UnLockOperationConfig It defines the configuration entity for configurations related to the lock process.
superUserUnLockOperationConfig UnLockOperationConfig It defines the configuration entity for configurations related to the lock process.
automaticInputUnLockOperationConfig UnLockOperationConfig It defines the configuration entity for configurations related to the lock process.
unlockUserAuthorizationConfig AuthorizationConfig It defines the configuration entity for configurations related to the authorization.
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
scaleVersionConfig ScaleVersionConfig It defines the configuration entity to configure the scale.

LockOperationConfig

Parameter Name Data Type, Range Description Default
openTransactionAllowed Boolean It defines a flag to indicate whether locking is allowed during an open transaction.

True: The break mode can be started at any time, regardless of the status of the pending receipt.

False: Open receipts are not allowed.

 true

UnLockOperationConfig

Parameter Name Data Type, Range Description Default
userRequired Boolean It defines a flag to indicate whether a cashier number is required to exit the lock mode.

True: The cashier number is requested to exit the break mode.

False: The cashier number is not requested to exit the break mode.

 false
passwordRequired Boolean It defines a flag to indicate whether a password is required to exit the lock mode.

True: The password is requested to exit the break mode.

False: The password is not requested to exit the break mode.

 true
unlockBySameUser Boolean It defines a flag to indicate whether unlocking is only allowed by the same user who locked the system. It is only relevant when userRequired = true, otherwise it will be ignored.

True: The break mode can only be finished by the user who was logged in before break mode was started.

False: The break mode can be finished by any user assigned to the same drawer as the user who started the break mode. If the drawer was assigned to a cash register instead of a cashier, break mode can be finished by any operator.

 true
forcedUnlock Boolean It defines an optional flag to indicate whether the unlock operation is forced or not (it is relevant for super-user unlock).

True: The break mode can be finished by an operator who is not able to end the break on their own (e.g. because of an expired password or blocked status). Therefore, they need to call the password forgotten function and be successfully authorized.

False: The break mode cannot be finished by an operator who is not able to end the break on their own. An error message will be displayed instead.

 null / false
passwordBypassAllowedInOnline Boolean It specifies whether the password entry can be skipped by authorization in online mode. true
passwordBypassAllowedInOffline Boolean It specifies whether the password entry can be skipped by authorization in offline mode. true
printSignOffReport Boolean It defines a flag to indicate whether, when switching user, a report for a sign-off transaction should be printed.

True: A logout document is printed if the cashier changes.

False: A logout document is not printed.

 false
loginName String It defines the input parameter of the cashier number.

AuthenticationConfig

Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether a password is required to exit the lock mode.

True: The password is requested to exit the break mode.

False: The password is not requested to exit the break mode.

 true
loginName String It defines the input parameter of the cashier number.
tillBarcode String It defines a predefined drawer barcode.

ScaleVersionConfig

Parameter Name Data Type, Range Description Default
deviceId String It defines the device ID of the scale. DefaultScale

Break POS Group - 01010101218

Not Supported: MPOS Size M MPOS Size S ONEX Stationary

PosGroupLockConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
scaleVersionConfig ScaleVersionConfig It defines the configuration entity to configure the scale.

AuthenticationConfig

Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether the password is needed or not.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
loginName String It defines the input parameter of the cashier number.

ScaleVersionConfig

Parameter Name Data Type, Range Description Default
deviceId String It defines the device ID of the scale. DefaultScale

Central App Login - 01010100001

CentralAppLoginConfig

Note:
extends ProcessConfig

Central App Logout - 01010100002

CentralAppLogoutConfig

Note:
extends ProcessConfig

Change Password - 01010100003

ChangePasswordConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
authorizationConfig AuthorizationConfig

AuthorizationConfig

Parameter Name Data Type, Range Description Default
authorizationRequired Boolean It defines whether authorization is required. false
activeOperatorRequired Boolean It defines whether an active operator group is required:
  • True: Error if no POS Group operator is active.
  • Null/False: No activate POS Group operator check.
 true
operatorSelectionAction OperatorAction It defines the POS group operator selection action.

Supported operator actions for the operator selection:

  • ASK_NEVER
  • ASK_IF_NOT_AVAILABLE
  • ASK_ALWAYS
 ASK_ALWAYS

Log In - 01010101201

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

LoginConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
forgotPasswordAuthorizationConfig AuthorizationConfig It defines the configuration entity for configurations related to the authorization.
passwordBypassAllowedInOnline Boolean It specifies whether the password entry can be skipped by authorization in online mode. true
passwordBypassAllowedInOffline Boolean It specifies whether the password entry can be skipped by authorization in offline mode. true
loanEmptyTill Boolean It controls the behavior if the target stock is equal to 0.00.

True: The process continues with change deposit.

False: The login is completed.

 true
scaleVersionConfig
autoLoginConfig AutoLoginConfig
loginWithoutTill Boolean Defines whether the POS Client does not handle tills.

It is used for the mobile POS application where cash payments are not used. In this case, the Client does not work with the till and the till is also not filled in the transaction.

 false

AuthenticationConfig

Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether the password is needed or not.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
passwordBypassAllowedInOnline Boolean It specifies whether the password entry can be skipped by authorization in online mode. true
passwordBypassAllowedInOffline Boolean It specifies whether the password entry can be skipped by authorization in offline mode. true
loginName String It defines the input parameter of the cashier number.
tillBarcode String It defines a predefined drawer barcode.

AutoLoginConfig

Parameter Name Data Type, Range Description Default
isAutoLoginEnabled Boolean It specifies whether the login is done automatically after system start. false
autoLoginName String It defines the input parameter of the cashier number which is used for automatic sign on.
autoLoginPassword String It defines the password (encoded) of the cashier which is defined in the parameter loginName.

CashDrawerConfig.Login

Parameter Name Data Type, Range Description Default
deviceName String It defines the device name of the cash drawer. VirtualCashDrawer
openAction CashDrawerOpenAction [

Always

Never

Tender]

 It defines whether the cash drawer will be opened.

Always - It will always be opened.

Never - It will never be opened.

Tender - It will be opened according to the tender configuration

 Always
messageKey String It defines the message key for the message that the cash drawer should be closed. cashdrawer.close.info.message
deviceNotPresentErrorDialog MessageDialogConfig It defines the message if the cash drawer is not present.
deviceOutOfOrderErrorDialog MessageDialogConfig It defines the message if the cash drawer is out of order.

TerminalRegistrationConfigs.Login

Parameter Name Data Type, Range Description Default
enableTerminalPayment Boolean It specifies whether the terminal registration is enabled or not. true
silentMode Boolean It specifies whether errors during terminal login must be confirmed. true
activeDeviceNames String [ 0 .. * ] It defines the active terminal device names.

Log In POS Group - 01010101216

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

POSGroupLoginConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
scaleVersionConfig ScaleVersionConfig It defines the input parameter of the cashier number.

AuthenticationConfig

Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether the password is needed or not.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
loginName String It defines the input parameter of the cashier number.
tillBarcode String It defines a predefined drawer barcode.

ScaleVersionConfig

Parameter Name Data Type, Range Description Default
deviceId String It defines the device ID of the scale. DefaultScale

Log Out - 01010101202

Timeout configuration

Parameter Name Configuration Details Data Type, Range Description Default
reaction autoLockreaction autoLogout RegistrationBase.promoj BREAK

SIGNOFF

 It specifies the action to be performed if the operator is inactive for a configurable time period (INPUT_TIMEOUT).

BREAK – The "Break" function is called

SIGNOFF – The "Logout" function is called

 BREAK

EventTimerConfig, EventTimerConfigs.InactivityTimer

Parameter Name Data Type, Range Description Default
timeout Long, only > 0 It defines the time period in seconds after which an automatic action (TIMEOUT_ACTION) is performed. 300
initEventKeys String [1..*]
cancelEventKeys String [1..*]
resetEventKeys String [1..*]
timeoutEventKey String

TimeOutConfig (for self checkout only)

Parameter Name Migration Data Type, Range Description Default
action TimeoutAction [

BREAK as "BREAK",

SIGNOFF as "SIGNOFF",

WELCOME as "WELCOME"]

 It specifies the action to be performed if the operator is inactive for a configurable time period (INPUT_TIMEOUT).

BREAK – The "Break" function is called

SIGNOFF – The "Logout" function is called

WELCOME – The welcome screen is displayed

 BREAK

LogoutConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
askForConfirmation Boolean It specifies whether a confirmation prompt is displayed. false
passwordInputTimeout
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
forgotPasswordAuthorizationConfig AuthorizationConfig It defines the configuration entity for configurations related to the authorization.
passwordBypassAllowedInOnline Boolean It specifies whether the password entry can be skipped by authorization in online mode. true
passwordBypassAllowedInOffline Boolean It specifies whether the password entry can be skipped by authorization in offline mode. true
scaleVersionConfig ScaleVersionConfig It defines the configuration entity to configure the scale.
closeDrawerRequired Boolean Defines whether the drawer must be closed. true

AuthenticationConfig

Parameter Name Data Type, Range Description Default
passwordRequired Boolean It defines a flag to indicate whether the password is required for the logout.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
loginName String It defines the input parameter of the cashier number.
tillBarcode String It defines a predefined drawer barcode.

CashDrawerConfig.Logout

Parameter Name Data Type, Range Description Default
deviceName String It defines the device name of the cash drawer. VirtualCashDrawer
openAction CashDrawerOpenAction [

Always

Never

Tender]

 It defines whether the cash drawer will be opened.

Always - It will always be opened.

Never - It will never be opened.

Tender - It will be opened according to the tender configuration

 Always
messageKey String It defines the message key for the message that the cash drawer should be closed. cashdrawer.close.info.message
deviceNotPresentErrorDialog MessageDialogConfig It defines the message if the cash drawer is not present.
deviceOutOfOrderErrorDialog MessageDialogConfig It defines the message if the cash drawer is out of order.

TerminalRegistrationConfigs.Login

Parameter Name Migration Data Type, Range Description Default
enableTerminalPayment Boolean It specifies whether the terminal registration is enabled or not. true
silentMode TERMINAL_ERROR_CONFIRM Boolean It specifies whether errors during terminal login must be confirmed. true
activeDeviceNames String [ 0 .. * ] It defines the active terminal device names.

ScaleVersionConfig

Parameter Name Data Type, Range Description Default
deviceId String It defines the device ID of the scale. DefaultScale

Log Out POS Group - 01010101217

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

POSGroupLogoutConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
authenticationConfig AuthenticationConfig It defines the configuration entity for configurations related to the authentication.
scaleVersionConfig ScaleVersionConfig It defines the configuration entity to configure the scale.

AuthenticationConfig

Parameter Name Migration Data Type, Range Description Default
passwordRequired LOGOUT_PASSWORD_REQUIRED Boolean It defines a flag to indicate whether the password is required for the logout.

True: The password prompt is displayed.

False: The password prompt is not displayed.

 true
loginName USER_INPUT String It defines the input parameter of the cashier number.

ScaleVersionConfig

Parameter Name Data Type, Range Description Default
deviceId String It defines the device ID of the scale. DefaultScale

Theme Selection - 01010100006

Not Supported: OPOS

FlowServiceConfig

Parameter Name Data Type, Range Description
flowServiceClientData FlowServiceClientData

FlowServiceClientData

Parameter Name Data Type, Range Description Default
themes String List of themes separated by semicolon that can be selected in theme selection newNow;highContrast

User Menu - 01010100005

Not Supported: OPOS

FlowServiceConfig

Parameter Name Data Type, Range Description
workstationDeviceCategories DeviceCategoryList[String] A map of allowed device categories per workstation type code.

DeviceCategoryList

Parameter Name Data Type, Range Description Default
entries DeviceCategoryEntry [ 1 .. *] The list of entries.

DeviceCategoryEntry

Parameter Name Data Type, Range Description Default
enabled boolean Flag to enable the device category entry. If an entry is disabled (enabled=false) it will be ignored and not send to clients.
deviceCategory String The device category name.
defaultDeviceLogicalName String The logical name of the default device for this device category.
deviceCategoryTranslation String The translation key for this device category. Flow Service replaces the key with the resolved translated text if it is found in translations.
selectDeviceConfigId String The runtime config ID for the SelectDevice process for this device category.