Domino Connector for CData Sync

Build 23.0.8920
  • Domino
    • 接続の確立
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • Account
        • Person
    • 接続文字列オプション
      • Authentication
        • URL
        • DatabaseScope
        • AuthScheme
        • User
        • Password
        • Scope
      • Azure Authentication
        • AzureTenant
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • TableTypes
        • UseDisplayNames
      • Miscellaneous
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • RowScanDepth
        • Timeout
        • TypeDetectionScheme
        • UserDefinedViews
        • UseSimpleNames

Domino Connector for CData Sync

概要

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

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

Domino バージョンサポート

Sync App は、Domino REST API を利用してDomino 12以降をサポートします。

Domino Connector for CData Sync

接続の確立

Domino への接続を追加

Domino への接続を追加するには:

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

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

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

Domino への接続

次のプロパティを設定し、Domino データに接続します。
  • URL:Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例:http://sampleserver:1234/
  • DatabaseScope:Domino Web UI でのスコープ名。Sync App は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択します。このプロパティを既存のスコープ名に設定します。

Domino への認証

Domino は、ログイン資格情報またはAzure Active Directory OAuth アプリケーションによる認証をサポートしています。

ログイン資格情報

AuthScheme をOAuthPassword に設定し、以下のプロパティを設定します。
  • User:認証するDomino ユーザーのユーザー名。
  • Password:認証するDomino ユーザーに関連付けられたパスワード。

Sync App は、ログイン資格情報を使用して、OAuthトークン交換を自動で実行します。

AzureAD

この認証方法では、Azure Active Directory をIdP として使用し、JWT トークンを取得します。Azure Active Directory にカスタムOAuth アプリケーションを作成し、IdP として設定する必要があります。そのためには、こちらの手順に従います。

AuthScheme をAzureAD に設定し、以下のプロパティを設定します。

  • OAuthClientId:カスタムOAuth アプリケーションを設定する際に取得したClient ID。
  • OAuthClientSecret:カスタムOAuth アプリケーションを設定する際に取得したClient secret。
  • CallbackURL:アプリの登録時に定義されたリダイレクトURI。例:https://localhost:33333
  • AzureTenant:データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントId を指定します。
    • テナントId は、Azure ポータルのAzure Active Directory -> プロパティページに表示されるディレクトリId と同じものです。

Domino Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Domino Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

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

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

Domino Connector for CData Sync

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Domino Connector for CData Sync

データモデル

概要

Sync App は、Domino のフォームやビューに関連するノートを動的に取得し、それらをテーブルやビューとしてモデル化します。

Note: Sync App によって公開されるフォームとビューは、DatabaseScope で指定されたスコープによって管理されるスキーマで公開されるものに限定されます。

テーブル

Sync App は、テーブルとしてdqlモードを有効にしたDomino フォームをモデル化します。テーブルをクエリして、フォームに関連するノートを取得します。

Note: フォームを検出してクエリするには、TableTypes をForms に設定する必要があります。

利用可能なテーブルは、"sys_tables" システムテーブルをクエリすることでリストされます。

次に例を示します。

SELECT * FROM sys_tables WHERE TableName = 'Person'

ビュー

Sync App は、Domino ビューをビューとしてモデル化します。ビューをクエリして、ビューに関連するノートを取得します。

Note: ビューを検出してクエリするには、TableTypes をViews に設定する必要があります。

利用可能なビューは、"sys_tables" システムテーブルをクエリすることでリストされます。

次に例を示します。

SELECT * FROM sys_tables WHERE TableName = '($Account)'

カラム

テーブルおよびビューで利用可能なカラムは、"sys_tablecolumns" システムテーブルをクエリすることでリストされます。

次に例を示します。

SELECT * FROM sys_tablecolumns WHERE TableName = 'Person'

ストアドプロシージャ

ストアドプロシージャは、Domino に対して関数のような操作を実行できます。

例えば、添付ファイルはDownloadAttachment、UploadAttachment、およびRemoveAttachment ストアドプロシージャを介して操作できます。

ノートのメタデータ

Domino は、各ノートに定義された項目に加え、サーバー上のすべてのデータベースで特定のノートを識別する一意のノート識別子であるunid を公開します。これは、すべてのテーブルおよびビューで使用できます。

メタデータ表示設定

Sync App は、テーブル、ビューおよびカラムの命名規則を制御するオプションに対応しています。

デフォルトでは、UseDisplayNames はtrue に設定され、Sync App はカラムラベルをビューのカラム名として使用します。UseDisplayNames をfalse に設定すると、Sync App はビューのカラムの内部名を表示します。

UseSimpleNames を有効にすると、テーブル名とカラム名に英数字とアンダースコアのみが表示される命名スキームが強制されます。英数字以外の文字はアンダースコアに置き換えられます。

Null 値

Domino にはSQL のNULL 値に直接相当するものはありません。Sync App は、次のシナリオでカラムのNULL 値を返します。

  • ノートに項目が設定されていない場合。Domino の式では、これは@IsAvailable(item) = 0 に相当します。
  • ノート上の単一値項目が空のテキスト値である場合。Domino の式では、これは@IsNull(item) = 1 に相当します。 ここで、単一値項目とは、タイプの検出時にSync App が複数値エントリを見つけられなかった基本テーブルまたはビューの項目です。

Domino Connector for CData Sync

テーブル

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

Domino Connector for CData Sync テーブル

Name Description
Account The notes visible within Account
Person The notes visible within Person

Domino Connector for CData Sync

Account

The notes visible within Account

Columns

Name Type ReadOnly Description
unid [KEY] String False

The unid of the Account table.

$FILES String False

The $FILES of the Account table.

AccountAuthor String False

The AccountAuthor of the Account table.

AccountDesc String False

The AccountDesc of the Account table.

AccountFilename String False

The AccountFilename of the Account table.

AccountFileRt String False

The AccountFileRt of the Account table.

AccountLocation String False

The AccountLocation of the Account table.

AccountLoginHelpText String False

The AccountLoginHelpText of the Account table.

AccountLoginName String False

The AccountLoginName of the Account table.

AccountName String False

The AccountName of the Account table.

AccountPassword String False

The AccountPassword of the Account table.

AccountPortNumber Float False

The AccountPortNumber of the Account table.

AccountProtocol String False

The AccountProtocol of the Account table.

AccountReplicationHistory String False

The AccountReplicationHistory of the Account table.

AccountReplicationMaxPull Float False

The AccountReplicationMaxPull of the Account table.

AccountServer String False

The AccountServer of the Account table.

AccountServer$ED String False

The AccountServer$ED of the Account table.

AccountService_ID String False

The AccountService_ID of the Account table.

AccountType String False

The AccountType of the Account table.

allowsharing String False

The allowsharing of the Account table.

authserver String False

The authserver of the Account table.

authserver$ED String False

The authserver$ED of the Account table.

authtype String False

The authtype of the Account table.

authtype$ED String False

The authtype$ED of the Account table.

ConnDispName String False

The ConnDispName of the Account table.

ConnDispName$ED String False

The ConnDispName$ED of the Account table.

connectionType String False

The connectionType of the Account table.

connectionType$ED String False

The connectionType$ED of the Account table.

connectionTypeInput String False

The connectionTypeInput of the Account table.

CSRF_Url String False

The CSRF_Url of the Account table.

DisplayName String False

The DisplayName of the Account table.

dominosso String False

The dominosso of the Account table.

dominossoserver String False

The dominossoserver of the Account table.

EditableList String False

The EditableList of the Account table.

FormFieldsList String False

The FormFieldsList of the Account table.

IMAPDeleteMail String False

The IMAPDeleteMail of the Account table.

INIFlg String False

The INIFlg of the Account table.

InternetFilter String False

The InternetFilter of the Account table.

IS_CLOUD_ACCOUNT Float False

The IS_CLOUD_ACCOUNT of the Account table.

IS_CSRFTOKEN_REQUIRED String False

The IS_CSRFTOKEN_REQUIRED of the Account table.

IS_GLOBAL_ACCOUNT Float False

The IS_GLOBAL_ACCOUNT of the Account table.

IS_SERVER_MANAGED Float False

The IS_SERVER_MANAGED of the Account table.

isPrimaryAccount String False

The isPrimaryAccount of the Account table.

keepAliveInterval Float False

The keepAliveInterval of the Account table.

keepAliveInterval$ED String False

The keepAliveInterval$ED of the Account table.

loginAtStartup String False

The loginAtStartup of the Account table.

loginAtStartup$ED String False

The loginAtStartup$ED of the Account table.

loginByToken String False

The loginByToken of the Account table.

loginByToken$ED String False

The loginByToken$ED of the Account table.

personalizedHome String False

The personalizedHome of the Account table.

port Float False

The port of the Account table.

port$ED String False

The port$ED of the Account table.

Properties String False

The Properties of the Account table.

proxyHost String False

The proxyHost of the Account table.

proxyPort Float False

The proxyPort of the Account table.

proxyResolvesLocally String False

The proxyResolvesLocally of the Account table.

proxyType String False

The proxyType of the Account table.

requireSSL String False

The requireSSL of the Account table.

requireSSL$ED String False

The requireSSL$ED of the Account table.

requireTrustedSites String False

The requireTrustedSites of the Account table.

requireTrustedSites$ED String False

The requireTrustedSites$ED of the Account table.

resolveLivenames String False

The resolveLivenames of the Account table.

resolveLivenames$ED String False

The resolveLivenames$ED of the Account table.

samlAcctName String False

The samlAcctName of the Account table.

sendKeepAlive String False

The sendKeepAlive of the Account table.

sendKeepAlive$ED String False

The sendKeepAlive$ED of the Account table.

ServerCopyModTime Datetime False

The ServerCopyModTime of the Account table.

ServerCopyUnid String False

The ServerCopyUnid of the Account table.

SSLExpiredCerts String False

The SSLExpiredCerts of the Account table.

SSLLDAPSASL String False

The SSLLDAPSASL of the Account table.

SSLSendCertificates String False

The SSLSendCertificates of the Account table.

SSLServerAuthenticate String False

The SSLServerAuthenticate of the Account table.

SSLSiteCerts String False

The SSLSiteCerts of the Account table.

SSLStatus String False

The SSLStatus of the Account table.

SSOCredentialID String False

The SSOCredentialID of the Account table.

stIcon String False

The stIcon of the Account table.

stIcon$ED String False

The stIcon$ED of the Account table.

Type String False

The Type of the Account table.

useGlobalConnSettings String False

The useGlobalConnSettings of the Account table.

useGlobalConnSettings$ED String False

The useGlobalConnSettings$ED of the Account table.

UserName$ED String False

The UserName$ED of the Account table.

useServerForLookup String False

The useServerForLookup of the Account table.

useServerForLookup$ED String False

The useServerForLookup$ED of the Account table.

Domino Connector for CData Sync

Person

The notes visible within Person

Columns

Name Type ReadOnly Description
unid [KEY] String False

The unid of the Person table.

$FILES String False

The $FILES of the Person table.

$Group_Main Float False

The $Group_Main of the Person table.

BooleanField Bool False

The BooleanField of the Person table.

City String False

The City of the Person table.

CompanyName String False

The CompanyName of the Person table.

DateField Date False

The DateField of the Person table.

DateTimeField Datetime False

The DateTimeField of the Person table.

Department String False

The Department of the Person table.

DisplayMailAddress String False

The DisplayMailAddress of the Person table.

DisplayName String False

The DisplayName of the Person table.

DoubleField Double False

The DoubleField of the Person table.

EmployeeID Int False

The EmployeeID of the Person table.

FirstName String False

The FirstName of the Person table.

FullName String False

The FullName of the Person table.

GroupTitle String False

The GroupTitle of the Person table.

GroupType String False

The GroupType of the Person table.

JobTitle String False

The JobTitle of the Person table.

LastName String False

The LastName of the Person table.

ListName String False

The ListName of the Person table.

Location String False

The Location of the Person table.

MailServer String False

The MailServer of the Person table.

Members String False

The Members of the Person table.

Title String False

The Title of the Person table.

Type String False

The Type of the Person table.

Domino Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
URLSet this to the URL of the server where your Domino instance is hosted.
DatabaseScopeThe name of a Domino scope from the Domino Web UI's Scopes page. The provider exposes forms and views for the schema governed by the specified scope.
AuthSchemeThe type of authentication to use when connecting to Domino.
User認証で使用されるDomino ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
ScopeSpace-separated list of Domino REST API data-access permissions, each prefixed with your Application ID URI.

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

OAuth


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

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 です。
TableTypesChoose whether Domino forms or Domino views are exposed by the provider.
UseDisplayNamesIf true, the display names for view columns are shown instead of their internal names.

Miscellaneous


プロパティ説明
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeDomino から返されるページあたりの結果の最大数。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepthSet this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionSchemeDetermines how to determine the data type of columns.
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Domino Connector for CData Sync

Authentication

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


プロパティ説明
URLSet this to the URL of the server where your Domino instance is hosted.
DatabaseScopeThe name of a Domino scope from the Domino Web UI's Scopes page. The provider exposes forms and views for the schema governed by the specified scope.
AuthSchemeThe type of authentication to use when connecting to Domino.
User認証で使用されるDomino ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
ScopeSpace-separated list of Domino REST API data-access permissions, each prefixed with your Application ID URI.
Domino Connector for CData Sync

URL

Set this to the URL of the server where your Domino instance is hosted.

解説

The port number can be specified as in the following: URL=http://10.0.2.15:8880;

Domino Connector for CData Sync

DatabaseScope

The name of a Domino scope from the Domino Web UI's Scopes page. The provider exposes forms and views for the schema governed by the specified scope.

解説

In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Domino Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Domino.

解説

  • OAuthPassword: This authentication method exchanges Domino user credentials for a JWT token. This method uses Domino's internal JWT provider.
  • AzureAD: This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. This method is used as an external JWT provider.

Domino Connector for CData Sync

User

認証で使用されるDomino ユーザーアカウント。

解説

このフィールドは、Password とともに、Domino サーバーに対して認証をするために使われます。

Domino Connector for CData Sync

Password

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

Domino Connector for CData Sync

Scope

Space-separated list of Domino REST API data-access permissions, each prefixed with your Application ID URI.

解説

初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。

You can find your Application ID URI on your Azure application's Expose an API page. See Domino's Scope Documentation for more information about he available scopes.

Domino Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
Domino Connector for CData Sync

AzureTenant

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は[Azure ポータル]->[Azure Active Directory]->[プロパティ]のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE(デフォルト)に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

Domino Connector for CData Sync

OAuth

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


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

OAuthClientId

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

解説

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

Domino Connector for CData Sync

OAuthClientSecret

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

解説

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

Domino Connector for CData Sync

SSL

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


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

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

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

Domino Connector for CData Sync

Firewall

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


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

FirewallType

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

解説

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

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

Domino Connector for CData Sync

FirewallServer

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

解説

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

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

Domino Connector for CData Sync

FirewallPort

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

解説

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

Domino Connector for CData Sync

FirewallUser

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

解説

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

Domino Connector for CData Sync

FirewallPassword

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

解説

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

Domino Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

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

解説

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

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

Domino Connector for CData Sync

ProxyServer

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

解説

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

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

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

Domino Connector for CData Sync

ProxyPort

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

解説

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

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

Domino Connector for CData Sync

ProxyUser

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

解説

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

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

user@domain
domain\user

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

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

Domino Connector for CData Sync

ProxyExceptions

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

解説

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

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

Domino Connector for CData Sync

Logging

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


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

LogModules

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

解説

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

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

Domino Connector for CData Sync

Schema

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


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
TableTypesChoose whether Domino forms or Domino views are exposed by the provider.
UseDisplayNamesIf true, the display names for view columns are shown instead of their internal names.
Domino Connector for CData Sync

Location

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

解説

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

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

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

Domino Connector for CData Sync

BrowsableSchemas

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

解説

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

Domino Connector for CData Sync

Tables

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

解説

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

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

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

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

Domino Connector for CData Sync

Views

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

解説

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

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

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

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

Domino Connector for CData Sync

TableTypes

Choose whether Domino forms or Domino views are exposed by the provider.

解説

When this property is set to Forms, the Sync App exposes Domino forms as SQL tables.

When this property is set to Views, the Sync App exposes Domino views as SQL views.

Domino Connector for CData Sync

UseDisplayNames

If true, the display names for view columns are shown instead of their internal names.

解説

By default, the Sync App will use column labels as the names for view columns. If this option is disabled, the Sync App will use internal names as the names for view columns instead. This can cause some columns computed using formulas to be reported with auto-generated names such as '$21'.

Domino Connector for CData Sync

Miscellaneous

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


プロパティ説明
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeDomino から返されるページあたりの結果の最大数。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepthSet this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionSchemeDetermines how to determine the data type of columns.
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Domino Connector for CData Sync

MaxRows

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

解説

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

Domino Connector for CData Sync

Other

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

解説

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

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

統合およびフォーマット

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

Domino Connector for CData Sync

Pagesize

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

解説

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

Domino Connector for CData Sync

PseudoColumns

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

解説

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

Domino Connector for CData Sync

RowScanDepth

Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.

解説

Determines the number of rows used to determine the column data types.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Domino Connector for CData Sync

Timeout

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

解説

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

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

Domino Connector for CData Sync

TypeDetectionScheme

Determines how to determine the data type of columns.

解説

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

Domino Connector for CData Sync

UserDefinedViews

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

解説

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

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

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

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

次に例を示します。

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

Domino Connector for CData Sync

UseSimpleNames

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

Domino テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。

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