Microsoft Excel Connector for CData Sync

Build 22.0.8479
  • Microsoft Excel
      • リモートMicrosoft Excel メタデータの表示
    • 接続の確立
      • Amazon S3 への接続
      • Azure Blob Storage への接続
      • Azure Data Lake Storage への接続
      • Box への接続
        • カスタムOAuth アプリの作成
      • Dropbox への接続
        • カスタムOAuth アプリの作成
      • Google Cloud Storage への接続
        • カスタムOAuth アプリの作成
      • Google Drive への接続
        • カスタムOAuth アプリの作成
      • HTTP Streams への接続
      • IBM Object Storage への接続
      • OneDrive への接続
      • SFTP への接続
      • SharePoint Online への接続
      • SSO 接続
      • データアクセスのファインチューニング
      • Kerberos の使用
    • Excel 操作
      • データの選択
      • データの変更
      • 式の使用
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • AccessKey
        • SecretKey
        • User
        • Password
        • SharePointEdition
      • Connection
        • ConnectionType
        • URI
        • DefineTables
        • Header
        • Orientation
        • ExcelFile
        • BufferChanges
        • Region
        • ProjectId
        • OracleNamespace
        • StorageBaseURL
        • UseVirtualHosting
      • AWS Authentication
        • AWSAccessKey
        • AWSSecretKey
        • AWSRoleARN
        • AWSPrincipalARN
        • AWSRegion
        • AWSSessionToken
        • AWSExternalId
        • MFASerialNumber
        • MFAToken
        • TemporaryTokenDuration
      • Azure Authentication
        • AzureStorageAccount
        • AzureAccessKey
        • AzureSharedAccessSignature
        • AzureTenant
        • AzureEnvironment
      • SSO
        • SSOLoginURL
        • SSOProperties
        • SSOExchangeUrl
      • Data
        • AllowFormula
        • EmptyValueMode
        • NullValues
        • IgnoreCalcError
        • NullValueMode
        • HasCrossSheetReferences
        • Recalculate
        • ShowEmptyRows
        • TypeDetectionScheme
        • EnableOleDbCompatibility
        • UseFastInsert
        • SkipTop
        • IncludeCustomNames
      • OAuth
        • OAuthVersion
        • OAuthClientId
        • OAuthClientSecret
        • Scope
        • OAuthGrantType
        • OAuthPasswordGrantMode
        • OAuthIncludeCallbackURL
        • OAuthAuthorizationURL
        • OAuthAccessTokenURL
        • OAuthRefreshTokenURL
        • OAuthRequestTokenURL
        • AuthToken
        • AuthKey
        • OAuthParams
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
        • OAuthJWTIssuer
        • OAuthJWTSubject
      • Kerberos
        • KerberosKDC
        • KerberosRealm
        • KerberosSPN
        • KerberosKeytabFile
        • KerberosServiceRealm
        • KerberosServiceKDC
        • KerberosTicketCache
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLMode
        • SSLServerCert
      • SSH
        • SSHAuthMode
        • SSHClientCert
        • SSHClientCertPassword
        • SSHClientCertSubject
        • SSHClientCertType
        • SSHUser
        • SSHPassword
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • Charset
        • ClientCulture
        • Culture
        • CustomHeaders
        • CustomUrlParams
        • FolderId
        • IncludeDropboxTeamResources
        • IncludeItemsFromAllDrives
        • MaxRows
        • Other
        • PseudoColumns
        • RowScanDepth
        • Timeout
        • UserDefinedViews

Microsoft Excel Connector for CData Sync

概要

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

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

Microsoft Excel Connector for CData Sync

リモートMicrosoft Excel メタデータの表示

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

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

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

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

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

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

Microsoft Excel Connector for CData Sync

接続の確立

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

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

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

Cloud-Hosted Microsoft Excel ファイルへの接続

Sync App はさまざまなクラウドストレージ上にホストされたMicrosoft Excel ファイルからデータを取得することができますが、INSERT、UPDATE、DELETE はローカルファイル以外ではサポートされていません。

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

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

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

Amazon S3

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

  • ConnectionType:ConnectionType をAmazon S3 に設定。
  • URI:バケット内のExcel ファイル:s3://bucket1/folder1/file.xlsx に設定。

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

Azure Blob Storage

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

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

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

Azure Data Lake Storage

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

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

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

Azure File Storage

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

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

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

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

Box

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

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

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

Dropbox

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

  • ConnectionType:Dropbox に設定。
  • URI:Excel ファイルへのパス に設定。例えば、dropbox://folder1/file.xlsx です。

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

FTP

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

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

  • ConnectionType:FTP またはFTPS のいずれかに設定。
  • URI:Excel ファイルへのパスが付いたサーバーのアドレス に設定。例:ftp://localhost:990/folder1/file.xlsx またはftps://localhost:990/folder1。
  • User:接続するFTP(S) サーバーのユーザー名に設定。
  • Password:接続するFTP(S) サーバーのパスワードに設定。

Google Cloud Storage

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

  • ConnectionType:Google Cloud Storage に設定。
  • URI:ファイルシステムの名前、Microsoft Excel ファイルを含むフォルダの名前、およびExcel ファイルの名前 へのパスに設定。例えば、gs://bucket/remotePath/file.xlsx です。

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

Google Drive

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

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

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

HDFS

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

  • ConnectionType:HDFS またはHDFS Secure に設定。
  • URI:Excel ファイルへのパス に設定。次に例を示します。
    • HDFS: webhdfs://host:port/remotePath/file.xlsx
    • HDFS Secure: webhdfss://host:port/remotePath/file.xlsx

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

匿名認証

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

Kerberos を使用した認証

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

HTTP Streams

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

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

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

IBM Cloud Object Storage

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

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

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

OneDrive

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

  • ConnectionType:OneDrive に設定。
  • URI:Excel ファイルへのパス に設定。例えば、onedrive://remotePath/file.xlsx です。

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

Oracle Cloud Storage

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

  • ConnectionType:ConnectionType をOracle Cloud Storage に設定。
  • URI:バケット内のExcel ファイル:os://bucket/remotePath/file.xlsx に設定。
  • AccessKey: Oracle Cloud のAccess Key に設定。
  • SecretKey:Oracle Cloud のSecret Key に設定。
  • OracleNamespace:Oracle cloud のnamespace に設定。
  • Region(オプション):S3ライクなWeb サービスのホスティングリージョンに設定。

SFTP

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

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

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

SharePoint Online

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

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

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

ワークブックへの接続

[接続]セクションのURI には、有効なExcel ファイルを設定する必要があります(ファイルパスを含む)。Sync App は、Excel 2007以降で使用されるOffice Open XML 形式をサポートします。

ワークブックのクエリ

その後、ワークブック内のスプレッドシートと範囲に対して、SELECT、INSERT、UPDATE、およびDELETE ステートメントを実行できます。テーブルとしてのスプレッドシートデータへのクエリについての詳細は、Excel 操作 を参照してください。

Microsoft Excel Connector for CData Sync

Amazon S3 への接続

接続の前に

AWS キーを取得

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

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

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

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

Amazon S3 への接続

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

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

Amazon S3 への認証

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

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

ルートクレデンシャル

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

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

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

EC2 インスタンス

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

  • AuthScheme:AwsEC2Roles に設定。
AWSAccessKey およびAWSSecretKey は指定しないでください。Sync App は自動的にIAM ロールの認証情報を取得し、それらを使って認証します。

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

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

IMDSv2 サポート

Microsoft Excel Sync App は、IMDSv2 をサポートしています。IMDSv1 とは異なり、新バージョンでは認証トークンが必須です。エンドポイントおよびレスポンスは、両バージョンで同じです。 IMDSv2 では、Microsoft Excel 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:この属性は、Microsoft Excel の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 デバイスから利用できる一時トークン。
(すでにEC2 インスタンスなどで接続されているのではなく)AWS に接続している場合は、追加で以下を指定する必要があります。
  • AWSAccessKey:MFA が発行されるIAM ユーザーのアクセスキー。
  • AWSSecretKey:MFA が発行されるIAM ユーザーのシークレットキー。
認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。
  • AWSRoleARN:認証したいロールのRole ARN を指定。これにより、Sync App はMFA を使用して指定されたロールの認証情報を 取得しようと試みます。
  • AWSExternalId(オプション):別のアカウントでロールを引き受ける場合にのみ必要です。
これにより、Sync App は一時的な認証情報を取得するために、リクエストでMFA 認証情報を送信します。

一時的な認証情報の有効期間(デフォルトは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 という名前のプロファイルが使用されます。
詳しくは、AWS Command Line Interface User Guide を参照してください。

AzureAD

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

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

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

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

  • Resource:アプリ登録の概要セクションにリストされている、Microsoft Excel アプリケーションのアプリケーションId URI。ほとんどの場合、これはカスタムMicrosoft Excel ドメインの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';

Microsoft Excel Connector for CData Sync

Azure Blob Storage への接続

接続の前に

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 で指定された証明書ストアの種類に設定。

Microsoft Excel Connector for CData Sync

Azure Data Lake Storage への接続

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 で指定された証明書ストアの種類に設定。

Microsoft Excel Connector for CData Sync

Box への接続

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 に設定。
接続すると、Sync App はサービスアカウントでのOAuth フローを完了します。

Microsoft Excel Connector for CData Sync

カスタムOAuth アプリの作成

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

CData は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 を選択します。

Microsoft Excel Connector for CData Sync

Dropbox への接続

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 アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

Microsoft Excel Connector for CData Sync

カスタムOAuth アプリの作成

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

CData は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 タブで、アプリが要求するユーザーのアクセス許可の範囲を選択します。

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

Microsoft Excel Connector for CData Sync

Google Cloud Storage への接続

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 アプリケーション設定のクライアントシークレットに設定。
接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。以下のようにSync App がOAuth プロセスを完了します。

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

Web アプリケーション

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

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 トークン値を保存する場所のパスを設定。これは接続間で維持されます。
次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

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

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

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

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

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

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

ヘッドレスマシン

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

  1. 以下のオプションから選択します。
    • オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2:インターネットブラウザに対応したマシンにSync App をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
  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 verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

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

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

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

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

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

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

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

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

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

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

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

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

Microsoft Excel Connector for CData Sync

カスタムOAuth アプリの作成

イントロダクション

カスタムOAuth アプリを使用して、サービスアカウントまたはユーザーアカウントで認証できます。カスタムOAuth アプリケーションはいつでも作成できますが、デスクトップおよびヘッドレス接続は埋め込みOAuth をサポートしており、認証プロセスを簡略化できることに留意してください。

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

CData はOAuth アプリケーション認証情報を製品に埋め込み、デスクトップアプリケーションまたはヘッドレスマシンから接続する際に使用することができます。

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

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

を有効化

次の手順に従い を有効化します。

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

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

AuthScheme=OAuth を使用し、Web アプリケーションを使用する場合、OAuth クライアントID アプリケーションを作成する必要があります。デスクトップおよびヘッドレスフローでのカスタム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)

AuthScheme=OAuthJWT を使用する場合、サービスアカウントアプリケーションを作成する必要があります。次の手順に従います。

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

Microsoft Excel Connector for CData Sync

Google Drive への接続

Google Drive への認証

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

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

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

ユーザーアカウント(OAuth)

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

Web アプリケーション

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

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 トークン値を保存する場所のパスを設定。これは接続間で維持されます。
次回のデータ接続では、OAuthAccessToken およびOAuthRefreshToken の値は、OAuthSettingsLocation から取得されます。

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

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

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

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

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

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

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

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

Microsoft Excel Connector for CData Sync

カスタムOAuth アプリの作成

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 を呼び出します。
データへの接続には、OAuthAccessToken を設定します。 アクセストークンの期限が切れたときは、RefreshOAuthAccessToken を呼び出します。

サービスアカウントを使って、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 メールアドレスを設定。
接続すると、Sync App はサービスアカウントでのOAuth フローを完了します。
  1. Sync App に要求されるclaim set でJWT を作成し、サインします。
  2. JWT はアクセストークンと交換されます。
  3. トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。

Microsoft Excel Connector for CData Sync

HTTP Streams への接続

HTTP(S) への認証

Basic

AuthScheme:Basic に設定。

Digest

AuthScheme:Digest に設定。

OAuth

AuthScheme:OAuth に設定。

OAuthJWT

AuthScheme:OAuthJWT に設定。

OAuthPassword

AuthScheme:OAuthPassword に設定。

OAuthClient

AuthScheme:OAuthClient に設定。

OAuthPKCE

AuthScheme:OAuthPKCE に設定。

Microsoft Excel Connector for CData Sync

IBM Object Storage への接続

接続の前に

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 プロセスを完了します。

Microsoft Excel Connector for CData Sync

OneDrive への接続

Microsoft Excel への認証

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

Microsoft Excel Connector for CData Sync

SFTP への接続

SFTP への接続

None

SSHAuthMode:None に設定。

Password

SSHAuthMode:Password に設定。

Public_Key

SSHAuthMode:Public_Key に設定。

Microsoft Excel Connector for CData Sync

SharePoint Online への接続

SharePoint Online SOAP への接続

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

次に例を示します。

URI=sp://Documents/folder1; User=user1; Password=password1; StorageBaseURL=https://subdomain.sharepoint.com;

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

SharePoint Online REST への接続

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

次に例を示します。

URI=sp://Documents/folder1; InitiateOAuth=GETANDREFRESH; StorageBaseURL=https://subdomain.sharepoint.com;

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

Microsoft Excel Connector for CData Sync

SSO 接続

SSO 認証

サービスプロバイダ Okta OneLogin ADFS AzureAD
Amazon S3 Y Y Y
Azure Blob Storage
Azure Data Lake Store Gen1
Azure Data Lake Store Gen2
Azure Data Lake Store Gen2 with SSL
Google Drive
OneDrive
Box
Dropbox
SharePoint Online SOAP Y Y Y
SharePoint Online REST
Wasabi
Google Cloud Storage
Oracle Cloud Storage
Azure File

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 統合

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

Microsoft Excel Connector for CData Sync

データアクセスのファインチューニング

高度なデータモデリング設定

以下の接続文字列を使用して、Sync App が検出するテーブルや戻り値、その他のデータアクセスの側面を設定します。

スキーマ検出

  • Orientation:スプレッドシートの方向と一致するテーブルをモデル化します。Horizontal またはVertical に設定します。
  • DefineTables:標準のExcel の範囲形式 [Table Name]=[Sheet Name]![Range] を使用して、テーブルとしてアクセスする範囲を明示的に指定します。複数のテーブルをセミコロン区切りリストで指定します。
      DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"
    Sync App は、シート内の名前付き範囲を自動的に検出し、それらをテーブルとしてレポートします。また、FROM 句で範囲を指定することもできます。
     SELECT * FROM Excel_Sheet#A5:F* 

カラム検出

  • Header:True の場合は、1行目からカラム名を検出します。そうでない場合は、疑似列名A、B、C などが使用されます。
  • TypeDetectionScheme:Sync App がカラムのデータ型を検出する方法を決定します。
  • RowScanDepth:row-scan タイプの検出スキームを使用する場合は、このプロパティをスキャンする行数に設定し、カラムのデータ型を決定します。

高度なExcel のデータ連携

数式

  • AllowFormula:数式結果や数式を、挿入するかまたは更新するか。
  • Recalculate:データが変更されたときに数式を再計算します。
  • IgnoreCalcError:数式が計算されたときに発生したエラーを無視します。
  • HasCrossSheetReferences:データが変更されたときに、すべてのワークシートで数式を再計算します。Sync App はクロスシート参照に従いますが、パフォーマンスコストがあります。

その他

  • EmptyValueMode:空のセルを処理する方法を設定します。空のセルとは、空の文字列(例:="")を含むセルです。空のセルを、空の文字列またはnull 文字列として返すことができます(デフォルトでは空の文字列を返します)。
  • NullValueMode:設定されていないセルの処理方法を設定します。設定されていないセルは、空のセルとは異なります。設定されていないセルには、null 文字列が含まれます。設定されていないセルを、空の文字列またはnull 文字列として返すことができます(デフォルトではNULL を返します)。
  • BufferChanges:データの変更を接続が閉じるまでメモリ内に保持するかどうかを示します。

Microsoft Excel Connector for CData Sync

Kerberos の使用

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

Kerberos

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

  • AuthScheme:NEGOTIATE に設定。
  • KerberosKDC:Kerberos KDC マシンのホスト名またはIP アドレスに設定。
  • KerberosSPN:Microsoft Excel の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 はキャッシュファイルを使用してMicrosoft Excel に接続するためのKerberos チケットを取得します。

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

Keytab ファイル

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

User およびPassword

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

クロスレルム

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

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

Microsoft Excel Connector for CData Sync

Excel 操作

CData Sync App では、さまざまな方法でExcel ファイルを操作できます。Sync App は縦方向および横方向にデータを読み取ったり、ユーザー定義の範囲や名前付き範囲からのデータを読み取ることができます。スプレッドシートデータをクエリおよび変更するためのさまざまな方法については、データの選択 およびデータの変更 を参照してください。

Microsoft Excel Connector for CData Sync

データの選択

Excel ワークシートの構成はさまざまです。Sync App には、さまざまな構成方法に基づいてデータを選択するための設定が用意されています。

ヘッダーセルあり

スプレッドシートにカラムヘッダーがある場合、Sync App は、それらを使用してワークシートテーブルの列名を表すことができます。ヘッダーセルを使用するには、Header プロパティをTrue に設定します。その後、次のようにクエリできます。
SELECT RowId, Name, Item, Quantity, Amount FROM Sheet1 WHERE Amount > '50'
上のクエリは、スプレッドシートの最初の行に列名RowId、Name、Quantity、およびAmount があることを前提としています。スプレッドシートに、選択した列より多くの列があってもかまいません。また、列の順序は任意です。

ヘッダーセルなし

スプレッドシートにヘッダーカラムがない場合、またはヘッダーカラムを無視する場合は、Header プロパティをfalse に設定できます。この場合、各列はExcel の列名で表されます(A、B、Cなど)。
SELECT A, B, C, D FROM Sheet1 WHERE D > '50'

方向

スプレッドシートを水平方向にレイアウトする(列名を最初の列に縦に並べる)場合は、Orientation プロパティをHorizontal に設定し、各列をテーブルの行として読み取ることができます。Orientation プロパティは、Header 接続プロパティや下記の範囲構文と組み合わせて使用できます。

ヘッダーカラムが設定されてなく、方向が水平方向の場合、列名はR1、R2、R3 などとなります。

SELECT R1, R2, R3 FROM Sheet1 WHERE R2 > '50'

範囲

スプレッドシートの左上が空いている場合、または目的のデータがシートの中ほどにある場合などは、範囲機能を使用して、プレッドシートの特定の部分のデータを選択できます。範囲は、テーブル名の一部として指定します。例えば、次のコマンドは、A1からE5までのセルの範囲を選択します。
SELECT * FROM Excel_Sheet#A1:E5
In case the sheet name contains a quote, if you want to select only a range, the correct Excel syntax involves using an extra quote as an escape character and enclosing the full sheet name with quotes. For example the following command will select the range of cells between A1 and E5 for the sheet named Excel'Sheet:
SELECT * FROM ['Excel''Sheet'#A1:E5]
また、範囲の終了セルにワイルドカード*)を使用することもできます。次のような範囲 '#A5:F*'、 '#A5:*20'、および '#A5:**' がサポートされます。例えば、次のコマンドは、A5と列F の間のセル範囲(スプレッドシートの最後の行まで)を選択します。
SELECT * FROM Excel_Sheet#A5:F*

名前付き範囲

スプレッドシート内に名前付き範囲が定義されている場合は、この範囲をテーブルとしてクエリできます。名前付き範囲SALES のデータを選択するには、次のクエリを発行します。
SELECT * FROM SALES

Microsoft Excel Connector for CData Sync

データの変更

CData Sync App はINSERT、UPDATE、およびDELETE をサポートしています。詳細は以下のとおりです。

更新および削除

更新および削除では、RowId カラムを指定して、単一の行を一意に識別する必要があります。

式を挿入するには、式の使用 を参照してください。

挿入

名前付き範囲に挿入するなど、シートの任意の場所に新しい行を挿入できます。

行の追加

INSERT ステートメントを使用すると、スプレッドシートに新しい行を追加できます。Header プロパティをTrue に設定した場合は、カラムヘッダーに基づいて挿入できます。Header プロパティをfalse に設定した場合は、セル名(A、B、C など)を使用して各行を挿入する必要があります。挿入された行は、シートの最後に追加されます。この新しい行には、Excel シート内の位置に基づいてRowId が割り当てられます。

セル範囲の最後に行を挿入することもできます。それには、行の挿入時にテーブル名の中で範囲を使用します。

INSERT INTO Sheet1#C1:D5 (A, B) VALUES ('Brian', '30')
上のコードは、範囲の最後(セルC6とセルD6)にBrian と30 を追加します。

行の挿入

Excel シートの中ほどに行を挿入したい場合もあります。Sync App では、行番号を特定するRowId を指定してINSERT コマンドを使用することで、これを行うことができます。INSERT クエリでRowId を指定すると、Sync App は、指定された行番号の位置に行を追加します。指定された行番号の位置以下にあるすべての行が1行下に移動し、それらのRowId が1つインクリメントされます。次に例を示します。
INSERT INTO Sheet1 (RowId, A, B) VALUES (5, 'Brian', '30')
上のコードは、セルA5とセルB5にBrian と30を挿入します。行5以下にある既存のデータは、1行下がります。

名前付き範囲への行の追加

名前付き範囲の最後に行を挿入することもできます。それには、RowId を指定せずに範囲名のテーブルに行を挿入します。下のコードは、名前付き範囲SALES の最後に新しい行を追加します。挿入された行も範囲に入るように、名前付き範囲の定義が拡張されます。
INSERT INTO SALES (Year, Category, Total) VALUES (1997, 'Beverage', 30000)

Microsoft Excel Connector for CData Sync

式の使用

Excel formulas are recalculated when the spreadsheet is opened. The Sync App includes a formula engine that can natively calculate most of the commonly used Excel formulas. The Sync App stores the state of a previous calculation in the spreadsheet and uses it to make efficient choices of when recalculation is necessary.

Recalculating Formulas

The Recalculate property allows you to control if formulas should be calculated. You should set Recalculate to True when you intend to read data from a spreadsheet that has formulas and you know that formula results might not be up to date. Once a value has been calculated for a cell, it is also updated into the spreadsheet. This can help avoid recalculations.

Calculating formula cells can add to the processing time. If a spreadsheet has not been modified since the last recalculation, you may choose to omit the calculation and simply read the previously calculated value in the formula cell. To skip recalculation, set Recalculate to False. You may also want to omit formula calculation when you are opening a spreadsheet just to insert or update cells and not reading anything from it.

Inserting Formulas

The Sync App allows you to insert formulas into cells. If the AllowFormula connection string property is set to true, then anything you insert beginning with an equals sign ('=') will be treated as a formula. For example, the following will insert a formula into the B column that will sum cells B1:B5:
INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Microsoft Excel Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Microsoft Excel Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

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

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

クライアントSSL 証明書

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

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

Microsoft Excel Connector for CData Sync

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Microsoft Excel Connector for CData Sync

データモデル

CData Sync App は、Excel のワークブックをリレーショナルデータベースとしてモデル化します。スプレッドシートおよび範囲がテーブルを構成します。

スプレッドシートへのSQL の実行

Excel 操作 は、スプレッドシートデータを操作するさまざまな方法を示します。

高度なデータモデリング

ワークブックの構成に合わせてデータモデルを微調整することができます。Sync App は、縦方向または横方向のデータの読み取りや、ユーザー定義の範囲や名前付き範囲で構成された疎らなスプレッドシートの読み取りをサポートしています。

接続文字列を設定して、Sync App が検出するテーブルや戻り値、その他のデータアクセスの側面を設定するには、データアクセスのファインチューニング を参照してください。

ストアドプロシージャ

スプレッドシートのデータの操作に加えて、用意されているストアドプロシージャを使用して、Excel ファイルのメタデータを変更できます。

Microsoft Excel Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
AuthSchemeリモートサービスに接続する際に使用する認証の種類。
AccessKeyアカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。
SecretKeyアカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。
UserThe user account used to authenticate.
PasswordThe password used to authenticate the user.
SharePointEdition使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

Connection


プロパティ説明
ConnectionType使用する接続の種類。
URIThe Uniform Resource Identifier (URI) for the Excel resource location.
DefineTablesExcel の範囲をテーブル名にマップします。
Header最初の行をカラムヘッダーとして使用するかどうかを示します。
OrientationExcel 内のデータを水平方向に配置するか、垂直方向に配置するかを示します。
ExcelFileExcel ファイルの場所。
BufferChangesデータの変更を接続が閉じるまでメモリ内に保持するかどうかを示します。
RegionS3ライクなWeb サービスのホスティングリージョン。
ProjectIdGoogle Cloud Storage インスタンスが存在するプロジェクトのId。
OracleNamespace使用するOracle Cloud Object Storage ネームスペース。
StorageBaseURLクラウドストレージサービスプロバイダーのURL。
UseVirtualHostingTrue(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

AWS Authentication


プロパティ説明
AWSAccessKeyAWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSSecretKeyAWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSRoleARN認証時に使用するロールのAmazon リソースネーム。
AWSPrincipalARNAWS アカウントのSAML ID プロバイダーのARN。
AWSRegionAmazon Web サービスのホスティングリージョン。
AWSSessionTokenAWS のセッショントークン。
AWSExternalIdA unique identifier that might be required when you assume a role in another account.
MFASerialNumberMFA デバイスが使用されている場合は、そのシリアル番号。
MFATokenMFA デバイスから利用できる一時トークン。
TemporaryTokenDuration一時トークンが持続する時間(秒単位)。

Azure Authentication


プロパティ説明
AzureStorageAccountAzure ストレージアカウント名。
AzureAccessKeyMicrosoft Excel アカウントに関連付けられているストレージキー。
AzureSharedAccessSignature認証に使用可能な共有アクセスキー署名。
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSOPropertiesセミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
SSOExchangeUrlSAML 応答を処理して、Microsoft Excel の資格情報と交換するために使用するURL。

Data


プロパティ説明
AllowFormula挿入および更新時に、等号(=)から始まる値を式として扱うかどうか。
EmptyValueMode空の値を空として読み取るか、null として読み取るかを示します。
NullValuesA comma separated list which will be replaced with nulls if there are found in the CSV file.
IgnoreCalcError計算中に発生したエラーを無視するかどうかを示します。
NullValueMode空のセルをnull として読み取るか、空として読み取るかを示します。
HasCrossSheetReferences複数のスプレッドシートを参照する式をプロバイダから読み取るかどうかを示します。
Recalculateデータの読み取り時に、すべての式を再計算するかどうかを示します。
ShowEmptyRows空の行をプッシュするかどうかを示します。
TypeDetectionSchemeprovider がカラムのデータ型を検出する方法を決定します。
EnableOleDbCompatibilityIndicates whether to read the data with the same behavior as the Microsoft OleDB driver.
UseFastInsertIndicates whether to use the fastInsert when executing Insert Statement.
SkipTopSkips the number of rows specified starting from the top.
IncludeCustomNamesIndicates whether or not the defined names should be pushed.

OAuth


プロパティ説明
OAuthVersion使われているOAuth のバージョン。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
OAuthGrantTypeOAuth フローのグラント種別。
OAuthPasswordGrantModeOAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。
OAuthIncludeCallbackURLWhether to include the callback URL in an access token request.
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
OAuthRefreshTokenURLOAuth トークンをリフレッシュするURL。
OAuthRequestTokenURLサービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
AuthTokenOAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKeyOAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParamsOAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

Kerberos


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。
SSLModeFTP またはFTPS サーバーに接続する際の認証メカニズム。
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSH


プロパティ説明
SSHAuthModeSFTP サーバーへのログオンに使用する認証方法。
SSHClientCertユーザーの認証に使用する秘密鍵。
SSHClientCertPasswordSSHClientCert キーのパスワード(ある場合)。
SSHClientCertSubjectSSH クライアント証明書のサブジェクト。
SSHClientCertTypeSSHClientCert 秘密鍵の種類。
SSHUserSSH ユーザー。
SSHPasswordSSH パスワード。

Firewall


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

Proxy


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
CharsetMicrosoft Excel ファイルに移行、またはMicrosoft Excel ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。
ClientCultureこのプロパティを使用して、クライアントアプリケーションが受け取るデータの形式(通貨値など)を指定できます。このプロパティは、クライアントアプリケーションがマシンの現在のカルチャ設定をサポートしていない場合に使用できます。例えば、Microsoft Access では'en-US' が必要です。
Cultureこの設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。
CustomHeadersユーザーが決定したその他のヘッダー(オプション)。
CustomUrlParamsリクエストに含めるカスタムクエリ文字列。
FolderIdGoogle Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。
IncludeDropboxTeamResourcesDropbox チームフォルダやファイルを含めるかどうかを示します。
IncludeItemsFromAllDrivesGoogle Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。
MaxRowsクエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
Microsoft Excel Connector for CData Sync

Authentication

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


プロパティ説明
AuthSchemeリモートサービスに接続する際に使用する認証の種類。
AccessKeyアカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。
SecretKeyアカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。
UserThe user account used to authenticate.
PasswordThe password used to authenticate the user.
SharePointEdition使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。
Microsoft Excel Connector for CData Sync

AuthScheme

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

解説

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 サービスを認証します。

Microsoft Excel Connector for CData Sync

AccessKey

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

解説

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

Microsoft Excel Connector for CData Sync

SecretKey

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

解説

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

Microsoft Excel Connector for CData Sync

User

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.

Microsoft Excel Connector for CData Sync

Password

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.

Microsoft Excel Connector for CData Sync

SharePointEdition

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

解説

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

Microsoft Excel Connector for CData Sync

Connection

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


プロパティ説明
ConnectionType使用する接続の種類。
URIThe Uniform Resource Identifier (URI) for the Excel resource location.
DefineTablesExcel の範囲をテーブル名にマップします。
Header最初の行をカラムヘッダーとして使用するかどうかを示します。
OrientationExcel 内のデータを水平方向に配置するか、垂直方向に配置するかを示します。
ExcelFileExcel ファイルの場所。
BufferChangesデータの変更を接続が閉じるまでメモリ内に保持するかどうかを示します。
RegionS3ライクなWeb サービスのホスティングリージョン。
ProjectIdGoogle Cloud Storage インスタンスが存在するプロジェクトのId。
OracleNamespace使用するOracle Cloud Object Storage ネームスペース。
StorageBaseURLクラウドストレージサービスプロバイダーのURL。
UseVirtualHostingTrue(デフォルト)の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます:http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します:http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。
Microsoft Excel Connector for CData Sync

ConnectionType

使用する接続の種類。

解説

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

Microsoft Excel Connector for CData Sync

URI

The Uniform Resource Identifier (URI) for the Excel resource location.

解説

Set the URI property to specify a path to a file or stream.

Below are examples of the URI formats for the available data sources:

Service providerURI formats
Local localPath/file.xlsx

file://localPath/file.xlsx

HTTP or HTTPS http://remoteStream

https://remoteStream

Amazon S3 s3://remotePath/file.xlsx
Google Drive gdrive://remotePath/file.xlsx
Box box://remotePath/file.xlsx
FTP or FTPS ftp://server:port/remotePath/file.xlsx

ftps://server:port/remotepath/file.xlsx

SFTP sftp://server:port/remotePath/file.xlsx
Sharepoint sp://https://server/remotePath/file.xlsx

Example Connection Strings and Queries

Below are example connection strings to Excel files or streams.

Service providerURI formats Connection exampleQuery example (if file.xlsx contains sheet1 or streamname1 is a Excel stream)
Local localPath

file://localPath/file.xlsx

URI=C:/folder1/file.xlsx SELECT * FROM sheet1
HTTP or HTTPS http://remoteStream

https://remoteStream

URI=http://www.host1.com/streamname1; SELECT * FROM streamedtable
Amazon S3 s3://bucket1/folder1/file.xlsx URI=s3://bucket1/folder1/file.xlsx; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO; SELECT * FROM sheet1
Google Drive gdrive://remotePath/file.xlsx URI=gdrive://folder1/file.xlsx; SELECT * FROM sheet1
Box box://remotePath/file.xlsx URI=box://folder1/file.xlsx; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;SELECT * FROM sheet1
FTP or FTPS ftp://server:port/remotePath/file.xlsx

ftps://server:port/remotepath/file.xlsx

URI=ftps://localhost:990/folder1/file.xlsx; User=user1; Password=password1; SELECT * FROM sheet1
SFTP sftp://server:port/remotePath/file.xlsx URI=sftp://127.0.0.1:22/remotePath/file.xlsx; User=user1; Password=password1; SELECT * FROM sheet1
Sharepoint sp://https://server/remotePath/file.xlsx URI=sp://https://domain.sharepoint.com/Documents/file.xlsx; User=user1; Password=password1; SELECT * FROM sheet1

Microsoft Excel Connector for CData Sync

DefineTables

Excel の範囲をテーブル名にマップします。

解説

このプロパティを使って、テーブルとして表示するExcel スプレッドシートの範囲を明示的に定義できます。Sync App は、スプレッドシートと名前付き範囲のテーブルを自動的に検出します。

テーブル名を範囲にマッピング

DefineTables 値は、名前と値のペアの カンマ区切りリストで、[Table Name]=[Sheet Name]![Range] の形式になります。Table Name は データに使うテーブルの名前で、クエリを発行する際に使用されます。Sheet Name はExcel スプレッドシート内 にあるシートの名前で、Range はテーブルのデータを含むセルの範囲です。

DefineTables 値の例を示します。DefineTables="Table1=Sheet1!A1:N25,Table2=Sheet2!C3:M53"

Microsoft Excel Connector for CData Sync

Header

最初の行をカラムヘッダーとして使用するかどうかを示します。

解説

true の場合は、最初の行が列ヘッダーとして使用されます。そうでない場合は、疑似列名A、B、C などが使用されます。

このルールから特定のシートを除外したい場合には、Header=True、Sheet1=False と設定してください。Sheet1 以外のすべてのシートでHeader がTrue に設定されます。

Microsoft Excel Connector for CData Sync

Orientation

Excel 内のデータを水平方向に配置するか、垂直方向に配置するかを示します。

解説

デフォルトでは、Sync App は垂直方向のスプレッドシートデータをモデル化します。行はヘッダ行の下に垂直に配置されます。

行が左から右に配置されている場合は、このプロパティを"Horizontal" に設定してください。最初の列は列名を含み、後続の列は行になります。

Header プロパティはOrientation プロパティと一緒に使用します。Header がfalse、Orientation がColumns に設定されている場合、列名はR1、R2、R3、etc. のようにレポートされます。

このルールから特定のシートを除外したい場合には、Orientation=Horizontal、Sheet1=vertical と設定してください。Sheet1 以外のすべてのシートでOrientation が水平に設定されます。

Microsoft Excel Connector for CData Sync

ExcelFile

Excel ファイルの場所。

解説

このプロパティは非推奨でURI に置き換えられます。

Excel ファイルを指すパス。ファイルが存在している必要があります。Sync App は、Excel 2007以降で使用されるOffice Open XML スプレッドシートに対するサポートを実装します。

Microsoft Excel Connector for CData Sync

BufferChanges

データの変更を接続が閉じるまでメモリ内に保持するかどうかを示します。

解説

データの変更を接続が閉じるまでメモリ内に保持するかどうかを示します。これをfalse に設定すると、変更が即座に書き込まれますが、ファイルを繰り返し開いたり閉じたりする必要があるので、要求が多い場合にパフォーマンスが低下する可能性があります。

Microsoft Excel Connector for CData Sync

Region

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

解説

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

Oracle Cloud Object Storage のリージョン

値 リージョン
商用クラウドリージョン
ap-hyderabad-1 India South (Hyderabad)
ap-melbourne-1 Australia Southeast (Melbourne)
ap-mumbai-1 India West (Mumbai)
ap-osaka-1 Japan Central (Osaka)
ap-seoul-1 South Korea Central (Seoul)
ap-sydney-1 Australia East (Sydney)
ap-tokyo-1 Japan East (Tokyo)
ca-montreal-1 Canada Southeast (Montreal)
ca-toronto-1 Canada Southeast (Toronto)
eu-amsterdam-1 Netherlands Northwest (Amsterdam)
eu-frankfurt-1 Germany Central (Frankfurt)
eu-zurich-1 Switzerland North (Zurich)
me-jeddah-1 Saudi Arabia West (Jeddah)
sa-saopaulo-1 Brazil East (Sao Paulo)
uk-london-1 UK South (London)
us-ashburn-1 (default) US East (Ashburn, VA)
us-phoenix-1 US West (Phoenix, AZ)
US Gov FedRAMP High Regions
us-langley-1 US Gov East (Ashburn, VA)
us-luke-1 US Gov West (Phoenix, AZ)
US Gov DISA IL5 Regions
us-gov-ashburn-1 US DoD East (Ashburn, VA)
us-gov-chicago-1 US DoD North (Chicago, IL)
us-gov-phoenix-1 US DoD West (Phoenix, AZ)

Wasabi のリージョン

値 リージョン
eu-central-1 Europe (Amsterdam)
us-east-1 (Default) US East (Ashburn, VA)
us-east-2 US East (Manassas, VA)
us-west-1 US West (Hillsboro, OR)

Microsoft Excel Connector for CData Sync

ProjectId

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

解説

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

Microsoft Excel Connector for CData Sync

OracleNamespace

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

解説

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

Microsoft Excel Connector for CData Sync

StorageBaseURL

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

解説

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

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

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

Microsoft Excel Connector for CData Sync

UseVirtualHosting

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 に設定されることに注意してください。

Microsoft Excel Connector for CData Sync

AWS Authentication

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


プロパティ説明
AWSAccessKeyAWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSSecretKeyAWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSRoleARN認証時に使用するロールのAmazon リソースネーム。
AWSPrincipalARNAWS アカウントのSAML ID プロバイダーのARN。
AWSRegionAmazon Web サービスのホスティングリージョン。
AWSSessionTokenAWS のセッショントークン。
AWSExternalIdA unique identifier that might be required when you assume a role in another account.
MFASerialNumberMFA デバイスが使用されている場合は、そのシリアル番号。
MFATokenMFA デバイスから利用できる一時トークン。
TemporaryTokenDuration一時トークンが持続する時間(秒単位)。
Microsoft Excel Connector for CData Sync

AWSAccessKey

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

解説

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

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

Microsoft Excel Connector for CData Sync

AWSSecretKey

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

解説

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

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

Microsoft Excel Connector for CData Sync

AWSRoleARN

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

解説

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

Microsoft Excel Connector for CData Sync

AWSPrincipalARN

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

解説

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

Microsoft Excel Connector for CData Sync

AWSRegion

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 です。

Microsoft Excel Connector for CData Sync

AWSSessionToken

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

解説

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

Microsoft Excel Connector for CData Sync

AWSExternalId

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.

Microsoft Excel Connector for CData Sync

MFASerialNumber

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

解説

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

Microsoft Excel Connector for CData Sync

MFAToken

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

解説

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

Microsoft Excel Connector for CData Sync

TemporaryTokenDuration

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

解説

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

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

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

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

Microsoft Excel Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureStorageAccountAzure ストレージアカウント名。
AzureAccessKeyMicrosoft Excel アカウントに関連付けられているストレージキー。
AzureSharedAccessSignature認証に使用可能な共有アクセスキー署名。
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。
Microsoft Excel Connector for CData Sync

AzureStorageAccount

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

解説

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

Microsoft Excel Connector for CData Sync

AzureAccessKey

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

解説

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

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

Microsoft Excel Connector for CData Sync

AzureSharedAccessSignature

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

解説

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

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

Microsoft Excel Connector for CData Sync

AzureTenant

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

解説

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

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

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

Microsoft Excel Connector for CData Sync

AzureEnvironment

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

解説

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

Microsoft Excel Connector for CData Sync

SSO

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


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSOPropertiesセミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
SSOExchangeUrlSAML 応答を処理して、Microsoft Excel の資格情報と交換するために使用するURL。
Microsoft Excel Connector for CData Sync

SSOLoginURL

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

解説

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

Microsoft Excel Connector for CData Sync

SSOProperties

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

解説

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

SSO configuration is discussed further in .

Microsoft Excel Connector for CData Sync

SSOExchangeUrl

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

解説

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

Microsoft Excel Connector for CData Sync

Data

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


プロパティ説明
AllowFormula挿入および更新時に、等号(=)から始まる値を式として扱うかどうか。
EmptyValueMode空の値を空として読み取るか、null として読み取るかを示します。
NullValuesA comma separated list which will be replaced with nulls if there are found in the CSV file.
IgnoreCalcError計算中に発生したエラーを無視するかどうかを示します。
NullValueMode空のセルをnull として読み取るか、空として読み取るかを示します。
HasCrossSheetReferences複数のスプレッドシートを参照する式をプロバイダから読み取るかどうかを示します。
Recalculateデータの読み取り時に、すべての式を再計算するかどうかを示します。
ShowEmptyRows空の行をプッシュするかどうかを示します。
TypeDetectionSchemeprovider がカラムのデータ型を検出する方法を決定します。
EnableOleDbCompatibilityIndicates whether to read the data with the same behavior as the Microsoft OleDB driver.
UseFastInsertIndicates whether to use the fastInsert when executing Insert Statement.
SkipTopSkips the number of rows specified starting from the top.
IncludeCustomNamesIndicates whether or not the defined names should be pushed.
Microsoft Excel Connector for CData Sync

AllowFormula

挿入および更新時に、等号(=)から始まる値を式として扱うかどうか。

解説

挿入および更新時に等号(=)から始まる値を式として扱うには、この値をtrue に設定します。 挿入と更新で使用されるすべての値を文字列として扱うには、この値をfalse に設定します。

Microsoft Excel Connector for CData Sync

EmptyValueMode

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

解説

指定可能な値は、ReadAsEmpty とReadAsNull です。空の値とは、空の文字列(=""など)が含まれているセルです。これは、設定されていないセル(null 文字列が含まれているセル)とは異なります。

Microsoft Excel Connector for CData Sync

NullValues

A comma separated list which will be replaced with nulls if there are found in the CSV file.

解説

A comma separated list which will be replaced with nulls if there are found in the CSV file. Example: "NaN,\N,N/A". If any of the specified values is found in a CSV row, it will be pushed as null.

Microsoft Excel Connector for CData Sync

IgnoreCalcError

計算中に発生したエラーを無視するかどうかを示します。

解説

IgnoreCalcError のデフォルトは、false です。IgnoreCalcError をtrue に設定すると、プロバイダは式の計算によって発生するエラーを無視します。この場合、式の結果は信頼できない可能性がありますが、他のデータは正確です。

Microsoft Excel Connector for CData Sync

NullValueMode

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

解説

NullValueMode は、空のExcel セルをどのようにモデル化するかを制御します。空のセルは、設定されていないセル(null 文字列が含まれているセル)です。NullValueMode をReadAsNull に設定すると、空のセルに対してNULL が報告されます。NullValueMode をReadAsEmpty に設定すると、空のセルに対して空の文字列が報告されます。

Microsoft Excel Connector for CData Sync

HasCrossSheetReferences

複数のスプレッドシートを参照する式をプロバイダから読み取るかどうかを示します。

解説

HasCrossSheetReferences は、クロスシート参照をどのように処理するかを制御します。クロスシート参照がある場合、1つのシートを変更すると、他のシートの他の式が再計算されることがあります。HasCrossSheetReferences をtrue に設定すると、ワークブック内のすべてのシートがメモリにロードされてクロスシート参照が処理されます。ただし、このプロパティをtrue に設定すると、Excel ファイルからすべてのシートが読み取られるため、パフォーマンスが低下する場合があります。

シートを更新する予定がある場合は、この値をtrue に設定する必要があります。このオプションが無効の場合、複数のシートでは共有データを再利用できないため、Sync App はより大きなファイルを生成します。しかし、このオプションを無効にすると、Sync App は複数シート間でデータを再利用し、小さなファイルを生成できます。

Microsoft Excel Connector for CData Sync

Recalculate

データの読み取り時に、すべての式を再計算するかどうかを示します。

解説

Excel シートのセルを変更すると、式セルの値が変化します。Recalculate をtrue に設定した場合、プロバイダは変更されたセルを検出し、式を再計算します。これらの新しい結果は、Excel シートに戻されて更新され、再計算が不要になります。

Microsoft Excel Connector for CData Sync

ShowEmptyRows

空の行をプッシュするかどうかを示します。

解説

true の場合、空の行が出力時にプッシュされます。

Microsoft Excel Connector for CData Sync

TypeDetectionScheme

provider がカラムのデータ型を検出する方法を決定します。

解説

NoneTypeDetectionScheme をNone に設定した場合は、すべてのカラムは文字列型で返されます。
RowScanTypeDetectionScheme をRowScan に設定した場合は、ヒューリスティックにデータ型を決定します。RowScanDepth ではスキャンする行数を決定します。
ColumnFormatTypeDetectionScheme をColumnFormat に設定すると、データ型は列のセル形式(数値、通貨、日付など)に基づいて報告されます。
ColumnStyleSetting TypeDetectionScheme to ColumnStyle will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.This will retrieve more specific data types (date / time instead of just timestamp), but is more likely to cause values to be truncated due to values in the cells not completely following the style.

Microsoft Excel Connector for CData Sync

EnableOleDbCompatibility

Indicates whether to read the data with the same behavior as the Microsoft OleDB driver.

解説

Indicates whether to read the data with the same behavior as the Microsoft OleDB driver.For example, the Microsoft OleDB driver would report the the newline as '\n' instead of '\r\n'.

Microsoft Excel Connector for CData Sync

UseFastInsert

Indicates whether to use the fastInsert when executing Insert Statement.

解説

The FastInsert has better performance than the common insert.However, the FastInsert didn't support the Insert statement with the specified ROWID and would save the insert data into the file after executing Insert Statement.

Microsoft Excel Connector for CData Sync

SkipTop

Skips the number of rows specified starting from the top.

解説

Skips the number of rows specified starting from the top.

Microsoft Excel Connector for CData Sync

IncludeCustomNames

Indicates whether or not the defined names should be pushed.

解説

If true, the defined names will be pushed.

Microsoft Excel Connector for CData Sync

OAuth

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


プロパティ説明
OAuthVersion使われているOAuth のバージョン。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
OAuthGrantTypeOAuth フローのグラント種別。
OAuthPasswordGrantModeOAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。
OAuthIncludeCallbackURLWhether to include the callback URL in an access token request.
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
OAuthRefreshTokenURLOAuth トークンをリフレッシュするURL。
OAuthRequestTokenURLサービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
AuthTokenOAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKeyOAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParamsOAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。
Microsoft Excel Connector for CData Sync

OAuthVersion

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthClientId

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthClientSecret

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

解説

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

Microsoft Excel Connector for CData Sync

Scope

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthGrantType

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthPasswordGrantMode

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthIncludeCallbackURL

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.

Microsoft Excel Connector for CData Sync

OAuthAuthorizationURL

OAuth サービスの認可URL。

解説

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

Microsoft Excel Connector for CData Sync

OAuthAccessTokenURL

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthRefreshTokenURL

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

解説

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

Microsoft Excel Connector for CData Sync

OAuthRequestTokenURL

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

解説

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

Microsoft Excel Connector for CData Sync

AuthToken

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

解説

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

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

Microsoft Excel Connector for CData Sync

AuthKey

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

解説

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

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

Microsoft Excel Connector for CData Sync

OAuthParams

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

解説

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

Microsoft Excel Connector for CData Sync

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。
OAuthJWTIssuerJava Web Token の発行者。
OAuthJWTSubjectアプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
Microsoft Excel Connector for CData Sync

OAuthJWTCert

JWT 証明書のストア。

解説

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

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

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

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

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

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

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

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

Microsoft Excel Connector for CData Sync

OAuthJWTCertType

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

解説

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

USERWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
GOOGLEJSONこの証明書ストアは、サービスアカウント情報を含むJSON ファイルの名前です。Google サービスに接続する場合にのみ有効です。
GOOGLEJSONBLOBこの証明書ストアは、サービスアカウントのJSON を含む文字列です。Google サービスに接続する場合にのみ有効です。

Microsoft Excel Connector for CData Sync

OAuthJWTCertPassword

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

解説

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

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

Microsoft Excel Connector for CData Sync

OAuthJWTCertSubject

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

解説

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

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

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

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

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

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EEメールアドレス

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

Microsoft Excel Connector for CData Sync

OAuthJWTIssuer

Java Web Token の発行者。

解説

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

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

Microsoft Excel Connector for CData Sync

OAuthJWTSubject

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

解説

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

Microsoft Excel Connector for CData Sync

Kerberos

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


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。
Microsoft Excel Connector for CData Sync

KerberosKDC

ユーザーの認証で使用される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 は設定されているドメイン名およびホストからそれらを推測します。

Microsoft Excel Connector for CData Sync

KerberosRealm

ユーザー認証に使用される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 環境で機能します。

Microsoft Excel Connector for CData Sync

KerberosSPN

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

解説

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

Microsoft Excel Connector for CData Sync

KerberosKeytabFile

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

解説

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

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

Microsoft Excel Connector for CData Sync

KerberosServiceRealm

サービスのKerberos レルム。

解説

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

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

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

Microsoft Excel Connector for CData Sync

KerberosServiceKDC

サービスのKerberos KDC。

解説

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

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

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

Microsoft Excel Connector for CData Sync

KerberosTicketCache

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

解説

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

Microsoft Excel Connector for CData Sync

SSL

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


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。
SSLModeFTP またはFTPS サーバーに接続する際の認証メカニズム。
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
Microsoft Excel Connector for CData Sync

SSLClientCert

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

解説

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

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

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

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

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

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

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

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

Microsoft Excel Connector for CData Sync

SSLClientCertType

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

解説

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

USER - デフォルトWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。

Microsoft Excel Connector for CData Sync

SSLClientCertPassword

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

解説

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

Microsoft Excel Connector for CData Sync

SSLClientCertSubject

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

解説

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

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

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

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

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EEメールアドレス

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

Microsoft Excel Connector for CData Sync

SSLMode

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

解説

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

  • AUTOMATIC
  • NONE
  • IMPLICIT
  • EXPLICIT

Microsoft Excel Connector for CData Sync

SSLServerCert

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

解説

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

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

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

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

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

Microsoft Excel Connector for CData Sync

SSH

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


プロパティ説明
SSHAuthModeSFTP サーバーへのログオンに使用する認証方法。
SSHClientCertユーザーの認証に使用する秘密鍵。
SSHClientCertPasswordSSHClientCert キーのパスワード(ある場合)。
SSHClientCertSubjectSSH クライアント証明書のサブジェクト。
SSHClientCertTypeSSHClientCert 秘密鍵の種類。
SSHUserSSH ユーザー。
SSHPasswordSSH パスワード。
Microsoft Excel Connector for CData Sync

SSHAuthMode

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

解説

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

Microsoft Excel Connector for CData Sync

SSHClientCert

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

解説

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

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

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

Microsoft Excel Connector for CData Sync

SSHClientCertPassword

SSHClientCert キーのパスワード(ある場合)。

解説

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

Microsoft Excel Connector for CData Sync

SSHClientCertSubject

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

解説

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

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

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

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

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

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EEメールアドレス

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

Microsoft Excel Connector for CData Sync

SSHClientCertType

SSHClientCert 秘密鍵の種類。

解説

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

種類説明許容されるBlob 値
MACHINE/USER Blob 値はサポートされていません。
JKSFILE/JKSBLOB base64のみ
PFXFILE/PFXBLOBPKCS12形式(.pfx)のファイル。証明書と秘密鍵の両方を含む必要があります。base64のみ
PEMKEY_FILE/PEMKEY_BLOBPEM 形式のファイル。RSA、DSA、またはOPENSSH の秘密鍵を含む必要があります。オプションで、秘密鍵と一致する証明書を含むことができます。base64またはプレーンテキスト。blob をテキストとして入力する場合、改行をスペースに置き換えることができます。
PPKFILE/PPKBLOBputtygen ツールで作成されたPuTTY 形式の秘密鍵。base64のみ
XMLFILE/XMLBLOB.NET のRSA クラスによって生成される形式のXML キー:RSA.ToXmlString(true)。base64またはプレーンテキスト。

Microsoft Excel Connector for CData Sync

SSHUser

SSH ユーザー。

解説

SSH ユーザー。

Microsoft Excel Connector for CData Sync

SSHPassword

SSH パスワード。

解説

SSH パスワード。

Microsoft Excel Connector for CData Sync

Firewall

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


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

FirewallType

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

解説

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

タイプ デフォルトポート 説明
TUNNEL 80 これが設定されている場合、Sync App はMicrosoft Excel への接続を開き、プロキシを経由して通信が行われます。
SOCKS4 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

Microsoft Excel Connector for CData Sync

FirewallServer

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

解説

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

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

Microsoft Excel Connector for CData Sync

FirewallPort

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

解説

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

Microsoft Excel Connector for CData Sync

FirewallUser

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

解説

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

Microsoft Excel Connector for CData Sync

FirewallPassword

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

解説

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

Microsoft Excel Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

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

解説

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

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

Microsoft Excel Connector for CData Sync

ProxyServer

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

解説

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

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

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

Microsoft Excel Connector for CData Sync

ProxyPort

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

解説

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

Microsoft Excel Connector for CData Sync

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

  • BASIC: Sync App はHTTP BASIC 認証を行います。
  • DIGEST: Sync App はHTTP DIGEST 認証を行います。
  • NEGOTIATE: Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
  • PROPRIETARY: Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

Microsoft Excel Connector for CData Sync

ProxyUser

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

解説

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

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

user@domain
domain\user

Microsoft Excel Connector for CData Sync

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

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

Microsoft Excel Connector for CData Sync

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTOデフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

Microsoft Excel Connector for CData Sync

ProxyExceptions

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

解説

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

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

Microsoft Excel Connector for CData Sync

Logging

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


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

LogModules

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

解説

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

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

Microsoft Excel Connector for CData Sync

Schema

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


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

Location

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

解説

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

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

Microsoft Excel Connector for CData Sync

BrowsableSchemas

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

解説

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

Microsoft Excel Connector for CData Sync

Tables

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

解説

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

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

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

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

Microsoft Excel Connector for CData Sync

Views

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

解説

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

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

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

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

Microsoft Excel Connector for CData Sync

Miscellaneous

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


プロパティ説明
CharsetMicrosoft Excel ファイルに移行、またはMicrosoft Excel ファイルから移行した文字データをエンコードおよびデコードするための、セッション毎の文字セットを指定します。デフォルト値はUTF-8 です。
ClientCultureこのプロパティを使用して、クライアントアプリケーションが受け取るデータの形式(通貨値など)を指定できます。このプロパティは、クライアントアプリケーションがマシンの現在のカルチャ設定をサポートしていない場合に使用できます。例えば、Microsoft Access では'en-US' が必要です。
Cultureこの設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。
CustomHeadersユーザーが決定したその他のヘッダー(オプション)。
CustomUrlParamsリクエストに含めるカスタムクエリ文字列。
FolderIdGoogle Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。
IncludeDropboxTeamResourcesDropbox チームフォルダやファイルを含めるかどうかを示します。
IncludeItemsFromAllDrivesGoogle Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。
MaxRowsクエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
Microsoft Excel Connector for CData Sync

Charset

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

解説

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

Microsoft Excel Connector for CData Sync

ClientCulture

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

解説

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

Microsoft Excel Connector for CData Sync

Culture

この設定を使用して、provider に渡された特定のデータ型をprovider が解釈する方法を決定するカルチャ設定を指定できます。例えば、Culture='de-DE' の設定にすると、米国のマシンでもドイツ語形式で出力されます。

解説

このプロパティは、Sync App 入力に影響を与えます。別のカルチャ形式の値を解釈するには、Client Culture プロパティを使用します。デフォルトでは、Sync App は入力の解釈と出力の形式に、マシンの現在のロケール設定を使用します。

Microsoft Excel Connector for CData Sync

CustomHeaders

ユーザーが決定したその他のヘッダー(オプション)。

解説

このプロパティは、他のプロパティ(ContentType、From など)から作成されたHTTP リクエストヘッダーに追加するヘッダーの文字列に設定できます。

ヘッダーは、HTTP の仕様で説明されているとおり、"header: value" 形式でなければなりません。ヘッダー行はキャリッジリターンと改行(CRLF)文字で区切る必要があります。

このプロパティは慎重に使用してください。このプロパティに無効なヘッダーが含まれていると、HTTP リクエストは失敗する場合があります。

このプロパティは、専門的/非標準的なAPI と統合するためにSync App の機能を微調整する場合に便利です。

Microsoft Excel Connector for CData Sync

CustomUrlParams

リクエストに含めるカスタムクエリ文字列。

解説

CustomUrlParams を使用すると、HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定できます。パラメータは、field1=value1&field2=value2&field3=value3 の形式で、クエリ文字列としてエンコードする必要があります。クエリ文字列の値はURL エンコードされている必要があります。

Microsoft Excel Connector for CData Sync

FolderId

Google Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。

解説

Google Drive のフォルダID。設定すると、URI で指定されたリソースの位置はすべての操作においてFolder ID からの相対位置となります。

Microsoft Excel Connector for CData Sync

IncludeDropboxTeamResources

Dropbox チームフォルダやファイルを含めるかどうかを示します。

解説

Dropbox チームフォルダやファイルにアクセスするには、この接続プロパティをTrue に設定してください。

Microsoft Excel Connector for CData Sync

IncludeItemsFromAllDrives

Google Drive の共有ドライブ項目を結果に含めるかどうか。存在しないかfalse に設定されている場合、共有ドライブ項目は返されません。

解説

このプロパティを'True' に設定すると、共有ドライブを含むすべてのドライブからファイルが取得されます。URI の先頭を共有ドライブのパスに設定し、オプションで任意のフォルダを指定することで、ファイルの検索対象を特定の共有ドライブまたは共有ドライブ内の特定のフォルダに限定することができます(例:'gdrive://SharedDriveA/FolderA/...')。さらに、FolderId プロパティを使用すると検索対象を正確なサブディレクトリに限定できます。

Microsoft Excel Connector for CData Sync

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Microsoft Excel Connector for CData Sync

Other

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

解説

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

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

統合およびフォーマット

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

Microsoft Excel Connector for CData Sync

PseudoColumns

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

解説

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

Microsoft Excel Connector for CData Sync

RowScanDepth

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

解説

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

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

Microsoft Excel Connector for CData Sync

Timeout

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

解説

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

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

Microsoft Excel Connector for CData Sync

UserDefinedViews

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

解説

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

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

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

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

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Sheet WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479