ActiveCampaign Connector for CData Sync

Build 23.0.8839
  • ActiveCampaign
    • 接続の確立
    • データモデル
      • テーブル
        • AccountContacts
        • AccountCustomFieldData
        • Accounts
        • ContactCustomFieldData
        • Contacts
        • DealCustomFieldData
        • DealGroups
        • Deals
        • DealStages
        • Tasks
      • ビュー
        • Addresses
        • Automations
        • Campaigns
        • ContactAutomations
        • ContactLists
        • ContactTags
        • DealActivities
        • Lists
        • Scores
        • Tags
        • TrackingLogs
        • Users
    • 接続文字列オプション
      • Authentication
        • APIKey
        • URL
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UserDefinedViews

ActiveCampaign Connector for CData Sync

概要

CData Sync App は、ActiveCampaign データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。

ActiveCampaign コネクタはCData Sync アプリケーションから使用可能で、ActiveCampaign からデータを取得して、サポートされている任意の同期先に移動できます。

ActiveCampaign バージョンサポート

Sync App は、ActiveCampaign API バージョン3を使用してActiveCampaign データへの双方向連携を実現します。

ActiveCampaign Connector for CData Sync

接続の確立

ActiveCampaign への接続を追加

ActiveCampaign への接続を追加するには：

  1. アプリケーションコンソールで、接続ページに移動します。
  2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
  3. ActiveCampaign アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからActiveCampaign コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

ActiveCampaign への接続

ActiveCampaign はAPI キーによる認証をサポートしています。ActiveCampaign に接続するには、自身のアカウントでDeveloper ページに移動して以下を設定します。

  • URL：このプロパティを設定するには、My Settings ページに移動します。例： https://<yourAccountName>.api-us1.com
  • APIKey：このプロパティを設定するには、Settings ページに移動します。ActiveCampaign アカウントの各ユーザーには、それぞれ固有のAPI キーがあります。

これらのプロパティを設定する際、My Settings とSettings をを間違えないようにしてください。

ActiveCampaign Connector for CData Sync

データモデル

概要

Sync App はContacts、Accounts などのActiveCampaign リソースをリレーショナルテーブルとしてモデル化し、SQL を記述してActiveCampaign データをクエリできるようにします。

これらのオブジェクトへのライブ接続により、Sync App を使用するとActiveCampaign アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。

ダイナミックビュー

デフォルトの静的ビューに加え、Sync App ではダイナミックビューでのクエリも可能です。

これらはActiveCampaign アカウントの"リスト"（"オーディエンス" とも呼ばれます）に基づいて作成されるビューです。
例えば、アカウントに以下の3つのリストがあると仮定しましょう：Master Contact List、New Audience、VIP List。

Sync App はそれらに基づいて3つのビューをリストします：List_MasterList、List_New Audience、List_VIP List。
ビューは、その特定のリストのメンバーである各コンタクトに関するデータを返します。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Accounts、Deals、DealGroups、DealStages、Tasks などのリソースを静的にモデル化するように定義されています。

Sync App はまた、AccountCustomFieldData、DealCustomFieldData、ContactCustomFieldData などのカスタムフィールドデータ情報を表すテーブルへのクエリもサポートしています。

さらに、Sync App は、メインリソース（Accounts、Contacts、Deals テーブルで利用可能）からのカスタムフィールドデータの更新や挿入をサポートし、カスタムフィールドはメインフィールドのカラムとして動的に追加されます。詳細については、特定のテーブルのセクションを参照してください。

ActiveCampaign Connector for CData Sync

テーブル

Sync App はActiveCampaign のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

ActiveCampaign Connector for CData Sync テーブル

Name Description
AccountContacts Usage information for the operation AccountContacts.rsd.
AccountCustomFieldData Create, modify, delete and query the available deal custom field data in ActiveCampaign.
Accounts View many or all contacts by including their ID's or various filters.
ContactCustomFieldData Create, modify, delete and query the available contact custom field data in ActiveCampaign.
Contacts View many or all contacts by including their ID's or various filters.
DealCustomFieldData Create, modify, delete and query the available deal custom field data in ActiveCampaign.
DealGroups Lists all existing accounts.
Deals Usage information for the operation Deals.rsd.
DealStages Usage information for the operation DealStages.rsd.
Tasks Lists all existing accounts.

ActiveCampaign Connector for CData Sync

AccountContacts

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

Name Type ReadOnly Description
Id [KEY] String True

The Id of the account-contact association.

AccountId String False

The account Id.

ContactId String False

The contact Id.

CreatedTimestamp Datetime True

Datetime value which indicates when the assosiaction was created.

JobTitle String False

Job Title of the contact at the account.

AccountLink String True

Account link.

ContactLink String True

Contact link.

UpdatedTimestamp Datetime True

Datetime value which indicates when the assosiaction was last updated.

ActiveCampaign Connector for CData Sync

AccountCustomFieldData

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

Name Type ReadOnly Description
Id [KEY] String True

The Id of the account custom field data.

AccountCustomFieldMetumId Integer True

The custom field metum Id.

AccountId Integer False

The ID of the account the field value relates to.

CreatedTimestamp Datetime True

Datetime value that indicates when the custom field value was set.

CustomFieldId Integer False

The ID of the custom field metum the field value relates to.

CustomFieldName String True

The name of the custom field metum the field value relates to.

FieldValue String False

Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5).

AccountLink String True

Account link.

AccountCustomFieldMetumLink String True

AccountCustomFieldMetum link.

UpdatedTimestamp Datetime True

Datetime value which indicates when the custom field data was last updated.

FieldCurrency String False

Value of the custom field currency type for a specific contact. This field is required when inserting currency custom fields.

ActiveCampaign Connector for CData Sync

Accounts

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

Name Type ReadOnly Description
Id [KEY] String True

The Id column of the Accounts table.

AccountUrl String False

Account's website.

ContactCount Integer True

The ContactCount column of the Accounts table.

CreatedTimestamp Datetime True

The CreatedTimestamp column of the Accounts table.

DealCount Integer True

The DealCount column of the Accounts table.

AccountContactsLink String True

The AccountContactsLink column of the Accounts table.

AccountCustomFieldDataLink String True

The AccountCustomFieldDataLink column of the Accounts table.

ContactEmailsLink String True

The ContactEmailsLink column of the Accounts table.

EmailActivitiesLink String True

The EmailActivitiesLink column of the Accounts table.

NotesLink String True

The NotesLink column of the Accounts table.

Name String False

Account's name.

UpdatedTimestamp Datetime True

The UpdatedTimestamp column of the Accounts table.

ActiveCampaign Connector for CData Sync

ContactCustomFieldData

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

Name Type ReadOnly Description
Id [KEY] String False

The Id column of the ContactCustomFieldData table.

CDate Datetime False

The CDate column of the ContactCustomFieldData table.

ContactId String False

The ContactId column of the ContactCustomFieldData table.

CustomFieldName String True

The name of the custom field metum the field value relates to.

FieldId String False

ID of the field the value belongs to.

FieldLink String False

The FieldLink column of the ContactCustomFieldData table.

OwnerLink String False

The OwnerLink column of the ContactCustomFieldData table.

Owner String False

The Owner column of the ContactCustomFieldData table.

Udate Datetime False

The Udate column of the ContactCustomFieldData table.

FieldValue String False

Value of the custom field for a specific contact.

ActiveCampaign Connector for CData Sync

Contacts

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

Name Type ReadOnly Description
Id [KEY] String True

The Id column of the Contacts table.

Adate Datetime True

The Adate column of the Contacts table.

Anonymized String True

The Anonymized column of the Contacts table.

BouncedDate String True

The BouncedDate column of the Contacts table.

BouncedHard String True

The BouncedHard column of the Contacts table.

BouncedSoft String True

The BouncedSoft column of the Contacts table.

Cdate Datetime True

The Cdate column of the Contacts table.

CreatedBy String True

The CreatedBy column of the Contacts table.

CreatedTimestamp Datetime True

The CreatedTimestamp column of the Contacts table.

CreatedUtcTimestamp Datetime True

The CreatedUtcTimestamp column of the Contacts table.

Deleted String True

The Deleted column of the Contacts table.

DeletedAt String True

The DeletedAt column of the Contacts table.

Edate Datetime True

The Edate column of the Contacts table.

Email String False

The Email column of the Contacts table.

EmailDomain String True

The EmailDomain column of the Contacts table.

EmailEmpty Boolean True

The EmailEmpty column of the Contacts table.

EmailLocal String True

The EmailLocal column of the Contacts table.

FirstName String False

The FirstName column of the Contacts table.

Gravatar String True

The Gravatar column of the Contacts table.

Hash String True

The Hash column of the Contacts table.

Ip String True

The Ip column of the Contacts table.

LastName String False

The LastName column of the Contacts table.

AccountContactsLink String True

The AccountContactsLink column of the Contacts table.

AutomationEntryCountsLink String True

The AutomationEntryCountsLink column of the Contacts table.

BounceLogsLink String True

The BounceLogsLink column of the Contacts table.

ContactAutomationsLink String True

The ContactAutomationsLink column of the Contacts table.

ContactDataLink String True

The ContactDataLink column of the Contacts table.

ContactDealsLink String True

The ContactDealsLink column of the Contacts table.

ContactGoalsLink String True

The ContactGoalsLink column of the Contacts table.

ContactListsLink String True

The ContactListsLink column of the Contacts table.

ContactLogsLink String True

The ContactLogsLink column of the Contacts table.

ContactTagsLink String True

The ContactTagsLink column of the Contacts table.

DealsLink String True

The DealsLink column of the Contacts table.

FieldValuesLink String True

The FieldValuesLink column of the Contacts table.

GeoIpsLink String True

The GeoIpsLink column of the Contacts table.

NotesLink String True

The NotesLink column of the Contacts table.

OrganizationLink String True

The OrganizationLink column of the Contacts table.

PlusAppendLink String True

The PlusAppendLink column of the Contacts table.

ScoreValuesLink String True

The ScoreValuesLink column of the Contacts table.

TrackingLogsLink String True

The TrackingLogsLink column of the Contacts table.

Organization String True

The Organization column of the Contacts table.

Orgname String True

The Orgname column of the Contacts table.

Phone String False

The Phone column of the Contacts table.

RatingTStamp String True

The RatingTStamp column of the Contacts table.

SegmentioId String True

The SegmentioId column of the Contacts table.

Sentcnt String True

The Sentcnt column of the Contacts table.

SocialdataLastcheck String True

The SocialdataLastcheck column of the Contacts table.

Ua String True

The Ua column of the Contacts table.

Udate Datetime True

The Udate column of the Contacts table.

UpdatedTimestamp String True

The UpdatedTimestamp column of the Contacts table.

Updated_by String True

The Updated_by column of the Contacts table.

SubscribeTo String False

Comma-separated list of list Ids to subscribe a contact to.

UnsubscribeFrom String False

Comma-separated list of list Ids to unsubscribe a contact from.

ActiveCampaign Connector for CData Sync

DealCustomFieldData

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

Name Type ReadOnly Description
Id [KEY] String False

The Id column of the DealCustomFieldData table.

CreatedTimestamp Datetime False

The CreatedTimestamp column of the DealCustomFieldData table.

CustomFieldName String True

The name of the custom field metum the field value relates to.

CustomFieldId Integer False

The CustomFieldId column of the DealCustomFieldData table.

DealCustomFieldMetumId Integer False

The DealCustomFieldMetumId column of the DealCustomFieldData table.

DealId Integer False

The DealId column of the DealCustomFieldData table.

FieldValue String False

The FieldValue column of the DealCustomFieldData table.

DealLink String False

The DealLink column of the DealCustomFieldData table.

DealCustomFieldMetumLink String False

The DealCustomFieldMetumLink column of the DealCustomFieldData table.

UpdatedTimestamp Datetime False

The UpdatedTimestamp column of the DealCustomFieldData.

FieldCurrency String False

Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.

FieldType String False

Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.

ActiveCampaign Connector for CData Sync

DealGroups

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

Name Type ReadOnly Description
Id [KEY] String True

The pipeline Id.

AllGroups String False

The AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.

AllUsers String False

The AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.

AutoAssign String False

The AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.

Cdate Datetime True

The Cdate column of the DealGroups table.

Currency String False

The Currency column of the DealGroups table.

DealGroupGroupsLink String True

The DealGroupGroupsLink column of the DealGroups table.

DealGroupUsersLink String True

The DealGroupUsersLink column of the DealGroups table.

StagesLink String True

The StagesLink column of the DealGroups table.

Stages String True

The Stages column of the DealGroups table.

Title String False

Pipeline's title.

Udate Datetime True

The Udate column of the DealGroups table.

ActiveCampaign Connector for CData Sync

Deals

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

Name Type ReadOnly Description
Id [KEY] String True

The Id column of the Deals table.

AccountId String False

The AccountId column of the Deals table.

ActivityCount String True

The ActivityCount column of the Deals table.

Cdate Datetime True

The Cdate column of the Deals table.

ContactId String False

Deal's primary contact's Id.

Currency String False

Deal's currency in 3-digit ISO format, lowercased.

CustomerAccount String True

The CustomerAccount column of the Deals table.

Description String False

The Description column of the Deals table.

Edate String True

The Edate column of the Deals table.

Group String False

Deal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.

Hash String True

The Hash column of the Deals table.

IsDisabled String True

The IsDisabled column of the Deals table.

AccountLink String True

The AccountLink column of the Deals table.

ContactLink String True

The ContactLink column of the Deals table.

ContactDealsLink String True

The ContactDealsLink column of the Deals table.

CustomerAccountLink String True

The CustomerAccountLink column of the Deals table.

DealActivitiesLink String True

The DealActivitiesLink column of the Deals table.

DealCustomFieldDataLink String True

The DealCustomFieldDataLink column of the Deals table.

GroupLink String True

The GroupLink column of the Deals table.

NextTaskLink String True

The NextTaskLink column of the Deals table.

NotesLink String True

The NotesLink column of the Deals table.

OrganizationLink String True

The OrganizationLink column of the Deals table.

OwnerLink String True

The OwnerLink column of the Deals table.

ScoreValuesLink String True

The ScoreValuesLink column of the Deals table.

StageLink String True

The StageLink column of the Deals table.

TasksLink String True

The TasksLink column of the Deals table.

Mdate Datetime True

The Mdate column of the Deals table.

NextTask String True

The NextTask column of the Deals table.

NextDate Datetime True

The NextDate column of the Deals table.

NextDealId String True

The NextDealId column of the Deals table.

NextTaskId String True

The NextTaskId column of the Deals table.

Organization String True

The Organization column of the Deals table.

Owner String False

Deal's owner Id. Required if pipeline's auto-assign option is disabled.

Percent String False

The Percent column of the Deals table.

Stage String False

Deal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.

Status String False

The Status column of the Deals table.

Title String False

The Title column of the Deals table.

Value String False

Deal's value in cents.

WinProbability Integer True

The WinProbability column of the Deals table.

WinProbabilityMdate Datetime True

The WinProbabilityMdate column of the Deals table.

ActiveCampaign Connector for CData Sync

DealStages

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

Name Type ReadOnly Description
Id [KEY] String True

The Id column of the DealStages table.

CardRegion1 String False

The CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards.

CardRegion2 String False

The CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards.

CardRegion3 String False

The CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars.

CardRegion4 String False

The CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards.

CardRegion5 String False

The CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards.

Cdate Datetime True

The Cdate column of the DealStages table.

Color String False

Deal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343.

DealOrder String False

Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either.

GroupId String False

The GroupId column of the DealStages table.

GroupLink String True

The GroupLink column of the DealStages table.

OrderId String False

The OrderId column of the DealStages table.

Title String False

The Title column of the DealStages table.

Udate Datetime True

The Udate column of the DealStages table.

Width String False

Deal stage's width in pixels, without px unit.

ActiveCampaign Connector for CData Sync

Tasks

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

Name Type ReadOnly Description
Id [KEY] String True

The Id column of the Tasks table.

Assignee String False

The Assignee column of the Tasks table.

Automation String True

The Automation column of the Tasks table.

Cdate Datetime True

The Cdate column of the Tasks table.

DealTaskType String False

The type of the task based on the available Task Types in the account.

DoneAutomation String False

The DoneAutomation column of the Tasks table.

DueDate Datetime False

Due date of the task.

Edate Datetime True

The Edate column of the Tasks table.

ActivitiesLink String True

The ActivitiesLink column of the Tasks table.

AssigneeLink String True

The AssigneeLink column of the Tasks table.

AutomationLink String True

The AutomationLink column of the Tasks table.

DealTasktypeLink String True

The DealTasktypeLink column of the Tasks table.

DoneAutomationLink String True

The DoneAutomationLink column of the Tasks table.

NotesLink String True

The NotesLink column of the Tasks table.

OwnerLink String True

The OwnerLink column of the Tasks table.

TaskNotificationsLink String True

The TaskNotificationsLink column of the Tasks table.

UserLink String True

The UserLink column of the Tasks table.

Note String False

The content describing the task.

OutcomeId Integer False

The OutcomeId column of the Tasks table.

OutcomeInfo String False

The OutcomeInfo column of the Tasks table.

OwnerId String True

The OwnerId column of the Tasks table.

OwnerType String False

The name of the relating object. Valid values are contact or deal.

Relid String False

The Id of the relational object for this task.

Reltype String True

The Reltype column of the Tasks table.

Status Integer False

The Status column of the Tasks table. 1 is complete and 0 is incomplete..

Title String False

The Title column of the Tasks table.

Udate Datetime True

The Udate column of the Tasks table.

User String True

The User column of the Tasks table.

ActiveCampaign Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

ActiveCampaign Connector for CData Sync ビュー

Name Description
Addresses Usage information for the operation Addresses.rsd.
Automations Usage information for the operation Automations.rsd.
Campaigns Query the campaigns information in ActiveCampaign.
ContactAutomations View many or all contacts by including their ID's or various filters.
ContactLists Retrieve ContactList for each contact Group or for the specific Contact group.
ContactTags Retrieve tags added for each contact or for the specific Contact Id
DealActivities Retrieve Deal Activities for each Deal or for the specific Deal Id.
Lists Usage information for the operation Lists.rsd.
Scores View many or all contacts by including their ID's or various filters.
Tags View many or all tags by including their ID's or various filters.
TrackingLogs Retrieve trackingLogs for the specific contact or all contacts
Users Usage information for the operation Users.rsd.

ActiveCampaign Connector for CData Sync

Addresses

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

Name Type Description
Id String The Id column of the Addresses table.
Address1 String The Address1 column of the Addresses table.
Address2 String The Address2 column of the Addresses table.
Allgroup String The Allgroup column of the Addresses table.
City String The City column of the Addresses table.
CompanyName String The CompanyName column of the Addresses table.
Country String The Country column of the Addresses table.
District String The District column of the Addresses table.
isDefault String The isDefault column of the Addresses table.
AddressGroupLink String The AddressGroupLink column of the Addresses table.
AddressListLink String The AddressListLink column of the Addresses table.
FormsLink String The FormsLink column of the Addresses table.
State String The State column of the Addresses table.
Zip String The Zip column of the Addresses table.

ActiveCampaign Connector for CData Sync

Automations

Usage information for the operation Automations.rsd.

Columns

Name Type Description
Id String The Id column of the Automations table.
Cdate Datetime The Cdate column of the Automations table.
DefaultScreenshot String The DefaultScreenshot column of the Automations table.
Entered String The Entered column of the Automations table.
Exited String The Exited column of the Automations table.
Hidden String The Hidden column of the Automations table.
BlocksLink String The BlocksLink column of the Automations table.
CampaignsLink String The CampaignsLink column of the Automations table.
ContactAutomationsLink String The ContactAutomationsLink column of the Automations table.
ContactGoalsLink String The ContactGoalsLink column of the Automations table.
GoalsLink String The GoalsLink column of the Automations table.
SiteMessagesLink String The SiteMessagesLink column of the Automations table.
SmsLink String The SmsLink column of the Automations table.
Mdate Datetime The Mdate column of the Automations table.
Name String The Name column of the Automations table.
Screenshot String The Screenshot column of the Automations table.
Status String The Status column of the Automations table.
UserId String The UserId column of the Automations table.

ActiveCampaign Connector for CData Sync

Campaigns

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

Name Type Description
Id [KEY] String The Id column of the Campaigns table.
ActiveRssInterval String The ActiveRssInterval column of the Campaigns table.
ActiveRssItems String The ActiveRssItems column of the Campaigns table.
ActiveRssUrl String The ActiveRssUrl column of the Campaigns table.
AddressId String The AddressId column of the Campaigns table.
AnalyticsCampaignName String The AnalyticsCampaignName column of the Campaigns table.
Automation String The Automation column of the Campaigns table.
BaseMessageId String The BaseMessageId column of the Campaigns table.
BaseTemplateId String The BaseTemplateId column of the Campaigns table.
BounceId String The BounceId column of the Campaigns table.
CanSkipApproval String The can_skip_approval column of the Campaigns table.
Cdate Datetime The Cdate column of the Campaigns table.
CreatedBy String The Created By column of the Campaigns table.
CreatedTimestamp Datetime The Created Timestamp column of the Campaigns table.
DeleteStamp String The DeleteStamp column of the Campaigns table.
EmbedImages String The EmbedImages column of the Campaigns table.
Facebook String The Facebook column of the Campaigns table.
FormId String The FormId column of the Campaigns table.
Forwards String The Forwards column of the Campaigns table.
HardBounces String The HardBounces column of the Campaigns table.
HasPredictiveContent Bit The HasPredictiveContent column of the Campaigns table.
HtmlUnsub String The HtmlUnsub column of the Campaigns table.
HtmlUnsubdata String The HtmlUnsubdata column of the Campaigns table.
Ip String The Ip column of the Campaigns table.
Ip4 String The Ip4 column of the Campaigns table.
LastStep String The LastStep column of the Campaigns table.
Ldate String The Ldate column of the Campaigns table.
LinkClicks String The LinkClicks column of the Campaigns table.
AutomationLink String The AutomationLink column of the Campaigns table.
CampaignAggregateRevenuesLink String The AggregateRevenues column of the Campaigns table.
CampaignListsLink String The CampaignListsLink column of the Campaigns table.
CampaignMessageLink String The CampaignMessageLink column of the Campaigns table.
CampaignMessagesLink String The CampaignMessagesLink column of the Campaigns table.
LinksLink String The LinksLink column of the Campaigns table.
LinksSegment String The Segment column of the Campaigns table.
UserLink String The UserLink column of the Campaigns table.
MailCleanup String The MailCleanup column of the Campaigns table.
MailSend String The MailSend column of the Campaigns table.
MailTransfer String The MailTransfer column of the Campaigns table.
MailerLogFile String The MailerLogFile column of the Campaigns table.
ManageText String The ManageText column of the Campaigns table.
Mdate Datetime The Mdate column of the Campaigns table.
Name String The Name column of the Campaigns table.
Opens String The Opens column of the Campaigns table.
Public String The Public column of the Campaigns table.
RealCid String The RealCid column of the Campaigns table.
Recurring String The Recurring column of the Campaigns table.
ReminderField String The ReminderField column of the Campaigns table.
ReminderFormat String The ReminderFormat column of the Campaigns table.
ReminderLastCronRun String The ReminderLastCronRun column of the Campaigns table.
ReminderOffset String The ReminderOffset column of the Campaigns table.
ReminderOffsetSign String The ReminderOffsetSign column of the Campaigns table.
ReminderOffsetType String The ReminderOffsetType column of the Campaigns table.
ReminderType String The ReminderType column of the Campaigns table.
Replies String The Replies column of the Campaigns table.
ReplySys String The ReplySys column of the Campaigns table.
ResponderExisting String The ResponderExisting column of the Campaigns table.
ResponderOffset String The ResponderOffset column of the Campaigns table.
ResponderType String The ResponderType column of the Campaigns table.
Schedule String The Schedule column of the Campaigns table.
ScheduledDate String The ScheduledDate column of the Campaigns table.
Screenshot String The Screenshot column of the Campaigns table.
Sdate String The Sdate column of the Campaigns table.
SegmentId String The SegmentId column of the Campaigns table.
SegmentName String The SegmentName column of the Campaigns table.
SendAmt String The SendAmt column of the Campaigns table.
SendId String The SendId column of the Campaigns table.
SeriesId String The SeriesId column of the Campaigns table.
Series Send Lock Time String The SeriesSendLockTime column of the Campaigns table.
SocialShares String The SocialShares column of the Campaigns table.
SoftBounces String The SoftBounces column of the Campaigns table.
Source String The Source column of the Campaigns table.
SplitContent String The SplitContent column of the Campaigns table.
SplitOffset String The SplitOffset column of the Campaigns table.
SplitOffsetType String The SplitOffsetType column of the Campaigns table.
SplitType String The SplitType column of the Campaigns table.
SplitWinnerAwaiting String The SplitWinnerAwaiting column of the Campaigns table.
SplitWinnerMessageId String The SplitWinnerMessageId column of the Campaigns table.
Status String The Status column of the Campaigns table.
SubscriberClicks String The SubscriberClicks column of the Campaigns table.
Survey String The Survey column of the Campaigns table.
TextUnsub String The TextUnsub column of the Campaigns table.
TextUnsubData String The TextUnsubData column of the Campaigns table.
ThreadId String The ThreadId column of the Campaigns table.
TotalAmt String The TotalAmt column of the Campaigns table.
TrackLinks String The TrackLinks column of the Campaigns table.
TrackLinksAnalytics String The TrackLinksAnalytics column of the Campaigns table.
TrackReads String The TrackReads column of the Campaigns table.
TrackReadsAnalytics String The TrackReadsAnalytics column of the Campaigns table.
Tweet String The Tweet column of the Campaigns table.
Type String The Type column of the Campaigns table.
UniqueForwards String The UniqueForwards column of the Campaigns table.
UniqueLinkClicks String The UniqueLinkClicks column of the Campaigns table.
UniqueOpens String The UniqueOpens column of the Campaigns table.
UniqueReplies String The UniqueReplies column of the Campaigns table.
UnsubReasons String The UnsubReasons column of the Campaigns table.
Unsubscribes String The Unsubscribes column of the Campaigns table.
Updated By String The UpdatedBy column of the Campaigns table.
Updated Timestamp String The UpdatedTimestamp column of the Campaigns table.
Updates String The Updates column of the Campaigns table.
User String The User column of the Campaigns table.
UserId String The UserId column of the Campaigns table.
WaitPreview String The WaitPreview column of the Campaigns table.
WillRecur String The WillRecur column of the Campaigns table.

ActiveCampaign Connector for CData Sync

ContactAutomations

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

Name Type Description
Id String The Id column of the ContactAutomations table.
Adddate Datetime The Adddate column of the ContactAutomations table.
Automation String The Automation column of the ContactAutomations table.
Batchid Unknown The Batchid column of the ContactAutomations table.
CompleteValue Integer The CompleteValue column of the ContactAutomations table.
Completed Integer The Completed column of the ContactAutomations table.
CompletedElements String The CompletedElements column of the ContactAutomations table.
ContactId String The ContactId column of the ContactAutomations table.
Lastblock String The Lastblock column of the ContactAutomations table.
Lastdate Datetime The Lastdate column of the ContactAutomations table.
LastLogId String The LastLogId column of the ContactAutomations table.
AutomationLink String The AutomationLink column of the ContactAutomations table.
ContactLink String The ContactLink column of the ContactAutomations table.
ContactGoalsLink String The ContactGoalsLink column of the ContactAutomations table.
Remdate Datetime The Remdate column of the ContactAutomations table.
SeriesId String The SeriesId column of the ContactAutomations table.
StartId String The StartId column of the ContactAutomations table.
Status String The Status column of the ContactAutomations table.
TimeSpan String The TimeSpan column of the ContactAutomations table.
TotalElements String The TotalElements column of the ContactAutomations table.

ActiveCampaign Connector for CData Sync

ContactLists

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

Name Type Description
Id [KEY] String The Id column of the ContactLists table.
ContactId String The ContactId column of the ContactLists table.
AutomationId String The AutomationId column of the ContactLists table.
AutosyncLog String The AutosyncLog column of the ContactLists table.
Campaign String The Campaign column of the ContactLists table.
CreatedBy String The CreatedBy column of the ContactLists table.
CreatedTimestamp Datetime The CreatedTimestamp column of the ContactLists table.
FirstName String The FirstName column of the ContactLists table.
Form String The Form column of the ContactLists table.
Ip4Sub String The Ip4Sub column of the ContactLists table.
Ip4Unsub String The Ip4Unsub column of the ContactLists table.
Ip4Last String The Ip4Last column of the ContactLists table.
LastName String The LastName column of the ContactLists table.
AutomationLink String The AutomationLink column of the ContactLists table.
AutosyncLogLink String The AutosyncLogLink column of the ContactLists table.
CampaignLink String The CampaignLink column of the ContactLists table.
ContactLink String The ContactLink column of the ContactLists table.
FormLink String The FormLink column of the ContactLists table.
ListLink String The ListLink column of the ContactLists table.
MessageLink String The MessageLink column of the ContactLists table.
UnsubscribeAutomationLink String The UnsubscribeAutomationLink column of the ContactLists table.
ListId String The ListId column of the ContactLists table.
Message String The Message column of the ContactLists table.
Responder String The Responder column of the ContactLists table.
Sdate Datetime The Sdate column of the ContactLists table.
SeriesId String The SeriesId column of the ContactLists table.
Status String The Status column of the ContactLists table.
SourceId String The SourceId column of the ContactLists table.
Sync String The Sync column of the ContactLists table.
Unsubreason String The Unsubreason column of the ContactLists table.
UnsubscribeAutomation String The UnsubscribeAutomation column of the ContactLists table.
UpdatedBy String The UpdatedBy column of the ContactLists table.
UpdatedTimestamp Datetime The UpdatedTimestamp column of the ContactLists table.

ActiveCampaign Connector for CData Sync

ContactTags

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

Name Type Description
Id [KEY] String The Id column of the ContactTags table.
ContactId String The ContactId column of the ContactTags table.
Cdate Datetime The Cdate column of the ContactTags table.
CreatedBy String The CreatedBy column of the ContactTags table.
CreatedTimestamp Datetime The CreatedTimestamp column of the ContactTags table.
ContactLink String The ContactLink column of the ContactTags table.
TagLink String The TagLink column of the ContactTags table.
Tag String The Tag column of the ContactTags table.
UpdatedBy String The UpdatedBy column of the ContactTags table.
UpdatedTimestamp Datetime The UpdatedTimestamp column of the ContactTags table.

ActiveCampaign Connector for CData Sync

DealActivities

Retrieve Deal Activities for each Deal or for the specific Deal Id.

Columns

Name Type Description
Id [KEY] String The Id of the activity.
DealId String The Id of the Deal to which the activity belongs to.
StageId String The Id of the Stage to which the parent Deal of the activity belongs to.
UserId String The Id of the User which triggered the activity.
DataId String The Id for the related object (e.g. a Task or Note or similar), if relevant.
DataType String The type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation.
DataAction String The action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing.
DataOldVal String The previous value, if the value has changed (see DataAction); otherwise, empty quotes ('')
CreatedDate Datetime The creation date of the activity.
SortDate Datetime
IsAddTask Boolean Indicates whether the activity was adding a task to the deal.
Deleted Boolean Indicates whethere the activity was deleted or not.
SeriesId String
DealLink String The API endpoint to the Deal related to this activity.
StageLink String The API endpoint to the Stage related to this activity.
UserLink String The API endpoint to the User related to this activity.
AutomationLink String The API endpoint to the Automation related to this activity.
ActivityLink String The API endpoint to the Activity.
Deal String The related to this Activity.
Stage String The Stage column of the DealActivities table.
User String The User column of the DealActivities table.
Automation String The Automation which triggered this activity.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Exclude String Include this param to exclude 'email', 'connection_email', and 'LinkData' activity types.

使用できる値は次のとおりです。email

ActiveCampaign Connector for CData Sync

Lists

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

Name Type Description
Id [KEY] String The Id column of the Lists table.
AnalyticsDomains String The AnalyticsDomains column of the Lists table.
AnalyticsSource String The AnalyticsSource column of the Lists table.
AnalyticsUa String The AnalyticsUa column of the Lists table.
CarbonCopy String The CarbonCopy column of the Lists table.
Cdate Datetime The Cdate column of the Lists table.
Udate Datetime The Udate column of the Lists table.
DeleteStamp String The DeleteStamp column of the Lists table.
FacebookSession String The FacebookSession column of the Lists table.
FullAddress String The FullAddress column of the Lists table.
UnsubscribeReason String The UnsubscribeReason column of the Lists table.
AddressListsLink String The AddressListsLink column of the Lists table.
ContactGoalListsLink String The ContactGoalListsLink column of the Lists table.
UserLink String The UserLink column of the Lists table.
Name String The Name column of the Lists table.
OptinMessageId String The OptinMessageId column of the Lists table.
OptinOptout String The OptinOptout column of the Lists table.
OptoutConf String The OptoutConf column of the Lists table.
EmbedImage String The EmbedImage column of the Lists table.
UseAnalyticsLink String The UseAnalyticsLink column of the Lists table.
UseAnalyticsRead String The UseAnalyticsRead column of the Lists table.
UseCaptcha String The UseCaptcha column of the Lists table.
UseFacebook String The UseFacebook column of the Lists table.
UseTracking String The UseTracking column of the Lists table.
UseTwitter String The UseTwitter column of the Lists table.
Private String The Private column of the Lists table.
RequireName String The RequireName column of the Lists table.
SendLastBroadcast String The SendLastBroadcast column of the Lists table.
SenderAddr1 String The SenderAddr1 column of the Lists table.
SenderAddr2 String The SenderAddr2 column of the Lists table.
SenderCity String The SenderCity column of the Lists table.
SenderCountry String The SenderCountry column of the Lists table.
SenderName String The SenderName column of the Lists table.
SenderPhone String The SenderPhone column of the Lists table.
SenderReminder String The SenderReminder column of the Lists table.
SenderState String The SenderState column of the Lists table.
SenderUrl String The SenderUrl column of the Lists table.
SenderZip String The SenderZip column of the Lists table.
StringId String The StringId column of the Lists table.
SubscriptionNotify String The SubscriptionNotify column of the Lists table.
ToName String The ToName column of the Lists table.
TwitterToken String The TwitterToken column of the Lists table.
TwitterTokenSecret String The TwitterTokenSecret column of the Lists table.
UnsubscriptionNotify String The UnsubscriptionNotify column of the Lists table.
ListsUser String The ListsUser column of the Lists table.
ListsUserid String The ListsUserid column of the Lists table.

ActiveCampaign Connector for CData Sync

Scores

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

Name Type Description
Id String The Id column of the Scores table.
Cdate Datetime The Cdate column of the Scores table.
Descript String The Descript column of the Scores table.
Mdate Datetime The Mdate column of the Scores table.
Name String The Name column of the Scores table.
RelType String The RelType column of the Scores table.
Status String The Status column of the Scores table.

ActiveCampaign Connector for CData Sync

Tags

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

Name Type Description
Id [KEY] String The Id column of the Tags table.
Tag String The Tag column of the Tags table.
TagType String The TagType column of the Tags table.
Description String The Description column of the Tags table.
Cdate Datetime The Cdate column of the Tags table.
ContactGoalTagsLink String The ContactGoalTagsLink column of the Tags table.

ActiveCampaign Connector for CData Sync

TrackingLogs

Retrieve trackingLogs for the specific contact or all contacts

Columns

Name Type Description
Id [KEY] String The Id column of the TrackingLogs table.
ContactId String The ContactId column of the TrackingLogs table.
Hash String The Hash column of the TrackingLogs table.
ContactLink String The ContactLink column of the TrackingLogs table.
SubscriberidLink String The SubscriberidLink column of the TrackingLogs table.
TstampLink Datetime The TstampLink column of the TrackingLogs table.
TypeLink String The TypeLink column of the TrackingLogs table.
ValueLink String The ValueLink column of the TrackingLogs table.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UDateLink Datetime

ActiveCampaign Connector for CData Sync

Users

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

Name Type Description
Id String The Id column of the Users table.
Email String The Email column of the Users table.
FirstName String The FirstName column of the Users table.
LastName String The LastName column of the Users table.
ConfigsLink String The ConfigsLinks column of the Users table.
DealGroupTotalsLink String The DealGroupTotalsLink column of the Users table.
DealGroupUsersLink String The DealGroupUsersLink column of the Users table.
ListsLink String The ListsLink column of the Users table.
UserGroupLink String The UserGroupLink column of the Users table.
Phone Unknown The Phone column of the Users table.
Signature Unknown The Signature column of the Users table.
Username String The Username column of the Users table.

ActiveCampaign Connector for CData Sync

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ説明
APIKeyThe APIKey obtained from the ActiveCampaign UI.
URLBase URL which is used to access the API.

SSL

プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ説明
LogModulesログファイルに含めるコアモジュール。

Schema

プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ説明
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeThe maximum number of results to return per page from ActiveCampaign.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ActiveCampaign Connector for CData Sync

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ説明
APIKeyThe APIKey obtained from the ActiveCampaign UI.
URLBase URL which is used to access the API.
ActiveCampaign Connector for CData Sync

APIKey

The APIKey obtained from the ActiveCampaign UI.

解説

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.

ActiveCampaign Connector for CData Sync

URL

Base URL which is used to access the API.

解説

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

ActiveCampaign Connector for CData Sync

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
ActiveCampaign Connector for CData Sync

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明 例
フルPEM 証明書（例では省略されています） -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵（例では省略されています） -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り） ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り） 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

ActiveCampaign Connector for CData Sync

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。
ActiveCampaign Connector for CData Sync

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ デフォルトポート 説明
TUNNEL 80 これが設定されている場合、Sync App はActiveCampaign への接続を開き、プロキシを経由して通信が行われます。
SOCKS4 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ActiveCampaign Connector for CData Sync

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

ActiveCampaign Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

ActiveCampaign Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

ActiveCampaign Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

ActiveCampaign Connector for CData Sync

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ActiveCampaign Connector for CData Sync

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ActiveCampaign Connector for CData Sync

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ActiveCampaign Connector for CData Sync

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ActiveCampaign Connector for CData Sync

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

  • BASIC： Sync App はHTTP BASIC 認証を行います。
  • DIGEST： Sync App はHTTP DIGEST 認証を行います。
  • NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ActiveCampaign Connector for CData Sync

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。 

user@domain
domain\user

ActiveCampaign Connector for CData Sync

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ActiveCampaign Connector for CData Sync

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTOデフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ActiveCampaign Connector for CData Sync

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

ActiveCampaign Connector for CData Sync

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ説明
LogModulesログファイルに含めるコアモジュール。
ActiveCampaign Connector for CData Sync

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

ActiveCampaign Connector for CData Sync

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ActiveCampaign Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\ActiveCampaign Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

Platform %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

ActiveCampaign Connector for CData Sync

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

ActiveCampaign Connector for CData Sync

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

ActiveCampaign Connector for CData Sync

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

ActiveCampaign Connector for CData Sync

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ説明
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeThe maximum number of results to return per page from ActiveCampaign.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ActiveCampaign Connector for CData Sync

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

ActiveCampaign Connector for CData Sync

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

ActiveCampaign Connector for CData Sync

Pagesize

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

解説

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.

ActiveCampaign Connector for CData Sync

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

ActiveCampaign Connector for CData Sync

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

ActiveCampaign Connector for CData Sync

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

  • 各ルートエレメントはビューの名前を定義します。
  • 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。 

{
	"MyView": {
		"query": "SELECT * FROM Contacts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。 
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
指定されたパスは引用符で囲まれていないことに注意してください。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839