Send data to Vibes

Vibes is a mobile marketing company that provides a variety of mobile marketing products and services, such as text message marketing (SMS/MMS), mobile wallet marketing, push notifications, and mobile web experiences.

You can use a flat-file (CSV) batch process to send query results from Amperity to Vibes to update recipient list data. This process supports downstream workflows, such as for:

  • Users who interact with campaigns from mobile devices

  • Interactive campaigns, including incentives, contents, and info-on-demand

  • Loyalty programs and offers

Files that are sent to Vibes are routed based on a required filename pattern. After the files are processed, an SMS message or push notification is sent to the recipient list from the Vibes platform.

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

  1. Get details

  2. Add destination

  3. Add data template

Get details

Vibes requires the following configuration details:

  1. The username.

  2. The passphrase.

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

  4. The public key to use for PGP encryption, if required.

  5. A Vibes recipient list must be assigned a name similar to <filename>.recipient_list. Define the filename template pattern to match the campaign name that is required by Vibes.

Important

Refer to the Vibes documentation if you plan to import a recipient list with included headers.

Add destination

Configure Amperity to send data to Vibes using SFTP.

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: “Vibes” and “This sends query results to “Vibes”.

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

    This automatically selects vibes as the Credential Type and assigns upload.vibes.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 “Vibes”), and then enter the username and password required to access this SFTP location.

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

  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 Vibes.)

    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. Add the PGP public key that is used to encrypt files sent to Vibes.

  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 customers to use this destination.

  15. Select Allow orchestrations from users with limited PII access. (A user with limited PII access 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.

Important

A filename template pattern is required for proper formatting for files sent to Vibes. By default this pattern includes the name of the query and the current date. Special characters and blank spaces in the query name are replaced by underscores in the file name.

A Vibes recipient list is assigned a name similar to <filename>.recipient_list. The file naming pattern must create a file that matches the campaign name in the Vibes platform.

You have two options for setting up data templates for Vibes:

  1. For use with campaigns

  2. For use with orchestrations

for campaigns

You can configure Amperity to send campaign results to Vibes. 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 Vibes.

To add a data template for campaigns

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

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Vibes email list” and “Send email addresses to Vibes.”

  3. 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 Vibes.

  4. Verify all template settings and make any required updates.

  5. Click Save.

for orchestrations

You can configure Amperity to send query results to Vibes. 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

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

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Vibes customer profiles” and “Send email addresses and customer profiles to Vibes.”

  3. 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.

  4. 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.

  5. Verify all template settings and make any required updates.

  6. Click Save.