Send to Airship

Airship is a customer engagement platform that helps marketers connect with their customers across every stage of the customer lifecycle.

You can send CSV files to Airship from Amperity using SFTP. The CSV files may contain audience lists or attributes .

This topic describes the steps that are required to send CSV files to Airship from Amperity:

1. Get details

2. Build a query

3. Add Airship destination

4. Add data template

5. Add orchestration

6. Run orchestration

Get details

Airship requires the following customer configuration details:

1. The username, passphrase, and hostname for the SFTP site.

2. The remote folder to which Amperity will send data.

3. The port number for the SFTP site.

   Note

   Refer to the Airship SFTP tutorial for more details.

4. The public key to use for PGP encryption.

   Important

   Amperity will generate the PGP credentials on behalf of the customer.

Build query

You will need to build a query that shapes data to the fields required by an Airship audience list or attribute list.

You can do this in the following ways:

1. Add a SQL table (using Spark SQL) to the customer 360 database that selects PII fields from the Customer_360 table, and then outputs them to a table with columns that map to the required patterns.

   Note

   PII fields may require SHA-256 hashing or using the CAST() function to convert to a UUID.

2. Add a SQL query (using Presto SQL) that filters within the query, and then outputs results that map to the required patterns.

   Note

   PII fields may require using the CAST() function to convert to a UUID.

The correct approach here depends on the data and the desired use case (or cases) for downstream workflows.

Map to audience lists

Airship audience lists are groups of devices, users, and addresses that can be targeted by channels and queries.

Map to attributes

Airship attributes are key-value pairs that are associated with audiences for better message targeting.

Add destination

Configure Amperity to send CSV files directly to Airship.

To add a destination

1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

2. Enter the name of the destination and a description. For example: “Airship” and “This sends query results to “Airship”.

3. From the Plugin drop-down, select Airship.

   This automatically selects sftp as the Credential Type and assigns sftp.airship.com as the location to which data is sent.

4. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box. Enter a name for the credential (typically “Airship”), and then enter the username and password required to access this SFTP location.

5. Under Settings, enter the path to the remote folder.

   Tip

   For remote folders that contain spaces, use a backslash (\) character to escape the space. For example, a folder named “From ACME” should be entered as “FromACME”.

6. From the File Format drop-down, select CSV.

7. Add a single character to be used as an escape character in the output file. (This should match the escape character required by Airship.)

   Note

   If an escape character is not specified and quote mode is set to “None” this may result in unescaped, unquoted files. When an escape character is not specified, you should select a non-“None” option from the Quote Mode setting.

8. Specify the encoding method. Encoding method options include “Tar”, “Tgz”, “Zip”, “GZip”, and “None”.

9. Optional. Add the PGP public key that is used to encrypt files sent to Airship.

10. Optional. Specify the line ending type: LF or CRLF.

11. Optional. Set the quote mode.

    Note

    If the quote mode is set to “None” and the Escape Character setting is empty this may result in unescaped, unquoted files. When quote mode is “None”, you should specify an escape character.

12. Optional. Select Include success file upon completion to add a .DONE file to indicate when an orchestration has finished sending data.

    Tip

    If a downstream sensor is listening for files sent from Amperity, configure that sensor to listen for the presence of the .DONE file.

13. Optional. Select Include header row in output files if headers are included in the output.

14. Select Allow business users to use this destination.

    This allows users who have been assigned to the Amp360 User and/or AmpIQ User policies to use this destination with orchestrations and/or campaigns.

15. Select Allow business users with limited PII access to send data. (A business user with limited PII access is someone who has been assigned the Restrict PII Access policy option.)

16. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

To add a data template

	From the Destinations tab, open the menu for a destination that is configured for Airship, and then select Add data template. This opens the Add Data Template dialog box. From the Destinations tab, open the menu for a destination that is configured for Airship, and then select Add data template. This opens the Add Data Template dialog box.
	Verify business user access to queries and orchestrations and access to segments and campaigns. A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data. If business user access was not configured as part of the destination, you may configure access from the data template. Important To allow business users to use this destination with campaigns, you must enable the Make available to campaigns option. This allows users to send campaign results from Amperity to Airship. If you enable this option, the data extension settings require using campaign name and group name template variables to associate the name of the data extension to your campaign.
	Verify all configuration settings. Note When the settings required by the SFTP site were are not configured as part of the destination, you must configure them as part of the data template before making this destination available to campaigns.
	Review all settings, and then click Save. After you have saved the data template, and depending on how you configured it, business users can send query results to Airship and/or send campaign results to Airship.

Add orchestration

An orchestration defines the relationship between query results and a destination, including the location to which those query results will be sent and the frequency at which the orchestration will be run.

Important

Airship audience lists are groups of devices, users, and addresses that can be targeted by channels and queries and attributes are key-value pairs that are associated with audiences for better message targeting. Refer to the SFTP tutorial for details about template patterns and file names.

To add an orchestration for Airship

1. From the Destinations tab, click Add Orchestration. This opens the Add Orchestration dialog box.

2. From the Object Type drop-down, select Query.

3. From the Object drop-down, select the query for which results will be sent to Airship.

4. From the Destination drop-down, select a destination that is configured for sending data to Airship.

5. From the Data Template drop-down, select a data template.

6. Verify all settings.

7. Set the workflow to Manual. (You can change this to automatic later, after verifying the end-to-end workflow.)

8. Click Save.

Run orchestration

Run the orchestration manually to validate that it works.

To run the orchestration

1. From the Destinations tab, under Orchestrations, open the    menu for the Airship orchestration, and then select Run.

2. The Status column for the orchestration will update to say “Waiting to start…”, after which the notifications pane will update to include a notification that shows the current status.

3. When the orchestration has run successfully, the status is updated to “Completed”.