Registration - 010201

Bulk Registration - 01020100103

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

BulkItemRegistrionConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
itemNrEan String It defines the input parameter for an item number/EAN.
uomCode String It defines the unit of measure code.
positionAmount Double It defines the line item amount.
itemPrice Double It defines the unit price.
itemQuantity Integer It defines the single quantity in the case of piece items.
errorAllowed Boolean

The parameter defines the handling of items which are not allowed to be entered:

  • true: The not-allowed items are listed after registration in the table of skipped items. The other items are registered as normal.
  • false: The not-allowed items are not registered. A corresponding warning dialog is displayed and the registration is canceled.
 true

dynamicTableConfig

Note:
extends ProcessConfig

For this function, the dynamicTableConfig is available. The visibility of the columns can be configured there.

There is also the option to select multi-selection.

Bulk Registration RFID - 01020100113

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

rfidBulkItemRegistrationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
rfidReadingConfigID String The parameter defines the specific RfidReading process config ID for RfidBulkItemRegistration. RfidReadingConfigs.Default
mode String The parameter defines the chosen mode for RFID bulk item registration. Possible options:
  • SYNC_ONLY - Only synchronizes scanned EPC to already registered items
  • REGISTRATION - Synchronizes scanned EPC to already registered items and registers new items for EPCs not yet registered in the current transaction
  • OFFLINE_EPC - Registration of tracked items without RFID reader
 REGISTRATION
positionOperationConfig PositionOperationConfig
itemEntryConfigID String The parameter defines the specific ItemEntry configID for RfidBulkItemRegistration. ItemEntryConfigs.RfidBulkItemRegistration
errorAllowed Boolean The parameter defines the handling of items which are not allowed to be entered:
  • true: The not-allowed items are listed after registration in the table of skipped items. The other items are registered as normal;
  • false: The not-allowed items are not registered. A corresponding warning dialog is displayed and the registration is canceled.
 true
tableConfig TableConfig The parameter defines the link to the table config for the configurable step controller.
itemNrEan String The parameter is an input parameter for itemNr/EAN to skip the RFID scan e.g. if scanned from a barcode.
itemTraceableUnitID String The parameter is an input parameter for the item traceable unit ID (EPC) to skip the RFID scan e.g. if scanned from a barcode.

rfidDeviceActivationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
rfidReadingConfig RfidReadingConfig

RfidReadingConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
displayItems Boolean It defines whether a table is shown from which the user can select the items to be added/synchronized with the transaction.

For continuous reading (readingMode == Continuous), the parameter is not supported. Therefore, setting the parameter to true is only supported in the single reading mode (readingMode == Single).

 false
mode String The parameter defines the chosen mode for RFID Bulk Item Registration.
itemNrEan String The parameter is an input parameter for itemNr/EAN to skip the RFID scan e.g. if scanned from a barcode.
itemTraceableUnitID String The parameter is an input parameter for the item traceable unit ID (EPC) to skip the RFID scan e.g. if scanned from a barcode.
readingMode String This property defines the RFID Reading Mode. Possible values:
  • Single: The RFID scanner executes only a single read operation. It starts and detects all tags in reader range once and stops again.
  • Continuous: The RFID scanner executes continuous read operations. Once started, it detects all tags in the reader range and all further tags that enter the reader range later as well until the continuous reading mode is stopped again.
 Continuous

RfidReturnWithTransactionConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
rfidReadingConfigID The parameter defines the specific RfidReading process config ID for RfidBulkItemRegistration. RfidReadingConfigs.Default
mode String The parameter defines the chosen mode for RFID Bulk Item Registration. REGISTRATION
itemNrEan String The parameter is an input parameter for itemNr/EAN to skip the RFID scan e.g. if scanned from a barcode.
itemTraceableUnitID String The parameter is an input parameter for the item traceable unit ID (EPC) to skip the RFID scan e.g. if scanned from a barcode.

RfidPaymentEndConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
reconcileItemsPositionOperationConfig PositionOperationConfig The position operation config for the reconcileItems action

RfidScannerConfig

Note:
instance DETEGO_JPOS
Parameter Name Data Type, Range Description Default
debug Boolean Defines whether additional debug logging is enabled. false
claimTimeout Integer Defines the timeout value in milliseconds to wait for a successful device claim. 2000
freezeEventsOnOpen Boolean Defines whether a Javapos event should be frozen while opening the device. true
enableDataEventsOnOpen Boolean Defines whether data events are enabled while opening the device. true
readTimerInterval Integer Defines the interval (in milliseconds) of reading operations when the device continuous reading mode is started. 1000
checkHealth PositionOperationConfig The parameter defines whether the RFID scanner should use a health check for the device before starting any further action with the device. false
healthCheckInterval Integer The parameter defines the interval (in milliseconds) of health checks. This attribute has no effect if checkHealth is false. 5000
readTimeout Integer Defines the read tag timeout in milliseconds (only used for RfidReadingConfig.Single). A value smaller or equal to 0 means no timeout. 0
rfidReadCommand String This property defines the RFID read command. ID_AND_FULL_USER_DATA
deviceActivityConfig DeviceActivityConfig reference\:DeviceActivityConfigs.RfidScanner

DeviceActivityConfig

Note:
extends AbstractEntity
Parameter Name Data Type, Range Description
enableProcesses ProcessContext[1..*] The parameter defines a collection of process context entries for enabling the device.
resetEventKeys String [1..*] The parameter defines a collection of event keys for resetting the toggle button status.

ProcessContext

Note:
extends AbstractEntity
Parameter Name Data Type, Range Description
processName String The parameter defines the process name.
contextIds String [1..*] The parameter defines a list of context IDs, e.g. 'Return' for enabled return mode

RfidProcessorConfig

Note:
extends AbstractEntity
Parameter Name Data Type, Range Description
rules RfidConfig[ 0 .. * ]

RfidConfig

Note:
extends AbstractEntity
Parameter Name Data Type, Range Description
id Integer
name String
posStates PosState[ 0 .. * ] List of processes in which the configuration is allowed.
actions RfidAction[ 1 .. * ] List of RFID Actions

RfidAction

Parameter Name Data Type, Range Description
processReactions ProcessReaction [ 1 .. * ] Defines a process action to execute.
configId String This parameter defines the ID of the config which should be used when the action is executed.
configParameters Parameter[ 0 .. * ] This parameter defines a list of config parameters which should be overridden.

jpos.xml

Parameter Name Data Type, Range Description Default
enableBatchProcessing Boolean This parameter defines whether items are sent in one or multiple requests to the RFID service:
  • true: multiple items are sent in one request to the RFID Service
  • false: each item is sent individually
 false
address String This parameter defines the address to the RFID service endpoint http://localhost:8090/PosService
timeout Int This parameter defines the receive timeout config in milliseconds 15000
connectionTimeout Int This parameter defines the connection timeout config in milliseconds. 2000
username String This parameter defines the username for basic authentication, if required
password String This parameter defines the password for basic authentication, if required

Change Line Item - 01020100120

ChangeLineItemConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
transactionPreviewContextConfig TransactionPreviewContextConfig It defines the configuration for the transaction preview. The config parameters will be passed to the transaction preview component, controller, report and datasource.
keepLineItemEditingMode Boolean The parameter specifies whether the change line item functions should stay after a line item change was done.
  • true: the change line item screen continues to be displayed after a change line item function was performed
  • Exception void line item (Line Item Cancellation - 01040100502): If a line item was voided, the registration mask is displayed afterwards independently of the value of this parameter
  • false: the registration mask is displayed after a change line item function was performed
 false

TransactionPreviewContextConfig

Parameter Name Data Type, Range Description Default
templateName String This parameter defines the name of the report template.
horizontalPositioningType HorizontalPositioningType [

Char as "1",

Pixel as "2"]

 It specifies the unit for the "posX" and "width" values in the report template:
  • Char as "1": The positioning unit depends on character width
  • Pixel as "2": The positioning unit depends on pixel width
 Pixel
verticalLinePadding Integer It specifies additional vertical line padding. This value will be added to the calculated line height, based on the font metrics. If you define any background colors (bgColor) in your report template, you should define an additional vertical line padding.
verticalLineSpacing Integer This value will be subtracted from the height of an entry rectangle, which will cause an additional vertical line spacing between the painted entries.

The value must be smaller or equal to verticalLinePadding. Otherwise, the text will be cut. If you define any background colors (bgColor) in your report template, you can define a vertical line spacing between the lines.
considerScopeTransactions Boolean It sets whether scope transactions should be considered or not.

If true, the active main or scoped transaction will be processed and displayed; otherwise, only the mainTransaction.
showHeader Boolean It specifies whether the header should be displayed or not.
showTotals String[0..*] It specifies whether the total should be displayed or not.
rowSelectionAllowed Boolean It specifies whether row selection is allowed in general.
cellEditAllowed Boolean It specifies whether inline cell editing is allowed in general.
showReturnableQuantity Boolean It specifies whether the returnable quantity for a line item should be displayed or not.
showLastChangedRow Boolean It specifies whether the last changed row should be made visible.
editLastChangedRow Boolean It specifies whether the last changed row should be edited.
showSubtotalRounding Boolean It sets whether the subtotal rounding should be displayed or not.
showChangeRounding Boolean It sets whether the change rounding should be displayed or not.
showLineItems String It specifies whether the line items for the given type codes should be displayed or not.
selectableLineItems String It specifies whether line items for the given type codes are selectable or not.
editableLineItems String It specifies whether line items for the given type codes are editable inline (cell editors) or not.

Delete Comment for Line Items - 01020100123

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

DeleteCommentForLineItemConfigs

Note:
extends ProcessConfig

Empties Return - 01020100210

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

EmptiesReturnConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
onlyOneEmptiesReturnLineItem Boolean It specifies whether the empties return mode is finished automatically after one empties return line item. false
toggleEmptiesReturnModeConfig String ToggleEmptiesReturn

ModeConfigs.Exit

EmptiesReturnMode
fixEmptiesReturnItem String It specifies an item for empties return.

Enter Comment for Line Items - 01020100121

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

EnterCommentForLineItemConfigs

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
fixComment String The parameter defines a fixed comment. The fixed comments can be configured behind the corresponding buttons. There is no translation required.

It is used for the most used comments to prevent the cashier from having to enter them again and again.
useRestrictedComments Boolean It defines whether restricted comments for the item should be used. false

RestrictedItemComments

Parameter Name Data Type, Range Description Default
merchandiseHierarchyGroupComments MerchandiseHierarchyGroupComments[0..*] Assignment of comments to merchandise hierarchy groups

Only the first valid set of comments for an item will be considered.

MerchandiseHierarchyGroupComments

Parameter Name Data Type, Range Description Default
merchandiseHierarchyGroupIdList String The parameter defines a list of merchandise hierarchy groups IDs separated by a semicolon. The configured comments are displayed for these merchandise hierarchy groups.
commentKeys String[0..*] List of translation keys for comments
Required Boolean Defines whether the comment is required to enter the item. false

Function Rights - 01020100017

LineItemProcessRightsConfig

Parameter Name Data Type, Range Description
returnTypeRights LineItemProcessRights[String] Process rights for return types.
lineItemTypeRights LineItemProcessRights[String] Process rights for line item types.
salesOrderTypeCodeRights LineItemProcessRights[String] Process rights for customer order types.
externalReceiptOfflineRights LineItemProcessRights[String] Process rights for offline registration of external receipts.
salesOrderModeRights LineItemProcessRights[String] Process rights for customer order mode.

LineItemProcessRights

Parameter Name Data Type, Range Description
processIds String[1..*] List of allowed processes.

Item Entry - 01020100102

ItemEntryConfig

Parameter Name Data Type, Range Description Default
fixedItemNrEan String It defines the fixed item number/EAN for fixed item keys.

If this parameter is filled, an entry which is made before the function call will be registered as a single quantity in the case of piece items.
itemNrEan String It defines the input parameter for an item number/EAN.
checkSalesRestrictions Boolean It defines whether sales restrictions are verified. true
checkSalesRestrictionsForReturn Boolean It defines whether sales restrictions are verified for return items. false
checkSellerAgeRestrictions Boolean It defines whether sales restrictions for the seller are verified. false
checkForVariants Boolean It defines whether a check is made for item variants. true
askForQuantity Boolean It specifies whether a quantity is requested. false
salesRestrictionId String It specifies an ID of a sales restriction that is to be checked additionally.
fskUskRestriction String It defines the sales restriction
ageVerificationRequired Boolean It defines if age verification is required for the item. If verification is required, then a confirmation dialog is displayed where the operator has to confirm the age of the customer or refuse the item entry. false
positionAmount Double It defines the line item amount.
itemPrice Double It defines the unit price.
factor Double It defines the packaging quantity of an item.
itemQuantity Integer It defines the single quantity in the case of piece items.
traceableItemId string It defines a traceable item ID (EPC).
serialNumber String It defines the serial number.
saleableWithoutPrice Boolean It defines whether an item is salable even if no price exists. true
switchToItemSearch Boolean It defines whether the system switches to Item Search if no search term exists. true
askForReceiptText Boolean It defines whether the receipt text of the item is requested. false
returnManual PositionAmountFor WeightItemsRequired Boolean It specifies whether the total price entry is requested in the case of a return of weight items. The value is set by Goods Return.
returnReasonRequired Boolean It specifies whether the reason is requested in the case of returns. The value is set by Goods Return.
returnManualPriceRequired Boolean It specifies whether a manual price entry is requested in the case of returns. The value is set by Goods Return.
promptForReceiptTextConfig Global - 010#PromptUserDialogConfig It defines the config for the Enter Receipt Text dialog.
promptForSerialNumberConfig Global - 010#PromptUserDialogConfig It defines the config for the Enter Serial Number dialog.
positionOperationConfig Global - 010#PositionOperationConfig It defines the configuration for line item-related operations.
priceDifference LimitExceedAuthConfig Authorization - 01010101205#AuthorizationConfig
promotionOperationConfig
forceManualWeight Boolean It defines whether the weight must be entered manually. This could be used for items that cannot be weighed with a normal checkout scale. false
quantityAccumulation Boolean It defines whether the quantity of line items with the same item should be accumulated. false
callPackageSelection Boolean It defines whether the Packaging Selection function is called. false
itemRegistrationConfig ItemRegistrationConfig
itemIDCaseSensitive Boolean It defines whether the item search is case-sensitive. false
manualPrice AcousticSignalConfigId String
quantityAcousticSignalConfigId String
serialNumber AcousticSignalConfigId String
checkTaxGroup Boolean This parameter specifies whether the tax group should be validated. true
itemProvider Local

LocalAndRemote

 The parameter defines the provider for the item data.

Local ... The item will be searched just locally.

LocalAndRemote ... The item will be searched locally first. If the item was not found, then the search will be repeated remotely.

 Local
removeOpenLineItemOnError Boolean It defines whether an open line item (without item) will be removed if item entry fails with an error.

It should be set to true for barcode rules with multiple actions where the second action is the item entry process.

 false
itemNotFoundAction String It defines the action after confirmation of the "Item Not Found" error.
  • Error ... Only display the error
  • MerchandiseCategorySale ... Switch to Merchandise Category Sale after confirmation of the "Item Not Found" error
 MerchandiseCategorySale

PromotionOperationConfig

Parameter Name Data Type, Range Description Default
triggerType String It defines the trigger type (reference to the corresponding promotion) for the Loyalty Engine (e.g. CO).
triggerValue String It defines the trigger value (reference to the corresponding promotion) for the Loyalty Engine.
privilegeType PromotionTriggerPrivilegeType [REBATEPERCENT, REBATESINGLE, NEWPRICE, REBATEAMOUNT]

RP/RS/PS/AM

 Type of manual discount

RP: Discount in %

RS: Absolute discount

PS: New price

AM: Discount value resulting from promotion

 RP
privilegeValue Double It defines the condition value.
sequenceType PromotionTriggerSequenceType [

FIX

MAX

SAME]

 FIX: Only one entry can be created per TriggerValue for the currently active line item. If an entry exists already, this entry will be overwritten.

MAX: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item.

SAME: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item. The sequence addend always corresponds to the value defined in the parameter START_SEQUENCE.

 FIX
startSequence Integer It defines the start value of the sequence addend. 1
maxSequence Integer It defines the maximum number of conditions/promotions with the same trigger value. 10
maxLimitWarn Double It defines the maximum percentage deviation from the unit price of the line item, from which a warning message is displayed. A warning message is displayed if the defined maxLimitWarn is exceeded. 30.0
maxLimitAuthorize Double It defines the maximum percentage deviation from the unit price of the item, from which authorization is required. Authorization is required if the defined maxLimitAuthorize is exceeded. 50.0
maxLimitForbid Double It defines the maximum percentage deviation from the unit price of the item, from which it is not allowed to exceed the limit. An error message is required if the defined maxLimitForbid is exceeded. The operation will be canceled. 75.0
priceDeviationType ALL

EQUAL_LESS

EQUAL_GREATER

 It defines the price deviation with respect to the previously valid line item price:

ALL: The new price can be greater than, smaller than, or equal to the previously valid line item price.

EQUAL_LESS: The new price must be smaller than or equal to the previous price.

EQUAL_GREATER: The new price must be greater than or equal to the previous price.

 ALL

CustomerSpecificPricesConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
enableCustomerSpecificPrices Boolean The parameter defines whether customer-specific prices should be applied and be displayed in the Item Info. false
dataProviderCustomerSpecificPriceService String The parameter specifies the data provider for retrieving the customer-specific prices:
  • LOCAL: The local customer-specific prices stored in the master data are used.
  • WEBSERVICE: A web service (configured centrally) is used to retrieve the customer-specific prices.
 LOCAL
customerSpecificPriceCardType String The parameter defines the customer card type which should be used for the customer-specific prices. CO
thresholdCustomerSpecificItemCheck Integer The parameter defines the threshold value for the download of the customer-specific prices by the web service.

If x (value of the parameter) items are entered, the download is triggered for the last x entries.

 5

Item Search - 01020100104

Functional Parameters

ItemSearchConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
askForDescription Boolean It controls whether the description can be entered as the search criterion. true
askForNumber Boolean It controls whether the item number can be entered as the search criterion. true
askForMerchandiseGroup Boolean It controls whether the merchandise category can be entered as the search criterion. true
askForPrice Boolean It controls whether the price can be entered as the search criterion. true
askForUomCode Boolean This parameter indicates the question for the unit of measure code as part of the search terms. true
maxCount Integer It defines the maximum number of search results. 50
checkSaleability Boolean It specifies whether the search is limited to salable items only. true
addWildcardsToCriteria Boolean It specifies whether search criteria contain wildcards. true
showSetFlag Boolean It specifies whether the set item flag is displayed on the item list. false
packageSelection Boolean It specifies whether the search is limited to package items only. false
itemIDCaseSensitive Boolean It specifies whether the item search is case-sensitive. false

Line Item Closing - 01020100101

PositionOperationConfig

Parameter Name Data Type, Range Description
closePrevious ClosePositionAction

[REQUIRED, IFPOSSIBLE, DISABLED]

 It defines whether the current line item is closed before function execution or not.

REQUIRED: required

IFPOSSIBLE: if possible

DISABLED: disabled
closeCurrent ClosePositionAction

[REQUIRED, IFPOSSIBLE, DISABLED]

 It defines whether the current line item is closed after function execution or not.

REQUIRED: required

IFPOSSIBLE: if possible

DISABLED: disabled

Line Item Creation - 01020100030

ItemEntryConfig

Parameter Name Data Type, Range Description Default
fixedItemNrEan String It defines the fixed item number/EAN for fixed item keys.

If this parameter is filled, an entry which is made before the function call will be registered as a single quantity in the case of piece items.
itemNrEan String It defines the input parameter for an item number/EAN.
uomCode String It defines the unit of measure code.
checkSalesRestrictions Boolean It defines whether sales restrictions are verified. true
checkSalesRestrictionsForReturn Boolean It defines whether sales restrictions are verified for return items. false
checkForVariants Boolean It defines whether a check is made for item variants. true
takeoverSetComponents Boolean It defines whether set components are applied instead of the header item. false
askForQuantity Boolean It specifies whether a quantity is requested. false
salesRestrictionId String It specifies an ID of a sales restriction that is to be checked additionally.
fskUskRestriction String It defines the sales restriction
ageVerificationRequired Boolean It defines whether age verification is required for the item. If verification is required, then a confirmation dialog is displayed where the operator has to confirm the age of the customer or refuse the item entry. false
positionAmount Double It defines the line item amount.
itemPrice Double It defines the unit price.
factor Double It defines the packaging quantity of an item.
itemQuantity Integer It defines the single quantity in the case of piece items.
traceableItemId string It defines a traceable item ID (EPC).
serialNumber String It defines the serial number.
saleableWithoutPrice Boolean It defines whether an item is salable even if no price exists. true
switchToItemSearch Boolean It defines whether the system switches to Item Search if no search term exists. true
askForReceiptText Boolean It defines whether the receipt text of the item is requested. false
returnManual PositionAmount ForWeightItemsRequired Boolean It specifies whether the total price entry is requested in the case of a return of weight items. The value is set by Goods Return.
returnReasonRequired Boolean It specifies whether the reason is requested in the case of returns. The value is set by Goods Return.
returnManual PriceRequired Boolean It specifies whether a manual price entry is requested in the case of returns. The value is set by Goods Return.
promptForReceipt TextConfig PromptUserDialogConfig It defines the config for the Enter Receipt Text dialog.
promptForSerial NumberConfig PromptUserDialogConfig It defines the config for the Enter Serial Number dialog.
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
priceDifference LimitExceed AuthConfig AuthorizationConfig
promotionOperationConfig
forceManualWeight Boolean It defines whether the weight must be entered manually. This could be used for items that cannot be weighed with a normal checkout scale. false
quantityAccumulation Boolean It defines whether the quantity of line items with the same item should be accumulated. false
callPackageSelection Boolean It defines whether the Packaging Selection function is called. false
itemRegistrationConfig ItemRegistrationConfig
itemIDCaseSensitive Boolean It defines whether the item search is case-sensitive. false
manualPrice AcousticSignal ConfigId String
quantityAcoustic SignalConfigId String
serialNumber AcousticSignalConfigId String

PromotionOperationConfig

Parameter Name Data Type, Range Description Default
triggerType String It defines the trigger type (reference to the corresponding promotion) for the Loyalty Engine (e.g. CO).
triggerValue String It defines the trigger value (reference to the corresponding promotion) for the Loyalty Engine.
privilegeType PromotionTriggerPrivilegeType [REBATEPERCENT,

REBATESINGLE,

NEWPRICE,

REBATEAMOUNT]

RP/RS/PS/AM

 Type of manual discount

RP: Discount in %

RS: Absolute discount

PS: New price

AM: Discount value resulting from promotion

 RP
privilegeValue Double It defines the condition value.
sequenceType PromotionTriggerSequenceType [

FIX

MAX

SAME]

 FIX: Only one entry can be created per TriggerValue for the currently active line item. If an entry exists already, this entry will be overwritten.

MAX: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item.

SAME: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item. The sequence addend always corresponds to the value defined in the parameter START_SEQUENCE.

 FIX
startSequence Integer It defines the start value of the sequence addend. 1
maxSequence Integer It defines the maximum number of conditions/promotions with the same trigger value. 10
maxLimitWarn Double It defines the maximum percentage deviation from the unit price of the line item, from which a warning message is displayed. A warning message is displayed if the defined maxLimitWarn is exceeded. 30
maxLimitAuthorize Double It defines the maximum percentage deviation from the unit price of the item, from which authorization is required. Authorization is required if the defined maxLimitAuthorize is exceeded. 50
maxLimitForbid Double It defines the maximum percentage deviation from the unit price of the item, from which it is not allowed to exceed the limit. An error message is required if the defined maxLimitForbid is exceeded. The operation will be canceled. 75
priceDeviationType ALL

EQUAL_LESS

EQUAL_GREATER

 It defines the price deviation with respect to the previously valid line item price:

ALL: The new price can be greater than, smaller than, or equal to the previously valid line item price.

EQUAL_LESS: The new price must be smaller than or equal to the previous price.

EQUAL_GREATER: The new price must be greater than or equal to the previous price.

 ALL

Line Item Repetition - 01020100110

Not Supported: MPOS Size S

RepeatLineItemConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range
positionRepetitionOperationConfig PositionOperationConfig
positionRepetitionConfig PositionRepetitionConfig
positionRepetitionClientConfig PositionRepetitionClientConfig

PositionRepetitionConfig

Parameter Name Data Type, Range Description Default
repeatQuantity Boolean True: The quantity input (single quantity) of the old line item is applied to the new line item.

False: The single quantity of the new line item will be 1.

 true
repeatManualDiscounts Boolean True: Manual discounts are copied to the new line item.

False: Manual discounts are not copied to the new line item.

 false

PositionRepetitionClientConfig

Parameter Name Data Type, Range Description Default
quantityAllowed Boolean True: Line items with a single quantity greater than 1 can be repeated.

False: Line items with a single quantity greater than 1 cannot be repeated.

 true
quantityQuestion Boolean True: If a line item with a single quantity greater than 1 is repeated, the quantity of the new line item must be entered.

False: The single quantity is not requested.

 true
weightAllowed Boolean True: Line items with weight can be repeated.

False: Line items with weight cannot be repeated.

 false
weightQuestion Boolean True: If a line item with weight is repeated, the weight of the new line item must be entered.

False: The weight is not requested. The weight of the original line item applies.

 true
measureAllowed Boolean True: Line items with dimensions can be repeated.

False: Line items with dimensions cannot be repeated.

 true
measureQuestion Boolean True: If a line item with dimensions is repeated, the quantity of the new line item must be entered.

False: The quantity is not requested. The quantity of the original line item applies.

 true
lengthAllowed Boolean True: Line items with length data can be repeated.

False: Line items with length data cannot be repeated.

 true
lengthQuestion Boolean True: When a line item with length data is repeated, the length of the new line item must be entered.

False: The length is not requested. The length of the original line item applies.

 true
areaAllowed Boolean True: Line items with area data can be repeated.

False: Line items with area data cannot be repeated.

 true
areaQuestion Boolean True: When a line item with area data is repeated, the area of the new line item (length, width) must be entered.

False: The area is not requested. The area of the original line item applies.

 true
volumeAllowed Boolean True: Line items with volume data can be repeated.

False: Line items with volume data cannot be repeated.

 true
volumeQuestion Boolean True: If a line item with volume data is repeated, the volume of the new line item (length, width, height) must be entered.

False: The volume is not requested. The volume of the original line item applies.

 true
quantityWith DecimalsAllowed Boolean True: Line items of item type 07 (quantity input with decimal digits but without an automatic quantity prompt) can be repeated.

False: Line items of item type 07 cannot be repeated.

 true
quantityWith DecimalsQuestion Boolean True: When a line item of item type 07 is repeated, the quantity of the new line item must be entered.

False: The quantity is not requested. The quantity of the original line item applies.

 true
manualDiscountsAllowed Boolean True: Line items with manual discounts can be repeated.

False: Line items with manual discounts cannot be repeated.

 true
repeatCounterReceipt Integer Maximum number of line item repetitions for an item included in a receipt.

If the parameter is not filled or contains the value 0, no check will be made.
receiptCounter Integer Maximum number of consecutive repetitions.

If the parameter is not filled or contains the value 0, no check will be made.
prepaidAllowed Boolean True: Prepaid items can be repeated.

False: Prepaid items cannot be repeated.

 true
quantityAccumulation Boolean It defines whether the quantity of line items with the same item should be accumulated. false
traceableUnitID RepetitionAllowed Boolean It defines whether items with item traceable unit ID can be repeated. false
traceableUnitID ShowRepetitionHint Boolean It defines whether the operator should be notified about items with traceable unit IDs when repetition operation is allowed and items with a traceable unit ID are present in the current line item. false

Manual Price - 01020100107

SetPriceForLineItemConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
setPriceMode SetPriceMode [

DefaultMode as "defaultMode",

ValidationMode as "validationMode",

NoPriceMode as "noPriceMode",

ReturnMode as "returnMode"]

 It defines the function mode. DefaultMode
itemRequired Boolean It specifies whether an item must have been entered to execute the function. false
reasonRequired Boolean It defines a flag to indicate whether a reason for price changes is required. true
reasonOnReturnItemsRequired Boolean It defines a flag to indicate whether a reason for price changes of return items is required.
reasonCodeGroupCode String It defines a code that identifies the reason group.
reasonCode It specifies a fixed predefined reason code (if set, no reason selection appears).
priceTypeCode String It defines the price type.
price Double It defines the price.
setOrChangePrice PositionOperationConfig
confirmedChangePrice PositionOperationConfig
pricePositionLimit PositionOperationConfig
priceDeviationType PositionOperationConfig
priceNegDeviationType PositionOperationConfig
priceDifference LimitExceedAction PositionOperationConfig
priceNegDifference LimitExceedAction PositionOperationConfig
priceDifference PercentPositionLimit PositionOperationConfig
priceDifference AbsolutePositionLimit PositionOperationConfig
priceDifference LimitExceedAuthConfig AuthorizationConfig
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
warningPrice DifferenceLimitExceed MessageDialogConfig
errorPriceDifference LimitExceed MessageDialogConfig
errorItemRequired MessageDialogConfig
errorPriceChange NotAllowed MessageDialogConfig
errorPriceMissing MessageDialogConfig
errorPriceWrongInput MessageDialogConfig

Merchandise Category Sale - 01020100201

Functional Parameters

Table 1. MerchandiseCategorySaleConfig
Parameter Name Data Type, Range Description Default
rootMerchandiseGroupId String It contains a start value for the iterative selection of the merchandise category number. 0
inputMerchandiseGroupId String It is defined as a merchandise category number.

If the parameter is filled, this merchandise category will be used for the line item creation.
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
singleRestriction String It contains the ID of a single sales restriction which is checked.
checkSalesRestrictions Boolean It determines whether the singleRestriction has to be checked or not. false
amount Double Input parameter for amount
posItemId String Input parameter for POS item ID
registrationNumber String Input parameter for registration number
returnReasonRequired Boolean It specifies whether the reason is requested in the case of returns. true
Note:
extends ProcessConfig

Package Selection - 01020100122

Functional Parameters

Table 2. PackageSelectionConfig
Parameter Name Data Type, Range Description Default
requiredUomCode String It defines the required unit of measure code of the displayed package units.
overtakeWithoutConfirmation Boolean If only one item is found, then it specifies whether this item is directly used to create a line item, or the dialog for packaging selection is displayed anyway. true
itemNrEan String It defines the input parameter for an item number/EAN.
skipEnteredItem Boolean Specifies whether the entered item is excluded from the selection. true
itemEntryConfigId String It defines the temporary configuration for the ItemEntry sub-process.
Note:
extends ProcessConfig

Quantity - 01020100111

SetQuantityForLineItemConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
quantity Integer It defines the input parameter of the single quantity.
length Double It defines the input parameter of the length.
width Double It defines the input parameter of the width.
height Double It defines the input parameter of the height.
weight Double It defines the input parameter of the weight.
measure Double It defines the input parameter of the dimension.
changeQuantity OperationConfig PositionOperationConfig
quantityTooHigh AuthorizationConfig AuthorizationConfig
scaleRequired Boolean It defines whether the weight must be determined by a scale.

If not, then it can be entered manually.

 false
forceManualWeight Boolean It defines whether the weight must be entered manually. false
manualWeightOnReturn Boolean It defines whether the weight must be entered manually in the case of a goods return. false
scaleDeviceId String It specifies the scale device ID for weighing processes.
confirmReduceQuantity Boolean It defines whether the operator has to confirm the decrease in line item quantity. true
confirmReduceQuantity MessageDialogConfig MessageDialogConfig
promptForQuantity PromptUserDialogConfig

Sales Info - 01020100034

ItemRegistrationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
discountInfoEnabled Boolean It defines whether the discount info should be displayed in the transaction preview. true
itemInfoEnabled Boolean It defines whether the item info should be displayed in the transaction preview. true
iconSalesInfoTextTypeCodes String[0..*] It defines a list of text type codes that should be displayed as sales info icons. SAIC

SICO
textSalesInfoTextTypeCodes String[0..*] It defines a list of text type codes that should be displayed as sales info text. SATE
salesInfoTextLimit Integer It defines the number of displayed text sales information. 5

SetQuantityForLineItemConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
quantity Integer It defines the input parameter of the single quantity.
length Double It defines the input parameter of the length.
width Double It defines the input parameter of the width.
height Double It defines the input parameter of the height.
weight Double It defines the input parameter of the weight.
measure Double It defines the input parameter of the dimension.
changeQuantityOperationConfig PositionOperationConfig
quantityTooHighAuthorizationConfig AuthorizationConfig
scaleRequired Boolean It defines whether the weight must be determined by a scale.

If not, then it can be entered manually.

 false
forceManualWeight Boolean It defines whether the weight must be entered manually. false
manualWeightOnReturn Boolean It defines whether the weight must be entered manually in the case of a goods return. false
scaleDeviceId String It specifies the scale device ID for weighing processes.
confirmReduceQuantity Boolean It defines whether the operator has to confirm the decrease in line item quantity. true
confirmReduceQuantityMessageDialogConfig MessageDialogConfig
promptForQuantity PromptUserDialogConfig

Salesperson - 01020100109

Functional Parameters

Table 3. AssignSellerForLineItemConfig
Parameter Name Data Type, Range Description Default
sellerRelationMethod SellerRelationMethod
  • CurrentLineItemOnly
  • CurrentAndFollowing

    LineItemsOfCurrentTransaction

  • CurrentAndFollowing

    LineItemsOfCurrentAnd

    FollowingTransactions

  • FollowingLineItemsOfCurrentTransaction
  • FollowingLineItemsOfCurrentAndFollowingTransactions
  • AllLineItemsOfCurrentTransaction
 CurrentLineItemOnly: The salesperson is exclusively assigned to the current line item.

CurrentAndFollowingLineItemsOfCurrentTransaction: The salesperson is assigned to the current and all subsequent line items of the current receipt.

CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions: The salesperson is assigned to the current and all subsequent line items of the current receipt and all subsequent receipts.

FollowingLineItemsOfCurrentTransaction: The salesperson is assigned to all subsequent line items of the current receipt.

FollowingLineItemsOfCurrentAndFollowingTransactions: The salesperson is assigned to all subsequent line items of the current receipt and all subsequent receipts.

AllLineItemsOfCurrentTransaction: The salesperson is assigned to all line items of the current receipt.

 FollowingLineItemsOfCurrentTransaction
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
inputObligation Boolean It specifies whether a salesperson number must be entered or if it is possible to leave the field blank/cancel the function.

This parameter is only taken into account when the function is automatically called at the beginning of a receipt.

 true
assignSeller Boolean It defines whether the POS Client asks for a salesperson when the first line item is entered. false
assignCashierAsSeller Boolean It defines whether the logged-in cashier is set as the salesperson. false
sellerNumber String It defines the salesperson number.
Note:
extends ProcessConfig

Sales Restrictions - 01020100130

SalesRestrictionsConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
ageRestrictionAuthorizationConfig AuthorizationConfig
limitRestrictionAuthorizationConfig AuthorizationConfig
timeRestrictionAuthorizationConfig AuthorizationConfig
lineItemExtensionOperationConfig PositionOperationConfig
allowOnlyOneQuantityLimitItem Boolean It specifies whether only one item with limited quantity is allowed on the receipt. false
showDialogOnRefusal Boolean It controls whether an additional error message is displayed when rejecting a sales query. false
authorizeCustomerAgeRestriction Boolean It controls whether authorization is required if the item sale is rejected due to the customer age restriction. false
authorizeTimeRestriction Boolean It controls whether authorization is required if the item sale is rejected due to restrictions on the time of sale. false
authorizeLimitRestriction Boolean It controls whether authorization is required if the item sale is rejected due to quantity restrictions. false
dialogSalesRestrictionsInfo MessageDialogConfig
dialogSalesRestrictionsConfirmation MessageDialogConfig
dialogSalesRestrictionsWarning MessageDialogConfig
quantityRestrictionOnlyOnePieceAcousticSignalConfigId String
quantityRestrictionLimitExceededAcousticSignalConfigId String
ageRestrictionAcousticSignalConfigId String
salesRestrictionConfirmAcousticSignalConfigId String
registrationNotAllowedAcousticSignalConfigId String
scoConfirmRegistrationAuthorizationConfig AuthorizationConfig
scoOnlyOneQuantityLimitItemAllowedAuthorizationConfig AuthorizationConfig
scoRegistrationForbiddenAuthorizationConfig AuthorizationConfig
scoRegistrationNotAllowedAuthorizationConfig AuthorizationConfig
scoAgeRestrictionAuthorizationConfig AuthorizationConfig
scoItemsForbiddenAuthorizationConfig AuthorizationConfig
scoDialogAgeRestrictionConfirmation MessageDialogConfig
voidForbiddenItemsOperationConfig PositionOperationConfig
singleRestriction String It contains the ID of a single sales restriction which is checked.
specificAgeCheck Boolean It determines whether the regular confirm dialog is displayed or a specific age check is performed. false

Selling Process - 01020100100

ItemRegistrationConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description
processBarcodeConfig ProcessBarcodeConfig It defines the config for barcode processing.
transactionPreviewContextConfig TransactionPreviewContextConfig It defines the configuration for the transaction preview. The config parameters will be passed to the transaction preview component, controller, report and datasource.
transactionPreviewShowMessage TransactionPreviewContextConfig It defines the configuration for the transaction preview in connection with the Show Message function. The config parameters will be passed to the transaction preview component, controller, report and datasource.
subTotalPositionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
promptReceiptDataConfig PromptReceiptDataConfig
goodsReturnConfig GoodsReturnConfig

ProcessBarcodeConfig

Parameter Name Migration Data Type, Range Description
barcodeTypes String [ 0 .. * ] It 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).

TransactionPreviewContextConfig

Parameter Name Data Type, Range Description Default
templateName String This parameter defines the name of the report template.
horizontalPositioningType HorizontalPositioningType [

Char as "1",

Pixel as "2"]

 It specifies the unit for the "posX" and "width" values in the report template:
  • Char as "1": The positioning unit depends on character width
  • Pixel as "2": The positioning unit depends on pixel width
 Pixel
verticalLinePadding Integer It specifies additional vertical line padding. This value will be added to the calculated line height, based on the font metrics. If you define any background colors (bgColor) in your report template, you should define an additional vertical line padding.
verticalLineSpacing Integer This value will be subtracted from the height of an entry rectangle, which will cause an additional vertical line spacing between the painted entries.

The value must be smaller or equal to verticalLinePadding. Otherwise, the text will be cut. If you define any background colors (bgColor) in your report template, you can define a vertical line spacing between the lines.
considerScopeTransactions Boolean It sets whether scope transactions should be considered or not.

If true, the active main or scoped transaction will be processed and displayed; otherwise, only the mainTransaction.
showHeader Boolean It specifies whether the header should be displayed or not.
showTotals String[0..*] It specifies whether the total should be displayed or not.
rowSelectionAllowed Boolean It specifies whether row selection is allowed in general.
cellEditAllowed Boolean It specifies whether inline cell editing is allowed in general.
showReturnableQuantity Boolean It specifies whether the returnable quantity for a line item should be displayed or not.
showLastChangedRow Boolean It specifies whether the last changed row should be made visible.
editLastChangedRow Boolean It specifies whether the last changed row should be edited.
showSubtotalRounding Boolean It sets whether the subtotal rounding should be displayed or not.
showChangeRounding Boolean It sets whether the change rounding should be displayed or not.
showLineItems String It specifies whether the line items for the given type codes should be displayed or not.
selectableLineItems String It specifies whether line items for the given type codes are selectable or not.
editableLineItems String It specifies whether line items for the given type codes are editable inline (cell editors) or not.

PromptReceiptDataConfig

Parameter Name Data Type, Range Description Default
processId String It specifies the unique process ID.
dialogTitleKey TranslationKey It specifies the key value for the prompt receipt data dialog title.
forceManualInput Boolean The input dialog will be shown even if all predefined values are filled.
businessUnitIdRequired Flag It specifies whether a business unit ID is returned and whether a business unit ID field is visible in the dialog. false
businessUnitIdEditable Flag It specifies whether the business unit ID field is editable. false
businessUnitIdPredefined IdentityUUID It specifies the predefined business unit ID.
businessUnitIdUseCurrent Flag It specifies whether a current business unit ID should be used if no predefined business unit ID is given. true
businessDayDateRequired Flag It specifies whether a business day date is returned and whether a business day date field is visible in the dialog. true
businessDayDateEditable Flag It specifies whether the business day date field is editable. true
businessDayDatePredefined Date It specifies whether a predefined value is used for the business day date.
businessDayDateUseCurrent Flag It specifies whether the current business day date should be used if no predefined business day date is given. true
workstationIdRequired Flag It specifies whether a workstation ID is returned and whether a workstation ID field is visible in the dialog. true
workstationIdEditable Flag It specifies whether a workstation ID field is editable. true
workstationIdPredefined IdentityAlphaNumeric It specifies whether a predefined value is used for the workstation ID.
workstationIdUseCurrent Flag It specifies whether a current workstation ID should be used if no predefined workstation ID is given. true
receiptNumberRequired Flag It specifies whether a transaction number is returned and whether a transaction number field is visible in the dialog. true
receiptNumberEditable Flag It specifies whether a transaction number field is editable. true
receiptNumberPredefined String It specifies whether a predefined transaction number is used.
receiptNumberUseCurrent Flag It specifies whether a current transaction number should be used if no predefined transaction number is given. true
useLastNonVoidedReceiptNumber Flag It specifies whether the last non-voided receipt number is used.

GoodsReturnConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range
withOutOriginalSc Boolean
registerCustomer Boolean
onlyOneReturnPosition Boolean
createReturnReceipt Boolean
customerIdentificationFunction CustomerIdentificationFunction [CUSTOMERREGISTRATION, CUSTOMERSEARCH]
customerRegistrationConfig CustomerRegistrationConfig
customerSearchConfig CustomerSearchConfig

AssignSellerForLineItemConfig

Parameter Name Data Type, Range Description Default
sellerRelationMethod SellerRelationMethod
  • CurrentLineItemOnly
  • CurrentAndFollowing

    LineItemsOfCurrentTransaction

  • CurrentAndFollowing

    LineItemsOfCurrentAnd

    FollowingTransactions

  • AllLineItemsOf

    CurrentTransaction

 CurrentLineItemOnly: The salesperson is exclusively assigned to the current line item.

CurrentAndFollowingLineItemsOfCurrentTransaction: The salesperson is assigned to the current and all subsequent line items of the current receipt.

CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions: The salesperson is assigned to the current and all subsequent line items of the current receipt and all subsequent receipts.

AllLineItemsOfCurrentTransaction: The salesperson is assigned to all line items of the current receipt.

 4
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
inputObligation Boolean It specifies whether a salesperson number must be entered or if it is possible to leave the field blank/cancel the function.

This parameter is only taken into account when the function is automatically called at the beginning of a receipt.

 true
assignSeller Boolean It defines whether the receipt must be assigned to a salesperson when the first line item is entered. false
assignCashierAsSeller Boolean It defines whether the logged-in cashier is set as the salesperson. false
sellerNumber String It defines the salesperson number.

PostRegistrationConfig

Parameter Name Data Type, Range Description Default
assignCustomer Boolean It specifies whether the entered customer is assigned to the receipt. false

CheckPickupLimitConfig

Parameter Name Data Type, Range Description Default
numberOfReceiptsBeforeRehearsal Integer It specifies the number of receipts after which the warning message for the exceeded tender pickup limit is displayed. 10

TerminalPaymentOperationConfigs

Parameter Name Migration Data Type, Range Description Default
saleOpenedEvents NotificationStyle saleOpenedEvent

NotificationStyle
  • NEVER
  • ALWAYS
 It controls the terminal-specific command for starting the EFT transaction:
  • NEVER – The command is never sent.
  • ALWAYS – The command is always sent.
 NEVER

Serial Number - 01020100108

Functional Parameters

Table 4. SetSerialNumberForLineItemConfig
Parameter Name Data Type, Range Description
serialNumberPredefined String Input parameter for serial number.
promptUserDialogConfig PromptUserDialogConfig It defines the configuration for prompting the user.
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
Note:
extends ProcessConfig