接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
UseUAT | Whether the connection should be made to an ADP UAT account. |
MaskSensitiveData | To mask the sensitive data in the resultset. |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
OAuthExpiresIn | OAuth アクセストークンの有効期限(秒単位)。 |
OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。 |
プロパティ | 説明 |
SSLClientCert | The certificate provided by ADP during Registration. |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
ProxyPort | プロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
Logfile | ログファイルの名前と場所を指定するファイルパス。 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
LogModules | ログファイルに含めるコアモジュール。 |
MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
BatchSize | 送信する各バッチ処理の最大サイズ。 |
ConnectionLifeTime | 接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。 |
ConnectOnOpen | このプロパティは、接続が開かれたときにADP に接続するかどうかを指定します。 |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PageSize | The maximum number of results to return per page from ADP. |
PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
PoolMaxSize | プールの最大接続数。 |
PoolMinSize | プール内の最小接続数。 |
PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
Readonly | このプロパティを使用して、provider からADP へのアクセスを読み取り専用に設定できます。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |