Configure destination for Cordial

Note

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

Cordial is a cross-channel marketing and data platform that collects all of your customer data in one platform for use with audience segments, trends, and automated customer experiences.

Use Amperity to manage contacts–attributes and list membership–in Cordial using the following REST APIs:

  • Account Contact Attributes to create contact attributes. Attributes that do not exist in Cordial are added as custom contact attributes.

  • Account Lists to fetch, create, and clear account lists, to which contacts are associated. An account list is overwritten each time results are sent from Amperity. An email address is added when it is not already a contact, after which it is assigned the subscribed status. An email address that is already a contact will retain its assigned subscription status.

  • Contact Imports to import contacts to Cordial, and then associate contacts to the account list.

  • Jobs to monitor the import job for completion.

Build a query or segment that contains the email field, along with any other fields that you want created or updated in Cordial and represented as contact attributes.

Note

Amperity recommends using the Cordial API to send email lists from Amperity to Cordial.

However, if you prefer to send a CSV or JSON file (one-time or recurring) instead of using the Cordial API you may configure Cordial Data Automations , and then enable that workflow using any of these destinations: SFTP, Amazon S3, or Google Cloud Storage.

Get details

Review the following details before configuring credentials for Cordial and before configuring Amperity to send email lists to Cordial.

Detail 1.

Credential settings

API key

Required. The API key for your Cordial account.

API URL

Required. The API URL for your Cordial account. May be one of the following: https://api.cordial.io/ or https://api.usw2.cordial.io/.

Tip

Use the IP address for allowlists for Amperity to configure the allowlist for the Cordial API.
Detail 2.

Required configuration settings

Audience primary key

The primary key for the audience. Set to “audience”.

List name (Required at orchestration)

The name of the list in Cordial that is managed by Amperity. This list will be created by Amperity if it does not exist.

Subscription status

Enable “Do not set subscription status automatically” to prevent updates without “channels.email.subscribeStatus” from being automatically subscribed in Cordial.
Detail 3.

Cordial Rest API configuration

The following Cordial REST API methods must be enabled:

GET /accountcontractattributes
POST /accountcontractattributes

GET /accountlists
POST /accountlists
PUT /accountlists/{key}/clear

POST /contactimports

GET /jobs/{id}

Configure credentials

Configure credentials for Cordial before adding a destination.

An individual with access to Cordial should use SnapPass to securely share “API key” and “API URL” details with the individual who will configure Amperity.

To configure credentials for Cordial

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

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 are determined by the credential type. For the “cordial” credential type, configure settings, and then click Save.

API key

Required. The API key for your Cordial account.

API URL

Required. The API URL for your Cordial account. May be one of the following: https://api.cordial.io/ or https://api.usw2.cordial.io/.

Add destination

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

To add a destination for Cordial

Step 1.

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

Add

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

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

  2. Search for Cordial. Start typing “cord”. The list will filter to show only matching destinations. Select “Cordial”.
Step 2.

Select the credential for Cordial 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 Cordial.
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 users with limited access to PII access to this destination.

Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.
Step 4.

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

Audience primary key

The primary key for the audience. Set to “audience”.

List name (Required at orchestration)

The name of the list in Cordial that is managed by Amperity. This list will be created by Amperity if it does not exist.

Subscription status

Enable “Do not set subscription status automatically” to prevent updates without “channels.email.subscribeStatus” from being automatically subscribed in Cordial.
Step 5.

After this destination is configured:

  • Use orchestrations to send query results

  • Use orchestrations and campaigns to send audiences

  • Use 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 Cordial 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 Cordial, 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 Cordial if required.

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

Required attributes are missing

Cordial will reject audiences when required attributes are missing.

For campaigns

To resolve this error, verify the attributes that are required by Cordial, and then verify that the list of attributes is correct for each treatment group in this campaign that is sending data to Cordial.

  1. Open the Cordial management console, and then open Jobs .

  2. Find the job with the ID that matches the ID in the error message associated with this workflow action, and then view job details.

  3. Download the rejected errors using the link in the job details. If the errors mention “missing required attribute(s)” do one of the following:

    Update the attribute(s) in Cordial to no longer be required.

    or

    Add the missing attributes for each treatment group that is associated with this campaign.

  4. Open the Campaigns page, and then for each treatment group that is configured to send audiences to Cordial, edit the list of attributes to include all required attributes.

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

For orchestrations

To resolve this error, verify the attributes that are required by Cordial, and then verify that the query used with this orchestration is returning all required attributes.

  1. Open the Cordial management console, and then open Jobs .

  2. Find the job with the ID that matches the ID in the error message associated with this workflow action, and then view job details.

  3. Download the rejected errors using the link in the job details. If the errors mention “missing required attribute(s)” do one of the following:

    Update the attribute(s) in Cordial to no longer be required.

    or

    Add the missing attributes to the results that are returned by the query that is associated with this orchestration.

  4. Open the Queries page, and then open the query used with this workflow. Update the query to return the list of attributes that are required by Cordial.

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

Unique list name required

Cordial list names must be unique.

To resolve this error, verify that the name of the list is unique.

  1. Open the Destinations page, and then review the data template for the destination associated with this workflow error.

  2. Verify that the value of the List Name setting is a unique value within Cordial.

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