Overview

Auxiliary Data (Aux Data) helps you import supplementary user information to an existing database. Often, marketers send campaigns to users around specific events that may require additional short-term data that needn't be stored permanently. For example:

• • • Businesses may wish to personalize campaigns with data about limited-time offers and discounts. Aux data can be used for campaign personalization for the duration of the offer.
    • An organization that runs a monthly fantasy sports league (where users collect points and win rewards every week) may want to send campaigns to users based on their participation in the current month. The points accumulated by a user would expire at the month's end and cease to be relevant after that. In such cases, Aux Data can be used to import the data to MoEngage and personalize campaigns.

Aux Data helps you ingest relevant information only for a specific timeframe and needs to be stored temporarily into MoEngage using file imports and use them for campaign creation. Aux Data also allows you to mark the fields that need to be updated in the user profile permanently.

Supported Sources

1. 1. 1. S3 Imports
      2. SFTP Imports

For information about preparing your file for import, refer to File Naming Conventions.

How to import Aux Data to MoEngage?

To import Aux Data:

1. 1. 1. Navigate to the Import management dashboard (Segment -> S3/SFTP Imports) and click on the Data tab.
      2. Click on the option available at the top right corner of the screen.
      3. Choose Aux Data from the available options.
      4. Select the S3 or SFTP option in the popup that opens.
      5. Click continue to go to the Aux Data Import UI.
      6. The Aux Data Import UI has three main steps, and they are:
         • • Configure Source and Format
           • Map your source file's columns to MoEngage attributes
           • Schedule the import and define import frequency.
      7. Once imported, you can see the import-related information on the Aux Data tab of the Import Management Dashboard.
      8. You can view the Aux Data, duplicate it or delete it from the dashboard.

Step 1: Configure Source and Format

The following fields are available in this section.

• • • Import Name - This field lets you specify a name for this import. You can identify this import using the name specified here on the Imports Dashboard.
    • Specify S3/SFTP Details
      S3 SFTP

      In this section, you can specify the details of the S3 Bucket where the file to be imported. The following fields are available here:

      Field	Description
      S3 bucket name	The name of your S3 bucket
      S3 access key	The Access Key ID of the account you want MoEngage to connect to your S3 bucket.
      S3 secret key	The Secret Access Key corresponding to your S3 bucket's Access key ID.
      Region	This is the region in which your bucket is hosted.
      Folder Path	The path of the folder in which your files will be present.

      For more information, refer to adding your S3 credentials.

      You can specify the details of the SFTP Client credentials and the folder path from where the file will be imported in this section. The following fields are available here:

      Field	Description
      Username	This is the username with which MoEngage will connect to your SFTP server.
      Password	The password associated with the username.
      Folder URL	The path of the folder in which your files are present.

      For more information, refer to adding your SFTP credentials.

    • File Encryption - If you upload an encrypted file, you can specify the encryption details by checking the Is your file encrypted? checkbox. MoEngage supports PGP encryption. For more information about how it works, refer to PGP encryption.

      Once the checkbox is checked, you can provide the following details:

      Field	Description
      Decryption Key	This is your Private PGP Key.
      Signing Key	This is your Public PGP Key.
      Key passphrase	This will be used to encrypt your private key.

      info

      Note File names must adhere to the file naming conventions specified for data imports. For information about this, refer to Naming Conventions. For information about the supported date and time formats, refer to Date and Time formats. For information about structuring the columns in your CSV file, refer to File Structure.

    • File Name Configuration - You can specify the prefix, date, and time format that will be present in your file name. This will fetch the files from the specified S3 bucket/SFTP Folder. The Filenames should have a prefix and datetime separated by "_". Prefix should preferably consist of alphabets, numerals, and "_". The default prefix is "aux_data_". Sample File Name: registered_userdata_20220131.csv
    • Enter the prefix name of your file and the time format, and click Fetch Files. The list of files in the S3 bucket with the specified name will be fetched and populated in the file to preview the dropdown.
    • Select the file of your choice from the dropdown to preview the top 5 rows of the file.
    • Click Next to move to the second step.

Step 2: Map your data to MoEngage Attributes

In this step, you can specify the file's primary key (the column containing a unique value in each row of the file). To set the primary key, choose the column name that contains the unique field from the Primary key dropdown. The dropdown contains the list of all columns in the file chosen in the previous step.

You can do the following optionally after choosing the primary key:

• • • Save as custom segment - This option lets you create a custom segment from the user base in the imported file. To save a custom segment:
      • • Turn on the Save as custom segment toggle.
        • Provide the segment name. The custom segment name has to be unique (two segments cannot have the same name).
        • Map the column that contains the user ID to facilitate custom segment creation. This column would be the ID field in the user profile of the users in MoEngage. For more information, refer to ID in MoEngage.
    • Update user profile attributes - This option lets you update the Aux Data in the User Profiles of the respective users in MoEngage. To update user profile attributes:
      • • Turn on the Update user profile attributes toggle.
        • Map the column that contains the user ID so that the user can be identified in MoEngage. This column would be the ID field in the user profile of the users in MoEngage. For more information, refer to ID in MoEngage.
        • Once the ID column is specified, the user attributes dropdown is enabled. If you use a custom attribute to store the ID value, select the attribute from the dropdown.
        • To map other fields, click the Update column checkbox at the end of the row to enable the user attribute dropdown. Select the attribute to which the column name should be mapped.
        •  Any column that is not mapped will be treated as Aux Data, and the data storage policies for Aux Data will apply. When columns are mapped to user attributes, they would be updated permanently, and the rate limits for user data imports would apply. For more information, refer to User Data Imports.
    • Send import status - You can send the status of the user imports by turning on this toggle. You can send the import status to a maximum of ten email ids. Once the toggle is turned on, the Email ID dropdown will be available with the list of email IDs.

Click Next to schedule the import.

Step 3: Import Schedule and Frequency

In this step, you can schedule the frequency of imports and the Aux Data expiry time.

Import Frequency

The following options are available here:

• • One Time - You can schedule the import once as soon as possible or at a fixed time using this option. The following options are available here:
    • • • As soon as possible - This option will start the import immediately.
        • At fixed time - This option helps you import the data on a specific date and time and contains the following fields:
          • • • • Timezone - the timezone in which the import would happen.
                • Start Date - the date on which the import would start.
                • Send Time - the time at which the import would start on the specified date. Select am or pm depending on the time of day the import should begin.
      • Periodic - You can schedule the import periodically using this option. The following fields are available here:
        • • Timezone - the timezone in which the import would happen.
          • Start Date - the date on which the import would start.
          • Send Time - the time at which the import would start on the specified date. Select am or pm depending on the time of day the import should begin.
          • Periodic - the periodicity of the import. You can choose from three options: Daily, Weekly, and Monthly, from the radio buttons available to the left of the screen.

            Periodicity	Description
            Daily	Repeat every - This option lets you specify the number of days after which the data import should be repeated.
            Weekly	Repeat every - This option lets you specify the number of weeks for which the data import should be repeated. Repeat on - This option lets you specify the day(s) of the week on which the import is to be repeated (For example, if you wish to import the data every Monday, Wednesday, and Friday, select these days in this option).
            Monthly	Repeat every - This option lets you specify the number of months for which the data import should be repeated. Repeat on - This option lets you do the following: Days of the month - Choose this option for repeating the imports on specific dates. Select the date(s) of the month when the data should be imported. (For example, to import dates on the 5th and the 25th of a month, select the 5th and 25th in the calendar widget.). Note: If the selected date(s) doesn't exist in the month specified (as it is a shorter month), the import will be scheduled on the last date of the month. (For example, if the 30th and 31st are selected and the month is February, an import would be scheduled on the 28th of the month). Days of week -  Choose this option to specify the day(s) of the week on which the import has to be scheduled (For example, if you wish to import data every Monday, Wednesday, and Friday, select these days in this option).

        

Data action

You can define the Aux Data expiry in the Aux data expiry dropdown.

Click Done to import the Aux Data. Once you've imported successfully, you can see the import added to the import management dashboard.

Actions that can be performed on Aux Data

To perform an action on an Aux Data import, click on the actions icon at the end of the row that contains the import and select the desired action. You can perform the following actions for your import here:

• • • View Details - You can view the details of Aux Data imported within the last <n days/months> here. The following details are available: date and time of when the import was scheduled, file name, status, number of users created, number of users updated, and number of successful and failed uploads.
    • Edit - You can edit all the fields except the import and segment names.
    • Duplicate - You can duplicate an import using this option.
    • Delete - You can delete an import using this option.

Next Steps

• • • Using Aux Data for Personalizing Email Campaigns