Summary

• A data feed is a mechanism through which we can push/send the available data from the Annex Cloud system to the clients' destination automatically with a specified frequency of time. The data could be Member Data, Interaction Data, Reward Data, Points Data, Tier Data, Liability Data, etc.
  
• To start the data feed transfer, the user must set up a connection with SFTP or S3 AWS. Once the connection is established, the user can create a data feed. The data feed allows seamless transfer of the feed file between the client and Annex cloud folders.
• While creating the data feed, a dynamic file name can be set so that the same feed file will be sent at regular intervals. The user can map the fields between the Annex Cloud and the clients to save the data under assigned columns in the database.
• These feeds run with the help of a cron job. This cron is scheduled to perform the transfer at a particular period so that the file transfer takes place on a timely basis.
• The cron job outcome can be checked by the Data transfer cron logs.

Steps to Access the Data Feed Connectivity Settings

Navigate to Products >Pre-Built Integrations > Data Sync> Connectivity Settings

To set the Data Feed connections, you must follow the steps below:

1. Click Products as shown in the image below.
2. Click Pre-Built Integrations as shown in the image below.
   
3. Click Data Sync to display the following image:

Note: On the Connectivity Settings page, you must set all the required conditions for the Data Feed process.

Connectivity Settings

• Before creating a new data feed, we need to establish a connection with the client SFTP / AWS S3 where we push the data files. To set the connection you need to follow the below process.
• Navigation: Data Sync Dashboard > Connectivity Settings
• Here, the user will set up the connection through which the data can be sent or received.
  

Create New Connection

1. To create a new connection, you need to click Add New as shown in the below image.
2. Once you click Add New, you will be directed to a new page in which you can set the connection by providing all the required information.
3. We have two types of connections - SFTP and S3 AWS.
   
   

CASE 1: When you select SFTP as the Type of connection.

• Under the SFTP connection, you will have the following parameters for which you need to provide the information before saving all the details.
• Provide the parameters below:
  

CASE 2: When you select S3 AWS as the Type of connection

• In the case of S3 AWS, all the access credentials are stored in the bucket. Once you provide the required information as shown in the below image, the connection is established.
• A mandatory field called Region Name appears below the Type of Connection field. 
  

Once you have set a connection and provided all the required information then by pressing on the “SAVE” button, all the data will be saved and can be seen on the dashboard. Here all the connection details will be displayed and you can also edit those connections as per the requirement.

1. In the above image point 1 shows the area at which all the connection information will be displayed.
2. Search: Through this feature, you can search for any type of connection.
3. Export: By clicking on this button, you can export all the connection details in excel format.

Adding a New Data Feed

• You need to follow the below process to add a new data feed.

Navigation: Loyalty > Add New

• Click Add New, a Pop-Up will be displayed in which you need to select the data feed page as shown in the image below.
  

After clicking on the “Proceed“ button, you will be directed to a page in which you will have 4 sections as shown in the image below:

1. Data Feed Details
2. Email Notification
3. Schedular
4. Field Mapping
   

Data Feed Details

Here, the administrator creates a dynamic file name, selects the separator used in the file, and defines the type of file. The administrator also defines the connection through which the file is sent and the folder where it will be sent.

Note: Sites with Multi-Templates display the template feature.

• Select Templates: All the Active or Inactive Templates associated with the site are displayed here. Select one of the options from the drop-down list. You have the following options to select a Template:

1. All Templates:
   All templates are automatically selected when this option is selected.
   
2. Select one or more Templates:
   In accordance with your requirements, you can select a single Template or more than one Template. As an example, multiple templates have been selected on the following page.
   

• Separate Template Reports: Using this option, you can generate the Data Feed report separately for all the Templates.
  

Note: Separate Template Reports must be enabled for all reports to be sent separately.

The following table shows the differences when the flag is turned ON or OFF :

• Data Feed Name: You need to provide the data feed name.
• File Details: In the file details, you have four options as shown in the image below.
  

In the above four options, you need to provide the details to create the file name.

Option 1: Provide the name of the data feed. For example, Member Report.

Option 2: Provide a separator between the name and date fields. You have the following options:

Option 3: Select a date and time format for the time stamp in the file name. You have the following options.

Option 4: Select a file format like CSV.

• File Name: Once you have provided all the details of the above-shown parameters then each of the field details will be displayed in the file name as shown in the below image.
  
• Select The Type Of Data Feed: Select Inbound or Outbound from the dropdown list.
• Report Is Based On: 

This field provides multiple report options for export. Based on the selected report from the drop-down, the system generates the report using the corresponding transactions from the database. The main query is executed according to the selected report.

After selecting a report from the drop-down, complete field mapping in the final step to define the required data fields. Additionally, optional fields can also be mapped and included in the export.

For example, if the Reward Report is selected from the Report Is Based On drop-down, the main SQL query checks the reward transactions and export the relevant data, including any applicable optional fields. This process remains consistent across all reports.

Available Report Options in "Report Is Based On" Drop-down

In the "Report Is Based On" drop-down, you have the following report options to choose from.

• Order Report
• Member Report
• Points/Liability Report
• Reward Report
• Tier Report
• Points Accrual By Tier Report
• Accrual Redemption Report
• Interaction (Activity) Report
• Hold Points Report
• Manual Points Report
• Manual Spend Report

The following details outline the process of selecting the Survey and Interaction reports, choosing the relevant fields, and viewing the final output after the report is generated.

Report Based On: Survey Report

If Report Is Based On is selected as a survey report, a new tab called Select Survey's is displayed. This tab shows all the surveys associated with the selected template.

• Select Survey's: Choose all the surveys for which you want to generate the report.
  When selecting a survey based report, the field mapping page automatically selects the survey report when adding fields to the report list.
  

In the annex field, you must select a property of the survey from the drop-down list, such as survey ID, user ID, or survey name.

Survey Report:

The survey report includes information about the survey, including its sections, questions, and members.

After selecting the survey options mentioned above, the survey report is generated with the following parameters:

• User ID: Displays the ID of the member.
• Survey Submit ID: Displays the ID generated at the time of the survey submission.
• Survey ID: Displays the unique survey ID that is auto generated on creation of a new survey on the configuration.
• Survey Name: Displays the survey name as specified by the administrator.
• Survey Start Date: Displays the start date of the survey.
• Survey End Date: Displays the end date of the survey.
• Survey Type: Displays the survey type as product feedback, display a score, vote/pole, community survey or other type.
• Status: Displays the survey’s status as, active or inactive.
• Section ID: Displays the unique section ID.
• Section Name: Displays the section name as specified by the administrator.
• User Section Completed Date: Displays the date on that the member has completed the section.
• Question ID: Displays the question ID.
• Question Name: Displays the question name set by the administrator.
• Answer ID: Displays the answer ID.
• Answer Value: Displays the required answer, that must appear alongside the question.
• Right Answer: Displays the right answer of the selected question.
• Answer Date: Displays the date on that the answer is provided.
• User Survey Completed Date: Displays the date on that the member completes the survey.
• Section Benefit Point: Displays the number of points awarded to members once they complete the section.
• Survey Benefit Points: Displays the number of points awarded to members once they complete the survey.
• Survey Benefit Reward: Displays the survey reward given to the members once they complete the survey.
• Section Benefit Reward: Displays the section reward given to the members once they complete the section.
• Survey Create Date: Displays the date on that survey was created.

Report Based On: Interaction Report

If the "Report Is Based On" option is set to "Interaction Report," the data feed report will be generated based on interaction data.

To generate reports, you need to select an action in the report list. This action includes annex fields such as action ID, action name, points for action, action performed, action performed date, action attribute name, and action attribute value. The image below illustrates how to add a field to the field mapping.

The field mapping page consists of the following parameters. All the associated parameters for the interaction report can be seen below:

After selecting the interaction report options, the report is generated with the following parameters:

• Action name: Displays the name of the action.
• Action ID: Displays the action ID.
• Points for action: Displays the number of points awarded for completing the action.
• Action performed: Displays the action performed by the member.
• Action performed date: Displays the date when the action was performed.
• Action attribute name: Displays the attribute associated to the action.
• Action attribute value: Displays the specific value assigned to the attribute associated with the action. For instance, if the attribute is "action type," the attribute value could be "purchase," "registration," or another action type.

Once you select an option from the Report Is Based On drop-down list, you need to provide the required information for the following fields to complete the setup process.

• Select The Type Of Column Separator: In order to establish continuous synchronization of the data, choose an option from the drop-down list. In the Column Separator, you have following options:

• Connection Name: Pass the connection name for the data feed details.
• Folder Path: Provide the folder name in which all the data will be stored. You need to provide the folder path in the format of “/ folder path / ".

Email Notification

• Through this feature, you can send the Data feed success or failure message to the listed members so that they will get information related to success or failure.
• Before setting the email notification you need to set the email template for success or failure.

Navigation: Data Sync Dashboard > Email Template

• Click Add New, and a page will be displayed all the details related to the email template.
  
• Template Name: Provide the name of the email template.
• Type: We have two types of email templates i.e, Success and Failure. You need to select one of the options from the drop-down list as shown in the below image.

Note: You should create both Success and Failure templates before selecting it.

• Email Subject: Pass the email subject which will be displayed while sending the email.
• Email Message: Provide the email message which will be displayed at the time of data feed success or failure.

In the Email Message, a list of HashCodes are defined. All HashCodes are displayed, once you click the following icon.

Note: The Hashcodes are variables that will populate with details of the specific information.

To send the information associated with the HashCodes, you must enter the required HashCodes in the Email Message box. For example, in the following page, as soon as #DataFeedName# and #FileName# are passed to the Email Message, the Datafeed Name and Datafeed File Name are displayed to the recipient.

• Once you have set the template for the email, then you need to provide all the parameters' information on the Email Notification page as shown in the below image.
• You need to enable the email notification button to get the success or failure email.
  
  

You need to provide the details of the following parameters:

Schedular

• In Data Sync, we have created a cron to send/receive the data but through this section, we can schedule the time for the cron to run.
• Under the schedular section, you have the following parameters for which you need to provide the information to set the time to run the cron.
  
• Start Date: The time at which the cron will run. For example, if you have given information as shown in the below image then the cron will run on 9th February 2023 at 12:10 PM.

• Start Date and Time range for Data selection: Provide the date and time from which the data will be captured for the Data Feed process.
• End Date and Time range for Data selection: Provide the end date and time till which the data will be captured for the Data Feed process.
• Select The Type Of Delta:

We have 3 types of Delta options under the drop-down list. Based on the selection, the data will be collected for the Data Feed.

•  Frequency: Based on the type of delta data selected, you will have options in the frequency drop-down list. Select the frequency for the data feed. For example, if you have selected frequency as a Day then the cron will run on a daily basis and collects the data.
  

Field Mapping

• The user maps the fields between the Annex Cloud and a Client in this section. As per the client’s request, we need to select the parameters in the field mapping. After clicking Finish, all the data will be collected.
  
• To add a new field, you need to click on the “Add Field“ button as shown in the below image.
• Once you click on the add Field button a pop-up page will be displayed and you need to select all the required information like report list, Annex field’s, and client fields.
  
• Report List - The report list contains all the names of the Annex product like Tier, Campaign, and others. Select one of the options from the drop-down list.
• Annex Cloud fields - Select the desired field from the dropdown provided. The fields displayed will depend on the option selected in the report list.
• Client Name fields - Client Name will be dynamically picked from the Site Name. This is a text box in which you can enter the client field name as per their request.

In the below image, you can see all the added fields. Point 1 indicates the Annex field and Point 2 represents the Client name fields.

Note: In the Field Mapping page, you can change the sequence of the fields as per the requirement. For example, the following pages show that daily_date is now in the first position instead of second.

Click https://imgur.com/VdKo5RV for a better understanding.

Once you have added all the fields, click Finish to get all the required data.

Available Fields by Report Type

The following fields are displayed based on the option selected for Report Is Based On on the Data feed Details page.

 

When Report Is Based On	Associated fields (To generate the report, you need to select among the following fields)	Description
Member Report	A flag called "Report with updated User's data" appears when Member Report is selected (this flag is only available for the Member Report). When this flag is enabled, the report is generated using the updated member data. For example, if a member information is updated (Name, Birthday, email, phone, etc.), these details will be pushed to the client.
	User ID	An internal database user ID used for JOINs and Data Mapping.
	UID	Displays the member’s unique identification number.
	User Email	Displays the member’s email address.
	First Name	Displays the member’s first name.
	Last Name	Displays the member’s last name.
	Full Name	Displays the member's full name (First Name + Last Name).
	Phone	Displays the member’s phone number.
	City	Displays the city of the member.
	State	Displays the state of the member.
	Zip Code	Displays the Zip Code of the member.
	Country	Displays the member’s country.
	Birth Date	Displays the member’s date of birth.
	Anniversary Date	Displays the loyalty member's anniversary date.
	Loyalty_join_date	Displays the date the member joined the loyalty program.
	User Profile ImageURL	Displays the image URL for the loyalty member’s profile picture.
	Opt Out Date	Displays the opt-out date of the loyalty member.
	Opt-in Date	Displays the opt-in date of the loyalty member.
	Opt-in Status	Displays the opt-in status of the member.
	Source	Displays the source of the loyalty member's profile creation, whether it was from a website, application, or in-store.
	Update Date	Displays the date and time on which the loyalty member profile was updated.
	Member Status	Displays the loyalty member’s status as active or inactive.
	Extended Attributes	Displays the extended member attributes that are established in your program configuration.
Order Report	Order ID	Displays the unique ID of the order.
	First Activity Date	Displays the member's first activity date.
	Last Activity Date	Displays the member's last activity date.
	First Purchase Date	Displays the member's first purchase date.
	Last Purchase Date	Displays the member's last purchase date.
	Order Hold Points	Displays the number of points on hold against the order.
	Order Date	Displays the order date.
	Order Total	Displays the total amount of an order placed by the loyalty member.
	Discount Amount	Displays the total discount amount on a placed order.
	Store ID	Displays the store ID from which the order was placed.
	Coupon Code	Displays the coupon code, if a code was applied on the order.
	Points Earned	Displays the total points awarded against the order.
	Points Awarded	Displays the net points awarded on the order.
	Shipping Points	Displays the points applied for shipping the order.
	Transaction Type	Displays the type of transaction used that is credit or debit.
	Hold Point Release Date	Displays the release date for the points on hold.
	Transaction ID	Displays the internal database transaction ID.
	Order Source	Displays the source from which the order was placed by the loyalty member, such as the web or a store.
	Order Attributes	Displays the order attribute values passed during order creation (if order attributes have been configured).
Points Report	Total Credit Points	Displays the number of points credited to the member’s account for performing the action.
	Total Debit Points	Displays the number of custom points debited from the member’s account.
	Available Points	Displays the number of points currently available in the member’s account.
	Used Points	Displays the number of points used from the member’s account.
	Redeemed Points	Displays the number of points redeemed from the member’s account.
	Returned Points	Displays the number of points deducted or returned by members after order returns.
	Redemption Credit	Displays the number of points credited back to the member when an order is returned, if a redemption was applied.
	Lifetime Points	Displays total earned points by the member.
	Earned Points	Displays total earned points by the member in specific duration.
	Expired Points	Displays the number of expired points from the member’s account.
	Hold Points	Displays the total number of points currently on hold in the member’s account.
	Last Points Earned Date	Displays the most recent date and time points were credited to the member’s account.
	Points To Expire	Displays the total points that are going to expire.
	Reason	Displays the reason for the transaction.
	Points Expiration Date	Displays the expiration date of the points.
	Ending Points	Displays the ending points.
	Points	Displays the credit or debit points against the transaction. This field can be used for interaction report exports.
	Give Away Point	Displays the give away points.
	MBP Attribute	Displays the MPB attributes that are established in your program configuration.
Product	Product ID	Displays the product ID retrieved from the Product Catalog Management (PCM).
	Product Name	Displays the product name.
	Product Price	Displays the product price.
	Product Point Type	Displays product points type as YES, NO, or BONUS.
	Point Award Type	Displays the points award type as Product or Category.
	Product Point Ratio	Displays the point ratio for the product. This ratio acts as a multiplier applied to the points awarded based on specific criteria such as Product, Tier, Category, or Campaign. For example, if the productPointRatio is 3, the awarded points will be multiplied by 3.
	Product Bonus	If the productPointType is set to Bonus, displays the bonus or flat points awarded for the purchase of the product.
	Product Bonus Flag	Displays the status of a flag whether the Product Bonus applies. (Yes/No).
	Product Minimum Limit	Displays the minimum number of units that must be purchased to award points.
	Category Id	Displays category ID of the product.
	Category Name	Displays category name of the product.
	Category Point Type	Displays category points type as YES, NO, or BONUS.
	Category Point Ratio	Displays the point ratio for the category. A ratio is a multiplier applied to a point award based on specific criteria (Product, Tier, Category, Campaign).
	Category Bonus	If the categoryPointType is Bonus, displays the bonus point amount for the category.
	Category Bonus Flag	Displays the status of a flag whether the Category Bonus applies. (Yes/No).
	UPC	Displays UPC attribute value of the product.
	MPN	Displays MPN attribute value of the product.
	GTIN	Displays GTIN attribute value of the product.
	Brand ID	Displays Brand ID attribute value of the product.
Tier Report	Current Tier Earned Date	Displays current tier earned date.
	Current Tier	Displays the loyalty member's current tier name. For example, Bronze, Silver, Gold.
	Current Points	Displays current available points of the member.
	Tier Expiry Date	Displays the expiration date of the current tier.
	Highest Tier	Displays the highest tier name of the loyalty program.
	Lowest Tier	Displays the lowest tier name of the loyalty program.
	Lower Tier	Displays the lower tier name of the loyalty program in comparison to the previous tier.
	Next Tier	Displays the name of the next tier which is awarded to the member once the required milestones are achieved.
	Previous Tier	Displays the previous tier that was assigned to the member.
	Tier Spent	Displays the amount spent by the member in the current tier.
	Points To Next Tier	Displays the number of points required to achieve the next tier.
	Spent To Next Tier	Displays the spend amount that the member must spend to reach the next tier.
Reward Report	Reward Claimed Status	Displays the reward status as claimed, used, or expired.
	Reward Claimed Date	Displays the reward claim date.
	Reward ID	Displays the unique ID for the reward configured in the loyalty program.
	Reward Name	Displays the name of the reward used by the member.
	Reward Code	Displays the reward code used by the member.
	Available Rewards	Displays all the available rewards.
	Status	Displays the status of the reward as active or inactive.
	Available Redeemption Points	Displays the total available redemption points.
	Used Redeemption Points	Displays the total used redemption points.
	Eligible Reward Name	Displays the reward name for which the member is eligible.
	Used Points On Reward	Displays the points used by the member to redeem the reward.
	Points Required To Next Reward	Displays the points required to get the next reward.
	Highest Available Reward	Displays the reward for which the member is eligible and gets maximum points from all eligible rewards.
	Last Earned Reward Date	Displays the date on which the last reward was used.
	Reward Expiration Date	Displays the reward expiration date.
	Reward Used Date	Displays the reward used date.
	Spent Amount	Displays the number of points earned or amount to be spent by the member to qualify for the reward
	Total Spent	Displays the number of points earned or amount spent by the member to achieve the reward.
Points Accrual By Tier Report	Daily Date	Displays the number of points available each day and their cumulative value.
	Tier Name	Displays the tier name.
	Daily Available Points	Displays the daily available points for each tier.
	Daily Available Points Value	Displays the value of daily available points for each tier.
	Cumulative Available Points	Displays cumulative available points for each tier.
	Cumulative Available Points Value	Displays the value of cumulative available points for each tier.
Accrual Redemption Report	Redemption Date	The date of the transaction when the points were redeemed.
	Points Redeemed	Total points redeemed for the associated transaction.
	Accrual Transaction ID	A system-generated numeric ID for the particular transaction.
	Accrual Action ID	A system-generated value to describe the action for the transaction.
	Accrual Used Point	Displays the total used points.
	Accrual Transaction Type	Displays the accrual transaction type as debit or credit.
MPB Redemption	Bucket Name	Displays the MPB bucket name.
	Bucket Type	Displays the MPB bucket type as tier, order, points, product, or cart.
Action	Action ID	Displays the unique action ID for the action established in the loyalty program.
	Action Name	Displays the name of the action established in the loyalty program.
	Points For Action	Displays the number of points awarded for performing the action.
	Action Performed	Displays the name of the action performed as configured for the site. For example, purchase
	Action Performed Date	Displays the date on which the action was performed.
	Action Attribute Name	Displays the action attribute name.
	Action Attribute Value	Displays the attribute value.
Survey Report	User ID	Displays the ID of the loyalty member.
	Survey Submit ID	Displays the ID generated at the time of the survey submission.
	Survey ID	Displays the unique survey ID that is auto generated on creation of a new survey on the configuration.
	Survey Name	Displays the survey name as specified by the administrator.
	Survey Start Date	Displays the start date of the survey.
	Survey End Date	Displays the end date of the survey.
	Survey Type	Displays the survey type as product feedback, display a score, vote/pole, community survey or other type.
	Status	Displays the survey’s status as, active or inactive.
	Section ID	Displays the unique section ID.
	Section Name	Displays the section name as specified by the administrator.
	User Section Completed Date	Displays the date on which the member has completed the section.
	Question ID	Displays the question ID.
	Question	Displays the question name set by the administrator.
	Answer ID	Displays the answer ID.
	Answer	Displays the required answer, that must appear alongside the question.
	Right Answer	Displays the right answer of the selected question.
	Answer Date	Displays the date on which the answer is provided.
	User Survey Completed Date	Displays the date on which the member completes the survey.
	Section Benefit Point	Displays the number of points awarded to members once they complete the section.
	Survey Benefit Points	Displays the number of points awarded to members once they complete the survey.
	Survey Benefit Reward	Displays the survey reward given to the members once they complete the survey.
	Section Benefit Reward	Displays the section reward given to the members once they complete the section.
	Survey Create Date	Displays the date on which the survey was created.

 

 

Data Feed Log Report

• The data feed log report provides administrators a detailed overview of the performance of each data feed. As a result, the loyalty program administrators have the opportunity to examine the performance of each data feed while executing the records.
• By analyzing the execution behavior of the data feed, our clients can plan for better performance.

Navigate to Products >Pre-Built Integrations > Data Sync> DataFeed Log Report

• Click Datafeed Log Report to display the following page and provide the following details to search the report:
  

1. Date Range: Using the start and end date range, records are filtered for a particular period. If any log report start dates or end dates fall within the data feed log report date range, reports of all those data feeds are displayed here.
2. Data Feed Name: Provide the data feed name to search the records.
3. Select Job Status: Select one of the options from the drop-down list to filter the data. Under the drop-down list, you have the following options:
   

• After providing all the required information, click Search to find the following report data:
  

• Once you click Reexecution, the following page is displayed. Click YES to re-execute the file.
  
• In this log report, you can also export the file in Excel or CSV format. Click Excel or CSV to download the file.