Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
AppArmor supports exporting to FTP in order to automatically populate subscribers. We use a simple approach with a low data footprint for a highly efficient and reliable system. Specifications for export below.

FTP Protocol

AppArmor supports both SFTP and FTPS. If you'd like to use SFTP, please generate a public key that is at least 2048 bits and send it to your AppArmor Onboarding contact so we can load it into our SFTP server. Most clients use FTPS.

...

We support 2 formats. Please note that in both formats, the file name(s) must be exactly the same each time you upload a new file.

Single

CSV

file

You send us a single file with all subscribers across multiple Alerting Mechanisms.

Folder Structure

Please put your .csv file in a folder called "CUSTOM" in the root folder of the FTP account. After that's done, we'll do some configuration to map the data in the Dashboard, and start the import script.

File Format

Please have a look at the attached “Sample Data.csv” file and also the “Sample Data with notes (Excel).xlsx” file. The csv is the actual format of the file, the xlsx has some notes on each row that you may find helpful.
Generally we're looking for the csv to provide the following

File

This is the most common configuration. You send us one or more CSV Files, which can contain the following information:

  1. REQUIRED - Headings (not quoted). The first row of the csv must contain the column headings. Headings should not contain any special characters, notably periods (".") are not allowed.

  2. REQUIRED - Subscriber data (quoted). This includes emails, SMS numbers, and Voice Call numbers.

  3. OPTIONAL - Groups (quoted). Applicable groups can go in one column, separated by commas. This can be very helpful if you want to have one person subscribed to multiple groups.

  4. OPTIONAL - User metadata (quoted). This can include names, id numbers, etc, as desired.


Please note that our system uses a "Data Mapping" Tool so that we can handle files with varied formats.


Multiple

As long as the files follow the above guidelines, it doesn't matter what order the rows are in.

CSV File Folder Structure

Please put your .csv file in a folder called "CUSTOM" in the root folder of the FTP account. After that's done, we'll do some configuration to map the data in the Dashboard, and start the import script.

Sample Files

Please have a look at the attached “Sample Data.csv” file and also the “Sample Data with notes (Excel).xlsx” file. The csv is the actual format of the file, the xlsx has some notes on each row that you may find helpful.

TXT files

You send us a file for each subscriber group.

 
Folder Structure:
 
Folders should be are named after each Alerting Mechanisms. Please name them according to the following specifications (no quotes):
 
Email Messages: "EMAIL"
SMS Text Messaging: "SMS"
Voice Call: "VOICE"
Desktop Alerts: "DESKTOP"
 
Text Files:
 
Please export your subscribers to a .txt file, with one subscriber/line. See the "Sample Data.txt" file attached. Files should be named for the groups their subscribers should be put into.

Note that this format does not accept metadata for the subscribers: just raw phone numbers, email addresses, or Device IDs should be included.