Salesforce コネクタ V2.0

Salesforce は、サポート、営業、マーケティングの各チームを管理するための顧客関係管理 (CRM) ツールです。を使用して Amazon Kendra 、Salesforce 標準オブジェクトやカスタムオブジェクトのインデックスを作成できます。

Amazon Kendra Salesforce データソースコネクタは、次の Salesforce エディションをサポートしています: Developer Edition と Enterprise Edition。

注記

Salesforce コネクタ V1.0 / SalesforceConfiguration API のサポートは 2023 年に終了する予定です。Salesforce コネクタ V2.0 / TemplateConfiguration API への移行または使用をお勧めします。

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

サポートされている機能

Amazon Kendra Salesforce データソースコネクタは、次の機能をサポートしています。

フィールドマッピング
ユーザーアクセスコントロール
包含/除外フィルター
完全および増分コンテンツ同期
仮想プライベートクラウド (VPC)

前提条件

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

Salesforce で、次の作業を行ったことを確認してください。

Salesforce 管理アカウントを作成し、Salesforce への接続に使用するユーザー名とパスワードをメモすること。
Salesforce への接続に使用されるアカウントに関連付けられた Salesforce セキュリティトークンをコピーすること。
OAuth を有効にした Salesforce 接続アプリケーションアカウントを作成し、Salesforce 接続アプリケーションに割り当てられたコンシューマーキー (クライアント ID) とコンシューマーシークレット (クライアントシークレット) をコピーすること。クライアント ID とクライアントシークレットは、シー AWS Secrets Manager クレットに保存されている認証情報として使用されます。詳細については、接続アプリケーションに関する Salesforce のドキュメントを参照してください。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
インデックスを作成する Salesforce インスタンスの URL をコピーすること。通常、URL は https://<company>.salesforce.com/ です。サーバーは Salesforce 接続アプリケーションを実行している必要があります。
ReadOnly プロファイルをクローンし、すべてのデータを表示して記事を管理するアクセス許可を追加することで、Salesforce への読み取り専用アクセス権を持つユーザーの認証情報を Salesforce サーバーに追加しました。これらの認証情報は、接続を行うユーザーと、 Amazon Kendra 接続先の Salesforce 接続アプリケーションを識別します。
各ドキュメントが Salesforce および同じインデックスに使用する予定の他のデータソース間で一意であると確認すること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。

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

Amazon Kendra インデックスを作成し、API を使用している場合はインデックス ID を記録しました。
データソースの IAM ロールを作成し、 API を使用している場合は、 IAM ロールの ARN を記録しました。

注記
認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。
Salesforce の認証資格情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。

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

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

接続手順

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

Console

Salesforce Amazon Kendra に接続するには：

にサインイン AWS Management Console し、Amazon Kendra コンソールを開きます。
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

注記
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
[使用開始] ページで、[データソースを追加] を選択します。
データソースの追加ページで、Salesforce コネクタ を選択し、コネクタの追加 を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた Salesforce コネクタを選択します。
[データソースの詳細を指定] ページで、次の情報を入力します。
1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
2. (オプション) [説明] - オプションで、データソースの説明を入力します。
3. デフォルト言語 - ドキュメントをフィルタリングしてインデックスを作成する言語を選択します。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
4. タグで、新しいタグを追加 — リソースを検索およびフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。
5. [次へ] をクリックします。
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
1. [Salesforce URL] - インデックスを作成する Salesforce サイトのインスタンス URL を入力します。
2. 承認 — ACL があり、アクセスコントロールに使用する場合は、ドキュメントのアクセスコントロールリスト (ACL) 情報をオンまたはオフにします。ACL は、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
3. 既存のシークレットを入力するか、新しいシークレットを作成すると、 AWS Secrets Manager シークレットウィンドウが開きます。
  1. 認証 — Secrets Manager シークレットの作成 AWS ウィンドウ に次の情報を入力します。
    1. [シークレット名] - シークレットの名前。シークレット名には、プレフィックスAmazonKendra「-Salesforce-」が自動的に追加されます。
    2. [ユーザー名]、[パスワード]、[セキュリティトークン]、[コンシューマーキー]、[コンシューマーシークレット]、[認証 URL] には、Salesforce アカウントで生成してダウンロードした認証情報の値を入力します。
      
      注記
      Salesforce Developer Edition を使用する場合は、 https://login.salesforce.com/services/oauth2/tokenまたは My Domain ログイン URL (https://MyCompany.my.salesforce.com など) を認証 URL として使用します。Salesforce サンドボックスエディションを使用する場合は、 https://test.salesforce.com/services/oauth2/token または My Domain ログイン URL ( MyDomainName--SandboxName.sandbox.my.salesforce.com など) を認証 URL として使用します。
    3. [認証を保存] を選択します。
4. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
5. ID クローラー — Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーをオンにして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラーがオフになっている場合は、代わりに PutPrincipalMapping API を使用してユーザーコンテキストフィルタリング用のユーザーおよびグループのアクセス情報をアップロードできます。
6. IAM role — 既存の IAM ロールを選択するか、リポジトリ認証情報にアクセスしてコンテンツにインデックスを付けるための新しい IAM ロールを作成します。
  
  注記
  IAM インデックスに使用されるロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
7. [次へ] をクリックします。
[同期設定の構成] ページで、次の情報を入力します。
1. [添付ファイルのクロール] - 選択すると、添付されたすべての Salesforce オブジェクトがクロールされます。
2. [標準オブジェクト]、[添付ファイル付き標準オブジェクト]、[添付ファイルなしの標準オブジェクト]、[ナレッジ記事] - クロールする Salesforce エンティティまたはコンテンツタイプを選択します。
3. インデックス作成には、標準オブジェクト、ナレッジ記事、または Chatter フィードのうち少なくとも 1 つの設定情報を入力する必要があります。[ナレッジ記事] のクロールを選択した場合は、インデックスを作成するナレッジ記事の種類を指定する必要があります。公開済み、アーカイブ済み、ドラフト、添付ファイルを選択できます。
  
  [正規表現フィルター] - 特定のカタログアイテムを含む正規表現パターンを指定します。
[追加の設定]:
- [ACL 情報] デフォルトでは、すべてのアクセスコントロールリストが含まれます。アクセスコントロールリストを選択解除すると、そのカテゴリのファイルがすべて公開されます。
- [正規表現パターン] - 特定のファイルを含めるまたは除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。
[同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースをと Amazon Kendra 初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとしてフル同期を選択しなくても、最初の同期が失敗した場合は、データのフル同期を実行する必要があります。
- 完全同期: すべてのコンテンツを新しくインデックス化し、データソースがインデックスと同期するたびに既存のコンテンツを置き換えます。
- 新しい、変更された同期: データソースがインデックスと同期するたびに、新しいコンテンツと変更されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。
- 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
[次へ] をクリックします。
[フィールドマッピングを設定] ページで、次の情報を入力します。
1. 標準ナレッジ記事 、標準オブジェクトアタッチメント 、および追加の推奨フィールドマッピング - インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。
  
  注記
  _document_body へのインデックスマッピングが必要です。Salesforce ID フィールドと Amazon Kendra _document_id フィールド間のマッピングは変更できません。Salesforce フィールドは、ドキュメントタイトルまたはドキュメント本文の Amazon Kendra 予約済み/デフォルトインデックスフィールドにマッピングできます。
  Salesforce フィールドを Amazon Kendra ドキュメントタイトルとドキュメント本文フィールドにマッピングすると、Amazon Kendra は検索レスポンスでドキュメントタイトルと本文フィールドのデータを使用します。
2. [フィールドを追加] - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。
3. [次へ] をクリックします。
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Salesforce Amazon Kendra に接続するには

TemplateConfiguration API を使用してデータソーススキーマの JSON を指定する必要があります。これには、以下の情報を入力する必要があります。

データソース — JSON スキーマSALESFORCEV2を使用する場合は、データソースタイプを TemplateConfiguration として指定します。また、 CreateDataSource API を呼び出すTEMPLATEときにデータソースをとして指定します。
ホスト URL - Salesforce インスタンスのホスト URL を指定します。
同期モード — データソースコンテンツが変更されたときにがインデックスを更新する方法 Amazon Kendra を指定します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとしてフル同期を選択しなくても、最初の同期が失敗した場合は、データのフル同期を実行する必要があります。以下のいずれかから選択できます。
- FORCED_FULL_CRAWL データソースがインデックスと同期するたびに既存のコンテンツを置き換え、すべてのコンテンツに新しいインデックスを付けます。
- FULL_CRAWL は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのみをインデックス化します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツをインデックス化できます。
- CHANGE_LOG データソースが index と同期するたびに、新規および変更されたコンテンツのみをインデックス作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツをインデックス作成できます。

シークレット Amazon リソースネーム (ARN) - Salesforce アカウントの認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。


{
    "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
    "consumerKey": "Application public key generated when you created your Salesforce application",
    "consumerSecret": "Application private key generated when you created your Salesforce application",
    "password": "Password associated with the user logging in to the Salesforce instance",
    "securityToken": "Token associated with the user account logging in to the Salesforce instance",
    "username": "User name of the user logging in to the Salesforce instance"
}

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

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

[仮想プライベートクラウド (VPC)] - VpcConfiguration で CreateDataSource を呼び出すタイミングを指定します。詳細については、「を使用する Amazon Kendra ためのの設定 Amazon VPC」を参照してください。
包含フィルターと除外フィルター - 特定のドキュメント、アカウント、キャンペーン、ケース、連絡先、リード、機会、ソリューション、タスク、グループ、Chatter、カスタムエンティティファイルを含めるか除外するかを指定できます。

注記
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
ID クローラー — Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendraの ID クローラーをオンにして、検索結果のユーザーコンテキストフィルタリングを設定することもできます。それ以外の場合、ID クローラーがオフになっていると、すべてのドキュメントをパブリックに検索できます。ドキュメントのアクセスコントロールを使用し、ID クローラーがオフになっている場合は、代わりに PutPrincipalMapping API を使用してユーザーコンテキストフィルタリング用のユーザーおよびグループのアクセス情報をアップロードできます。
フィールドマッピング - 選択すると、Salesforce データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、データソースフィールドのマッピングを参照してください。

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

注記
_document_body へのインデックスマッピングが必要です。Salesforce ID フィールドと Amazon Kendra _document_id フィールド間のマッピングは変更できません。Salesforce フィールドは、ドキュメントタイトルまたはドキュメント本文の Amazon Kendra 予約済み/デフォルトインデックスフィールドにマッピングできます。
Salesforce フィールドを Amazon Kendra ドキュメントタイトルとドキュメント本文フィールドにマッピングすると、Amazon Kendra は検索レスポンスでドキュメントタイトルと本文フィールドのデータを使用します。

設定するその他の重要な JSON キーのリストについては、「Salesforce テンプレートスキーマ」を参照してください。

詳細はこちら

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

の更新された Salesforce コネクタ (V2) の発表 Amazon Kendra

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Salesforce コネクタ V1.0

ServiceNow