Application File Imports Release Notes Sync Web Services FAQ

Member Extended Sync

The Member Extended Sync is used to export batches of member changes with related information, including point changes and custom field triggers. This sync is unique because the amount of columns in each record is dictated by the trigger type.

Upon each execution, all member changes since the last execution will be included in the sync file with current information. From there, the sync files are FTP'd to the user-set location.

Below, you'll find the Member Extended Sync and all its trigger configurations.

Each of the Sync triggers will include a Record Type that corresponds to the type of trigger that occurred. The Record Types are identified as follows:

  1. Core Trigger
  2. Account Id Trigger
  3. Email Trigger
  4. Phone Trigger
  5. Address Trigger
  6. Club Trigger
  7. Delete Trigger
  8. Point Change Trigger
  9. Head of Household Change Trigger
  10. Member Custom Field Change Trigger
  11. Member Child Trigger

Note: This information is offered as a PDF for portability. Member Extended Sync.docx

Member Extended Sync

Name Name Standard_Member_Sync_YYYYMMDDHHMMSS.txt
Standard_Member_With_Points_Sync_YYYYMMDDHHMMSS.txt (w/ Points Setting ON)
Format Pipe delimited
No header record
Variable column count (see trigger type information)
Frequency  Daily
Source ALP SaaS
Contents Member-related trigger data in ALP SaaS since the last sync file execution

Core Trigger

Field Name Type Notes
Record Type Numeric(1) Always contains a value of 1
Internal Member Id Numeric(10) ALP SaaS Internal Member Id
Member Prefix String(60)  
First Name String(60)  
Middle Name String(60)  
Last Name String(60)  
Member Suffic String(60)  
Birthdate Year Numeric(4)  
Birthdate Month Numeric(2)  
Birthdate Day Numeric(2)  
Gender String(10) Male, Female, Undefined
Do Not Email Boolean True, False
Do Not Text Boolean True, False
Do Not Phone Boolean True, False
Do Not Mail Boolean True, False
Preferred Delivery Method for Offers  Numeric(1) 1 = Email, 2 = Text
Preferred Delivery Method for Non-Offers  Numeric(1) 1 = Email, 2 = Text
Preferred Language String(60) Language external reference
Enrollment Location String(20) Location external reference
Enrollment Date Date/Time or Date  Default Value: Enrollment Date (UTC) YYYY-MM-DD  HH:MM:SS (24hr clock)  
Option Value: Enrollment Date  configured in Sync Settings page
Member is Employee Boolean True, False
Member is Suspended Boolean True, False
Member is Verified Boolean True, False (optional field, configured in sync settings)

Example Data

1|28421|MR|Johnny|C|Watson|JR.|1944|12|11|Undefined|False|False|False|False|1|1|EN|54355|2012-02-17 18:42:11|False|True|False

Account Id Trigger

Note: Any Account Id-related change will produce one record per Account Id for the all Ids associated member.

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 2 
Internal Member Id Numeric(20)   
Member Account Id  String(60)  
Id Type External Reference  String(20)  
Inactive Boolean True, False
Inactive at Devices Boolean True, False

Example Data

2|38967|1203981209Z|CN1|False|False

Email Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 3 
Internal Member Id  Numeric(20)   
Member Email Address  String(256)   
Marked as Bad Email Boolean True, False

Example Data

3|117796|111@smartbutton.com|False 

Phone Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 4 
Internal Member Id  Numeric(20)   
Account Phone Number  String(30)  See Article for Phone Number Formatting 
Mobile Phone Number String(30) See Article for Phone Number Formatting 
Account Phone Marked as Bad  Boolean True, False
Mobile Phone Marked as Bad Boolean True, False

Example Data

4|12324|1-(333) 555-3092|1-(333) 555-4930|False|False  

Address Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 5 
Internal Member Id  Numeric(20)   
Country Name String(120)   
Country Abbreviation  String(2)  
C/O (Care Of) String(120)  
Address Line 1 String(120)  
Address Line 2 String(120)  
City String(120)  
Region Name String(120)  
Region Abbreviation String(2)  
Postal Code String(14)  
Address Marked as Bad  Boolean True, False

Example Data

5|182398|United States|US|John Smith|1504 Main St|APT 143|Newark|Delaware|DE|19711|False 

Club Trigger

Note: Club Triggers occur any time a club-related change happens for an associated member. The Club Trigger Sync Record will include all clubs each member is assigned to.

Field Name  Type  Notes 
Record Type  Numberic(1)  Always contains a value of 6 
Internal Member Id  Numeric(20)   
Club External Reference  String(20)   

Example Data

6|213928|REWARDS_CLUB 

Delete Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 7 
Internal Member Id  Numeric(20)   
Combined Into Member Id  Numeric(20) If the result of a combine, the Internal Member Id for the resulting account is listed 

Example Data

7|512932|23029

Point Change Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 8 
Internal Member Id  Numeric(20)   
Points Available  Float(21)   
Points Earned  Float(21)  
Points Deducted Float(21)  
Points Used Float(21)  
Points Expired Float(21)  
Points Expired Last Process Date  Date/Time YYYY-MM-DD HH:MM:SS UTC, 24-hour clock (Optional field, must be configured in sync settings) 
Next Expiration Date 1  Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 1 Float(21) (Optional field, must be configured in sync settings) 
Next Expiration Date 2 Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 2 Float(21) (Optional field, must be configured in sync settings) 
Next Expiration Date 3 Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 3 Float(21) (Optional field, must be configured in sync settings) 
Next Expiration Date 4  Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 4 Float(21) (Optional field, must be configured in sync settings) 
Next Expiration Date 5  Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 5 Float(21) (Optional field, must be configured in sync settings) 
Next Expiration Date 6 Date YYYY-MM-DD (Optional field, must be configured in sync settings) 
Next Points Expiring 6 Float(21) (Optional field, must be configured in sync settings) 

Example Data

8|70827|1551|6283.8234|0|1870|2862.8234 

Head of Household Change Trigger

Field Name  Type  Notes 
Record Type  Numeric(1)  Always contains a value of 9 
Internal Member Id  Numeric(20)   
Is Head of Household  Boolean  True, False
Is Dependent of Household  Boolean  True, False
Belongs to Head of Household Internal Member Id  Numeric(20) Internal Member Id of the Head of House this member belongs to, if relevant 
Number of Head of Household Dependents  Numeric(3)  Number of dependents this Head of House member has, if relevant 

Example Data

9|12324|True|False||2

Member Custom Field Change Trigger

Field Name  Type  Notes 
Record Type  Numeric(2)  Always contains a value of 10 
Internal Member Id  Numeric(20)   
Member Custom Field External Reference  String(40)   
Custom Field Datatype Integer  1 = Checkbox
2 = Dropdown
3 = Integer
4 = Money
5 = Text
6 = List
7 = Date
8 = Address
9 = Multi Checkbox
Custom Field Main Value Variable Checkbox = "True" or "False"
Dropdown = Dropdown Value External Reference 
Integer, Money, Text = Actual Value
List = Length of List
Date = Actual Value (YYYY-MM-DD format) 
Address = C/O Value
Multi Checkbox = Number of checkboxes checked 
Custom Field Value Additional Values Variable Address contains 7 additional columns (Line 1, Line 2, City, State/Region, Postal Code, Country) 

List contains a variable amount of additional columns equal to the amount of list elements

Multi Checkbox contains a variable amount of additional columns, with external references for the selected checkboxes 

Example Data

10|34387|Checkbox_1|1|False 10|34387|Customer_Type|2|C  
10|34387|Integer_1|3|400  10|34387|Money_1|4|320.00  
10|34387|Text_1|5|ABCDEF  
10|34387|List|6|10|A|B|C|D|E|F|G|H|I|J  
10|34387|Date_1|7|2015-01-02  
10|34387|Address_1|8|John|100 Main St|Apt. 4|Newark|DE|19701|US  
10|34387|MultiCheckbox_1|9|2

Member Child Trigger

Note: Member Child Triggers occur any time a Member Child-related change happens for an associated member. The Member Child Trigger Sync Record will include all children each member has.

Field Name  Type  Notes 
Record Type  Numeric(2)  Always contains a value of 11 
Internal Member Id  Numeric(20)   
Child First Name  String(60)   
Child Gender String(9) Boy, Girl, Undefined
Year Numeric(4)  
Month Numeric(2)  
Day  Numeric(2)  

Example Data

11|1|John|Boy|2005|10|12 

Aimia Logo

Please note: All external ALP SaaS links and references are directed to US datacenter unless specifically noted.

Tags:
Home: Aimia Loyalty Platform SaaS Wiki Copyright © 2019 Aimia Inc. All Rights Reserved.