Create a connection to ActiveCampaign by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the ActiveCampaign icon is not available, click the Add More icon to download and install the ActiveCampaign connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to ActiveCampaign

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

• URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}.api-us1.com
• APIKey: This can be found in your account on the Settings page under the Developer tab. Each user in your ActiveCampaign account has their own unique API key.

Overview

The Sync App models ActiveCampaign resources like Contacts, Accounts as relational tables, allowing you to write SQL to query ActiveCampaign data.

Live connectivity to these objects means any changes to your ActiveCampaign account are immediately reflected when using the Sync App.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Dynamic Views

Along with the default static views, the Sync App also allows querying on dynamic views.

These are views that are created based on the "lists" (also called "audiences") in your ActiveCampaign account.
For example, suppose you have these 3 lists in your account: Master Contact List, New Audience, VIP List.

The Sync App lists 3 views based on them: List_MasterList, List_New Audience, List_VIP List.
The views return data about each contact that is a member of that specific list.

Tables

Tables describes the available tables. Tables are statically defined to model resources like Accounts, Deals, DealGroups, DealStages, Tasks, etc.

The Sync App also supports querying tables like AccountCustomFieldData, DealCustomFieldData, ContactCustomFieldData which represent custom field data information.

Additionally, the Sync App supports updating, inserting custom fields data from the main resource (available for the Accounts, Contacts, Deals tables) where custom fields are dynamically appended as main resource columns. See the specific table section for more information.

The Sync App models the data in ActiveCampaign into a list of tables that can be queried using standard SQL statements.

Generally, querying ActiveCampaign tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

ActiveCampaign Connector for CData Sync Tables

Usage information for the operation AccountContacts.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

SELECT * FROM AccountContacts WHERE AccountId = 1 AND ContactId = 100

Insert

Inserting an account-contact association requires specifying a value for the AccountId and ContactId columns.

INSERT INTO AccountContacts (AccountId, ContactId) VALUES (2, 300)

INSERT INTO AccountContacts (AccountId, ContactId, Jobtitle) VALUES (2, 300, 'nurse')

Update

The driver supports updating account-contact information.

UPDATE AccountContacts SET ContactId = 3, JobTitle = 'updatedJobTitle' WHERE Id = 1

UPDATE AccountContacts SET JobTitle = 'updatedJobTitle' WHERE AccountId = 1

Delete

Remove all account-contacts association or an association by specifying the Id of the association.

DELETE FROM AccountContacts WHERE Id = 10003

Columns

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountCustomFieldData WHERE Id = 10003

SELECT * FROM AccountCustomFieldData WHERE AccountId = 1

Insert

Inserting an account custom field data requires specifying a value for the AccountId, CustomFieldId, FieldValue columns.

Additionally, the Sync App supports inserting account custom fields data from the Accounts table. See Accounts for more information.

INSERT INTO AccountCustomFieldData (FieldValue, CustomFieldId, AccountId) VALUES ('custom field value',1,5)

Update

The Sync App supports updating account custom field data information. Updating an account custom field data requires specifying a value for the Id and CustomFieldId columns.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE AccountCustomFieldData SET FieldValue = 'Custom Field Value' WHERE Id = 13 AND CustomFieldId = 1

Delete

The Sync App supports removing accounts' custom field data.

DELETE FROM AccountcustomFieldData WHERE Id = 10

Columns

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Accounts WHERE Id = 10003

SELECT * FROM Accounts WHERE Name = 'testAccount'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the AccountCustomFieldData table.

Insert

Inserting an account requires specifying the account name.

INSERT INTO Accounts (Name) VALUES ('testAccount2')

INSERT INTO Accounts (Name,AccountUrl) VALUES ('account','http://accountUrl.com/')

Additionally, the Sync App supports inserting account and account custom fields data from the Accounts table. All custom field columns start with CF_.

INSERT INTO Accounts (Name,CF_Description,CF_Hidden,CF_Number) VALUES ('testAccount3','custom field value','custom field value',123)

Update

The Sync App supports updating account information.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE Accounts SET Name = 'updatedName',AccountUrl = 'http://updatedAccountUrl.com/' WHERE Id = 1

UPDATE Accounts SET Name = 'updatedName',CF_Description = 'custom field value', CF_Hidden = 'custom field value' WHERE Id = 1

Delete

Remove all accounts or an account by specifying the Id of the account.

DELETE FROM Accounts WHERE Id = 10003

Columns

Create, modify, delete and query the available contact custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM ContactCustomFieldData WHERE Id = 10003

SELECT * FROM ContactCustomFieldData WHERE FieldValue = 'custom field value'

Insert

Inserting a contact custom field data requires specifying a value for the ContactId, FieldId, FieldValue columns.

Additionally, the Sync App supports inserting contact custom fields data from the Contacts table. See Contacts for more information.

INSERT INTO ContactCustomFieldData (FieldValue , FieldId , ContactId) VALUES ('custom field value',1,5)

Update

The Sync App supports updating contact custom field data information. Updating contact custom field data requires specifying a value for the Id, ContactId and FieldId columns.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE ContactCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND ContactId = 3 AND FieldId = 2"

Delete

The Sync App supports removing contact custom field data.

DELETE FROM ContactCustomFieldData WHERE Id = 10

Columns

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = 10

SELECT * FROM Contacts WHERE Udate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Udate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Cdate >= '2019-06-30T10:44:34-05:00' AND Cdate <= '2021-06-30T10:44:34-05:00'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the ContactCustomFieldData table.

Insert

Inserting a contact requires specifying the contact email.

INSERT INTO Contacts (Email) VALUES ('[email protected]')

INSERT INTO Contacts (Email,FirstName,LastName,Phone) VALUES ('[email protected]','test','test','contactphonenumber')

Additionally, the Sync App supports inserting contact and contact custom fields data from the Contacts table. All custom field columns start with CF_.

INSERT INTO Contacts (Name,CF_Description,CF_Hidden,CF_Number) VALUES ('testcontact3','custom field value','custom field value',123)

Update

The Sync App supports updating contact information.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE Contacts SET FirstName = 'updatedName' WHERE Id = 1

UPDATE Contacts SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Bulk Import Contacts

The Sync App supports uploading large numbers of contacts into your account. This operation includes:

• Creating new contacts
• Updating existing contacts
• Subscribing and unsubscribing from lists

Contacts are imported in batches of up to 250 items. The importer is not recommended to be used for a small number of contacts. You can import contacts as below:

INSERT INTO Contacts#Temp (Email) VALUES ('[email protected]')

INSERT INTO Contacts#Temp (Email) VALUES ('[email protected]')

UPSERT INTO Contacts (Email) SELECT Email FROM Contacts#Temp

Additionally, the Sync App supports BULK INSERT for the Contacts table. Please note this operation will cause a cost in performance as the Sync App validates if the submitted contacts exist before importing them.

INSERT INTO Contacts#Temp (Email) VALUES ('[email protected]')

INSERT INTO Contacts#Temp (Email) VALUES ('[email protected]')

INSERT INTO Contacts (Email) SELECT Email FROM Contacts#Temp

To subscribe and unsubscribe contacts from a specific list set a value for the SubscribeTo and/or UnsubcribeFrom columns which accept a comma-separated list of list ids. For example:

INSERT INTO Contacts#Temp (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]','1,2','6,12')

INSERT INTO Contacts#Temp (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]','3,7','6,1')

UPSERT INTO Contacts (Email, SubscribeTo, UnsubcribeFrom) SELECT Email, SubscribeTo, UnsubcribeFrom FROM Contacts#Temp

Contacts must meet all the following criteria in order to be created or updated with this API:

• The imported contacts may not exceed your account limit
• The contact must have an email address
• The contact's email address must not be on an exclusion list
• The contact's email must not be on a list of bounced email addresses
• The contact must not have unsubscribed to a list that the import would add them to

If contacts do not meet all of these requirements, they will be skipped by the importer.

Delete

Remove all contacts or a contact by specifying the Id of the contact.

DELETE FROM Contacts WHERE Id = 10003

Columns

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealCustomFieldData WHERE Id = 10003

SELECT * FROM DealCustomFieldData WHERE DealId = 1

Insert

Inserting a deal custom field data requires specifying a value for the DealId, CustomFieldId, and FieldValue columns.

Additionally, the Sync App supports inserting deal custom fields data from the Deals table. See Deals for more information.

INSERT INTO DealCustomFieldData (FieldValue , CustomFieldId , DealId) VALUES ('custom field value',1,5)

Update

The Sync App supports updating deal custom field data information. Updating deal custom field data requires specifying a value for the Id, DealId and CustomFieldId columns.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE DealCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND DealId = 3 AND CustomFieldId = 2

Delete

The Sync App supports removing deal custom field data.

DELETE FROM DealCustomFieldData WHERE Id = 10

Columns

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealGroups WHERE Id = 10003

SELECT * FROM DealGroups WHERE Title = 'title'

Insert

Inserting a pipeline/dealgroup requires specifying a value for the Currency, Title columns.

INSERT INTO DealGroups (Currency, Title) VALUES (2,300)

INSERT INTO DealGroups (Currency, Title, AutoAssign, AllUsers, AllGroups) VALUES ('USD','title',1,0,1)

Update

The Sync App supports updating pipeline/dealgroup information.

UPDATE DealGroups SET AllUsers = 0, AllGroups = 1, Currency = 'EUR' WHERE Id = 1

Delete

Remove all pipelines or a pipeline by specifying the Id of the dealgroup.

DELETE FROM DealGroups WHERE Id = 10003

Columns

Usage information for the operation Deals.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Deals WHERE Id = 10

SELECT * FROM Deals WHERE GroupId = 1

SELECT * FROM Deals WHERE OwnerId = 1

SELECT * FROM Deals WHERE Stage = 1 AND Title = 'title'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the DealCustomFieldData table.

Insert

Inserting a deal requires specifying a value for the GroupId, Stage, OwnerId, Title, Value, Currency columns and a value for AccountId or ContactId column.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency) VALUES (1,1,1,1,'title',100,'USD')

INSERT INTO Deals (Email, FirstName, LastName, Phone) VALUES ('[email protected]' ,'test', 'test', 'dealphonenumber')

Additionally, the Sync App supports inserting deal and deal custom fields data from the Deals table. All custom field columns start with CF_.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency, CF_CustomField1,CF_CustomField2, CF_CustomField3) VALUES (1,1,1,1,'title',100,'USD','value','value','value')

Update

The Sync App supports updating deal information.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE Deals SET Title = 'updatedTitle' WHERE Id = 1

UPDATE Deals SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Delete

Remove all deals or a deal by specifying the Id of the deal.

DELETE FROM Deals

DELETE FROM Deals WHERE Id = 10003

Columns

Usage information for the operation DealStages.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealStages WHERE Id = 10003

SELECT * FROM DealStages WHERE Title = 'title' AND GroupId = 1

Insert

Inserting a stage requires specifying a value for the GroupId, Title columns.

INSERT INTO DealStages (GroupId, Title) VALUES (2,'title')

INSERT INTO DealStages (Title, GroupId, OrderId, CardRegion3, Color, Width) VALUES ('TestStage',1,2,'hide-avatar','434343','280')

Update

The Sync App supports updating stage/dealstage information.

UPDATE DealStages SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM DealStages WHERE Id = 10003

Columns

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Tasks WHERE Id = 10003

SELECT * FROM Tasks WHERE DealTaskType = 1 

SELECT * FROM Tasks WHERE DueDate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE DueDate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE OutcomeId = 1 AND RelId = 1 AND Status = 1

Insert

Inserting a stage requires specifying a value for the DealTaskType, DueDate, Relid columns.

INSERT INTO Tasks (DealTaskType, DueDate, Relid) VALUES (2, '2021-06-30T10:44:34-05:00', 7)

Update

The Sync App supports updating stage/dealstage information.

UPDATE Tasks SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM Tasks WHERE Id = 10003

Columns

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

ActiveCampaign Connector for CData Sync Views

Usage information for the operation Addresses.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

Columns

Usage information for the operation Automations.rsd.

Columns

Query the campaigns information in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Campaigns WHERE Id = 10003

Columns

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM ContactAutomations WHERE Id = 10003

Columns

Retrieve ContactList for each contact Group or for the specific Contact group.

Table Specific Information

Select

Retrieving information from ContactLists requires specifying a ContactId.

SELECT * FROM ContactLists WHERE ContactId = 1000

Columns

Retrieve tags added for each contact or for the specific Contact Id

Table Specific Information

Select

Retrieving information for ContactTags requires specifying a ContactId.

SELECT * FROM ContactTags WHERE ContactId = 1

Columns

Usage information for the operation Lists.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Lists WHERE Id = 1

SELECT * FROM Lists WHERE Name = 'list1'

In addition the Sync App supports retrieving information about members of lists in your account by supporting them dynamically as VIEWS. Selecting from a dynamic list will return information about all the contacts that are members of that list. Lists names always start with "List_".

Columns

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Scores WHERE Id = 10

Columns

View many or all tags by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Tags WHERE Id = 10003

Columns

Retrieve trackingLogs for the specific contact or all contacts

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Usage information for the operation Users.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 10003

Columns

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

Authentication

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

The APIKey obtained from the ActiveCampaign UI.

Remarks

API key can be found in your account on the Settings page under the "Developer" tab. Each user in your ActiveCampaign account has their own unique API key.

Base URL which is used to access the API.

Remarks

URL can be found in your account on the My Settings page under the "Developer" tab. For example: https://{yourAccountName}.api-us1.com

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\ActiveCampaign Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

The maximum number of results to return per page from ActiveCampaign.

Remarks

The Pagesize property affects the maximum number of results to return per page from ActiveCampaign. ActiveCampaign allows a maximum of 100 records to be returned in each page.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Contacts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"