TIBCO Scribe® Online Connector For Mailchimp

The TIBCO Scribe® Online Connector for Mailchimp is based on the CData driver forMailchimp. This Connector provides read and write access to Mailchimp objects like Campaigns, Lists, ListMembers, and EcommerceOrders. Integrating Mailchimp with CRM systems like Dynamics 365 and Salesforce can make your email marketing efforts more efficient and easier to manage by automating manual steps in your business process. You can also integrate Mailchimp with eCommerce platforms like Shopify and Magento. This Connector is based on Scribe.Connector.AdoNet library and CData MailChimp ADO.NET provider.

Possible use cases for the Mailchimp Connector include:

Get information about Campaigns.
Manage Campaigns.
Manage the list of subscribers.
Consume statistics about Campaigns, such as total clicks or unique clicks.
Start Campaigns

Connector Specifications

	Supported
Agent Types
Connect on-premise	X
Connect cloud	X
Data Replication Apps
Source
Target
On Schedule Apps
Source	X
Target	X
On Event Apps
Source	X
Target	X
Flows
Integration	X
Request-Reply	X
Message

Note: This Connector is available from the TIBCO Cloud™ Integration Marketplace. See Marketplace Connectors for more information.

Supported Entities

The Mailchimp Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Cloud™ Integration - Connect.

Standard Operations

Entity	Query	Create	Update	Delete
AuthorizedApps	X	X	X	X
AutomationEmailQueues	X	X	X	X
AutomationEmails	X
Automations	X
AutomationsRemovedSubscribers	X	X	X	X
CampaignFeedback	X	X	X	X
Campaigns	X	X	X	X
ConversationMessages	X	X	X	X
Conversations	X
EcommerceCartLines	X	X	X	X
EcommercCarts	X	X	X	X
EcommerceCustomers	X	X	X	X
EcommerceOrderLines	X	X	X	X
EcommerceOrders	X	X	X	X
EcommerceProducts	X	X	X	X
EcommerceProductVariants	X	X	X	X
EcommerceStores	X	X	X	X
FileManagerFiles	X	X	X	X
FileManagerFolders	X	X	X	X
ListAbuse	X
ListActivity	X
ListClients	X
ListGrowthHistory	X
ListInterestCategories	X	X	X	X
ListInterests	X	X	X	X
ListMemberActivity	X
ListMemberNotes	X	X	X	X
ListMembers	X	X	X	X
ListMergeFields	X	X	X	X
Lists	X	X	X	X
ListSegmentMembers	X	X	X	X
ListSegments	X	X	X	X
ListSignUpForms	X
ListsTwitterLeadGenCards	X	X	X	X
ListsWebhooks	X	X	X	X
ReportAbuse	X
ReportAdvice	X
ReportClickDetails	X
ReportClickDetailsMembers	X
ReportDomainPerformance	X
ReportEmailActivity	X
ReportLocations	X
Reports	X
ReportSentTo	X
ReportUnsubscribes	X
TemplateFolders	X	X	X	X
Templates	X	X	X	X

Special Operations

Supports the Execute Block to execute stored procedures, where each stored procedure is represented as an entity and each input parameter is represented as a field within that entity. See Execute Block and the CData Mailchimp documentation for additional information.

Setup Considerations

Supports Mailchimp API Version 3.
Requires a Mailchimp API Key. To create an API key:
1. Log in to your Mailchimp account.
2. Go to Profile.
3. From the menu bar select Extras > API Keys.
4. Either copy your existing API Key or select the Create A Key button to create one.

Advanced scenarios such as customizing the SSL configuration, or connecting through a firewall or a proxy are described in Advanced Settings in the CData documentation.

API Usage Limits

Note: Refreshing metadata for the Connector consumes API calls.

Selecting An Agent Type For Mailchimp

Refer to TIBCO Cloud™ Integration - Connect Agents for information on available agent types and how to select the best agent for your app.

Connecting To Mailchimp

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 Cloud™ Integration - Connect users. Depending on the entities supported, a TIBCO Cloud™ Integration - Connect user could alter user accounts in the target system.

Select Connections from the menu.
From the Connections page select Create to open the Create a connection dialog.
Select the Connector from the list to open the Connection dialog, 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 Key — Enter the API Key used to access your Mailchimp account.
- Additional Parameters — Optional field where you can specify one or more connection string parameters. See the Connection String Options section of the CData documentation for a list of parameters that can be used and their default values. Note that in some cases the CData Mailchimp ADO.NET Provider does not fully support all of the possible parameters.
  Syntax for the Additional Parameters field is as follows:
  - All blank characters, except those within a value or within quotation marks, are ignored
  - Preceding and trailing spaces are ignored unless enclosed in single or double quotes, such as Keyword=" value"
  - Semicolons (;) within a value must be delimited by quotation marks
  - Use a single quote (') if the value begins with a double quote (")
  - Use a double quote (") if the value begins with a single quote (')
  - Parameters are case-insensitive
  - If a KEYWORD=VALUE pair occurs more than once in the connection string, the value associated with the last occurrence is used
  - If a keyword contains an equal sign (=), it must be preceded by an additional equal sign to indicate that the equal sign is part of the keyword
  - Parameters that are handled by other fields or default settings in the Connection dialog are ignored if used in the Additional Parameters field, including:
    - API Key
    - Logfile — This parameter is not visible in the Connection dialog, but is set by the Connector. The default size is a maximum of 10MB. Any CData log files generated by this setting are stored in the default Connect on-premise Agent Logs directory, C:\Program Files (x86)\Scribe Software\TIBCO Scribe® Online Agent\logs\. The format for log file names for CData logs are as follows: <ConnectorName><GUID of the Connection><DateTimeStamp>.log
      Note: For information on setting log file verbosity, see Verbosity in the CData Help.
    - MaxLogFileSize — This parameter is set by the Connector to a maximum of 10MB.
    - Other
    - RTK
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

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Relationships

Hierarchical relationships, such as grandparent, parent, grandchild relationships are not supported. See Hierarchical Data for examples.
Parent/Child relationships are not supported.

Mailchimp Connector As An App Source

Consider the following when using the Mailchimp Connector as an app Source.

Filtering

Different entities support different filtering abilities. Refer to the filtering details for specific entities in the CData Mailchimp documentation

Net Change

When a datetime is configured on the Query block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Cloud™ Integration - Connect builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Cloud™ Integration - Connect only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

Operators

The following Operators are not supported:

Filter Fields

Most entities only support filtering by Id using the equals operator. In some cases, the Connector returns a large amount of data, stores it in memory, and then sorts and filters that data. This may cause performance to slow down. To help prevent performance issues, be careful with Joins, aggregate functions, and a large number of filters.

Native Query

The Mailchimp Connector supports SQL queries in Native Query Blocks to create customized queries for Mailchimp. The query can be as simple or complex as you need it to be; however, it should return a single result set. The native query text is sent to Mailchimp exactly as it is entered without any modifications.

You can use SELECT , UPDATE , INSERT and DELETE clauses. If support for Enhanced SQL is enabled, you can use Joins and Aggregate functions. For additional details, see the SQL Compliance section of the CData documentation .

After entering the SQL query, you must select Test to validate the query. Invalid queries are not accepted by the Connector. See Native Query Block and Creating Native Queries For Microsoft SQL Server for additional information.

When testing a Native Query in a flow, if the source datastore does not return any data, TIBCO Cloud™ Integration - Connect cannot build the schema for the underlying metadata and the flow cannot be saved. To allow TIBCO Cloud™ Integration - Connect to build the schema, do the following:

Create a single temporary record in the source datastore that matches the Native Query.
Test the Native Query and ensure that it is successful.
Save the flow.
Remove the temporary record from the source datastore.

Mailchimp Connector As An App Target

Consider the following when using the Mailchimp Connector as an app target.

Batch Processing

Batch processing is not supported.

TIBCO Cloud™ Integration - Connect API Considerations

To create connections with the TIBCO Cloud™ Integration - Connect API, the Mailchimp Connector requires the following information:

Connector Name	MailChimp
Connector ID	8B2327D6-C95E-4D0E-92B3-0AD6D09D5CA1

TIBCO Cloud™ Integration - Connect 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	Usage
APIKey	string	Yes	Yes
AdditionalParameters	string	No	No

License Agreement

The TIBCO End User License Agreement for the Mailchimp 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.