TIBCO Scribe® Online Connector for Acoustic Connect
Use the TIBCO Scribe® Online Connector forAcoustic Connect to create source or target Connections to the Acoustic Connect API.
Connector Specifications
| Supported | |
|---|---|
|
Agent Types |
|
| On Premise | X |
| Cloud | X |
|
Replication Services |
|
| Source | |
| Target | |
|
Integration Services |
|
| Source | X |
| Target | X |
|
Maps |
|
| Integration | X |
| Request-Reply | X |
| Message | |
Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.
Selecting An Agent Type For Acoustic Connect
Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.
Connecting To Acoustic Connect
- 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 dropdown 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.
- 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.
- API endpoint — Acoustic Connect API endpoint URL.
- ApiKey — Acoustic Connect API key.
- Select Test to ensure that the Agent can connect to Acoustic Connect instance. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
- Select OK/Save to save the Connection.
Acoustic Connect Connector As IS Source
Consider the following when using the Acoustic Connect Connector as an IS source.
Supported Operations
Standard operations for Acoustic Connect entities include:
- Query
- Create
- Update
- Upsert
- Delete
- Update/Insert
Special Operations
Supported special operations for Contacts include:
Because Consent Group and Consent Channel objects are hierarchical to the Contact Object, you must use CreateWith and UpdateWith Block types when working with them.
- CreateWith — Container Block used with hierarchical data to add a parent record that may contain one or more child records. This Block collects all the data for a single record before writing the entire record to the target. See CreateWith Block.
- UpdateWith — Container Block used with hierarchical data. Use this Block to update a parent record that may contain one or more child records. This Block collects all the data for a single parent record before writing the record to the target. See UpdateWith Block.
Note: Operation results from an UpdateWith Block are not available for use in subsequent Blocks.
Metadata Notes
Relationships
This connector facilitates the management of consent data through two relationships on the Contact Object.
- ConsentByChannel
- ConsentByGroup
Note: The relationships are mutually exclusive, so including both relationships in a query results in an exception.
Filtered Operations
Filtering in Acoustic Connect Contact Queries.
The Acoustic Connect API supports the following filters:
- in (is one of the following): To create an in filter, combine multiple
equalsconditions for the same field using an OR logical connection. - eq (equals): This represents a simple
equalscondition. - blank (is or is not blank):
- To create an is blank filter, use an
equalscondition set to an empty string ornull. - To create an is not blank filter, use a
not equalcondition set to an empty string ornull.
- To create an is blank filter, use an
- contains (contains the specified text): Create this filter using the
Is Likeoperator without any wildcards.
TIBCO Scribe® Online API Considerations
To create connections with the TIBCO Scribe® Online API, the Acoustic Connect Connector requires the following information:
|
Connector Name |
AcousticConnect |
|
Connector ID |
F720D29F-71DC-408A-9BD3-67A17E7C35B9 |
TIBCO Scribe® Online Connection Properties
In addition, this Connector uses the Connection properties shown in the following table.
Note: Connection property names are case-sensitive.
| Name | Data Type | Required | Secured |
|---|---|---|---|
|
baseUrl |
String |
Yes |
No |
|
apiKey |
String |
Yes |
Yes |
License Agreement
The TIBCO Scribe® Online End-User License Agreement for the Acoustic Connect Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.
More Information
For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.