TIBCO Scribe® Online Connector For Silverpop
The TIBCO Scribe® Online Connector for Silverpop allows you to integrate Watson Campaign Automation lead, contact, account, mailing statistics, task and relational table data in Dynamics CRM, Salesforce, or other systems.
Connector Specifications
Supported | |
---|---|
Agent Types |
|
On Premise | X |
Cloud | X |
Replication Services |
|
Source | |
Target | |
Integration Services |
|
Source | X |
Target | X |
Migration Services |
|
Source | |
Target | |
Maps |
|
Integration | X |
Request-Reply | |
Message |
Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.
Supported Entities
The Silverpop Connector supports the following entities. Select a linked entity name for additional information when using that entity in TIBCO Scribe® Online.
Batch Processing
For better performance, use Batch Processing when possible. For the Silverpop Connector the maximum batch sizes are listed in the following table.
Watson Campaign Automation Target |
Block Type |
Max Batch Size |
---|---|---|
Recipients DB (Lead, Contact, Other) — Flexible DB
|
Update Insert |
1000 |
Delete |
One at a time |
|
Merge |
1 |
|
Update (related Account data) |
One at a time |
|
Recipients DB (Lead, Contact, Other) — Restricted DB
|
Update/Insert |
1 |
Delete |
1 |
|
|
Update/Insert |
500 |
Delete |
500 |
|
Create |
1 |
|
Create |
500 |
|
Update/Insert |
One at a time |
|
Create |
One at a time |
Standard Operations
Entity | Query | Create | Update | Delete | Upsert | Merge | Convert |
---|---|---|---|---|---|---|---|
X |
|
|
X |
X |
X |
X |
|
X |
|
|
X |
X |
X |
|
|
X |
|
|
X |
|
X |
|
|
|
|
X |
|
|
|
|
|
X |
|
|
|
|
|
|
|
X |
|
|
|
|
|
|
|
X |
|
|
|
|
|
|
|
|
|
|
X |
X |
|
|
|
|
X |
|
|
|
|
|
|
X |
|
|
|
|
|
|
|
X |
|
|
|
X |
|
|
|
X |
X |
|
|
|
|
|
|
|
X |
|
X |
|
|
|
Note: For more information about the Watson Campaign Automation services, operations, and messages, visit the Watson Campaign Automation Portal.
Setup Considerations
Silverpop Connector has several requirements.
- An OAuth Token must be generated from Watson Campaign Automation, visit the Watson Campaign Automation Portal.
- There must be a Flexible / Restricted DB or relational table in Watson Campaign Automation. Only Single Opt-In or Regular database types supported.
- Prior to running an Account update Map, the desired account fields must be mapped in the Lead, Contact and/or Other entity.
- Prior to syncing data back to a CRM, a Watson Campaign Automation Recipient ID text field, must be created on the Lead/Contact record in CRM.
- Prior to syncing aggregate reporting data to a CRM, a reporting object must be created in the CRM. The object must include a Reporting ID and the desired reporting fields. Available reporting fields can be found in the Field List tab for the MailingReport Entity.
Selecting An Agent Type For Silverpop Connector
Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.
Connecting To Watson Campaign Automation
Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.
- Select More > Connections from the menu.
- From the Connections page select Add to open the Add a New Connection dialog.
- Select the Connector from
the drop-down list in the Connection Type field, and then enter the following information for this Connection:
- Name — This can be any meaningful name, up to 25 characters. Best practice is to name it after the name of your Watson Campaign Automation ORG.
- Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
- Watson Campaign Automation Pod # — The pod number.
- Refresh Token — Token that allows the Connector to authenticate to the selected pod. For more information, visit the Watson Campaign Automation Portal.
- Database Type — Type of Watson Campaign Automation database, either Flexible or Restricted. Must be Single Opt-In or Regular. .
Important:
Database Type determines the API command used while creating or updating records in Watson Campaign Automation.
To determine the Database Type for your Connection, consider following:
- CRM type database uses a flexible database.
- NON-CRM type database may use a restricted databse which has one or more fields designated as the composite key.
- If you want to work with Relational Tables, you must select CRM database type.
- Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
- Select OK/Save to save the Connection.
Metadata Notes
Consider the following for Watson Campaign Automation data fields and entity types.
Matching Data Types
If the data type of a source field does not match the data type of the mapped target field in Watson Campaign Automation, you must convert the source data to the data type of the target.
Unique Values Required
Lead, Contact, And Other entities
Unique values, such as CRM_SYNC_ID and RECIPIENT_ID, are required when using CRUD, or Create, Read, Update, and Delete operations, in the Watson Campaign Automation system. The Connector uses the unique value to find the match in Watson Campaign Automation. If no match found, the Connector creates a new record with CRM_SYNC_ID as the mapped value. RECIPIENT_ID is ignored. In this case, it is automatically generated on the Watson Campaign Automation side. The CRM_SYNC_ID is the shared key between the systems and the RECIPIENT_ID key is the native key for Watson Campaign Automation.
Account Entity
CRM_ACCOUNT_ID is used to find all related records for a specified account/parent record. Note that all related records should already have their CRM_ACCOUNT_ID field populated on the lead, or contact entity prior to using the Account entity as the Target.
Silverpop Connector As IS Source
Consider the following when using the Silverpop Connector as an IS source.
Filters
- Custom fields are not available for filtering.
Boolean
- Acceptable Boolean values are True or False. Do not enclose values in quotes.
Previewing Records
- The Silverpop Connector returns a maximum of 25 records as an example of what records are returned. Any filters that you have defined are applied to the 25 sample records and only matching records are returned.
Relationships
- The Silverpop Connector does not support relationships.
Silverpop Connector As IS Target
Consider the following when using Watson Campaign Automation as an IS Target.
Lead, Contact, And Other Entities
- The Lead entity represents a Recipient in Watson Campaign Automation set to type “lead”.
- The Contact entity represents a Recipient in Watson Campaign Automation set to type “contact”.
- The Other entity represents a Recipient in Watson Campaign Automation set to type “other”.
- Each database in Watson Campaign Automation contains separate Lead, Contact, and Other entities. Therefore, there could be many of each of these entities available in the Silverpop Connector. The number of Lead, Contact, and Other entities depends on how many databases an organization has.
- There are no separate Create or Update commands for these entities. The Watson Campaign Automation API supports Update/Insert.
- For the operations listed below, these entities do not support the Matching Criteria tab in Integration Maps. Required fields must be mapped in the Block Properties Fields Tab.
- Query
- Unsupported while using Restricted contact databases.
- Watson Campaign Automation must have the “CRM Enable Sync” field set to a 1. This is a system field exposed/managed via the Watson Campaign Automation when the organization is enabled for Salesforce.com, Dynamics CRM or SugarCRM.
Note: When using the Connector to insert records into Watson Campaign Automation, it automatically sets this field to a 1.
- When filtering by date/time there is an option to get only records created/updated since the last Map run. In this case, use the LAST_MODIFIED_TIME_START field on the Block Properties Net Change Tab of the Query Block.
- Supports filtering records by the CRM_SYNC_ID shared key, LAST_MODIFIED_TIME_START, or Recipient ID fields in the Lookup Block.
- Update/Insert or Upsert
- CRM_SYNC_ID — ID of the entity in Watson Campaign Automation (shared key). This field is required.
- RECIPIENT_ID — ID of the entity in Watson Campaign Automation (native key). This field is optional.
- CRM_ACCOUNT_ID – ID intended to store the Contact’s parent account ID where contacts are assigned to accounts.
- OPT_OUT – Defines the recipient’s subscription status. Use “True” to opt out or exclude the entity from mailings and “False” to opt in or include the entity from mailings. It is important to note that once OPT_OUT is set to True, it cannot be changed.
- OPT_OUT_DATE – Read Only
- OPT_OUT_DETAILS – Read Only
- OPT_IN_DATE – Read Only
- OPT_IN_DETAILS – Read Only
- Delete
- CRM_SYNC_ID – ID of the entity in Watson Campaign Automation (shared key). This field is required.
- Merge — Requires the following fields:
- MASTER_CRM_SYNC_ID – ID of the master record in Watson Campaign Automation.
- CRM_SYNC_ID – ID of the loser record in Watson Campaign Automation.
- Convert — This operation applies only to the Lead entity. Merges a Lead with a newly created contact. Requires the following fields:
- MASTER_CRM_SYNC_ID – ID of the contact in Watson Campaign Automation. Contact is created immediately after the Convert operation in the Source system. After the Convert operation all history and data is merged with the specified Contact on the Watson Campaign Automation side.
- CRM_SYNC_ID – ID of the lead record, which was converted in Watson Campaign Automation. The Lead that was deactivated immediately after the Convert operation in the Source system. After the Convert operation executes, the Lead is soft deleted from Watson Campaign Automation.
- Query
Account Entity
- This entity represents logic that updates all related objects by updating the parent record using the UpdateAccounts API.
- Field list for the Account entity represents “Lead”, “Contact”, or “Other” entity fields. The main purpose of this entity is to update selected fields for all related leads, contacts or others linked to the account specified in the CRM_ACCOUNT_ID field.
- Update — Requirements include:
- CRM_ACCOUNT_ID must already be mapped and populated via another Lead, Contact, or other Map. It is not mapped as part of the Account Entity.
- CRM_ACCOUNT_ID — Intended to store the account ID of the Contact’s parent record in Watson Campaign Automation.
GetMailingReportId Entity
- This entity represents information for ReportId and Sends for specified mailings using the GetReportIdByDate API.
- Query — Requires the following fields:
- MAILING_ID – ID of the sent mailing in Watson Campaign Automation.
- DATE_START – Start date for the mailing report.
- DATE_END – End date for the mailing report.
GetAggregateDataByMailing Entity
- This entity represents metrics for the specified mailing using the GetAggregateTrackingForMailing API.
- Query — Requires the following fields:
- MAILING_ID – ID of the sent mailing in Watson Campaign Automation.
- REPORT_ID – ID of the report for the selected mailing in Watson Campaign Automation.
Task Entity
- This entity represents lead alerts in Watson Campaign Automation designed to create CRM Task records for related Leads and Contacts. Note that Tasks are only supported when Watson Campaign Automation is configured for CRM integration.
- Query — When filtering by date/time there is an option to get only records created/updated since the last map run. In this case, use the LAST_MODIFIED_TIME_START field on the Block Properties Net Change Tab of the Query Block.
Relational Table
- An entity of this type represents a relational table in Watson Campaign Automation.
- Relational tables are displayed in the following format: “RT_EntityName_EntityId”. (e.g. RT_ServiceCalls_123456) when Watson Campaign Automation is the target.
- Query – Relational Tables are not available when Watson Campaign Automation is the source, therefore data from those tables cannot be queried.
- Update/Insert or Upsert
- Fields marked as required are based on the key columns in the table.
- Does not support the Block Properties Matching Criteria Tab in the Update/Insert Block or Upsert Block. Key columns must be mapped on the Block Properties Fields Tab.
- Delete
- Requires that the unique id column(s) be mapped.
- Fields marked as required are based on the key columns in the table.
- Fields are required in the Block Properties Matching Criteria Tab in the Delete Block in Integration Maps.
UB Event
- This entity represents the Universal Behavior Event in Watson Campaign Automation.
- Each database in Watson Campaign Automation contains its own Event entity. Therefore, there could be many Event entities available in the Silverpop Connector. The number of Event entities depends on how many databases an organization has.
- Actual entity name is different on real environments and is displayed in the following format:
“[Database Name]_UB_[Event Name]_[Event Id]"
- Only the Create operation is supported and requires the ContactId field. This is the ID of the recipient in Watson Campaign Automation. Because a ContactId is required, only UB Events from your CRM are supported.
UB Error
- This entity represents failed Universal Behavior Events in Watson Campaign Automation. These are UB events that failed to be created using the Watson Campaign Automation API.
- This entity represents errors for all available organizations and all event types in Silverpop.
- Query
- Filtering is not supported. TheSilverpop Connector retrieves all available events using paging.
- Field Descriptions:
- GeneralErrors — Contains a description about the error in general.
- AttributeErrors — Contains descriptions for all attributes that failed, if any.
- RawEventJson — Contains raw, as submitted while creating, event information and structure.
Consent
- This entity represents SMS Consent data in Watson Campaign Automation.
- Query — Filtering is required. The following filters are supported:
- Program_ID — ID of a program in which the recipient participates.
- SMS_Phone_Number — Phone number associated with a subscription.
- Update/Insert (Upsert) — Requires the following fields:
- Program_ID — ID of a program in which the recipient participates.
- SMS_Phone_Number — Phone number associated with a subscription.
Contact List
- This entity represents Watson Campaign Automation Contact List.
- Query — Supports filtering by the Name field.
- Create — Requires the following fields:
- DatabaseID
- Name
Contact List Member
- This entity represents Watson Campaign Automation Contact List Member.
- Create — Requires the following fields:
- ListId — ID of a parent Contact List.
- RECIPIENT_ID — ID of a recipient that will be a member of a Contact List.
- Delete — Requires the following fields:
- ListId — ID of a parent Contact List.
TIBCO Scribe® Online API Considerations
Note: Connectors using OAuth for authentication are not fully supported by the TIBCO Scribe® Online API at this time.
More Information
For the latest information about the Silverpop Connector, visit the Watson Campaign Automation Portal.