View a markdown version of this page

Salesforce-Konnektor V1.0 - Amazon Kendra

Amazon Kendra ist nicht mehr offen für neue Kunden. In den Amazon Bedrock Knowledge Bases finden Sie ähnliche Funktionen wie. Amazon KendraWeitere Informationen.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Salesforce-Konnektor V1.0

Salesforce ist ein Customer Relationship Management (CRM)-Tool zur Verwaltung von Support-, Vertriebs- und Marketingteams. Sie können ihn verwenden Amazon Kendra , um Ihre Salesforce-Standardobjekte und sogar benutzerdefinierte Objekte zu indizieren.

Wichtig

Amazon Kendra verwendet die Salesforce-API-Version 48. Die Salesforce-API begrenzt die Anzahl der Anfragen, die Sie pro Tag stellen können. Wenn Salesforce diese Anfragen überschreitet, wird der Vorgang wiederholt, bis der Vorgang fortgesetzt werden kann.

Anmerkung

Der V1.0 Salesforce-Konnektor/die SalesforceConfiguration Salesforce-API endete 2023. Wir empfehlen, zum V2.0 Salesforce-Konnektor/zur TemplateConfiguration Salesforce-API zu migrieren oder diese zu verwenden.

Informationen zur Fehlerbehebung bei Ihrem Amazon Kendra Salesforce-Datenquellen-Connector finden Sie unterProblembehandlung bei Datenquellen.

Unterstützte Features

Amazon Kendra Der Salesforce-Datenquellen-Connector unterstützt die folgenden Funktionen:

  • Feldzuordnungen

  • Zugriffskontrolle für Benutzer

  • Inclusion/exclusion Filter

Voraussetzungen

Bevor Sie Ihre Salesforce-Datenquelle Amazon Kendra zur Indizierung verwenden können, nehmen Sie diese Änderungen in Salesforce und Ihren AWS Konten vor.

Stellen Sie in Salesforce sicher, dass Sie:

  • Sie haben ein Salesforce-Konto erstellt und den Benutzernamen und das Passwort notiert, die Sie für die Verbindung mit Salesforce verwenden.

  • Sie haben ein Salesforce Connected-App-Konto mit aktiviertem OAuth erstellt und den Ihrer Salesforce Connected-Anwendung zugewiesenen Verbraucherschlüssel (Client-ID) und das Verbrauchergeheimnis (Client Secret) kopiert. Die Client-ID und das Client-Geheimnis werden als Ihre Authentifizierungsdaten verwendet, die in einem AWS Secrets Manager Secret gespeichert sind. Weitere Informationen finden Sie in der Salesforce-Dokumentation zu verbundenen Anwendungen.

    Anmerkung

    Wir empfehlen, die Anmeldeinformationen und Secrets regelmäßig zu aktualisieren oder zu wechseln. Stellen Sie zu Ihrer eigenen Sicherheit nur die unbedingt erforderliche Zugriffsebene bereit. Es wird nicht empfohlen, Anmeldeinformationen und Geheimnisse für alle Datenquellen und die Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

  • Das Salesforce-Sicherheitstoken wurde kopiert, das dem Konto zugeordnet ist, das für die Verbindung mit Salesforce verwendet wurde.

  • Die URL der Salesforce-Instanz, die Sie indizieren möchten, wurde kopiert. Dabei handelt es sich in der Regel um https://<company>.salesforce.com/. Der Server muss eine mit Salesforce verbundene Anwendung ausführen.

  • Ihrem Salesforce-Server wurden Anmeldeinformationen für einen Benutzer mit schreibgeschütztem Zugriff auf Salesforce hinzugefügt, indem Sie das ReadOnly Profil geklont und dann die Berechtigungen „Alle Daten anzeigen“ und „Artikel verwalten“ hinzugefügt haben. Diese Anmeldeinformationen identifizieren den Benutzer, der die Verbindung herstellt, und die Salesforce-Anwendung, Amazon Kendra mit der eine Verbindung hergestellt wird.

  • Aktiviert, jedes Dokument ist in Salesforce und in allen anderen Datenquellen, die Sie für denselben Index verwenden möchten, einzigartig. Jede Datenquelle, die Sie für einen Index verwenden möchten, darf nicht in allen Datenquellen dasselbe Dokument enthalten. Dokument-IDs gelten global für einen Index und müssen pro Index eindeutig sein.

Stellen Sie in Ihrem sicher AWS-Konto, dass Sie:

  • Hat einen Amazon Kendra Index erstellt und bei Verwendung der API die Index-ID notiert.

  • Hat eine IAM Rolle für Ihre Datenquelle erstellt und, falls Sie die API verwenden, den ARN der IAM Rolle notiert.

    Anmerkung

    Wenn Sie Ihren Authentifizierungstyp und Ihre Anmeldeinformationen ändern, müssen Sie Ihre IAM Rolle aktualisieren, um auf die richtige AWS Secrets Manager geheime ID zuzugreifen.

  • Ihre Salesforce-Anmeldeinformationen wurden in einem AWS Secrets Manager Geheimnis gespeichert und, falls Sie die API verwenden, die ARN des Geheimnisses notiert.

    Anmerkung

    Wir empfehlen, die Anmeldeinformationen und Secrets regelmäßig zu aktualisieren oder zu wechseln. Stellen Sie zu Ihrer eigenen Sicherheit nur die unbedingt erforderliche Zugriffsebene bereit. Wir empfehlen nicht, Anmeldeinformationen und Geheimnisse für alle Datenquellen und die Connector-Versionen 1.0 und 2.0 (sofern zutreffend) wiederzuverwenden.

Wenn Sie noch keine IAM Rolle oder kein Geheimnis haben, können Sie die Konsole verwenden, um eine neue IAM Rolle und ein neues Secrets Manager Geheimnis zu erstellen, wenn Sie Ihre Salesforce-Datenquelle mit verbinden. Amazon Kendra Wenn Sie die API verwenden, müssen Sie den ARN einer vorhandenen IAM Rolle und eines vorhandenen Secrets Manager Geheimnisses sowie eine Index-ID angeben.

Anweisungen zur Verbindung

Um eine Verbindung Amazon Kendra zu Ihrer Salesforce-Datenquelle herzustellen, müssen Sie die erforderlichen Details Ihrer Salesforce-Datenquelle angeben, damit Sie auf Ihre Daten zugreifen Amazon Kendra können. Wenn Sie Salesforce noch nicht konfiguriert haben, Amazon Kendra sieheVoraussetzungen.

Console

Um eine Verbindung Amazon Kendra zu Salesforce herzustellen

  1. Melden Sie sich bei der AWS Management Console an und öffnen Sie die Amazon Kendra Konsole.

  2. Wählen Sie im linken Navigationsbereich Indizes aus und wählen Sie dann den Index, den Sie verwenden möchten, aus der Liste der Indizes aus.

    Anmerkung

    Sie können Ihre Einstellungen für die Benutzerzugriffskontrolle unter Indexeinstellungen konfigurieren oder bearbeiten.

  3. Wählen Sie auf der Seite Erste Schritte die Option Datenquelle hinzufügen aus.

  4. Wählen Sie auf der Seite Datenquelle hinzufügen die Option Salesforce-Connector V1.0 und dann Connector hinzufügen aus.

  5. Geben Sie auf der Seite „Datenquellendetails angeben“ die folgenden Informationen ein:

    1. Datenquellenname — Geben Sie einen Namen für Ihre Datenquelle ein. Sie können Bindestriche, aber keine Leerzeichen verwenden.

    2. (Optional) Beschreibung — Geben Sie eine optionale Beschreibung für Ihre Datenquelle ein.

    3. Standardsprache — Eine Sprache zum Filtern Ihrer Dokumente für den Index. Sofern Sie nichts anderes angeben, ist die Standardsprache Englisch. Die in den Metadaten angegebene Sprache überschreibt die ausgewählte Sprache.

    4. Neues Schlagwort hinzufügen — Stichwörter zum Suchen und Filtern Ihrer Ressourcen oder zum Nachverfolgen Ihrer gemeinsamen Kosten.

    5. Wählen Sie Weiter aus.

  6. Geben Sie auf der Seite „Zugriff und Sicherheit definieren“ die folgenden Informationen ein:

    1. Salesforce-URL — Geben Sie die Instanz-URL für die Salesforce-Site ein, die Sie indizieren möchten.

    2. Wählen Sie für den Authentifizierungstyp zwischen Bestehend und Neu, um Ihre Salesforce-Anmeldeinformationen zu speichern. Wenn Sie sich dafür entscheiden, ein neues Geheimnis zu erstellen, wird ein AWS Secrets Manager geheimes Fenster geöffnet.

      1. Geben Sie im Fenster Create an AWS Secrets Manager secret die folgenden Informationen ein:

        1. Secret-Name – Ein Name für Ihr Secret. Das Präfix 'AmazonKendra-Salesforce-' wird automatisch zu Ihrem geheimen Namen hinzugefügt.

        2. Für Benutzername, Passwort, Sicherheitstoken, Verbraucherschlüssel , Verbrauchergeheimnis und Authentifizierungs-URL — Geben Sie die Authentifizierungsdaten ein, die Sie in Ihrem Salesforce-Konto erstellt haben.

        3. Wählen Sie Authentifizierung speichern aus.

    3. IAM Rolle — Wählen Sie eine vorhandene IAM Rolle aus oder erstellen Sie eine neue IAM Rolle, um auf Ihre Repository-Anmeldeinformationen und Indexinhalte zuzugreifen.

      Anmerkung

      IAM Rollen, die für Indizes verwendet werden, können nicht für Datenquellen verwendet werden. Wenn Sie sich nicht sicher sind, ob eine vorhandene Rolle für einen Index oder häufig gestellte Fragen verwendet wird, wählen Sie Neue Rolle erstellen, um Fehler zu vermeiden.

    4. Wählen Sie Weiter aus.

  7. Geben Sie auf der Seite Synchronisierungseinstellungen konfigurieren die folgenden Informationen ein:

    1. Für Anlagen crawlen — Wählen Sie diese Option, um alle angehängten Objekte, Artikel und Feeds zu crawlen.

    2. Für Standardobjekte, Knowledge-Artikel und Chatter-Feeds — Wählen Sie Salesforce-Entitäten oder Inhaltstypen aus, die Sie crawlen möchten.

      Anmerkung

      Sie müssen Konfigurationsinformationen für die Indexierung mindestens eines der Standardobjekte, Knowledge-Artikel oder Chatter-Feeds angeben. Wenn Sie Knowledge-Artikel crawlen möchten, müssen Sie die Typen der zu indexierenden Knowledge-Artikel und den Namen der Artikel angeben und festlegen, ob die Standardfelder aller Knowledge-Artikel oder nur die Felder eines benutzerdefinierten Artikeltyps indexiert werden sollen. Wenn Sie benutzerdefinierte Artikel indexieren möchten, müssen Sie den internen Namen des Artikeltyps angeben. Sie können bis zu 10 Artikeltypen angeben.

    3. Häufigkeit — Wie oft Amazon Kendra wird mit Ihrer Datenquelle synchronisiert.

    4. Wählen Sie Weiter aus.

  8. Geben Sie auf der Seite Feldzuordnungen festlegen die folgenden Informationen ein:

    1. Für Standard-Knowledge-Artikel, Standardobjektanhänge und Zusätzliche empfohlene Feldzuordnungen — Wählen Sie aus den Amazon Kendra generierten Standarddatenquellenfeldern aus, die Sie Ihrem Index zuordnen möchten.

      Anmerkung

      Eine Indexzuordnung zu _document_body ist erforderlich. Sie können die Zuordnung zwischen dem Feld Salesforce ID und dem Amazon Kendra -Feld _document_id nicht ändern.

    2. Feld hinzufügen — Um benutzerdefinierte Datenquellenfelder hinzuzufügen, um einen Indexfeldnamen für die Zuordnung und den Felddatentyp zu erstellen.

    3. Wählen Sie Weiter aus.

  9. Überprüfen Sie auf der Seite Überprüfen und erstellen, ob die von Ihnen eingegebenen Informationen korrekt sind, und wählen Sie dann Datenquelle hinzufügen aus. Sie können Ihre Informationen auch auf dieser Seite bearbeiten. Ihre Datenquelle wird auf der Seite Datenquellen angezeigt, nachdem die Datenquelle erfolgreich hinzugefügt wurde.

API

Um eine Verbindung Amazon Kendra zu Salesforce herzustellen

Sie müssen Folgendes für die SalesforceConfiguration API angeben:

  • Server-URL — Die Instanz-URL für die Salesforce-Site, die Sie indizieren möchten.

  • Geheimer Amazon-Ressourcenname (ARN) — Geben Sie den Amazon-Ressourcennamen (ARN) eines Secrets Manager Secrets an, das die Anmeldeinformationen für Ihr Salesforce-Konto enthält. Das Geheimnis wird in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

    { "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 role — Geben Sie anRoleArn, wann Sie anrufenCreateDataSource, um einer IAM Rolle Berechtigungen für den Zugriff auf Ihr Secrets Manager Secret und zum Aufrufen der erforderlichen öffentlichen APIs für den Salesforce-Connector und Amazon Kendra zu gewähren. Weitere Informationen finden Sie unter IAM Rollen für Salesforce-Datenquellen.

  • Sie müssen Konfigurationsinformationen für die Indexierung mindestens eines der Standardobjekte, Knowledge-Artikel oder Chatter-Feeds angeben.

    • Standardobjekte — Wenn Sie Standardobjekte crawlen möchten, müssen Sie den Namen des Standardobjekts und den Namen des Felds in der Standardobjekttabelle angeben, das den Dokumentinhalt enthält.

    • Knowledge-Artikel — Wenn Sie Knowledge-Artikel crawlen möchten, müssen Sie angeben, welche Typen von Knowledge-Artikeln indexiert werden sollen, welchen Status die zu indizierenden Knowledge-Artikel haben und ob die Standardfelder aller Knowledge-Artikel oder nur die Felder eines benutzerdefinierten Artikeltyps indexiert werden sollen.

    • Chatter-Feeds — Wenn Sie Chatter-Feeds crawlen möchten, müssen Sie den Namen der Spalte in der FeedItem Salesforce-Tabelle angeben, die den zu indizierenden Inhalt enthält.

Sie können auch die folgenden optionalen Funktionen hinzufügen:

  • Aufnahme- und Ausschlussfilter — Geben Sie an, ob bestimmte Dateianhänge ein- oder ausgeschlossen werden sollen.

    Anmerkung

    Die meisten Datenquellen verwenden Muster mit regulären Ausdrücken, bei denen es sich um Ein- oder Ausschlussmuster handelt, die als Filter bezeichnet werden. Wenn Sie einen Einschlussfilter angeben, werden nur Inhalte indexiert, die dem Einschlussfilter entsprechen. Jedes Dokument, das dem Einschlussfilter nicht entspricht, wird nicht indexiert. Wenn Sie einen Aufnahme- und Ausschlussfilter angeben, werden Dokumente, die dem Ausschlussfilter entsprechen, nicht indexiert, auch wenn sie dem Einschlussfilter entsprechen.

  • Feldzuordnungen — Wählen Sie diese Option, um Ihre Salesforce-Datenquellenfelder Ihren Indexfeldern zuzuordnen. Amazon Kendra Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.

    Anmerkung

    Das Textfeld des Dokuments oder das Äquivalent zum Dokumententext für Ihre Dokumente ist erforderlich, um Ihre Dokumente durchsuchen Amazon Kendra zu können. Sie müssen den Feldnamen für den Dokumenttext in Ihrer Datenquelle dem Indexfeldnamen zuordnen_document_body. Alle anderen Felder sind optional.

  • Benutzerkontextfilterung und Zugriffskontrolle Amazon Kendra — durchsucht die Zugriffskontrollliste (ACL) für Ihre Dokumente, sofern Sie eine ACL für Ihre Dokumente haben. Die ACL-Informationen werden verwendet, um Suchergebnisse basierend auf dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.