The transaction sync is used to export batches of transactions and can create multiple file types per target.
File types include:
- Issued Transactions (Transaction-Level Details)
- Issued Transactions (Product-Level Details)
- Cancelled Transactions
- Point Expirations
- Transactional Bonuses (“Real-Time” Transaction Bonus Promotions)
- Promo Code Bonuses
- Transaction Type Details
The “Issued Transactions” files can be configured to include or exclude transactions that were issued AND cancelled after the last sync execution. Information about supporting files can be found below in the appropriate sections.
Column order of custom fields is fixed within the custom field file, but defined by the sync process. Custom fields added later are not necessarily appended to the end of the custom field column order. New custom fields may appear at the beginning, between previously existing, or at the end of the custom fields. Any system-level custom field changes necessitates re-verification of sync data by data consumers if column order is a dependency.
Upon each execution, all transactions since the last execution will be included in the desired file types with current information. Files can optionally be split into X records per file, which are then FTP’d to the predetermined location. Files can be compressed and/or PGP encrypted prior to being transferred.
Note: This information is available as a PDF for portability. TransactionSync.pdf
Transaction Sync
| Name | TransactionSync_YYYYMMDD.txt TransactionSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Transactions added to Kognitiv Loyalty since the last sync file execution |
| Field Name | Type | Notes |
|---|---|---|
| App Transaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Member Account Id | String(60) | Primary Account Id |
| First Name | String(60) | |
| Last Name | String(60) | |
| Primary Phone | Numeric(30) | See Article for Phone Number Formatting |
| Mobile Phone | Numeric(30) | See Article for Phone Number Formatting |
| Primary Email | String(256) | |
| Location External Ref | String(20) | External reference for the associated location |
| Transaction Type External Ref If “Replace Transaction Type External Reference with Transaction Type ID” is enabled, datatype will be Integer and field name will be: TransactionTypeID |
String(20) | External reference for the associated transaction type If “Replace Transaction Type External Reference with Transaction Type ID” is enabled the External Reference is replaced with the Internal Transaction Type ID. |
| Transaction Timestamp | Date/Timestamp(23) | Timestamp (UTC) when the transaction member was added (posted) to the loyalty program |
| Activity Timestamp | Date/Timestamp(23) | Timestamp (UTC) when the transaction occurred |
| Transaction Retail Value | Decimal(21,4) | Value of the transaction |
| Transaction Profit Value | Decimal(21,4) | Calculated profit for the transaction derived from the user configured Profit Formula for the transaction type |
| Transaction Base Point Value | Decimal(21,4) | Base point value for the transaction Either calculated from the transaction type point formula or directly entered by the user or process |
| Transaction Point Value | Decimal(21,4) | The total point value for the transaction is comprised of the base point value plus any additional points awarded through transaction bonus promotions. |
| Transaction Won Value | Decimal(21,4) | The total won value for the transaction the member won on the wager. (Gaming/Parimutuel) |
| Event Name | String(120) | Name of the event the transaction was assigned to |
| Issue Audit User | String(120) | Source user or process name |
| Transaction External Ref | String(40) | Provided or generated reference identifier for unique transaction |
| Source Activity Date Field is only present if source date is enabled within sync settings |
Date | YYYY-MM-DD Configured on the Sync Settings page |
| Transfer App Transaction Id Field is only present if transfer column option is enabled within sync settings |
Integer | Kognitiv Loyalty Internal Transaction Id of the "second" transaction involved in the point transfer. A value of -1 suggests a non-transfer transaction. |
|
Triggering App Transaction Id
Field is only present if triggering transaction column option is |
Integer | Kognitiv Loyalty Internal Transaction Id of the "Original" member transaction involved in triggering the Event Driven Promotion that created the "second" internal transaction for point issuance. |
Example Data
AppTransactionId|MemberId|MemberAccountId|FirstName|LastName|PrimaryPhone|MobilePhone|PrimaryEmail|LocationExternalRef| TransactionTypeExternalRef|TransactionTimestamp|ActivityTimestamp|TransactionRetailValue|TransactionProfitValue|TransactionBasePointValue| TransactionPointValue|TransactionWonValue|EventName|IssueAuditUser|TransactionExternalRef
921220|18813|400001@kognitivloyalty.com|Jonas|Simpson|1-(111) 111-1144||400001@kognitivloyalty.com|132||2013-10-08 15:24:29.540|
2013-10-08 15:24:29.537|0.0000|0.0000|40.0000|40.0000|0.0000||Jason Schneiders|3211786321
Basket Product File
| Name | TransactionProductInfoSync_YYYYMMDD.txt TransactionProductInfoSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionProductInfoSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionProductInfoSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Basket Products for transactions added to Kognitiv Loyalty since the last sync file |
| Field Name | Type | Notes |
|---|---|---|
| App Transaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Transaction Type External Ref If “Replace Transaction Type External Reference with Transaction Type ID” is enabled, datatype will be Integer and field name will be: TransactionTypeID |
String(20) | External reference for the associated transaction type If “Replace Transaction Type External Reference with Transaction Type ID” is enabled the External Reference is replaced with the Internal Transaction Type ID. |
| ProductItem External Ref | String(20) | User controlled list of product references |
| Final Unit Price | Decimal(21,4) | Unit value of the product |
| Base Points | Decimal(21,4) | Base point value for the product. This is calculated from the transaction type Point Formula. |
| Bonus Points | Decimal(21,4) | The Bonus Point value for the product is comprised of the additional points awarded through product bonus promotions. |
| Profit Value | Decimal(21,4) | Calculated profit for the transaction derived from the user configured Profit Formula for the transaction type |
| Transaction External Ref | String(40) | Provided or generated reference identifier for unique transaction |
Example Data
AppTransactionId|MemberId|TransactionTypeExternalRef|ProductItemExternalRef|FinalUnitPrice|BasePoints|BonusPoints|ProfitValue| TransactionExternalRef
1234|1|GMP|HAT_123|24.9900|24.9900|49.9800|12.5000|1234550000000120130910131412
Transaction Cancel File
| Name | TransactionsCancelledSync_YYYYMMDD.txt TransactionsCancelledSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionsCancelledSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionsCancelledSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Transactions cancelled in Kognitiv Loyalty since the last sync file execution |
| Field Name | Type | Notes |
|---|---|---|
| App Transaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Cancel Timestamp | Date/Timestamp(23) | Timestamp of cancel (UTC) |
| Cancel Audit User | String(120) | Source user or process name |
| Transaction External Ref | String(40) | Provided or generated reference identifier for unique transaction |
Example Data
AppTransactionId|MemberId|CancelTimestamp|CancelAuditUser|TransactionExternalRef
920267|71491|2013-10-09 21:33:15.553|Bob Trommelen|1023912498239
Point Expiration File
| Name | TransactionExpirePointsSync_YYYYMMDD.txt TransactionExpirePointsSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionExpirePointsSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionExpirePointsSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Member Points expired in Kognitiv Loyalty since the last sync file execution |
| Field Name | Type | Notes |
|---|---|---|
| Member Expire Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Expire Timestamp UTC | Date/Timestamp(23) | Timestamp of expiration(UTC) |
| Points Expired | Decimal(21,4) | Points Expired |
Example Data
MemberExpireId|MemberId|ExpiredTimestampUTC|PointsExpired
641187|801968|2014-04-18 13:48:05.353|1.0000
641188|801971|2014-04-18 13:48:05.353|1.0000
641189|801972|2014-04-18 13:48:05.357|2.0000
Transaction Bonus File
| Name | TransactionBonusInfoSync_YYYYMMDD.txt TransactionBonusInfoSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionBonusInfoSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionBonusInfoSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Transaction bonus details for transactions added to Kognitiv Loyalty since the last sync file |
| Field Name | Type | Notes |
|---|---|---|
| AppTransaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Transaction Type External Ref If “Replace Transaction Type External Reference with Transaction Type ID” is enabled, datatype will be Integer and field name will be: TransactionTypeID |
String(20) | External reference for the associated transaction type If “Replace Transaction Type External Reference with Transaction Type ID” is enabled the External Reference is replaced with the Internal Transaction Type ID. |
| Bonus Type | Numeric(1) | Bonus Type 1 = Transaction Bonus 2 = Parimutuel Transaction Bonus 3 = Transaction Product Bonus 4 = Transaction Product Quantity Bonus |
| Bonus External Reference | String(20) | User controlled list of promotion bonus external references |
| Bonus Points | Decimal(21,4) | Promotion bonus point value |
| Product Item External Reference | String(20) | External reference of the product bonused via the Transaction Product Bonus promotion (Bonus Types = 3, 4) |
| Transaction External Ref | String(40) | Provided or generated reference identifier for unique transaction |
Example Data
AppTransactionId|MemberId|TransactionTypeExternalReference|BonusType|BonusExteranlReference|BonusPoints|ProductItemExternalReference|TransactionExternalReference
1234|1|1|DBL_POINTS|24.9900|004578|1234550000000120130910131412
Transaction Promo Code Info File
| Name | TransactionPromoCodeInfoSync_YYYYMMDD.txt TransactionPromoCodeInfoSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionPromoCodeInfoSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionPromoCodeInfoSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Key/Promo Code bonus details for transactions added to Kognitiv Loyalty since the last sync file |
| Field Name | Type | Notes |
|---|---|---|
| App Transaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Transaction Type External Ref If “Replace Transaction Type External Reference with Transaction Type ID” is enabled, datatype will be Integer and field name will be: TransactionTypeID |
String(20) | External reference for the associated transaction type If “Replace Transaction Type External Reference with Transaction Type ID” is enabled the External Reference is replaced with the Internal Transaction Type ID. |
| Promo Type | Numeric(1) |
Promo Type 2 = Product Code 3 = Product Item |
| Code | String(20) | Code entered for promotion |
| Product Item External Reference | String(20) | External reference of the product bonused via the transaction. |
| Product Base Points | Decimal(21,4) | Base points earned for a product, if present. |
| Product Bonus Points | Decimal(21,4) | Bonus points earned for a product, if present. |
| Transaction External Ref | String(40) | Provided or generated reference identifier for unique transaction |
Example Data
AppTransactionId|MemberId|TransactionTypeExternalReference|PromoType|Code|ProductItemExternalReference|ProductBasePoints|ProductBonusPoints|TransactionExternalReference
2059212|129251|49381|2|123982948826|P1002|5|0|
Transaction Type Detail File
| Name |
TransactionTypeDetailSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) This sync file does NOT use the following options
|
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | All Transaction Type Details for transactions |
| Field Name | Type | Notes |
|---|---|---|
| Transaction Type Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Type Id |
| Transaction Type Name | String(120) | |
| Transaction Type External Reference | String(20) | May be NULL |
| Transaction Type Category Id | Numeric(10) | 1 = Admission Transaction 2 = Purchase Transaction 3 = Point Adjustment Transaction 4 = Miscellaneous Transaction 5 = Promotional Transaction 6 = Parimutuel Transaction 7 = Slot Transaction 8 = Survey Transaction |
| Transaction Type Category Name | String(40) | |
| Transaction Type As Visit Trip | Boolean | Transaction type to be used when counting a Visit or Trip Part of the Transaction Type Analytic Flags 0 = Does not count as Visit or Trip -1 = Counts as Visit or Trip |
| Transaction Type As Active | Boolean |
Transaction type to be used when counting an Active member Part of the Transaction Type Analytic Flags 0 = Does not count as Active member -1 = Counts as Active member |
| Transaction Recency | Boolean |
Use In 'Recency' Calculation for RFM Part of the Transaction Type Analytic Flags 0 = Does not use in Recency calculation -1 = Use in Recency calculation |
| Transaction Frequency | Boolean |
Use In 'Frequency' Calculation for RFM Part of the Transaction Type Analytic Flags 0 = Does not use in Frequency calculation -1 = Use in Frequency calculation |
| Transaction Monetary | Boolean |
Use In 'Monetary' Calculation for RFM Part of the Transaction Type Analytic Flags 0 = Does not use in Monetary calculation -1 = Use in Monetary calculation |
| Transaction Product Setting Id | Numeric(10) | Transaction Product Setting ID 1 = Transaction Does Not Store Products 2 = Transaction Uses Single Product Basket 3 = Transaction Uses Multiple Product Basket 4 = Transaction Stores a Non Processed Basket |
| Transaction Type Product Setting Name | String(45) | |
| Transaction Point name | String(120) | Transaction Type point (for fixed point amount) or point formula name |
| Transaction Profit Name | String(120) | |
| Transaction Rule Name | String(120) |
Example Data
TransactionTypeID|TransactionTypeName|TransactionTypeExternalReference|TransactionTypeCategoryID|TransactionTypeCategoryName|TransactionTypeAsVisitTrip|TransactionTypeAsActive|
TransactionRecency|TransactionFrequency|TransactionMonetary|TransactionProductSettingID|TransactionTypeProductSettingName|TranactionPointName|TransactionProfitName|TransactionRuleName|UpdatedTimestampUTC
5|General Merchandise Purchase|GMP|1| Purchase Transaction|-1|-1|-1|-1|-1|3|Transaction Uses Multiple Product Basket|10 Points Per $1|0%|No Limit|1/20/2016 02:25:33 PM
Transaction Custom Fields
| Name |
TransactionCustomFieldsInfoSync_YYYYMMDD.txt TransactionCustomFieldsInfoSync_YYYYMMDD_##.txt (If file splitting is enabled) TransactionCustomFieldsInfoSync_YYYYMMDDHHMMSS.txt (If filename time is enabled) TransactionCustomFieldsInfoSync_YYYYMMDDHHMMSS_##.txt (If file splitting & filename time are enabled) |
| Format | Pipe delimited |
| Frequency | Daily |
| Source | Kognitiv Loyalty |
| Contents | Transaction custom field info for transactions created or for transactions which have received custom field updates since the last sync file. |
| Field Name | Type | Notes |
|---|---|---|
| App Transaction Id | Numeric(10) | Kognitiv Loyalty Internal Transaction Id |
| Member Id | Numeric(10) | Kognitiv Loyalty Internal Member Id |
| Transaction Type External Ref If “Replace Transaction Type External Reference with Transaction Type ID” is enabled, datatype will be Integer and field name will be: TransactionTypeID |
String(20) | External reference for the associated transaction type If “Replace Transaction Type External Reference with Transaction Type ID” is enabled the External Reference is replaced with the Internal Transaction Type ID. |
| Transaction External Reference | String(40) | Provided or generated reference identifier for unique transaction |
| Custom Fields | Variable |
Each custom field is represented in its own column with the custom field external reference in the header. See top-level notes for details on ordering. |
Example Data
AppTransactionId|MemberId|TransactionTypeExternalReference|TransactionExternalReference|SourceCompanyCode
2287245|34387|GMP|GMP33999|SFWAY01
