Microsoft SharePoint On-Prem コネクタをデプロイする

Google Workspace のコンテンツに加えて、組織の SharePoint オンプレミス コンテンツからも結果を返すように Google Cloud Search を設定できます。Google Cloud Search SharePoint On-Prem コネクタを使用して、特定の SharePoint データソースにアクセスするように構成します。

重要な考慮事項

尊重された SharePoint 設定

Cloud Search SharePoint On-Prem コネクタは、SharePoint の [検索の公開設定] 設定を常に適用します。この設定はオーバーライドできません。下書きのドキュメントの場合、ユーザー アカウントの権限(コネクタが SharePoint Online へのアクセスに使用する権限)によって、インデックスに登録されて返される下書きドキュメントを制御します。アカウントに「完全な読み取り」権限しかない場合、コネクタは SharePoint の「下書きアイテムの公開設定」の設定に従います。

ユーザー アカウントのアクセス権に基づいて結果を制限するようにコネクタを構成することもできます。Google プリンシパルと外部プリンシパルを使用して ACL を定義できます。SharePoint コンテンツのセキュリティ トリミングを適用するには、次の外部 ID を Google ディレクトリと同期します。

  • Active Directory ユーザー
  • Active Directory グループ
  • SharePoint ローカル グループ(メンバーは Active Directory ユーザーとグループ)

AD のユーザーとグループを同期するには、Google Cloud Directory Sync を使用して、ID がマッピングされたグループを有効にします。SharePoint ローカル グループを同期するには、SharePoint ID コネクタを使用します。

また、コネクタは、プリンシパルを同期するための追加情報を取得するために AD でルックアップを行う必要もあります。たとえば、AD によるルックアップでは、コネクタで次のことができます。

  • ドメイン グループの SID を対応する sAMAccountName にマッピングします。
  • ユーザーの sAMAccountName を SharePoint ローカル グループ メンバーシップのメールアドレスにマッピングします。

検索の最適化

より関連性の高い検索結果を返すようにコネクタを設定することで、ユーザー エクスペリエンスを向上させることができます。

API を使用するには、SharePoint Online コネクタ構成ファイルで HTML 生成パラメータの値を設定します。これらのパラメータを使用すると、一致に対する影響を高くまたは低く抑えるフィールドを設定できます。

スキーマを設定するには、スキーマを作成して登録するの手順に沿って操作します。スキーマを設定する場合:

  • SharePoint コンテンツ タイプの名前を対応するオブジェクト定義にマッピングするために、コネクタは、サポートされていない文字を除外してコンテンツ タイプ名を正規化します。オブジェクト定義の場合、Cloud Search API は A ~ Z、a ~ z、0 ~ 9 の有効な文字のみをサポートしています。たとえば、コンテンツ タイプ「Announcements」はオブジェクト定義「Announcements」にマッピングされます。コンテンツ タイプ「News Article」は「NewsArticle」(スペースなし)にマッピングされます。

  • オブジェクト定義とオブジェクト定義が一致しない場合、コネクタは代替オブジェクト タイプ(itemMetadata.objectType)を使用します。詳しくは、メタデータ設定パラメータをご覧ください。

  • SharePoint プロパティ名をプロパティ定義にマッピングするために、コネクタは、16 進数でエンコードされた文字をデコードし、「ows_」接頭辞を削除し、サポートされていない文字(有効な文字として A ~ Z、a ~ z、0 ~ 9 を除くすべての文字)を除外することで、プロパティ名を正規化します。

Microsoft Outlook でのメールの処理

コネクタがコンテンツをインデックスに登録する際に Microsoft Outlook の .msg ファイルを検出すると、ファイルのメディアタイプをオーバーライドして application/vnd.ms-outlook. としてインデックスに登録します

マルチテナント構成

SharePoint がマルチテナント デプロイであり、複数の顧客サイトが同じウェブ アプリケーションでホストされている場合は、構成ファイルでサイト収集モードを構成する必要があります。マルチテナント デプロイでは、SharePoint On-Prem コネクタに必要なように、サイト コレクションの権限のみを取得できます。完全読み取り権限は取得できません。

サイト コレクション モードを有効にするには:

  • コネクタ ユーザー アカウントに、サイト コレクション管理者の権限を付与します。
  • コネクタ構成ファイルの sharepoint.server を、http://sharepoint.example.com/sites/sitecollection などのサイト コレクション URL に設定します。SharePoint の場合とまったく同じ URL を使用する必要はありません。
  • コネクタ構成ファイルの sharepoint.siteCollectionOnlytrue に設定します。

マルチテナント環境でインデックス登録するサイト コレクションが複数ある場合は、サイト コレクションごとに 1 つのコネクタ インスタンスを設定する必要があります。

コネクタの既知の制限事項

  • コネクタがデータベース内のアイテムの変更を検出するのにかかる時間は、コネクタがモニタリングするデータベースの数に比例します。
  • メモリ消費量は、各サイト コレクションの ACL で使用するユニーク ユーザーとグループの数に比例して増加します。
  • 1 つの Active Directory ドメインの ID のみを使用してコネクタを構成できます。
  • EveryoneBUILTIN\UsersAll Authenticated Users などの一般的な Active Directory と Windows のプリンシパルの一部はサポートされていません。
  • 削除通知は即時ではなく、ユーザーがソース リポジトリからコンテンツを削除したことをコネクタが認識するまでに 4 時間以上かかることがあります。

システム要件

システム要件
OS
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10(64 ビット)
ソフトウェア
  • SharePoint サーバー
    • SharePoint Server 2016
    • SharePoint Server 2013
  • Google Cloud Search SharePoint On-Prem コネクタを実行するコンピュータに Java JRE 1.8 がインストールされていること
認証
  • NTLM
  • Kerberos
  • HTTP ベーシック
  • ADFS

コネクタをデプロイする

前提条件

  1. サービス アカウント ID を含む Google Workspace の秘密鍵を作成する。秘密鍵を取得する方法については、 Google Cloud Search API へのアクセスを構成するをご覧ください。

  2. Google Workspace 管理者は、検索対象のデータソースを追加する必要があります。データソース ID を記録します。

  3. コネクタが ACL に基づいて結果を返す場合(結果は公開されません)、Google Workspace 管理者が 2 つの ID ソースを作成し、その ID を提供する必要があります。

    • Active Directory ユーザーとグループを同期するための ID ソース。
    • SharePoint ローカル グループの ID ソース。

    また、管理者は組織の Google Workspace お客様 ID を取得して提供する必要があります。

    これらの値を取得する方法については、Cloud Search でユーザー ID をマッピングするをご覧ください。

  4. ユーザー ポリシーで、SharePoint ウェブ アプリケーションに対する完全な読み取り権限を持つコネクタのユーザー アカウントを設定します。

  5. SharePoint Web Application にルートサイト コレクションがない場合は、作成します。

  6. サイト コレクションが書き込みロックされている場合は、管理者権限のあるアカウントで SharePoint サーバーにログインし、PrepareWriteLockedSites.ps1 スクリプトを実行します。

  7. コネクタ構成を通知するデータソースの指標を取得するには、ファーム管理権限を持つアカウントで SharePoint サーバーにログインして、diagnose_sp.ps1 を実行します。

    出力では、ウェブ アプリケーション、ドキュメント、ユーザー グループ メンバーの数が報告されます。この情報を使用して、必要なコネクタ インスタンスの数、メモリ要件、ドキュメント数を見積もります。

ステップ 1: Google Cloud Search SharePoint On-Prem コネクタ ソフトウェアをインストールする

  1. GitHub からコネクタ リポジトリのクローンを作成します。

    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. 希望するバージョンのコネクタをチェックアウトします。

    $ git checkout tags/latest_version

    ここで、latest_version = v1-0.0.5 などの値。

  3. コネクタをビルドします。

    $ mvn package

    コネクタのビルド時にテストをスキップするには、mvn package ではなく mvn package -DskipTests を実行します。

  4. コネクタ zip ファイルをローカルのインストール ディレクトリにコピーします。

    $ cp target/google-cloudsearch-sharepoint-connector-latest_version.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-sharepoint-connector-latest_version.zip
    $ cd google-cloudsearch-sharepoint-connector-latest_version

手順 2. SharePoint On-Prem コネクタ構成ファイルを作成する

  1. コネクタのインストールと同じディレクトリにファイルを作成します。ファイル名を connector-config.properties にすることをおすすめします。これにより、コネクタを実行するために追加のコマンドライン パラメータが不要になります。多数のコネクタ インスタンスを実行する場合は、区別できるように詳細を名前に追加します。

  2. 次の例のように、パラメータを Key-Value ペアとしてファイルの内容に追加します。

    ### Sharepoint On-Prem Connector configuration ###
    
    # Required parameters for data source access
    api.sourceId=08ef8becd116faa4546b8ca2c84b2879
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint on-premises access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    
    # Optional parameters for schema mapping
    contentTemplate.sharepointItem.title=Title
    contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
    

    各パラメータの詳細については、 構成パラメータのリファレンスをご覧ください。

  3. (省略可)必要に応じて、追加のコネクタ パラメータを構成します。詳細については、Google 提供のコネクタ パラメータをご覧ください。

ステップ 3: HTTPS の場合は、SharePoint を信頼できるホストとして追加する

HTTPS を使用するように SharePoint が構成されている場合は、SharePoint 証明書を取得して、コネクタの信頼できるホストとして追加します。

  1. コネクタを実行するパソコンでブラウザを開き、SharePoint に移動します。

  2. 警告ページが開いたら、[I understand the Risks] と [Add Exception] をクリックします。証明書は自己署名されており、信頼できる認証局による署名がないため、ページに「この接続は信頼できません」などのメッセージが表示されます。

  3. [View] ボタンが表示されたら、クリックします。

  4. [詳細] タブに移動し、[エクスポート] をクリックします。

  5. 証明書を sharepoint.crt という名前でコネクタ ディレクトリに保存します。

  6. [閉じる]、[キャンセル] の順にクリックしてウィンドウを閉じます。

  7. コマンド プロンプトを開き、次のコマンドを入力します。

    $ keytool -importcert -keystore cacerts.jks -storepass changeit -file sharepoint.crt -alias sharepoint

    [この証明書を信頼しますか?] というメッセージが表示されたら、「yes」と入力します。

ステップ 4: ロギングの設定

  1. コネクタ バイナリを含むディレクトリに、logs という名前のフォルダを作成します。

  2. 同じディレクトリ(logs ではない)に、Latin1 でエンコードされた logging.properties という名前のファイルを作成します。

  3. logging.properties に次のテキストを追加します。

    handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
    # Default log level
    .level = INFO
    # uncomment line below to increase logging level for SharePoint APIsa
    #com.google.enterprise.cloudsearch.sharepoint.level=FINE
    
    # uncomment line below to increase logging level to enable API trace
    #com.google.api.client.http.level = FINE
    java.util.logging.ConsoleHandler.level = INFO
    java.util.logging.FileHandler.pattern=logs/connector-sharepoint.%g.log
    java.util.logging.FileHandler.limit=10485760
    java.util.logging.FileHandler.count=10
    java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter
    

ステップ 5. SharePoint On-Prem ID コネクタを構成する

この手順は、SharePoint On-Prem の ID ベースの ACL を検索結果に適用するために必要です。コネクタを公開 ACL で設定する場合は、この手順を省略できます。

  1. SharePoint Online コネクタのインストールと同じディレクトリに、sharepoint-onprem-identity-connector.config というファイルを作成し、

  2. 次の例のように、パラメータを Key-Value ペアとしてファイルの内容に追加します。

    ### SharePoint On-prem identity connector configuration ###
    
    # Required parameters for data source access
    api.customerId=C05d3djk8
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    

    値は、api.sourceId ではなく api.customerId である点を除き、SharePoint On-Prem コネクタの場合とほぼ同じです。api.customerId の値は、Google Workspace 管理者から取得したお客様 ID です。

ステップ 6. SharePoint On-Prem コネクタを起動する

次の手順では、オンプレミスの Active Directory と SharePoint サイト コレクションの両方のプリンシパルを Cloud Identity サービスの ID にマッピングします。この同期は、Google Cloud Directory Sync(GCDS)と SharePoint On-Prem ID コネクタを使用して行われます。

GCDS によるユーザーとグループの同期後、SharePoint サイト コレクション グループを同期するには、SharePoint On-Prem ID コネクタを実行します。最後に、SharePoing On-Prem コネクタを実行して、Cloud Search ユーザーに結果をインデックス登録して提供します。

  1. まだ行っていない場合は、 GCDS を構成して実行します。ID マッピングされたグループを有効にしてください。

  2. SharePoint On-Prem ID コネクタを実行します。

    $ java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-version.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector -Dconfig=sharepoint-onprem-identity-connector.config
  3. SharePoint On-Prem コネクタを実行します。SharePoint サイトのセキュリティには、次のコマンド構文を使用します。

    • HTTP(信頼できるホストは不要):

      $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar
    • HTTPS(SharePoint を信頼できるホストとして追加):

      $ java -Djavax.net.ssl.trustStore=cacerts.jks -Djavax.net.ssl.trustStoreType=jks -Djavax.net.ssl.trustStorePassword=changeit -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar

構成パラメータのリファレンス

データソース アクセス

設定 パラメータ
データソース ID api.sourceId=1234567890abcdef

必須。Google Workspace 管理者が設定した Google Cloud Search データソース ID。

サービス アカウントの秘密鍵ファイルへのパス api.serviceAccountPrivateKeyFile=PrivateKey.json

必須。Google Cloud Search サービス アカウント キー ファイルのパス。

SharePoint オンプレミス アクセス

設定 パラメータ
SharePoint サーバーの URL sharepoint.server=http://yoursharepoint.example.com/

必須。完全修飾ホスト名としての SharePoint サーバーの URL(例: http://yoursharepoint.example.com/)。ホスト名が完全修飾されていない場合、コネクタホストで DNS オーバーライドを設定する必要があります。

SharePoint ユーザー名 sharepoint.username=YOURDOMAIN\\ConnectorUser

Linux または SharePoint Server AD ドメインの一部ではない Windows マシンでコネクタを実行する場合に必要です。

SharePoint パスワード sharepoint.password=user_password

Linux または SharePoint Server AD ドメインの一部ではない Windows マシンでコネクタを実行する場合に必要です。

ライブ認証を使用して SharePoint に接続する sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE

ADFS 認証を使用して SharePoint に接続する sharepoint.username=AdaptorUser@yourdomain.com

sharepoint.password=uS3R_passWoRD

sharepoint.sts.endpoint=https://adfs.example.com/adfs/services/trust/2005/usernamemixed

sharepoint.sts.realm=urn:myserver:sharepoint または https://yoursharepoint.example.com/_trust

sharepoint.formsAuthenticationMode=ADFS

サイト コレクションのインデックス登録

設定 パラメータ
インデックス タイプ sharepoint.siteCollectionOnly=boolean

省略可。ただし、マルチテナント SharePoint デプロイを除きます(詳細)。true に設定すると、コネクタのインデックスを仮想サーバーではなくサイト コレクションとして sharepoint.server にすることができます。デフォルトは null(自動検出)です。

SharePoint の ID マッピング

設定 パラメータ
ID ソースの ID api.identitySourceId=1234567890abcdef

必須。SharePoint ローカル グループを同期するための ID ソースの ID。Google Workspace 管理者が設定した Google Cloud Search ソースの ID。検索対象のデータソースを追加するをご覧ください。

参照 ID ソース api.referenceIdentitySources=CONTOSO,contoso

Active Directory プリンシパルの参照 ID ソースのカンマ区切りリスト。この値は、参照する Active Directory プリンシパルの Active Directory NETBIOS 名と一致します。

参照 ID ソースの ID api.referenceIdentitySource.DOMAIN.id=identity-source-id

必須。Active Directory プリンシパルを同期するための ID ソース ID。

Active Directory ルックアップ

設定 パラメータ
Active Directory ホスト adLookup.host=host

必須。Active Directory のホスト名(dc.contoso.com など)または IP アドレス。

Active Directory 参照ポート adLookup.port=port

省略可。デフォルトは 389 です。SSL には 686 を使用します。

Active Directory 参照方法 adLookup.method=value

省略可。デフォルトは「standard」です。HTTPS 接続の場合は、「ssl」に設定します。

Active Directory 参照ユーザー adLookup.username=CONTOSO\user1

必須。Active Directory 参照を実行することを承認されたユーザー。

Active Directory 参照パスワード adLookup.password=password123

必須。adLookup.user で指定されたユーザーのパスワード。

HTML コンテンツの生成

設定 パラメータ
HTML テンプレート タイトル項目 contentTemplate.sharePointItem.title=Title

生成される HTML の HTML テンプレート タイトルとして使用する SharePoint フィールド。

HTML コンテンツの高検索精度項目 contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

生成された HTML に高品質のフィールドとして含める、フィールドのカンマ区切りのリスト。検索語句のキーワードがこれらのフィールドと一致すると、検索結果の順位が高くなります。

HTML コンテンツの中検索精度項目 contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

生成された HTML に中程度の品質のフィールドとして含めるカンマ区切りのフィールドのリスト。

HTML コンテンツの低検索精度項目 contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

生成された HTML に低品質フィールドとして含めるフィールドのカンマ区切りリスト。

HTML コンテンツのマッピングされていない列 contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

コネクタがマッピングされていない列を処理する方法。値は APPEND(デフォルト)または IGNORE です。

  • APPEND - 品質レベル(高、中、低)が設定されていないフィールドを含むすべてのフィールドの HTML コンテンツが生成されます。
  • IGNORE - コネクタは、マッピングされたフィールドのみを含む HTML コンテンツを生成します。