Act-On への接続を追加

Act-On への接続を追加するには：

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

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

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

Act-On への認証

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

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

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

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

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

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

接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。以下のようにSync App が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：Sync App が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：ブラウザに対応したマシンにSync App をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

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

オプション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. ログインして、Sync App にアクセス許可を与えます。すると、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 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がSync App に読み書きのアクセス許可を与えることを確認してください。

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

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

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

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

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

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

このセクションでは、Act-On Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Act-On にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

CData Sync App は、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.

クエリ処理の使用

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

ビュー

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

ストアドプロシージャ

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

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

Act-On Connector for CData Sync テーブル

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 Sync App 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 Sync App.

• 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.

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

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

Act-On Connector for CData Sync ビュー

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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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 Sync App 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 Sync App.

• 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.

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

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

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

---

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

Firewall

---

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

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名または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	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Act-On から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Determines how to determine the data type of columns.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

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

---

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

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

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

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

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

---

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

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

解説

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

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はAct-On への接続を開き、プロキシを経由して通信が行われます。
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 を使ってください。

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

解説

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

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

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

解説

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

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

解説

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

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

解説

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

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

---

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

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

解説

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

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

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

解説

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

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

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

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

解説

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

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 を参照してください。

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

解説

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

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

user@domain
domain\user

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 に設定します。

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	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

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

解説

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

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

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

---

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

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

解説

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

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

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

---

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

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

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

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

解説

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

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

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

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

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

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	Act-On から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Determines how to determine the data type of columns.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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

解説

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

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

解説

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

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

統合およびフォーマット

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

Act-On から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Act-On から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

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

解説

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

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

解説

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

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

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

解説

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

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

Determines how to determine the data type of columns.

解説

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.

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

解説

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

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

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

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

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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

指定されたパスは引用符で囲まれていないことに注意してください。