E Tender Account Batch Sync Processing
This appendix provides information on batch sync processing of tender account information, including file layouts and background on configuration and scheduling.
The tender account and tender account activity sync options are generic, and can be modified through the use of System Configuration settings. This appendix describes the default file formats and contents.
About this Appendix
This appendix includes information on the following Tender Account batch export files:
Tender Account Sync Export
This section includes:
Tender Account Sync File Format
The first time you generate the Tender Account Sync file, all records are included.
Afterward, only tender accounts created or updated since the last run date and time are included.
The Tender Account Sync file contains the following information by default, but the exported information is configurable with the help of Oracle consultants.
Table E-1 Tender Account Sync File Format
| Field Name | Data Type | Maximum Length | Description |
|---|---|---|---|
|
ACCOUNT_ID |
Number |
19 |
Unique identifier for a tender account. |
|
LAST_ACT_DATE |
Date (YYYY-MM-DD) |
Date of last activity on the account. |
|
|
EFFECTIVE_DATE |
Date (YYYY-MM-DD) |
Date when the card becomes effective. |
|
|
ACCT_EXPIRY_DATE |
Date (YYYY-MM-DD) |
Date when the card expires. |
|
|
CARD_SERIAL_NUM |
Varchar |
64 |
Sixteen-digit embossed on the card that consists of the 5-digit prefix, 2-digit series number, 3-digit batch number, and 6-digit sequence number. |
|
CARD_NUM |
Varchar |
64 |
Randomly-generated number encoded on the magnetic strip of the card. |
|
ACTIVATION_DATE |
Date (YYYY-MM-DD) |
Date when the card was first activated. |
|
|
CARD_FIRST_USED_DATE |
Date (YYYY-MM-DD) |
The date when the account was first used. |
|
|
CARD_LAST_USED_DATE |
Date (YYYY-MM-DD) |
The date when the account was most recently used. |
|
|
CARD_EXPIRY_DATE |
Date (YYYY-MM-DD) |
The date when the account expires. |
|
|
CUST_ASSOC_DATE |
Date (YYYY-MM-DD) |
Date when the card was associated with the customer. |
|
|
START_DATE |
Date (YYYY-MM-DD) |
The date when the account becomes effective. |
|
|
END_DATE |
Date (YYYY-MM-DD) |
The date when the account stops being effective. |
|
|
CUST_ID |
Varchar |
32 |
Unique identifier for the customer (individual or organization). |
|
PRIMARY_FLAG |
Number |
1 |
Set to 1 if the customer is the primary account-holder. |
|
ACCOUNT_STATUS_CODE |
30 |
Code indicating whether the account is active or inactive. |
|
|
BALANCE |
Number |
17.6 |
The current balance for the account. |
|
BOOK_BALANCE |
Number |
17.6 |
Balance for accounting purposes. |
|
FROZEN_BALANCE |
Number |
17.6 |
Amount that is frozen and unusable. |
|
PROGRAM_ID |
Varchar |
32 |
Unique identifier for the tender program. |
|
BALANCE_CURRENCY_TYPCODE |
Varchar |
30 |
Code identifying the currency for the balance. |
|
USAGE_COUNT |
Number |
38 |
The total number of times the account was accessed for a transaction. |
|
TOTAL_CREDITS |
Number |
17.6 |
The total lifetime credits for the account. |
|
TOTAL_DEBITS |
Number |
17.6 |
The total lifetime debits for the account |
|
CREATE_DATE |
Date (YYYY-MM-DD) |
Date when the account was created. |
|
|
CREATE_USER |
254 |
The user who created the account. |
|
|
UPDATE_DATE |
Date (YYYY-MM-DD) |
Date when the account was most recently updated. |
|
|
UPDATE_USER |
Varchar |
254 |
The user who most recently updated the account. |
Sample Rows
The following is an example of data in the Tender Account Sync file:
ACCOUNT_ID LAST_ACT_DATE EFFECTIVE_DATE ACCT_EXPIRY_DATE CARD_SERIAL_NUM CARD_NUM ACTIVATION_DATE CARD_FIRST_USED_DATE CARD_LAST_USED_DATE CARD_EXPIRY_DATE CUST_ASSOC_DATE START_DATE END_DATE CUST_ID PRIMARY_FLAG ACCOUNT_STATUS_CODE BALANCE BOOK_BALANCE FROZEN_BALANCE PROGRAM_ID BALANCE_CURRENCY_TYPCODE USAGE_COUNT TOTAL_CREDITS TOTAL_DEBITS CREATE_DATE CREATE_USER UPDATE_DATE UPDATE_USER <ACCOUNT_ID> 2016-11-08 2016-10-24 2018-10-30 <CARD_SERIAL_NUM> <CARD_NUM> 2009-01-01 2009-01-01 2016-11-08 2018-12-31 2016-10-12 <CUT_ID> 1 Active 15 25 0 <PROGRAM_ID> USD 2 25 10 2016-10-24 2016-11-08 <USER>
Tender Account Activity Sync File Format
The first time you generate the Tender Account Activity Sync file, all records are included. Afterward, only tender accounts created or updated since the last run date and time are included.
The Tender Account Activity Sync file contains the following information by default, but the exported information is configurable with the help of Oracle consultants.
Table E-2 Tender Account Activity Sync File Format
| Field Name | Data Type | Maximum Length | Description |
|---|---|---|---|
|
ACCOUNT_ID |
Number |
19 |
Unique identifier for a tender account. |
|
PROGRAM_ID |
Varchar |
32 |
Unique identifier for the tender program. |
|
ACCT_ACT__ID |
Number |
19 |
Unique identifier for the activity. |
|
AUTH_CODE |
Varchar |
32 |
The authorization code. |
|
CUST_ID |
Varchar |
32 |
Unique identifier for the customer (individual or organization). |
|
CARD_NUM |
Varchar |
64 |
Randomly-generated number encoded on the magnetic strip of the card. |
|
VOID_FLAG |
Number |
Flag indicating whether the transaction was voided. |
|
|
ACT_ACCT_ACTIVITY_TYPCODE |
Varchar |
30 |
Code used to categorize types of account activities. |
|
ACTIVITY_DATETIME |
Date and time (YYYY-MMDDTHH:MM:SS format) |
The date and time of the activity. |
|
|
ACTIVITY_AMOUNT |
Number |
17.6 |
The total amount for the activity or transaction. |
|
CURRENCY_TYPCODE |
Varchar |
30 |
Code identifying the currency. |
|
OPERATOR_ID |
Varchar |
32 |
Unique identifier for an operator. |
|
RTL_TRANS_SEQ |
Number |
38 |
A POS-generated sequential transaction ID> |
|
RTL_TRANS_ID |
Varchar |
128 |
Unique transaction ID that references the location, workstation, and transaction sequence number. |
|
RTL_LOC_ID |
Varchar |
64 |
The retail location where the activity took place. |
|
RTL_WKSTN_ID |
Number |
19 |
Unique identifier for the workstation performing the activity. |
|
RTL_BUSINESS_DATE |
Date (YYYY-MM-DD) |
The retailer’s date for the transaction. |
|
|
REF_ACCOUNT_ID |
Number |
19 |
ID of account referenced by this transaction. |
|
REF_ACCT_ACT__ID |
Varchar |
32 |
Unique identifier of the activity. |
|
CARD_SWIPED_FLAG |
Number |
3 |
A flag indicating if a card was swiped during the transaction. |
|
ERROR_CODE |
Varchar |
64 |
Code representing the error generated by the activity. |
|
COMMENTS |
Varchar |
1000 |
User-generated noted about the activity. |
|
REQUESTED_CURRENCY_CD |
Varchar |
30 |
Code identifying the currency for the activity. |
|
REQUESTED_AMOUNT |
Number |
17.6 |
Amount of the transaction, in the requested currency. |
|
EXCHANGE_RATE |
Number |
17.6 |
The amount of the requested currency equal to one unit of the base currency. |
|
MERGED_FROM_ACCOUNT_ID |
Number |
19 |
For a card merge, this is the source account ID. |
|
FRANCHISEE_ID |
Number |
10 |
Unique identifier for the franchisee. |
|
REASON_CODE |
100 |
Account adjustment reason code. |
|
|
EXPIRATION_DATE |
Date (YYYY-MM-DD) |
Date the activity expires. |
|
|
CREATE_DATE |
Date (YYYY-MM-DD) |
Date when the record was created. |
|
|
CREATE_USER |
254 |
The user who created the record. |
|
|
UPDATE_DATE |
Date (YYYY-MM-DD) |
Most recent date when the record was updated. |
|
|
UPDATE_USER |
Varchar |
254 |
The user who updated the record. |
Sample Rows
The following is an example of data in the Tender Account Activity Sync file:
ACCOUNT_ID PROGRAM_ID ACCT_ACT__ID AUTH_CODE CUST_ID CARD_NUM VOID_FLAG ACT_ACCT_ACTIVITY_TYPCODE ACTIVITY_DATETIME ACTIVITY_AMOUNT CURRENCY_TYPCODE OPERATOR_ID RTL_TRANS_SEQ RTL_TRANS_ID RTL_LOC_ID RTL_WKSTN_ID RTL_BUSINESS_DATE REF_ACCOUNT_ID REF_ACCT_ACT__ID CARD_SWIPED_FLAG ERROR_CODE COMMENTS REQUESTED_CURRENCY_CD REQUESTED_AMOUNT EXCHANGE_RATE MERGED_FROM_ACCOUNT_ID FRANCHISEE_ID REASON_CODE EXPIRATION_DATE CREATE_DATE CREATE_USER UPDATE_DATE UPDATE_USER <ACCOUNT_ID> <PROGRAM_ID> <ACCT_ACT_ID> <AUTH_CODE> <CUST_ID> 0 Preauthorization 2016-10-25T14:13:44 0 USD 1 <OPERATOR_ID> <RTL_TRANS_SEQ> <RTL_TRANS_ID> 1 2016-10-25 0 12345 1 Original Pre-Auth requested USD 75.00- actual USD 75.00; Sample USD 0 1 0 0 Sample 2016-10-25 UpdateUserID 2016-11-01 Expire Pre-Auth Job
Scheduling Tender Sync
Generation of these files is configured through the Tender Sync Export option in Job Scheduling. Select the Tender Program for export:
Figure E-1 Tender Sync Export Parameter
See the Oracle Retail Customer Engagement Cloud Services User Guide for more information on Job Scheduling.
See the Batch Exporter Properties chapter of the Oracle Retail Customer Engagement Cloud Services Implementation Guide for more information about setting related properties.