Send data to Attentive Mobile¶

Attentive Mobile is a personalized mobile messaging platform that improves brand engagement with mobile consumers.

Amperity can manage an audience in Attentive Mobile. An audience has two components: subscribers and segments. To manage segments within an audience, you may send lists of email addresses or phone numbers from Amperity.

Amperity uses the subscriber segment upload process to manage segments. Updates appear on the Segments page within your audience in Attentive Mobile. Amperity is your source of truth for your customers who will belong to audience segments in Attentive Mobile.

Profile attributes in Attentive Mobile are updated to match the most recent value that was sent from Amperity. You may use empty values for profile attributes.

Caution

Attentive Mobile is your source of truth for opt-in/out and/or subscriber status.

Work directly with the Attentive Mobile white glove team (whiteglove@attentivemobile.com) and/or with your Amperity representative to provide opt-in/out and/or subscriber status data to Attentive Mobile.

Note

Changes to audiences are not immediately available in Attentive Mobile. Allow for up to 24 hours after the point at which Amperity has finished sending audience updates for them to be available.

This topic describes the steps that are required to send audiences to Attentive Mobile from Amperity:

Get details
Add destination
Add data template

How this destination works¶

Amperity can manage segments within an audience in Attentive Mobile. An audience has two components: subscribers and segments. A segment is the list of customers to which you will send emails or messages (and is the list of customers that you can manage from Amperity). A subscriber is a customer for which you have an opt-in/out status. You can only send emails or messages from Attentive Mobile to customers who have opted-in.

Send lists of customers from Amperity to Attentive Mobile.

An Attentive Mobile destination works like this:

Use a query or segment to build a list of customers that will be sent SMS messages or emails.
Configure Amperity to send audience segments to Attentive Mobile.
Send a test from Amperity, and then from within Attentive Mobile verify that the Segments page has the list of customers that you sent from Amperity.

Caution

Attentive Mobile is your source of truth for opt-in/out and/or subscriber status.

If you have opt-in/out and/or subscriber status for your list of customers within your Amperity data and if you want to use that data in Attentive Mobile, you must output those results separately as a CSV file, and then provide that list directly to Attentive Mobile.

This may be done using any combination of working directly with the Attentive Mobile white glove team (whiteglove@attentivemobile.com) and/or working with your Amperity representative.

After this process is completed, updates for opt-in/out and/or subscriber status will appear on the Subscribers page within your audience in Attentive Mobile.
Run campaigns directly from Attentive Mobile by sending personalized text messages to customers who have opted-in to receiving offers, promotions, and communication.

Important

If you are providing opt-in/out and/or subscriber status updates for the Subscribers in Attentive Mobile from Amperity data, be sure to wait for that data to be available in Attentive Mobile before running any campaigns.

Get details¶

The Attentive Mobile destination requires the following configuration details for sending audience segments:

The username and passphrase with permission to write data to Attentive Mobile using their SFTP process.
The remote folder to which Amperity will send data: /uploads.
The public key to use for PGP encryption, if required.
Review the subscriber segment upload topic for specific requirements for how to format the CSV file.
Do not include header rows in output.

Add destination¶

Configure Amperity to send data to Attentive Mobile using SFTP.

Important

Be sure to use “Segments” in the destination title so that users of Amperity who will send segments to Attentive Mobile will be able to identify this destination. Review the subscriber segment upload topic for specific requirements for how to format the CSV file. Do not include header rows in output.

To add a destination

From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.
Enter the name of the destination and a description. For example: “Attentive Mobile” and “This sends query results to “Attentive Mobile”.
From the Plugin drop-down, select attentive.

This automatically selects attentive-mobile as the Credential Type and assigns sftp.attentivemobile.com as the location to which data is sent.
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 “Attentive Mobile”), and then enter the username and password required to access this SFTP location.
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”.
From the File Format drop-down, select CSV.
Add a single character to be used as an escape character in the output file. (This should match the escape character required by Attentive Mobile.)

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.
Specify the encoding method. Encoding method options include “Tar”, “Tgz”, “Zip”, “GZip”, and “None”.
Add the PGP public key that is used to encrypt files sent to Attentive Mobile.
Optional. Specify the line ending type: LF or CRLF.
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.
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.
Optional. Select Include header row in output files if headers are included in the output.
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.
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.)
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.

You have two options for setting up data templates for Attentive Mobile:

For use with campaigns
For use with orchestrations

About name templates¶

A filename template defines the segment name as it will appear in the Segments tab in Attentive Mobile.

The following table shows how your segment name will appear in Attentive Mobile. These examples are for a one-time buyer campaign that is attempting to win a second purchase. The campaign is named “Winback” and it has sub-audiences for “Dress Shirts”, “Jeans”, and “Shoes”. Keep these patterns in mind when naming campaigns, recipient groups, and sub-audiences within your campaigns.

Pattern	Segment name(s)	Description
(empty)	WinbackDressShirts WinbackJeans WinbackShoes	An empty filename template setting is the equivalent of {{ campaign_name }}{{ group_name }}.
campaign_name	Winback	Use this pattern for campaigns that do not have more than one recipient group or have sub-audiences. This will use the name of the campaign as the name of the segment in Attentive Mobile. Tip Use {{ campaign_name }} instead of {{ list_name }}.
campaign_name + group_name	Winback_DressShirts Winback_Jeans Winback_Shoes	Use this pattern for campaigns that have more than one recipient group and/or have sub-audiences. You may use an underscore (`_`) or a hyphen (`-`): {{ campaign_name }}_{{ group_name }} or {{ campaign_name }}-{{ group_name }}. You may put them next to each other (without using an underscore or hyphen): {{ campaign_name }}{{ group_name }}. You may switch the ordering: {{ group_name }}_{{ campaign_name }}. Tip Be sure to use descriptive names for campaigns and recipient groups and be careful to not use the default recipient group names when sending campaigns to Attentive Mobile. This will ensure that downstream users in Attentive Mobile will be able to understand what each segment is for and won’t have to view default naming patterns like “Winback_Recipient1”, “WinbackRecipient2”, etc.
group_name	DressShirts Jeans Shoes	Use this pattern when to only use the names of recipient groups as segment names in Attentive Mobile. This will omit the name of the campaign and the name of the sub-audience from the segment name.

Important

The filename template, as used with Attentive Mobile (and unlike how it is used with other destinations), does not build a file name.

Instead the filename template defines which strings (campaign name and/or recipient group name) will be used as the name of a segment in Attentive Mobile. Spaces in campaign and recipient group names are removed.

The CSV file that is landed at Attentive Mobile will have a filename that is similar to:

{clientdomain}_subscriber_segment_{date}_{file_number}.csv

for campaigns¶

You can configure Amperity to send campaigns to Attentive. These results are sent from the Campaigns tab. Results default to a list of email addresses, but you may configure a campaign to send additional attributes to Attentive Mobile.

To add a data template for campaigns

From the Destinations tab, open the menu for a destination that is configured for Attentive Mobile, and then select Add data template.

This opens the Add Data Template dialog box.
Enter the name of the data template and a description. For example: “Attentive Mobile email list” and “Send email addresses to Attentive Mobile.”
Enable the Allow customers to use this data template option, and then enable the Make available to campaigns option. This allows users to send campaign results from Amperity to Attentive Mobile.
Verify all template settings and make any required updates.
Click Save.

for orchestrations¶

You can configure Amperity to send query results to Attentive. These results are sent using an orchestration and will include all columns that were specified in the query.

To add a data template for orchestrations

From the Destinations tab, open the menu for a destination that is configured for Attentive Mobile, and then select Add data template.

This opens the Add Data Template dialog box.
Enter the name of the data template and a description. For example: “Attentive Mobile customer profiles” and “Send email addresses and customer profiles to Attentive Mobile.”
Enable the Allow customers to use this data template option. This allows users to build queries, and then configure orchestrations that send results from Amperity to a configured destination.
Optional. Enable the Allow orchestrations from customers with limited PII access option. This allows users who have been assigned the Restrict PII Access policy option to send results from Amperity.
Verify all template settings and make any required updates.
Click Save.