SharePoint コネクタ V1.0

SharePoint は、ウェブコンテンツをカスタマイズしたり、ページ、サイト、ドキュメントライブラリ、リストを作成したりできる、コラボレーション用ウェブサイト構築サービスです。SharePoint ユーザーの場合は、 Amazon Kendra を使用して SharePoint データソースのインデックスを作成できます。

注記

SharePoint コネクタ V1.0 / SharePointConfiguration API は 2023 年に終了しました。SharePoint コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。

Amazon Kendra SharePoint データソースコネクタのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング。

サポートされている機能

• フィールドマッピング

• ユーザーアクセスコントロール

• 包含/除外フィルター

• 変更ログ

• 仮想プライベートクラウド (VPC)

前提条件

Amazon Kendra を使用して SharePoint データソースのインデックスを作成する前に、SharePoint と AWS アカウントでこれらの変更を行います。

シー AWS Secrets Manager クレットに安全に保存されている認証情報を指定する必要があります。

注記

認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

SharePoint では、次のものがあることを確認してください。

• インデックスを作成する SharePoint サイトの URL を記録しました。

• SharePoint オンラインの場合:

  • サイト管理者権限を持つユーザー名とパスワードを含む基本認証資格情報を記録しました。

  • オプション: ユーザー名、パスワード、クライアント ID、クライアントシークレットを含む OAuth 2.0 認証情報を生成しました。

  • 管理者ユーザーを使用して Azure Portal の [セキュリティデフォルト] を無効にしました。Azure Portal でのセキュリティのデフォルト設定の管理の詳細については、セキュリティのデフォルトを有効または無効にする方法に関する Microsoft のドキュメントを参照してください。

• SharePoint Server の場合:

  • SharePoint Server のドメイン名 (アクティブディレクトリの NetBIOS 名) を記録しました。これを SharePoint 基本認証のユーザー名とパスワードとともに使用して、SharePoint Server を Amazon Kendraに接続します。

  注記

  SharePoint Server を使用し、ユーザーコンテキストでフィルタリングするためにアクセスコントロールリスト (ACL) を E メール形式に変換する必要がある場合は、LDAP サーバーの URL と LDAP 検索ベースを指定します。または、ディレクトリドメインの上書きを使用することもできます。LDAP サーバーの URL は、完全なドメイン名およびポート番号 (例えば、ldap://example.com:389) です。LDAP 検索ベースは、ドメインコントローラの「example」と「com」です。ディレクトリドメインの上書きでは、LDAP サーバーの URL と LDAP 検索ベースを使用する代わりに、E メールドメインを使用できます。例えば、「[e-mail]」の E メールドメインは「example.com」です。この上書きは、ドメインの検証について心配がなく、単に E メールドメインを使用する場合に使用できます。

• SharePoint アカウントに次のアクセス許可を追加しました。

  SharePoint リストの場合

  • アイテムを開く - サーバー側のファイルハンドラを使用してドキュメントのソースを表示します。

  • アプリケーションページの表示 - フォーム、ビュー、およびアプリケーションページを表示します。リストを一覧表示します。

  • アイテムの表示 - リスト内のアイテムとドキュメントライブラリ内のドキュメントを表示します。

  • バージョンの表示 - リスト項目またはドキュメントの過去のバージョンを表示します。

  SharePoint ウェブサイトの場合

  • ディレクトリの参照 - SharePoint Designer および Web DAV インターフェイスを使用してウェブサイトのファイルとフォルダを一覧表示します。

  • ユーザー情報の参照 - ウェブサイトのユーザーに関する情報を表示します。

  • アクセス許可の一覧表示 - ウェブサイト、リスト、フォルダ、ドキュメント、またはリスト項目に対する許可を一覧表示します。

  • 開く - ウェブサイト、リスト、またはフォルダを開き、コンテナ内のアイテムにアクセスします。

  • クライアント統合機能の使用 - SOAP、WebDAV、クライアントオブジェクトモデル、または SharePoint Designer インターフェイスを使用してウェブサイトにアクセスします。

  • リモートインターフェイスの使用 - クライアントアプリケーションを起動する機能を使用します。

  • ページの表示 - ウェブサイトのページを表示します。

• 各ドキュメントが SharePoint および同じインデックスを使用予定の他のデータソース間で一意であることを確認します。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。

で AWS アカウント、以下があることを確認します。

• Amazon Kendra インデックスを作成し、 API を使用している場合はインデックス ID を記録しました。

• データソースの IAM ロールを作成し、 API を使用している場合はロールの ARN を記録しました IAM 。

  注記

  認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。

• SharePoint の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。

  注記

  認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

既存の IAM ロールまたはシークレットがない場合は、SharePoint データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。

接続手順

SharePoint データソース Amazon Kendra に接続するには、 がデータにアクセスできるように Amazon Kendra 、SharePoint 認証情報の詳細を指定する必要があります。SharePoint をまだ設定していない場合は、 Amazon Kendra 「」を参照してください前提条件。

Console

SharePoint Amazon Kendra に接続するには

1. AWS マネジメントコンソールにサインインし、Amazon Kendra コンソールを開きます。

2. 左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

   注記

   [インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。

3. [使用開始] ページで、[データソースを追加] を選択します。

4. [データソースを追加] ページで、[SharePoint connector v1.0] を選択し、[データソースを追加] を選択します。

5. [データソースの詳細を指定] ページで、次の情報を入力します。

   1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。

   2. (オプション) [説明] - オプションで、データソースの説明を入力します。

   3. デフォルト言語 - ドキュメントをインデックス用にフィルタリングする言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。

   4. タグで、新しいタグを追加する - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。

   5. [次へ] を選択します。

6. [アクセスとセキュリティの定義] ページで、次の情報を入力します。

   1. [ホスティング方法] の場合 - [SharePoint Online] と [SharePoint Server] のどちらかを選択します。

      1. [SharePoint Online] の場合 - SharePoint リポジトリ固有のサイト URL を入力します。

      2. SharePoint Server の場合 - SharePoint バージョンを選択し、SharePoint リポジトリに固有のサイト URLs を入力し、SSL 証明書の場所への Amazon S3 パスを入力します。

   2. (SharePoint Server のみ) [Web プロキシ] の場合 - 内部 SharePoint インスタンスの [ホスト名] と [ポート番号] を入力します。ポート番号は 0～65535 の数字である必要があります。

   3. [認証] の場合 - ユースケースに基づいて以下のオプションから選択してください。

      1. SharePoint Online の場合:[基本認証] と [OAuth 2.0 認証] のどちらかを選択します。

      2. SharePoint Server の場合 - [なし]、[LDAP]、[手動] のいずれかを選択します。

   4. AWS Secrets Manager シークレットの場合 - 既存のシークレットを選択するか、SharePoint 認証情報を保存する新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。[シークレット名] を入力する必要があります。シークレット名に、プレフィックス「AmazonKendra-SharePoint-」が自動的に追加されます。

   5. [ AWS Secrets Manager シークレットウィンドウを作成] に次のその他の情報を入力します。

      1. ユースケースに基づいて、次の SharePoint Cloud 認証オプションから選択してください。

         1. [基本認証] - SharePoint アカウントのユーザー名を [ユーザー名] に、SharePoint アカウントのパスワードを [パスワード] に入力します。

         2. [OAuth 2.0 認証] - SharePoint アカウントのユーザー名を [ユーザー名] に、SharePoint アカウントのパスワードを [パスワード] に、自動生成された一意の SharePoint ID を [クライアント ID] として、SharePoint と Amazon Kendra の両方で [クライアントシークレット] として使用される共有シークレット文字列を入力します。

      2. ユースケースに基づいて、次の SharePoint Server 認証オプションから選択してください。

         1. [なし] - SharePoint アカウントのユーザー名を [ユーザー名] に、SharePoint アカウントのパスワードを [パスワード] に入力し、[サーバーのドメイン名] を入力します。

         2. [LDAP] -SharePoint アカウントのユーザー名を [ユーザー名] に、SharePoint アカウントのパスワードを [パスワード] に入力し、[LDAP サーバーエンドポイント] (プロトコルとポート番号を含む。例えば、ldap://example.com:389)、[LDAP 検索ベース] (例えば、dc=example, dc=com) を入力します。

         3. [手動] - SharePoint アカウントのユーザー名を [ユーザー名] に、SharePoint アカウントのパスワードを [パスワード] に入力し、[E メールドメインの上書き] (ディレクトリユーザーまたはグループの E メールドメイン) を入力します。

      3. [保存] を選択します。

   6. [仮想プライベートクラウド (VPC)] - [サブネット] と [VPC セキュリティグループ] も追加する必要があります。

      注記

      SharePoint Server を使用する場合は VPC を使用する必要があります。 Amazon VPC は他の SharePoint バージョンではオプションです。

   7. IAM role - 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。

      注記

      IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。

   8. [次へ] を選択します。

7. [同期設定の構成] ページで、次の情報を入力します。

   1. [変更ログを使用] - 選択すると、すべてのファイルを同期する代わりにインデックスを更新できます。

   2. [添付ファイルをクロール] - 選択すると添付ファイルがクロールされます。

   3. [ローカルグループマッピングを使用] - 選択すると、ドキュメントが適切にフィルター処理されます。

   4. [追加設定] - 特定のファイルを含めるか除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。

   5. [同期実行スケジュール] の [頻度] - Amazon Kendra がデータソースと同期する頻度。

   6. [次へ] を選択します。

8. [フィールドマッピングを設定] ページで、次の情報を入力します。

   1. Amazon Kendra デフォルトフィールドマッピング — インデックスにマッピングする Amazon Kendra 生成されたデフォルトデータソースフィールドから選択します。

   2. [カスタムフィールドマッピング] の場合 - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。

   3. [次へ] を選択します。

9. [確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

SharePoint Amazon Kendra に接続するには

SharePointConfiguration API を使用して以下を指定する必要があります。

• SharePoint バージョン - SharePoint を構成するときに使用する SharePoint バージョンを指定します。これは、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019、または SharePoint Online のどれを使用していても当てはまります。

• シークレット Amazon リソースネーム (ARN) — SharePoint アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは JSON 構造に保存されます。

  SharePoint Online 基本認証の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。

  {
      "userName": "user name",
      "password": "password"
  }

  SharePoint Online OAuth 2.0 認証の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。

  {
      "userName": "SharePoint account user name"",
      "password": "SharePoint account password",
      "clientId": "SharePoint auto-generated unique client id",
      "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
  }

  SharePoint Server 基本認証の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。

  {
      "userName": "user name",
      "password": "password",
      "domain": "server domain name"
  }

  SharePoint Server の LDAP 認証の場合 (ユーザーコンテキストでフィルタリングするためにアクセスコントロールリスト (ACL) を E メール形式に変換する必要がある場合は、シークレットに LDAP サーバーの URL と LDAP 検索ベースを含めることができます)、シークレットに含める必要がある最小の JSON 構造は次のとおりです。

  {
      "userName": "user name",
      "password": "password",
      "domain": "server domain name"
      "ldapServerUrl": "ldap://example.com:389",
      "ldapSearchBase": "dc=example,dc=com"
  }

  SharePoint Server 手動認証の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。

  {
      "userName": "user name",
      "password": "password",
      "domain": "server domain name",
      "emailDomainOverride": "example.com"
  }

• IAM role - を呼び出しCreateDataSourceて、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、SharePoint コネクタと に必要なパブリック APIs を呼び出すRoleArnタイミングを指定します Amazon Kendra。詳細については、「IAM roles for SharePoint data sources」を参照してください。

• Amazon VPC - SharePoint Server を使用する場合は、データソース構成の一部として VpcConfiguration を指定してください。「VPC を使用する Amazon Kendra ように を設定する」を参照してください。

オプションで、次の機能を追加することもできます。

• ウェブプロキシ - ウェブプロキシ経由で SharePoint サイトの URL に接続するかどうか。このオプションは SharePoint Server でのみ使用できます。

• インデックス作成リスト — が添付ファイルの内容を SharePoint リスト項目にインデックス Amazon Kendra 作成するかどうか。

• 変更ログ — Amazon Kendra が SharePoint データソース変更ログメカニズムを使用して、インデックスでドキュメントを更新する必要があるかどうかを判断するかどうか。

  注記

  Amazon Kendra にすべてのドキュメントをスキャンさせない場合は、変更ログを使用します。変更ログが大きい場合、変更ログを処理するよりも、SharePoint データソース内のドキュメントのスキャンにかかる時間が Amazon Kendra 短くなる場合があります。SharePoint データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。

• 包含フィルターと除外フィルター - 特定のコンテンツを含めるか除外するかを指定できます。

  注記

  ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。

• フィールドマッピング - 選択すると、SharePoint データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。

  注記

  がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントに対応するドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 にマッピングする必要があります_document_body。その他のすべてのフィールドはオプションです。

• ユーザーコンテキストのフィルタリングとアクセスコントロール —Amazon Kendra ドキュメントの ACL がある場合は、ドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。

詳細はこちら

SharePoint SharePoint データソース Amazon Kendra との統合の詳細については、以下を参照してください。

• Amazon Kendra SharePoint Online コネクタの開始方法