Impact Data

2 | Impact Data TalkBox Vouchers Interface Setup

This article outlines how to add the Impact Data Till Extension and its configurations within BackOffice. The interface with Impact Data allows customers to redeem TalkBox Promotions and Vouchers.

This article outlines how to add the Impact Data Till Extension and its configurations within BackOffice.

The interface with Impact Data allows customers to redeem TalkBox Promotions and Vouchers.

Prerequisites 
  • This interface requires .NET 4.6 or above, as such this interface is not available on the following POS OS
    • XP
    • POSReady 2009
    • Windows 7  requires the OS to have the Convenience rollup updateThis convenience rollup is intended to make it easy to integrate fixes that were released after SP1 for Windows 7 - Without this update, you will run into TLS1.2  could not create SSL/TLS secure channel.

 

How to ensure Windows 7 is running the current Update:

Frameworks 4.6 Required and Current Windows 7 OS Updates.

 

Convenience rollup update

Prerequisites:
Requires SP1

April 2015 servicing stack update

Convenience rollup:

  • Future proof for TLS1.3, Install frameworks 4.8

Extra:

  • Enable Windows 7 updates
  • Update Windows via Windows update

 

  • To access and configure ImpactData Features, the following Operator Privileges will need to be enabled 
    • Operator Maintenance 'General' Tab
      • System Setup: "Maintain Venue, Stores & Tills" Flag
      • SystemSetup: " Access Venue Stores & Tills" Flag 
    • Operator Maintenance 'Marketing & Promotions' Tab
      • Promotions: "Maintain Voucher Setup" Flags
  • The following items need to be addressed when setting up the Bepoz API, including access by a third party:
    • The Venue need to purchase the Bepoz API as an add-on to the POS
    • The Venue will require an additional till license for the API
    • The Venue’s IT provider will need to provide Port forwarding API Port to Bepoz server
    • Bepoz implementation team: API Set-Up on the Venue’s Bepoz Server
    • Bepoz implementation team: Perform External connection tests to the API

Impact Data Voucher Setup
  1. Set up API till on the Venue’s Bepoz server

⦁          Ensure an additional till license has been issued; if an additional till license has not been issued when the API till starts it may use a license of a physical till which will stop that physical till from working

⦁          Create a NEW API Till

⦁          MENU: System Set-Up > Venue, Stores & Tills

⦁          Name the Till appropriately (eg: API TILL)

⦁          Set the “Till Mode:”  [API Till]

 

  1. Set-Up an API Till Job in the Scheduled Job section

⦁          Set the following parameters:

⦁          “Job Name:” [API Till Job]

⦁          “Job Type:” [External DLL]

⦁          “DLL Name:” [Jobxml_api.Dll]

⦁          “ClassName:” [XML_API]

⦁          Need to setup schedule time “startup only”

⦁          Mac Secret Key: This should be set to a complex secret passphrase for use by third-party connections to authorize their access; it is generated by us

⦁          Eg: *$MyVenueSecret002017

⦁          “Connection Port:”  9009

⦁          “Till:” set this to the “API till name” created previously in the step “Create a NEW API Till”

 

  1. Send all port number, public IP address, Mac secret Key to the Impact data support team

 

  1. Impact data will create an excel form with voucher detail need to setup
    • Setup new vouchers in Bepoz and put the Voucher Setup ID of the voucher and fill in the excel file and send it back to Impact Data
Till Extension 
  • After logging into BackOffice, complete the following steps to create & configure an Impact Data Till Extension:
    1. Navigate to the System Setup component in the sidebar, expand, and select Venue, Stores & Tills to open the  Venue Stores and Tills List tab  
    2. Highlight the desired Till and click on the Add New Device button at the top of the tab; when prompted select 'Blank Device' and a New Device and Interfaces Maintenance window will open 
    3. Enter a relevant Device Name,  set the Device Type to 'Till Extension', the External DLL Name to "Tillx_impactdata.Dll" and the Class Name to 'Impact Data' 
    4. Configure the Device Options as follows: 
      • Base URL: This will be provided by Impact Data (use https://talkbox.impactapp.com.au/ as the base URL if nothing is entered) 
    5. Click OK to save the Till Extension 


Creating Vouchers 
  • Talkbox is an application created by impact Data which allows Organizations to create Vouchers to be sent directly to Customers 
    • To learn how to create a Voucher on TalkBox, please visit the Impact Data website
  • Talkbox Voucher Data is then linked with Voucher Data within BackOffice so that scanned QR Codes can be validated after being scanned 
    • This is achieved using the Voucher Setup ID in  Voucher Setup  within BackOffice which determines which Voucher is to be redeemed 


Creating voucher on Talkbox

2. Navigate to URL : https://talkbox.impactapp.com.au

Login Details:
username:
password: 

3. Create TalkBox Voucher

Vouchers are created under Tools→Vouchers

Populate all fields

Key :

  • Key : voucher_setup_id 
  • Value : voucher setup id in BackOffice

Note: Voucher_Setup_ID is case sensitive it and should be set as "voucher_setup_id"

4. Vouchers are issued under Communicate→Send choose Email)

Follow the process to create a new promotion using a created voucher by dropping the QR code onto the chosen template.

 

 

Sample Code 
  • QR Codes will direct to a URL which will store all Voucher information in a JSON File
  • Below is sample File with all Voucher Data:
 

File Name            

                                                                                                                  Sample Code                                                                                                                  

voucher.JSON

{

   "Description": "This voucher entitles the holder to a free beverage from the selection.",

   "redeemed_at": null,

   "created_at": "2016-10-18T15:22:22+11:00",

   "name": "Free Beverage" , 

  "valid_to": "2017-12-30T00:00:00+11:00",

  "valid_from": "2011-04-09T00:00:00+10:00",

   "user data";      {

              "voucher_id": "54"

    },

   "expires_at": "2017-12-30T00:00:00+11:00"

   "status": "redeemable" 

}