Application File Imports Release Notes Sync Web Services FAQ

Sync

System Location: Tools / Sync

What is a Sync?

A Sync is a synchronization process between the ALP SaaS platform and external systems. By performing a sync (either scheduled or manually), users can "push" data from ALP SaaS to one or multiple FTP destinations.

Syncs are always transferred by FTP. ALP SaaS supports three FTP methods (standard, SSL and, preferably, SSH) using default ports. Files can be compressed and/or encrypted before distribution. Compression and encryption options are detailed within ALP SaaS.

Users looking to perform Syncs must contact ALP SaaS Support in order to initially configure their instance. Syncs will not be available until added by the support team. Additionally, users need adequate system permissions in order to access Syncs.

To learn how to configure a Sync with multiple FTP destinations, read "How to Configure a Sync for Multiple FTP Destinations."


Standard Syncs Available

ALP SaaS offers 16 standard Syncs. Remember, these must be initially configured by ALP SaaS Support. You will not see them in ALP SaaS until they are configured. Below, you will find each Sync and its basic details. To read more about each Sync, click its type name.

Sync Types and Intended Purposes

Sync Type Intended Purpose Notes

Member Extended Sync

Exporting member-specific changes.

This sync exports batches of member changes with related information, including the point change and custom field triggers.

Member Descriptor Sync

Exporting basic information for members in a specific member descriptor.

 

Member Future Point Expiration Sync Exporting member-level future point expiration data.  

Member Ranking Sync

Exporting basic information for members in a specific member rank.

This sync exports all rank-specific member details in the database, not just those added or changed since the last execution.

Member Ranking Sync Extended

Exporting extended rank-related information for members.

This sync exports current member information for those entering sets, changing levels or with descriptor reassignments.

Member RFM Sync

Exporting RFM totals and basic member information for the full member database.

 

Member Product Purchases Sync

Exporting member purchase history with products ranked by quantity.

This sync exports each member's purchase history and indicates which products they buy most.

Reward Sync

Exporting reward-specific changes.

 

Reward Type Sync

Exporting reward types and available details.

 

Interaction Sync

Exporting basic member account interactions.

Interactions could include adding an email address, adding a phone number or adding a birthdate.

Case Sync

Exporting case events.

This sync is unique because it exports a stream of events instead of only the most recent change.

Transaction Sync

Exporting batches of transactions.

This sync can create multiple separate files per target. When executed, all transactions since the last execution will be included.

Product Item Sync

Exporting product item information.

This sync exports every product item in the database, not just the items added or changed since the last execution.

Location Sync

Exporting basic location information for all locations.

This sync exports every location in the database, not just the locations added or changed since the last execution.

Survey Sync

Exporting survey, trivia and poll answers.

 

Campaign Member Group Sync

Exporting basic information for members in a campaign.

This sync exports all campaign-specific member details in the database, not just those added or changed since the last execution.

Promotional Member Group Sync

Exporting basic information for members in a promotion.

This sync exports all promotion-specific member details in the database, not just those added or changed since the last execution.


Managing an Existing Sync

Once a sync is configured by ALP SaaS Support, sync management can be handled by a user with adequate permissions. These options are available in ALP SaaS at Tools / Sync

Enabling or Disabling a Sync

The current status is represented in the "Enable/Disable" column. If enabled, the sync will be run automatically at the configured time in the Execution Time column. To change the running status, click the link within the Enable/Disable column.

Modifying Settings

To view and/or manage the execution time and all other sync-related options, click on the Edit link in the Settings column for the appropriate sync. Due to potential issues with daylight savings transitions, it is recommended not to set sync times to 2:00 AM.

Adding, removing and editing FTP Destinations

Syncs can be configured to send to more than one FTP destination. FTP destinations can be added or edited by clicking the Add or Edit link in the FTP Destination column. When configuring an FTP Destination, users will name the Sync destination, set its Server Address, Server Type, Server User and Server Password. Optionally, users can define a specific FTP Port Number.

For more information on configuring FTP destinations, read "How to Configure a Sync for Multiple FTP Destinations."

Individual Sync Instances (Dashboard)

Click the View link within the Dashboard column of the appropriate sync to go to its Sync Dashboard.

Viewing Past Sync Instances

In the sync dashboard, previous sync runs can be viewed. To see more detail about the file creation for a specific instance, click the Complete link in the Creation Status column. To view more detail about the transfer, click the Completed link in the Transfer Status column. The original file can be downloaded from either link.

Re-Transferring Past Sync Instances

From the Transfer Status detail page, the Transfer File(s) button can be used to re-transfer a file in the event that the specific file should be re-transferred.

Generating New Sync Instances

Clicking the Process New Sync button on the dashboard page will generate and deliver a new sync file.

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.