Refer to the following topic to understand in detail in the 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. Unique values such as CRM_SYNC_ID and RECIPIENT_ID are required when you are using CRUD (Create, Read, Update, and Delete) operations in the Acoustic Campaign system. The connector uses the unique values to find the match in Acoustic Campaign. If a match is not found, the connector creates a new record with the CRM_SYNC_ID mapped value. RECIPIENT_ID is ignored in this case - it is automatically generated on 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. CRM_ACCOUNT_ID is used to find all related records for specified account/parent record. All the related records must be linked with account/parent record when you are using the same CRM_ACCOUNT_ID on lead or contact entity.
Acoustic Campaign Connector as an IS Source
Consider the following when you are using Acoustic Campaign Connector as an Integration Services (IS) source.
- Filters: Custom fields are not available for filtering.
- Boolean: Acceptable Boolean values are "True" or "False". Scribe recommends not enclosing Boolean value in quotes.
- The Acoustic Campaign Connector returns a maximum of 25 records as an example of what records are returned. Any filters that you define are applied to the 25 sample records and only matching records are returned.
- Acoustic Campaign Connector does not support relationships.
Acoustic Campaign Connector as an IS Target
Consider the following when you are using Acoustic Campaign Connector as an Integration Services (IS) target.
Special information about the Lead entity is explained in the following section.
- The Lead entity represents a recipient in Acoustic Campaign with type lead.
- Each database in Acoustic Campaign contains a separate lead entity. Hence there could be many lead entities available in Acoustic Campaign Connector. It depends on how many databases an organization has. You can sync data to the CRM database.
- There are no separate Create or Update commands for the lead entity. Acoustic Campaign API supports combined operation - Update (Basic maps) or Update/Insert (Advanced maps).
- The entity does not support the Matching Criteria tab for all operations that are specified (Advanced maps). Fields that are required have to be mapped in the Fields area.
Query: There is an option to get leads created or updated since the last map is executed. In this case, use LAST_MODIFIED_TIME_START field in the General tab and use CRM_SYNC_ID as the shared key (Lookup block) under optional fields. Update/Insert (Upsert)
- Requires the following fields: CRM_SYNC_ID - ID of the lead in Acoustic Campaign (shared key).
- Optional fields: RECIPIENT_ID - ID of the lead in Acoustic Campaign (native key).
- Other fields: CRM_ACCOUNT_ID - ID of the parent record that is linked with the lead, and PT_OUT - defines if the lead is opted in/opted out. Use "True" to opt in the lead and "False" to opt out.
Delete: CRM_SYNC_ID - ID of the lead in Acoustic Campaign (shared key). Merge: MASTER_CRM_SYNC_ID - ID of the master record in Acoustic Campaign and CRM_SYNC_ID - ID of the loser record in Acoustic Campaign. Convert (Merge lead with newly created contact)
- MASTER_CRM_SYNC_ID - ID of the contact in Acoustic Campaign (contact was created right after Convert operation in Source system - after Convert operation all history and data is merged with specified contact on Acoustic Campaign side).
- CRM_SYNC_ID - ID of the loser record in Acoustic Campaign(lead that was deactivated right after Convert operation in Source system - after Convert operation executed lead is soft deleted on Acoustic Campaign side).
Special information about the Contact entity is explained in the following section.
This entity represents Recipient in the Acoustic Campaign with type contact.
- Each database in Acoustic Campaign contains a separate contact entity that is why there could be many lead entities available in the Acoustic Campaign Connector. It depends on how many databases an organization has. You can sync data to the CRM database.
- There are no separate Create or Update commands for Contact entity. Acoustic Campaign API supports combined operation - Upsert (Basic maps) or Update/Insert (Advanced maps).
- The contact entity does not support Matching Criteria tab for all operations that are specified (Advanced maps). Fields that are required have to be mapped in Fields area.
Query: Filtering by date/time: There is an option to get leads created or updated since last map is executed. In this case, use LAST_MODIFIED_TIME_START field in the General tab and use CRM_SYNC_ID as the shared key (Lookup block) under optional fields. Update/Insert (Upsert)
- Requires the following fields: CRM_SYNC_ID - ID of the contact in Acoustic Campaign (shared key).
- Optional fields: RECIPIENT_ID - ID of the contact in Acoustic Campaign (native key).
- Other fields:
- CRM_ACCOUNT_ID - ID of the parent record that is linked with the contact.
- OPT_OUT - defines if the contact opted in/opted out. Use "True" to opt in the contact and "False" to opt out. You cannot opt IN a Acoustic Campaign Contact from CRM if the contact was previously opted out.
Delete CRM_SYNC_ID - ID of the contact in Acoustic Campaign (shared key).
Merge MASTER_CRM_SYNC_ID - ID of the master record in Acoustic Campaign and CRM_SYNC_ID - ID of the loser record in Acoustic Campaign. Special information about the Other entity is explained in the following section.
The entity represents Recipient in Acoustic Campaign with type other.
- Each database in Acoustic Campaign contains a separate other entity, that is why there could be many lead entities available in Acoustic Campaign Connector. It depends on how many databases an organization has. You can sync data to the CRM DB (Must be created at implementation). Non-CRM DBs will be opened up for sync, in a future release.
- There are no separate Create or Update commands for "other" entity. Acoustic Campaign API supports combined operation - Upsert (Basic maps) or Update/Insert (Advanced maps).
- This entity does not support Matching Criteria tab for all operations that are specified (Advanced maps). Fields that are required have to be mapped in the Fields area.
Query There is an option to get only others created/updated since last map run. In this case, use LAST_MODIFIED_TIME_START field on General tab and the Optional fields are CRM_SYNC_ID shared key (Lookup block). Update/Insert (Upsert) : CRM_SYNC_ID - ID of the other in Acoustic Campaign (shared key).
- Optional fields: RECIPIENT_ID - ID of the other in Acoustic Campaign (native key).
- Other fields:
- CRM_ACCOUNT_ID - ID of the parent record that is linked with the other.
- OPT_OUT - defines if the other entity opted in/opted out. Use "True" to opt in the other and "False" to opt-out.
Delete CRM_SYNC_ID - ID of the other in Acoustic Campaign (shared key).
Merge MASTER_CRM_SYNC_ID - ID of the master record in Acoustic Campaign and CRM_SYNC_ID - ID of the loser record in Acoustic Campaign. Special information about the Account entity is explained in the following section.
The entity represents logic that updates all related objects by updating the parent record (Update Accounts API). Field list for Account entity represents Lead, Contact, or Other entity fields, as the main idea of this entity is to update selected fields for all related leads, contacts or others linked with specified account in CRM_ACCOUNT_ID field.
Update: CRM_ACCOUNT_ID field has to be mapped with the ID of the parent record in Acoustic Campaign on Lead, Contact, or Other entities. Requires the following fields: CRM_ACCOUNT_ID - ID of the parent record in Acoustic Campaign. Special information about the GetemailReportId entity is explained in the following section.
This entity represents information as ReportId and Sends for specified email (GetReportIdByDate API).
Query
Requires the following fields:
- email_ID - ID of the sent email in Acoustic Campaign.
- DATE_START - Start date to get email report.
- DATE_END - End date to get email report.
Special information about the GetAggregateDataByemail entity is explained in the following section.
This entity represents metrics for specified email (GetAggregateTrackingForemail API).
Query : email_ID - ID of the sent email in Acoustic Campaign and REPORT_ID - ID of the report for selected email in Acoustic Campaign. Task: This entity represents alerts in Acoustic Campaign with type "task". Query: LAST_MODIFIED_TIME_START - date/time filter to get task from specified date until now. Initialize this field on the General tab if needed. Relational Tables : Relational tables are displayed as EntityName_EntityId. Update/Insert (Upsert) Fields that are marked as required depend on the key columns table and the operation does not support Matching Criteria tab. Key columns have to be mapped in Fields area. Delete Fields that are marked as required depend on how many key columns are in a table. Fields have to be specified in Matching Criteria tab. Query Data in the Relation Table cannot be queried via Scribe. UB Event
- Each database in Acoustic Campaign contains its own events that are why there could be many events available in Acoustic Campaign Connector. It depends on how many databases an organization has and how many events each organization contains.
- The actual name of the event is retrieved in the list in the following format: "[Database Name]_UB_[Event Name]_[Event Id]".
- Create operation is supported UB event entity.
Create: ContactId (Id of the recipient in Acoustic Campaign) UB Error: This entity represents failed Universal Behavior Event in Acoustic Campaign. (UB Events that failed while you are creating them using Acoustic Campaign API.) Entity represents errors for all available organizations and all event types in Acoustic Campaign. The only Query operation is the supported UB Error entity. Query Filtering is not supported for UB Error. Acoustic Campaign Connector retrieves all available events by using paging.
- Field Descriptions:
- GeneralErrors: contains a description of the error in general.
- AttributeErrors: contains descriptions for all attributes that failed.
- RawEventJson: contains raw event information and structure.