Global - 010

BaseQueryConfig

Parameter Name Data Type, Range Description
maxCount Integer It defines the maximum number of records to return.
pageSize Integer It defines the number of records per page. e.g. "<=0" means "get them all"
infoProperties String For example:
  • process.itemQuery.infoProperties=itemNumber, itemVariant, itemNormalPrice, itemSellingStatusCode, itemName, itemUOMCode, itemColorCode, itemMerchandiseHierarchyGroup
  • process.itemQuery.listProperties=itemNumber, itemVariant, itemNormalPrice, itemName, itemMerchandiseHierarchyGroup
  • action.searchWithItemNumber.itemQuery.listProperties=itemNumber, itemVariant, itemNormalPrice, itemName
listProperties String
sortProperty String It defines the property ID for sorting.
descendingSorting It specifies whether the sorting is done in descending order. It only evaluates if the sortPropertyId is set.

ShowMessageProcessConfig

Parameter Name Data Type, Range
transactionPreview TransactionPreviewContextConfig

TransactionPreviewContextConfig

Parameter Name Data Type, Range Description
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.

TPosFlowConfig

Note:
extends ProcessConfig
Table 1. ProcessConfig
Parameter Name Data Type, Range Description
processId String It specifies the unique process ID.
authorizationConfig AuthorizationConfig It specifies the authorization config.
Table 2. TransactionReportPrintConfig
Parameter Name Data Type, Range Description
defaultPrintMode PrintMode, values:
  • NoPrint
  • Print
  • AskForPrinting
  • PrintOnlyAdditionalPrintouts
  • PrintWithoutMail
  • PrintOnlyAdditionalPrintoutsForMerchant
 It defines the default fallback value of receipt printing.
  • NoPrint: Print no document
  • Print: Print document
  • AskForPrinting: Ask the operator whether document printing is required
  • PrintOnlyAdditionalPrintouts: The document itself is not printed. Only additional printouts for merchants (purpose=Merchant) and/or customer (purpose=Customer) are printed.
  • PrintWithoutMail:
    • The receipt is printed if RetailTransaction.EmailRequestedFlag == false.
    • The receipt is sent by email if RetailTransaction.EmailRequestedFlag == true
  • PrintOnlyAdditionalPrintoutsForMerchant: The document itself is not printed. Only additional printouts for merchants (purpose=Merchant) are printed.
printScalePosition Boolean It defines whether scale line items must be printed.

DialogConfig

Parameter Name Data Type, Range Description
titleKey String It defines the translation key for the title.

DialogOption

Parameter Name Data Type, Range Description
id String It defines the option unique ID.
textKey String It defines the option text - message - translation key.
visible Boolean It defines the visibility of the option.

PromptUserDialogConfig

Note:
extends DialogConfig
Parameter Name Data Type, Range Description
inputDomain String It defines the input domain for the input field.
inputMandatory Boolean It specifies whether an input is mandatory.
cancelAllowed Boolean It specifies whether a cancellation of the dialog is allowed.
labelTextKey String It defines the optional translation key for the label text.

MessageDialogConfig

Note:
extends DialogConfig
Parameter Name Data Type, Range Description
messageType DialogMessageType [INFO, CONFIRMATION, WARNING, ERROR] It defines the type of message to display.
  • INFO: Info
  • CONFIRMATION: Confirmation
  • WARNING: Warning
  • ERROR: Error
messageKey String It defines the translation for the message.
okButtonKey Boolean It defines the translation of the OK button.
cancelButtonKey String It defines the translation of the cancel button.
isTimeControlled Boolean It defines whether this is a time-controlled dialog.
duration Integer It defines the duration in msec for the time-controlled dialog.

DecisionDialogConfig

Note:
extends DialogConfig
Parameter Name Data Type, Range Description
messageType DialogMessageType [INFO, CONFIRMATION, WARNING, ERROR] It defines the type of message to display.
  • INFO: Info
  • CONFIRMATION: Confirmation
  • WARNING: Warning
  • ERROR: Error
messageKey String It defines the translation for the message.
option1 It defines the decision option 1.
option2 It defines the decision option 2.
option3 It defines the decision option 3.
option4 It defines the decision option 4.
option5 It defines the decision option 5.

PositionOperationConfig

Parameter Name Data Type, Range Description
forceQuantityInput Boolean It defines the forced quantity input for every item.
pricePositionLimit Money It defines the price position limit (-1 means disabled).
pricePositionZeroAllowed Boolean It defines whether the position of a price of 0.00 is allowed.

It will be disallowed if the fiscal limit 'positionTotalZeroAllowed' is set to false.
priceTransactionLimit Money It defines the price transaction limit (negative value turns limit off).

It may be overridden by fiscal limit 'transactionTotalAmountLimit'.
priceDifferencePercentPositionLimit Percent, Double(7,4) It defines the price difference limit in percent.
priceDifferenceAbsolutePositionLimit Money It defines the price difference limit as an absolute value.
priceDifferenceLimitExceedAction LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED] It defines the price difference limit exceed action.
  • WARN: warn
  • AUTHORIZE: authorize
  • FORBID: forbid
  • UNCHECKED: unchecked
priceNegDifferenceLimitExceedAction LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]
  • WARN: warn
  • AUTHORIZE: authorize
  • FORBID: forbid
  • UNCHECKED: unchecked
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
filterResult Boolean It defines a flag indicating filter results.
allowedWithWeight Boolean It defines a flag to indicate whether a single quantity for a weighing item is allowed.
allowedWithLength Boolean It defines a flag to indicate whether a single quantity for a length-based item is allowed.
allowedWithArea Boolean It defines a flag to indicate whether a single quantity for an area item is allowed.
allowedWithVolume Boolean It defines a flag to indicate whether a single quantity for a volume item is allowed.
allowedWithMeasure Boolean It defines a flag to indicate whether a single quantity for a measure item is allowed.
maximumQuantity Integer, Number It shows the maximum single quantity.
minimumQuantity Integer, Number It shows the minimum single quantity.
quantityInputOrder InputOrder [BEFOREORAFTER, BEFORE, AFTER] It indicates the input order for quantities.
  • BEFOREORAFTER: beforeOrAfter
  • BEFORE: before
  • AFTER: after
priceInputOrder InputOrder [BEFOREORAFTER, BEFORE, AFTER]
  • BEFOREORAFTER: beforeOrAfter
  • BEFORE: before
  • AFTER: after
quantityLimitExceedAction LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED] It defines a quantity limit exceed action.
  • WARN: warn
  • AUTHORIZE: authorize
  • FORBID: forbid
  • UNCHECKED: unchecked
weightUnitFactor Double It defines a multiplication factor for weight quantities.
measureUnitFactor Double It defines a multiplication factor for dimension quantities.
priceDeviationType DeviationType [ALL, EQUALORLESS, EQUALORGREATER]
  • ALL: all
  • EQUALORLESS: equalOrLess
  • EQUALORGREATER: equalOrGreater
priceNegDeviationType DeviationType [ALL, EQUALORLESS, EQUALORGREATER]
  • ALL: all
  • EQUALORLESS: equalOrLess
  • EQUALORGREATER: equalOrGreater