Agents - 012802
Couponing Agent - 01280200004
Global
| Parameter Name | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| gkr.tx-export.couponingAgent.transactionBulkExporter.enabled | Boolean | Property for enabling/disabling the agent | false |
Store
| Parameter Name | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|
| gkr.tx-export.couponingAgent.webservice.url | String | Couponing Service webservice URL | ||
| gkr.tx-export.couponingAgent.webservice.connectionTimeout | Period | Timeout to establish TCP connection | 30s | |
| gkr.tx-export.couponingAgent.webservice.receiveTimeout | Period | Timeout to get response from webservice | 40s | |
| gkr.tx-export.couponingAgent.webservice.auth.type | String |
Webservice authentication type
|
NONE | |
| gkr.tx-export.couponingAgent.webservice.username | String | Webservice authentication username | ||
| gkr.tx-export.couponingAgent.webservice.password | String | Webservice authentication encrypted password | ||
| gkr.tx-export.couponingAgent.webservice.companyId | String | Specifies the code of the retailer | GK |
Digital Receipt Agent - 01280200005
Global
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.digitalReceiptAgent.transactionBulkExporter.enabled | Boolean | Property for enabling/disabling the agent | false |
Store
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.digitalReceiptAgent.webservice.url | String | Digital Receipt Service webservice URL | https://localhost/api/v1/transaction/addPosLogPdf |
| gkr.tx-export.digitalReceiptAgent.webservice.connectionTimeout | Period | Timeout to establish TCP connection | 30s |
| gkr.tx-export.digitalReceiptAgent.webservice.receiveTimeout | Period | Timeout to get response from webservice | 40s |
| gkr.tx-export.digitalReceiptAgent.webservice.auth.type | String | Webservice authentication type
|
NONE |
| gkr.tx-export.digitalReceiptAgent.webservice.username | String | Webservice authentication username | |
| gkr.tx-export.digitalReceiptAgent.webservice.password | String | Webservice authentication encrypted password |
Loyalty Service Integration Agent - 01280200007
Global
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| core.common.security.client.http.auth.group.<LoyaltyServiceIntegration>.type | String | Webservice authentication type
The value in brackets '<>' must be the same as the value of property gkr.loyalty_service_integration.loyaltyApi.webservice.auth.group or gkr.loyalty_service_integration.loyaltyOnePPS.webservice.auth.group in the store configuration. |
NONE |
| core.common.security.client.http.auth.group.<LoyaltyServiceIntegration>.BASIC.username | String | Webservice authentication username The value in brackets '<>' must be the same as the value of property gkr.loyalty_service_integration.loyaltyApi.webservice.auth.group or gkr.loyalty_service_integration.loyaltyOnePPS.webservice.auth.group in the store configuration. |
|
| core.common.security.client.http.auth.group.<LoyaltyServiceIntegration>.BASIC.password | String | Webservice authentication encrypted password The value in brackets '<>' must be the same as the value of property gkr.loyalty_service_integration.loyaltyApi.webservice.auth.group or gkr.loyalty_service_integration.loyaltyOnePPS.webservice.auth.group in the store configuration. |
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-business.loyaltyServiceIntegrationAgent.enabled | Boolean | Enables or disables the agent. Once set, it is not possible to unset! | false |
| gkr.loyalty_service_integration.agent.poolLockedRetryCount | Integer | This is a technical property that controls retry behavior while the pool is locked | 10 |
| gkr.loyalty_service_integration.agent.poolLockedRetryPeriod | 1s | This is a technical property that controls retry behavior while the pool is locked | 1s |
| gkr.loyalty_service_integration.agent.loyaltyCustomerAddressTypeCode | String | Type code of the loyalty customer | LC |
Store
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.loyalty_service_integration.loyaltyApi.webservice.url | String | Webservice URL to call the Loyalty Service for the call of save-points i.e. https://qa.cloud4retail.co/loyalty-service/tenants/001/services/rest/rest/loyalty/v1/ |
|
| gkr.loyalty_service_integration.loyaltyApi.webservice.connectionTimeout | Period | Timeout to establish TCP connection | 5s |
| gkr.loyalty_service_integration.webservice.loyaltyApi.receiveTimeout | Period | Timeout to get response from Loyalty Service | 5s |
| gkr.loyalty_service_integration.loyaltyApi.webservice.auth.group | String | Authentication client group code identifier; the value is used as a part of the property key in global security.properties | loyaltyService |
| gkr.loyalty_service_integration.loyaltyOnePPS.webservice.url | String | Webservice URL to call the Loyalty Service for the calculation i.e. https://qa.cloud4retail.co/loyalty-service/tenants/001/services/rest/loyalty-calculation/v1/ |
|
| gkr.loyalty_service_integration.loyaltyOnePPS.webservice.connectionTimeout | Period | Timeout to establish TCP connection | 5s |
| gkr.loyalty_service_integration.loyaltyOnePPS.webservice.receiveTimeout | Period | Timeout to get response from Loyalty Service | 5s |
| gkr.loyalty_service_integrationn.loyaltyOnePPS.webservice.auth.group | String | Authentication client group code identifier; the value is used as a part of the property key in global security.properties | loyaltyService |
RFID Agent - 01280200006
Global Parameters
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.rfidAgent.transactionBulkExporter.enabled | Boolean | Property for enabling/disabling the agent | false |
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| core.common.security.client.http.auth.group.<rfidAgent>.type | String | Webservice authentication type
The value in brackets '<>' must be the same as the value of the property gkr.tx-export.rfidAgent.webservice.auth.group in the store configuration. |
NONE |
| core.common.security.client.http.auth.group.<rfidAgent>.BASIC.username | String | Webservice authentication username The value in brackets '<>' must be the same as the value of the property gkr.tx-export.rfidAgent.webservice.auth.group in the store configuration. |
|
| core.common.security.client.http.auth.group.<rfidAgent>.BASIC.password | String | Webservice authentication encrypted password The value in brackets '<>' must be the same as the value of the property gkr.tx-export.rfidAgent.webservice.auth.group in the store configuration. |
Functional Parameters
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.rfidAgent.webservice.url | String | RFID webservice URL | |
| gkr.tx-export.rfidAgent.webservice.connectionTimeout | Period | Timeout to establish TCP connection | 5s |
| gkr.tx-export.rfidgent.webservice.receiveTimeout | Period | Timeout to get response from webservice | 5s |
| gkr.tx-export.rfidAgent.webservice.auth.group | String | Authentication client group code identifier; the value is used as a part of the property key in global security.properties | rfidAgent |
| gkr.tx-export.rfidAgent.webservice.failFastTreshold | Period | Specifies how long the service should block remote calls after the server (side) reports an error | 2m |
Sales Order Agent - 01280200002
| Parameter Name | Configuration Details | Migration | Data Type, Range | Description | Default |
|---|---|---|---|---|---|
| gkr.tx-export.salesOrderAgent. transactionBulkExporter.enabled |
true false |
boserver.{functionNumber}. agent.salesOrder.enabled |
Boolean | Property for enabling/disabling the agent | false |
| gkr.tx-export.salesOrderAgent. rejectionReasonCode |
max. string length 2 | boserver.{functionNumber}.agent. salesOrder.rejectionReasonCode |
String | Default rejection reason code (reason for cancellation) | 00 |
| gkr.tx-export.salesOrderAgent. webservice.url |
boserver.{functionNumber}.connection.url | String | Sales order webservice URL (example:http://localhost:9999/ sales-order-agent) |
||
| gkr.tx-export.salesOrderAgent. webservice.connectionTimeout |
Period | Timeout to establish TCP connection | 5s | ||
| gkr.tx-export.salesOrderAgent. webservice.receiveTimeout |
boserver.{functionNumber}.timeout | Period | Timeout to get response from webservice | 5s | |
| gkr.tx-export.salesOrderAgent. webservice.failFastTreshold |
Period | How long to block remote calls after failure | 2m | ||
| gkr.tx-export.salesOrderAgent. webservice.auth.type |
String | Webservice authentication type
|
NONE | ||
| gkr.tx-export.salesOrderAgent. webservice.username |
boserver.{functionNumber}.username | String | Web service authentication username | ||
| gkr.tx-export.salesOrderAgent. webservice.password |
boserver.{functionNumber}.password | String | Web service authentication encrypted password |
Valuephone Digital Receipt Agent - 01280200008
Global
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.valuephoneDRAgent.transactionBulkExporter.enabled | Activates the bulk exporter. | true | |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.missingItemID | String | Content of the XML element ItemID if the receipt does not contain an item number. | "not_found" |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.saleItemForMstrExport | Boolean | Specifies whether to export item information (item number, EAN) for merchandise category items. | true |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.priceChange.rebateMethod | String | Discount method to be exported for price changes. | "001" |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.priceRevaluation.priceTypes | String | List of price types (comma-separated or semicolon-separated) for sales price revaluation. | "13" |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.tenderType.foreignCurrency.dbValue.enabled | Boolean | This flag defines whether the corresponding tender code is exported from the
database for foreign currencies. (If false, a consistent tender type is exported, see property '…tenderType.foreignCurrency') |
true |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.tenderType.foreignCurrency | String | Consistent tender code to be exported for all foreign currencies. (Only if '…foreignCurrency.dbValue.enabled' = false) |
"YTFW" |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.tender.exportCreditDebitCardNumber | Boolean | Specifies whether the credit card number and account number are exported. | false |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.formattedOutput | Boolean | Enable formatted string output of XML marshaller. | true |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.removeXMLDeclaration | Boolean | Enable removing of xml declaration (<?xml version="1.0" encoding="UTF-8" standalone="no" ?>) from serialized Receipt object by XML marshaller. | true |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.quantity.decimalPlacesCount | Integer | Number of decimal places to which the calculated quantity is rounded. | 3 |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.amount.decimalPlacesCount | Integer | Number of decimal places to which the calculated item amount is rounded. | 2 |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.percent.decimalPlacesCount | Integer | Number of decimal places to which the calculated percentage is rounded. | 4 |
| gkr.tx-export.valuephoneDRAgent.digitalReceipt.position.tax.amount.decimalPlacesCount | Integer | Number of decimal places to which the calculated item tax amount is rounded. | 4 |
| core.common.security.client.http.auth.group.<valuephonePosPaymentAgent>.type | String | Authentication type
The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephoneDRAgent.webservice.auth.group in the store configuration. |
NONE |
| core.common.security.client.http.auth.group.<valuephonePosPaymentAgent>.BASIC.username | String | Webservice authentication username The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephoneDRAgent.webservice.auth.group in the store configuration. |
|
| core.common.security.client.http.auth.group.<valuephonePosPaymentAgent>.BASIC.password | String | Webservice authentication encrypted password The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephoneDRAgent.webservice.auth.group in the store configuration. |
Store
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.valuephoneDRAgent.webservice.url | String | Valuephone webservice URL | |
| gkr.tx-export.valuephoneDRAgent.webservice.connectionTimeout | Period | Webservice connection timeout | 5s |
| gkr.tx-export.valuephoneDRAgent.webservice.receiveTimeout | Period | Webservice receive timeout | 5s |
| gkr.tx-export.valuephoneDRAgent.webservice.failFastTreshold | Period | How long should the service block remote calls after the server side reports an error | 2m |
| gkr.tx-export.valuephoneDRAgent.webservice.auth.group | String | Authentication client group code identifier; the value is used as a part of the property key in global security.properties | valuephonePosPaymentAgent |
Valuephone Promotion Checkout Service Agent - 01280200009
Global
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.transactionBulkExporter.enabled | Activates the bulk exporter. | true | |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.transactionBulkExporter.maxBulkSize | Defines the maximum number of transactions which are exported in a file | 1 | |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.missingItemID | String | Content of the XML element ItemID if the receipt does not contain an item number. | "not_found" |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.saleItemForMstrExport | Boolean | Specifies whether to export item information (item number, EAN) for merchandise category items. | true |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.priceChange.rebateMethod | String | Discount method to be exported for price changes. | "001" |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.priceRevaluation.priceTypes | String | List of price types (comma-separated or semicolon-separated) for sales price revaluation. | "13" |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.tenderType.foreignCurrency.dbValue.enabled | Boolean | This flag defines whether the corresponding tender code is exported from the
database for foreign currencies. (If false, a consistent tender type is exported, see property '…tenderType.foreignCurrency') |
true |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.tenderType.foreignCurrency | String | Consistent tender code to be exported for all foreign currencies. (Only if '…foreignCurrency.dbValue.enabled' = false) |
"YTFW" |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.tender.exportCreditDebitCardNumber | Boolean | Specifies whether the credit card number and account number are exported. | false |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.formattedOutput | Boolean | Enable formatted string output of XML marshaller. | true |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.removeXMLDeclaration | Boolean | Enable removing of xml declaration (<?xml version="1.0" encoding="UTF-8" standalone="no" ?>) from serialized Receipt object by XML marshaller. | true |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.quantity.decimalPlacesCount | Integer | Number of decimal places to which the calculated quantity is rounded. | 3 |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.amount.decimalPlacesCount | Integer | Number of decimal places to which the calculated item amount is rounded. | 2 |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.percent.decimalPlacesCount | Integer | Number of decimal places to which the calculated percentage is rounded. | 4 |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.digitalReceipt.position.tax.amount.decimalPlacesCount | Integer | Number of decimal places to which the calculated item tax amount is rounded. | 4 |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.receiptBinaryFallback.enabled | Boolean | Enable Transaction Report creation from journal data if the PDF_Journal does not exist in TransactionBinaryData. Enabling this property has a significant impact on performance. | false |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.receiptBinaryFallback.reportID | String | Specifies the report template to be created if ReceiptBinary mapping is enabled and the Transaction Report must be generated from journal data. | transaction |
| core.common.security.client.http.auth.group.valuephonePromotionCheckoutServiceAgent.type | String | Authentication type
The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.auth.group in the store configuration. |
NONE |
| core.common.security.client.http.auth.group.valuephonePromotionCheckoutServiceAgent.BASIC.username | String | Webservice authentication username The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.auth.group in the store configuration. |
|
| core.common.security.client.http.auth.group.valuephonePromotionCheckoutServiceAgent.BASIC.password | String | Webservice authentication encrypted password The property is located in global security.properties. The value in brackets '<>' must be the same as the value of the property gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.auth.group in the store configuration. |
Store
| Parameter Name | Data Type, Range | Description | Default |
|---|---|---|---|
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.url | String | MCA webservice URL | |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.connectionTimeout | Period | Webservice connection timeout | 5s |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.receiveTimeout | Period | Webservice receive timeout | 5s |
| gkr.tx-export.valuephonePromotionCheckoutServiceAgent.webservice.auth.group | String | Authentication client group code identifier; the value is used as a part of the property key in global security.properties | valuephonePromotionCheckoutServiceAgent |