Customizing Reference
Differences from POS Client
Customer Detail Panel - 01050101129
Limited Support: 
Function Parameters
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| displaySuspendedTab | Boolean | It specifies whether the tab for suspended transactions is displayed. | true |
| displaySalesOrderTab | Boolean | It specifies whether the tab for customer orders is displayed. | true |
| displayHistoryTab | Boolean | It specifies whether the tab for the customer transaction history is displayed. | true |
| displayPointsTab | Boolean | It specifies whether the tab for the points information is displayed. | true |
| displayContactTab | Boolean | It specifies whether the tab for the contact information is displayed. | true |
| historyTransactionDayCount | Integer | It defines the maximum age of transactions in days for the transaction history. | 30 |
| salesOrderCustomerAddressTypeCode | String | Defines the customer type which is valid for customer orders. | CO |
| differentStoreAllowed | Boolean | It specifies whether it is allowed to retrieve a receipt from other stores. | true |
| displayParentCustomerField | Boolean | It specifies whether the field ParentCustomer in the contact tab is displayed. | false |
| layawayCustomerAddressTypeCode | String | It defines the customer type which is valid for layaways. | CO |
Note:
extends ProcessConfig
Log In - 01010101201
Limited Support:
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 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 |
Device Selection - 01060100012
selectDeviceConfigs
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| PrinterInReport.enableDeviceSelection | Boolean | If device selection is not enabled, the process will be skipped. | true |
| GraphicalPrinterInReport.enableDeviceSelection | Boolean | If device selection is not enabled, the process will be skipped. | true |
| TerminalInPayment.enableDeviceSelection | Boolean | If device selection is not enabled, the process will be skipped. | true |
| TerminalAdminProcess.enableDeviceSelection | Boolean | If device selection is not enabled, the process will be skipped. | true |
Payment End - 01030100998
PaymentEndConfigs
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| confirmChangeAmount | Boolean | Defines whether the change needs to be confirmed. | true |