View a markdown version of this page

Connecteur Salesforce V2.0 - Amazon Kendra

Amazon Kendra n'est plus ouvert aux nouveaux clients. Pour des fonctionnalités similaires à Amazon Kendra, explorez les bases de connaissances Amazon Bedrock. En 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 d’assistance, 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

Le V1.0 SalesforceConfiguration connecteur/API Salesforce a pris fin en 2023. Nous vous recommandons de migrer vers ou d'utiliser le V2.0 TemplateConfiguration connecteur/API Salesforce.

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 des utilisateurs

  • Inclusion/exclusion filtres

  • Synchronisation complète et incrémentielle du contenu

  • Cloud privé virtuel (VPC)

Conditions préalables

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

Note

Salesforce va retirer le Username-Password Flow dans la version d'hiver 2027. Nous vous recommandons d'utiliser le flux d'informations d'identification du client pour les nouvelles configurations afin d'éviter toute interruption future de votre connexion de données. Pour plus d'informations, consultez la section Retrait d'OAuth 2.0 Username-Password Flow pour les applications connectées dans la documentation Salesforce.

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

Pour le flux d'informations d'identification des clients (recommandé) :

  • Créez une application client externe dans Salesforce avec OAuth activé :

    1. Dans Configuration, choisissez Applications, App Manager, puis choisissez Nouvelle application cliente externe.

    2. Activez les champs d'application OAuth : gérez les données des utilisateurs via des API (API) et effectuez des requêtes à tout moment (refresh_token, offline_access).

    3. Dans la section Flux d'authentification et améliorations des applications clientes externes, activez le flux d'informations d'identification du client.

    4. Configurez un utilisateur Exécuter en tant qu'utilisateur pour le contexte d'exécution. Par exemple : Exécuter en tant que (nom d'utilisateur).

    5. Notez la clé Consumer (client_id) et le secret Consumer (client_secret).

  • Copiez l'URL de mon domaine de votre instance Salesforce (par exemple,https://<orgDomain>.my.salesforce.com). Pour trouver l'URL de votre domaine, dans Configuration, dans la zone Recherche rapide, saisissez Mon domaine, puis sélectionnez Mon domaine. Pour Client Credentials Flow, https://login.salesforce.com et ne https://test.salesforce.com sont pas pris en charge.

Pour Username-Password Flow (Legacy, obsolète depuis l'hiver 2027) :

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

  • J'ai copié le jeton de sécurité Salesforce associé au compte utilisé pour se connecter à Salesforce.

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

    Note

    Nous vous recommandons d’actualiser ou de modifier régulièrement vos informations d’identification et votre secret. Pour votre propre sécurité, fournissez uniquement le niveau d’accès nécessaire. 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).

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

  • Ajout d'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 se connecte.

Pour les deux flux :

  • Coché : chaque document est unique dans Salesforce et parmi 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 ID de document sont globaux pour un index et doivent être uniques par index.

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

  • A créé un Amazon Kendra index et, si vous utilisez l'API, en avez noté l'ID.

  • 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 à l'ID AWS Secrets Manager secret correct.

  • Vous avez enregistré vos informations d'authentification Salesforce dans un AWS Secrets Manager code 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 secret. Pour votre propre sécurité, fournissez uniquement le niveau d’accès nécessaire. 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 ID 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 voirConditions préalables.

Console

Pour vous connecter Amazon Kendra à Salesforce  :

  1. Connectez-vous à la Amazon Kendra console Console de gestion AWS 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 Paramètres d'index.

  3. Sur la page Mise en route, choisissez Ajouter une source de données.

  4. Sur la page Ajouter une source de données, choisissez le connecteur Salesforce, puis choisissez 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 un nom pour votre source de données. Vous pouvez inclure des tirets 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 en vue de l'index. Sauf indication contraire de votre part, 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 Tags, pour Ajouter une nouvelle étiquette  : 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 possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie 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 contextuel des utilisateurs.

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

      1. Authentification : choisissez votre type d'authentification :

        • Flux d'informations d'identification du client (recommandé)  : utilise uniquement client_id et client_secret pour les intégrations de serveur à serveur.

        • Username-Password Flow (Legacy)  : utilise le nom d'utilisateur, le mot de passe, le jeton de sécurité, la clé du consommateur et le secret du consommateur. Obsolète par Salesforce à l'hiver 2027.

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

      3. Pour le flux d'informations d'identification des clients :

        • Clé du consommateur  : identifiant du client provenant de votre application client externe Salesforce

        • Secret du consommateur  : secret client provenant de votre application client externe Salesforce

        • URL d'authentification  : URL de votre domaine (par exemple, https://<orgDomain>.my.salesforce.com/services/oauth2/token).

          Note

          https://login.salesforce.comet ne https://test.salesforce.com sont pas pris en charge pour ce flux.

      4. Pour Username-Password Flow :

        • Nom d'utilisateur  : votre nom d'utilisateur d'administrateur Salesforce

        • Mot de passe  : votre mot de passe administrateur Salesforce

        • Jeton de sécurité : jeton de sécurité pour votre compte Salesforce

        • Clé du consommateur  : identifiant client de votre application Salesforce Connected

        • Secret du consommateur  : secret client provenant de votre application Salesforce Connected

        • URL d'authentification  : pour Salesforce Developer Edition, utilisez https://login.salesforce.com/services/oauth2/token ou votre URL de connexion My Domain (par exemple). https://MyCompany.my.salesforce.com Pour Salesforce Sandbox Edition, utilisez https://test.salesforce.com/services/oauth2/token ou votre URL de connexion My Domain (par exemple, MyDomainName--SandboxName.sandbox.my.salesforce.com).

      5. Choisissez Enregistrer l'authentification.

    4. Virtual Private Cloud (VPC)  : vous pouvez choisir d'utiliser un VPC. Si c'est le cas, vous devez ajouter des sous-réseaux et des groupes de sécurité VPC.

    5. Identity crawler  : indiquez si vous souhaitez activer le robot Amazon Kendra d'identification. Le robot d'identification 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 d'utiliser votre ACL, vous pouvez également choisir d'activer le robot Amazon Kendra d'identification pour configurer le filtrage contextuel des résultats de recherche par utilisateur. Sinon, si le robot d’identité est désactivé, tous les documents peuvent faire l’objet d’une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification 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 joints.

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

    3. Vous devez fournir des informations de configuration pour indexer au moins un objet standard, des articles de connaissances ou des fils de membres de la 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 documents publiés, archivés, les brouillons et les pièces jointes.

      Filtre Regex  : spécifiez un modèle regex 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 modèles.

    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 si votre synchronisation initiale a échoué, même si vous n'avez pas sélectionné la synchronisation complète comme mode de synchronisation.

    • Synchronisation complète : indexez récemment tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

    • Synchronisation nouvelle et modifiée : indexez uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée 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 des contenus nouveaux, modifiés et supprimés : indexez uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée 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 connaissances standard, les pièces jointes aux objets standard et les mappages de champs supplémentaires suggérés  : 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 mappage d'index vers _document_body est requis. Vous ne pouvez pas modifier le mappage entre le champ Salesforce ID et le champ Amazon Kendra _document_id . Vous pouvez mapper n'importe quel champ Salesforce au titre du document ou aux champs d' reserved/default index Amazon Kendra du corps du document.

      Si vous associez un champ Salesforce aux champs du titre et du corps du document Amazon Kendra, Amazon Kendra utilisera les données des champs du titre et 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 que vous avez 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 comme SALESFORCEV2 lorsque vous utilisez le schéma TemplateConfiguration JSON. Spécifiez également la source de données comme 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  : indiquez 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 si votre synchronisation initiale a échoué, même si vous n'avez pas sélectionné la 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 est synchronisée avec votre index.

    • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée 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 est synchronisée 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 RoleArn quand vous appelez CreateDataSource pour fournir un IAM rôle autorisé à accéder à votre Secrets Manager secret et à 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)  : spécifiez VpcConfiguration quand vous appelez. CreateDataSource Pour de plus amples informations, veuillez consulter 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, dossiers, contacts, prospects, opportunités, solutions, tâches, groupes, discussions 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 qui correspondent au filtre d'exclusion ne sont pas indexés, même s'ils correspondent au filtre d'inclusion.

  • Identity crawler  : indiquez si vous souhaitez activer le robot Amazon Kendra d'identification. Le robot d'identification 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 d'utiliser votre ACL, vous pouvez également choisir d'activer le robot Amazon Kendra d'identification pour configurer le filtrage contextuel des résultats de recherche par utilisateur. Sinon, si le robot d’identité est désactivé, tous les documents peuvent faire l’objet d’une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification 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 Amazon Kendra champs d'index. Pour plus d’informations, consultez 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 obligatoire pour Amazon Kendra effectuer une recherche dans vos documents. Vous devez associer le nom du champ du corps de votre document dans votre source de données au nom du champ d'index_document_body. Tous les autres champs sont facultatifs.

    Note

    Un mappage d'index vers _document_body est requis. Vous ne pouvez pas modifier le mappage entre le champ Salesforce ID et le champ Amazon Kendra _document_id . Vous pouvez mapper n'importe quel champ Salesforce au titre du document ou aux champs d' reserved/default index Amazon Kendra du corps du document.

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

Pour obtenir la liste des autres clés JSON importantes à configurer, consultez la section 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 :

Remarques

  • Lorsque les listes de contrôle d'accès (ACL) sont activées, l'option « Synchroniser uniquement le contenu nouveau ou modifié » n'est pas disponible en raison des limites de l'API Salesforce. Nous vous recommandons d’utiliser plutôt les modes « Synchronisation complète » ou « Synchronisation du contenu nouveau, modifié ou supprimé », ou de désactiver les listes ACL si vous devez utiliser ce mode de synchronisation.