Data Synchronization facilitates the automatic upload and updating of subscriber data from an institutional directory system. This section describes how this element functions, and the various features available to users in the configuration and maintenance of the Data Feed. It can be found at: https://[ClientDashboardURL].apparmor.com/Notifications/Data/
Please see the File Format Options page for information on the formats we support.
| Child pages (Children Display) | ||
|---|---|---|
|
FTPS/SFTP Connection
AppArmor provides an FTP folder where you can place the extracts from your directory. This tab provides the connection details you’ll need to set up an FTP connection, along with some basic information about file format.
...
SFTP connections should be made over Port 2200
File Format
The files should by plain text and contain one subscriber per line.
File Names
The names of the files should correspond to the group code they will be imported to, and have a .txt file extension. (e.g.: students.txt)
File Locations
Place the file in the correct folder for the mechanism.
Synchronization
Synchronization runs automatically whenever a new file is uploaded. We recommend once per day, and no more than twice per day.
Custom Synchronization
Custom synchronization preferences can be configured on the "Custom Subscriber Sync" tab. Files should be placed in the /CUSTOM FTPS folder, and should be CSV formatted text files that include a header row.
Custom Subscriber Sync
You can view all of the files in the CUSTOM folder on the FTP site. Most clients rely on AppArmor Staff to create file mappings for these files. We recommend that for the most part any interaction with this page (other than downloading a file to verify its contents) is left to AppArmor Staff.
Sync
...
Logs
AppArmor provides information about the status of the Data Synchronization by giving authorized Dashboard users access to the full logs from the Data Synchronization and allowing of each log file, with the option to "View Log" or "Download" the logs. This section also updates in real time as the logs are being processed immediately after they're synced with our system. Below are the fields that are recorded in this section:
Data Sync Notifications
This section allows Dashboard Admin users to opt-into receiving automated email notifications about the activity of the Data Synchronization, with a choice of receiving an email when a new file gets imported, and/or a daily overview email containing an overview of the files imported each day. We strongly recommend subscribing to these notifications to keep an eye on the status of your automated Data Synchronization.
| Info |
|---|
While there's no Menu Item for the Data Synchronization section, you can access it through a button in the top right corner of the Alerting Mechanisms page: |
...
| title | Sync Service Error |
|---|
...
.