このページでは、CData Cloud でのAct-On への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Act-On への接続

接続の確立 は、CData Cloud にデータベースを作成するためのAct-On への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してAct-On からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Act-On に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Act-On への認証

Act-On はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムアプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成 を参照してください。

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。

次の接続プロパティを設定して、接続してください。

• OAuthClientId：（カスタムアプリケーションのみ）アプリケーション設定のクライアントID に設定。
• OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーション設定のクライアントシークレットに設定。

接続すると、Cloud はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。以下のようにCloud がOAuth プロセスを完了します。

Web アプリケーション

Web アプリケーション経由で接続する場合は、Act-On にカスタムOAuth アプリケーションを登録する必要があります。詳しくは、カスタムOAuth アプリの作成 を参照してください。その後、ドライバーを使用してOAuth トークンの値を取得および管理します。

初めに、次の接続プロパティを設定してOAuthAccessToken を取得します。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。必要に応じて、Scope パラメータを設定してカスタム権限をリクエストします。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Scope パラメータを設定してカスタム権限をリクエストします。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
• OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
• OAuthSettingsLocation：Cloud がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。

次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

1. 以下のオプションから選択します。
   • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
   • オプション2：ブラウザに対応したマシンにCloud をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにCloud を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

1. 以下のオプションから選択します。
   • 埋め込みOAuth アプリケーションを使用する場合は、Act-On OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
   • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
     • InitiateOAuth：OFF に設定。
     • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
     • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
     次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

2. ログインして、Cloud にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

• InitiateOAuth：REFRESH に設定。
• OAuthVerifier：verifier code に設定。
• OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
• OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がCloud に読み書きのアクセス許可を与えることを確認してください。

パスワードグラント認証

ユーザーとアプリケーションの間に信頼関係がある場合、ユーザーはPassword グラントタイプを使用して、デスクトップアプリケーションまたはWeb のどちらからでも認証できます。 この認証スキームを有効にするには、AuthScheme をOAuthPassword に設定します。

パスワードグラントによる認証は、OAuth に似ています。実際、カスタムOAuth アプリの作成 で説明するようにカスタムOAuth アプリケーションを設定済みであることが必要です。しかし、一度設定すれば、ユーザーの操作は必要ありません。

接続すには、次のプロパティを設定します。

• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換や、手動での接続文字列のアクセストークン設定の繰り返しを避けられます。
• AuthScheme：パスワードグラント種別で認証を行う場合は、AuthScheme をOAuthPassword に設定します。
• User：カスタムOAuth アプリケーションで指定されたユーザーのUsername。
• Password：カスタムOAuth アプリケーションで指定されたユーザーのPassword。
• OAuthClientId：カスタムOAuth アプリケーションで指定されたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションで指定されたクライアントシークレット。

When to Create a Custom OAuth App

CData embeds OAuth Application Credentials with CData branding that can be used when connecting via either a Desktop Application or from a Headless Machine. Creating a custom OAuth application is, however, required when using a web application.

You may choose to create your own OAuth Application Credentials when you want to

• control branding of the Authentication Dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

Follow the steps below to create a custom OAuth app and obtain the connection properties in a specific OAuth authentication flow.

Create a Custom OAuth App: Desktop

Sign up to https://developer.act-on.com/provision/. After registering your account on Act-On you will get an email with the following connection properties:

• OAuthClientId
• OAuthClientSecret

The default value for the callback URL is http://localhost:80. If you would like to change it you need to contact the API support for Act-On.

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud は、Act-On API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
Lists in Act-On are exposed as views with the convention List_ListName. For each list there is another view List_ListName_Score where you can see the score of the people in the list.
Same logic for Segments in Act-On, they are exposed as views as Segment_SegmentName. And have an equivalent view Segment_SegmentName_Score.
Any changes you make to your Act-On account, such as adding a new list, adding new columns, or changing the data type of a column, will immediately be reflected
when you connect using the driver.

クエリ処理の使用

Cloud は、Act-On API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをCloud 内で処理します。次のセクションでは、API の制限と要件を説明します。

ビュー

ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

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

CData Cloud - Act-On テーブル

Name	Description
List_MyList	Create, update, delete, and query records of a List.
Optout	Upsert, delete and query records of a Optout list.

Create, update, delete, and query records of a List.

Table Specific Information

Every list that is created in your Act-On account is represented by a new table that is dynamically retrieved from your Act-On account. The name of the table has the following format:

List_nameOfTheList

For example, if the list in the Act-On UI is called 'MyList', the name of the table in the driver would be 'List_MyList'.

This is an example on how a list is exposed as table.

Select

Query records of the specified table.:

SELECT * FROM [List_MyList]

INSERT

Create a new record in the table.

Note: The ListId is required to insert a new record into a table.

All the fields that are not read-only can be specified.

INSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('John', 'Doe', '[email protected]', 'l-000d')

Update

Update details of a specific record.

Note: To update a record from a table, the ListId and E-mail Address must be specified.

All the fields that are not read-only can be specified.

UPDATE [List_MyList] SET [First Name] = 'Mohit', [Last Name] = 'Chaturvedi', [E-mail Address] = '[email protected]' WHERE [ListId] = 'l-000d' AND [E-mail Address] = '[email protected]'

Upsert

Update details of a specific record if it exists, else will insert a new record.

Note: To upsert a record from a table, the ListId and E-mail Address must be specified.

All the fields that are not read-only can be specified.

UPSERT INTO [List_MyList] ([First Name], [Last Name], [E-mail Address], [ListId]) VALUES ('Shubham', 'Prakash', '[email protected]', 'l-000a')

Delete

Delete a record of a table.

Note: To Delete a record the ListId and _contact_id_ must be specified.

All the fields that are not read-only can be specified.

DELETE FROM List_MyList WHERE [ListId] = 'l-000d' AND [_contact_id_] = 'l-000d:10'

Columns

Name	Type	ReadOnly	Description
_contact_id_ [KEY]	String	False	The _contact_id_ of the List_MyList.
First Name	String	False	The First Name of the List_MyList.
Last Name	String	False	The Last Name of the List_MyList.
E-mail Address	String	False	The E-mail Address of the List_MyList.
_FORM	String	False	The _FORM of the List_MyList.
_CAMPAIGN	String	False	The _CAMPAIGN of the List_MyList.
_IPADDR	String	False	The _IPADDR of the List_MyList.
_BROWSER	String	False	The _BROWSER of the List_MyList.
_JSTZO	String	False	The _JSTZO of the List_MyList.
_TIME	String	False	The _TIME of the List_MyList.
_REFERRER	String	False	The _REFERRER of the List_MyList.
_EMAIL_REFERRER	String	False	The _EMAIL_REFERRER of the List_MyList.
_FORM_URL	String	False	The _FORM_URL of the List_MyList.
_SEARCH	String	False	The _SEARCH of the List_MyList.
_GEO_NAME	String	False	The _GEO_NAME of the List_MyList.
_GEO_COUNTRY_CODE	String	False	The _GEO_COUNTRY_CODE of the List_MyList.
_GEO_COUNTRY	String	False	The _GEO_COUNTRY of the List_MyList.
_GEO_STATE	String	False	The _GEO_STATE of the List_MyList.
_GEO_CITY	String	False	The _GEO_CITY of the List_MyList.
_GEO_POSTAL_CODE	String	False	The _GEO_POSTAL_CODE of the List_MyList.
__created_date	Datetime	False	The __created_date of the List_MyList.
__modified_date	Datetime	False	The __modified_date of the List_MyList.
ListId	String	False	The ListId of the List_MyList.

Upsert, delete and query records of a Optout list.

Table Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Optout WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Optout WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Upsert

Upsert can be executed by specifying the Email column. Following is an example of how to insert a single email into this table

UPSERT INTO Optout(Email) VALUES ('[email protected]')

Multiple emails can also be added or updated. Following is an example of how to insert multiple emails into this table

UPSERT INTO Optout(Email) VALUES ('[email protected];[email protected]')

DELETE

Delete can be executed by specifying the Email column in the WHERE Clause. Following is an example of how to delete a single email from this table

DELETE FROM Optout WHERE Email = '[email protected]'

Multiple emails can also be deleted. Following is an example of how to delete multiple emails into this table

DELETE FROM Optout WHERE Email = '[email protected];[email protected]'

Columns

Name	Type	ReadOnly	Description
Email	String	False	Email of the user.
Origin	String	True	Origin.
Timestamp	Timestamp	True	When the user joined the list.

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

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

CData Cloud - Act-On ビュー

Name	Description
Campaigns	Query the available campaigns ActOn.
Categories	Query the available categories of subscription in ActOn.
DrilldownReports	Query detailed reports about messages in ActOn.
Hardbounce	Query records of a Hardbounce list.
Images	Query the available images on your ActOn account.
Media	Query the available media on your ActOn account.
Messages	Query the available messages in ActOn.
OtherLists	Query the hardbounce, spam complaint and optout lists on ActOn. This view has been deprecated.
Programs	Query the available programs on ActOn.
Reports	Query the available reports in ActOn.
ReportsByPeriod	Query the reports related to messages in ActOn.
ScoreDetails	Query the score details of a contact.
Spamcomplaint	Query records of a Spamcomplaint list.
SubscriptionOptOuts	Query the available subscriptions in ActOn.
Users	Query the email senders for the current account in ActOn.

Query the available campaigns ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Id supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Campaigns WHERE Id = 0001
SELECT * FROM Campaigns WHERE Id IN (0001, 0002)

Columns

Name	Type	Description
Id [KEY]	String	The Id of the campaign.
Name	String	The name of the campaign.
Created	Datetime	When the campaign was created.
AssetIds	String	Asset ids of the campaigns.
Description	String	Description of the campaign.
Modified	Datetime	When the campaign was last modified.
Urls	String	Urls related to the campaign.

Query the available categories of subscription in ActOn.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
Id [KEY]	String	The Id of the category.
Name	String	The name of the category.
Description	String	Description of the category.
HeaderId	String	Header id.
HeaderName	String	Header name.

Query detailed reports about messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• MessageId supports the '=' operator.
• Drilldown supports the '=' operator.

MessageId and Drilldown are required to select from this view and will be filtered by the Act-On API.

SELECT * FROM DrilldownReports WHERE MessageId = 's-0003-1803' AND Drilldown = 'SENT'

Columns

Name	Type	Description
MessageId	String	The id of the message.
Drilldown	String	Type of message. 使用できる値は次のとおりです。SENT, SUPPRESSED, OPENED, CLICKED, BOUNCED, OPT_OUT, SPAM
Email	String	The receiver email.
Name	String	Name of the receiver.
ListId	String	Id of the list the receiver belongs to.
RecId	String	The id of the receiver.
Timestamp	Datetime	When the message was sent.

Query records of a Hardbounce list.

View Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Hardbounce WHERE Timestamp >= '2022-09-15 08:53:50.111' AND  Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Hardbounce WHERE Timestamp > '2022-09-15 08:53:50.111' AND  Timestamp < '2022-09-16 00:30:33.14'

Columns

Name	Type	Description
Email	String	Email of the user.
Origin	String	Origin.
Timestamp	Timestamp	When the user joined the list.

Query the available images on your ActOn account.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• FolderName supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Images WHERE FolderName = 'New Folder'
SELECT Name, FolderName FROM Images WHERE FolderName IN ('New Folder', 'Default Folder')

Columns

Name	Type	Description
Id [KEY]	String	Id of the image.
FolderName	String	Name of the folder that contains the image.
Name	String	Name of the image.
CreationTime	Datetime	When the image was created.
LastModified	Datetime	When the image was last modified.
ImageUrl	String	Link to the image.
ThumbUrl	String	Link to the image.
Size	Int	Size of the image.

Pseudo-Columns

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

Name	Type	Description
Type	String	Identifier for the next page of results. Do not set this value manually.

Query the available media on your ActOn account.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
Id [KEY]	String	Id of the image.
FolderName	String	Name of the folder that contains the image.
Name	String	Name of the image.
CreationTime	Datetime	When the image was created.
LastModified	Datetime	When the image was last modified.
Url	String	Link to the media.
Size	Int	Size of the image.

Query the available messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '='operator.

For example, the following query is processed server side:

SELECT * FROM Messages WHERE Type = 'SENT'

Type can be one of: SENT, DRAFT, TEMPLATE, TRIGGERED, FAILED, SCHEDULED

Columns

Name	Type	Description
Id [KEY]	String	The Id of the message.
Timestamp	Datetime	When the message has been sent.
Title	String	Title of the message.
FolderName	String	The folder where the message is contained.

Pseudo-Columns

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

Name	Type	Description
Type	String	Used as a filter to retrieve different types of messages. 使用できる値は次のとおりです。SENT, DRAFT, TEMPLATE, TRIGGERED, FAILED, SCHEDULED

Query the hardbounce, spam complaint and optout lists on ActOn. This view has been deprecated.

View Specific Information

To query data from this view, you must specify Type.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '=' operator.
• CreatedAfter supports the '=' operator.
• CreatedBefore supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM [OtherLists] WHERE Type = 'OPTOUT'
SELECT * FROM [OtherLists] WHERE Type = 'OPTOUT' AND CreatedAfter = '2018-08-28T14:37:48.923+02:00' AND CreatedBefore = '2018-08-28T14:37:48.925+02:00'
SELECT * FROM [OtherLists] WHERE Type = 'HARDBOUNCE' AND CreatedBefore = '2019-09-28T14:39:48.924+02:00'

Columns

Name	Type	Description
Email	String	Email of the user.
Timestamp	Datetime	When the user joined the list.
Origin	String
Type	String	The type of list. 使用できる値は次のとおりです。HARDBOUNCE, SPAMCOMPLAINT, OPTOUT

Pseudo-Columns

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

Name	Type	Description
CreatedBefore	String	Only records created before the supplied value will be returned.
CreatedAfter	String	Only records created after the supplied value will be returned.

Query the available programs on ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Type supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Programs WHERE Type = 'RACK'

Columns

Name	Type	Description
Id [KEY]	String	The id of the program.
Name	String	The name of the program.
IsFavorite	Bool	Flag denoting if the program is among the 'favorite' ones.
Description	String	The description of the program.
SrcIds	String	Ids of the lists involved in the program.
SrcNames	String	Name of the lists involved in the program.
MessageIds	String	Ids of the messages sent within the program.
Created	Datetime	When the program was created.
Modified	Datetime	When the program was last modified.
NextRun	Datetime	When the program is going to run again.
State	String	The state of the program.
Running	Bool	Flag denoting if the program is running or not.
Active	Int	Flag denoting if the program is active or not.
Scheduled	Bool	Flag denoting if the program is scheduled or not.
TagNames	String	List of tags related to the program.
Valid	Bool	Flag denoting if the program is valid or not.

Pseudo-Columns

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

Name	Type	Description
Type	String	Type of the program, used for filtering. 使用できる値は次のとおりです。RACK, EVENT, LIST_MAINT

Query the available reports in ActOn.

View Specific Information

To query data from this view, you must specify MessageId.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• MessageId supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM Reports WHERE MessageId = 'd-0008'
SELECT * FROM Reports WHERE MessageId IN ('d-0008', 's-0004-1809')

Columns

Name	Type	Description
MessageId [KEY]	String	The Id of the message.
Title	String	The title of the message.
Status	String	The status of the message.
Bounced	Int	The number of times the message generated a bounce.
Clicked	String	The number of times the message has been clicked.
Delivered	Int	The number of times the message has been delivered.
EffectiveOpened	String	.
HardBounced	Int	The number of times the message generated hard bounce.
LastClick	Datetime	The timestamp of the last click.
LastOpen	Datetime	The timestamp of the last opening.
NotOpened	Int	The number of times the message has not been opened.
NotSent	String	The number of times the message has not been sent.
Opened	String	The number of times the message was opened.
OptOut	Int	The number of times the receiver opted out.
RedbroadcastClick	Int	.
Sent	Int	The number of times the message has been sent.
SentTo	String	The ids of the people who received the email.
SoftBounced	Int	The number of times the message generated soft bounce.
Spam	Int	The number of times has been considered as spam.
Subject	String	The subject of the message.
SuppressedOn	String	.

Query the reports related to messages in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Period supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM ReportsByPeriod WHERE Period = 'January 2018'
SELECT * FROM ReportsByPeriod WHERE Period IN ('January 2018', 'March 2018')

If not specified, the period will be the current month.

Columns

Name	Type	Description
Period	String	The period defined in the format '{month} yyyy' used to filter the reports. If not specified, report for the current month will return.
DayOfMonth	Int	The day of the month the report is about.
DayOfWeek	Int	The day of the week the report is about.
Sent	Int	The number of sent messages.
Bounced	Int	The number of bounced messages.
Clicked	Int	The number of clicked messages.
Opened	Int	The number of opened messages.
OptedOut	Int	Th number of opted out.

Query the score details of a contact.

View Specific Information

To query data from this view, you must specify ContactId.
The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• ContactId supports the '=' and 'IN' operators.

For example, the following queries are processed server side:

SELECT * FROM ScoreDetails WHERE ContactId = 'l-0004:2'
SELECT * FROM ScoreDetails WHERE ContactId IN ('l-0004:2', 'l-0004:3')

Columns

Name	Type	Description
ContactId [KEY]	String	Unique identifier of the contact.
ActivityId	String	Unique identifier of the activity.
Action	String	Brief description of the action.
IdType	String	Type of the activity.
Profile	Boolean	Whether or not the user has a profile.
Score	Integer	Score of the activity.
Specific	Boolean	Whether or not the activity is specific.
Ago	Integer	Days ago that activity happened.
InScoreRange	Boolean	Whether or not the activity is in score range.
What	String	Object of the activity.
When	Datetime	When the activity happened.
Bin	String	Subject of the activity.
Verb	String	Description of the activity.

Query records of a Spamcomplaint list.

View Specific Information

Select

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Timestamp supports the '>=' , '>' , '<=' and '<' operator.

For example:

SELECT * FROM Spamcomplaint WHERE Timestamp >= '2022-09-15 08:53:50.111' AND Timestamp <= '2022-09-16 00:30:33.14'

SELECT * FROM Spamcomplaint WHERE Timestamp > '2022-09-15 08:53:50.111' AND Timestamp < '2022-09-16 00:30:33.14'

Columns

Name	Type	Description
Email	String	Email of the user.
Origin	String	Origin.
Timestamp	Timestamp	When the user joined the list.

Query the available subscriptions in ActOn.

View Specific Information

The Cloud will use the Act-On API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• Category supports the '=' operator.

Category is required to select from this view. For example, the following query is processed server side:

SELECT * FROM SubscriptionOptOuts WHERE Category = 'test'

Columns

Name	Type	Description
Email	String	The email of the subscribed user.
Timestamp	Datetime	The time when the user subscribed.
Category	String	The category of the subscription. This attribute is required for select operations.

Query the email senders for the current account in ActOn.

View Specific Information

Act-On does not support any column for filtering this view.

Columns

Name	Type	Description
UserId [KEY]	String	The universally unique identifier of the user.
Email	String	The email of the user.
Name	String	The name of the user.
Title	String	The title of the user.
Cell	String	The mobile phone of the user.
Phone	String	The phone number of the user.
Fax	String	The fax of the user.
isVerified	Bool	Flag denoting if the user has been verified or not.

ストアドプロシージャはファンクションライクなインターフェースで、Act-On の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAct-On から関連するレスポンスデータを返します。

CData Cloud - Act-On ストアドプロシージャ

Name	Description

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Act-On のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Images テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Images' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、RefreshOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

主キーおよび外部キーについて説明します。

次のクエリは、Images テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Images' 
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

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

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Act-On.
User	認証するAct-On ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Pagesize	Act-On から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
TypeDetectionScheme	Determines how to determine the data type of columns.

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

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Act-On.
User	認証するAct-On ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。

The type of authentication to use when connecting to Act-On.

Possible Values

OAuth, OAuthPassword

データ型

string

デフォルト値

"OAuth"

解説

• OAuth: Set this to perform OAuth with the code grant type.
• OAuthPassword: Set this to perform OAuth with the password grant type.

認証するAct-On ユーザーアカウントのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーアカウントのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

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

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

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

データ型

string

デフォルト値

""

解説

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

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

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

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

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

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

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

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

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Pagesize	Act-On から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
TypeDetectionScheme	Determines how to determine the data type of columns.

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Act-On から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

1000

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

データ型

int

デフォルト値

50

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Determines how to determine the data type of columns.

Possible Values

None, RowScan

データ型

string

デフォルト値

"RowScan"

解説

None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.