Service - 011901

Brand Device Service Tool - 01190100002

Not Supported: MPOS Size M MPOS Size S ONE X Stationary POS

BrandDeviceServiceToolServiceConfigs

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
executeCommandConfigId String This parameter defines the instance of the command configuration.
includedDeviceDescriptionKeys String [ 0 .. * ] This parameter defines the relevant devices that need to be considered by the process when loading the device service tool.

Digital Receipt Service API - 01190100005

WebServiceServerConfig

Parameter Name Data Type, Range Description Default
address String https://localhost/api/v1/transaction/addPosLogPdf
connectionTimeout Integer This parameter defines the timeout for establishing the connection. 3000
timeout Integer This parameter defines the timeout for responding after establishing the connection. 5000
username String
password String
passwordencryptorclass String
format String

Display Unfinished Transactions - 01190100001

UnfinishedTransactionsConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
multiSelection Boolean It controls whether multiple selection and retrieval of suspended receipts is possible from a picklist. false
storeId String It defines the Store ID.
infoMessageConfig MessageDialogConfig It configures the info message dialog.

Launch App - 01190100003

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

LaunchAppConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
requiresWorkstationLoggedOut Boolean It defines whether the app requires that the POS is logged out. If it is required and the POS is logged in, then an automatic logout will be performed and the configured app will be launched afterwards. false
browserConfig BrowserConfig It defines the app that should be launched. Additionally, it defines the browser settings for launching the app.

Launch External Application - 01190100002

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

ExecuteCommandOperationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
command String This parameter defines the command to execute.
arguments String[0..*] This parameter defines the command arguments.
watchDog Boolean This parameter defines whether the command execution should be guarded with a watchdog. The watchdog will terminate the command process after a configurable timeout. true
watchDogTimeout Int This parameter defines the watchdog timeout in seconds, if you enabled the watchdog for your command execution. 60
commandStatusMessageKey String This parameter defines the translation message key for the status message during command execution.
successExitValues Int[0..*] This parameter defines all exit values of the command that indicate a successful execution/termination. If not set, the typical system-related exit values for commands will be used (e.g. exit value 0).

Offline POS Update - 01190100004

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

OfflineCDPLUpdateConfig

Parameter Name Data Type, Range Description Default
allowUpdateCheck DuringLogin Boolean Determines whether the check for new updates will be done during the Login function. true
allowUpdateCheck DuringStartup Boolean Determines whether the check for new updates will be done after POS startup. true
maximumAllowed SkippedUpdates Int Maximum amount of times that the update can be skipped before it is forced. 6
manageSkipCount Boolean Determines whether the update process will check/increase the skip count and if it can force the update based on it. true
showUpdate ConditionWarnings Boolean Determines whether the update process will show a warning dialog when the check for an available/already running update fails. false
abortLoginOnUpdateTimeout Int Determines whether the Login function is aborted when the POS update times out. false
forceUpdateOnPOS Boolean Determines whether the update is forced or the operator can choose to skip it. false
waitingForUpdateTimeout Int Maximum amount of time in seconds that the POS will wait for the CDPL process to shut it down. 300
waitingForUpdate TimeoutMessageKey String Translation key used to get the correct message displayed in the warning about update timeout. offline.cdpl.update.timeout
allowSSHCheck Boolean Determines whether the update process should try to access the configured host:port to check if SSH is running. true
sshHost String Host name of the server on which the SSH service should be running. localhost
sshPort Int Port number on which the SSH service should be running. 22
continueLoginOn UpdateTimeoutInstanceId String The OfflineCDPLUpdateConfig instanceId, which will be used during POS login, if abortLoginOnUpdateTimeout is set to false. OfflineCDPLUpdateConfigs.

LoginContinueOnTimeout
abortLoginOn UpdateTimeoutInstanceId String The OfflineCDPLUpdateConfig instanceId, which will be used during POS login, if abortLoginOnUpdateTimeout is set to true. OfflineCDPLUpdateConfigs.

LoginAbortOnTimeout

Open Drawer - 01190100706

Not Supported: MPOS Size M MPOS Size S

Functional Parameters

Table 1. OpenDrawerConfig
Parameter Name Migration Data Type, Range Description Default
reasonRequired REASON_REQUIRED Boolean Defines whether a reason is requested. true
reasonCode REASON String Reason
reasonGroupCode String It specifies the Reason Group Code. DO
Note:
extends ProcessConfig

Receipt As Email Activation - 01190100414

ReceiptAsEmailActivationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
emailDomains String[0..*] List of email domains.
promptUserEmailAddressConfig PromptUserDialogConfig It defines the user dialog for the input of the email address.
emailAddress String Input parameter for email address
showRegistrationMessage showRegistrationMessage It defines whether a message is displayed after assignment of the email address. true

Touch Screen Cleaning - 01190101425

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

TouchScreenCleaningConfigs

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
screenCleaningMessage MessageDialogConfig Configuration for the dialog shown while cleaning the screen.
screenCleaningFinished MessageDialogConfig Configuration for the dialog confirming the cleanup was finished.