View a markdown version of this page

ServiceNow connecteur 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.

ServiceNow connecteur V2.0

ServiceNow fournit un système de gestion des services basé sur le cloud pour créer et gérer des flux de travail au niveau de l'organisation, tels que les services informatiques, les systèmes de billetterie et le support. Vous pouvez les utiliser Amazon Kendra pour indexer vos ServiceNow catalogues, vos articles de connaissances, vos incidents et leurs pièces jointes.

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

Fonctionnalités prises en charge

Amazon Kendra ServiceNow le connecteur de source de données 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

  • ServiceNow versions d'instance : Rome, Sandiego, Tokyo, Autres

  • Cloud privé virtuel (VPC)

Conditions préalables

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

Dans ServiceNow, assurez-vous d'avoir :

  • créé une instance de développeur personnelle ou d’entreprise et disposer d’une instance ServiceNow dotée d’un rôle administratif ;

  • J'ai copié l'URL de l'hôte de votre ServiceNow instance. Le format de l'URL de l'hôte que vous entrez estyour-domain.service-now.com. Vous avez besoin de l’URL de votre instance ServiceNow pour vous connecter à Amazon Kendra ;

  • Notez vos informations d'authentification de base, à savoir un nom d'utilisateur et un mot de passe, Amazon Kendra pour vous permettre de vous connecter à votre ServiceNow instance.

    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).

  • Facultatif : informations d'identification du client OAuth 2.0 configurées qui peuvent s'identifier Amazon Kendra à l'aide d'un nom d'utilisateur, d'un mot de passe, d'un ID client généré et d'un secret client. Consultez ServiceNow la documentation sur l'authentification OAuth 2.0 pour plus d'informations.

  • Les autorisations suivantes ont été ajoutées :

    • kb_category

    • kb_knowledge

    • kb_knowledge_base

    • kb_uc_cannot_read_mtom

    • kb_uc_can_read_mtom

    • sc_catalog

    • catégorie_sc

    • sc_cat_item

    • sys_attachment

    • sys_attachment_doc

    • rôle_utilisateur_sys

  • Coché : chaque document est unique dans ServiceNow et entre 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' ServiceNow authentification 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 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 ServiceNow données à 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 ServiceNow données, vous devez fournir les informations nécessaires sur votre source de ServiceNow données afin que celle-ci Amazon Kendra puisse accéder à vos données. Si vous n'avez pas encore configuré ServiceNow pour Amazon Kendra voirConditions préalables.

Console

Pour vous connecter Amazon Kendra à ServiceNow

  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 ServiceNow connecteur, puis choisissez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le ServiceNow connecteur 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 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 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. ServiceNow host —Entrez l'URL de l' ServiceNowhôte. Le format de l'URL de l'hôte que vous entrez estyour-domain.service-now.com.

    2. ServiceNow version  : sélectionnez la version de votre ServiceNow instance. Vous pouvez choisir entre Rome, Sandiego, Tokyo ou autres.

    3. 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.

    4. Authentification  : choisissez entre l'authentification de base et l'authentification Oauth 2.0.

    5. AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager pour stocker vos informations ServiceNow d'authentification. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre. Saisissez les informations suivantes dans la fenêtre :

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

      2. Si vous utilisez l'authentification de base, entrez le nom secret, le nom d'utilisateur et le mot de passe de votre compte. ServiceNow

        Si vous utilisez l' OAuth2.0 authentification : entrez le nom secret, le nom d'utilisateur, le mot de passe , l'ID client et le code secret client que vous avez créés dans votre compte. ServiceNow

      3. Enregistrez et ajoutez votre secret.

    6. 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.

    7. 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.

    8. 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.

    9. Choisissez Suivant.

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

    1. Pour les Articles de connaissances, choisissez l’une des options suivantes :

      • Articles de connaissances  : choisissez d'indexer les articles de connaissances.

      • Pièces jointes aux articles de connaissances  : choisissez d'indexer les pièces jointes aux articles de connaissances.

      • Type d'articles de connaissances  : choisissez entre uniquement les articles publics et les articles de connaissances en fonction d'une requête de ServiceNow filtre basée sur votre cas d'utilisation. Si vous sélectionnez Inclure les articles en fonction d'une requête de ServiceNow filtre, vous devez saisir une requête de filtre copiée depuis votre ServiceNow compte. Les exemples de requêtes de filtre incluent :workflow_state=draft^EQ,kb_knowledge_base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ,article_type=text^active=true^EQ.

        Important

        Si vous choisissez d'explorer uniquement les articles publics, Amazon Kendra analyse uniquement les articles de connaissances auxquels un rôle d'accès public a été attribué. ServiceNow

      • Inclure des articles en fonction d'un filtre de description courte  : spécifiez des modèles d'expressions régulières pour inclure ou exclure des articles spécifiques.

    2. Pour les Éléments du catalogue de services :

      • Éléments du catalogue de services  : choisissez d'indexer les éléments du catalogue de services.

      • Pièces jointes aux éléments du catalogue de services  : choisissez d'indexer les pièces jointes aux éléments du catalogue de services.

      • Éléments du catalogue de services actifs  : choisissez d'indexer les éléments du catalogue de services actifs.

      • Éléments du catalogue de services inactifs  : choisissez d'indexer les éléments inactifs du catalogue de services.

      • Requête de filtre  : choisissez d'inclure des éléments du catalogue de services en fonction d'un filtre défini dans votre ServiceNow instance. Les exemples de requêtes de filtre incluent :short_descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ,nameSTARTSWITHService^active=true^EQ.

      • Inclure les éléments du catalogue de services en fonction d'un filtre de description courte  : spécifiez un modèle d'expression régulière pour inclure des éléments de catalogue spécifiques.

    3. Pour les Incidents :

      • Incidents  : choisissez d'indexer les incidents de service.

      • Pièces jointes aux incidents  : choisissez d'indexer les pièces jointes aux incidents.

      • Incidents actifs  : choisissez d'indexer les incidents actifs.

      • Incidents inactifs  : choisissez d'indexer les incidents inactifs.

      • Type d'incident actif  : choisissez entre Tous les incidents, Incidents ouverts, Incidents ouverts - incidents non attribués et Incidents résolus en fonction de votre cas d'utilisation.

      • Requête de filtre  : choisissez d'inclure les incidents en fonction d'un filtre défini dans votre ServiceNow instance. Les exemples de requêtes de filtre incluent :short_descriptionLIKETest^urgency=3^state=1^EQ,priority=2^category=software^EQ .

      • Inclure les incidents en fonction d'un filtre de description courte  : spécifiez un modèle d'expression régulière pour inclure des incidents spécifiques.

    4. Pour une configuration supplémentaire  :

      • Informations ACL  : les listes de contrôle d'accès pour les entités que vous avez sélectionnées 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. Les options ACL sont automatiquement désactivées pour les entités non sélectionnées. Pour les articles publics, l'ACL n'est pas appliquée.

      • Pour Taille de fichier maximale  : spécifiez la limite de taille de fichier en Mo qu'Amazon Kendra analysera. Amazon Kendra analysera uniquement les fichiers dont la taille ne dépasse pas la limite que vous avez définie. La taille de fichier par défaut est de 50 Mo. La taille de fichier maximale doit être supérieure à 0 Mo et inférieure ou égale à 50 Mo.

      • Modèles de regex de pièces jointes  : ajoutez des modèles d'expressions régulières pour inclure ou exclure certains fichiers joints de catalogues, d'articles de connaissances et d'incidents. Vous pouvez ajouter jusqu’à 100 modèles.

    5. 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 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.

    6. Dans Synchroniser le calendrier d'exécution, pour Fréquence  : choisissez la fréquence à laquelle vous souhaitez synchroniser le contenu de votre source de données et mettre à jour votre index.

    7. Choisissez Suivant.

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

    1. Mappages de champs par défaut  : 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.

    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.

  9. 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 à ServiceNow

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 SERVICENOWV2 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 la version de l'instance ServiceNow hôte. Par exemple, your-domain.service-now.com.

  • Type d'authentification  : spécifiez le type d'authentification que vous utilisez, que ce soit basicAuth ou OAuth2 pour votre ServiceNow instance.

  • ServiceNow version de l'instance  : spécifiez l' ServiceNow instance que vous utilisezTokyo, que ce soit SandiegoRome, ouOthers.

  • 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.

  • Nom de ressource Amazon secret (ARN)  : indiquez le nom de ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification que vous avez créées dans votre ServiceNow compte.

    Si vous utilisez l'authentification de base, le secret est stocké dans une structure JSON avec les clés suivantes :

    { "username": "user name", "password": "password" }
  • Si vous utilisez les informations d'identification du client OAuth2, le secret est stocké dans une structure JSON avec les clés suivantes :

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
  • 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 ServiceNow connecteur et Amazon Kendra. Pour plus d'informations, consultez la section IAM Rôles pour les sources de ServiceNow données.

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 fichiers joints à l'aide des noms de fichiers et des types de fichiers des articles de connaissances, des catalogues de services et des incidents.

    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.

  • Documents spécifiques à indexer  : vous pouvez utiliser une ServiceNow requête pour spécifier les documents que vous souhaitez trouver dans une ou plusieurs bases de connaissances, y compris des bases de connaissances privées. L'accès aux bases de connaissances est déterminé par l'utilisateur que vous utilisez pour vous connecter à l' ServiceNow instance. Pour plus d'informations, veuillez consulter la rubrique Spécification des documents à indexer avec une requête.

  • Paramètres d'indexation  : vous pouvez également choisir de spécifier si vous souhaitez :

    • Indexez les articles de connaissances, les catalogues de services et les incidents, ou tous ces éléments. Si vous choisissez d'indexer les articles de connaissances, les éléments du catalogue de services et les incidents, vous devez fournir le nom du ServiceNow champ qui est mappé au champ de contenu du document d'index dans l' Amazon Kendra index.

    • Indexez les pièces jointes aux articles de connaissances, aux éléments du catalogue de services et aux incidents.

    • Incluez des articles de connaissances, des éléments du catalogue de services et des incidents en fonction du modèle de short description filtre.

    • Choisissez de filtrer les articles et les incidents actifs et inactifs du catalogue de services.

    • Choisissez de filtrer les incidents en fonction de leur type.

    • Choisissez les entités dont l'ACL doit être analysée.

    • Vous pouvez utiliser une ServiceNow requête pour spécifier les documents que vous souhaitez obtenir à partir d'une ou de plusieurs bases de connaissances, y compris des bases de connaissances privées. L'accès aux bases de connaissances est déterminé par l'utilisateur que vous utilisez pour vous connecter à l' ServiceNowinstance. Pour plus d'informations, veuillez consulter la rubrique Spécification des documents à indexer avec une requête.

  • 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 vos champs de source de ServiceNow données à vos champs d' Amazon Kendra 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.

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

En savoir plus

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