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 が作成したリクエストに、クエリ文字列パラメータを追加する際に設定します。

• 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 バージョンを使用している場合に役立ちます。
• 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 設定のカスタマイズ

TLS を有効化するには、以下を設定します。

• URL：接続文字列の前にhttps:// を付加します。

この設定により、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	OData への接続に使用される認証スキームを指定します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online.

Azure Authentication

---

プロパティ	説明
AzureADTenant	Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.
AzureTenant	データにアクセスするために使用されているOData テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。
AzureResource	認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。

SSO

---

プロパティ	説明
SharePointSSODomain	Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

OAuth

---

プロパティ	説明
InitiateOAuth	OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。
OAuthVersion	使われているOAuth のバージョンを指定します。
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
OAuthAccessToken	データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。
OAuthAccessTokenSecret	OAuth を使用して接続するためのアクセストークンのトークンシークレット。
OAuthPasswordGrantMode	OAuth Client ID およびClient Secret を認可サーバーに送信する方法を指定します。
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）サービスを識別します。（SPNEGO またはWindows 認証のみ）
KerberosRealm	ユーザーの認証に使用される Kerberos レルムを識別します。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）を指定します。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。
KerberosKeytabFile	Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイルを指定します。
KerberosServiceRealm	サービスのKerberos レルムをを指定します。（クロスレルム認証のみ）
KerberosServiceKDC	サービスのKerberos Key Distribution Center（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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーの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

---

プロパティ	説明
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します（OData 4.0 以降のみ）。
Cookies	This property can be manually specified in the format of name=value pairs, which are separated by semicolons.
CustomHeaders	他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
CustomURLParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
DataFormat	Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.
DecodeXMLNames	Unicode 文字を含むカラム名をデコードするかどうかを指定します。
EnableAtomicBatchOperations	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
ExcludeControlInformationRootType	Indicates whether OData should use the odata.type control information for the root element.
ExpandAsterisk	The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.
IncludeNavigationParentColumns	Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.
IncludeReferenceColumn	バルクINSERT 操作用に設計された入力専用のParentReference カラムを追加し、Deep INSERT プロセス中に子レコードがそれぞれの親レコードに正しくリンクされるようにします。
MaxFilterLength	Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxSelectLength	このプロパティは、$select クエリオプションで許可される文字数を制限します。生成された$select パラメータの長さが指定した値を超える場合、カラムの選択は代わりにクライアントサイドで処理されます。このプロパティを0 に設定すると、provider が$select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに役立ちます。
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	使用するOData のバージョン。デフォルトでは、プロバイダーは自動的に適切なバージョンを検出して適応するように設計されており、シームレスな統合と機能性を実現します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がOData にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ServerTimeZone	The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.
StoredProceduresAsViews	A boolean value indicating whether stored procedures returning collections of entities should be treated as views.
SupportsExpand	Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.
SupportsFilter	Specifies whether the OData service supports the $filter query parameter.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseEtags	このプロパティの目的は、サービスがEtag カラムの値を返さない場合に、オプションでEtag カラムを非表示にすることです。そうしない場合、その項目は含まれますが空白のままになります。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。

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

---

プロパティ	説明
URL	OData サービスのルートURL（サービスルートURL とも呼ばれます）を指定します。例：http://services.odata.org/V4/Northwind/Northwind.svc
AuthScheme	OData への接続に使用される認証スキームを指定します。
User	認証するユーザーのユーザーID を指定します。
Password	認証するユーザーのパスワードを指定します。
FeedURL	URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSO	Specifies whether 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 です。

OData への接続に使用される認証スキームを指定します。

解説

• 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 認証を使う場合に設定。

認証するユーザーのユーザー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.

Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online.

解説

When set to true, the Sync App uses single sign-on (SSO) to authenticate to SharePoint Online with the account specified by User and Password. AD FS, OneLogin, and OKTA identity providers are supported.

When set to false, SSO is not used, and authentication relies on the method configured for the connection.

SharePointSSODomain may be required if the SSO domain differs from the User domain.

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

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

---

プロパティ	説明
AzureADTenant	Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.
AzureTenant	データにアクセスするために使用されているOData テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。
AzureResource	認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。

Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication.

解説

This property is required when using Azure Active Directory OAuth authentication.

The tenant determines who can sign in to the application. Set this property to one of the following:

• The tenant name, such as contoso.onmicrosoft.com
• The tenant ID, such as 8eaef023-2b34-4da1-9baa-8bc8c9d6a490
• The word common to allow users from any Azure AD tenant

You can find your tenant name and ID in the Azure portal under Entra ID > Overview.

Use this property to ensure the OAuth token is issued for the intended tenant when authenticating to the OData.

データにアクセスするために使用されているOData テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。

解説

テナントとは、Microsoft Entra ID（旧称：Azure AD）を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン（例：microsoft.com やcontoso.onmicrosoft.com）も関連付けられています。

Microsoft Entra 管理センターでディレクトリ（テナント）ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ（テナント）ID」と表示されている値をコピーします。

このプロパティは以下の場合に必要です。

• AuthScheme がAzureServicePrincipal またはAzureServicePrincipalCert に設定されている場合
• AuthScheme がAzureAD で、ユーザーアカウントが複数のテナントに属している場合

テナントの値は、2つの形式のいずれかで指定できます。

• ドメイン名（例：contoso.onmicrosoft.com）
• GUID 形式のディレクトリ（テナント）ID（例：c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0）

テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。

この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。

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

解説

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

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

---

プロパティ	説明
SharePointSSODomain	Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service.

解説

When SharePointUseSSO is set to true, set this property if the domain of the User (for example, [email protected]) is different from the domain configured within the SSO service (for example, [email protected]).

When set, the Sync App uses this domain for authentication instead of the User domain. When not set, the Sync App uses the User domain by default.

This property may be required for AD FS, OneLogin, or OKTA SSO services.

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

---

プロパティ	説明
InitiateOAuth	OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。
OAuthVersion	使われているOAuth のバージョンを指定します。
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
OAuthAccessToken	データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。
OAuthAccessTokenSecret	OAuth を使用して接続するためのアクセストークンのトークンシークレット。
OAuthPasswordGrantMode	OAuth Client ID およびClient Secret を認可サーバーに送信する方法を指定します。
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 アクセストークンとユーザー認証情報の交換。
• アプリケーションへの限定的なアクセスの提供。

OAuth アクセスの開始と維持のオプションは、Sync App が処理するフローの部分に基づいて命名されています。

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

OAuth の設定方法や、接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

使われているOAuth のバージョンを指定します。

解説

有効な入力値は次のとおりです：1.0,2.0

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。

解説

OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。 これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。 このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。

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

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

Note：アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

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

解説

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

OAuth Client ID およびClient Secret を認可サーバーに送信する方法を指定します。

解説

OAuth RFC では、OAuthClientId とOAuthClientSecret を渡す2つの方法を提供します。

• POST：トークンリクエストのPOST ボディにOAuthClientId とOAuthClientSecret を含めて送信します。これは最も一般的にサポートされている方法で、ほとんどのOAuth フローで機能します。
• BASIC：Basic 認証を使用してHTTP Authorization ヘッダーにOAuthClientId とOAuthClientSecret を送信します。一部のOAuth サーバーでは、コンプライアンスやセキュリティのためにこの方法が必要とされます。

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

解説

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

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

OAuth サービスの認可URL。

解説

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

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）サービスを識別します。（SPNEGO またはWindows 認証のみ）
KerberosRealm	ユーザーの認証に使用される Kerberos レルムを識別します。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）を指定します。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。
KerberosKeytabFile	Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイルを指定します。
KerberosServiceRealm	サービスのKerberos レルムをを指定します。（クロスレルム認証のみ）
KerberosServiceKDC	サービスのKerberos Key Distribution Center（KDC）を指定します。
KerberosTicketCache	MIT Kerberos 認証情報キャッシュファイルの完全ファイルパスを指定します。

ユーザーの認証に使用されるKerberos キー配布センター（KDC）サービスを識別します。（SPNEGO またはWindows 認証のみ）

解説

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

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

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

ユーザーの認証に使用される Kerberos レルムを識別します。

解説

レルムとは、ドメインに似た論理的なネットワークで、同じマスターKDC の下にあるシステムのグループを定義します。一部のレルムは階層構造を持ち、一方のレルムが他方の上位集合となることもありますが、通常は非階層型（「直接型」）であり、2つのレルム間のマッピングを定義する必要があります。 Kerberos のクロスレルム認証により、異なるレルム間での認証が可能になります。各レルムは、相手レルムのプリンシパル情報を自レルムのKDC に登録しておく必要があります。

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。 Sync App は、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 をKDC のURL に設定します。

Kerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。

解説

Kerberos プリンシパルが存在する場合、データベースへの認証には常にそのKerberos プリンシパル名を使用する必要があります。

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

解説

keytab（“key table” の略）は、1つ以上のプリンシパルの長期キーを格納します。 ほとんどの場合、エンドユーザーはクライアントシークレット（パスワード）を使用してKDCに 認証します。 ただし、自動化されたスクリプトやアプリケーションで認証や再認証が行われる場合、keytab を使用する方が効率的です。keytab はパスワードを暗号化された形式で自動的にKDC に送信します。

Keytab は通常、標準形式のファイルで表現され、type:value の形式で命名されます。 通常、type はFILE で、value はファイルの絶対パス名です。 type のもう一つの可能な値はMEMORY で、これは現在のプロセスのメモリに格納された一時的なkeytab を示します。

keytab には1つ以上のエントリが含まれ、各エントリはタイムスタンプ（エントリがkeytab に書き込まれた時刻を示す）、プリンシパル名、キーバージョン番号、暗号化タイプ、および暗号化キー自体で構成されます。 これらはkutil を使用して生成できます。

例：

[admin@myhost]# ktutil

ktutil: addent -password -p starlord/[email protected] -k 1 -e aes256-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/[email protected] -k 1 -e aes128-cts-hmac-sha1-96
Password for starlord/myhost.galaxy.com:

ktutil: addent -password -p starlord/[email protected] -k 1 -e des3-cbc-sha1
Password for starlord/myhost.galaxy.com:

ktutil: wkt /path/to/starlord.keytab

Note： サポートしたいすべての認証方法（暗号化タイプ）に対してプリンシパルを作成する必要があります。

keytab を表示するには、klist -k を使用します。

サービスのKerberos レルムをを指定します。（クロスレルム認証のみ）

解説

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

ほとんどの場合、Kerberos 認証の実行には単一のレルムとKDC マシンが使用されるため、このプロパティは必要ありません。ただし、認証チケット（AS リクエスト）とサービスチケット（TGS リクエスト）の取得に異なるレルムとKDC マシンが使用される複雑なセットアップではこのプロパティを使用できます。

サービスのKerberos Key Distribution Center（KDC）を指定します。

解説

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

ほとんどの場合、Kerberos 認証の実行には単一のレルムとKDC マシンが使用されるため、このプロパティは必要ありません。ただし、認証チケット（AS リクエスト）とサービスチケット（TGS リクエスト）の取得に異なるレルムとKDC マシンが使用される複雑なセットアップではこのプロパティを使用できます。

MIT Kerberos 認証情報キャッシュファイルの完全ファイルパスを指定します。

解説

MIT Kerberos Ticket Manager または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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

このセクションでは、本プロバイダーの接続文字列で設定可能な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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

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

解説

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

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

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

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

解説

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

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

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

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

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

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

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• 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 接続プロパティは設定しないでください。

Note：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 を参照してください。

Note：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 は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

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

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

---

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

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

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

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

---

プロパティ	説明
AllowNavigationDisassociation	Specifies whether the provider binds navigation properties to null values.
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します（OData 4.0 以降のみ）。
Cookies	This property can be manually specified in the format of name=value pairs, which are separated by semicolons.
CustomHeaders	他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
CustomURLParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
DataFormat	Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.
DecodeXMLNames	Unicode 文字を含むカラム名をデコードするかどうかを指定します。
EnableAtomicBatchOperations	This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
ExcludeControlInformationRootType	Indicates whether OData should use the odata.type control information for the root element.
ExpandAsterisk	The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.
IncludeNavigationParentColumns	Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.
IncludeReferenceColumn	バルクINSERT 操作用に設計された入力専用のParentReference カラムを追加し、Deep INSERT プロセス中に子レコードがそれぞれの親レコードに正しくリンクされるようにします。
MaxFilterLength	Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxSelectLength	このプロパティは、$select クエリオプションで許可される文字数を制限します。生成された$select パラメータの長さが指定した値を超える場合、カラムの選択は代わりにクライアントサイドで処理されます。このプロパティを0 に設定すると、provider が$select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに役立ちます。
NavigationPropertiesAsViews	A boolean indicating navigation properties should be promoted to full views.
ODataVersion	使用するOData のバージョン。デフォルトでは、プロバイダーは自動的に適切なバージョンを検出して適応するように設計されており、シームレスな統合と機能性を実現します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
Pagesize	provider がOData にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ServerTimeZone	The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.
StoredProceduresAsViews	A boolean value indicating whether stored procedures returning collections of entities should be treated as views.
SupportsExpand	Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.
SupportsFilter	Specifies whether the OData service supports the $filter query parameter.
SupportsFormulas	A boolean indicating if the odata service supports server side formulas.
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseClientSidePaging	Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseEtags	このプロパティの目的は、サービスがEtag カラムの値を返さない場合に、オプションでEtag カラムを非表示にすることです。そうしない場合、その項目は含まれますが空白のままになります。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。

Specifies whether the provider binds navigation properties to null values.

解説

In OData, navigation properties represent relationships between entities. Disassociating a navigation property removes the relationship, and some services support doing this by binding the property to a null value.

When set to true, the Sync App binds navigation properties to null in INSERT or UPDATE requests when those properties are set to null and the OData supports null binding. This can be used to disassociate navigation properties.

When set to false, navigation properties set to null or an empty string are omitted from the request body.

This property is useful when you need to explicitly remove or disassociate related entities through null binding.

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

解説

ContinueOnError がtrue に設定されていてバッチでエラーが発生した場合、次のバッチに進み、失敗したバッチのステータス情報を提供します。

ContinueOnError がfalse の場合、エラーが発生するとそれ以降のバッチ処理を停止します。エラーが発生する前に行われたすべての変更はそのまま保持されます。

This property can be manually specified in the format of name=value pairs, which are separated by semicolons.

解説

Typically, the Cookies property does not need to be configured. However, since there are various types of OData services, manual specification of cookies may be required if the solution relies on cookies not obtained through the CData JDBC Sync App for OData. Cookies can be entered in the format of name=value pairs, separated by semicolons. For example: Cookie1=value; Cookie2=value2.

This property is useful for authentication, session tracking, and personalization purposes.

他のプロパティ（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 で置き換えられます。

Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.

解説

The DataFormat defines the data format (either JSON or XML) for the request body in INSERT, UPDATE, or DELETE (if any) operations and the accepted response format for SELECT operations via the Accept header. It ensures that the driver correctly handles both request and response formats.

This property helps ensure compatibility with the client's preferred format.

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

解説

true に設定されている場合、Sync App はカラム名のUnicode 文字をすべて人間が読める文字として表示します。

false に設定されている場合、Sync App はカラム名のUnicode 文字をすべて16進数エンコード形式で表示します。

このプロパティは、特に非ASCII 文字を含むメタデータを扱うときに、エンコードされた名前よりも読みやすいカラム名を好む場合に便利です。

This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.

解説

The behavior of the Sync App is dependent on both EnableAtomicBatchOperation and ContinueOnError. The ContinueOnError option is effective only when EnableAtomicBatchOperation is set to false.

When the EnableAtomicBatchOperations property is set to true, the Create, Update, and Delete (CUD) operations within a transaction are completed successfully as a single unit. If any part of the transaction fails, the entire transaction is aborted, and the database is left unchanged. Therefore, when atomic batch operations are enabled, ContinueOnError will be ignored.

ContinueOnError can be used in conjunction with EnableAtomicBatchOperations set to true. When EnableAtomicBatchOperations is set to true, the API will ensure that if any request in the batch fails, the entire batch will be rolled back.

Indicates whether OData should use the odata.type control information for the root element.

解説

The OData specification requires that the root element in a POST or PATCH request include the control information annotation odata.type. However, some services do not accept this annotation. In these cases, you can set this property to true, which will omit the annotation from the request.

The ExcludeControlInformationRootType property is only applicable when the DataFormat property is set to JSON or when it is set to AUTO and a JSON format is detected.

This is an example of how this annotation appears on request post data:

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

The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.

解説

When ExpandAsterisk is true, all columns reported as queryable from the service will be included in the $select query parameter.

For example:

SELECT * FROM Items

All columns will be listed in projection.

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

This property helps you quickly retrieve object graphs and makes debugging easier. However, it can create large data loads and costly queries when there is a lot of deep nesting. For OData entities labeled as OpenType, the Returns columns are not defined in the metadata document and do not appear in the table definition.
Therefore, when the ExpandAsterisk property is set to true, these columns will not be automatically appended to the $Select query parameter unless they are explicitly requested.

Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.

解説

When the IncludeNavigationParentColumns is set to true, the view's parent columns from the navigation property are displayed. Displaying these columns may be beneficial as it allows for filtering based on information from the parent.

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

バルクINSERT 操作用に設計された入力専用のParentReference カラムを追加し、Deep INSERT プロセス中に子レコードがそれぞれの親レコードに正しくリンクされるようにします。

解説

IncludeReferenceColumn は、バルクINSERT 用に入力専用のParentReference カラムを作成し、同じ親を持つ子レコードがDeep INSERT 中に正しく関連付けられるようにします。

このプロパティは、バルクINSERT 操作中にリレーションを確立するのに役立ちます。

Specifies the maximum number of characters permitted in the $filter query parameter of a OData request.

解説

Certain APIs impose restrictions on the number of characters that can be included in a URL. When the filter becomes too long, some services can return an error or become unresponsive. The purpose of this property is to process filters client-side if the filter parameter exceeds this value, thus avoiding errors or hangs.

If MaxFilterLength is set to a positive number, the driver will ensure we do not send a filter to the service that exceeds the character length set in MaxFilterLength. If exceeded, the filter will be processed entirely on the client side. This should only be changed if the services limit the character length; otherwise, it should remain unlimited by default.

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

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

このプロパティは、$select クエリオプションで許可される文字数を制限します。生成された$select パラメータの長さが指定した値を超える場合、カラムの選択は代わりにクライアントサイドで処理されます。このプロパティを0 に設定すると、provider が$select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに役立ちます。

解説

API によっては、$select クエリパラメータでカラムのリストを指定する必要があります。このような場合は、ExpandAsterisk 接続プロパティの使用をお勧めします。

MaxSelectLength が超過した場合、$select=* をデフォルトにしようとします。しかし、これをサポートしていないAPI では検証エラーが発生するため、ユーザーは手動で選択リストを制限する必要があります。OData のバージョンによっては、$select=* を使用することと、$select パラメータを完全に省略することは同じと見なされます。

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 のバージョン。デフォルトでは、プロバイダーは自動的に適切なバージョンを検出して適応するように設計されており、シームレスな統合と機能性を実現します。

解説

ODataVersion が Auto に設定されている場合、バージョンは自動的に検出されます。バージョンが判定できない場合、Sync App は安全なフォールバックとしてバージョン3.0を使用します。 さらに、必要に応じて希望するバージョンを手動で指定するオプションもあります。

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

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

統合およびフォーマット

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

provider がOData にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

解説

クエリを処理する際、OData でクエリされたデータすべてを一度にリクエストする代わりに、Sync App はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Sync App がページごとにリクエストする結果の最大数を決定します。

Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にSync App がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.

解説

By default, Edm.DateTime values on the server are assumed to be in GMT. However, both time zone abbreviations and names are supported, with a recommendation to use the time zone name, such as America/New_York. The Sync App will convert any filters derived from Edm.DateTime values from the machine's local time zone to the specified server time zone. Conversely, values returned by the OData server will be converted from the specified time zone to the local time zone of the machine before being presented in the result set.

When Edm.DateTime values are sent to the server, they are treated according to the time zone established by the ServerTimeZone. When the server returns Edm.DateTime values, it formats them based on the ServerTimeZone. This method ensures that Edm.DateTime values are consistently interpreted by both the client and the server.

A boolean value indicating whether stored procedures returning collections of entities should be treated as views.

解説

When this property is set to true, stored procedures that return result sets can be exposed as entity sets in the service model. These entity sets will function as read-only views. Thus, operations such as INSERT, UPDATE, and DELETE are not supported because these are user-facing operations.

Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.

解説

This property determines whether navigation properties can be retrieved from the base entity set.

If you use the connection property NavigationPropertiesAsViews, you will create a new view for each relationship. If SupportsExpand is set to false, querying these relationships will not work. In this case, you will see an exception message.

For example, the following query does not work when SupportsExpand is false:

SELECT * FROM navigationView

However, the following query will work:

SELECT * FROM navigationView WHERE parentKey = 'some value'

When the connection property IncludeNavigationProperties is set to true and this property is enabled, foreign keys for each relationship in every table will be included. However, if SupportsExpand is false, this information will not be available, as expansion is necessary to retrieve the actual key values.

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 for this view:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

Specifies whether the OData service supports the $filter query parameter.

解説

Set this property to true if your OData service supports filtering using the $filter query parameter.

When this property is set to true, the Sync App attempts to push filter logic to the OData service, reducing the volume of data retrieved and improving performance. However, the actual behavior depends on the capabilities of the OData service as some filter expressions may still be handled client-side if the service does not support them.

If your OData service does not support the $filter parameter, set this property to false. When this property is set to false, all requested data is retrieved from the service and filtered locally. This can significantly impact performance, so use this setting only when necessary.

For example, if $filter is not supported, the following query is processed client-side:

SELECT       * 
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

This property is typically used with OData services that have partial or no support for filtering operations.

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秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.

解説

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.

Client-Side Paging

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.

If you set UseClientSidePaging to True, ensure that the value of PageSize is not set higher than the maximum value supported by the service. Setting PageSize to a higher value than supported may result in missing information.

Server-Side Paging

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.

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.

このプロパティの目的は、サービスがEtag カラムの値を返さない場合に、オプションでEtag カラムを非表示にすることです。そうしない場合、その項目は含まれますが空白のままになります。

解説

UseEtags プロパティがtrue に設定されると、Etag という新しいカラムが各テーブルに公開されます。このカラムは指定された行のEtag 値を表示します。サービスがETags をサポートしていない場合、このカラムの値はNULL になります。このような場合は、このプロパティをfalse に設定してカラムを完全に削除することをお勧めします。

このプロパティはレコードの更新を追跡するのに便利です。

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

解説

UserDefinedViews を使用すると、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

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

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

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

解説

OData テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

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

Notes：

• 英数字以外の文字はアンダースコアに置き換えられます。
• カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.