Silverpop Engage Connector Setup Guide

Silverpop Engage Connector Setup Guide

by Community Manager ‎05-10-2018 10:42 AM - edited ‎05-16-2018 02:11 PM (107 Views)

This article describes how to set up the Silverpop Engage Connector in your Universal Data Hub account.

Table of Contents Placeholder

Supported Actions

Action Name AudienceStream EventStream
Insert/Upsert Visitor in Database
Update Visitor in Database
Insert Visitor into Contact List
Insert/Upsert Visitor in Database and Add to Program
Insert Visitor into Program
Send Email using Custom Triggered Autoresponder
Upsert Visitor in Relational Table

Configure Settings

Go to the Connector Marketplace and add a new Connector. Read the Connector Overview article for general instructions on how to add a Connector.

After adding the connector, configure the following settings:

  • API Username
  • API Password
  • Server Host: e.g. "api5.silverrpop.com" where "api5" is your pod number (do not include "http(s)://" protocol) 

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them.

This section describes how to set up Parameters and Options for each Action.

Action - Insert/Upsert Visitor in Database

Parameters

Parameter Description
Database Name This is the target Database (not Contact List), it can be found by
  • Logging into your Silverpop account
  • Browsing to Data -> Databases
Data Column(s) to Set
  • Primary Key field(s) is required.
  • "VISITOR_KEY" (Optional): when provided, allows specifying a visitor key to associate a contact to a previously unknown visitor when using the Web Tracking feature.
  • "CONTACT_LIST_ID" (Optional): when provided, allows adding the new contact to the provided Contact List Id .
Recipient Primary Key Column(s) to Lookup
  • Required only if "Enable Recipient Database Column Update Criteria" is enabled.
  • Also, to prevent errors, you need to have "Enable Upsert" option enabled.
  • Either "RECIPIENT_ID" or Primary Key field(s) is required.
  • "Email": As an API requirement, if Email column is set make sure to set OLD_EMAIL column also.
Recipient Database Column(s) Criteria to Match
  • Required only if "Enable Recipient Database Column Update Criteria" is enabled.
  • All the specified criteria will be evaluated i.e. logical "AND" operation.
  • Note: Using this option enforces an extra API call for database recipient lookup, use only when necessary.

Action - Update Visitor in Database

Parameters

Parameter Description
Database Name This is the target Database (not Contact List), it can be found by
  • Logging into your Silverpop account
  • Browsing to Data -> Databases
Primary Key Column(s) to Lookup
  • Either "RECIPIENT_ID" or Primary Key field(s) is required.
  • "Email": As an API requirement, if Email column is set make sure to set OLD_EMAIL column also.
Data Column(s) to Update
  • Only fields that have the keyword "_tealium_as" in the custom field name are updatable.
  • Ensure you have appended your custom column names with the keyword "_tealium_as"
Recipient Database Column(s) Criteria to Match
  • Required only if "Enable Recipient Database Column Update Criteria" is enabled.
  • All the specified criteria will be evaluated i.e. logical "AND" operation.
  • Note: Using this option enforces an extra API call for database recipient lookup, use only when necessary.

Action - Insert Visitor into Contact List

Parameters

Parameter Description
Contact List Name This is the Contact List (not Database), it can be found by
  • Logging into your Silverpop account
  • Browsing to Data -> Contact Lists
Contact List's Corresponding Database This is the Corresponding Contact List"s Database, it can be found by
  • Logging into your Silverpop account
  • Browsing to Data -> Databases
Primary Key Column(s) to Lookup
  • Either Recipient ID or Primary Key field(s) is required.
  • Please ensure, the contact to be added already exists in the Target Contact List's Corresponding Database.

Action - Insert/Upsert Visitor in Database and Add to Program

Parameters

Parameter Description
Database Name This is the target Database (not Contact List), it can be found by
  • Logging into your Silverpop account
  • Browsing to Data -> Databases
Data Column(s) to Set
  • Primary Key field(s) is required.
  • "VISITOR_KEY" (Optional): when provided, allows specifying a visitor key to associate a contact to a previously unknown visitor when using the Web Tracking feature.
  • "CONTACT_LIST_ID" (Optional): when provided, allows adding the new contact to the provided Contact List Id .
Program Id Unique ID of the Program.
Recipient Primary Key Column(s) to Lookup
  • Required only if "Enable Recipient Database Column Update Criteria" is enabled.
  • Also, to prevent errors, you need to have "Enable Upsert" option enabled.
  • Either "RECIPIENT_ID" or Primary Key field(s) is required.
  • "Email": As an API requirement, if Email column is set make sure to set OLD_EMAIL column also.
Recipient Database Column(s) Criteria to Match
  • Required only if "Enable Recipient Database Column Update Criteria" is enabled.
  • All the specified criteria will be evaluated i.e. logical "AND" operation.
  • Note: Using this option enforces an extra API call for database recipient lookup, use only when necessary.

Action - Insert Visitor into Program

Parameters

Parameter Description
Contact Id Unique ID of the Contact being added to the Program.
Program Id Unique ID of the Program.

Action - Send Email using Custom Triggered Autoresponder

Parameters

Parameter Description
Autoresponder Mailing Send Id
  • Required: This is the Autoresponder Id (not name).
  • For this operation to work the autoresponder has to be custom triggered i.e. choose "Custom" option when creating the Automated Mailing Send and also use a Database as its "Contact Source"
  • You can find the Autoresponder Id by going to your Silverpop account Autoresponder list"s page
  • Opening the Autoresponder, and copying the value of the browser URL query string for "mailingId" e.g. https://engage5.silverpop.com/mailingsSummary.do?action=mailingSummary&mailingId=XXXXXXX
Autoresponder's Corresponding Database This is the Database that was used when creating the selected Autoresponder.
Corresponding Primary Key Column(s) to Lookup
  • "RECIPIENT_EMAIL": is required.
  • Also required (if the the database has a key other than "Email") is the Primary Key Column(s) of the Database used for this Automated Mailing.

Action - Upsert Visitor in Relational Table

Parameters

Parameter Description
Target Relational Table Required
Upsert Data to Set
  • Map column values to keys.
  • Primary Key field(s) is required. Natively, if Silverpop can match the Primary Key, it will update the existing record, otherwise a new record is inserted.
  • Note: this action supports multiple relational table insertions in One API Call. If you want to use this feature, configure the target column(s) to an AudienceStream List.
  • Note: If the relational table column that is being configured is of Silverpop Column Type of "DATE" or "TIMESTAMP" and a value of AudienceStream Type of Date is assigned to it, this connector will automatically convert the date variable to the appropriate GMT dates, shown below. If any other AudienceStream Types are configured, please make sure to pass formatted data accordingly to prevent the API call failure.
    • Silverpop Engage Relational Table API Expected Date Format: MM/dd/yyyy e.g. 06/18/2015
    • Silverpop Engage Relational Table API Expected Timestamp Format: MM/dd/yyyy hh:mm:ss e.g. 06/18/2015 10:57:06