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

Alfresco

Alfrescoest un service de gestion de contenu qui aide les clients à stocker et à gérer leur contenu. Vous pouvez l'utiliser Amazon Kendra pour indexer votre bibliothèque de Alfresco documents, votre wiki et votre blog.

Amazon Kendra prend en charge les services Alfresco sur site et Alfresco dans le cloud (plateforme en tant que service).

Vous pouvez vous connecter Amazon Kendra à votre source de Alfresco données à l'aide de la Amazon Kendra console ou de l'TemplateConfigurationAPI.

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

Fonctionnalités prises en charge

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

  • OAuth 2.0 et authentification de base

  • Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir l'utiliser Amazon Kendra pour indexer votre source de données Alfresco, apportez ces modifications dans votre Alfresco fichier et. Comptes AWS

DansAlfresco, assurez-vous d'avoir :

  • Vous avez copié l'URL de votre Alfresco référentiel et l'URL de votre application Web. Si vous souhaitez uniquement indexer un Alfresco site spécifique, copiez également l'ID du site.

  • Notez vos informations Alfresco d'authentification, qui incluent un nom d'utilisateur et un mot de passe avec au moins des autorisations de lecture. Si vous souhaitez utiliser l'authentification OAuth 2.0, vous devez ajouter l'utilisateur au groupe des Alfresco administrateurs.

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

  • Facultatif : informations d'identification OAuth 2.0 configurées dans. Alfresco Les informations d'identification incluent l'identifiant du client, le secret du client et l'URL du jeton. Pour plus d'informations sur la configuration des clients sur Alfresco site, consultez la documentation Alfresco. Si vous utilisez Alfresco le Cloud (PaaS), vous devez contacter le support Hyland pour l'Alfrescoauthentification OAuth 2.0.

  • Il est vérifié que chaque document est unique dans Alfresco 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 identifiants d'authentification Alfresco 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 Alfresco à. 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 Alfresco, vous devez fournir les informations nécessaires à votre source de données Alfresco afin de Amazon Kendra pouvoir accéder à vos données. Si vous n'avez pas encore configuré Alfresco pour Amazon Kendra, consultez. Prérequis

Console

Pour vous connecter Amazon Kendra à Alfresco

  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 Alfresco, puis sélectionnez Ajouter un connecteur. Si vous utilisez la version 2 (le cas échéant), choisissez le connecteur Alfresco avec le tag « 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 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 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. Alfrescotype —Choisissez si vous utilisez Alfresco sur place/serveur ou dans le Alfresco cloud (plate-forme en tant que service).

    2. URL du dépôt Alfresco : entrez l'URL de votre référentiel Alfresco. Par exemple, si vous utilisez Alfresco le Cloud (PaaS), l'URL du référentiel peut être https://company.alfrescocloud.com. Ou, si vous utilisez Alfresco On-Premises, l'URL du référentiel peut être. https://company-alfresco-instance.company-domain.suffix:port

    3. Application utilisateur Alfresco. URL —Entrez l'URL de votre interface Alfresco utilisateur. Vous pouvez obtenir l'URL du dépôt auprès de votre Alfresco administrateur. Par exemple, l'URL de l'interface utilisateur peut être https://example.com.

    4. Emplacement du certificat SSL : entrez le chemin d'accès au certificat SSL stocké dans un Amazon S3 compartiment. Vous l'utilisez pour vous connecter à Alfresco On-Premises avec une connexion SSL sécurisée.

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

    6. Authentification —Choisissez l'authentification de base ou l'authentification OAuth 2.0. Choisissez ensuite un Secrets Manager secret existant ou créez-en un nouveau pour stocker vos Alfresco informations d'identification. Si vous choisissez de créer un nouveau secret, une fenêtre AWS Secrets Manager secrète s'ouvre.

      Si vous avez choisi l'authentification de base, entrez le nom du secret, le nom Alfresco d'utilisateur et le mot de passe.

      Si vous avez choisi l'authentification OAuth 2.0, entrez un nom pour le secret, l'ID client, le secret client et l'URL du jeton.

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

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

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

    10. Choisissez Suivant.

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

    1. Étendue de synchronisation : définissez des limites pour l'exploration de certains contenus et filtrez le contenu à l'aide de modèles d'expression regex.

      1. Contenu : choisissez d'explorer le contenu marqué d'un « Aspects »Alfresco, le contenu d'un Alfresco site spécifique ou le contenu de tous vos Alfresco sites.

      2. (Facultatif) Configuration supplémentaire : définissez les paramètres suivants :

        • Inclure les commentaires : choisissez d'inclure les commentaires dans la bibliothèque de Alfresco documents et le blog.

        • Modèles Regex : modèles d'expressions régulières permettant d'inclure ou d'exclure certains fichiers.

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

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

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

    5. Choisissez Suivant.

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

    1. 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. Pour ajouter des champs de source de données personnalisés, créez 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 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 à Alfresco

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 ALFRESCO lorsque vous utilisez le schéma TemplateConfigurationJSON. Spécifiez également la source de données TEMPLATE lorsque vous appelez l'CreateDataSourceAPI.

  • AlfrescoID du site —Spécifiez l'ID du site Alfresco.

  • AlfrescoURL du référentiel : spécifiez l'URL du Alfresco référentiel. Vous pouvez obtenir l'URL du dépôt auprès de votre Alfresco administrateur. Par exemple, si vous utilisez Alfresco le Cloud (PaaS), l'URL du référentiel peut être https://company.alfrescocloud.com. Ou, si vous utilisez Alfresco On-Premises, l'URL du référentiel peut être. https://company-alfresco-instance.company-domain.suffix:port

  • AlfrescoURL de l'application Web —Spécifiez l'URL de Alfresco l'interface utilisateur. Vous pouvez obtenir l'URL du dépôt auprès de votre Alfresco administrateur. Par exemple, l'URL de l'interface utilisateur peut être https://example.com.

  • Type d'authentification : spécifiez le type d'authentification que vous souhaitez utiliser, que ce soit OAuth2 ouBasic.

  • Alfrescotype —Spécifiez le type que Alfresco vous utilisez, que ce soit PAAS (Cloud/Plateforme en tant que service) ou ON_PREM (sur site).

  • Nom de ressource Amazon secret (ARN) : si vous souhaitez utiliser l'authentification de base, vous devez fournir un secret qui stocke vos informations d'authentification, à savoir votre nom d'utilisateur et votre mot de passe. Vous fournissez le Amazon Resource Name (ARN) d'un AWS Secrets Manager secret. Le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "username": "user name",
    "password": "password"
}

    Si vous souhaitez utiliser l'authentification OAuth 2.0, le secret est stocké dans une structure JSON avec les clés suivantes :

    {
    "clientId": "client ID",
    "clientSecret": "client secret",
    "tokenUrl": "token URL"
}

  • 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 Alfresco et. Amazon Kendra Pour plus d'informations, consultez la section IAM Rôles des sources de données Alfresco.

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.

  • Type de contenu : le type de contenu que vous souhaitez explorer, qu'il s'agisse du contenu marqué d'un « Aspects » dans le champ « Aspects »Alfresco, du contenu d'un Alfresco site spécifique ou du contenu de tous vos Alfresco sites. Vous pouvez également répertorier du contenu « Aspects » spécifique.

  • Filtres d'inclusion et d'exclusion : spécifiez si vous souhaitez inclure ou exclure certains fichiers.

    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.

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

  • 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 Identity Crawler 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 Alfresco à vos champs d'index. Amazon Kendra 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.

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

En savoir plus

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