Microsoft SharePoint Connector for CData Sync

Build 23.0.8839
  • Microsoft SharePoint
    • 接続の確立
      • REST API への接続
      • Kerberos の使用
      • データアクセスのファインチューニング
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • SOAP データモデル
      • テーブル
        • Attachments
        • Groups
        • Roles
        • Users
        • Views
      • ビュー
        • FileVersions
        • GetValidTerms
        • Lists
        • Permissions
        • Subsites
    • REST データモデル
      • ビュー
        • Attachments
        • Files
        • Groups
        • Lists
        • RoleAssignmentMember
        • RoleAssignments
        • RoleDefinitionBindings
        • Roles
        • Subsites
        • Users
      • データ型マッピング
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • URL
        • SharePointEdition
        • User
        • Password
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • SSO
        • SSOLoginURL
        • SSODomain
        • SSOProperties
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
        • State
        • OAuthGrantType
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTIssuer
      • Kerberos
        • KerberosKDC
        • KerberosRealm
        • KerberosSPN
        • KerberosKeytabFile
        • KerberosServiceRealm
        • KerberosServiceKDC
        • KerberosTicketCache
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • Schema
      • Miscellaneous
        • CalculatedDataType
        • ContinueOnError
        • CreateIDColumns
        • DisableFilterLimit
        • FolderOption
        • IncludeLookupColumns
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • ShowHiddenColumns
        • ShowPredefinedColumns
        • ShowVersionViews
        • STSURL
        • Timeout
        • UseDisplayNames
        • UseEntityTypeName
        • UseNTLMV1
        • UserDefinedViews
        • UseSimpleNames

Microsoft SharePoint Connector for CData Sync

概要

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

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

Microsoft SharePoint バージョンサポート

Sync App は、SOAP API をサポートするMicrosoft SharePoint のすべてのバージョンをサポートします。これには、Windows SharePoint Services 3.0、SharePoint Server 2007+ (2010, 2013, etc.)、およびSharePoint Online が含まれます。Sync App は、SharePoint のカスタムリストを双方向アクセス可能なテーブルとしてモデル化します。接続時に、Sync App はSharePoint Web サービスを呼び出してこれらのテーブルのメタデータを取得します。サポートされる認証スキーマはNTLM、Basic、Digest、Forms、Kerberos、SSO、STS (security token services)、およびSharePoint 認証クッキーです。

Microsoft SharePoint Connector for CData Sync

接続の確立

Microsoft SharePoint への接続を追加

Microsoft SharePoint への接続を追加するには:

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

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

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

Microsoft SharePoint への接続

オンラインまたはオンプレミスのどちらで接続するか、どのようなアーキテクチャを使用するか、どのリストやドキュメントにアクセスするかに関わらず、Microsoft SharePoint への接続には次の2つの設定が必要です。
  • URL 接続プロパティを設定します。
  • 使用環境に適した認証プロパティを設定します。

URL の設定:

Microsoft SharePoint は、グローバルなMicrosoft SharePoint サイト内のすべてのリストとドキュメント、または個々のサイトのすべてのリストとドキュメントで機能します。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティをサイトコレクションURL に設定します。次に例を示します。

https://teams.contoso.com

個々のサイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティを個々のサイトURL に設定します。次に例を示します。

 https://teams.contoso.com/TeamA

以下のセクションでは、使用環境に適した認証プロパティの設定方法について説明します。カスタムOAuth アプリケーション(Web アプリケーションでAzureAD を使用する場合は必須、デスクトップアプリケーションまたはヘッドレスサーバー経由でAzureAD にアクセスする場合はオプション)の作成については、カスタムOAuth アプリケーションの作成 を参照してください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。

Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。

  • AzureAD
  • ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
  • Azure MSI
  • Azure パスワード
  • OAuthJWT
  • SharePointOAuth

もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。

AzureAD

Azure Active Directory(AzureAD)は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft SharePoint との通信を要求します。下記で説明するとおり、本ドライバーはさまざまな方法でこれをサポートします。AuthScheme をAzureAD に設定します。以下で説明するAzure AD フローは、すでに設定済みであることを前提として書かれています。

Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。

シングルサインオンID プロバイダー

ADFS

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

  • User:ADFS ユーザー。
  • Password:ユーザーのADFS パスワード。
  • SSODomain(オプション):ADFS のID プロバイダーで設定されたドメイン。
接続文字列の例:
AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
Okta

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

  • User:Okta ユーザー。
  • Password:ユーザーのOkta パスワード。
  • SSODomain(オプション):Okta のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
OneLogin

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

  • User:OneLogin ユーザー。
  • Password:ユーザーのOneLogin パスワード。
  • SSODomain(オプション):OneLogin のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
PingFederate

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

  • User:PingFederate ユーザー。
  • Password:ユーザーのPingFederate パスワード。
  • SSODomain(オプション):PingFederate のID プロバイダーで設定されたドメイン。

接続文字列の例:

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';

Azure MSI

Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity(MSI)の資格情報を利用して接続が可能です。

  • AuthScheme:AzureMSI。

MSI 資格情報が認証用に自動的に取得されます。

Azure パスワード

Azure 資格情報を使用して直接接続するには、次の接続プロパティを指定します。
  • AuthScheme: AzurePassword
  • User:Azure への接続に使用するユーザーアカウント
  • Password:Azure への接続に使用するパスワード
  • AzureTenant:Azure 上のMicrosoft SharePoint への認証に使用するOAuth アプリケーションの概要ページにある、Directory (tenant) ID。

OAuthJWT 証明書

AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。

  • AzureTenant:接続するテナント。
  • OAuthJWTCert:JWT 証明書のストア。
  • OAuthJWTCertType:JWT 証明書を格納するキーストアの種類。
  • OAuthJWTIssuer:OAuth クライアントId。
  • OAuthJWTCertPassword:JWT 証明書に関連付けられたパスワード。証明書タイプにパスワードが必要な場合は、これを設定します。

SharePointOAuth

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

  • Schema:REST。
  • InitiateOAuth:GETANDREFRESH。
  • OAuthClientId:アプリケーションのId / クライアントId。
  • OAuthClientSecret:アプリケーションのクライアントシークレット。

接続文字列の例:

SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;
このAuthScheme はカスタムOAuth アプリケーションで動作します。カスタムOAuth アプリケーションから認証情報を生成するには、カスタムOAuth アプリケーションの作成 を参照してください。

Microsoft SharePoint Connector for CData Sync

REST API への接続

Microsoft SharePoint REST API はSharePoint OnPremise とSharePoint Online の両方でサポートされています。REST API を使用して接続するには、Schema をREST に設定してください。

SharePointEdition プロパティは、SharePoint のエディションの定義に使用できます。

SharePoint Online

SharePoint Online はOAuth 標準を使用して認証します。詳しくは、接続の確立 の「SharePoint Online への認証」の手順でご確認ください。

SharePoint OnPremise

詳しくは、接続の確立 の「SharePoint On Premises への認証」の手順でご確認ください。

Microsoft SharePoint Connector for CData Sync

Kerberos の使用

Kerberos

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

Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、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 はキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。

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

Keytab ファイル

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

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

User およびPassword

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

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

Microsoft SharePoint 接続の調整

高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。

  • UseDisplayNames:これをtrue に設定すると、基底のAPI のフィールド名と合致する列名を返します。デフォルトでは、Sync App はSharePoint で定義されたフィールド名と合致する列名を使います。
  • UseSimpleNames:これをtrue に設定すると、SharePoint が許容するが他のデータベースでは通常許容されない特殊文字を含む列名の代替を行います。
  • ShowPredefinedColumns:これをfalse に設定するとリスト内のフィールドから派生しているフィールドを除外します。例えば、Author とCreatedAt です。この設定は、SELECT * 構文およびスキーマ検出で、事前に定義されたフィールドが返されないようにします。
  • ShowHiddenColumns:これをtrue に設定すると、SharePoint で非表示に設定されている列がSync App で表示されます。

Microsoft SharePoint Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Microsoft SharePoint Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

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

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

クライアントSSL 証明書

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

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

Microsoft SharePoint Connector for CData Sync

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

Microsoft SharePoint Connector for CData Sync

SOAP データモデル

CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

データモデルのカスタマイズ

Sync App は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。

  • CalculatedDataType:計算フィールドで使用されるデータ型。
  • CreateIDColumns:他のリストに格納されている情報からの値を使っているSharePoint 列に補助的Id 列を作成するかしないかを示します。
  • FolderOption:結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
  • PseudoColumns:疑似列をテーブルメタデータの列としてレポートするかどうかを示します。

テーブル

テーブル では、利用可能なテーブルを説明します。

Sync App は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。

ビュー

一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。

リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。

SELECT * FROM ListName WHERE ViewID='ID of the view'
Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。
SELECT * FROM Views WHERE List ='ListName'

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

Microsoft SharePoint Connector for CData Sync

テーブル

Sync App はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Microsoft SharePoint Connector for CData Sync テーブル

Name Description
Attachments Reads or deletes attachments to the specified item on the specified list.
Groups Creates, updates, deletes, and queries Groups from SharePoint.
Roles Creates, updates, deletes, and queries Roles from SharePoint.
Users Updates, deletes, and queries Users from SharePoint.
Views Creates, updates, deletes, and queries the available lists in SharePoint.

Microsoft SharePoint Connector for CData Sync

Attachments

Reads or deletes attachments to the specified item on the specified list.

テーブル固有の情報

Select

Attachment を戻すにはリストとリストID が必要です。

Insert

リスト項目に新しい添付ファイルを追加するには、AddAttachments ストアドプロシージャを呼び出します。

Columns

Name Type ReadOnly Description
Url [KEY] String True

Description of the term set.

List String True

The internal name of the list to retrieve attachments from.

ListDisplayName String True

The display name of the list to retrieve attachments from.

ItemID String True

The Id of the item on the list to retrieve attachments from.

Name String True

The name of the attachment on the item.

Microsoft SharePoint Connector for CData Sync

Groups

Creates, updates, deletes, and queries Groups from SharePoint.

テーブル固有の情報

Insert

このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。

UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。

Columns

Name Type ReadOnly Description
Name# [KEY] String False

The name of the group.

Description# String False

A description of the group.

OwnerLogin# String False

The user name of the owner of the group. This value should be in the format DOMAIN\\username.

OwnerType# String False

The type of owner. User or group.

DefaultLogin# String False

The user name of the default user for the group. This value should be in the format DOMAIN\\username.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UserName String

The logical name of the user to return groups for. Specify this value on the SELECT statement to return only groups the specified User is in.

Microsoft SharePoint Connector for CData Sync

Roles

Creates, updates, deletes, and queries Roles from SharePoint.

テーブル固有の情報

Select

UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。

Insert

Role を挿入するには、最低でもName が必要です。

INSERT INTO Roles (Name) VALUES ('My Role')

Columns

Name Type ReadOnly Description
Name# [KEY] String False

The name of the role.

Description# String False

A description of the role.

Permissions# Long False

A long representing the permissions for the role.

RoleType String True

The type of role.

IsHidden Boolean True

A boolean indicating if the role is hidden.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UserName String

The login name of the user to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified user.

GroupName String

The name of the group to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified group.

Microsoft SharePoint Connector for CData Sync

Users

Updates, deletes, and queries Users from SharePoint.

テーブル固有の情報

Select

SharePoint Account のために作成されたすべてのユーザーを取得する:

SELECT * FROM Users

1つのグループに所属するすべてのユーザーを取得することも可能です。その場合には、Group Name を指定します。

SELECT * FROM Users WHERE [Group] = "GroupName"

指定されたロールを持つユーザーを取得することも可能です。その場合には、Role Name を指定します。

SELECT * FROM Users WHERE [Role] = "RoleName"

Columns

Name Type ReadOnly Description
ID String True

The Id of the user.

LoginName# [KEY] String False

The login name of the user.

Name# String False

The name of the user.

Email# String False

The email address of the user.

IsInDomainGroup Boolean True

A boolean indicating if the user is in the domain group.

IsSiteAdmin Boolean True

A boolean indicating if the user is a site admin.

Notes# String False

Optional notes concerning the user.

SecurityId String True

The security Id (SID) for the user.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Group String

The group you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but you can optionally specify deletions.

Role String

The role you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but but you can optionally specify deletions.

Microsoft SharePoint Connector for CData Sync

Views

Creates, updates, deletes, and queries the available lists in SharePoint.

テーブル固有の情報

Views は特別なテーブルです。これを使用して、指定されたリストのビューを取得、更新、挿入、および削除できます。

Select

Views から結果を返すには、SELECT ステートメントでID またはList のいずれかを指定する必要があります。次に例を示します。


SELECT * FROM Views WHERE List = 'MyListName'

Insert

このテーブルに挿入するにはList、Name、Type、およびFields カラムが必要です。

Columns

Name Type ReadOnly Description
ID [KEY] String True

The Id of the view.

List String True

The list the view is associated with. A list must be specified when performing SELECT statements if the Id is not specified.

ViewID String True

The Id of the view. May only be unique for the specific list.

Name String False

The name of the view.

Type String False

The type of view. This must have a value on inserts and updates.

使用できる値は次のとおりです。CALENDAR, GRID, HTML

デフォルト値はHTMLです。

Fields String False

A comma-separated list of the fields associated with the view. This is space-sensitive.

IsDefault Boolean False

A boolean indicating if the view is the default view for the list.

Query String False

A query for the view.

Microsoft SharePoint Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Microsoft SharePoint Connector for CData Sync ビュー

Name Description
FileVersions Lists the versions of files available on SharePoint.
GetValidTerms Gets a list of valid terms for the specified column on the specified table.
Lists Lists the available lists in SharePoint.
Permissions The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID.
Subsites Lists the available subsites.

Microsoft SharePoint Connector for CData Sync

FileVersions

Lists the versions of files available on SharePoint.

ビュー固有の情報

このビューから結果を返すには、Library およびFile を指定する必要があります。

Columns

Name Type Description
ID [KEY] String The Id of the version.
Comments String Comments about the particular version.
CreateBy String The username of the SharePoint user who modified this version of the file.
Date Datetime When the file was modified.
Size String The size of this version of the file.
Url String The URL to this version of the file.
Library String The library name on SharePoint you are listing versions from. A library must be specified to retrieve the versions for a file.

デフォルト値はShared Documentsです。

File String The name of the file on SharePoint to list versions for. You must specify a file to retrieve the versions for a file.

Microsoft SharePoint Connector for CData Sync

GetValidTerms

Gets a list of valid terms for the specified column on the specified table.

テーブル固有の情報

GetValidTerms は特別なビューです。これを使用して、特定のリストの分類列または管理されたメタデータ列に対して有効な用語を取得できます。このビューを使用するには、テーブルの名前と、有効な用語の取得元になる列を指定します。次に例を示します。


SELECT * FROM GetValidTerms WHERE List = 'MyListName' AND ColumnName = 'MyManagedMetadataColumn'

Columns

Name Type Description
ID [KEY] String The identifier of the term.
TermLabelValue String The label of the term.
Description String Description of the term set.
NameInRequestedLang String The name of the term set in the language requested by the client.
IsOpen Boolean A Boolean indicating if the term set is open.
Deprecated Boolean A Boolean indicating if the term is deprecated.
InternalId String An internal identifier for the term.
TermSetContact String The term set contact.
ContainerDesc String The container node for the description.
SingleTermLabelDesc String This fully describes a single term label.
IsDefaultLabel Boolean True if the term label is the default term label.
BelongsTo String This item describes a term set to which a term belongs.
IsTaggingAvailable Boolean If the term set is available for tagging, this value is true.
TermPath String Term path of the term with term labels.
TermpathoftermwithIds String Term path of term with identifiers.
ChildTerms String A string value that indicates a custom sort order for the child terms of the term identified by PertainingToTerm.
HasChildTerms Boolean True if the term has child terms.
PertainingToTerm String An identifier of the term that this term set information is pertaining to.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
List String The name of the list to get valid terms for.
ColumnName String The name of the column to get valid terms for.
LocaleId String The locale Id for the term. Defaults to 1033.

Microsoft SharePoint Connector for CData Sync

Lists

Lists the available lists in SharePoint.

テーブル固有の情報

Lists を使用して、SharePoint のテーブルをリストできます。これは、SharePoint 内の実際のリストだけを返します。Sync App に関連付けられた特別なテーブルは返しません。

WHERE 句で次の列を使用できます:Title およびBaseTemplage。

Columns

Name Type Description
ID [KEY] String The Id of the list.
Title String The title of the list. This column may be used in the WHERE clause and may be used with a wild card (*) character.
Description String A description for the list.
BaseTemplate String Indicates the type of template used to create the list. This column may be used in the WHERE clause.
Version Double The version of the list.
Url String The default URL of the list.
EmailAlias String The email alias of the list.
ImageUrl String The image URL of the list.
ItemCount Integer The number of items in the list.
Item_Deleted Datetime The last time an item was deleted from this list.
Item_Modified Datetime The last time an item was modified from this list.
SendToUrl String The send-to URL of the list.
Created Datetime The time when the list was created.
AllowDeletion String Whether items can be deleted.
AllowMultiResponses Boolean A Boolean indicating if multiple responses are enabled for the survey.
Direction String A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left, or None.
EnableAssignedToEmail Boolean A Boolean indicating if assigned-to emails are enabled. Only applies to issues lists.
EnableAttachments Boolean A Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries.
EnableModeration Boolean A Boolean indicating if content approval is enabled for the list.
EnableVersioning Boolean A Boolean indicating if versioning is enabled for the list.
Hidden Boolean A Boolean indicating if the list is hidden so that it does not appear on the Documents and Lists page, Quick Launch bar, Modify Site Content page, or Add Column page as an option for lookup fields.
MultipleDataList Boolean A Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site.
Ordered Boolean A Boolean indicating if items in the list can be sorted on the Edit View page.
Showuser Boolean A Boolean indicating if the names of users are shown in the results of the survey.

Microsoft SharePoint Connector for CData Sync

Permissions

The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID.

Columns

Name Type Description
MemberID [KEY] String The Id of the permission.
Mask Long A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ('|') in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.
MemberIsUser Bool Indicate whether it is the permission for user.
MemberGlobal Bool Indicate whether it is the permission for group.
RoleName String A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ObjectName String A string that contains the name of the list or site.
ObjectType String A string that specifies either List or Web.
ItemID String Id of the item.

Microsoft SharePoint Connector for CData Sync

Subsites

Lists the available subsites.

Columns

Name Type Description
Title String The name of the subsite.
Url String The url of the subsite.

Microsoft SharePoint Connector for CData Sync

REST データモデル

CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

テーブル

Microsoft SharePoint サイトのリストは、リレーショナルテーブルとして動的に生成されます。そのため、新しいリストやフィールドを加えるなどの変更をリスト内で行うと、ドライバーにも反映されます。

テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。

ビュー

ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

OData 標準の使用

REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。

NOTE: "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に $select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。

Microsoft SharePoint Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Microsoft SharePoint Connector for CData Sync ビュー

Name Description
Attachments Reads attachments for the specified item on the specified list.
Files Query the available files on your sharepoint site.
Groups Query the available groups on your sharepoint site.
Lists Query the available lists on your sharepoint site.
RoleAssignmentMember Get Web RoleAssignments member.
RoleAssignments Get Web RoleAssignments.
RoleDefinitionBindings Get Web Role definition binding.
Roles Query the roles your users can have.
Subsites This lists the available subsites.
Users Query the available users on your sharepoint site.

Microsoft SharePoint Connector for CData Sync

Attachments

Reads attachments for the specified item on the specified list.

Table Specific Information

Select

Note: List and ItemId are required to return Attachments.

List can be fetched from the Lists view(Title column).

SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1

Columns

Name Type References Description
Id [KEY] String The Id of the attachment on the item.
Updated Datetime The updated date of the attachment to the item.
FileName String The FileName of the attachment to the item.
ServerRelativePath_DecodedUrl String The ServerRelativePath DecodedUrl of the attachment to the item.
FileNameAsPath_DecodedUrl String The FileNameAsPath DecodedUrl of the attachment to the item.
ServerRelativeUrl String The ServerRelativeUrl of the attachment to the item.
List String The internal name of the list to retrieve attachments from.
ItemID String The Id of the item on the list to retrieve attachments from.

Microsoft SharePoint Connector for CData Sync

Files

Query the available files on your sharepoint site.

Columns

Name Type References Description
Id [KEY] String
CreatedBy_Id String
CreatedBy_Name String
CreatedBy_Puid String
ETag String
LastModifiedBy_Id String
LastModifiedBy_Name String
LastModifiedBy_Puid String
Name String
Size Int
TimeCreated Datetime
TimeLastModified Datetime
Url String

Microsoft SharePoint Connector for CData Sync

Groups

Query the available groups on your sharepoint site.

Table Specific Information

Select


SELECT * FROM Groups

Columns

Name Type References Description
Id [KEY] Int The Group Id.
AllowMembersEditMembership Bool
AllowRequestToJoinLeave Bool
AutoAcceptRequestToJoinLeave Bool
CanCurrentUserEditMembership Bool
CanCurrentUserManageGroup Bool
CanCurrentUserViewMembership Bool
Description String
OnlyAllowMembersViewMembership Bool
OwnerTitle String
RequestToJoinLeaveEmailSetting String
LinkedOwner String
LinkedUsers String

Microsoft SharePoint Connector for CData Sync

Lists

Query the available lists on your sharepoint site.

Columns

Name Type References Description
HasUniqueRoleAssignments [KEY] Bool
LinkedFirstUniqueAncestorSecurableObject String
LinkedRoleAssignments String
ServerRelativeUrl String The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite.
Id [KEY] String
AllowContentTypes Bool
AllowDeletion Bool
BaseTemplate Int
BaseType Int
BrowserFileHandling Int
ContentTypesEnabled Bool
CrawlNonDefaultViews Bool
Created Datetime
CurrentChangeToken_StringValue String
CustomActionElements_Items String
DataSource_Properties String
DefaultContentApprovalWorkflowId String
DefaultDisplayFormUrl String
DefaultEditFormUrl String
DefaultItemOpenUseListSetting Bool
DefaultNewFormUrl String
DefaultViewPath_DecodedUrl String
DefaultViewUrl String
Description String
Direction String
DisableGridEditing Bool
DocumentTemplateUrl String
DraftVersionVisibility Int
EffectiveBasePermissions_High Long
EffectiveBasePermissions_Low Long
EffectiveBasePermissionsForUI_High Long
EffectiveBasePermissionsForUI_Low Long
EnableAssignToEmail Bool
EnableAttachments Bool
EnableFolderCreation Bool
EnableMinorVersions Bool
EnableModeration Bool
EnableRequestSignOff Bool
EnableVersioning Bool
EntityTypeName String
ExcludeFromOfflineClient Bool
ExemptFromBlockDownloadOfNonViewableFiles Bool
FileSavePostProcessingEnabled Bool
ForceCheckout Bool
HasExternalDataSource Bool
Hidden Bool
ImagePath_DecodedUrl String
ImageUrl String
IrmEnabled Bool
IrmExpire Bool
IrmReject Bool
IsApplicationList Bool
IsCatalog Bool
IsEnterpriseGalleryLibrary Bool
IsPrivate Bool
IsSiteAssetsLibrary Bool
IsSystemList Bool
ItemCount Int
LastItemDeletedDate Datetime
LastItemModifiedDate Datetime
LastItemUserModifiedDate Datetime
ListExperienceOptions Int
ListItemEntityTypeFullName String
MajorVersionLimit Int
MajorWithMinorVersionsLimit Int
MultipleDataList Bool
NoCrawl Bool
OnQuickLaunch Bool
PageRenderType Int
ParentWebPath_DecodedUrl String
ParentWebUrl String
ParserDisabled Bool
ReadSecurity Int
SchemaXml String
ServerTemplateCanCreateFolders Bool
TemplateFeatureId String
Title String
ValidationFormula String
ValidationMessage String
WriteSecurity Int
LinkedContentTypes String
LinkedCreatablesInfo String
LinkedDefaultView String
LinkedDescriptionResource String
LinkedEventReceivers String
LinkedFields String
LinkedForms String
LinkedInformationRightsManagementSettings String
LinkedItems String
LinkedParentWeb String
LinkedRootFolder String
LinkedSubscriptions String
LinkedTitleResource String
LinkedUserCustomActions String
LinkedViews String
LinkedWorkflowAssociations String

Microsoft SharePoint Connector for CData Sync

RoleAssignmentMember

Get Web RoleAssignments member.

Table Specific Information

Select

Note: PrincipalId is required to return RoleAssignmentMember.

SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'

Columns

Name Type References Description
ID [KEY] String The ID of the role assigned member.
Updated Datetime The updated date for role assigned member.
IsHiddenInUI Boolean A boolean indicating if the assigned role member is hidden in UI.
LoginName String The login name of the role assigned member.
Title String The title of the role assigned member.
AllowMembersEditMembership Boolean A boolean indicating whether to allow members edit membership.
AllowRequestToJoinLeave Boolean A boolean indicating whether to allow request to join leave.
AutoAcceptRequestToJoinLeave Boolean A boolean indicating whether to auto accept request to join leave.
Description String The description of the role assigned member.
OnlyAllowMembersViewMembership Boolean A boolean indicating whether to only allow members view membership.
OwnerTitle String The owner title of the role assigned member.
RequestToJoinLeaveEmailSetting String The request to join leave email setting of the role assigned member.
PrincipalId String

RoleAssignments.PrincipalId

The Principal Id.
List String

Lists.Title

The internal name of the list to retrieve role assigned member from.
ItemId String List item id for role assignment.

Microsoft SharePoint Connector for CData Sync

RoleAssignments

Get Web RoleAssignments.

Table Specific Information

Select


SELECT * FROM RoleAssignments WHERE List = 'TestApp'
SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'

Columns

Name Type References Description
ID [KEY] String The ID of the role assigned.
PrincipalId Long The Principal ID for role assigned.
Updated Datetime The updated date for role assigned.
List String

Lists.Title

The internal name of the list to retrieve role assigned from.
ItemId String List item id for role assignment.

Microsoft SharePoint Connector for CData Sync

RoleDefinitionBindings

Get Web Role definition binding.

Table Specific Information

Select

NOTE: PrincipalId is required to return RoleDefinitionBindings.

SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'

Columns

Name Type References Description
ID [KEY] String The ID of the role assigned member.
BasePermissions_High Int64 The base permissions high.
BasePermissions_Low Int64 The base permissions low.
Description String The description.
Hidden Boolean A boolean indicating if it is hidden.
Name String The name.
Order Int The order.
RoleTypeKind Int The role type kind.
PrincipalId String

RoleAssignments.PrincipalId

The Principal Id.
List String

Lists.Title

The internal name of the list to retrieve role assigned member from.
ItemId String List item id for role defintion.

Microsoft SharePoint Connector for CData Sync

Roles

Query the roles your users can have.

Columns

Name Type References Description
Id [KEY] Int
BasePermissions_High Long
BasePermissions_Low Long
Description String
Hidden Bool
Name String
Order Int
RoleTypeKind Int

Microsoft SharePoint Connector for CData Sync

Subsites

This lists the available subsites.

Table Specific Information

Select


SELECT * FROM Subsites

Columns

Name Type References Description
Id [KEY] String The Id of the subsite.
AllowRssFeeds Boolean The AllowRssFeeds of the subsite.
AlternateCssUrl String The AlternateCssUrl of the subsite.
AppInstanceId String The AppInstanceId of the subsite.
ClassicWelcomePage String The ClassicWelcomePage of the subsite.
Configuration Int The Configuration of the subsite.
Created Datetime The Created of the subsite.
CurrentChangeToken_StringValue String The CurrentChangeToken_StringValue of the subsite.
CustomMasterUrl String The CustomMasterUrl of the subsite.
Description String The Description of the subsite.
DesignPackageId String The DesignPackageId of the subsite.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Boolean The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite.
EnableMinimalDownload Boolean The EnableMinimalDownload of the subsite.
FooterEmphasis Int The FooterEmphasis of the subsite.
FooterEnabled Boolean The FooterEnabled of the subsite.
FooterLayout Int The FooterLayout of the subsite.
HeaderEmphasis Int The HeaderEmphasis of the subsite.
HeaderLayout Int The HeaderLayout of the subsite.
HideTitleInHeader Boolean The HideTitleInHeader of the subsite.
HorizontalQuickLaunch Boolean The HorizontalQuickLaunch of the subsite.
IsHomepageModernized Boolean The IsHomepageModernized of the subsite.
IsMultilingual Boolean The IsMultilingual of the subsite.
IsRevertHomepageLinkHidden Boolean The IsRevertHomepageLinkHidden of the subsite.
KeepFieldUserResources Boolean The KeepFieldUserResources of the subsite.
Language Int The Language of the subsite.
LastItemModifiedDate Datetime The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate Datetime The LastItemUserModifiedDate of the subsite.
LogoAlignment Int The LogoAlignment of the subsite.
MasterUrl String The MasterUrl of the subsite.
MegaMenuEnabled Boolean The MegaMenuEnabled of the subsite.
NavAudienceTargetingEnabled Boolean The NavAudienceTargetingEnabled of the subsite.
NoCrawl Boolean The NoCrawl of the subsite.
ObjectCacheEnabled Boolean The ObjectCacheEnabled of the subsite.
OverwriteTranslationsOnChange Boolean The OverwriteTranslationsOnChange of the subsite.
ResourcePath_DecodedUrl String The ResourcePath_DecodedUrl of the subsite.
QuickLaunchEnabled Boolean The QuickLaunchEnabled of the subsite.
RecycleBinEnabled Boolean The RecycleBinEnabled of the subsite.
SearchScope Int The SearchScope of the subsite.
ServerRelativeUrl String The ServerRelativeUrl of the subsite.
SiteLogoUrl String The SiteLogoUrl of the subsite.
SyndicationEnabled Boolean The SyndicationEnabled of the subsite.
TenantAdminMembersCanShare Int The TenantAdminMembersCanShare of the subsite.
Title String The Title of the subsite.
TreeViewEnabled Boolean The TreeViewEnabled of the subsite.
UIVersion Int The UIVersion of the subsite.
UIVersionConfigurationEnabled Boolean The UIVersionConfigurationEnabled of the subsite.
Url String The Url of the subsite.
WebTemplate String The WebTemplate of the subsite.
WelcomePage String The WelcomePage of the subsite.

Microsoft SharePoint Connector for CData Sync

Users

Query the available users on your sharepoint site.

Table Specific Information

Select


SELECT * FROM Users // Fetch all the Users
SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group

Columns

Name Type References Description
AadObjectId_NameId String
AadObjectId_NameIdIssuer String
Email String
Expiration String
IsEmailAuthenticationGuestUser Bool
IsShareByEmailGuestUser Bool
IsSiteAdmin Bool
UserId_NameId String
UserId_NameIdIssuer String
UserPrincipalName String
LinkedAlerts String
LinkedGroups String
LoginName String The login name of the user.
Title String The Title of the user.
IsHiddenInUI Boolean A boolean indicating if the user is hidden in UI.
GroupId Int The group id the user is added to.

Microsoft SharePoint Connector for CData Sync

データ型マッピング

データ型のマッピング

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

Microsoft SharePoint CData Schema
Choice (menu) string
Currency float
Date and Time datetime
Hyperlink or Picture string
Lookup string
Multiple lines of text string
Number float
Person or Group string
Single line of text string
Task Outcome string
Yes/No bool

Microsoft SharePoint Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
AuthSchemeSharePoint への認証に使用されるスキーム。
URLサイトのベースURL。
SharePointEdition使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User認証で使用されるSharePoint ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainシングルサインオン(SSO)を使用する場合のユーザーのドメイン。
SSOPropertiesセミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。

OAuth


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
ScopeThe scope used for the OAuth flow to access data from the Application.
State追加のOAuth ステート情報を表すオプションの値。
OAuthGrantTypeOAuth フローのグラント種別。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTIssuerJava Web Token の発行者。

Kerberos


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

SSL


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

Firewall


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

Proxy


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
CalculatedDataType計算フィールドで使用されるデータ型。
ContinueOnErrorエラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成するかしないかを示します。
DisableFilterLimitMicrosoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Enable this property to pull more than 5000 records from the list filter at the cost of additional performance overhead.
FolderOption結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
IncludeLookupColumnsこのオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeMicrosoft SharePoint から返されるページあたりの結果の最大数。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
ShowHiddenColumns非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViewsリストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。
STSURLシングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNamesAPI 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeNameBoolean determining if the table name should be EntityTypeName instead of the title in the REST schema.
UseNTLMV1ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Microsoft SharePoint Connector for CData Sync

Authentication

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


プロパティ説明
AuthSchemeSharePoint への認証に使用されるスキーム。
URLサイトのベースURL。
SharePointEdition使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User認証で使用されるSharePoint ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
Microsoft SharePoint Connector for CData Sync

AuthScheme

SharePoint への認証に使用されるスキーム。

解説

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

  • NTLM:認証にWindows クレデンシャルを使う場合に設定。
  • Negotiate:AuthScheme がNegotiate に設定された場合、Sync App は認証メカニズムをサーバーとネゴシエートします。Kerberos 認証を使いたい場合はAuthScheme をNegotiate に設定します。
  • None:匿名認証を使用する場合に設定。例えばパブリックサイトにアクセスする場合です。
  • Basic:HTTP Basic 認証を使う場合に設定。
  • ADFS:ADFS でシングルサインオン認証を使う場合に設定。

SharePoint Online に認証する場合、OAuth がデフォルトのオプションです。次のオプションを使って、認証スキームを選択してください。

  • AzureAD:Azure Active Directory OAuth 認証を実行する場合に設定。
  • AzurePassword:Password GrantType でOAuth 認証を使う場合に設定。
  • OAuthJWT:AuthScheme がOAuthJWT に設定されている場合、Sync App はAzureAD を使用して自己署名証明書に接続しようとします。
  • PingFederate:PingFederate でシングルサインオン認証を使う場合に設定。
  • ADFS:ADFS でシングルサインオン認証を使う場合に設定。
  • OneLogin:OneLogin でシングルサインオン認証を使う場合に設定。
  • OKTA:OKTA でシングルサインオン認証を使う場合に設定。
  • OAuth:OAuth 2 認証をGrantType CODE またはPASSWORD で使用する場合に設定。
  • AzureMSI:Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得するために設定。
  • SharePointOAuth:Sharepoint アプリクライアントクレデンシャルによるOAuth 認証を使う場合に設定。

Microsoft SharePoint Connector for CData Sync

URL

サイトのベースURL。

解説

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

  • http://server/SharePoint/
  • http://server/Sites/mysite/
  • http://server:90/
プロバイダーは、URL を使用して、他のサーバー呼び出しのためのURL を派生します。

Microsoft SharePoint Connector for CData Sync

SharePointEdition

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

解説

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

Microsoft SharePoint Connector for CData Sync

User

認証で使用されるSharePoint ユーザーアカウント。

解説

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

SharePoint On-Premise では、User にドメインを含める必要があり、User は"DOMAIN\Username" のようになります。

SharePoint Onlineでは、User は"[email protected]" のようになります。

Microsoft SharePoint Connector for CData Sync

Password

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

Microsoft SharePoint Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。
Microsoft SharePoint Connector for CData Sync

AzureTenant

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

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

AzureEnvironment

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

解説

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

このプロパティを使って、使用しているクラウドに基づいてURL サフィックスの問題を解決します(例えば、URL が.us で終わる場合はUSGOVT に設定)。設定についての詳細は、こちらからご覧いただけます: 「各国のクラウド」についてのMicrosoft ドキュメント。

Microsoft SharePoint Connector for CData Sync

SSO

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


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSODomainシングルサインオン(SSO)を使用する場合のユーザーのドメイン。
SSOPropertiesセミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
Microsoft SharePoint Connector for CData Sync

SSOLoginURL

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

解説

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

Microsoft SharePoint Connector for CData Sync

SSODomain

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

SSOProperties

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

解説

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

SSO 設定については、 で詳しく説明します。

Microsoft SharePoint Connector for CData Sync

OAuth

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


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
ScopeThe scope used for the OAuth flow to access data from the Application.
State追加のOAuth ステート情報を表すオプションの値。
OAuthGrantTypeOAuth フローのグラント種別。
Microsoft SharePoint Connector for CData Sync

OAuthClientId

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

解説

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

Microsoft SharePoint Connector for CData Sync

OAuthClientSecret

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

解説

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

Microsoft SharePoint Connector for CData Sync

Scope

The scope used for the OAuth flow to access data from the Application.

解説

The scope used for the OAuth flow to access data from the Application.

Note: If not specified or left to 'NONE', the Sync App sets the default scope dependant upon OAuthGrantType. Defaults to 'AllSites.Manage' unless using JWT OAuth, Azure Service Principal, or CLIENT grant type. The available values are:

  • AllSites.Read: Enables reading custom lists
  • AllSites.Write: Enables reading & writing custom lists
  • AllSites.Manage: Enables reading, writing and creating custom lists
  • .default: Requests application permissions without a user context. All the application permissions that have been granted for that web API are included in the retrieved OAuthAccessToken.

Microsoft SharePoint Connector for CData Sync

State

追加のOAuth ステート情報を表すオプションの値。

解説

追加のOAuth ステート情報を表すオプションの値。

Microsoft SharePoint Connector for CData Sync

OAuthGrantType

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

解説

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

Microsoft SharePoint Connector for CData Sync

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTIssuerJava Web Token の発行者。
Microsoft SharePoint Connector for CData Sync

OAuthJWTCert

JWT 証明書のストア。

解説

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

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

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

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

OAuthJWTCertType

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

OAuthJWTCertPassword

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

解説

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

Microsoft SharePoint Connector for CData Sync

OAuthJWTIssuer

Java Web Token の発行者。

解説

Java Web Token の発行者。 ほとんどの場合、これはOAuth App Id(クライアントId)接続プロパティの値を使用するため、個別に設定する必要はありません。

Microsoft SharePoint Connector for CData Sync

Kerberos

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


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

KerberosKDC

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

解説

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

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

KerberosRealm

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

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

KerberosSPN

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

KerberosKeytabFile

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

解説

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

Microsoft SharePoint Connector for CData Sync

KerberosServiceRealm

サービスのKerberos レルム。

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

KerberosServiceKDC

サービスのKerberos KDC。

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

KerberosTicketCache

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

解説

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

Microsoft SharePoint Connector for CData Sync

SSL

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


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

SSLClientCert

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

解説

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

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

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

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

SSLClientCertType

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

SSLClientCertPassword

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

解説

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

Microsoft SharePoint Connector for CData Sync

SSLClientCertSubject

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

解説

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

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

SSLServerCert

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

解説

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

Firewall

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


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

FirewallType

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

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

FirewallServer

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

FirewallPort

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

解説

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

Microsoft SharePoint Connector for CData Sync

FirewallUser

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

解説

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

Microsoft SharePoint Connector for CData Sync

FirewallPassword

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

解説

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

Microsoft SharePoint Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

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

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

Microsoft SharePoint Connector for CData Sync

ProxyServer

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

解説

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

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

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

Microsoft SharePoint Connector for CData Sync

ProxyPort

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

解説

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

Microsoft SharePoint Connector for CData Sync

ProxyAuthScheme

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

解説

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

ProxyUser

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

解説

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

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

user@domain
domain\user

Microsoft SharePoint Connector for CData Sync

ProxyPassword

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

解説

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

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

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

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

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

Microsoft SharePoint Connector for CData Sync

ProxySSLType

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

ProxyExceptions

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

Logging

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


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

LogModules

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

Schema

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


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

Location

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

解説

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

Note: このSync App は複数のスキーマをサポートするため、Microsoft SharePoint カスタムスキーマファイルの構造は以下のようになります。

  • 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
  • これらのスキーマフォルダは親フォルダに含まれています。
  • 親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。

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

Platform %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

Microsoft SharePoint Connector for CData Sync

BrowsableSchemas

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

解説

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

Microsoft SharePoint Connector for CData Sync

Tables

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

解説

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

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

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

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

Microsoft SharePoint Connector for CData Sync

Views

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

解説

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

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

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

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

Microsoft SharePoint Connector for CData Sync

Schema

使用するスキーマの種類。

解説

利用可能なスキーマは、REST(Sharepoint のREST API を使う場合)およびSOAP(Sharepoint のSOAP API を使う場合)です。

Microsoft SharePoint Connector for CData Sync

Miscellaneous

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


プロパティ説明
CalculatedDataType計算フィールドで使用されるデータ型。
ContinueOnErrorエラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成するかしないかを示します。
DisableFilterLimitMicrosoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Enable this property to pull more than 5000 records from the list filter at the cost of additional performance overhead.
FolderOption結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
IncludeLookupColumnsこのオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeMicrosoft SharePoint から返されるページあたりの結果の最大数。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
ShowHiddenColumns非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViewsリストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。
STSURLシングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNamesAPI 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeNameBoolean determining if the table name should be EntityTypeName instead of the title in the REST schema.
UseNTLMV1ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Microsoft SharePoint Connector for CData Sync

CalculatedDataType

計算フィールドで使用されるデータ型。

解説

計算フィールドで使用されるデータ型。デフォルト(Calculated)では、SharePoint の計算フィールドの型によってデータ型が判定されます。 ただし、これらの計算フィールドが、指定された型に合わない値を返す場合があります。このような場合は、CalculatedDataType を適切な型に設定できます。

Microsoft SharePoint Connector for CData Sync

ContinueOnError

エラー後にバッチ内の項目の更新を続行するかどうかを示します。

解説

このプロパティをTrue(デフォルト)に設定すると、項目の1つでエラーが発生した場合も、Sync App は引き続き項目の追加、更新、削除を行います。False に設定すると、エラーが発生した後、Sync App は項目の追加、更新、削除を停止します(問題があるエントリの前にあるエントリは、引き続き追加、更新、削除されます)。

Microsoft SharePoint Connector for CData Sync

CreateIDColumns

他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成するかしないかを示します。

解説

他のリストに格納されている情報からの値を使っている("Lookup" または"Person or Group" 列のように)SharePoint 列に補助的ID 列を作成するかしないかを示します。作成されたID 列は関連するエントリーのID をオリジナルリストのコンテキストの中で保有します。 false に設定されている場合にはID は作成されず、ID は無視されID は参照列の値のみが返されます。

Microsoft SharePoint Connector for CData Sync

DisableFilterLimit

Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Enable this property to pull more than 5000 records from the list filter at the cost of additional performance overhead.

解説

Regardless of whether this property is set to true or false, for list filters with 5000 or fewer records, server-side processing of list filter queries is supported by Microsoft SharePoint, leading to the fastest possible performance.

When this property is set to true and the list filter exceeds 5000 entries, the Sync App will process the query filters client-side, which has an extra cost to performance.

However, if this property is set to false and the list filter exceeds 5000 entries, the Sync App will query from the list itself (as opposed to the list filter). This causes the set of columns in the query result to reflect the columns in the list instead of the list filter.

Microsoft SharePoint Connector for CData Sync

FolderOption

結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。

解説

結果にフォルダを表示する方法を決定するオプション。FilesOnly は、指定されたリストまたはライブラリ内のファイルだけを表示します。 FilesAndFolders は、指定されたリスト内のファイルとフォルダを表示します。RecursiveAll は、指定されたリストとすべてのサブフォルダ内のファイルを表示します。

Microsoft SharePoint Connector for CData Sync

IncludeLookupColumns

このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。

解説

このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。SharePoint サーバーは、1つのクエリに多数のルックアップ列が含まれている場合、リクエストを拒否します。

Microsoft SharePoint Connector for CData Sync

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

Microsoft SharePoint Connector for CData Sync

Other

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

解説

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

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

統合およびフォーマット

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

Microsoft SharePoint Connector for CData Sync

Pagesize

Microsoft SharePoint から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、Microsoft SharePoint から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

Microsoft SharePoint Connector for CData Sync

PseudoColumns

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

解説

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

Microsoft SharePoint Connector for CData Sync

ShowHiddenColumns

非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。

解説

SOAP スキーマとREST スキーマの両方で使用できます。false に設定すると、REST スキーマのパフォーマンスに影響を与える可能性があります。

Microsoft SharePoint Connector for CData Sync

ShowPredefinedColumns

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。

解説

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 通常、これはCreatedBy やAuthor などのシステム列です。ただし、定義済みの列にはTitle などの一般的な列が含まれることもあります。

Microsoft SharePoint Connector for CData Sync

ShowVersionViews

リストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。

解説

リストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。

Microsoft SharePoint Connector for CData Sync

STSURL

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

解説

シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。これを明示的に設定する必要はめったにありません。

Microsoft SharePoint Connector for CData Sync

Timeout

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

解説

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

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

Microsoft SharePoint Connector for CData Sync

UseDisplayNames

API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。

解説

SOAP スキーマとREST スキーマの両方で使用できます。有効にすると、REST スキーマのパフォーマンスに影響を与える可能性があります。

Microsoft SharePoint Connector for CData Sync

UseEntityTypeName

Boolean determining if the table name should be EntityTypeName instead of the title in the REST schema.

解説

Boolean determining if the table name should be EntityTypeName instead of the title in the REST schema.

Microsoft SharePoint Connector for CData Sync

UseNTLMV1

ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。

解説

ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。

Microsoft SharePoint Connector for CData Sync

UserDefinedViews

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

解説

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

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

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

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

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
指定されたパスは引用符で囲まれていないことに注意してください。

Microsoft SharePoint Connector for CData Sync

UseSimpleNames

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

解説

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

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839