Skip to main content

categoryname

TIBCO Connector Guide

The TIBCO Scribe Online\TIBCO Cloud Integration connector for Acoustic Campaign allows you to integrate Acoustic Campaign lead, contact, account, mailing statistics, task, and relational table data in Dynamics CRM, Salesforce, SugarCRM, or other systems. 

Connector Specifications

  Supported
Agent types
On Premise x
Cloud x
Integration services 
Source x
Target
Maps/flows
Integration x
Request-Reply  
Message  

This Connector is available in the following TIBCO marketplaces:

Supported entities

The Silverpop Connector supports the following entities. Below you'll find additional information on when you could be using that entity in TIBCO Scribe Online.

Batch processing

For better performance, use batch processing when possible. The maximum batch sizes are listed below.

Acoustic Campaign target Block type Maximum 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
Relational table Update/insert 500
Delete 500
Contact list Create 1
Contact list member Create 500
SMS Consent Update/insert One at a time
UB Event, UB error Create One at a time

Standard operations by Acoustic Campaign entity

Entity Query Create Update Delete Upsert Merge Convert
Lead x     x x x x
Contact x     x x x  
Other x     x   x  
Account     x        
GetMailingReportID x            
GetAggregateDataByMailing x            
Task x            
Relational table       x x    
UB event            
UB error x          
Consent x     x    
Contact list x x          
Contact list member     x      

Setup requirements

  • An OAuth Token must be generated from the Acoustic Campaign.
  • There must be a flexible/restricted DB or relational table in the Acoustic Campaign. Only single opt-in or regular database types are supported.
  • Desired AccountID fields must be mapped in the preceding Lead, Contact, and/or Other entity maps\flows.
  • Before syncing data back to a CRM, an Acoustic Campaign Recipient ID text field must exist or be created on the Lead/Contact record in CRM.
  • Before syncing aggregate reporting data to a CRM, a reporting object (mailing) must exist or 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

Refer to:

for information on available Agent types and how to select the best Agent for your Solution.

Connecting to Acoustic Campaign

Note: The 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 connection-assigned users. Depending on the entities supported, a connection assigned user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page, select Add to open the Add a New Connection dialog.
  3. Select the Silverpop 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. The best practice is to name it after the name of your Acoustic Campaign 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.
    • Acoustic Campaign Pod # - The Pod number.
    • Refresh Token - Token that allows the Connector to authenticate to the selected Pod. For more information review the following article - https://help.goacoustic.com/hc/en-us/articles/360043570673-Get-the-Scribe-refresh-token 
    • Database Type - Type of Acoustic Campaign database, either Flexible or Restricted. Must be Single Opt-In or Regular.
  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that will use this Connection. See Testing Connections.

If the POD number alone fails the test connection, use the corresponding API URL instead:

Campaign organization pod # Setting name Setting value
1 Pod https://api-campaign-us-1.goacoustic.com
2   https://api-campaign-us-2.goacoustic.com
3   https://api-campaign-us-3.goacoustic.com
4   https://api-campaign-us-4.goacoustic.com
5   https://api-campaign-us-5.goacoustic.com
6   https://api-campaign-eu-1.goacoustic.com
7   https://api-campaign-ap-2.goacoustic.com
8   https://api-campaign-ca-1.goacoustic.com
9   https://api-campaign-us-6.goacoustic.com
B   https://api-campaign-ap-3.goacoustic.com
  1. Select OK to save the Connection.

Important:

Database type determines the API command used while creating or updating records in Acoustic Campaign.

To determine the database type for your connection, consider the following:

  • CRM-type database uses a flexible database.
  • NON-CRM type database may use a restricted database that has one or more fields designated as the composite key.
  • If you want to work with relational tables, you must select the CRM database type.

Metadata notes

Consider the following for Acoustic Campaign 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 Acoustic Campaign, you must convert the source data to the data type of the target using formulas

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 Acoustic Campaign. The Connector uses the unique value to find the match in the Acoustic Campaign. If no match is found, it 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 Acoustic Campaign side. The CRM_SYNC_ID is the shared key between the systems and the RECIPIENT_ID key is the native key for Acoustic Campaign.

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 before using the Account entity as the Target.

Silverpop Connector as an 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 an IS target

Consider the following when using Acoustic Campaign as an IS target.

Lead, contact, and other entities

  • The Lead entity represents a Recipient in the Acoustic Campaign set to type "lead".
  • The Contact entity represents a Recipient in Acoustic Campaign set to type "contact".
  • The Other entity represents a Recipient in Acoustic Campaign set to type "other".
  • Each database in Acoustic Campaign 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 Acoustic Campaign API supports and uses Update/Insert instead, updating records where a key match is found and creating records when a key match is not found.
  • For the operations listed below, these entities do not support the Matching Criteria tab in Integration Maps\Flows. Required fields must be mapped in the Block Properties Fields Tab.

Query

Unsupported for Restricted Acoustic Campaign databases.

Acoustic Campaign must have the "CRM Enable Sync" field set to a 1. This is a system field exposed/managed via Acoustic Campaign when the organization is enabled for Salesforce.com, Dynamics CRM, or SugarCRM.

Note: When using the Connector to insert records into Acoustic Campaign, 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 Acoustic Campaign (shared key). This field is required.
    • RECIPIENT_ID - ID of the entity in Acoustic Campaign (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 Acoustic Campaign (shared key). This field is required.

Merge - requires the following fields:

  • MASTER_CRM_SYNC_ID - ID of the master record in Acoustic Campaign.
  • CRM_SYNC_ID - ID of the loser record in Acoustic Campaign.

Convert - this operation applies only to the lead entity. It merges the lead with a newly created contact. Requires the following fields:

  • MASTER_CRM_SYNC_ID – ID of the contact in Acoustic Campaign. Contact is created immediately after the Convert operation in the Source system. After the Convert operation, all history and data are merged with the specified Contact on the Acoustic Campaign side.
  • CRM_SYNC_ID – ID of the lead record, which was converted in Acoustic Campaign. The lead was deactivated immediately after the Convert operation in the Source system. After the Convert operation executes, the lead is soft-deleted from Acoustic Campaign.

Account Entity

  • This entity represents logic that updates all related objects by updating the parent record using the UpdateAccounts API.
  • The 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\Flow. It is not mapped as part of the Account Entity.
    • CRM_ACCOUNT_ID - Intended to store the account ID of the Recipient’s parent record in Acoustic Campaign.

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 Acoustic Campaign.
    • 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 Acoustic Campaign.
    • REPORT_ID - ID of the report for the selected mailing in Acoustic Campaign.

Task Entity

  • This entity represents Lead Alerts in Acoustic Campaign designed to create CRM Task records for related Leads and Contacts. Note that CRM Tasks are only supported when the Acoustic Campaign 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\flow 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 the Acoustic Campaign.
  • Relational Tables are displayed in the following format: "RT_TableName_TableId". (e.g. RT_ServiceCalls_123456) when the Acoustic Campaign is the target.
  • Query - Relational Tables are not available when Acoustic Campaign 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 the Acoustic Campaign.
  • Each database in Acoustic Campaign 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.
  • The actual entity name is different in 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 the Acoustic Campaign. Because a ContactId is required, only UB Events from your CRM are supported.

UB Error

  • This entity represents failed Universal Behavior Events in the Acoustic Campaign. These are UB events that failed to be created using the Acoustic Campaign API.
  • This entity represents errors for all available organizations and all event types in Silverpop.
  • Query
      • Filtering is not supported. The Silverpop Connector retrieves all available events using paging.
      • Field Descriptions:
        • GeneralErrors - contain a description of 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 the Acoustic Campaign.
  • 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 the Acoustic Campaign Contact List.
  • Query - Supports filtering by the Name field.
  • Create - Requires the following fields:
    • DatabaseID
    • Name

Contact List Member

  • This entity represents the Acoustic Campaign 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.

Related articles

community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more