Connecteur Salesforce V2.0 - Amazon Kendra
Fonctionnalités prises en chargePrérequisInstructions de connexionEn savoir plus

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Connecteur Salesforce V2.0

Salesforce est un outil de gestion de la relation client (CRM) permettant de gérer les équipes de support, de vente et de marketing. Vous pouvez l'utiliser Amazon Kendra pour indexer vos objets standard Salesforce et même vos objets personnalisés.

Le connecteur de source de données Amazon Kendra Salesforce prend en charge les éditions Salesforce suivantes : Developer Edition et Enterprise Edition.

Note

Support pour le connecteur Salesforce V1.0/ SalesforceConfiguration API devrait prendre fin en 2023. Nous vous recommandons de migrer vers ou d'utiliser le connecteur Salesforce TemplateConfiguration V2.0/API.

Pour résoudre les problèmes liés à votre connecteur de source de données Amazon Kendra Salesforce, consultezDépannage des sources de données.

Fonctionnalités prises en charge

Amazon Kendra Le connecteur de source de données Salesforce prend en charge les fonctionnalités suivantes :

  • Mappages de champs

  • Contrôle d'accès utilisateur

  • Filtres d'inclusion/exclusion

  • Synchronisation complète et incrémentielle du contenu

  • Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir l'utiliser Amazon Kendra pour indexer votre source de données Salesforce, apportez ces modifications à votre Salesforce et à vos AWS comptes.

Dans Salesforce, assurez-vous que vous disposez des éléments suivants :

  • J'ai créé un compte administratif Salesforce et j'ai noté le nom d'utilisateur et le mot de passe que vous utilisez pour vous connecter à Salesforce.

  • Le jeton de sécurité Salesforce associé au compte utilisé pour se connecter à Salesforce a été copié.

  • Vous avez créé un compte Salesforce Connected App avec OAuth activé et j'ai copié la clé client (ID client) et le secret client (secret client) attribués à votre application Salesforce Connected. L'ID client et le secret du client sont utilisés comme informations d'authentification stockées dans un AWS Secrets Manager secret. Consultez la documentation Salesforce sur les applications connectées pour plus d'informations.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

  • Vous avez copié l'URL de l'instance Salesforce que vous souhaitez indexer. Il s'agit généralement de https ://.salesforce.com/. <company> Le serveur doit exécuter une application connectée à Salesforce.

  • Vous avez ajouté des informations d'identification à votre serveur Salesforce pour un utilisateur ayant un accès en lecture seule à Salesforce en clonant le ReadOnly profil, puis en ajoutant les autorisations Afficher toutes les données et Gérer les articles. Ces informations d'identification identifient l'utilisateur qui établit la connexion et l'application connectée Salesforce à laquelle Amazon Kendra elle se connecte.

  • Il est vérifié que chaque document est unique dans Salesforce et dans les autres sources de données que vous prévoyez d'utiliser pour le même index. Chaque source de données que vous souhaitez utiliser pour un index ne doit pas contenir le même document dans toutes les sources de données. Les identifiants de document sont globaux à un index et doivent être uniques par index.

Dans votre Compte AWS, assurez-vous d'avoir :

  • Création d'un Amazon Kendra index et, si vous utilisez l'API, notez l'ID de l'index.

  • Vous avez créé un IAM rôle pour votre source de données et, si vous utilisez l'API, notez l'ARN du IAM rôle.

    Note

    Si vous modifiez votre type d'authentification et vos informations d'identification, vous devez mettre à jour votre IAM rôle pour accéder au bon identifiant AWS Secrets Manager secret.

  • Stockez vos informations d'authentification Salesforce dans un AWS Secrets Manager secret et, si vous utilisez l'API, notez l'ARN du secret.

    Note

    Nous vous recommandons d'actualiser ou de modifier régulièrement vos informations d'identification et votre code secret. Fournissez uniquement le niveau d'accès nécessaire pour votre propre sécurité. Nous vous déconseillons de réutiliser les informations d'identification et les secrets entre les sources de données et les versions 1.0 et 2.0 du connecteur (le cas échéant).

Si vous n'avez pas de IAM rôle ou de secret existant, vous pouvez utiliser la console pour créer un nouveau IAM rôle et un nouveau Secrets Manager secret lorsque vous connectez votre source de données Salesforce à Amazon Kendra. Si vous utilisez l'API, vous devez fournir l'ARN d'un IAM rôle et d'un Secrets Manager secret existants, ainsi qu'un identifiant d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de données Salesforce, vous devez fournir les informations nécessaires sur votre source de données Salesforce afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Salesforce pour Amazon Kendra voirPrérequis.

Console

Pour vous connecter Amazon Kendra à Salesforce :

  1. Connectez-vous à la Amazon Kendra console AWS Management Console et ouvrez-la.

  2. Dans le volet de navigation de gauche, choisissez Index, puis choisissez l'index que vous souhaitez utiliser dans la liste des index.

    Note

    Vous pouvez choisir de configurer ou de modifier vos paramètres de contrôle d'accès utilisateur dans les paramètres de l'index.

  3. Sur la page de démarrage, choisissez Ajouter une source de données.

  4. Sur la page Ajouter une source de données, choisissez le connecteur Salesforce, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Salesforce avec la balise « V2.0 ».

  5. Sur la page Spécifier les détails de la source de données, entrez les informations suivantes :

    1. Dans Nom et description, pour Nom de la source de données : entrez le nom de votre source de données. Vous pouvez inclure des traits d'union, mais pas des espaces.

    2. (Facultatif) Description : entrez une description facultative pour votre source de données.

    3. Dans la langue par défaut : choisissez une langue pour filtrer vos documents pour l'index. Sauf indication contraire, la langue par défaut est l'anglais. La langue spécifiée dans les métadonnées du document remplace la langue sélectionnée.

    4. Dans Balises, pour Ajouter une nouvelle balise : incluez des balises facultatives pour rechercher et filtrer vos ressources ou suivre vos AWS coûts.

    5. Choisissez Suivant.

  6. Sur la page Définir l'accès et la sécurité, entrez les informations suivantes :

    1. URL Salesforce —Entrez l'URL de l'instance du site Salesforce que vous souhaitez indexer.

    2. Autorisation : activez ou désactivez les informations de la liste de contrôle d'accès (ACL) pour vos documents, si vous disposez d'une ACL et que vous souhaitez l'utiliser pour le contrôle d'accès. L'ACL indique les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage du contexte utilisateur.

    3. Entrez un secret existant ou, si vous en créez un nouveau, une fenêtre de AWS Secrets Manager secret s'ouvre.

      1. Authentification : entrez les informations suivantes dans la fenêtre Créer un AWS Secrets Manager secret :

        1. Nom secret : le nom de votre secret. Le préfixe « AmazonKendra -Salesforce-» est automatiquement ajouté à votre nom secret.

        2. Pour le nom d'utilisateur, le mot de passe, le jeton de sécurité, la clé du client, le secret du consommateur et l'URL d'authentification, entrez les valeurs d'identification d'authentification que vous avez générées et téléchargées depuis votre compte Salesforce.

          Note

          Si vous utilisez Salesforce Developer Edition, utilisez https://login.salesforce.com/services/oauth2/token l'URL de connexion My Domain (par exemple, https ://MyCompany.my.salesforce.com) comme URL d'authentification. Si vous utilisez Salesforce Sandbox Edition, utilisez https://test.salesforce.com/services/oauth2/token l'URL de connexion My Domain (par exemple, MyDomainName-- SandboxName .sandbox.my.salesforce.com) comme URL d'authentification.

        3. Choisissez Enregistrer l'authentification.

    4. Virtual Private Cloud (VPC) —Vous pouvez choisir d'utiliser un VPC. Dans ce cas, vous devez ajouter des sous-réseaux et des groupes de sécurité VPC.

    5. Identity Crawler : spécifiez s'il faut activer l'explorateur Amazon Kendra d'identité. Le robot d'exploration d'identité utilise les informations de la liste de contrôle d'accès (ACL) de vos documents pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Si vous disposez d'une ACL pour vos documents et que vous choisissez de l'utiliser, vous pouvez également choisir d'activer le robot d'exploration Amazon Kendra d'identité pour configurer le filtrage des résultats de recherche par contexte utilisateur. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'exploration d'identité est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes afin de filtrer le contexte utilisateur.

    6. IAM rôle —Choisissez un IAM rôle existant ou créez-en un nouveau IAM pour accéder aux informations d'identification de votre référentiel et indexer le contenu.

      Note

      IAM les rôles utilisés pour les index ne peuvent pas être utilisés pour les sources de données. Si vous ne savez pas si un rôle existant est utilisé pour un index ou une FAQ, choisissez Créer un nouveau rôle pour éviter les erreurs.

    7. Choisissez Suivant.

  7. Sur la page Configurer les paramètres de synchronisation, entrez les informations suivantes :

    1. Pour analyser les pièces jointes : sélectionnez cette option pour analyser tous les objets Salesforce attachés.

    2. Pour les objets standard, les objets standard avec pièces jointes et les objets standard sans pièce jointe et articles de connaissances, sélectionnez les entités ou les types de contenu Salesforce que vous souhaitez analyser.

    3. Vous devez fournir des informations de configuration pour indexer au moins un objet standard, un article de connaissances ou un fil de discussion. Si vous choisissez d'explorer les articles de connaissances, vous devez spécifier les types d'articles de connaissances à indexer. Vous pouvez choisir les versions publiées, archivées, les brouillons et les pièces jointes.

      Filtre Regex : spécifiez un modèle d'expression régulière pour inclure des éléments de catalogue spécifiques.

  8. Pour une configuration supplémentaire :

    • Informations ACL Toutes les listes de contrôle d'accès sont incluses par défaut. La désélection d'une liste de contrôle d'accès rendra publics tous les fichiers de cette catégorie.

    • Modèles Regex : ajoutez des modèles d'expressions régulières pour inclure ou exclure certains fichiers. Vous pouvez ajouter jusqu'à 100 motifs.

    Mode de synchronisation : choisissez la manière dont vous souhaitez mettre à jour votre index lorsque le contenu de votre source de données change. Lorsque vous synchronisez votre source de données Amazon Kendra pour la première fois, tout le contenu est analysé et indexé par défaut. Vous devez exécuter une synchronisation complète de vos données en cas d'échec de la synchronisation initiale, même si vous ne choisissez pas l'option de synchronisation complète comme mode de synchronisation.

    • Synchronisation complète : Indexez tout le contenu fraîchement, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

    • Nouvelle synchronisation modifiée : Indexez uniquement le contenu nouveau et modifié chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

    • Synchronisation nouvelle, modifiée ou supprimée : Indexez uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  9. Choisissez Suivant.

  10. Sur la page Définir les mappages de champs, entrez les informations suivantes :

    1. Pour l'article de connaissance standard, les pièces jointes aux objets standard et les mappages de champs suggérés supplémentaires, sélectionnez parmi les champs de source de données par défaut Amazon Kendra générés que vous souhaitez mapper à votre index.

      Note

      Un index mappé à _document_body est requis. Vous ne pouvez pas modifier le mappage entre le Salesforce ID champ et le Amazon Kendra _document_id champ. Vous pouvez associer n'importe quel champ Salesforce au titre du document ou aux champs d'index réservés/par défaut d'Amazon Kendra.

      Si vous associez un champ Salesforce aux champs du titre et du corps du document Amazon Kendra, Amazon Kendra utilisera les données du titre et des champs du corps du document dans les réponses de recherche.

    2. Ajouter un champ —Pour ajouter des champs de source de données personnalisés afin de créer un nom de champ d'index à mapper et le type de données du champ.

    3. Choisissez Suivant.

  11. Sur la page Réviser et créer, vérifiez que les informations saisies sont correctes, puis sélectionnez Ajouter une source de données. Vous pouvez également choisir de modifier vos informations depuis cette page. Votre source de données apparaîtra sur la page Sources de données une fois que la source de données aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à Salesforce

Vous devez spécifier un JSON du schéma de source de données à l'aide de l'TemplateConfigurationAPI. Vous devez fournir les informations suivantes :

  • Source de données —Spécifiez le type de source de données tel que SALESFORCEV2 lorsque vous utilisez le schéma TemplateConfigurationJSON. Spécifiez également la source de données TEMPLATE lorsque vous appelez l'CreateDataSourceAPI.

  • URL de l'hôte : spécifiez l'URL de l'hôte de l'instance Salesforce.

  • Mode de synchronisation : spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Lorsque vous synchronisez votre source de données Amazon Kendra pour la première fois, tout le contenu est analysé et indexé par défaut. Vous devez exécuter une synchronisation complète de vos données en cas d'échec de la synchronisation initiale, même si vous ne choisissez pas l'option de synchronisation complète comme mode de synchronisation. Vous pouvez choisir entre :

    • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données se synchronise avec votre index.

    • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

    • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données se synchronise avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • Nom de ressource Amazon secret (ARN) : indiquez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification de votre compte Salesforce. Le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "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 —Spécifiez à quel RoleArn moment vous appelez CreateDataSource pour fournir à un IAM rôle les autorisations d'accéder à votre Secrets Manager secret et pour appeler les API publiques requises pour le connecteur Salesforce et Amazon Kendra. Pour plus d'informations, consultez la section IAM Rôles pour les sources de données Salesforce.

Vous pouvez également ajouter les fonctionnalités optionnelles suivantes :

  • Virtual Private Cloud (VPC) VpcConfiguration —Spécifiez le moment de votre appel. CreateDataSource Pour plus d’informations, consultez Configuration Amazon Kendra pour utiliser un Amazon VPC.

  • Filtres d'inclusion et d'exclusion : vous pouvez spécifier si vous souhaitez inclure ou exclure certains documents, comptes, campagnes, cas, contacts, prospects, opportunités, solutions, tâches, groupes, chatteurs et fichiers d'entités personnalisés.

    Note

    La plupart des sources de données utilisent des modèles d'expressions régulières, qui sont des modèles d'inclusion ou d'exclusion appelés filtres. Si vous spécifiez un filtre d'inclusion, seul le contenu correspondant au filtre d'inclusion est indexé. Tout document qui ne correspond pas au filtre d'inclusion n'est pas indexé. Si vous spécifiez un filtre d'inclusion et d'exclusion, les documents correspondant au filtre d'exclusion ne sont pas indexés, même s'ils correspondent au filtre d'inclusion.

  • Identity Crawler : spécifiez s'il faut activer l'explorateur Amazon Kendra d'identité. Le robot d'exploration d'identité utilise les informations de la liste de contrôle d'accès (ACL) de vos documents pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Si vous disposez d'une ACL pour vos documents et que vous choisissez de l'utiliser, vous pouvez également choisir d'activer le robot d'exploration Amazon Kendra d'identité pour configurer le filtrage des résultats de recherche par contexte utilisateur. Sinon, si le robot d'identification est désactivé, tous les documents peuvent être consultés publiquement. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'exploration d'identité est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes afin de filtrer le contexte utilisateur.

  • Mappages de champs : choisissez de mapper les champs de votre source de données Salesforce à vos champs d' Amazon Kendra index. Pour plus d'informations, veuillez consulter la rubrique Mappage des champs de source de données.

    Note

    Le champ du corps du document ou l'équivalent du corps du document pour vos documents est requis pour Amazon Kendra effectuer une recherche dans vos documents. Vous devez associer le nom du champ du corps du document dans votre source de données au nom du champ d'index_document_body. Tous les autres champs sont facultatifs.

    Note

    Un index mappé à _document_body est requis. Vous ne pouvez pas modifier le mappage entre le Salesforce ID champ et le Amazon Kendra _document_id champ. Vous pouvez associer n'importe quel champ Salesforce au titre du document ou aux champs d'index réservés/par défaut d'Amazon Kendra.

    Si vous associez un champ Salesforce aux champs du titre et du corps du document Amazon Kendra, Amazon Kendra utilisera les données du titre et des champs du corps du document dans les réponses de recherche.

Pour obtenir la liste des autres clés JSON importantes à configurer, consultez le schéma du modèle Salesforce.

En savoir plus

Pour en savoir plus sur l'intégration Amazon Kendra à votre source de données Salesforce, consultez :