Gift Certificate Reconciliation

Interface

Interface Stored Value Server - 01070200002

General

The POS Server works as a client and uses this interface to communicate with a Stored Value Server via an interface adapter.

The interface methods are called via a POS Server process which searches receipts for offline gift certificate transactions (see 'Agent').

Agent

Gift cert reconciliation agent - 01280200001

General

This agent is used for subsequent posting of gift certificate transactions on a Stored Value Server (third-party Stored Value Server or Stored Value Server). The module searches the receipt data for gift certificate transactions that have not been posted on a Stored Value Server yet (due to offline situations) and subsequently posts the data. Each subsequent posting is performed only once.

Because several Stored Value Servers can be simultaneously connected to the POS Client, it must be ensured that only transactions for the correct Stored Value Server are considered. Simultaneous operations of several Stored Value Servers are supported. The POS Client transaction provides the value of the relevant Stored Value Server and this value determines the Stored Value Server on which subsequent posting is performed.

The following use cases exist:

  • Create a new gift certificate
  • Sell a gift certificate
  • Top up a gift certificate
  • Cancel a gift certificate transaction

Adapter Stored Value Server

Adapter Stored Value Server - 01070200001

General

This adapter is used for communication with the Stored Value Server (SVS) for subsequent positing of gift certificate transactions (created offline).

Configuration

  • at global level:

Configuration file transaction-bulk-exporter.properties: 

 ################################################################################
# Gift Cert Reconciliation Agent
 ################################################################################
# Property for enabling/disabling the agent
 gkr.tx-export.giftCertReconciliationAgent.transactionBulkExporter.enabled=false

To enable the gift certificate reconciliation agent, set 'gkr.tx-export.giftCertReconciliationAgent.transactionBulkExporter.enabled=true'

Configuration file security.properties: 

# Gift Cert Reconciliation Agent
 core.common.security.client.http.auth.group.giftCertReconciliationAgent.type=NONE
 core.common.security.client.http.auth.group.giftCertReconciliationAgent.BASIC.username=
 core.common.security.client.http.auth.group.giftCertReconciliationAgent.BASIC.password=
  • at store level:

Configuration file transaction-bulk-exporter.properties: 

 ################################################################################
# Gift Cert Reconciliation Agent
 ################################################################################
# Stored Value Server Clearing Webservice URL e.g. http\://localhost\:8080/svs/services/GkrHoGcsClearingWsFacade
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.url=
#Timeout to establish TCP connection
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.connectionTimeout=30s
#Timeout to get reponse from webservice
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.receiveTimeout=30s
#How long to block remote calls after failure
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.failFastTreshold=2m
# Authentication client group code identifier, the value is used as a part of property key in global security.properties
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.auth.group=giftCertReconciliationAgent
# Default company ID
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.companyId=GKR
# Property for enabling/disabling of webservice debug mode
 gkr.tx-export.giftCertReconciliationAgent.svs-clearing.debugMode.enabled=false

The SVS web service URL can be configured in 'gkr.tx-export.giftCertReconciliationAgent.svs-clearing.webservice.url'.