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

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

このセクションでは、SharePoint Online およびSharePoint On Premises への接続に関する詳細について説明します。

ワークブックへの接続

使用しているSharePoint のエディションに関わらず、File をExcel ワークブックに設定します。このパスは次のプロパティからの相対パスです。

• Library：デフォルトでは、Shared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定できます。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
• Folder：このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名と関連があります。

テーブルとしてのスプレッドシートデータへの接続

Sync App は、基底のAPI の使用可能なオブジェクトに基づいて使用可能なテーブルを検出します。

API は異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択します。

• OData： OData API を使用すると、Excel で［挿入］->［テーブル］をクリックして作成されたExcel テーブルオブジェクト（範囲やスプレッドシートではありません）から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、Sync App がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定します。
• REST： REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへのアクセスを可能にします。これはデフォルトのAPI です。範囲およびスプレッドシートから多数の行をリクエストすることはREST API によって制限されており、Sync App では返される行数をデフォルトで100に制限しています。またSync App は、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定します。

DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

Sync App がテーブルを検出してそれらをクエリする方法について、詳しくはData Model を参照してください。

SharePoint オンプレミスへの接続

Url をサーバー名もしくはIP アドレスに設定します。さらに、SharePointVersion および認証値を設定します。

SharePoint OnPremise を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUser およびPassword を設定します。

Note：SharePoint On-Premises 2010に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

• Windows（NTLM）

  これは最も一般的な認証タイプです。そのため、Sync App はNTLM をデフォルトとして使用するように事前設定されています。Windows のUser およびPassword を設定して接続します。

• Kerberos

  Kerberos で認証する方法についての詳細は、Kerberos の使用 を参照してください。

• Forms

  この設定で、Active Directory の代わりにカスタム認証メソッドによる認証が可能になります。この認証タイプを使用するには、AuthScheme をFORMS に設定し、User およびPassword を設定します。

• ADFS

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

  • User：ADFS ユーザーに設定。
  • Password：ユーザーのADFS パスワードに設定。
  • SSOLoginURL：ADFS サーバーのWS-Trust エンドポイントに設定。
  次のSSOProperties がADFS への認証に必要です。
  • RelyingParty：SharePoint のADFS サーバー上の証明書利用者の識別子の値です。
  以下は接続文字列の例です。
  

  AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;SSOLoginURL=https://<authority>/adfs/services/trust/2005/usernamemixed;SSO Properties ='RelyingParty=urn:sharepoint:sp2016;';

• Anonymous Access

  Set the AuthScheme to NONE along with the URL.

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

高度なインテグレーションで簡単にデータにアクセスできるようにするには、次のクエリを使うことができます：

• TypeDetectionScheme：このプロパティを使って、RowScanDepth で指定された値に基づく自動型検出を有効化/無効化できます。
• RowScanDepth：このプロパティは、カラムのデータ型を判定するためにスキャンされる行数を指定します。

Troubleshooting

413 Request Entity Too Large

This error occurs when a workbook has too much data per row. Generally, solution to this error will be to make the Excel table smaller or to make the rows less dense.

However, setting the following connection properties will enable you to work around this limitation. Note: This workaround is only supported when using the REST API.

• DefineTables: Set this to the desired cell range in your sheet.
• Other: Set this to PageSize=X to determine the number of records that will be paged through at once. Each page should contain less than 100kb. Note that smaller page sizes also entail slower perfomance.

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

Kerberos

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

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

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

Keytab ファイル

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

User およびPassword

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

クロスレルム

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

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

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Sync App は、SharePoint 2013で導入されたREST API およびOData API を通じて、SharePoint オンプレミスからExcel データを取得することをサポートします。Excel ファイルは、Excel 2007 以降で使用されている.xlsx 形式である必要があります。

Note： Microsoft はSharePoint Online のExcel Services API を2022年2月に終了する予定であることを表明しました。 今後、SharePoint データにアクセスする際には、CData Sync App for Excel Online への移行をご検討ください。

Sync App は、以下に基づいてワークブック内のテーブルを検出できます。

• スプレッドシート
• Excel テーブル
• 範囲

動的なメタデータクエリ

動的なメタデータクエリを通じて、Excel テーブルやスプレッドシートの追加やカラムの変更などのExcel でのあらゆる変更は、再接続時に反映されます。

テーブル検出の設定

OData API とREST API（デフォルト）はそれぞれ異なるAPI オブジェクトを表示します。ワークブックの構成とExcel Services のバージョンに基づいて、使用するAPI を選択します。

Excel テーブルへの接続

OData API は、スプレッドシートの［挿入］->［テーブル］で定義したExcel テーブルのみ表示します。

スプレッドシート、範囲、およびExcel テーブルへの接続

Excel テーブルの外のデータにアクセスする必要がある場合は、UseRESTAPI をtrue に設定します。REST API を使用すると、スプレッドシート、範囲、およびExcel テーブルにデータベーステーブルとしてアクセスできます。

スプレッドシートと範囲へのSQL の実行について、詳しくはREST API を参照してください。

SharePoint バージョンでサポートされているAPI

次のテーブルは、各SharePoint バージョンで使用できるAPI を示しています。

OData プロトコルを使う場合、スプレッドシート内のExcel テーブルで定義されたデータのみにアクセスできます。このデータは、Excel で［挿入］->［テーブル］をクリックして作成します。

テーブルオブジェクトの外にデータがある場合には、OData API 経由での取得はできません。この場合には、テーブルが返されません。 これはOData API の仕様であり、この場合にはREST API の使用を検討してください。

REST API を使用している場合は、次のテーブルからデータを選択できます。

• ワークブック内のスプレッドシート
• Excel テーブルオブジェクト
• DefineTables で指定する範囲

名前衝突の解決

2つ以上のテーブルが同じ名前を持つ場合、Sync App は衝突を解決するために、次の優先順位を使用します：［範囲］->［Excel テーブル］->［シート］の降順。

次に例を示します。MyTable がDefineTables にあり、同じ名前のExcel テーブルがワークブックにあります。DefineTables で指定された定義はExcel テーブルをオーバーライドします。

スプレッドシートから選択

スプレッドシートからデータを選択するには、FROM 句でスプレッドシート名を指定します。デフォルトでは、1行目はカラム名の定義に使われます。Header をfalse に設定すると、自動カラム名検出を無効にできます。

データの範囲はA1:Z100 です。異なる範囲を指定するには、DefineTables を使用します。

Excel テーブルから選択

Excel テーブルオブジェクトからデータを選択するには、FROM 句でテーブル名を指定します。これらはExcel で［挿入］->［テーブル］をクリックして作成されたテーブルです。

範囲から選択

標準のExcel 形式を使用して範囲を定義できます。範囲をDefineTables のテーブル名にマッピングします。

データ型のマッピング

Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Authentication

Connection

SSO

Kerberos

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

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

認証で使用されるスキーム。有効な入力値はNTLM、Basic、Digest、Forms、None、Negotiate、ADFS です。

解説

このフィールドは、Password およびUser とともに、サーバーに対して認証をするために使われます。デフォルトのオプションはNTLM です。次のオプションを使って、認証スキームを選択してください。

• NTLM：認証にWindows クレデンシャルを使う場合に設定。
• Basic：HTTP Basic 認証を使う場合に設定。
• Digest：HTTP Digest 認証に設定。
• Forms：Forms 認証を使う場合に設定。
• Negotiate：AuthScheme がNegotiate に設定された場合、Sync App は認証メカニズムをサーバーとネゴシエートします。Kerberos 認証を使いたい場合はAuthScheme をNegotiate に設定します。
• ADFS：ADFS でシングルサインオン認証を使う場合に設定。
• None：匿名認証を使う場合に設定。

サイトまたはサイトコレクションのベースURL。

解説

以下は有効なURL の例です。

• http://server/SharePoint/
• http://server/Sites/mysite/
• http://server:90/

サーバーへの認証で使用されるアカウントのユーザー名。

解説

このフィールドは、Password とともに、Url で指定されたSharePoint OnPremise に対して認証をするために使われます。

サーバーへの認証で使用されるアカウントのパスワード。

解説

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

接続するSharePoint サーバーのバージョン。

解説

有効な値は、SharePoint 2013、およびSharePoint 2010 です。

シングルサインオン（SSO）を使用する場合のセキュリティトークンサービス（STS）のURL。

解説

このプロパティは、ローカルActive Directory Federation Services（ADFS）でシングルサインオンを使用する場合にのみ設定が必要です。

Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).

解説

Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).

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

スプレッドシート内のテーブルの定義。

解説

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

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

Note：定義されたテーブル名がデフォルトで返されるものと同じ場合（e.g. same name as a worksheet）、定義されたテーブルはデフォルトテーブルを上書きします。

接続するExcel ファイルの名前。

解説

接続するExcel ファイルの名前（".xlsx" 拡張子を含む）。このファイルは存在している必要があります。

File プロパティで指定したワークブックを含むフォルダ。

解説

File が存在するLibrary 内の階層を含むフルパス。例えば、File が"BaseFolder"という名前のフォルダ内の"SubFolder" という名前のフォルダに位置している場合、プロパティは"/BaseFolder/SubFolder/" に設定されます。

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

解説

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

Note：このプロパティは、UseRESTAPI が'True' に設定されている場合のみ有効です。

接続するDocument Library。

解説

このプロパティは、Excel ファイルを保存するDocument Libray の名前を示します。 ライブラリを指定しない場合は、"SharePoint documents" ライブラリが使用されます。

OneDrive for Business への接続を行う場合、このプロパティを"Documents" に設定します。

Note:

If the language of your SharePoint site is not English, set this property to the name of the library for the corresponding language.

Here are some steps to get the value:

1.Go to your SharePoint site collection.

2.Go to the document library page.

3.Click on Settings menu.

4.lick on the Library settings on the settings menu.

5.Under the List Information section, there is a flag "Web Address".

For example, the address is "https://Your SharePoint Site/subSites/.../subSites/Documents partages/Forms/AllItems.aspx" if the language of SharePoint site belongs to the French. And the value "Documents partages" is the name of the library for the corresponding language.

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

解説

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

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

解説

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

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

解説

データの取得にREST API を使うかどうか。

解説

データの取得にREST API を使うかどうか。SharePoint 2010 ではREST API を使用する必要があります。SharePoint 2013 以降のバージョンでは、REST API およびOData API の両方が利用可能です。

REST API を使用して、テーブルオブジェクトと同様に、スプレッドシートと範囲にテーブルとしてアクセスします。OData API は、テーブルオブジェクトにのみアクセスを可能にします。

異なる方法で構成されたスプレッドシートへのクエリについて詳しくは、Data Model を参照してください。

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

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

解説

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

シングルサインオン（SSO）を使用する場合のユーザーのドメイン。

解説

このプロパティは、シングルサインオンを使用する場合（UseSSO がtrue に設定されている場合）でUser のドメイン（例：[email protected]）がSSO サービスで設定されたドメイン （例：[email protected]）と異なる場合のみ適用可能です。

このプロパティは、ADFS サービス使用時に必要になる場合があります。

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

解説

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

SSO configuration is discussed further in .

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

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

解説

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

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

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

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

解説

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

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

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

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

解説

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

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

解説

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

サービスのKerberos レルム。

解説

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

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

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

サービスのKerberos KDC。

解説

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

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

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

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

解説

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

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

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

解説

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

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

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

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

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

解説

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

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

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

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

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

解説

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

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

user@domain
domain\user

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

解説

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

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

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

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

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

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

解説

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

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

解説

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

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

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

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

解説

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

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

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

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

解説

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

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

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

解説

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

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

解説

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

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

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

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

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

解説

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

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

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

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

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

Indicates if navigation parent columns should be included on navigation views.

解説

When NavigationPropertiesAsViews is set to true, this property controls if parent columns from the navigation property will be displayed or not on the view. It may be worth displaying them in order to take advantage of being able to filter based on information about the parent.

When set to false, the primary keys of the parent will still be displayed to allow for joining back to the parent, but other other columns will not be.

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

解説

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

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

統合およびフォーマット

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

解説

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

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

解説

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

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

Indicates whether or not the empty rows should be pushed when UseRESTAPI = true.

解説

If true, the empty rows will be pushed at the output when UseRESTAPI = true.

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

解説

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

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

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

解説

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

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

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

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

次に例を示します。

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

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