Gift Cards / Promotions / Vouchers

Member / Voucher Import

3rd Party Integration with swiftpos Service Monitor

This outlines the information and the steps that are needed to familiarise oneself with the with the Member / Voucher Import interface in Service Monitor.

 


Subjects      

 


About     

 

Import File Specification     

File

ATTRIBUTE VALUE

COMMENTS

Name XX_MemberVoucherExtract.txt

Where XXX is any value to keep track of files. For example, 001, 002, etc.

Extension TXT Once imported the file's extension will be renamed from .txt to .processed
Type Delimited

The '|' character is used as a delimiter.

Processing Interval 30 seconds

This is the default interval.

 

Fields

FIELD REQUIRED DATA TYPE

COMMENTS

EXAMPLE
Voucher ID Yes Number

Must be listed as the ID of an existing Voucher in the Vouchers screen.

1
Mapping String No Text

Maximum of 1000 characters allowed. Can be used for a 3rd Party provided Barcode.

987654321
Stored Value No Amount

 

50.00
PIN No Text

Must be 4 characters long and only contain numbers.

0123
Start No Date/Time If empty or invalid, use the Issue Start Date of the SwiftPOS Voucher. 1/07/2024 0:00
Expires No Date/Time If empty or invalid, use the Issue Start Date of the SwiftPOS Voucher. 31/07/2024 23:59
Member No No Number Whole number with a maximum of 9 digits allowed.

Notes ...
This is only used to identify a Member, when the Create / Update Member option is selected in the Member / Voucher Import settings screen. If the number imported here is left blank, then use the next Member Number in SwiftPOS when creating a new member.

If in the Member / Voucher Import settings screen, the Member Number field is selected in the Member Identifier drop down list, then the number imported here will be used to match to the SwiftPOS Member No.

If no import number is specified here, then the Voucher will NOT be assigned to a Member.

2
Member Card / Alternate ID No Number

Whole number with a maximum of 64 digits allowed.

Notes ...
This is only used to identify a Member, when the Create / Update Member option is selected in the Member / Voucher Import settings screen. If the number imported here is left blank, then use the next Member Number in SwiftPOS when creating a new member.

 If in the Member / Voucher Import settings screen, the Alternate ID field is selected in the Member Identifier drop down list, then the number imported here will be used to match to the SwiftPOS Member Alternate ID.

If no import number is specified here, then the Voucher will NOT be assigned to a Member.

11012
External Sync ID No Number Whole number with a maximum of 64 digits allowed.

Notes ...
This is only used to identify a Member, when the Create / Update Member option is selected in the Member / Voucher Import settings screen. If the number imported here is left blank, then use the next Member Number in SwiftPOS when creating a new member.

If in the Member / Voucher Import settings screen, the External ID field is selected in the Member Identifier drop down list, then the number imported here will be used to match to the SwiftPOS Ext Sync ID.

If no import number is specified here, then the Voucher will NOT be assigned to a Member.

2345678901234
Classification No Number Must be listed as the ID of an existing Classification in the Member Classifications screen.

Notes ...

This is only required when the Create / Update Member option is selected in the Member / Voucher Import settings screen, and a Member is being created. It does NOT APPLY when updating a Member.

1

 

Example

VALUE
25||||2024-03-01 00:00|2024-03-08 00:00||8832|10032||Homer|Simpson

26||||2024-03-01 00:00|2024-03-08 00:00||8833|10033||Mary|Jones

 

What Is It?     

The Member / Voucher Import interface is used to import vouchers into the Voucher Ledger and assign the Voucher to a Member if the Member Number is included in the import file. It will also provide the option of creating/updating Members.

 

Notes ...

 

By default the import will use the settings configured for the Voucher in SwiftPOS if NOT provided in the imported file.

 


Screens     

 

Member / Voucher Import Screen     

 

member-voucher-import-1

 

To access refer to How To Access The Service Monitor for more information. Used to configure the settings required for swiftpos Media Schedules.

  • Please select the path to the Member File - Displays/Enter the path and file name of the file to import.

  • Create / Update Member - Select to allow Member to be created/updated in SwiftPOS.

  • Allow Duplicate Vouchers - Select to allow the duplication of Vouchers.

  • Member Identifier - Select from the drop-down list of available fields.

  • Default Classification - Select the select button to open the Search Membership Classifications screen and locate and select the appropriate Classification to be used as the default when creating Members.

  • Terminal - Select from the drop-down list of available Terminals.



Notes ...

 

The terminal is recorded against the creation of the Voucher transaction. Using a specific terminal may make it easier to find vouchers created by the import process.


  • Clerk - Select from the drop-down list of available Clerks.

  • Enable Watching - Select to enable the Service Monitor to watch for activity.

  • Enable Full Debug - Select to enable. This should only be enabled when recommended.   

  • Run Now - Select to run the import.

 

End of article