Configure destination for Vibes

Note

This topic contains information about configuring a destination that sends query results to Vibes using orchestrations. To configure a destination that sends audiences to Vibes using campaigns see this topic .

Vibes offers a variety of mobile marketing products and services, such as text message marketing (SMS or MMS), mobile wallet marketing, push notifications, and mobile web experiences.

Configure Amperity to send CSV files to Vibes.

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.

Get details

Review the following details before configuring credentials for Vibes and before configuring Amperity to send CSV files to Vibes.

Detail 1.

Credential settings

Credentials for Vibes require a “username” and “passphrase”. Set the host name to “upload.vibes.com”.

Detail 2.

Required configuration settings

File format

Configure Amperity to send CSV files to Vibes.

Some file formats allow a custom delimiter. Choose the “Custom delimiter” file format, and then add a single character to represent the custom delimiter.

Remote folder

The remote folder to which Amperity sends data.

Use a forward slash–“/”–as the first character for this value. For example: “/folder”. For example: “/folder”.

If the path to the remote folder has a space, use a backslash (\) character to escape that space. For example, a folder named “From ACME” should be entered as “From\ ACME”.

Note

All other Amperity file format settings for Vibes are optional.

Detail 3.

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.

Detail 4.

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

Detail 5.

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 name of the campaign as configured in the Vibes platform.

Configure credentials

Configure credentials for Vibes before adding a destination.

An individual with access to Vibes should use SnapPass to securely share “username”, “passphrase”, and “hostname” details with the individual who configures Amperity.

To configure credentials for Vibes

Step 1.

From the Settings page, select the Credentials tab, and then click the Add credential button.

Step 2.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select Vibes.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.

Step 3.

The settings that are available for a credential vary by credential type. For the “vibes” credential type, configure settings, and then click Save.

Hostname

Required

Required. The host name for Vibes. For example: “upload.vibes.com”.

Passphrase

Required

The passphrase associated with the username.

Username

Required

Required. A username with access to Vibes. This username must have permission to write data to the remote folder to which Amperity sends data.

Add destination

Use a sandbox to configure a destination for Vibes. Before promoting your changes, send a test audience, and then verify the results in Vibes. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Vibes

Step 1.

Open the Destinations page, and then click the Add destination button.

Add

To configure a destination for Vibes, do one of the following:

  1. Click the row in which Vibes is located. Destinations list alphabetically and you can scroll up and down the list.

  2. Search for Vibes. Start typing “vib”. The list filters to show only matching destinations. Select “Vibes”.

Step 2.

Select the credential for Vibes from the Credential dropdown, and then click Continue.

Tip

Click the “Test connection” link on the “Configure destination” page to verify that Amperity can connect to Vibes.

Step 3.

In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination.

Configure business user access

By default a destination is available to all users who have permission to view personally identifiable information (PII).

Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.

Enable the PII setting checkbox to allow limited access to PII for this destination.

Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.

Step 4.

Configure the following settings, and then click “Save”.

Compression

The compression format to apply to the file. May be one of “GZIP”, “None”, “TAR”, “TGZ”, or “ZIP”.

Escape character

The escape character to use in the file output. Applies to CSV, TSV, PSV, and custom delimiter file types.

When an escape character is not specified and the quote mode is “None” files are sent with unescaped and unquoted data. When an escape character is not specified, you should select a non-“None” option as the quote mode.

File format

Required

Configure Amperity to send CSV files to Vibes.

Some file formats allow a custom delimiter. Choose the “Custom delimiter” file format, and then add a single character to represent the custom delimiter.

Filename template

A filename template defines the naming pattern for files that sent from Amperity. Specify the name of the file, and then use Jinja-style string formatting to append a date or timestamp to the filename.

A Vibes recipient list must have a name similar to “<filename>.recipient_list”.

Header

Enable to include header rows in output files.

Line ending

The line ending to use in file output. May be one of “LF” or “CRLF”.

PGP public key

The PGP public key that Amperity uses to encrypt files.

Quote mode

The quote mode to use within the file. May be one of “all fields”, “all non-NULL fields”, “fields with special characters only”, “all non-numeric fields” or “None”.

Unescaped, unquoted files may occur when quote mode is “None” and an escape character is not specified.

Remote folder

Required

The remote folder to which Amperity sends data.

Use a forward slash–“/”–as the first character for this value. For example: “/folder”. For example: “/folder”.

If the path to the remote folder has a space, use a backslash (\) character to escape that space. For example, a folder named “From ACME” should be entered as “From\ ACME”.

Success file

Enable to send a “.DONE” file when Amperity has finished sending data.

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

Use Zip64?

Enable to apply Zip64 data compression to large files.

Step 5.

After configuring this destination users may use:

  • Orchestrations to send query results

  • Orchestrations and campaigns to send audiences

  • Orchestrations and campaigns to send offline events

Workflow actions

A workflow will occasionally show an error that describes what prevented a workflow from completing successfully. These first appear as alerts in the notifications pane. The alert describes the error, and then links to the Workflows tab.

Open the Workflows page to review a list of workflow actions, choose an action to resolve the workflow error, and then follow the steps that are shown.

Step one.

You may receive a notifications error for a configured Vibes destination. This appears as an alert in the notifications pane on the Destinations tab.

Review a notifications error.

If you receive a notification error, review the details, and then click the View Workflow link to open this notification error in the Workflows page.

Step two.

On the Workflows page, review the individual steps to determine which step(s) have errors that require your attention, and then click Show Resolutions to review the list of workflow actions that were generated for this error.

The workflow tab, showing a workflow with errors.
Step three.

A list of individual workflow actions are shown. Review the list to identify which action you should take.

Choose a workflow action from the list of actions.

Some workflow actions are common across workflows and will often be available, such as retrying a specific task within a workflow or restarting a workflow. These types of actions can often resolve an error.

In certain cases, actions are specific and are shown when certain conditions exist in your tenant. These types of actions typically must be resolved and may require steps that must be done upstream or downstream from your Amperity workflow.

Amperity provides a series of workflow actions that can help resolve specific issues that may arise with Vibes, including:

Step four.

Select a workflow action from the list of actions, and then review the steps for resolving that error.

Choose a workflow action from the list of actions.

After you have completed the steps in the workflow action, click Continue to rerun the workflow.

Invalid credentials

The credentials that are defined in Amperity are invalid.

To resolve this error, verify that the credentials required by this workflow are valid.

  1. Open the Credentials page.

  2. Review the details for the credentials used with this workflow. Update the credentials for Vibes if required.

  3. Return to the workflow action, and then click Resolve to retry this workflow.

SFTP site unavailable

The SFTP site at “upload.vibes.com” is unavailable. This may be due to any of the following issues:

  • A configuration error within Amperity.

  • The SFTP server is unavailable or unresponsive.

  • The SFTP server does not have enough storage space.

  • Too many connection attempts were made to the SFTP server.

Note

Amperity will make multiple attempts to connect to an SFTP server before showing this workflow error.

To resolve this error, do any of the following.

  1. Verify the configuration for “upload.vibes.com”.

  2. Verify that the SFTP server is available and responsive.

  3. Verify the amount of storage space that is available on the SFTP server.

  4. Decrease the number of couriers in Amperity that are configured to connect to “upload.vibes.com”.

  5. Return to the workflow action, and then click Resolve to retry this workflow.