CData Sync App は、CSV ストリーミング専用です。

このストリームファイルのコンテンツには、リモートで保存されたCSV ファイルに関連するファイル名やフォルダ名などのメタデータはすべて含まれていません。

ファイルのメタデータとファイルの実際のコンテンツの両方にアクセスする必要がある場合は、CData Sync App は、CSV ファイルがリモートで格納されているサービスの関連ファイルシステムドライバーと併せて使用する必要があります。

以下のファイルシステムドライバーが利用可能です。

• AmazonS3
• Box
• Dropbox
• FTP
• GoogleCloudStorage
• IBLCloudObjectStorage
• OneDrive
• SFTP

保存されているCSV ファイルメタデータに接続するための設定方法については、関連するCData ファイルシステムドライバーのドキュメントを参照してください。

Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、CSV への接続を作成します。CSV アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからCSV コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

CData Sync App を使用すると、ローカルおよびリモートのCSV リソースに接続できます。データソースへの接続に必要なプロパティに加えて、URI プロパティをCSV リソースの場所に設定します。

ローカルファイルへの接続

ConnectionType をLocal に設定します。ローカルファイルは、SELECT\INSERT\UPDATE\DELETE をサポートします。

URI をCSV ファイルを含むフォルダに設定します。 C:\folder1。

同じスキーマを共有する複数のCSV ファイルに接続することもできます。以下は接続文字列の例です。

URI=C:\folder; AggregateFiles=True;

個々のCSV ファイルをすべてテーブルとして公開したい場合は、このプロパティをFalse のままにしてください。

URI=C:\folder; AggregateFiles=False;

Cloud-Hosted CSV ファイルへの接続

クラウド上のファイルをINSERT、UPDATE、DELETE する必要がある場合は、そのクラウドサービスに対応するCData Sync App をダウンロードし（ストアドプロシージャでサポートされています）、ローカルファイルの対応するSync App に変更を加え、そのクラウドソース用のストアドプロシージャを使ってファイルをアップロードできます。

例えば、SharePoint 上に格納されたファイルをアップデートしたい場合、CData SharePoint Sync App のDownloadDocument プロシージャを使用してCSV ファイルをダウンロードし、CData CSV Sync App でローカルのCSV ファイルをアップデートして、最後にSharePoint Sync App のUploadDocument プロシージャを使って変更されたファイルをSharePoint にアップロードできます。

URI 接続プロパティの先頭にある一意の接頭辞は、Sync App が対象とするクラウドデータストアを識別するために使用され、残りのパスは目的のフォルダ（1ファイルにつき1テーブル）または単一ファイル（単一テーブル）への相対パスとなります。

Amazon S3

Amazon S3 に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：ConnectionType をAmazon S3 に設定。
• URI：バケットおよびフォルダ：s3://bucket1/folder1 に設定。

Amazon S3 でホストされているCSV ファイルへの接続および認証について詳しくは、Amazon S3 への接続 を参照してください。

Azure Blob Storage

Azure Blob Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Azure Blob Storage に設定。
• URI：コンテナの名前およびBlob の名前に設定。例えば、azureblob://mycontainer/myblob です。

Amazon Blob Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Azure Blob Storage への接続 を参照してください。

Azure Data Lake Storage

Azure Data Lake Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Azure Data Lake Storage Gen1、Azure Data Lake Storage Gen2、またはAzure Data Lake Storage Gen2 SSL に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 に設定。次に例を示します。
  • Gen 1：adl://myfilesystem/folder1
  • Gen 2：abfs://myfilesystem/folder1
  • Gen 2 SSL：abfss://myfilesystem/folder1

Azure Data Lake Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Azure Data Lake Storage への接続 を参照してください。

Azure File Storage

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

• ConnectionType：Azure Files に設定。
• URI：Azure ファイル共有の名前とリソースの名前に設定。例：azurefile://fileShare/remotePath。
• AzureStorageAccount（必須）：Azure ファイルに紐づいているアカウントに設定。

Azure アクセスキーまたはAzure 共有アクセス署名のいずれかで認証できます。次のいずれか1つを設定してください。

• AzureAccessKey：Azure ファイルに紐づいているアクセスキーに設定。
• AzureSharedAccessSignature：Azure ファイルに紐づいている共有アクセス署名に設定。

Box

Box に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Box に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 に設定。例えば、box://folder1です。

Box でホストされているCSV ファイルへの接続および認証について詳しくは、Box への接続 を参照してください。

Dropbox

Dropbox に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Dropbox に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。例えば、dropbox://folder1 です。

Dropbox でホストされているCSV ファイルへの接続および認証について詳しくは、Dropbox への接続 を参照してください。

FTP

Sync App は、FTP サーバーへのプレーンテキスト接続およびSSL/TLS 接続の両方をサポートします。

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

• ConnectionType：FTP またはFTPS のいずれかに設定。
• URI：ルートフォルダとして使用されるフォルダへのパスが付いたサーバーのアドレス に設定。例：ftp://localhost:990/folder1 またはftps://localhost:990/folder1。
• User：接続するFTP(S) サーバーのユーザー名に設定。
• Password：接続するFTP(S) サーバーのパスワードに設定。

Google Cloud Storage

Google Cloud Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Google Cloud Storage に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 へのパスに設定。例えば、gs://bucket/remotePath です。

Google Cloud Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Google Cloud Storage への接続 を参照してください。

Google Drive

Google Drive に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Google Drive に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 へのパスに設定。例えば、gdrive://folder1 です。

Google Drive でホストされているCSV ファイルへの接続および認証について詳しくは、Google Drive への接続 を参照してください。

HDFS

HDFS に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：HDFS またはHDFS Secure に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。次に例を示します。
  • HDFS： webhdfs://host:port/remotePath
  • HDFS Secure： webhdfss://host:port/remotePath

HDFS データソースへの接続に使用できる認証方法は、匿名認証とKerberos 認証の2つがあります。

匿名認証

状況によっては、認証接続プロパティなしでHDFS に接続できます。 そのためには、AuthScheme プロパティをNone（デフォルト）に設定します。

Kerberos を使用した認証

認証資格情報が必要な場合、認証にKerberos を使用することができます。 Kerberos で認証する方法についての詳細は、Kerberos の使用 を参照してください。

HTTP Streams

HTTP streams に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：HTTP またはHTTPS に設定。
• URI：HTTP(S) stream のURI に設定。次に例を示します。
  • HTTP： http://remoteStream
  • HTTPS： https://remoteStream

HTTP Streams でホストされているCSV ファイルへの接続および認証について詳しくは、HTTP Streams への接続 を参照してください。

IBM Cloud Object Storage

IBM Cloud Object Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：IBM Object Storage Source に設定。
• URI：バケットおよびフォルダに設定。例えば、ibmobjectstorage://bucket1/remotePath です。
• Region：このプロパティをIBM インスタンスリージョンに設定。例：eu-gb.

IBM Cloud Object Storage でホストされているCSV ファイルへの接続および認証について詳しくは、IBM Object Storage への接続 を参照してください。

OneDrive

OneDrive に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：OneDrive に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。例えば、onedrive://remotePath です。

OneDrive でホストされているCSV ファイルへの接続および認証について詳しくは、OneDrive への接続 を参照してください。

Oracle Cloud Storage

HMAC で認証するには、次のプロパティを設定します。

• ConnectionType：ConnectionType をOracle Cloud Storage に設定。
• URI：バケットおよびフォルダ：os://bucket/remotePath に設定。
• AccessKey： Oracle Cloud のAccess Key に設定。
• SecretKey：Oracle Cloud のSecret Key に設定。
• OracleNamespace：Oracle cloud のnamespace に設定。
• Region（オプション）：S3ライクなWeb サービスのホスティングリージョンに設定。

SFTP

SFTP に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：SFTP に設定。
• URI：これをサーバーのアドレスに設定し、ルートフォルダとして使用するフォルダのパスを続けて指定します。例えば、sftp://server:port/remotePath です。

SFTP でホストされているCSV ファイルへの接続および認証について詳しくは、SFTP への接続 を参照してください。

SharePoint Online

SharePoint Online に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：SharePoint REST またはSharePoint SOAP に設定。
• URI：CSV ファイルを含むドキュメントライブラリ に設定。次に例を示します。
  • SharePoint Online REST： sprest://remotePath
  • SharePoint Online SOAP： sp://remotePath

SharePoint Online でホストされているCSV ファイルへの接続および認証について詳しくは、SharePoint Online への接続 を参照してください。

HTTP CSV ストリームへの接続

URI をテーブルとしてアクセスしたいCSV リソースのHTTP またはHTTPS URL に設定します。次に例を示します。

URI=http://www.host1.com/streamname1;

To query the CSV stream, reference streamedtable as the table name.

SELECT * FROM streamedtable

その他のソースへの接続システムストリーム

システムストリームへの読み出し/書き込みも可能です。ExtendedProperties 接続プロパティを使用して、コードからストリームを参照します。

セキュアなCSV への接続

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL/TLS のネゴシエーションを試みます。別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

CSV への接続

以下は、Sync App のデフォルトのデータモデリング設定を使用したCSV ファイルまたはストリームへの接続文字列の例です。

動的なスキーマ検出

次のプロパティを設定して、Sync App が接続時に自動的にCSV をテーブルとしてモデル化する方法を制御します。

• IncludeColumnHeaders：指定したファイルの一行目からカラム名を取得するように設定します（デフォルト）。そうでない場合は、カラム名はカラム番号になります。
• FMT：テキストファイルのパースに使用する形式に設定します。CsvDelimited（デフォルト）またはTabDelimited。
• IncludeFiles：テーブルとしてモデル化されたファイル一式に含めるファイル拡張子のカンマ区切りリストに設定します。（デフォルトでは.txt、.tab、および.csv ファイルがモデル化されます。）
• RowScanDepth：指定した深さまで行をスキャンして、データ型を自動的に決定するように設定します。

ローカルCSV で作業する場合は、Microsoft Jet ドライバーと互換性のあるSchema.ini ファイルを使用してカラムとデータ型を定義することもできます。Schema.ini の使用 を参照してください。

スキーマのカスタマイズ

カラムのデータ型およびスキーマのその他の側面をカスタマイズするには、スキーマを静的なコンフィギュレーションファイルに保存できます。コンフィギュレーションファイルはシンプルな形式となっており、簡単に拡張できます。Sync App スキーマの拡張について詳しくは、スキーマファイルの生成 を参照してください。

サブフォルダへのアクセス

次のプロパティを設定して、サブフォルダをビューとしてモデル化します。

• IncludeSubdirectories：ネストされたフォルダからファイルやSchema.ini を読み出すように設定します。名前衝突が起こった場合は、テーブル名の前にアンダースコアで区切られたフォルダ名が付けられます。デフォルト値はfalse です。
• DirectoryRetrievalDepth：IncludeSubdirectories が設定されている場合に、再帰的にスキャンするサブフォルダの数を設定します。デフォルトでは、Sync App はすべてのサブフォルダをスキャンします。

IncludeSubdirectories が設定されている場合、自動的に検出されるテーブル名は以下の規則に従います。

接続の前に

AWS キーを取得

IAM ユーザーの認証情報を取得するには、以下の手順に従ってください。

1. IAM コンソールにサインインします。
2. ナビゲーションペインで［ユーザー］を選択します。
3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してから［セキュリティ認証情報］タブを選択します。

AWS ルートアカウントの認証情報を取得するには、以下の手順に従ってください。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

Amazon S3 への接続

データへの接続には、以下を設定してください。

• AWSRegion：CSV データがホストされているリージョンに設定。
• StorageBaseURL（オプション）：ベースとなるS3 サービスのURL が"amazonaws.com" と異なる場合のみ、そのURL を指定します。必ず完全なURL を指定してください。例：http://127.0.0.1:9000

Amazon S3 への認証

CSV への接続に使用できる認証方法は、以下を含めいくつかあります。

• ルートクレデンシャル
• AWS ロール（EC2 インスタンスまたはルート認証の指定による）としてのAWS ロール
• SSO（ADFS、Okta、PingFederate）
• MFA
• 一時クレデンシャル
• クレデンシャルファイル

ルートクレデンシャル

アカウントのルートクレデンシャルで認証するには、次を設定します。

• AuthScheme：AwsRootKeys に設定。
• AWSAccessKey：AWS ルートアカウントに紐づいているアクセスキー。
• AWSSecretKey：AWS ルートアカウントに紐づいているシークレットキー。

Note： この認証スキームの使用は、簡単なテスト以外ではAmazon では推奨されていません。アカウントのルート認証情報はユーザーの完全な権限を持つため、これが最も安全性の低い認証方法になります。

EC2 インスタンス

EC2 インスタンスからSync App を使用していて、そのインスタンスにIAM ロールが割り当てられている場合は、 認証にIAM ロールを使用できます。これを行うには、次のプロパティを設定して認証します。

• AuthScheme：AwsEC2Roles に設定。

認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のアカウントでロールを引き受ける場合にのみ必要です。

IMDSv2 サポート

CSV Sync App は、IMDSv2 をサポートしています。IMDSv1 とは異なり、新バージョンでは認証トークンが必須です。エンドポイントおよびレスポンスは、両バージョンで同じです。 IMDSv2 では、CSV Sync App はまずIMDSv2 メタデータトークンの取得を試み、それを使用してAWS メタデータエンドポイントを呼び出します。トークンを取得できない場合、Sync App はIMDSv1 を使用します。

AWS IAM ロール

多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。

AWS ロールとして認証するには、次を設定します。

• AuthScheme：AwsIAMRoles に設定。
• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のアカウントでロールを引き受ける場合にのみ必要です。

Note： AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定する場合、ロールは使用できません。

ADFS

AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。

• User：ADFS ユーザーに設定。
• Password：ユーザーのADFS パスワードに設定。
• SSOLoginURL：SSO プロバイダーが使用するログインURL に設定。

ADFS への認証には、次のSSOProperties が必要です。

• RelyingParty：この属性は、CSV のADFS サーバー上のRelying Party Identifier の値です。

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';SSOProperties='RelyingParty=https://saml.salesforce.com';

ADFS 統合

ADFS 統合フローは、現在ログインしているWindows ユーザーの認証情報で接続していることを示します。 ADFS 統合フローを使うには、User およびPasswordを指定せず、それ以外は上記ADFS ガイドの手順と同じです。

Okta

AuthScheme をOkta に設定します。Okta を介した認証には、次の接続プロパティを使用します。

• User：Okta ユーザーに設定。
• Password：Okta パスワードに設定。
• SSOLoginURL：SSO プロバイダーが使用するログインURL に設定。

• Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する
• MFA を構成する

Okta を使用して認証するためには、SSOProperties 入力パラメータの組み合わせを使用する必要があります。それ以外の場合、これらの値を設定する必要はありません。

SSOProperties に、必要に応じて以下の入力パラメータを設定します。

• APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
• MFAType：MFA フローを設定した場合に設定。現時点では、次のタイプをサポートしています：OktaVerify、Email、およびSMS。
• MFAPassCode：MFA フローを設定した場合にのみ設定。これを空欄または無効な値に設定した場合、Sync App はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
• MFARememberDevice：Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、Sync App はMFA 認証の有効期間を延長するデバイストークンを送信します。このプロパティはデフォルトでTrue に設定されてます。MFA を記憶させない場合のみFalse に設定してください。

接続文字列の例：

AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;

PingFederate

AuthScheme をPingFederate に設定します。次の接続プロパティを設定する必要があります。

• User：PingFederate ユーザーに設定。
• Password：ユーザーのPingFederate パスワードに設定。
• SSOLoginURL：SSO プロバイダーが使用するログインURL に設定。
• AWSRoleARN （オプション）：複数のロールARN がある場合、認可に使用したいものをオプションで指定できます。
• AWSPrincipalARN （オプション）：複数のプリンシパルARN がある場合、認可に使用したいものをオプションで指定できます。
• SSOExchangeUrl: The Partner Service Identifier URI configured in your PingFederate server instance under: SP Connections > SP Connection > WS-Trust > Protocol Settings. This should uniquely identify a PingFederate SP Connection, so it is a good idea to set it to your AWS SSO ACS URL. You can find it under AWS SSO > Settings > View Details next to the Authentication field.
• SSOProperties （オプション）：Amazon S3 へのリクエストにユーザー名とパスワードを認可ヘッダーとして含めたい場合は、オプションで"AuthScheme=Basic" に設定できます。

追加で次のSSOProperties を使って、SSOLoginURL 用の相互SSL 認証（WS-Trust STS エンドポイント）の設定が可能です。

• SSLClientCert
• SSLClientCertType
• SSLClientCertSubject
• SSLClientCertPassword

authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam::215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam::215338515180:role/SSOTest2;

MFA

多要素認証を必要とするユーザーおよびロールには、以下を指定して認証してください。

• AuthScheme：AwsMFA に設定。
• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

• AWSAccessKey：MFA が発行されるIAM ユーザーのアクセスキー。
• AWSSecretKey：MFA が発行されるIAM ユーザーのシークレットキー。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App はMFA を使用して指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のアカウントでロールを引き受ける場合にのみ必要です。

一時的な認証情報の有効期間（デフォルトは3600秒）は、TemporaryTokenDuration プロパティを設定することで制御できます。

一時クレデンシャル

一時クレデンシャルで認証するには、次を設定します。

• AuthScheme：AwsTempCredentials に設定。
• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSSessionToken：AWS のセッショントークン。これは一時的な認証情報とともに提供されます。詳しくは、AWS Identity and Access Management User Guide を参照してください。

Sync App は、一時クレデンシャルの有効期間中、長期的な認証情報（IAM ユーザー認証情報など）によって提供されるものと同じ権限を使用してリソースをリクエストできるようになりました。

認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のアカウントでロールを引き受ける場合にのみ必要です。

クレデンシャルファイル

認証にはクレデンシャルファイルを使用することができます。AccessKey/SecretKey 認証、一時クレデンシャル、ロール認証、またはMFA に関連するすべての設定が使用できます。 これを行うには、次のプロパティを設定して認証します。

• AuthScheme：AwsCredentialsFile に設定。
• AWSCredentialsFile：クレデンシャルファイルの場所に設定。
• AWSCredentialsFileProfile（オプション）：オプションで、指定したクレデンシャルファイルから使用するプロファイルの名前に設定。指定しない場合は、default という名前のプロファイルが使用されます。

AzureAD

AuthScheme をAzureAD に設定します。AzureAD への接続には、以下の接続プロパティを使用します。

この構成には、2つのAAD アプリケーションが必要であることに注意してください：シングルサインオンに使用される"CSV" アプリケーションと、"CSV" アプリケーションに対するuser_impersonation 権限を持つ別の"コネクタ" アプリケーションです。 OAuth 接続プロパティも指定する必要があります。

• OAuthClientId：アプリ登録の概要セクションにリストされている、コネクタアプリケーションのアプリケーションId。
• OAuthClientSecret：コネクタアプリケーションのクライアントシークレット値。新しいクライアントシークレットを作成すると、Azure AD にこれが表示されます。
• CallbackURL：コネクタアプリケーションのリダイレクトURI に設定。例：https://localhost:33333

AzureAD への認証には、以下のSSOProperties を使用します。

• Resource：アプリ登録の概要セクションにリストされている、CSV アプリケーションのアプリケーションId URI。ほとんどの場合、これはカスタムCSV ドメインのURL です。
• AzureTenant：アプリケーションが登録されているAzure AD テナントのId。

次は接続文字列の例です。

AuthScheme=AzureAD;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=https://signin.aws.amazon.com/saml;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';

接続の前に

AzureBlob ユーザーの認証情報を取得するには、以下の手順に従ってください。

1. ルートアカウントの認証情報を使用してAzure ポータル にサインインします。
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定でアクセスキーをクリックします。
4. ページ上にストレージアカウント名とキーが表示されます。

Azure Blob Storage への接続

ユーザーを識別するために、AzureAccessKey 接続プロパティをAzure Blob に紐づいているアクセスキーに設定します。

Azure Blob Storage への認証

Azure AD ユーザー、MSI 認証、またはAzure サービスプリンシパルでAzure Blob Storage を認証できます。

Azure AD

Azure アクセスキーまたはOAuth 認証のいずれかでAzure AD アカウントを認証できます。

方法1：ストレージアカウントおよびアクセスキー

Azure アクセスキーで認証するには、以下のように設定します。

• AuthScheme：AzureAD に設定。
• AzureStorageAccount：Azure Data Lake Store に紐づいているアカウントに設定。
• AzureAccessKey：Azure Data Lake Store に紐づいているアクセスキーに設定。

方法2：OAuth

OAuth で認証するには、以下のように設定します。

• AuthScheme：AzureAD に設定。
• AzureStorageAccount：Azure Data Lake Store に紐づいているアカウントに設定。

Azure MSI

Azure Blob Storage のアクセス許可を持つAzure VM で接続する場合は、以下を設定します。

• AuthScheme：AzureMSI に設定。
• AzureStorageAccount：Azure Blob に紐づいているアカウントに設定。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。認証するには以下のように設定します。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

Azure Data Lake Storage への接続

Azure AD ユーザー、MSI 認証、またはAzure サービスプリンシパルでAzure Data Lake Storage を認証できます。

Azure AD

Azure アクセスキーまたはOAuth 認証のいずれかでAzure AD アカウントを認証できます。

方法1：ストレージアカウントおよびアクセスキー

Azure アクセスキーで認証するには、以下のように設定します。

• AuthScheme：AzureAD に設定。
• AzureStorageAccount：Azure Data Lake Store に紐づいているアカウントに設定。
• AzureAccessKey：Azure Data Lake Store に紐づいているアクセスキーに設定。

方法2：OAuth

OAuth で認証するには、以下のように設定します。

• AuthScheme：AzureAD に設定。
• AzureStorageAccount：Azure Data Lake Store に紐づいているアカウントに設定。

Azure MSI

Azure Data Lake Storage に接続するアクセス許可を持つAzure VM で接続する場合は、以下を設定します。

• AuthScheme：AzureMSI に設定。
• AzureStorageAccount：Azure Data Lake Store に紐づいているアカウントに設定。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

Box への接続

Box への接続には、OAuth 認証標準を使用します。ユーザーアカウントまたはサービスアカウントで認証できます。組織全体のアクセススコープをSync App に許可するには、サービスアカウントが必要です。下記で説明するとおり、Sync App はこれらの認証フローをサポートします。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

Web アプリケーション

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

OAuth アクセストークンの取得

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

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

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

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。

2. ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURL のクエリ文字列のcode パラメータに設定します。

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

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

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

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

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

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

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

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

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

サービスアカウントで認証する

この方法で認証するには、AuthScheme をOAuthJWT に設定します。

サービスアカウントには、ブラウザによるユーザー認証なしのサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープをSync App に委任することもできます。

このフローでは、OAuth アプリケーションを作成する必要があります。アプリの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるBox データに接続できます。

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

• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• OAuthJWTCertType："PEMKEY_FILE" に設定。
• OAuthJWTCert：生成した.pem ファイルのパスに設定。
• OAuthJWTCertPassword：.pem ファイルのパスワードに設定。
• OAuthJWTCertSubject：証明書ストア内の1番目の証明書を選択するには、"*" に設定。
• OAuthJWTSubjectType：アプリケーション設定で選択した［Application Access Value］に応じて、［enterprise］または［user］に設定。この接続プロパティのデフォルト値は［enterprise］です。
• OAuthJWTSubject：サブジェクトタイプが［enterprise］に設定されている場合は、これをエンタープライズID に設定します。［user］に設定されている場合は、アプリのユーザーID に設定します。
• OAuthJWTPublicKeyId：アプリケーション設定の公開キーID に設定。

カスタムOAuth アプリケーションを作成するタイミング

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

ユーザーアカウント用のOAuth アプリの作成

1. Box 開発者ダッシュボード にログインしてアプリの新規作成をクリックします。アプリの種類を選択します（例：カスタムアプリ）。
2. ［標準OAuth 2.0（ユーザー認証）］認証メソッドを選択してアプリの表示をクリックします。アプリを作成したら、メインメニューから設定をクリックしてアプリ設定にアクセスできます。
3. 表示されるクライアントID およびクライアントシークレットを控えておきます。これらの値は、後でOAuthClientId およびOAuthClientSecret 接続プロパティを入力するために必要です。
4. リダイレクトURI を設定し、後でSync App を設定するために指定された値を保存します。
   • を設定する際、リダイレクトURI をhttp://localhost:33333か別のポート番号に設定してください。
   • Web アプリを設定する際、リダイレクトURI をhttps://<yourwebappserver:><port> に設定します。
5. アプリが要求するユーザーのアクセス許可の範囲を選択します。

サービスアカウント用のOAuth アプリの作成

次の手順に従ってOAuth アプリケーションを作成しプライベートキーを生成します。その後サービスアカウントを認証します。

1. Box 開発者ダッシュボード にログインしてアプリの新規作成をクリックします。アプリの種類を選択します（例：カスタムアプリ）。
2. ［JWT を使用したOAuth 2.0（サーバー認証）］認証メソッドを選択し、アプリケーション名を入力してアプリの作成をクリックします。アプリを作成したら、メインメニューから設定をクリックしてアプリ設定にアクセスできます。
3. 表示されるクライアントID およびクライアントシークレットを控えておきます。これらの値は、後でOAuthClientId およびOAuthClientSecret 接続プロパティを入力するために必要です。
4. アプリケーションのアクセスレベルおよびアプリが要求するユーザーのアクセス許可の範囲を選択します。エンタープライズアクセスレベルを使用すると、エンタープライズ内の既存のユーザーと作業できます。アプリケーションレベルの設定では、App-type ユーザー（API アクセスのみを持つユーザー）へのアクセスが制限されます。
5. RSA キーペアを作成します。まず最初に、秘密キーを生成する必要があります。これを行うには、次のOpenSSL コマンドを実行します：openssl genrsa -aes128 -out private_key.pem 2048（Windows を使用している場合は、Cygwin パッケージをインストールしてOpenSSL RSA キーペアを実行できます）。
6. 以下のOpenSSL コマンドを実行して、公開キーを生成します：openssl rsa -pubout -in private_key.pem -out public_key.pem。生成されたpublic_key.pem ファイルの内容をコピーし、アプリケーション設定の公開キーの追加と管理オプションを使用して追加します。

7. エンタープライズ管理コンソール でアプリケーションを認可します。アプリ -> カスタムアプリマネージャ -> アプリの追加に移動します。[アプリの追加]モーダルウィンドウで、クライアントId を入力し次へをクリックしてアプリを識別および検証します。

   Note：JWT アクセススコープを変更する場合は、エンタープライズ管理コンソールでアプリケーションを再認可する必要があります。メインメニューのアプリ をクリックし、JWT アプリケーション名の横にある省略記号ボタンを選択します。メニューのReauthorize App を選択します。

Dropbox への接続

Dropbox はOAuth 認証標準を利用しています。

Dropbox OAuth スコープ

CData の埋め込みOAuth アプリを使うか、カスタムOAuth アプリの作成 のどちらかを選択してください。

Web アプリケーション

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

OAuth アクセストークンの取得

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

• OAuthClientId：OAuth アプリ設定にあるApp key の値に設定。
• OAuthClientSecret：OAuth アプリ設定のApp secret に設定。

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

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。

2. ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURL のクエリ文字列のcode パラメータに設定します。

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

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

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

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

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

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

• OAuthClientId：OAuth アプリ設定にあるApp key の値に設定。
• OAuthClientSecret：OAuth アプリ設定のApp secret に設定。

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

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

カスタムOAuth アプリケーションを作成するタイミング

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムOAuth アプリの作成

1. Dropbox 開発者ダッシュボード にログインして［アプリを作成］をクリックします。Dropbox API を選択します。アプリへのアクセスタイプはFull Dropbox を選択します。
2. アプリを作成すると、アプリ設定を表示するメインメニューからConfiguration を見ることができます。
3. アプリのSettings タブで、のちのSync App 設定のためにApp key とApp secret の値をメモしておきます。
4. リダイレクトURI を設定し、後でSync App を設定するために指定された値を保存します。
   • を設定する際、リダイレクトURI をhttp://localhost:33333か別のポート番号に設定してください。
   • Web アプリを設定する際、リダイレクトURI をhttps://<yourwebappserver:><port> に設定します。
5. アプリのPermissions タブで、アプリが要求するユーザーのアクセス許可の範囲を選択します。

CSV のアプリ設定でこれ以上値を指定する必要はありません。

Google Cloud Storage への接続

ProjectId プロパティを接続するプロジェクトのId に設定します。

Google Cloud Storage への認証

Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Cloud Storage の利用可能な認証スキームについて説明します。

• ユーザーアカウント（OAuth）
• サービスアカウント（OAuthJWT）
• GCP インスタンスアカウント

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

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

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

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

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

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

• コールバックURL からアクセストークンを取得します。
• 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
• OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します。

Web アプリケーション

OAuth アクセストークンの取得

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

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

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

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

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

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

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

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

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

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

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

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

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

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

ヘッドレスマシン

1. 以下のオプションから選択します。
   • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
   • オプション2：インターネットブラウザに対応したマシンにSync App をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにSync App を設定します。

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

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

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

1. 以下のオプションから選択します。
   • 埋め込みOAuth アプリケーションを使用する場合は、Google Cloud Storage OAuth エンドポイント をクリックし、ブラウザでエンドポイントを開きます。
   • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
     • InitiateOAuth：OFF に設定。
     • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
     • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
     次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
2. ログインして、Sync App にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

ヘッドレスマシンでは、次の接続プロパティを設定して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 に読み書きのアクセス許可を与えることを確認してください。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

イントロダクション

カスタムOAuth アプリケーションを作成するタイミング

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

を有効化

1. Google Cloud Console に移動します。
2. 左側のナビゲーションメニューからライブラリを選択します。API ライブラリページが開きます。
3. 検索ボックスに、「」を入力し、検索結果から を選択します。
4. ページで、有効にするをクリックします。

ユーザーアカウント用のOAuth アプリケーションの作成（OAuth）

以下の手順でカスタムOAuth アプリケーションを作成します。

1. Google Cloud Console に移動します。
2. まだ作成していない場合は、コンソールの手順に従ってOAuth 同意画面を構成します。
3. 左側のナビゲーションメニューから認証情報を選択します。
4. 認証情報ページで認証情報を作成->OAuth クライアントID を選択します。
5. アプリケーションの種類メニューでウェブアプリケーションを選択します。
6. OAuth カスタムWeb アプリケーションの名前を指定します。
7. 承認済みのリダイレクトURI の下にあるURI を追加をクリックし、リダイレクトURI を入力します。Enter で確定します。
8. 作成をクリックすると、認証情報ページに戻ります。
9. ウィンドウが開き、クライアントId とクライアントシークレットが表示されます。クライアントシークレットはGoogle Cloud コンソールからアクセス可能ですが、クライアントシークレットをメモしておくことをお勧めします。OAuthClientId とOAuthClientSecret 接続プロパティを指定するには、クライアントシークレットとクライアントId の両方が必要です。

サービスアカウント用のOAuth アプリケーションの作成（OAuthJWT）

1. Google Cloud Console に移動します。
2. まだ作成していない場合は、コンソールの手順に従ってOAuth 同意画面を構成します。
3. 左側のナビゲーションメニューから認証情報を選択します。
4. 認証情報ページで認証情報を作成->サービスアカウントを選択します。
5. サービスアカウントの作成ページで、サービスアカウント名、サービスアカウントID、および任意でサービスアカウントの説明を入力します。
6. 完了をクリックします。認証情報ページに戻ります。

Google Drive への認証

Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Drive の利用可能な認証スキームについて説明します。

• ユーザーアカウント（OAuth）
• サービスアカウント（OAuthJWT）
• GCP インスタンスアカウント

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

Web アプリケーション

OAuth アクセストークンの取得

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

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

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

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

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

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

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

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

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

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

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

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

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

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

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

Sync App は次のOAuth 認証フローを行います。

• ユーザー同意フローにより、個々のユーザーが自分のデータに接続できます。
• サービスアカウントフローを使用すると、ドメイン全体のデータにアクセスできます。

ユーザーアカウントを使ってGoogle に接続

OAuth フローでは認証するユーザーにブラウザでGoogle との通信を要求します。下記で説明するとおり、Sync App はさまざまな方法でこれをサポートします。

Google へ認証

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

1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
2. アクセストークンの期限が切れたときにはリフレッシュしてください。
3. OAuth 値を保存し、接続間で永続化されるようにします。

Web アプリケーションからの認証

Web アプリケーションから接続する場合、またはSync App にブラウザウィンドウを開く権限がない場合は、verifier code とアクセストークンを交換する必要があります。

始めるには、Google にOAuth アプリを登録して次の接続プロパティを設定します。

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

アプリを登録してOAuthClientId およびOAuthClientSecret を設定したら、verifier code をアクセストークンと交換できます。

1. GetOAuthAuthorizationURL を呼び出します。ストアドプロシージャがOAuth エンドポイントのURL を返します。

2. OAuth エンドポイントにログインして、アプリケーションを認可します。コールバックURL 経由でリダイレクトされます。

   verifier code は"Code" と名付けられたクエリ文字列パラメータとして、コールバックURL に追加されます。verifier code を取り出します。

3. GetOAuthAccessToken を呼び出します。

サービスアカウントを使って、Domain-Wide データに接続

このOAuth フローのサービスアカウントを使って、ユーザーもしくはドメインの代わりにGoogle API にアクセスすることができます。ドメイン管理者はドメイン全体のアクセスをサービスアカウントに委任することができます。

サービスアカウントフローを完了させるには、Google API Console で秘密キーを生成します。サービスアカウントフローにおいて、Sync App はOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。OAuthAccessToken が認証し、Sync App はサービスアカウントと同じアクセス許可が与えられます。

秘密キーの生成

下記の手順に従って、秘密キーを生成しアプリケーションのクレデンシャルを取得します。

1. Google API コンソールにログインします。
2. ［プロジェクトの作成］をクリック、または既存のプロジェクトを選択します。
3. API Manager で、［認証情報］->［認証情報を作成］->［サービスアカウントキー］をクリックします。サービスアカウントメニューで［新しいサービスアカウント］か既存のサービスアカウントを選択します。［キーのタイプ］で［P12 キー］を選択します。
4. ［作成］をクリックして、キーペアをダウンロードします。秘密キーのパスワードが表示されます。これは、OAuthJWTCertPassword 内にあります。
5. クレデンシャルページのサービスアカウントキーセクションでは［Manage Service Accounts］をクリックして、OAuthJWTIssuer をサービスアカウントID で表示されたE メールアドレスに設定します。
6. ［ライブラリ］->［Google Drive API］->［有効にする］をクリックします。

サービスアカウント

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

• InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。
• OAuthJWTCertType："PFXFILE" に設定。
• OAuthJWTCertPassword：.p12ファイルのパスワードに設定。
• OAuthJWTCertSubject："*" に設定すると、証明書ストアの1番目の証明書が選択されます。
• OAuthJWTIssuer：サービスアカウントのE メールアドレスに設定。
• OAuthJWTCert：.p12ファイルのパスに設定。
• OAuthJWTSubject：アクセスの委譲を要求しているアプリケーションのユーザーのE メールアドレスを設定。

1. Sync App に要求されるclaim set でJWT を作成し、サインします。
2. JWT はアクセストークンと交換されます。
3. トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。

HTTP(S) への認証

Basic

AuthScheme：Basic に設定。

Digest

AuthScheme：Digest に設定。

OAuth

AuthScheme：OAuth に設定。

OAuthJWT

AuthScheme：OAuthJWT に設定。

OAuthPassword

AuthScheme：OAuthPassword に設定。

OAuthClient

AuthScheme：OAuthClient に設定。

OAuthPKCE

AuthScheme：OAuthPKCE に設定。

接続の前に

Cloud Object Storage の新規インスタンスの登録

IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

1. IBM Cloud アカウントにログインします。
2. Cloud Object Storage ページに移動し、インスタンス名を指定して作成をクリックします。作成したばかりのCloud Object Storage のインスタンスにリダイレクトされます。

API キー

IBM Cloud Object Storage に接続するにはApiKey が必要です。これは次のようにして取得できます。

1. IBM Cloud アカウントにログインします。
2. Platform API Keys ページに移動します。
3. 中央右隅のCreate an IBM Cloud API Key をクリックして、新しいAPI キーを作成します。
4. ポップアップウィンドウが表示されたら、API キー名を指定して作成をクリックします。ダッシュボードからは再びアクセスできなくなるため、ApiKey を控えておきます。

IBM Cloud Object Storage への接続

HMAC またはOAuth のいずれかを使用して、IBM Cloud Object Storage への認証ができます。

HMAC

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

• AccessKey：IBM アクセスキー（ユーザー名）に設定。
• SecretKey：IBM シークレットキーに設定。
• Region：このプロパティをIBM インスタンスリージョンに設定。

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; AccessKey=token1; SecretKey=secret1; Region=eu-gb;

OAuth

OAuth 認証を使用して認証するには以下を設定します。

• AuthScheme：OAuth に設定。
• ApiKey：セットアップ中にメモしたIBM API キーに設定。
• Region：IBM インスタンスのリージョンに設定。

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; ApiKey=key1; Region=eu-gb; AuthScheme=OAuth; InitiateOAuth=GETANDREFRESH;

接続すると、Sync App がOAuth プロセスを完了します。

CSV への認証

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

SFTP への接続

None

SSHAuthMode:None に設定。

Password

SSHAuthMode:Password に設定。

Public_Key

SSHAuthMode:Public_Key に設定。

SharePoint Online SOAP への接続

URI をCSV ファイルを含むドキュメントライブラリ に設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

次に例を示します。

ただし、StorageBaseURL の末尾が"-my.sharepoint.com" の場合、この接続方法は機能しないことがあります。Sync App がファイルをダウンロードするために必要なSharePoint のコンポーネントをサポートしていないため、これらのサイトに接続する場合は、onedrive:// scheme を使用する必要があります。

SharePoint Online REST への接続

URI をCSV ファイルを含むドキュメントライブラリ に設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

次に例を示します。

ただし、StorageBaseURL の末尾が"-my.sharepoint.com" の場合、この接続方法は機能しないことがあります。Sync App がファイルをダウンロードするために必要なSharePoint のコンポーネントをサポートしていないため、これらのサイトに接続する場合は、onedrive:// scheme を使用する必要があります。

SSO 認証

AzureAD

Azure AD の設定

この構成の背景にあるメインテーマはOAuth 2.0 On-Behalf-Of flow です。 これにはAzure AD アプリケーションが2つ必要です。

1. 特定のサービスプロバイダーへのシングルサインオンプロセスに使用されるアプリケーション。
   • Amazon S3： このアプリケーションを作成する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Azure AD からAWS コンソールにログイン可能であることを確認してください。

     "Azure AD テストユーザーの割り当て" の手順は、ユーザーを割り当てる際にAWS ロールを選択できるように、プロビジョニング後まで保存しておきます。

2. 前の手順で作成したSSO アプリケーションに対するuser_impersonation 権限を持つ「コネクタ」プリケーション。 ［Azure Active Directory］->［アプリの登録］に進み、新しいアプリケーションを登録します。アプリケーションを登録したら、SSO アプリケーションへのAPI 呼び出しを許可する必要があります。 登録したアプリのAPI のアクセス許可セクションに移動して、［アクセス許可の追加］ボタンをクリックします。API 名またはアプリケーションId を指定してSSO アプリケーションのAPI を選択し、 user_impersonation アクセス許可を追加します。

CData ドライバーの共通プロパティ

次のSSOProperties がAzure Active Directory への認証に必要です。すべてのサービスプロバイダーに指定する必要があります。

• Resource：アプリ登録の概要セクションにリストされている、SSO アプリケーションのアプリケーションId URI。
• Tenant：アプリケーションが登録されているAzure AD テナントのId。この値はhere で確認できます。

OAuth 2.0 On-Behalf-Of フローからSSO SAML レスポンスを取得するので、次のOAuth 接続プロパティを指定する必要があります。

• OAuthClientId：アプリ登録の概要セクションにリストされている、コネクタアプリケーションのアプリケーションId。
• OAuthClientSecret：コネクタアプリケーションのクライアントシークレット値。新しいクライアントシークレットを作成すると、Azure AD にこれが表示されます（証明書 & シークレットのセクション）。

Amazon S3

Amazon S3 サービスプロバイダーに接続するときは、共通プロパティに加えて、次のプロパティを指定する必要があります。

• AuthScheme：AuthScheme をAzureAD に設定します。
• AWSRoleARN：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=d593a1d-ad89-4457-872d-8d7443aaa655;OauthClientSecret=g9-oy5D_rl9YEKfN-45~3Wm8FgVa2F;SSOProperties='Tenant=94be7-edb4-4fda-ab12-95bfc22b232f;Resource=https://signin.aws.amazon.com/saml;';AWSRoleARN=arn:aws:iam::2153385180:role/AWS_AzureAD;AWSPrincipalARN=arn:aws:iam::215515180:saml-provider/AzureAD;

OneLogin

OneLogin の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： このアプリケーションを作成する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、OneLogin からOffice 365 にログイン可能であることを確認してください。 アプリケーション内でWS-Trust を有効化してください。有効化されていない場合、CData ドライバーは接続できません。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOneLogin に設定。
• User：OneLogin アカウントのユーザー名。
• Password：OneLogin アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='OneLogin';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Okta

Okta の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： このアプリケーションを作成してSSO を設定する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Okta からOffice 365 にログイン可能であることを確認してください。 アプリケーション内でWS-Federation を使用してSSO を設定してください。設定されていない場合、CData ドライバーは接続できません。
• Amazon S3： このアプリケーションを作成してSSO を設定する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Okta からAWS にログイン可能であることを確認してください。 アプリケーション内でSAML 2.0でSSO を設定してください。設定されていない場合、CData ドライバーは接続できません。 Okta アプリで割り当てられたAWS ロールが、接続するS3バケットにアクセスできることを確認します。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOkta に設定。
• User：Okta アカウントのユーザー名。
• Password：Okta アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='Okta';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Amazon S3

以下のプロパティは、Amazon S3サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOkta に設定。
• User：Okta アカウントのユーザー名。
• Password：Okta アカウントのパスワード。
• SSOLoginURL：AWS Okta SSO アプリの埋め込みURL に設定。
• AWSRoleARN（オプション）：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN（オプション）：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。
• SSOProperties：
  • APIToken（オプション）：顧客がOkta 組織で作成したAPI Token に設定。Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合に使用してください。

AuthScheme=Okta;User=OktaUser;Password=OktaPassword;SSOLoginURL='https://{subdomain}.okta.com/home/amazon_aws/0oan2hZLgQiy5d6/272';

ADFS

ADFS の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： Office 365 のシングルサインオン用にADFS を設定するには、こちらのlink詳しい手順を参照してください。接続をテストして、ADFS からOffice 365 にログイン可能であることを確認してください。
• Amazon S3： AWS のシングルサインオン用にADFS を設定するには、こちらのlink詳しい手順を参照してください。接続をテストして、ADFS からAWS にログイン可能であることを確認してください。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をADFS に設定。
• User：ADFS アカウントのユーザー名。
• Password：ADFS アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='ADFS';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Amazon S3

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をADFS に設定。
• SSOLoginURL：ADFS インスタンスのURL に設定。
• User：ADFS アカウントのユーザー名。
• Password：ADFS アカウントのパスワード。
• AWSRoleARN（オプション）：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN（オプション）：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じステップを実行してください。

このセクションでは、Kerberos でCSV に認証する方法を説明します。

Kerberos

Kerberos を使用してCSV に認証するには、次のプロパティを設定します。

• AuthScheme：NEGOTIATE に設定。
• KerberosKDC：Kerberos KDC マシンのホスト名またはIP アドレスに設定。
• KerberosSPN：CSV のKerberos プリンシパルのサービスとホストに設定。これは、principal value（例：ServiceName/[email protected]）の'@' 記号の前の値（例：ServiceName/MyHost）です。

Kerberos チケットの取得

次のオプションのいずれかを使用して、必要なKerberos チケットを取得できます。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はないことに注意してください。

1. KRB5CCNAME という名前の環境変数が作成されていることを確認してください。
2. KRB5CCNAME 環境変数をクレデンシャルキャッシュファイルを指すパスに設定します（例えばC:\krb_cache\krb5cc_0 または/tmp/krb5cc_0）。このファイルは、MIT Kerberos チケットマネージャーでチケットを生成するときに作成されます。
3. チケットを取得するには、MIT Kerberos チケットマネージャーアプリケーションを開き、Get Ticket をクリックしてプリンシパル名とパスワードを入力し、OK をクリックします。成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。
4. クレデンシャルキャッシュファイルを作成したので、Sync App はキャッシュファイルを使用してCSV に接続するためのKerberos チケットを取得します。

KRB5CCNAME 環境変数を設定する代わりに、KerberosTicketCache プロパティを使用してファイルパスを直接設定できます。 設定すると、Sync App は指定されたキャッシュファイルを使用してCSV に接続するためのKerberos チケットを取得します。

Keytab ファイル

KRB5CCNAME 環境変数が設定されていない場合、Keytab ファイルを使用してKerberos チケットを取得できます。これを行うには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

KRB5CCNAME 環境変数およびKerberosKeytabFile プロパティの両方が設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。これを行うには、User およびPassword プロパティを、CSV での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります（例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合）。

このような環境では、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

リソースの場所

• 値が空の場合は、URL を自動的にカレントディレクトリ"./" への参照に割り当てます。CSV フォルダへの明示的なパスは、実行中のアプリケーションの環境に依存します。
• フォルダへのパス。
• ファイルまたはストリームへのパス - この場合、SELECT * FROM streamedtable を実行してファイルをクエリできます。

テーブルのモデル化

次のプロパティを設定して、Sync App がCSV をテーブルとしてモデル化する方法を制御します。

• IncludeColumnHeaders：指定したファイルの一行目からカラム名を取得するように設定します（デフォルト）。そうでない場合は、カラム名はカラム番号になります。
• FMT：テキストファイルのパースに使用する形式に設定します。CsvDelimited（デフォルト）またはTabDelimited。
• IncludeFiles：テーブルとしてモデル化されるファイル一式に含めるファイル拡張子のカンマ区切りリストに設定します。（デフォルトでは.txt、.tab、および.csv ファイルがモデル化されます。）
• RowScanDepth：指定した深さまで行をスキャンして、データ型を自動的に決定するように設定します。

CData Sync App は、ワイヤプロトコルを介した接続からテーブルをモデル化するまでの、ローカルおよびリモートのCSV データの処理の複雑さを隠します。ただし、これらのレイヤーを制御することもできます。

自動スキーマ検出のカスタマイズ

Sync App は、指定された接続プロパティに基づいてCSV からスキーマを動的に派生します。利用可能な接続プロパティを使用すると、データがテーブルとしてモデル化される方法のさまざまな側面を制御できます。接続の設定について詳しくは、CSV データソースへの接続 を参照してください。ローカルCSV で作業する場合は、Microsoft Jet ドライバーで使用される構成であるSchema.ini を使用して、カラム定義とファイル形式を設定することもできます。

レポートされたカラムや、データをテーブルとしてモデル化するその他の側面をより細かく制御するために、独自のスキーマを定義するか生成されたスキーマを拡張することができます。スキーマは、拡張可能なコンフィギュレーションファイルで定義されます。検出されたスキーマを設定ファイルに保存するには、スキーマファイルの生成 を参照してください。このファイルは簡単に編集できます。

次のセクションでは、スキーマをカスタマイズする方法やゼロから記述する方法について説明します。

カスタムスキーマのオーサリング

テーブルとビューは、API Script でスキーマファイルを作成することによって定義されます。API Script は、テーブルのカラムとその動作を定義するシンプルなAPI Script コンフィギュレーション言語にて書かれています。また、CSV を処理可能にするビルトインオペレーションがあります。

これらのデータ処理構造に加えて、API Script は、条件分岐やループなどに対応して構成されているフル機能の言語です。ただし、サンプルスキーマに示すように、ほとんどのテーブル定義ではこれらの機能を使用する必要はありません。

以下は、一般的なNorthwind サンプルデータベースのPerson エンティティをモデル化した、完全な機能を持つテーブルスキーマです。これには、SQL を通じでデータソースにアクセスするために必要なすべてのコンポーネントが含まれています。これらのコンポーネントの詳細は、カラムの定義 およびSELECT 実行 を参照してください。

<api:script>
  <!-- See Column Definitions to define column behavior. -->
   <api:info title="CSVPersons" desc="Parse the CSV Persons feed.">
    <attr name="ID"           xs:type="int" key="true"  />
    <attr name="EmployeeID"   xs:type="int"             />
    <attr name="Name"         xs:type="string"          />
    <attr name="TotalExpense" xs:type="double"          />
    <attr name="HireDate"     xs:type="datetime"        />
    <attr name="Salary"       xs:type="int"             />
  </api:info>

  <api:set attr="uri" value="http://pathtocsvstream" /> 
  
  <!-- The GET method corresponds to SELECT. The results of processing are pushed to the schema's output. See SELECT Execution for more information. -->
  <api:script method="GET" >
    <api:call  op="csvproviderGet"/>
  </api:script>

  <!-- Not implemented -->
  <api:script method="POST">
    <api:call op="csvproviderInsert">
      <api:push/>
    </api:call>
  </api:script>

  <!-- Not implemented -->
  <api:script method="MERGE">
    <api:call op="csvproviderUpdate">
      <api:push/>
    </api:call>
  </api:script>

  <!-- Not implemented -->
  <api:script method="DELETE">
    <api:call op="csvproviderDelete">
      <api:push/>
    </api:call>
  </api:script>
</api:script>

Schema.ini ファイルでは、テーブルとしてモデル化したいテキストファイルの形式を指定できます。また、テーブルのカラムも定義できます。 Schema.ini はURI で指定されたフォルダ内に配置する必要があります。あるいは、IncludeSubdirectories が設定されている場合は、Schema.ini を各サブフォルダ内に定義できます。

Schema.ini を必要な場合にのみ定義できるようにするには、IncludeFiles およびExtendedProperties も使用できます。

ExtendedProperties はMicrosoft Jet OLE DB 4.0 と互換性があります。すべてのテキストファイルの形式はExtendedProperties で設定が可能です。Schema.ini は特定のファイルに対してExtendedProperties をオーバーライドします。

Schema.ini で指定されたファイルは、IncludeFiles で追加されたファイルに加えてテーブルとしてレポートされます。Sync App は、テーブルのレポートにSchema.ini の定義を使用します。定義がない場合はファイル名を使用します。

Schema.ini でテーブルを定義

Schema.ini のセクションは、角かっこで囲まれたファイル名で始まる必要があります。次に例を示します。

[Jerrie's travel expense.txt]

ファイル形式を指定

ファイル名のエントリを追加したら、Format プロパティをファイルの形式に設定できます。有効な値は次のとおりです。

• CSVDelimited
• TabDelimited
• Delimited(custom character)

Format=Delimited(,)

カラムを定義

カラムの定義には、テキストファイルのフィールドに基づく2つの方法があります。

• ファイルの一行目、ヘッダー行でカラム名を定義します。接続するとSync App がデータ型を決定します。
• カラム番号、名前、データ型、および幅をSchema.ini で定義します。この方法で定義されたカラムは、最初にヘッダー行から受け取ったカラムをオーバーライドします。Schema.ini のファイルセクションで"ColNameHeader=False" に設定することで、ファイルのヘッダー行を無視することもできます。

Schema.ini でカラムを定義するには、次のフォーマットを使用します。

Coln=ColumnName DataType [Width Width]

次に例を示します。

Col2=A Text Width 100 

Schema.ini の例

[Jerrie's travel expense.csv] 
ColNameHeader=True 
Format=Delimited(,) 
Col1=Date Text 
Col2=A Text 
Col3=B Text 
Col4=C Text 
Col5=Total Text
Col6=Date Text 
Col7=D Text
Col8=E Text 
Col9=F Text 
Col10=G Text
Col11=rate numeric

[invoices.csv] 
ColNameHeader=True 
Format=Delimited(,) 
Col1=id numeric 
Col2=invoicedate date 
Col3=total numeric

サポートされるデータ型

データ型は次のいずれかになります。

• binary
• byte
• boolean
• date
• time
• datetime
• decimal
• double
• tinyint
• smallint
• integer
• bigint
• float
• string
• text
• longtext
• char
• varchar
• nvarchar

CData Sync App を使用すると、スキーマ定義をコンフィギュレーションファイルに保存できます。スキーマファイルを使用すると、動的に検出されたスキーマをカスタマイズして保存したり、独自のデータビューを定義したりすることが容易になります。

次のセクションでは、GenerateSchemaFiles プロパティを使って接続文字列に基づいて検出されたテーブル定義を保存する方法を示します。 あるいは、ストアドプロシージャを呼び出して、指定された入力パラメータに基づいてスキーマファイルを手動で生成することもできます。

スキーマを作成したら、データ型をさらに制御するためにテーブルスキーマを拡張する方法や、CSV をテーブルとしてモデル化するその他の側面についてCSV データのモデリング を参照してください。

GenerateSchemaFiles 接続プロパティの使用

次の追加の接続プロパティを設定して、ローカルまたはリモートCSV のテーブルスキーマを生成します。

• GenerateSchemaFiles：これを設定すると、CSV データソースへの接続 で説明されている接続プロパティで決定されたテーブルのスキーマファイルが生成されます。OnUse に設定した場合、CSV に対してSELECT クエリを実行するとスキーマが生成されます。OnStart に設定すると、接続時にスキーマが生成されます。同じ名前のスキーマファイルがすでに存在する場合、Sync App はファイルを上書きしません。
• Location：このプロパティをスキーマのパスに設定します。Sync App は、すべてのフォルダ内のすべての.rsd ファイルをテーブルとして表示します。Sync App は、すべてのフォルダ内のすべての.rsb ファイルをストアドプロシージャとして表示します。

Note：.rsd ファイルで定義されたカラムはSchema.ini の定義よりも優先されます。生成されたスキーマファイルで定義されたカラムはSchema.ini の定義よりも優先されます。

カラムの基本属性は、カラム名、データ型、カラムが主キーかどうか、および内部名です。Sync App は、内部名を使って読み取り可能な名前のないCSV からノードを取得します。

スキーマファイルのapi:info ブロックにカラム属性をマークアップします。other:internalname プロパティに内部名を設定することができます。結果のカラム値の形式を他のvalueFormat に指定することも可能です。 エンティティ定義の詳細な例を見るには、CSV データのモデリング を参照してください。

<api:info title="CSVPersons" desc="Parse the CSV Persons feed.">
  <attr name="ID"           xs:type="int"        key="true"                                            />
  <attr name="EmployeeID"   xs:type="int"                             other:internalname="employee_id" />
  <attr name="Name"         xs:type="string"                                                           />
  <attr name="TotalExpense" xs:type="double"                                                           />
  <attr name="HireDate"     xs:type="datetime"                                                         />
  <attr name="Salary"       xs:type="int"                                                              />
</api:info>

内部名の定義

other:internalname プロパティは、CSV からカラム値を取得するCSV カラム名を指定するために使われます。したがって、CSV ファイルにemployee_id というカラム名が含まれている場合、other:internalname="employee_id" を使用します。

URL とカラムの定義 が指定されている場合、Sync App はSupportEnhancedSQL を介してクライアント側のインメモリでSELECT ステートメントを処理します。 次のセクションでは、Sync App のビルトインオペレーションを使って、Sync App がどのようにリクエストを出してサーバーからデータを返すかをカスタマイズする方法を示します。

CSV へのSelect の実行

SELECT クエリが発行されると、Sync App は、スキーマのGET メソッドを実行します。このメソッドでは、CSV を処理できます。 このスキーマの詳細な例を見るには、CSV データのモデリング を参照してください。

データの取得

次の行はスキーマをURI にマップします。

<api:set  attr="uri"                      value="ftp://somewebsite/NorthwindOData.csv" />

GET メソッドでデータを取得する処理を呼び出します。api:push キーワードを使って操作を指定します。次の行は、処理の結果をスキーマのアウトプットにプッシュします。

<api:script method="GET" >
  <api:push op="csvproviderGet"/>
</api:script>

データ検索のカスタマイズ

Sync App の操作は、サーバーに送信されるリクエストを高いレベルで制御可能にします。さまざまな入力を設定して、認証やその他のリクエストの側面を制御できます。 利用可能は入力はOperations を参照してください。

また、SQL ステートメントからの入力によってリクエストを構築することもできます。例として、次のセクションでは、WHERE 句を使用してリクエストを動的に変更する方法を示します。WHERE 句で指定された他のフィルタはSync App によってクライアント側で処理されます。レスポンスで返されたあらゆるカラムを検索することができます。

CSV で場所の予測を返す天気予報API を考えてみましょう。URI に必要な場所を指定します。Sync App を使用すると、次のようなクエリで予測を取得できます。

SELECT *
FROM Forecasts 
WHERE (Location = '90210') 

下記の手順に従って、このクエリを実装します。次のプロシージャは、疑似カラム、WHERE 句でのみ使用できる入力を定義し、疑似カラムをAPI リクエストにマップします。

1. ロケーション入力パラメータをapi:info ブロックのカラム定義に追加します。
   

   <api:info>
   ...
   <input  name="Location"                 required="true"/>
   </api:info>

2. ロケーション疑似カラムの値を参照します。次の例では、ロケーションはURI に設定されたCSV リソースの名前です。
   

   <api:set attr='uri' value="http://api.wunderground.com/api/MyAPIKey/hourly/q/[_input.Location].csv"/> 

3. 処理を呼び出してリクエストを行い、レスポンスを処理します。
   

   <api:script method="GET" >
   <api:push op="csvproviderGet"/>
   </api:script>

ページングのカスタマイズ

Sync App の内部ページングメカニズムをオーバーライドするには、Rows@Next 入力をapi:info ブロックのカラムリストに追加します。

<input name="rows@next" desc="Identifier for the next page of results." />

<api:set attr="EnablePaging" value="TRUE" />

例えば、API が次ページのURL を応答で返す場合があります。URL にXPath を指定することでこの値を取得できます。

<api:set  attr="elementmappath#"  value="/next_page" />
<api:set  attr="elementmapname#"  value="rows@next" /> 

<api:check attr="_input.rows@next">
<api:set  attr="uri"  value="[_input.rows@next]" />
<api:else>
<api:set  attr="uri"  value="<first page's URL>" />
</api:else>
<api:check> 

SELECT ステートメントのコンポーネントへのアクセス

_query アイテムを使用して、スキーマのSELECT ステートメントのコンポーネントにアクセスできます。

SELECT Id, Name FROM Accounts WHERE City LIKE '%New%' AND COUNTRY = 'US' GROUP BY CreatedDate ORDER BY Name LIMIT 10,50;

City LIKE '%New%' AND COUNTRY = 'US'

Sync App は、CSV データソースからのデータへのアクセスにおいて高いパフォーマンスのビルトインオペレーションを持ちます。これらのオペレーションはプラットフォームを問いません：これらのオペレーションを呼び出すスキーマファイルは、.NET およびJava 両方で使うことができます。Sync App を、.NET またはJava で書かれたユーザー自身のオペレーションによって拡張することも可能です。

Sync App は次のオペレーションによって成り立ちます：

The csvproviderGet operation is an API Script operation that is used to process CSV content. It allows you to split CSV content into rows.

Required Parameters

• URI: The URI parameter specifies the location of the CSV content. This URI scheme can be file:// for local files or can specify a remote data source: http:// (or https://), s3://, gdrive://, box://, or ftp:// (ftps://).

Network Operation

The csvproviderGet operation can be used to execute remote data retrieval operations. It abstracts the request and also enables configuration of most aspects through the following inputs, including authentication and firewall traversal. See ProxyAuthScheme and FirewallType the properties needed to negotiate a firewall.

Column Mapping

The csvproviderGet operation reads the api:info section of the table schema file to map various elements in the CSV document into column values within a row. It does so using the other:internalname property of the column definition.

HTTP

• Method: The HTTP method that corresponds to the SQL data manipulation statement. The allowed values are GET, POST, PUT, DELETE, and MERGE. The default value is GET.
• ContentType: The content type of the HTTP post. Relevant only if data is specified.
• Data: Data to include in the put or the post.
• Text: Input CSV text (an alternative to URI).
• Header:Name#: The name for each custom header to pass with the request.
• Header:Value#: The value for each custom header to pass with the request.
• ParamName#: The name for each parameter to pass with the request.
• ParamValue#: The value for each parameter to pass with the request.
• Cookie:*: Any cookies that should be added to the request.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• LogFile: The file where exchanged/transferred data is logged.

Authentication

• User: The username used for authentication.
• Password: The password used for authentication.
• AuthScheme: The authentication method to use. Only relevant if User and Password are provided. The allowed values are BASIC, DIGEST, NONE, NTLM, NEGOTIATE. The default value is BASIC.
• KerberosKDC: The KDC setting of Kerberos, available when AuthScheme is NEGOTIATE.
• KerberosRealm: The Realm setting of Kerberos, available when AuthScheme is NEGOTIATE.
• KerberosToken: The Kerberos token used for authentication.

OAuth

• Version: The OAuth version. The allowed values are DISABLED, 1.0, 2.0. The default value is DISABLED.
• Token: The access token for OAuth.
• Token_Secret: The access token secret. OAuth 1.0 only.
• Client_Id: The OAuth client Id. OAuth 1.0 only.
• Client_Secret: The OAuth client secret. OAuth 1.0 only.
• Sign_Method: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Other_Options: Other options to control the behavior of OAuth.

Proxy

• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.

Firewall

• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, and SOCKS5. The default value is NONE.

The oauthGetAccessToken operation is an API Script operation that is used to facilitate the OAuth authentication flow. To pass the needed inputs to the operation, define the GetOAuthAccessToken stored procedure and, if your data source has a refresh flow, RefreshOAuthAccessToken. The Sync App can call this internally.

The Sync App includes stored procedures that invoke this operation to complete the OAuth exchange. The following example schema briefly lists some of the typically required inputs before the following sections explain them in more detail.

For a guide to using the Sync App to authenticate, see the "Getting Started" chapter.

Creating a GetOAuthAccessToken Stored Procedure

Invoke the oauthGetAccessToken with the GetOAuthAccessToken stored procedure. The following inputs are required for most data sources and will provide default values for the connection properties of the same name.

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="GetOAuthAccessToken"   description="Obtains the OAuth access token to be used for authentication with various APIs."                                                         >
    <input  name="AuthMode"               desc="The OAuth flow. APP or WEB."                                                                                                                    />
    <input  name="CallbackURL"            desc="The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. " />
    <input  name="OAuthAccessToken"       desc="The request token. OAuth 1.0 only."                                                                                                             />
    <input  name="OAuthAccessTokenSecret" desc="The request token secret. OAuth 1.0 only."                                                                                                      />
    <input  name="Verifier"               desc="The verifier code obtained when the user grants permissions to your app."                                                                       />

    <output name="OAuthAccessToken"       desc="The access token."                                                                                                                              />
    <output name="OAuthTokenSecret"       desc="The access token secret."                                                                                                                       />
    <output name="OAuthRefreshToken"      desc="A token that may be used to obtain a new access token."                                                                                         />
 </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"                                                    value="MyOAuthVersion"                 />
  <!-- Set RequestTokenURL to the URL where the request for the request token is made. OAuth 1.0 only.-->
  <api:set attr="OAuthRequestTokenURL"                                            value="http://MyOAuthRequestTokenURL" />
  <!-- Set OAuthAuthorizationURL to the URL where the user logs into the service and grants permissions to the application. -->
  <api:set attr="OAuthAuthorizationURL"                                           value="http://MyOAuthAuthorizationURL" />
  <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
  <api:set attr="OAuthAccessTokenURL"                                             value="http://MyOAuthAccessTokenURL"   />
  <!-- Set GrantType to the authorization grant type. OAuth 2.0 only. -->
  <api:set attr="GrantType"                                                       value="CODE"                           />
  <!-- Set SignMethod to the signature method used to calculate the signature of the request. OAuth 1.0 only.-->
  <api:set attr="SignMethod"                                                      value="HMAC-SHA1"                      />
  <api:call op="oauthGetAccessToken">
    <api:push/>
  </api:call>
  
</api:script>

Writing the RefreshOAuthAccessToken Stored Procedure

You can also use oauthGetAccessToken to refresh the access token by providing the following inputs:

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="RefreshOAuthAccessToken" description="Refreshes the OAuth access token used for authentication." >
    <input  name="OAuthRefreshToken"        desc="A token that may be used to obtain a new access token."           /> 
    <output name="OAuthAccessToken"         desc="The authentication token returned."                               />
    <output name="OAuthTokenSecret"         desc="The authentication token secret returned. OAuth 1.0 only."        />
    <output name="OAuthRefreshToken"        desc="A token that may be used to obtain a new access token."           />
    <output name="ExpiresIn"                desc="The remaining lifetime on the access token."                      />

  </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"                                                    value="MyOAuthVersion"                 />
    <!-- Set GrantType to REFRESH. OAuth 2.0 only. -->
    <api:set attr="GrantType"            value="REFRESH" />
    <!-- Set SignMethod to the signature method used to calculate the signature of the request. OAuth 1.0 only.-->
    <api:set attr="SignMethod"           value="HMAC-SHA1" />
    <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
    <api:set attr="OAuthAccessTokenURL"  value="http://MyOAuthAccessTokenURL" />
    <!-- Set AuthMode to 'WEB' when calling RefreshOAuthAccessToken -->
    <api:set attr="AuthMode" value="WEB"/>
  <api:call op="oauthGetAccessToken">
    <api:push/>
  </api:call>
  
</api:script>

Input Parameters

• OAuthVersion: The OAuth version. The allowed values are 1.0, 2.0. The default value is 1.0.
• AuthMode: The OAuth flow. OAuth 2.0 only. If you choose the App mode, this operation will launch your browser and prompt you to authenticate with your account credentials. Set this parameter to WEB to authenticate a Web app or if the Sync App is not allowed to open a Web browser. The default value is APP.
• OAuthRequestTokenURL: The URL where the Sync App makes a request for the request token. OAuth 1.0 only. Required for OAuth 1.0.
• OAuthAuthorizationURL: The URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthAccessTokenURL: The URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.
• CallbackURL: The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. This value must match the callback URL you specify when you register an app. Note that your data source may additionally require the port.
• OAuthClientId: The client Id obtained when you register an app. Also called a consumer key.
• OAuthClientSecret: The client secret obtained when you register an app. Also called a consumer secret.
• OAuthAccessToken: The request token. OAuth 1.0 only.
• OAuthAccessTokenSecret: The request token secret. OAuth 1.0 only.
• OAuthRefreshToken: A token that may be used to obtain a new access token.
• GrantType: Authorization grant type. OAuth 2.0 only. The allowed values are CODE, PASSWORD, CLIENT, REFRESH. The default value is CODE.
• Verifier: The verifier code obtained when the user grants permissions to the Sync App. In the OAuth 2.0 code grant type, the verifier code is located in the code query string parameter of the callback URL. In OAuth 1.0, the verifier is located in the oauth_verifier query string parameter of the callback URL.
• SignMethod: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Cert: Path for the PFX personal certificate file. OAuth 1.0 only.
• CertPassword: Personal certificate password. OAuth 1.0 only.
• OtherOptions: Other options to control the behavior of OAuth.
• OAuthParam:*: Other parameters.
• PostData: The HTTP POST data.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• LogFile: Specifies a file where the request and response are logged.
• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, SOCKS5. The default value is NONE.
• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.

Output Parameters

• OAuthAccessToken: The access token.
• OAuthTokenSecret: The access token secret.
• OAuthRefreshToken: A token that may be used to obtain a new access token.
• ExpiresIn: The remaining lifetime on the access token.
• OAuthParam:*: Other parameters sent from the server.

The oauthGetUserAuthorizationURL is an API Script operation that is used to facilitate the OAuth authentication flow for Web apps, for offline apps, and in situations where the Sync App is not allowed to open a Web browser. To pass the needed inputs to this operation, define the GetOAuthAuthorizationURL stored procedure. The Sync App can call this internally.

Define stored procedures in .rsb files with the same file name as the schema's title. The example schema briefly lists some of the typically required inputs before the following sections explain them in more detail.

For a guide to authenticating in the OAuth flow, see the "Getting Started" chapter.

Writing the GetOAuthAuthorizationURL Stored Procedure

Call oauthGetUserAuthorizationURL in the GetOAuthAuthorizationURL stored procedure.

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="Get OAuth Authorization URL" description="Obtains the OAuth authorization URL used for authentication with various APIs."                                                          >
    <input  name="CallbackURL"                  desc="The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. " />

    <output name="URL"                          desc="The URL where the user logs in and is prompted to grant permissions to the app. "                                                               />
    <output name="OAuthAccessToken"             desc="The request token. OAuth 1.0 only."                                                                                                             />
    <output name="OAuthTokenSecret"             desc="The request token secret. OAuth 1.0 only."                                                                                                      />
  </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"          value="MyOAuthVersion"                 />
  <!-- Set ResponseType to the desired authorization grant type. OAuth 2.0 only.-->
  <api:set attr="ResponseType"           value="code"                           />
  <!-- Set SignMethod to the signature method used to calculate the signature. OAuth 1.0 only.-->
  <api:set attr="SignMethod"            value="HMAC-SHA1"                      />
  <!-- Set OAuthAuthorizationURL to the URL where the user logs into the service and grants permissions to the application. -->
  <api:set attr="OAuthAuthorizationURL"  value="http://MyOAuthAuthorizationURL" />
  <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
  <api:set attr="OAuthAccessTokenURL"   value="http://MyOAuthAccessTokenURL"/>
  <!-- Set RequestTokenURL to the URL where the request for the request token is made. OAuth 1.0 only.-->
  <api:set attr="OAuthRequestTokenURL"   value="http://MyOAuthRequestTokenURL"       />
  <api:call op="oauthGetUserAuthorizationUrl">
    <api:push/>
  </api:call>
  
</api:script>

<p>

Input Parameters

• OAuthVersion: The OAuth version. The allowed values are 1.0, 2.0. The default value is 1.0.
• OAuthAuthorizationURL: The URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthRequestTokenURL: The URL where the Sync App makes a request for the request token. OAuth 1.0 only. Required for OAuth 1.0.
• CallbackURL: The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. This value must match the callback URL you specify when you register an app. Note that your data source may additionally require the port. The default value is http://127.0.0.1/.
• OAuthClientId: The client Id. Also called a consumer key.
• OAuthClientSecret: The client secret. Also called a consumer secret.
• ResponseType: The desired authorization grant type. OAuth 2.0 only. The allowed values are CODE, IMPLICIT. The default value is CODE.
• SignMethod: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, RSA-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Cert: Path for the personal certificate PFX file. OAuth 1.0 only.
• CertPassword: Personal certificate password. OAuth 1.0 only.
• OtherOptions: Other options to control the behavior of OAuth.
• OAuthParam:*: Other parameters. OAuth 1.0 only.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, SOCKS5. The default value is NONE.
• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.

Output Parameters

• URL: The URL where the user logs in and is prompted to grant permissions to the app. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthAccessToken: The request token. OAuth 1.0 only.
• OAuthTokenSecret: The request token secret. OAuth 1.0 only.
• OAuthParam:*: Other parameters sent from the server. OAuth 1.0 only.

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

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

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

クライアントSSL 証明書

CSV Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Authentication

Connection

AWS Authentication

Azure Authentication

SSO

OAuth

JWT OAuth

Kerberos

SSL

SSH

Firewall

Proxy

Logging

Schema

Data Formatting

Miscellaneous

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

リモートサービスに接続する際に使用する認証の種類。

解説

General

次のオプションは、一般的にすべての接続で利用可能です。

• None：認証を使用しません。
• Basic：User およびPassword でBasic 認証を使用します。
• Auto：サービスに基づいて、使用する適切な認証の種類を決定します。ローカルファイルおよびHTTP は、None を使用します。

HTTP

URI がWeb サービスを参照する場合は、次のオプションが利用可能です。

• Digest：User およびPassword でHTTP Digest 認証を使用します。
• NTLM：Windows 資格情報に設定されたUser とPassword で、NTLM 認証を使用します。
• Negotiate：サーバーとネゴシエートして認証スキームを決定します。一般的には、KerberosKDC、KerberosRealm、およびKerberosSPN を必要とするKerberos で使用されます。
• OAuth：OAuth1.0 またはOAuth2.0 のいずれかを使用し、特定のフローはOAuthGrantType によって決定されます。OAuth のどのバージョンを使用するかを決定するには、OAuthVersion を設定する必要があります。
• OAuthJWT：JWT ベアラーグラント種別でOAuth2.0 を使用します。OAuthJWTCertType およびOAuthJWTCert は、JWT がどの証明書で署名されるかを決定します。OAuthVersion は2.0に設定する必要があります。
• OAuthPassword：パスワードグラント種別でOAuth2.0 を使用します。User およびPassword は資格情報です。OAuthVersion は2.0に設定する必要があります。
• OAuthClient：クライアント資格情報グラント種別でOAuth2.0 を使用します。OAuthClientId およびOAuthClientSecret は資格情報です。OAuthVersion は2.0に設定する必要があります。
• OAuthPKCE：認証コードグラント種別とPKCE 拡張仕様でOAuth2.0 を使用します。OAuthClientId は資格情報です。OAuthVersion は2.0に設定する必要があります。
• SSL：SSL クライアント証明書を使用して認証します。URI をHTTPS URL に設定して、SSLClientCert とSSLClientCertType を設定する必要があります。

AWS

URI がAmazon サービスを指す場合は、次のオプションも使用できます。

• AwsRootKeys：ルートユーザーのアクセスキーおよびシークレットを使用する場合に設定。簡易なテストには便利ですが、本番環境のユースケースでは、権限を絞ったものを使用することをお勧めします。
• AwsIAMRoles：接続にIAM ロールを使用する場合に設定。
• AwsEC2Roles：CData Sync App が現在実行されているEC2 マシンに割り当てられたIAM ロールを、自動的に使用する場合に設定。
• AwsMFA：マルチファクタ認証を使用する場合に設定。
• OKTA：OKTA をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• ADFS：ADFS をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• AzureAD：AzureAD をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• AwsTempCredentials：一時的なセキュリティ認証情報を、セッショントークンと一緒に利用して接続する場合に設定。
• AwsCredentialsFile：認証に認証情報ファイルを使用する場合に設定。

Azure

URI がAzure サービスを指す場合は、次のオプションも利用できます。

• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureServicePrincipal：Azure サービスプリンシパルとして認証する場合に設定。
• AzureMSI：Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得する場合に設定。

SharePoint

URI がSharePoint SOAP サービスを指す場合は、次のオプションも使用できます。

• OKTA：OKTA をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• ADFS：ADFS をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• OneLogin：OneLogin をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• PingFederate：PingFederate をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。

IBM Cloud Object Storage

URI がIBM Cloud Object Storage サービスを指す場合は、次のオプションも使用できます。

• OAuth：InitiateOAuth によって決定された特定のフローでいずれかのOAuthを使用します。ApiKey が設定されていないと、このフローは正常に終了しません。
• HMAC：AccessKey とSecretKey で、IBM Cloud Object Storage サービスを認証します。

アカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。

解説

アカウントのアクセスキー。この値には、使用しているサービスに応じたセキュリティ認証情報ページからアクセスできます。

アカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。

解説

アカウントのシークレットキー。この値には、使用しているサービスに応じたセキュリティ認証情報ページからアクセスできます。

IBM Cloud にユーザーを識別させるためのAPI キー。

解説

CSV REST API のリソースへのアクセスは、トークンを取得するためのAPI キーで管理されています。API キーは、［Manage（管理）］->［Access（IAM）］->［Users（ユーザー）］と移動して、［Create（作成）］をクリックすることで作成できます。

The user account used to authenticate.

解説

Together with Password, this field is used to authenticate against the server.

This property will refer to different things based on the context, namely the value of ConnectionType and AuthScheme:

• ConnectionType=AmazonS3
  • AuthScheme=ADFS: This refers to your ADFS username.
  • AuthScheme=Okta: This refers to your Okta username.
  • AuthScheme=PingFederate: This refers to your PingFederate username.
• ConnectionType=FTP(S)
  • AuthScheme=Basic: This refers to your FTP(S) server username.
• ConnectionType=HDFS/HDFS Secure
  • AuthScheme=Negotiate: This refers to your HDFS intance username.
• ConnectionType=HTTP(S)
  • AuthScheme=Basic: This refers to the username associated with the HTTP stream.
  • AuthScheme=Digest: This refers to the username associated with the HTTP stream.
  • AuthScheme=OAuthPassword: This refers to the username associated with the HTTP stream.
• ConnectionType=SharePoint SOAP
  • AuthScheme=Basic: This refers to your SharePoint account username.
  • AuthScheme=ADFS: This refers to your ADFS username.
  • AuthScheme=Okta: This refers to your Okta username.
  • AuthScheme=OneLogin: This refers to your OneLogin username.

The password used to authenticate the user.

解説

The User and Password are together used to authenticate with the server.

This property will refer to different things based on the context, namely the value of ConnectionType and AuthScheme:

• ConnectionType=AmazonS3
  • AuthScheme=ADFS: This refers to your ADFS password.
  • AuthScheme=Okta: This refers to your Okta password.
  • AuthScheme=PingFederate: This refers to your PingFederate password.
• ConnectionType=FTP(S)
  • AuthScheme=Basic: This refers to your FTP(S) server password.
• ConnectionType=HDFS/HDFS Secure
  • AuthScheme=Negotiate: This refers to your HDFS intance password.
• ConnectionType=HTTP(S)
  • AuthScheme=Basic: This refers to the password associated with the HTTP stream.
  • AuthScheme=Digest: This refers to the password associated with the HTTP stream.
  • AuthScheme=OAuthPassword: This refers to the password associated with the HTTP stream.
• ConnectionType=SharePoint SOAP
  • AuthScheme=Basic: This refers to your SharePoint account password.
  • AuthScheme=ADFS: This refers to your ADFS password.
  • AuthScheme=Okta: This refers to your Okta password.
  • AuthScheme=OneLogin: This refers to your OneLogin password.

使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

解説

使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

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

使用する接続の種類。

解説

ConnectionType を以下のいずれかに設定します。

• Auto
• Local
• Amazon S3
• Azure Blob Storage
• Azure Data Lake Storage Gen1
• Azure Data Lake Storage Gen2
• Azure Data Lake Storage Gen2 SSL
• Azure Files
• Box
• Dropbox
• FTP
• FTPS
• Google Cloud Storage
• Google Drive
• HDFS
• HDFS Secure
• HTTP
• HTTPS
• IBM Object Storage Source
• OneDrive
• Oracle Cloud Storage
• SFTP
• SharePoint REST
• SharePoint SOAP

ConnectionType を以下のいずれかに設定します。

• Auto
• Local
• Amazon S3
• Azure Blob Storage
• Azure Data Lake Storage Gen1
• Azure Data Lake Storage Gen2
• Azure Data Lake Storage Gen2 SSL
• Azure Files
• Box
• Dropbox
• FTP
• FTPS
• Google Cloud Storage
• Google Drive
• HDFS
• HDFS Secure
• HTTP
• HTTPS
• IBM Object Storage Source
• OneDrive
• Oracle Cloud Storage
• SFTP
• SharePoint REST
• SharePoint SOAP

CSV リソースロケーションのUniform Resource Identifier (URI)。

解説

URI プロパティを設定して、ファイルまたはストリームへのパスを指定します。

NOTE: this connection property requires that you set ConnectionType, which provide the

複数ファイルのパースおよびマージに使用できる、より高度な機能については、 を参照してください。

以下は、使用可能なデータソースのURI 形式の例です。

接続文字列とクエリの例

以下は、CSV ファイルまたはストリームへの接続文字列の例です。

S3ライクなWeb サービスのホスティングリージョン。

解説

S3ライクなWeb サービスのホスティングリージョン。

Oracle Cloud Object Storage のリージョン

Wasabi のリージョン

Google Cloud Storage インスタンスが存在するプロジェクトのId。

解説

Google Cloud Storage インスタンスが存在するプロジェクトのId。この値は、Google Cloud コンソールにアクセスして左上画面のプロジェクト名をクリックすると確認できます。ProjectId は一致するプロジェクトのId カラムに表示されます。

使用するOracle Cloud Object Storage ネームスペース。

解説

使用するOracle Cloud Object Storage ネームスペース。リクエストを行う前に、この設定をOracle Cloud アカウントに関連付けられてたOracle Cloud Object Storage ネームスペースに設定する必要があります。お使いのアカウントのObject Storage ネームスペースを検索する方法については、Oracle Cloud ドキュメントのUnderstanding Object Storage Namespaces ページを参照してください。

クラウドストレージサービスプロバイダーのURL。

解説

このプロパティは、以下を指定するために使われます。

• カスタムS3サービスのURL。
• Sharepoint SOAP / REST クラウドストレージサービスプロバイダーに必要なURL。

  このオプションのドメインが-my で終わる場合（例えば、https://bigcorp-my.sharepoint.com）、sp:// またはsprest:// スキームの代わりに onedrive:// スキームを使用する必要がある場合があります。

この設定はしきい値をバイト単位で設定します。このしきい値を超えると、provider は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。

解説

この設定はしきい値をバイト単位で設定します。このしきい値を超えると、Sync App は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。

True（デフォルト）の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます：http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します：http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

解説

True（デフォルト）の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます：http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します：http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

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

AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

認証時に使用するロールのAmazon リソースネーム。

解説

AWS の外部で認証する場合は、AWS アカウント認証情報ではなく、ロールを認証に使用するのが 一般的です。AWSRoleARN を入力すると、CData Sync App はAWSAccessKey とAWSSecretKey を直接 使用する代わりに、ロールベースの認証を実行します。この認証を実行するためには、AWSAccessKey と AWSSecretKey を指定する必要があります。RoleARN を設定するときは、AWS ルートユーザーの 認証情報を使用できません。AWSAccessKey およびAWSSecretKey はIAM ユーザーのものである必要があります。

AWS アカウントのSAML ID プロバイダーのARN。

解説

AWS アカウントのSAML ID プロバイダーのARN。

Amazon Web サービスのホスティングリージョン。

解説

Amazon Web サービスのホスティングリージョン。利用可能な値はOHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、JAKARTA、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、STOCKHOLM、ZURICH、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST です。

認証に使用するAWS クレデンシャルファイルへのパス。

解説

認証に使用するAWS クレデンシャルファイルへのパス。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。

提供されたAWSCredentialsFile から使用されるプロファイルの名前。

解説

提供されたAWSCredentialsFile から使用されるプロファイルの名前。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。

AWS のセッショントークン。

解説

AWS のセッショントークン。この値はさまざまな方法で取得できます。詳しくは、this link を参照してください。

A unique identifier that might be required when you assume a role in another account.

解説

A unique identifier that might be required when you assume a role in another account.

MFA デバイスが使用されている場合は、そのシリアル番号。

解説

AWS マネジメントコンソールにアクセスしてユーザーのセキュリティ認証情報を表示することで、IAM ユーザーのデバイスを見つけることができます。 仮想デバイスの場合、これは実際にはAmazon リソースネームです（ arn:aws:iam::123456789012:mfa/user など）。

MFA デバイスから利用できる一時トークン。

解説

MFA が必要な場合、この値はログインのためのテンポラリクレデンシャルを取得するためにMFASerialNumber とともに使用されます。 AWS から入手可能な一時的な認証情報はデフォルトで最長1時間しか持続しません（TemporaryTokenDuration を参照してください）。時間が経過したら、新しい認証情報を取得できるように、接続を 更新して新しいMFA トークンを指定する必要があります。 %AWSpSecurityToken; %AWSpTemporaryTokenDuration;

一時トークンが持続する時間（秒単位）。

解説

一時トークンは、MFA 認証とロールベース認証の両方で使用されます。一時トークンは、やがてタイムアウトします。 そのときには、新しい一時トークンを取得する必要があります。MFA が使用されていない状況では、これは大したこと ではありません。一時トークンが期限切れになると、CData Sync App は内部的に新しい一時トークンをリクエストします。

ただし、MFA が必要な接続の場合は、新しい一時トークンを取得するために新しいMFAToken を接続で指定 する必要があります。これは、ユーザーによる接続の更新が必要になるため、より煩わしい問題です。指定できる 最大値と最小値は、使用されている接続によって大きく異なります。

ロールベース認証の場合は、最小期間は900秒（15分）で、最大期間は3600秒（1時間）です。 ロールベース認証でMFA が使用されている場合でも、3600秒が依然として最大です。

MFA 認証自体では（IAM ユーザーまたはルートユーザーを使用）、最小値は900秒（15分）、 最大値は129600（36時間）です。

有効にすると、Amazon S3バケットへのファイルアップロードがサーバー側で暗号化されます。

解説

サーバー側の暗号化とは、データを受信するアプリケーションまたはサービスによって、送信先でデータを暗号化することです。Amazon S3は、データセンターのディスクに書き込まれるときにデータをオブジェクトレベルで暗号化し、ユーザーがデータにアクセスするときに復号します。詳しくは、こちらを参照してください。https://docs.aws.amazon.com/ja_jp/AmazonS3/latest/userguide/serv-side-encryption.html

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

Azure ストレージアカウント名。

解説

Azure ストレージアカウントの名前。

CSV アカウントに関連付けられているストレージキー。

解説

CSV アカウントに関連付けられているストレージキー。以下のように取得できます：

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定で［アクセスキー］をクリックします。
4. ページ上にストレージアカウント名とキーが表示されます。

認証に使用可能な共有アクセスキー署名。

解説

共有アクセス署名。以下の手順で作成することができます。

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定で［Shared Access Signature］をクリックします。
4. 権限およびトークンの有効期限を設定します。
5. ［Generate SAS］をクリックするとトークンをコピーできます。

データにアクセスするために使用される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 を明示的に指定する必要があります。

接続を確立するときに使用するAzure 環境。

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。

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

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。

解説

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。SSOLoginURL と一緒に使われます。

SSO configuration is discussed further in .

SAML 応答を処理して、CSV の資格情報と交換するために使用するURL。

解説

CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、CSV の資格情報を取得します。 取得した資格情報はSSO 接続時の最後の情報であり、CSV との通信に使用されます。

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

使われているOAuth のバージョン。

解説

使われているOAuth のバージョン。次のオプションが利用可能です：1.0,2.0

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

解説

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

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

解説

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

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

解説

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

OAuth フローのグラント種別。

解説

次のオプションが利用可能です：CODE,CLIENT,PASSWORD

OAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。

解説

OAuth RFC では、Password OAuthGrantType を使用する際にOAuthClientId とOAuthClientSecret を渡す2つの方法を指定します。 最も一般的な方法は、post データを介してサービスに渡す方法です。しかし、一部のサービスでは、BASIC 認証で使用するためにAuthorize ヘッダーを介して渡すことを要求する場合があります。 このプロパティをBasic に変更すると、パラメータをpost データではなくAuthorize ヘッダーの一部として送信します。

Whether to include the callback URL in an access token request.

解説

This defaults to true since standards-compliant OAuth services will ignore the redirect_uri parameter for grant types like CLIENT or PASSWORD that do not require it.

This option should only be enabled for OAuth services that report errors when redirect_uri is included.

OAuth サービスの認可URL。

解説

OAuth サービスの認可URL。このURL でユーザーはサーバーにログインしてアプリケーションにアクセス許可を与えます。OAuth 1.0 では、アクセス許可が付与されるとリクエストトークンが認可されます。

OAuth アクセストークンを取得するURL。

解説

OAuth アクセストークンを取得するURL。OAuth 1.0 では、このURL で認可されたリクエストトークンがアクセストークンと交換されます。

OAuth トークンをリフレッシュするURL。

解説

OAuth トークンをリフレッシュするURL。OAuth 2.0 では、古いトークンの期限が切れたときは、このURL でリフレッシュトークンと新しいアクセストークンと交換します。

サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。

解説

サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。OAuth 1.0 では、これがアプリケーションがリクエストトークンをリクエストするURL です。

OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。

解説

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthKey とともに指定して、OAuthAccessToken を取得できます。

OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。

解説

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthToken とともに指定して、OAuthAccessToken を取得できます。

OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

解説

OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

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

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

Java Web Token の発行者。

解説

Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

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

ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

ユーザー認証に使用されるKerberos 領域。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Kerberos 領域は、Kerberos キー配布センター（KDC）サービスを使用してユーザーを認証するために使用されます。Kerberos 領域は、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。

Kerberos 領域が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからデフォルトレルムを取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App はユーザー設定されているドメイン名およびホストからそれらを推測します。これは、一部のWindows 環境で機能します。

Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。

解説

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

解説

Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

サービスのKerberos レルム。

解説

KerberosServiceRealm は、クロスレルムKerberos 認証を使用するときにサービスKerberos レルムを指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

サービスのKerberos KDC。

解説

KerberosServiceKDC は、クロスレルムKerberos 認証を使用するときにサービスKerberos KDC を指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

MIT Kerberos 資格情報キャッシュファイルへのフルパス。

解説

このプロパティは、MIT Kerberos チケットマネージャーまたはkinit コマンドを使用して作成された資格情報キャッシュファイルを使用する場合に設定できます。

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

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。

解説

クライアント証明書のための証明書ストア名。

SSLClientCertType フィールドは、SSLClientCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、SSLClientCertPassword でパスワードを指定します。

SSLClientCert は、SSLClientCertSubject フィールドとともにクライアント証明書を指定するために使われます。SSLClientCert に値がある場合で、SSLClientCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、SSLClientCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

TLS/SSL クライアント証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

TLS/SSL クライアント証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

TLS/SSL クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]" です。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

FTP またはFTPS サーバーに接続する際の認証メカニズム。

解説

SSLMode がNONE に設定されている場合、サーバーへのログインには、デフォルトのプレーンテキストでの認証が使われます。 SSLMode がIMPLICIT に設定されている場合、接続が確立された直後にSSL ネゴシエーションが開始されます。 SSLMode がEXPLICIT に設定されている場合、Sync App は最初にプレーンテキストで接続し、次にSTARTTLS などのプロトコルコマンドを使用してSSL ネゴシエーションを明示的に開始します。 SSLMode がAUTOMATIC に設定されている場合、リモートポートがプロトコルの標準のプレーンテキストポート（適用可能な場所）に設定されている場合、コンポーネントはSSLMode がEXPLICIT に設定されている場合と同じように動作します。その他すべてのケースでは、SSL ネゴシエーションはIMPLICIT になります。

• AUTOMATIC
• NONE
• IMPLICIT
• EXPLICIT

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

解説

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

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

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

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

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

SFTP サーバーへのログオンに使用する認証方法。

解説

• None：認証は行われません。現在のUser の値は無視され、接続は匿名でログインされます。
• Password：Sync App は、User とPassword の値を使用してユーザーを認証します。
• Public_Key：Sync App は、User とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

ユーザーの認証に使用する秘密鍵。

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はSync App が秘密鍵から生成します。 Sync App は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Sync App はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

SSHClientCert キーのパスワード（ある場合）。

解説

このプロパティは、SSHAuthMode がPublicKey に設定され、SSHClientCert が秘密鍵に設定されているSFTP サーバーに認証する場合にのみ使用されます。

SSH クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

SSHClientCert 秘密鍵の種類。

解説

このプロパティには次の値の1つを設定できます。

SSH ユーザー。

解説

SSH ユーザー。

SSH パスワード。

解説

SSH パスワード。

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

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

解説

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

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 をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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 もしくはKereros トークンを取得します。
• 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 のいずれかです。有効な値は次のとおりです。

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

解説

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

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

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

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

解説

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

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

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

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

解説

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

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

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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` です。

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

schema.ini ファイルを含むディレクトリのパス。

解説

schema.ini ファイルを含むディレクトリのパス。schema.ini ファイルに別の名前を指定したい場合にも使用できます。

true に設定すると、プロバイダーは URI ディレクトリ内にある同じスキーマを持つすべてのファイルを AggregatedFiles と呼ばれる単一のテーブルに集計します。

解説

デフォルトでは、フォルダ内の最初のファイルがスキーマの定義に使用されますが、MetadataDiscoveryURI を指定して代わりに別のファイルを使用することもできます。

例えば、以下のCSV のコンテンツを見てみましょう。

File 1

ItemID,Name,NumInStock
1,Peanuts - Salted,76
2,Peanuts - Unsalted,43
3,Raisins,26

File 2

ItemID,Name,NumInStock
4,Pretzels - Original,55
5,Pretzels - Chocolate,35
6,Toffee,44

結果の集計テーブルは以下のとおりです。集計では、定義されたスキーマに存在するカラムのみが使用されることに注意してください。

AggregateFiles

ItemID,Name,NumInStock
1,Peanuts - Salted,76
2,Peanuts - Unsalted,43
3,Raisins,26
4,Pretzels - Original,55
5,Pretzels - Chocolate,35
6,Toffee,44

AggregateFiles と併用され、AggregatedFiles 結果セットのスキーマを読み出すための特定のファイルを指定します。

解説

AggregateFiles と併用され、AggregatedFiles 結果セットのスキーマを読み出すための特定のファイルを指定します。

カラムのデータ型を決定するための方法を指定します。

解説

The number of columns to detect when dynamically determining columns for the table.

解説

The number of columns to detect when dynamically determining columns for the table. Columns are dynamically determined when a schema (RSD) file is not available for the table, such as when using GenerateSchemaFiles. To specify the number of columns set the ColumnCount connection property.

動的にテーブルのカラムを決定するためにスキャンする行数。

解説

動的にテーブルのカラムを決定するためにスキャンする行数。 GenerateSchemaFiles を使用しているときなど、スキーマ（RSD）ファイルがテーブルに対して見つからない場合、カラムは動的に決定されます。

大きな値に設定すると、リクエストにより時間がかかりますが正確さが増します。

この値を0 （ゼロ）に設定すると、CSV ドキュメント全体をパースします。

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

指定したファイルの一行目からカラム名を取得するかどうか。

解説

このプロパティをTrue に設定すると、Sync App は各テーブルのカラム名を各ファイルの一行目から取得します。このプロパティをFalse に設定すると、カラム名は単純にカラム番号になります。カラム名がSchema.ini で定義されていない場合もです。

Microsoft Jet OLE DB 4.0 と同様に、このプロパティはExtendedProperties でも指定できます。ExtendedProperties で指定されたIncludeColumnHeaders 値は、このプロパティをオーバーライドします。

次の接続文字列は、.csv と.log ファイルをヘッダーなしのCSV としてパースします。

DataSource=C:\mycsvlogs;IncludeColumnHeaders=False;Include Files='CSV,LOG'

すべてのテキストファイルのパースに使用する形式。

解説

この接続プロパティを設定すると、Sync App は指定されたファイル形式に従ってURI のすべてのテキストファイルをパースします。テキストファイルの形式は、Microsoft Jet OLE DB 4.0 ExtendedProperties for text files と同様に、ExtendedProperties でも指定できます。ExtendedProperties で指定された形式は、スタンドアロン接続プロパティとして設定された形式をオーバーライドします。Schema.ini のFormat プロパティは、接続文字列で設定されたファイル形式をオーバーライドします。

FMT には次のいずれかの値を設定できます。

• CsvDelimited：Sync App は各フィールドをカンマで区切ります。
• TabDelimited：Sync App は各フィールドをタブで区切ります。
• FixedLength：Sync App は各フィールドを区切るために指定された文字数をカウントします。この形式を指定した場合は、各カラムの幅をSchema.ini で定義する必要があります。

次の接続文字列は、URI で指定されたフォルダ内のすべてのテキストファイルをヘッダー付きのタブ区切りの値としてパースします。

URI=C:\mytsv;FMT=TabDelimited

プロパティが上記の値以外の値に設定されている場合は、指定された入力の文字リテラルが区切り文字として読み取られます。例：

URI=C:\mypipdelimitedfile;FMT=||

Microsoft Jet OLE DB 4.0互換のテキストファイルの拡張プロパティです。

解説

Microsoft Jet OLE DB 4.0互換のテキストファイルの拡張プロパティです。 このプロパティを使ってテキストファイルの形式を指定できます。ローカルファイルを処理する場合は、Schema.ini で指定された個別ファイルの形式は、ExtendedProperties で指定された形式をオーバーライドします。

次の例は、URI フォルダ内のすべてのテキストファイルをヘッダー付きのタブ区切りの値としてパースします：ExtendedProperties='text;FMT=TabDelimited'

.csv および.log ファイルをヘッダーなしCSV としてパース：

ExtendedProperties='text;IncludeColumnHeaders=False';Include Files='CSV,LOG'

CSV の行末を検出する際に使用する文字。

解説

CSV ファイルに\r、\n、\r\n、\n\r が行の区切り文字として含まれる場合、このプロパティを指定する必要はありません。 行の区切り文字としてHEX 文字列を指定することができます（例：RowDelimiter=0x01）。

指定した行数を上から読み飛ばします。

解説

指定した行数を上から読み飛ばします。

空の行をスキップするかどうかを示します。

解説

空の行をスキップするかどうかを示します。

カラムヘッダー内のカラム名に空の値を含めるかどうか。

解説

このプロパティをFalse に設定すると、Sync App はカラムヘッダーに値を持たないカラムを除外します。 True に設定すると、Sync App はカラム番号からカラム名を取得します。この動作はヘッダーに値のないカラムにのみ適用されます。 カラムがヘッダーに値を持つ場合、そのまま保持されます。

true に設定すると、ファイルの先頭の# から始まる行がスキップされます。

解説

# で始まらない行が見つかるまで、# で始まる行をスキップします。後続の行は、# で始まるかどうかにかかわらず読み取られます。

CSV ファイルに移行、またはCSV ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。

解説

CSV ファイルに移行、またはCSV ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。

値を囲む文字をエスケープする際に使用する文字を指定します。

解説

値を囲む文字をエスケープする際に使用する文字を指定します。

CSV ファイルで値を囲む際に使用する文字を指定します。

解説

CSV ファイルで値を囲む際に使用する文字を指定します。

Note： このプロパティはCSV ファイルでのみ機能します。値を囲む文字なしでCSV ファイルにフィールドを追加したい場合、このプロパティに"NONE" を設定してください。

囲まれた値を含むセル内の先頭と末尾のスペースを、プロバイダが削除するよう設定したい場合はTrue に設定します。

解説

囲まれた値を含むセル内の先頭と末尾のスペースを、プロバイダが削除するよう設定したい場合はTrue に設定します。False に設定され、セル内の先頭の文字が値を囲む文字でない場合、セルは囲まれていないそのままの値として扱われます。

空の値を空として読み取るか、null として読み取るかを示します。

解説

空の値を空として読み取るか、null として読み取るかを示します。

CSV ファイル内で見つかった場合null に変換される値の一覧（カンマ区切り）。

解説

CSV ファイル内で見つかった場合null に変換される値の一覧（カンマ区切り）。例："NaN,\N,N/A"。指定された値がCSV の行に見つかった場合、null に変換されます。

Determines the character which will be used to replace the file separator.

解説

Determines the character which will be used to replace the file separator. If there is a CSV file located in "Test/CSVFiles/Test.csv" and if this property is set to "_", then the table name for this file would be "Test_CSVFiles_Test.csv".

Indicates whether to ignore incomplete rows.

解説

Indicates whether to ignore the rows that do not match the headers.

Max length a cell can hold, after passing this number the cell content will get truncated. If value is -1 then we don't limit the cell content length.

解説

Max length a cell can hold, after passing this number the cell content will get truncated. If value is -1 then we don't limit the cell content length.

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

Determines the naming convention of batch files.

解説

Determines the naming convention of batch files.

• Timestamp_BatchNumber: The file name formatted as yyyyMMddhhmmssSSS_batchNumber, where the timestamp marks the beginning of the transaction.
• TableName_BatchNumber: The file name formatted as TableName_batchNumber.csv.

このプロパティを使用して、クライアントアプリケーションが受け取るデータの形式（通貨値など）を指定できます。このプロパティは、クライアントアプリケーションがマシンの現在のカルチャ設定をサポートしていない場合に使用できます。例えば、Microsoft Access では'en-US' が必要です。

解説

このオプションは、Sync App 出力の形式に影響を与えます。入力の解釈方法を定義する形式を指定するには、Culture オプションを使用します。デフォルトでは、Sync App は入力の解釈と出力の形式に、マシンの現在のロケール設定を使用します。

Whether to create a folder or not when InsertMode is set to FilePerBatch.

解説

Whether to create a folder or not when InsertMode is set to FilePerBatch.

この設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。

解説

このプロパティは、Sync App 入力に影響を与えます。別のカルチャ形式の値を解釈するには、Client Culture プロパティを使用します。デフォルトでは、Sync App は入力の解釈と出力の形式に、マシンの現在のロケール設定を使用します。

ユーザーが決定したその他のヘッダー（オプション）。

解説

このプロパティは、他のプロパティ（ContentType、From など）から作成されたHTTP リクエストヘッダーに追加するヘッダーの文字列に設定できます。

ヘッダーは、HTTP の仕様で説明されているとおり、"header: value" 形式でなければなりません。ヘッダー行はキャリッジリターンと改行（CRLF）文字で区切る必要があります。

このプロパティは慎重に使用してください。このプロパティに無効なヘッダーが含まれていると、HTTP リクエストは失敗する場合があります。

このプロパティは、専門的/非標準的なAPI と統合するためにSync App の機能を微調整する場合に便利です。

リクエストに含めるカスタムクエリ文字列。

解説

CustomUrlParams を使用すると、HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定できます。パラメータは、field1=value1&field2=value2&field3=value3 の形式で、クエリ文字列としてエンコードする必要があります。クエリ文字列の値はURL エンコードされている必要があります。

IncludeSubdirectories が有効の場合に、再帰的にスキャンされるサブフォルダを制限します。

解説

IncludeSubdirectories が有効の場合は、DirectoryRetrievalDepth は、停止する前に再帰的にスキャンするサブフォルダの数を指定します。-1 は、すべてのサブフォルダをスキャンすることを示します。

ファイル拡張子をテーブル名から除外する必要がある場合はtrue に設定します。

解説

ファイル拡張子をテーブル名から除外する必要がある場合はtrue に設定します。例えば、true に設定すると、`users.csv`が`users`として表示されます。

テーブルとしてモデル化されたファイル一式から除外するファイル拡張子のカンマ区切りリスト。

解説

datetime フィルタを指定することも可能です。現在、CreatedDate およびModifiedDate がサポートされています。 すべての拡張フィルタは論理和（OR 演算子を使用）で評価され、結果のフィルタはdatetime フィルタと組み合わせて（AND 演算子を使用）評価されます。

例：

ExcludeFiles="TXT,CreatedDate<='2020-11-26T07:39:34-05:00'"
ExcludeFiles="TXT,ModifiedDate<=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 50, 000)"
ExcludeFiles="ModifiedDate>=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 49, 000),ModifiedDate<=CURRENT_TIMESTAMP()"

Google Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。

解説

Google Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。

スキーマを生成して保存するユーザーの好みのタイミングを示します。

解説

このプロパティは、Location で指定されたパスの.rsd ファイルにスキーマをアウトプットします。

有効な設定は次のとおりです。

• Never：スキーマファイルは生成されません。
• OnUse：スキーマファイルがまだ存在していない場合に、初めてテーブルが参照されるときにスキーマファイルが生成されます。
• OnStart：現在スキーマファイルを持たないあらゆるテーブルに対して、接続時にスキーマファイルが生成されます。
• OnCreate：CREATE TABLE SQL クエリを実行すると、スキーマファイルが生成されます。

.rsd ファイルで定義されたカラムは、Schema.ini の定義よりも優先されます。 ファイルを再生成したい場合には、既存のファイルを削除する必要があることに注意してください。

SQL でスキーマを生成する

GenerateSchemaFiles をOnUse に設定すると、Sync App はSELECT クエリを実行したときにスキーマを生成します。スキーマはクエリのそれぞれの参照されたテーブルに対して生成されます。

GenerateSchemaFiles をOnCreate に設定すると、CREATE TABLE クエリが実行されたときにのみスキーマが生成されます。

接続時にスキーマを生成する

このプロパティのもう一つの使い方は、接続するときにデータベース内のすべてのテーブルのスキーマを取得することです。これには、GenerateSchemaFiles をOnStart に設定して接続します。

Dropbox チームフォルダやファイルを含めるかどうかを示します。

解説

Dropbox チームフォルダやファイルにアクセスするには、この接続プロパティをTrue に設定してください。

テーブルとしてモデル化されたファイル一式に含めるファイル拡張子のカンマ区切りリスト。

解説

Comma-separated list of file extensions to include into the set of the files modeled as tables. For example, IncludeFiles=TXT,TAB. The default is CSV, TAB, and TXT.

A 'NOEXT' value can be specified to include files without an extension.

The following archive types are also supported (currently only when AggregateFiles is true): ZIP, TAR, and GZ.

When archive files are found, they will be downloaded to the local machine so the Sync App can extract and parse the contained files. Note: Files contained within an archive must match an extension listed in IncludeFiles to be included in the set of files modeled as tables.

File masks can be specified using an asterisk (*) to provide enhanced filtering capabilities; e.g. IncludeFiles=2020*.csv,TXT.

Files specified in Schema.ini are honored in addition to the files included by this property.

datetime フィルタを指定することも可能です。現在、CreatedDate およびModifiedDate がサポートされています。 すべての拡張フィルタは論理和（OR 演算子を使用）で評価され、結果のフィルタはdatetime フィルタと組み合わせて（AND 演算子を使用）評価されます。

例：

IncludeFiles="TXT,CreatedDate<='2020-11-26T07:39:34-05:00'"
IncludeFiles="TXT,ModifiedDate<=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 50, 000)"
IncludeFiles="ModifiedDate>=DATETIMEFROMPARTS(2020, 11, 26, 7, 40, 49, 000),ModifiedDate<=CURRENT_TIMESTAMP()"

Google Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。

解説

このプロパティを'True' に設定すると、共有ドライブを含むすべてのドライブからファイルが取得されます。URI の先頭を共有ドライブのパスに設定し、オプションで任意のフォルダを指定することで、ファイルの検索対象を特定の共有ドライブまたは共有ドライブ内の特定のフォルダに限定することができます（例：'gdrive://SharedDriveA/FolderA/...'）。さらに、FolderId プロパティを使用すると検索対象を正確なサブディレクトリに限定できます。

ネストされたフォルダからファイルを読み出すかどうか。名前衝突が起こった場合は、テーブル名の前にアンダースコアで区切られたフォルダ名が付けられます。

解説

ネストされたフォルダからファイルを読み取るかどうか。ローカルCSVにアクセスする場合、Sync App はサブフォルダで定義されたSchema.ini を尊重します。テーブル名には、テーブル名が競合する場合にのみ、アンダースコアで区切られたネストされた各フォルダ名の接頭辞が付けられます。次に例を示します。

When defining a Schema.ini for local CSV folders, table names do not need to be prefixed in the section names. This allows you to move the folder or use the Sync App alongside the OLEDB Jet Driver.

CSV ファイルにデータを挿入する際のモードを指定します。

解説

CSV ファイルへのデータ挿入には、2つのモードが利用可能です。

• FilePerBatch：バッチごとに新しいCSV ファイルが作成されます。ファイル名は、"yyyyMMddhhmmssSSS_batchId" のフォーマットになり、日付と時刻がトランザクションの開始を表します。
• SingleFile：このモードでは、すべてが単一のCSV ファイルに挿入されます。

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

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

解説

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

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

統合およびフォーマット

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

解説

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

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

解説

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

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

解説

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

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

プロバイダが各挿入（バッチ挿入）時に切り捨てるようにする場合は、True に設定します。

解説

プロバイダが各挿入（バッチ挿入）時に切り捨てるようにする場合は、True に設定します。

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

解説

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

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

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

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

次に例を示します。

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

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

CSV で削除や更新を行う場合で、カスタムスキーマを指定したくない場合は、これをtrue に設定します。これにより、そのテーブルのキーとして使用されるRowNumber という名前の新しいカラムが作成されます。

解説

CSV で削除や更新を行う場合で、カスタムスキーマを指定したくない場合は、これをtrue に設定します。これにより、そのテーブルのキーとして使用されるRowNumber という名前の新しいカラムが作成されます。