Customer - 010501

Adapter CRM SAP - 01050101130

A separate connection configuration must exist for each SAP CRM method.

Parameter Name Data Type, Range Description Default
maxActivityResults Integer Maximum number of activities. 10

WebServiceConfig

Parameter Name Data Type, Range Description Default
address String
connectionTimeout Integer This parameter defines the timeout for establishing the connection. 10000
timeout Integer This parameter defines the timeout for responding after establishing the connection. 15000
password String
passwordencryptorclass String

Adapter Loyalty System SAP - 01050101132

The configuration is defined in the file web_service.xml.

WebServiceConfig

connectionTimeout

Parameter Name Data Type, Range Description Default
address String
connectionTimeout Integer This parameter defines the timeout for establishing the connection. 10000
timeout Integer This parameter defines the timeout for responding after establishing the connection. 15000
password String
passwordencryptorclass String

Customer Data Entry - 01050101102

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

CustomerDataEntryConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
assignCustomer Boolean It specifies whether the selected customer is assigned to the receipt. true
readOnly Boolean It defines whether the customer data is read only or whether it can be edited. false
useCRMService Boolean It defines whether a customer service is used to update the customer data. false
confirmCRMServiceUsage Boolean It defines whether the operator is able to decide if the customer service should be used or not.

True: The operator decides if customer data is just entered for one transaction or if customer data is stored permanently using the customer service.

False: The value of the parameter useCRMService defines the usage of the customer service.

 false
customerOperationConfig CustomerOperationConfig It defines the configuration for general customer operations.
confirmCustomerDataEntryAbort MessageDialogConfig
customerDataAlreadyRegistered MessageDialogConfig
errorUpdateCustomerData MessageDialogConfig
tabs CustomerDataEntryTab [0..*] List of Customer Data Entry Tabs
dataPrivacyConfig DataPrivacyConfig It defines the configuration for data privacy.
printCustomerCard Boolean The parameter defines whether the function is called to print a customer card with the entered values. false
automaticTaxExemptionEnabled Boolean It controls whether it is checked whether the customer is marked for tax exemption (Customer.SalesTaxLiableFlagGK). false

CustomerDataEntryTab

Parameter Name Data Type, Range Description
tabTextKey TranslationKey Translation key of the tab
fields CustomerDataEntryTabField [0..*] List of Customer Data Entry Fields in a tab.

CustomerDataEntryTabField

Parameter Name Data Type, Range Description Default
type CustomerDataFieldType: String It defines the type of text field.
labelTextKey TranslationKey It defines the translation key of the text field.
inputDomain InputDomainId It defines the input domain for the input field.
inputMandatory Boolean It specifies whether an input is mandatory.
inputEditable Boolean It specifies whether an input into the text field is allowed. true
inputEditableInEditMode Boolean It specifies whether an input into the text field is allowed in Edit mode. false

CustomerOperationConfig

Parameter Name Data Type, Range Description Default
customerId String It defines the customer ID. 0
customerGroupId String It defines the customer group. 0
customerCardType String It defines the customer card type. CO
customerCardTypeDescriptionKey String It defines the description of the card type. Customer card
useWebService String It specifies which web service is used to retrieve customer data. If empty, then no web service will be used.

CRM

SAP ERP
dataProvider String It specifies the data provider of the customer service.
  • MASTER_DATA - SDC Customer Data
  • SAP_ERP - SAP ERP Customer Data
  • CPS - Customer Profile Service
prefix String The parameter defines the prefix of the Customer ID.
differentStoreAllowed Boolean The parameter defines whether it is allowed to register a customer by e.g. an AZTEC Code from other stores (the store is stored in the code). false
differentDateAllowed Boolean The parameter defines whether it is allowed to register a customer by e.g. an AZTEC Code with a date different from the current date (the date is stored in the code). false

DataPrivacyConfig

Parameter Name Data Type, Range Description Default
customerDeclarationRequired Boolean Defines whether the customer declaration is necessary for permanent storage of the customer data. This property only works if dataPrivacyEnabled = true. true
editCustomerReasonCodeGroupCode String It defines the code of the reason code group for editing customer data. LMO
editCustomerReasonCode String It defines the predefined reason code for editing customer data.
newCustomerReasonCodeGroupCode String It defines the code of the reason code group for creating a new customer. LCR
newCustomerReasonCode String It defines the predefined reason code for creating a new customer.

Global Configuration

Table 1. customer-data-provider.properties
Parameter Name Data Type, Range Description Default
gkr.dp.customer-data-provider.client.baseUrl String URL of the customer service http://localhost:8080/swee-sdc/tenants/

${SystemConfig.tenantId}/stores/

${SystemConfig.retailStoreId}/

rest/services/customer-data-provider/
gkr.dp.customer-data-provider.client.connectionTimeout Integer Connection timeout in ms. 50000
gkr.dp.customer-data-provider.client.readTimeout Integer Read timeout in ms. 60000
Table 2. DataPrivacyServiceConfig
Parameter Name Data Type, Range Description Default
dataPrivacyEnabled Boolean Enables processes for data privacy.

Note: Disabling this feature may violate data privacy legislation (EU-GDPR) unless other means are used to fulfill the EU Regulation.

 true

Process Parameter

Parameter Name Data Type, Range Description Default
scannedValue String Input parameter for scanner inputs
scannedFieldType String It defines which input field (e.g. Email) should be filled with the value from the parameter scannedValue. After scanning the barcode, the corresponding input field is focused.

Customer Detail Panel - 01050101129

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

Function Parameters

Table 3. CustomerInfoConfig
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

Customer Entry - 01050101101

Functional Parameters

Table 4. CustomerRegistrationConfig
Parameter Name Data Type, Range Description Default
customerOperationConfig CustomerOperationConfig It defines the configuration for general customer operations.
customerAssignedInfoDialog MessageDialogConfig
takeInputFieldValue Boolean If you enter a number and press the customer entry button, this parameter specifies whether the entered number is used as the customer number or not.

True: The value on the entry line is used.

False: The value on the entry line is ignored.

 true
manualInput Boolean It specifies whether the customer number can be entered manually. true
searchDatabase Boolean It specifies whether the customer number is searched for in the customer master data. false
searchForIdentificationNumber Boolean It specifies whether the card number is searched for in the database. false
forcedCustomerCardType String It defines the required card type.
showRegistrationMessage Boolean It specifies whether a message is displayed after entering a customer card. false
customerSearchEnabled Boolean It specifies whether the customer search can be accessed from the customer number entry mask. true
customerSearchConfigId String It specifies the config used for the customer search. CustomerSearch

Configs.Default
checkSuspendedReceipts Boolean It specifies whether the list of suspended receipts for the customer is automatically displayed after registration. false
selectShipToAddress Boolean It specifies whether the table with available "ship to" addresses is displayed. false
allowRescan Boolean It specifies whether it is allowed to enter a customer card if the same card type was already registered. true
enterLastCustomer Boolean It specifies whether the most recent customer should be registered again. false
customerCardTypeLastCustomer String It specifies the card type of the customer which should be searched for if enterLastCustomer == true. CC
automaticTaxExemptionEnabled Boolean It controls whether it is checked whether the customer is marked for tax exemption (Customer.SalesTaxLiableFlagGK). False
Note:
extends ProcessConfig
Table 5. CustomerOperationConfig
Parameter Name Data Type, Range Description Default
customerId String It defines the entered customer number/card number.
customerGroupId String It defines the customer group. 0
customerCardType String It defines the card type. 00
customerCardTypeDescriptionKey String It defines the description of the card type. Customer card
useWebservice String It specifies which web service is used to retrieve customer data. If empty, then no web service will be used.

SAP_CRM

SAP_ERP
dataProvider String It specifies the data provider of the customer service.
  • MASTER_DATA - SDC Customer Data
  • SAP_ERP - SAP ERP Customer Data
  • CPS - Customer Profile Service
prefix String The parameter defines the prefix of the replacement card.
differentStoreAllowed Boolean The parameter defines whether it is allowed to register a customer by e.g. an AZTEK Code from other stores (the store is stored in the code).
differentDateAllowed Boolean The parameter defines whether it is allowed to register a customer by e.g. an AZTEK Code with a date different to the current date (the date is stored in the code).
printCustomerCard Boolean The parameter defines whether a customer card should be printed.
useLoyaltyService String It defines whether a Loyalty Service should be used and if so, which one.
  • None - no Loyalty Service is used
  • GK - GK Loyalty Service is used
 None
allowOfflineRegistration Boolean It defines whether a customer is registered if customer service is not available. false
pointsCalculationMode LOCAL

CENTRAL

 It defines the points calculation mode.
  • LOCAL - Points are calculated real-time by local PCE.
  • CENTRAL - Points are calculated at the end of payment by the Points Calculation Service.
 LOCAL

Global Configuration

Table 6. customer-data-provider.properties
Parameter Name Data Type, Range Description Default
gkr.dp.customer-data-provider.client.baseUrl String URL of the customer service http://localhost:8080/swee-sdc/tenants/

${SystemConfig.tenantId}/stores/

${SystemConfig.retailStoreId}/rest/

services/customer-data-provider/
gkr.dp.customer-data-provider.client.connectionTimeout Integer Connection timeout in ms. 50000
gkr.dp.customer-data-provider.client.readTimeout Integer Read timeout in ms. 60000
Table 7. DataPrivacyServiceConfig
Parameter Name Data Type, Range Description Default
dataPrivacyEnabled Boolean Enables processes for data privacy.

Note: Disabling this feature may violate data privacy legislation (EU-GDPR) unless other means are used to fulfill the EU Regulation.

 true

Customer Identification - 01050101133

CustomerIdentificationConfig

Parameter Name Data Type, Range Description Default
customerCardType String It defines the required customer card type. CO
customerIdentificationFunction CustomerRegistration

CustomerSearch

CustomerDataEntry

 It defines the customer registration function. CustomerRegistration
customerRequired Boolean Controls whether it is mandatory to enter a customer. false
customerRequiredAudibleAlert Boolean It specifies whether an acoustic signal is triggered before the customer identification function is called. false
customerRequiredMessage String It defines the message that is displayed if the customer is missing.
retrieveCustomerId Boolean Controls whether the customer identification process will provide the customer ID of the identified customer for use by the calling process.
customerRegistrationConfigId String It defines the configuration for the customer registration process. Only in use if customerIdentificationFunction is set to CustomerRegistration.
customerSearchConfigId String It defines the configuration for the customer search process. Only in use if customerIdentificationFunction is set to CustomerSearch.
customerDataEntryConfigId String It defines the configuration for the CustomerDataEntry process. Only in use if customerIdentificationFunction is set to CustomerDataEntry or if required customer data is missing.
firstNameRequired Boolean It defines whether the first name of the customer is required. false
lastNameRequired Boolean It defines whether the last name of the customer is required. false
streetRequired Boolean It defines whether the street of the default home address of the customer is required. false
cityRequired Boolean It defines whether the city of the default home address of the customer is required. false
postalCodeRequired Boolean It defines whether the postal code of the default home address of the customer is required. false
federalStateRequired Boolean It defines whether the federal state of the default home address of the customer is required. false
countryRequired Boolean It defines whether the country of the default home address of the customer is required. false
taxIdRequired Boolean It defines whether the tax ID of the customer is required. false
customerGroupId String It defines the required customer group ID.
customerRequirementsNotFulfilledMessage String Message that is shown when a customer is already registered with the required card type but further conditions are not fulfilled.

Customer Search - 01050101103

Function Parameters

Table 8. CustomerSearchConfig
Parameter Name Data Type, Range Description Default
customerOperationConfig Customer

OperationConfig

 It defines the configuration for general customer operations.
customerCriteriaSearchConfig CustomerCriteria

SearchConfig

 It defines the config for customer searches.
showAllCustomers Boolean It controls whether a list of all customers or the search dialog is shown at function call. false
assignCustomer Boolean It specifies whether the selected customer is assigned to the receipt. true
maxSearchResult Integer It defines the maximum number of search results. 500
newCustomerEnabled Boolean It specifies whether the create customer process can be accessed from the search criteria mask. true
customerDataEntryConfigId String It specifies the config used for customer data entry. CustomerDataEntry

Configs.Default
automaticTaxExemptionEnabled Boolean It controls whether it is checked whether the customer is marked for tax exemption (Customer.SalesTaxLiableFlagGK). False
allowRescan Boolean It specifies whether it is allowed to enter a customer card if the same card type was already registered. true
checkSuspendedReceipts Boolean It specifies whether the list of suspended receipts for the customer is automatically displayed after registration. false
Note:
extends ProcessConfig
Table 9. CustomerOperationConfig
Parameter Name Migration Data Type, Range Description Default
customerId String It defines the customer ID.
customerGroupId CUSTOMER_GROUP String It defines the customer group. 0
customerCardType ADR_TYPE String It defines the customer card type. 00
customerCardTypeDescriptionKey ADR_DESCRIPTION String It defines the description of the card type. Customer card
useWebService USE_WEBSERVICE String It specifies which web service is used to retrieve customer data. If empty, then no web service will be used.

CRM

SAP_ERP
dataProvider String It specifies the data provider of the customer service.
  • MASTER_DATA - SDC Customer Data
  • SAP_ERP - SAP ERP Customer Data
  • CPS - Customer Profile Service
printCustomerCard true Boolean The parameter defines whether a customer card should be printed. false
useLoyaltyService String It defines whether a Loyalty Service should be used and if so, which one.
  • None - no Loyalty Service is used
  • GK - GK Loyalty Service is used
 None
allowOfflineRegistration Boolean It defines whether a customer is registered if customer service is not available. false
pointsCalculationMode LOCAL

CENTRAL

 It defines the points calculation mode.
  • LOCAL - Points are calculated real-time by local PCE.
  • CENTRAL - Points are calculated at the end of payment by the Points Calculation Service.
 LOCAL
Table 10. CustomerCriteriaSearchConfig
Parameter Name Migration Data Type, Range Description Default
askForCustomerId ASK_NUMBER Boolean It specifies whether the user is prompted to enter the customer number. true
askForCustomerName ASK_NAME Boolean It specifies whether the user is prompted to enter the name. true
askForPlace ASK_PLACE Boolean It specifies whether the user is prompted to enter the city. true
askForStreet ASK_STREET Boolean It specifies whether the user is prompted to enter the street. true
askForPostalCode ASK_POSTAL_CODE Boolean It specifies whether the user is prompted to enter the postal code. true
askForCountry ASK_COUNTRY Boolean It specifies whether the user is prompted to enter the country. true
askForFederalState ASK_FEDERAL_STATE Boolean It specifies whether the user is prompted to enter the federal state. true
askForPhoneNumber Boolean It specifies whether the user is prompted to enter a phone number. true
askForEmail Boolean It specifies whether user the is prompted to enter the email.

Only supported if Customer Profile Service is used.

 true

Global Configuration

Table 11. customer-data-provider.properties
Parameter Name Data Type, Range Description Default
gkr.dp.customer-data-provider.client.baseUrl String URL of the customer service http://localhost:8080/swee-sdc/tenants/

${SystemConfig.tenantId}/stores/

${SystemConfig.retailStoreId}/

rest/services/customer-data-provider/
gkr.dp.customer-data-provider.client.connectionTimeout Integer Connection timeout in ms. 50000
gkr.dp.customer-data-provider.client.readTimeout Integer Read timeout in ms. 60000
Table 12. DataPrivacyServiceConfig
Parameter Name Data Type, Range Description Default
dataPrivacyEnabled Boolean Enables processes for data privacy.

Note: Disabling this feature may violate data privacy legislation (EU-GDPR) unless other means are used to fulfill the EU Regulation.

 true

Interface CRM - 01050101122

Parameter Name Data Type, Range Description
externalSystemAdapterName String Name of the CRM adapter that should be used.

Payment Points - 01050100916

Functional Parameters

Table 13. PointsPaymentConfig
Parameter Name Data Type, Range Description
paymentOperationConfig PointsPaymentOperationConfig It defines the payment operation config for the points payment action.
promptForAmountConfig PromptUserDialogConfig It defines the config for the prompt for the points payment amount dialog.
positionOperationConfig PositionOperationConfig It defines the position operation config for the points payment action.
customerIdentificationConfig CustomerIdentificationConfig It defines whether and how the customer is identified.
defaultPointsPaymentTenderDescriptionKey String It defines the default points payment tender description key.
Note:
extends ProcessConfig
Table 14. PointsPaymentOperationConfig
Parameter Name Data Type, Range Description Default
pointsRedemptionConversionFactor Double It describes the factor to convert money into points. 100
Note:
extends PaymentOperationConfig
Table 15. CustomerIdentificationConfig
Parameter Name Data Type, Range Description Default
customerCardType String It defines the required customer card type. CO
customerIdentificationFunction CustomerRegistration

CustomerSearch

CustomerDataEntry

 It defines the customer registration function. CustomerRegistration
customerRequired Boolean It controls whether it is necessary to enter a customer. If a customer is required, only receipts of this customer can be retrieved. false
customerRequiredAudibleAlert Boolean It specifies whether an acoustic signal is triggered before the customer identification function is called. false
customerRequiredMessage String It defines the message that is displayed if the customer is missing.
retrieveCustomerId Boolean
customerRegistrationConfigId String It defines the configuration for the customer registration process.
customerSearchConfigId String It defines the configuration for the customer search process.
customerDataEntryConfigId String It defines the configuration for the CustomerDataEntry process. It is only in use if customerIdentificationFunction is set to CustomerDataEntry.

Global Parameters

Table 16. DataPrivacyConfig
Parameter Name Data Type, Range Description Default
dataPrivacyEnabled Boolean Enables processes for data privacy.

Note: Disabling this feature may violate data privacy legislation (EU-GDPR) unless other means are used to fulfill the EU Regulation.

 true

Permanent Customer Information - 01050101128

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

Parameter Name Data Type, Range Description Default
displayCustomerNumber Boolean It specifies whether the parent customer number is displayed permanently in the Permanent Customer Information Panel. false
displayCustomerName Boolean It specifies whether the parent customer name is displayed permanently in the Permanent Customer Information Panel. false
displayBuyerNumber Boolean It specifies whether the buyer number/customer number is displayed permanently in the Permanent Customer Information Panel. false
displayBuyerName Boolean It specifies whether the buyer name/customer name is displayed permanently in the Permanent Customer Information Panel. false
displayAllowedTenderGroup Boolean /customer is displayed permanently in the Permanent Customer Information Panel. false

Remove Customer - 01050101107

RemoveCustomerConfigs

Note:
extends ProcessConfig