OData への接続を追加

OData への接続を追加するには：

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

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

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

OData への接続

OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。

OData への認証

OData は、以下を経由する認証をサポートします。

• HTTP
• Kerberos
• SharePoint Online
• OAuth
• Azure AD

HTTP 認証スキーム

HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。

Scheme	AuthScheme	その他の設定
None	None	認証を必要としない場合に使用。
Basic	Basic	User、Password
NTLM（1）	NTLM	User、Password
Digest（サポートされている場合）	Digest	User、Password

（1） NTLM は、Windows ユーザー資格情報を使用して、LAN でよく使用されるWindows 認証の一種です。Windows マシンから接続していない場合や、現在ログインしているユーザーアカウントを接続に使用しない場合は、User およびPassword を設定します。

Kerberos

Kerberos を使用してOData への認証を行うには、次のプロパティを設定します。

• hive.server2.authentication：Kerberos。
• AuthScheme：NEGOTIATE。
• KerberosKDC：Kerberos KDC マシンのホスト名またはIP アドレス。
• KerberosSPN：OData のKerberos プリンシパルのサービスとホスト。この値は、principal value の'@' 記号のすぐ前にあります。

SharePoint Online

SharePoint Online 接続は、SharePoint Online cookie を取得することで確立できます。認証するには、次のプロパティを設定します。

• AuthScheme：SharePointOnline。
• User：認証するSharePoint Online ユーザーアカウント。
• Password：認証するアカウントのパスワード。

OAuth

OData のすべてのOAuth フローでこの認証を有効にするには、カスタムOAuth アプリケーションを作成し、AuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのOData への認証について詳しく説明します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 OData で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

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

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには：

1. はじめてデータに接続する前に、次の接続パラメータを設定します。
   • InitiateOAuth：REFRESH。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

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

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

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

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

Azure AD

AzureAD は、Azure を経由するOAuth の形式をサポートします。AuthScheme をAzureAD に設定します。

CData Sync App は、自動的に内部で既知のAzure URL を処理するので、OAuthAccessTokenURL、OAuthAuthorizationURL、OAuthRefreshTokenURL、OAuthRequestTokenURL のような通常のOAuth 接続プロパティを指定する必要は ありません。

この接続メソッドには、以下のような他の接続プロパティが必要な場合があります。

• Scope：InitiateOAuth がGETANDREFRESH に設定されている場合は、資格情報の取得中にScope がMicrosoft に送信されるため、これを指定する必要があります。これはサービスによって異なりますが、一般的には、リソース（URL のhostname）とパーミッション名の組み合わせになります。例：https://host/user_impersonation
• AzureADResource：Microsoft ログイン時に認証する特定のAzure リソース。 何も指定されていない場合は、ユーザーアカウントのデフォルトリソースが使用されます。
• AzureADTenant：Microsoft ログイン中に認証する特定のAzure テナント。何も指定されていない場合は、common ログインエンドポイントを介したユーザーアカウントのデフォルトテナントが使用されます。これは、接続する特定のリソースや、リソースが別のテナントに保存されている場合などによっては、正しくないことがあります。

それ以外は、認証手順はデスクトップ認証、Web 認証、ヘッドレスマシン認証の説明と同じです。

Azure AD で使用するカスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。

セキュアなOData への接続

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

Kerberos

Kerberos でOData への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でOData への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます（チケットはリフレッシュされます）。

Sync App は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

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

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには：

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

   チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Sync App はキャッシュファイルを使用してOData に接続するためのKerberos チケットを取得します。

Note： KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Sync App は指定されたキャッシュファイルを使用してOData に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

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

この方法を使用するには、User およびPassword プロパティを、OData での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

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

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

API リクエストのカスタマイズ

次のプロパティは、非標準的なAPI と連携する際、またはより高度なOData 機能にアクセスする際に役立つ詳細な設定を実現します。

• CustomUrlParams：Sync App が作成したリクエストに、クエリ文字列パラメータを追加する際に設定します。

  このプロパティが設定されていない場合、エラーを避けるためにUrl をサービスドキュメントに設定する必要があります。

• ContinueOnError：Sync App は内部のドライバーインターフェースのバッチAPI が呼び出された場合、OData 4.0 サービスへバッチリクエストを作成します。例えば、アプリケーションがバッチリクエストを行う場合です。

  このプロパティが設定されている場合、実行の停止を避けるためにエラーは一時テーブル内に返されます。

• UseEtags：OData クライアントはEtags を、リソースがサーバーで変更されたかどうかを確認し、コンカレンシーの問題を回避するために使用できます。
  この機能を利用する必要がない場合、またはOData サービスがEtags を返さない場合には、このプロパティをfalse に設定してください。
• Cookies：Sync App の外部で取得したクッキーを使用する必要がある場合、この値にクッキーを設定できます。
• CustomHeaders：このプロパティを使えば、任意のHTTP リクエストヘッダーに任意の値を追加できます。

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

次のプロパティを設定して、Sync App がOData API をデータベースとしてモデル化する方法を設定します。

• NavigationPropertiesAsViews：デフォルトでは、Sync App はナビゲーションプロパティをビューとしてモデル化します。
  これによって、これらのエンティティがOData サービスで外部キーによってリンクされていなくても、関連するエンティティへ接続することができます。
• SupportsExpand：API が$expand パラメータをサポートしていない場合、このプロパティを設定してNavigationPropertiesAsViews が設定されている場合のエラーを回避します。
  API がこのパラメータをサポートしていない場合、WHERE 句内のベースエンティティの主キーを指定してナビゲーションプロパティにアクセスします。
• DataFormat：このプロパティをJSON またはXML に設定してください。設定されていない場合、Sync App はサービスが定義したデフォルトのフォーマットを使用します。
• ODataVersion：このプロパティを使用して、Sync App が検出したバージョンをオーバーライドします。アプリケーションが古いOData バージョンを使用している場合に役立ちます。
• UseIdUrl：デフォルトでは、Sync App はダイレクトURL を主キーとしてエンティティに返します。このプロパティをfalse に設定すると、エンティティキーが返されます。
• UseSimpleNames：カラム名に英数字のみを返すには、これをtrue に設定します。この設定は、SQL エスケープおよびSQL ベースのツールでのエラーを避けるために役立ちます。
• ServerTimeZone：デフォルトでは、Sync App はサーバーのEdm.DateTime バリューがGMT であると想定し、環境に応じてインストールされたマシンのローカルタイムゾーンに、またはローカルタイムゾーンからGMT に、変換します。
  サーバーのEdm.DateTime バリューが異なるタイムゾーンに適用されると分かっている場合には、このプロパティをそのタイムゾーン（例：EST）に設定してください。

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

CData Sync App は、OData エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、接続先のOData サービスから動的に取得されます。メタデータのあらゆる変更（カラムの追加や削除、データ型の変更など）は、再接続によってロードされます。

テーブル

Sync App は、サービスメタデータドキュメントで記述された書き込み可能なエンティティセットおよびシングルトンを双方向テーブル としてモデル化します。

ビュー

いくつかのOData エンティティは、ナビゲーションプロパティ 経由でのみアクセス可能です。デフォルトでは、Sync App はナビゲーションプロパティを別々のビューとしてモデル化します。この動作はNavigationPropertiesAsViews で無効にできます。 ナビゲーションプロパティのクエリについて詳しくは、ビュー を参照してください。

ストアドプロシージャ

Stored Procedures は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

The Sync App exposes tables for every entity set and singleton defined on the OData service document. Entities on these tables may be inserted, updated, or deleted using standard SQL insert, update, or delete statements.

Executing Deep Inserts with SQL

The Sync App supports OData deep inserts, in which you simultaneously create a base entity and link it to related entities, by specifying navigation properties. To specify ナビゲーションプロパティ for an entity, you may either submit JSON / XML data, or you may create a temporary table for the navigation property and then reference the temporary table in the insert to the base table. Sumit the XML / JSON or reference the temporary table in the appropriate navigation property column on the base table. Each navigation property column is prefixed with the word "Linked".

Example: Deep Inserts using XML / JSON

To submit XML or JSON data, simply supply the values for the table the navigation property is referencing in XML or JSON format. If you are familiar with the OData standard, you should not be submitting values in the standard. The XML / JSON used here is simply a means of supplying multiple values ot the CData Sync App.

For example, consider the Orders table in Northwind odata.org test service. To create a new Order, you specify the Products ordered, Customer, Employee, and Shipper. To do so, you need to specify the Customer, Order_Details, Shipper, and Employee navigation properties.

• Customer: The following XML represents a new Customer:
  

    <Row>
      <CustomerID>VINET</CustomerID>
  	<CompanyName>Vins et alcools Chevalier</CompanyName>
  	<ContactName>Paul Henriot</ContactName>
  	<ContactTitle>Accounting Manager</ContactTitle>
  	<Address>59 rue de l'Abbaye</Address>
  	<City>Reims</City>
  	<PostalCode>51100</PostalCode>
  	<Country>France</Country>
  	<Phone>26.47.15.10</Phone>
  	<Fax>26.47.15.11</Fax>
    </Row>

• Order_Details: The following JSON add two Products to the Order:
  

    [
      {
  	  "ProductID": 72,
  	  "UnitPrice": 34.80,
  	  "Quantity": 5,
  	  "Discount": 0
  	},
  	{
  	  "ProductID": 42,
  	  "ProductID": 9.80,
  	  "ProductID": 10,
  	  "ProductID": 0
  	}
    ]

• Employee: The following XML specifies the existing Employee:
  

    <Row>
      <EmployeeID>5</EmployeeID>
    </Row>

• Shipper: The following JSON specifies the existing Shipper:
  

    [
      {
        "ShipperID": 3
      }
    ]

In order to execute the insert, simply reference or include as string literals the complete XML / JSON. For example:

INSERT INTO Orders (CustomerID, EmployeeID, ShipVia, ShipName, ShipAddress, ShipCity, ShipPostalCode, ShipCountry, OrderDate, LinkedOrder_Details, LinkedCustomer, LinkedEmployee, LinkedShipper) VALUES ('VINET', 5, 3, 'Paul Henriot', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '07/04/1996', '{ ... }', '<Row>...</Row>', ?, ?)

Example: Deep Inserts using Temporary Tables

If using temporary tables, they must be defined and inserted within the same connection. Closing the connection will clear out any temporary tables in memory. Keeping with the Northwind example, you need to specify the following navigation properties.

Creating Temporary Tables

Insert the related entities into temporary tables that correspond to each navigation property. You can specify an existing entity's primary key or you can insert a new entity.

• Customer: The following statement creates a new Customer:
  

  INSERT INTO Customers#TEMP (CustomerID, CompanyName, ContactName, ContactTitle, Address, City, PostalCode, Country, Phone, Fax) 
  VALUES ('VINET', 'Vins et alcools Chevalier', 'Paul Henriot', 'Accounting Manager', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '26.47.15.10', '26.47.15.11')

• Order Details: The following statements add two Products to the Order:
  

  INSERT INTO Order_Details#TEMP (ProductID, UnitPrice, Quantity, Discount) VALUES (72, 34.80, 5, 0)
  
  INSERT INTO Order_Details#TEMP (ProductID, UnitPrice, Quantity, Discount) VALUES (42, 9.80, 10, 0)

• Employee: The following statement specifies the existing Employee:
  

  INSERT INTO Employees#TEMP (EmployeeID) 
  VALUES (5)

• Shipper: The following statement specifies the existing Shipper:
  

  INSERT INTO Shippers#TEMP (ShipperID) VALUES (3) 

The CData Sync App will assume that the Shipper and Employee already exist and will only link to the existing references since only the primary keys were specified for either. When more than just the primary key is defined, such as the examples for Customer and Order_Details, the CData Sync App will attempt to create new entries - triggering the deep insert.

Inserting the Entity

In the INSERT statement for the base entity, reference the temporary tables in the LinkedOrder_Details, LinkedCustomer, LinkedEmployee, and LinkedShipper columns:

INSERT INTO Orders (CustomerID, EmployeeID, ShipVia, ShipName, ShipAddress, ShipCity, ShipPostalCode, ShipCountry, OrderDate, LinkedOrder_Details, LinkedCustomer, LinkedEmployee, LinkedShipper) VALUES ('VINET', 5, 3, 'Paul Henriot', '59 rue de l''Abbaye', 'Reims', '51100', 'France', '07/04/1996', 'Order_Details#TEMP', 'Customers#TEMP', 'Employees#TEMP', 'Shippers#TEMP')

Modeling Navigation Properties

By default, the Sync App models ナビゲーションプロパティ as separate views. The views are named in the format ParentTable_NavigationProperty. You can disable this behavior with NavigationPropertiesAsViews.

Querying Navigation Properties

For an example of working with a navigation property as a view, consider the Northwind sample service from odata.org. In this service, the Categories entity set has a Products navigation property. The CData Sync App will display a view called Categories_Products for this service. Retrieving data from Categories_Products will display all of the Products associated with a given Category. The Categories_Products view has a primary key made up of the Id of the parent entity and the Id of the related entity.

Support for navigation properties is limited in some OData services. See NavigationPropertiesAsViews and SupportsExpand for more information on API restrictions when querying navigation properties.

In OData, a navigation property is a property on an entity that is itself either a single entity or list of entities.

A single-entity navigation property signifies a one-to-one relationship; for example, an OData service might allow a Product to have only one Category. In this service, Category might be a navigation property on Products.

An entity set navigation property signifies a one-to-many relationship; for example, many Products can belong in the same Category. In this service, Products might be a navigation property on Categories.

Working with Navigation Properties Relationally

Navigation properties in OData link related entities. Similarly, in a relational database, a foreign key serves to link tables. For example, a Product record might have a CategoryId column, which uniquely identifies what Category the Product belongs to. However, there is no requirement in OData that an entity must contain a foreign key reference to a related entity. This means sometimes you will get navigation properties without having a foreign key reference to that entity on the parent or back to the parent from the related entity. In cases without a foreign key reference, the navigation property's existence is the only thing that can be used to identify a relationship between the two entities.

Select

NavigationPropertiesAsViews is useful for accessing data in OData services that lack foreign key references. Likewise, it can be used to retrieve related entites that do not exist by themselves such as LineItems on an Invoice. See ビュー for more information on querying navigation properties.

INSERT

The Sync App supports OData deep inserts. See テーブル for more information on specifying navigation properties when you create an entity.

データ型のマッピング

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

OData V2	OData V3	OData V4	CData スキーマ
Edm.Binary	Edm.Binary	Edm.Binary	binary
Edm.Boolean	Edm.Boolean	Edm.Boolean	bool
Edm.DateTime	Edm.DateTime	Edm.DateTimeOffset	datetime
Edm.Decimal	Edm.Decimal	Edm.Decimal	decimal
Edm.Double	Edm.Double	Edm.Double	double
Edm.Guid	Edm.Guid	Edm.Guid	guid
Edm.Int16	Edm.Int16	Edm.Int16	int
Edm.Int32	Edm.Int32	Edm.Int32	int
Edm.Int64	Edm.Int64	Edm.Int64	bigint
Edm.String	Edm.String	Edm.String	string
Edm.Time	Edm.Time	Edm.TimeOfDay	time

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

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

Authentication

---

プロパティ	説明
URL	OData サービスファイルのルートURL で、サービスルートURL とも呼ばれます。例：http://services.odata.org/V4/Northwind/Northwind.svc
AuthScheme	認証で使用されるスキーム。NTLM、BASIC、DIGEST、NONE、NEGOTIATE、およびSHAREPOINTONLINE が利用可能です。
User	認証するOData ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online.

Azure Authentication

---

プロパティ	説明
AzureADTenant	The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth).
AzureTenant	データにアクセスするために使用されるOData テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureResource	認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。

SSO

---

プロパティ	説明
SharePointSSODomain	The domain of the user when using single sign-on (SSO).

OAuth

---

プロパティ	説明
InitiateOAuth	OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthAccessToken	OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。
OAuthAccessTokenSecret	OAuth を使用して接続するためのアクセストークンのトークン シークレット。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
OAuthPasswordGrantMode	OAuth Client Id およびClient Secret を渡す方法を指定します。サポートされるオプション：BASIC およびPOST。
OAuthIncludeCallbackURL	アクセストークンリクエストにコールバックURL を含めるかどうか。
OAuthAuthorizationURL	OAuth サービスの認可URL。
OAuthAccessTokenURL	OAuth アクセストークンを取得するURL。
OAuthRefreshTokenURL	OAuth トークンをリフレッシュするURL。
OAuthRequestTokenURL	サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
AuthToken	OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKey	OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParams	OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

Kerberos

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）
Cookies	Allows cookies to be manually specified in name=value pairs separated by a semicolon.
CustomHeaders	他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
CustomUrlParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
DataFormat	The data format to retrieve data in. Select either ATOM or JSON.
DecodeXMLNames	Unicode 文字を含むカラム名をデコードするかどうかを指定します。
EnableAtomicBatchOperations	Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
ExcludeControlInformationRootType	Indicates wheather or not the OData should use the odata.type control information for the root element.
ExpandAsterisk	Indicates whether the asterisk should be expanded in the $select query parameter.
IncludeNavigationParentColumns	Indicates if navigation parent columns should be included on navigation views.
IncludeReferenceColumn	Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.
MaxFilterLength	The maximum number of characters for the $filter query parameter.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxSelectLength	$Select クエリパラメータには最大文字数制限があります。このプロパティを0 に設定すると、ドライバーが$Select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに有用です。
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	使用するODataのバージョン。デフォルトでは、providerはバージョンを自動検出しようとします。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	OData から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ServerTimeZone	The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine.
StoredProceduresAsViews	A boolean indicating if we should list stored procedures which return a collection of entities as views.
SupportsExpand	Whether you need to specify the base entity's key to query navigation property views.
SupportsFilter	Set this to true if your OData service supports filters.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. If set to false, OData uses server-side paging.
UseEtags	ODataソースがEtagsを使用するかどうか。
UseIdURL	特定のエンティティへの直接URLを表すID列を表示するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

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

---

プロパティ	説明
URL	OData サービスファイルのルートURL で、サービスルートURL とも呼ばれます。例：http://services.odata.org/V4/Northwind/Northwind.svc
AuthScheme	認証で使用されるスキーム。NTLM、BASIC、DIGEST、NONE、NEGOTIATE、およびSHAREPOINTONLINE が利用可能です。
User	認証するOData ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online.

OData サービスファイルのルートURL で、サービスルートURL とも呼ばれます。例：http://services.odata.org/V4/Northwind/Northwind.svc

解説

サービスルートは通常、リソースパスとクエリオプションを含む長いURL の最初の部分です。

例えば、以下のURLで：

http://host:port/path/SampleService.svc/Categories(1)/Products?$top=2$orderby=Name

• サービスルートURL はhttp://host:port/path/SampleService.svc/ です。
• リソースパスはCategories(1)/Products? です。
• クエリオプションは$top=2$orderby=Name です。

認証で使用されるスキーム。NTLM、BASIC、DIGEST、NONE、NEGOTIATE、およびSHAREPOINTONLINE が利用可能です。

解説

このフィールドは、Password およびUser とともに、OData サーバーに対して認証をするために使われます。デフォルト値はNONE です。

• None：このサービスの認証は行いません。
• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• Basic：HTTP Basic 認証を使う場合に設定。
• Digest：HTTP Digest 認証を使う場合に設定。
• Negotiate：AuthScheme がNEGOTIATE に設定された場合、Sync App は認証メカニズムをサーバーとネゴシエートします。Kerberos 認証を使いたい場合はAuthScheme をNEGOTIATE に設定します。
• NTLM：認証にWindows クレデンシャルを使う場合に設定。
• OAuth：OAuth 接続を確立する場合に設定。
• OAuthPassword：パスワードグラントタイプでOAuth 接続を確立する場合に設定。
• OAuthClient：クライアントグラントタイプでOAuth 接続を確立する場合に設定。
• SharePointOnline：SharePoint Online 認証を使う場合に設定。

認証するOData ユーザーアカウントのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーアカウントのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.

解説

URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. You can use this property when the OData service does not have a root document.

Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online.

解説

When set to true, single sign-on (SSO) will be used to authenticate to SharePoint Online using the account specified via User and Password. The Active Directory Federation Services (AD FS), OneLogin, and OKTA SSO identity providers are supported.

SharePointSSODomain may be required to be set if the domain configured on the SSO domain is different than the domain of the User.

SSO is only applicable when using SharePoint Online and AuthScheme is set to SHAREPOINTONLINE. It is not available for OAuth connections to SharePoint.

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

---

プロパティ	説明
AzureADTenant	The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth).
AzureTenant	データにアクセスするために使用されるOData テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureResource	認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。

The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth).

解説

The tenant must be specified if using Azure Active Directory OAuth. The tenant is used to control who can sign into the application. This should be the name of the tenant such as xxx.onmicrosoft.com, the id such as 8eaef023-2b34-4da1-9baa-8bc8c9d6a490, contoso.onmicrosoft.com, or the word common.

データにアクセスするために使用されるOData テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）

解説

テナントは、主にドメイン（例えば、microsoft.com）に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID（ディレクトリID とも呼ばれる）によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。

解説

Azure OAuth を使用する場合は、リソースを指定する必要があります。 Web API（セキュアリソース）のApp Id URI に設定されなければなりません。

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

---

プロパティ	説明
SharePointSSODomain	The domain of the user when using single sign-on (SSO).

The domain of the user when using single sign-on (SSO).

解説

This property is only applicable when using single sign-on (SharePointUseSSO is set to true) and if the domain of the User (e.g. [email protected]) is different than the domain configured within the SSO service (e.g. [email protected]).

This property may be required when using the AD FS, OneLogin, or OKTA SSO services.

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

---

プロパティ	説明
InitiateOAuth	OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。
OAuthVersion	使われているOAuth のバージョン。
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthAccessToken	OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。
OAuthAccessTokenSecret	OAuth を使用して接続するためのアクセストークンのトークン シークレット。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
OAuthPasswordGrantMode	OAuth Client Id およびClient Secret を渡す方法を指定します。サポートされるオプション：BASIC およびPOST。
OAuthIncludeCallbackURL	アクセストークンリクエストにコールバックURL を含めるかどうか。
OAuthAuthorizationURL	OAuth サービスの認可URL。
OAuthAccessTokenURL	OAuth アクセストークンを取得するURL。
OAuthRefreshTokenURL	OAuth トークンをリフレッシュするURL。
OAuthRequestTokenURL	サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
AuthToken	OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKey	OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParams	OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。

解説

OAuth は、アプリケーションがHTTP サービス上のユーザーアカウントに限定的にアクセスすることを可能にする認可フレームワークです。OAuth フローは、ユーザーのログイン方法、認証に使用されるOAuth アクセストークンと資格情報の交換方法、およびアプリケーションへの限定的なアクセスを提供する方法を定義します。

OData は、OAuth アクセスを開始するための以下のオプションをサポートしています。

1. OFF：OAuth フローの自動開始はありません。OAuth フローは完全にユーザーによって操作され、ユーザーが自らのOAuth アクセストークンを取得するためのアクションを取ります。 この設定では、ユーザーがトークンを手動でリフレッシュし、現在のトークンが期限切れになった際に更新されたOAuthAccessToken プロパティで再接続する必要があることに注意してください。
2. GETANDREFRESH：OAuth フローはSync App によってすべて操作されます。トークンが既に存在する場合は、必要に応じてリフレッシュされます。トークンが存在しない場合、ユーザーにログインを促してトークンを取得します。
3. REFRESH：ユーザーはOAuth アクセストークンの取得を操作し、OAuth アクセストークンのリフレッシュシーケンスを設定します。ユーザーは認証のためにログインを求められることはありません。ユーザーがログインした後、Sync App がOAuthアクセストークンのリフレッシュを操作します。

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

解説

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

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

解説

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。これは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 Sync App は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。

OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、Sync App はトークンを直ちにリフレッシュします。

OAuth を使用して接続するためのアクセストークンのトークン シークレット。

解説

OAuth を使用して接続および認証するには、OAuthAccessTokenSecret プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessTokenSecret が取得されます。取得されたトークンシークレットは OAuthAccessToken と一緒に使用され、タイムアウトするまで複数の要求のために使用されます。

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

OAuth Client Id およびClient Secret を渡す方法を指定します。サポートされるオプション：BASIC およびPOST。

解説

OAuth RFC では、OAuthClientId とOAuthClientSecret を渡す2つの方法を提供します。 POST はpost データを介してOAuthClientId およびOAuthClientSecret を渡します。 （OAuthGrantType = PASSWORD, CODE, or CLIENT で動作します。） BASIC は、Authorize ヘッダーを介してOAuthClientId およびOAuthClientSecret を渡します。 （OAuthGrantType = CODE or CLIENT で動作します。）

アクセストークンリクエストにコールバックURL を含めるかどうか。

解説

デフォルトではtrue です。 標準に準拠したOAuth サービスでは、redirect_uri パラメータを必要としないCLIENT やPASSWORD などのグラント種別では、 redirect_uri パラメータを無視するからです。

このオプションは、redirect_uri が含まれる場合にエラーを報告するOAuth サービスに対してのみ有効にしてください。

OAuth サービスの認可URL。

解説

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

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

解説

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

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

解説

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

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

解説

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT 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 ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。

解説

データベースに使用しているユーザーがKerberos データベース内のユーザーと一致しない場合、これをKerberos プリンシパル名に設定する必要があります。

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 プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

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

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

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類は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 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

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

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

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

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

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

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

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がOData への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がOData への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がOData にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

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

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

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

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

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

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

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

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

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

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

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

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

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

---

プロパティ	説明
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）
Cookies	Allows cookies to be manually specified in name=value pairs separated by a semicolon.
CustomHeaders	他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
CustomUrlParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
DataFormat	The data format to retrieve data in. Select either ATOM or JSON.
DecodeXMLNames	Unicode 文字を含むカラム名をデコードするかどうかを指定します。
EnableAtomicBatchOperations	Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
ExcludeControlInformationRootType	Indicates wheather or not the OData should use the odata.type control information for the root element.
ExpandAsterisk	Indicates whether the asterisk should be expanded in the $select query parameter.
IncludeNavigationParentColumns	Indicates if navigation parent columns should be included on navigation views.
IncludeReferenceColumn	Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.
MaxFilterLength	The maximum number of characters for the $filter query parameter.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxSelectLength	$Select クエリパラメータには最大文字数制限があります。このプロパティを0 に設定すると、ドライバーが$Select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに有用です。
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	使用するODataのバージョン。デフォルトでは、providerはバージョンを自動検出しようとします。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	OData から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ServerTimeZone	The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine.
StoredProceduresAsViews	A boolean indicating if we should list stored procedures which return a collection of entities as views.
SupportsExpand	Whether you need to specify the base entity's key to query navigation property views.
SupportsFilter	Set this to true if your OData service supports filters.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. If set to false, OData uses server-side paging.
UseEtags	ODataソースがEtagsを使用するかどうか。
UseIdURL	特定のエンティティへの直接URLを表すID列を表示するかどうかを決定するboolean。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）

解説

ContinueOnError がtrue に設定されている場合、エラーが発生したバッチ操作は完了し、エラー応答を含む結果テーブルが作成されます。 ContinueOnError がfalse に設定されている場合、エラーが発生したバッチ操作は中止され、エラーメッセージが表示されます。

Allows cookies to be manually specified in name=value pairs separated by a semicolon.

解説

In general it should not be required to set this property. However, there are many different flavors of OData services. If your solution requires cookies that are obtained outside of the CData Sync App, they can be manually specified here. Specify cookies in name=value pairs separated by a semicolon. For instance: Cookie1=value;Cookie2=value2.

他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。

解説

このプロパティを使用して、Sync App から送信されるHTTP リクエストにカスタムヘッダーを追加します。

このプロパティは、追加ヘッダーや非標準ヘッダーを必要とするAPI とやり取りするためにリクエストを微調整する際に役立ちます。 ヘッダーはHTTP 仕様で記述されているとおり"header: value" の形式に従う必要があり、各ヘッダー行はキャリッジリターンとラインフィード（CRLF）文字で区切る必要があります。 重要：このプロパティを設定する際は注意してください。無効なヘッダーを指定するとHTTP リクエストが失敗する場合があります。

HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。

解説

このプロパティを使用すると、HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定できます。 パラメータは、各値がURL エンコードされた形式でfield1=value1&field2=value2&field3=value3 の形式で、クエリ文字列としてエンコードする必要があります。 URL エンコーディングは、以下のようにインターネット上で送信可能な文字列に変換する方法です。

• 非ASCII 文字は、"%" とそれに続く2桁の16進数で表される同等の文字に置き換えられます。
• スペースはプラス記号（+）または%20 で置き換えられます。

The data format to retrieve data in. Select either ATOM or JSON.

解説

Note that not all data sources support JSON. Other IANA content types are not supported at this time. Leave blank to use the system service default. If blank, ATOM will be used when submitting data in an INSERT or update.

Unicode 文字を含むカラム名をデコードするかどうかを指定します。

解説

この接続プロパティがTrue に設定されている場合、カラム名のUnicode 文字はすべて人間が読める文字として表示されます。

False（デフォルト）に設定されている場合、カラム名のUnicode 文字はすべて16進数エンコード形式で表示されます。

Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).

解説

If set to false, batch CUD operations are processed non-atomically, allowing individual operations to succeed or fail independently within the batch.

EnableAtomicBatchOperations is tightly coupled with ContinueOnError.

If ContinueOnError and EnableAtomicBatchOperations are both true, all batch rows are treated as a single unit. If a failure occurs, the API stops processing the remaining rows. The driver reports the remaining rows as failed.

If ContinueOnError is false and EnableAtomicBatchOperations is true, all batch rows are processed as a single unit. If one of the rows fails, the driver breaks the flow and displays an error. No rows are reported in LastResultInfo.

If ContinueOnError is true/false (defaults to true for EnableAtomicBatchOperations = false) and EnableAtomicBatchOperations is false, each row in the batch is treated as a single unit. the API processes all the rows. The driver populates LastResultInfo with information about each row, including their success status.

Indicates wheather or not the OData should use the odata.type control information for the root element.

解説

The OData spec expects the root element in a POST or PATCH request to use the control information annotation odata.type . Some services do not accept this annotation. This property can be set to true for such cases and the annotation will be ommited from the request. This property is valid only when the DataFormat property is set to JSON or when set to AUTO and a JSON format is detected.

This is what an example on what this annotation looks like on a requests post data:

{
  "@odata.type": "#NorthwindModel.Category",
  "CategoryName": "Electronics"
}

Indicates whether the asterisk should be expanded in the $select query parameter.

解説

When ExpandAsterisk is set to true all columns will be listed in the $select query parameter.

For example:

SELECT * FROM Items

All columns will be listed in projection.

SELECT col1,col2, ... , coln FROM Items

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.

Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.

解説

Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.

The maximum number of characters for the $filter query parameter.

解説

Some APIs have a limitation on the number of characters that can be included in the URL. If the set MaxFilterLength limit is reached, the filter is processed internally by the driver.

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

$Select クエリパラメータには最大文字数制限があります。このプロパティを0 に設定すると、ドライバーが$Select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに有用です。

解説

一部のAPI では、URL に含めることができる文字数に制限があります。設定されたMaxSelectLength の制限に達した場合、すべてのカラムがサービスから取得され、クライアント側でフィルタリングされます。

A boolean indicating navigation properties should be promoted to full views.

解説

This property can be useful for OData services that can return related collections of entities, or navigation properties. Some OData entities can only be accessed through navigation properties. NavigationPropertiesAsViews will cause all of the discovered navigation properties to be added as views in the format ParentTable_NavigationProperty.

Retrieving Data from Limited OData APIs

In most cases, NavigationPropertiesAsViews can be left on and the resulting views can be accessed with any SELECT query. However, some OData APIs have limitations that require you to specify the primary key of the parent record when querying a navigation property.

For example:

SELECT * FROM Categories_Products WHERE Categories_CategoryId='1'

You will also need to set SupportsExpand to false. You can find more information on this API limitation in the documentation for the property.

使用するODataのバージョン。デフォルトでは、providerはバージョンを自動検出しようとします。

解説

使用するODataのバージョン。デフォルトでは、Sync Appは、サービスが使用しているバージョンを自動的に特定しようとします。バージョンを解決できない場合は、3.0が使用されます。オプションで、これを手動で設定できます。

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

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

統合およびフォーマット

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

OData から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine.

解説

By default, Edm.DateTime values in the server will be assumed to be GMT. If the server is known to represent such values in a specific timezone, then the abbreviation of that timezone can be provided here (i.e. EST). From there, the driver will convert any Edm.DateTime derived filters from the installed machine's local timezone to the one specified for the server. Conversely, similar values returned by the OData server will be converted from the specified timezone to the installed machine's local timezone before being exposed in the result set.

A boolean indicating if we should list stored procedures which return a collection of entities as views.

解説

A boolean indicating if we should list stored procedures which return a collection of entities as views.

Whether you need to specify the base entity's key to query navigation property views.

解説

This connection property is primarily used with limited OData APIs; it determines whether navigation properties can be retrieved from the base entity set. In OData, navigation properties link a base entity to a related entity or a collection of related entitites.

For more on navigation properties, see データモデル.

Working with Limited APIs

In OData, the $expand parameter is used to expand specified navigation properties when requesting data from a given entity set. In SQL, this makes it possible to execute a SELECT * to a navigation property view.

If $expand is not supported, a different request must be made to retrieve a navigation property, one that specifies the primary key of the base entity set. This API restriction is reflected in SQL: You will need to specify the base entity's primary key in the WHERE clause.

For example, consider two entities with a one-to-many relationship in the Northwind sample service, Categories and Products. In OData, the Products associated with a given Category could be represented as a navigation property on the base Category entity set. The Sync App models the Products navigation property as a Categories_Products view.

If $expand is not supported, use a query like the following to this view:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

Set this to true if your OData service supports filters.

解説

This connection property is primarily used with limited OData APIs.

If your OData service supports the $filter query parameter, set this to true. When set to true, the Sync App defers filter processing to the OData service, which has a performance benefit. If you set this property to true when your OData service does not support $filter, the Sync App returns "not supported" errors for queries containing filters.

If your OData service does not support the $filter query parameter, set this to false. When set to false, the Sync App retrieves all of requested data for a given query from the OData service before filtering it client-side. This is slower than deferring filters to the OData service, so only set this property to false if $filter is unsupported on your service.

For example, if $filter is not supported, the following criteria is handled by the driver:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

A boolean indicating if the odata service supports server side formulas.

解説

OData has a number of server side formulas that are built into the specifications. However, many services do not natively support them and will return errors when these formulas are appended to the $filter parameter. These formulas can be used to make some queries that use them execute much faster. If your OData service supports formulas, change this connection property to true. Otherwise, leave it as false.

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Specifies whether or not OData should return data using client-side paging, if your source supports it. If set to false, OData uses server-side paging.

解説

Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. (To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.)

In client-side paging, the client specifies how many records to return in each request, and the order of the requests. If UseClientSidePaging is set to true, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.

In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed. Server-side pagination is best for large data sets.

Note: Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.

ODataソースがEtagsを使用するかどうか。

解説

一部のODataソースはEtagsを使用しません。このような場合は、UseEtagsをFalseに設定します。

特定のエンティティへの直接URLを表すID列を表示するかどうかを決定するboolean。

解説

特定のエンティティへの直接URLを表すID列を表示するかどうかを決定するboolean。

If set to false, the entity key is returned instead. For example, the Sync App returns "1" as the primary key for the entity specified with the URL below:

http://host/service/Categories(1)

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

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

解説

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

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