SharePoint connecteur V1.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.

SharePoint connecteur V1.0

SharePoint est un service collaboratif de création de sites Web que vous pouvez utiliser pour personnaliser le contenu Web et créer des pages, des sites, des bibliothèques de documents et des listes. Si vous êtes un SharePoint utilisateur, vous pouvez utiliser Amazon Kendra pour indexer votre source SharePoint de données.

Note

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

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

Fonctionnalités prises en charge

  • Mappages de champs

  • Contrôle d'accès des utilisateurs

  • Filtres d'inclusion/exclusion

  • Journal des modifications

  • Cloud privé virtuel (VPC)

Prérequis

Avant de pouvoir utiliser Amazon Kendra pour indexer votre source de SharePoint données, apportez ces modifications dans votre SharePoint AWS comptes.

Vous devez fournir des informations d'authentification, que vous stockez en toute sécurité dans un AWS Secrets Manager 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).

Dans SharePoint, assurez-vous d'avoir :

  • Notez URL les SharePoint sites que vous souhaitez indexer.

  • Pour SharePoint en ligne :

    • Vous avez noté vos informations d'authentification de base contenant un nom d'utilisateur et un mot de passe avec des autorisations d'administrateur du site.

    • Facultatif : informations d'identification OAuth 2.0 générées contenant un nom d'utilisateur, un mot de passe, un identifiant client et un secret client.

    • Paramètres de sécurité par défaut désactivés sur votre portail Azure à l'aide d'un utilisateur administratif. Pour plus d'informations sur la gestion des paramètres de sécurité par défaut sur le portail Azure, consultez la documentation Microsoft sur la façon d'activer/désactiver les paramètres de sécurité par défaut.

  • Pour le SharePoint serveur :

    • Vous avez noté le nom de domaine de votre SharePoint serveur (le BIOS nom réseau dans votre Active Directory). Vous l'utilisez, ainsi que votre nom d'utilisateur et votre mot de passe d'authentification de SharePoint base, pour connecter le SharePoint serveur à Amazon Kendra.

    Note

    Si vous utilisez SharePoint Server et que vous devez convertir votre liste de contrôle d'accès (ACL) au format e-mail pour filtrer en fonction du contexte utilisateur, fournissez le LDAP serveur URL et la base LDAP de recherche. Vous pouvez également utiliser le remplacement du domaine de l'annuaire. Le LDAP serveur URL est le nom de domaine complet et le numéro de port (par exemple, ldap : //example.com:389). La base LDAP de recherche est constituée des contrôleurs de domaine « example » et « com ». Avec le remplacement du domaine de l'annuaire, vous pouvez utiliser le domaine de messagerie au lieu d'utiliser le LDAP serveur URL et la base LDAP de recherche. Par exemple, le domaine de messagerie pour username@example.com est « exemple.com ». Vous pouvez utiliser cette dérogation si la validation de votre domaine ne vous préoccupe pas et si vous souhaitez simplement utiliser votre domaine de messagerie.

  • Vous avez ajouté les autorisations suivantes à votre SharePoint compte :

    Pour les SharePoint listes

    • Éléments ouverts : affichez la source des documents à l'aide des gestionnaires de fichiers côté serveur.

    • Afficher les pages de candidature : affichez les formulaires, les vues et les pages de candidature. Énumérez des listes.

    • Afficher les éléments : affichez les éléments dans les listes et les documents dans les bibliothèques de documents.

    • Afficher les versions : permet d'afficher les versions précédentes d'un élément de liste ou d'un document.

    Pour les SharePoint sites Web

    • Parcourir les répertoires : énumère les fichiers et les dossiers d'un site Web à l'aide de SharePoint Designer et de l'interface Web. DAV

    • Parcourir les informations utilisateur : affichez les informations sur les utilisateurs du site Web.

    • Énumérer les autorisations : énumère les autorisations sur le site Web, la liste, le dossier, le document ou l'élément de liste.

    • Ouvrir : ouvrez un site Web, une liste ou un dossier pour accéder aux éléments contenus dans le conteneur.

    • Utiliser les fonctionnalités d'intégration du client : utilisez le Web SOAPDAV, le modèle d'objet client ou les interfaces SharePoint Designer pour accéder au site Web.

    • Utiliser des interfaces distantes : utilisez des fonctionnalités qui lancent des applications clientes.

    • Afficher les pages : affiche les pages d'un site Web.

  • Il est vérifié que chaque document est unique dans SharePoint 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. IDsLes documents sont globaux par rapport à 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 leAPI, notez l'identifiant de l'index.

  • A créé un IAM rôle pour votre source de données et, si vous utilisez leAPI, notez le ARN 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 AWS Secrets Manager identifiant secret.

  • Vous avez stocké vos informations d' SharePoint authentification dans un AWS Secrets Manager secret et, si vous utilisez leAPI, notez le 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'en avez pas déjà IAM rôle ou secret, vous pouvez utiliser la console pour créer un nouveau IAM rôle et Secrets Manager secret lorsque vous connectez votre source SharePoint de données à Amazon Kendra. Si vous utilisez leAPI, vous devez fournir le ARN IAM rôle et Secrets Manager secret et un identifiant d'index.

Instructions de connexion

Pour vous connecter Amazon Kendra à votre source de SharePoint données, vous devez fournir les détails de vos SharePoint informations d'identification afin que Amazon Kendra peuvent accéder à vos données. Si vous n'avez pas encore configuré SharePoint pour Amazon Kendra voir Prérequis.

Console

Pour vous connecter Amazon Kendra à SharePoint

  1. Connectez-vous au AWS Console de gestion et ouvrez le Amazon Kendra console.

  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 SharePoint connecteur v1.0, puis sélectionnez Ajouter une source de données.

  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 votre AWS coûts.

    5. Choisissez Suivant.

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

    1. Pour la méthode d'hébergement : choisissez entre SharePoint Online et SharePointServer.

      1. Pour SharePointen ligne —Entrez le site URLs spécifique à votre SharePoint référentiel.

      2. Pour le SharePointserveur : choisissez votre SharePoint version, entrez le site URLs spécifique à votre SharePoint référentiel, puis entrez le Amazon S3 chemin d'accès à l'emplacement SSL de votre certificat.

    2. (SharePoint Serveur uniquement) Pour le proxy Web : entrez le nom d'hôte et le numéro de port de votre SharePoint instance interne. Le numéro de port doit être une valeur numérique comprise entre 0 et 65535.

    3. Pour l'authentification : choisissez l'une des options suivantes en fonction de votre cas d'utilisation :

      1. Pour SharePoint en ligne : choisissez entre l'authentification de base et l'authentification OAuth 2.0.

      2. Pour le SharePoint serveur : choisissez entre Aucun et LDAPManuel.

    4. Pour AWS Secrets Manager secret —Choisissez un secret existant ou créez-en un nouveau Secrets Manager secret pour stocker vos informations SharePoint d'authentification. Si vous choisissez de créer un nouveau secret, AWS Secrets Manager une fenêtre secrète s'ouvre. Vous devez saisir un nom secret. Le préfixe « AmazonKendra - SharePoint - » est automatiquement ajouté à votre nom secret.

    5. Entrez les autres informations suivantes dans le champ Créer un AWS Secrets Manager fenêtre secrète  :

      1. Choisissez parmi les options d'authentification SharePoint dans le cloud suivantes, en fonction de votre cas d'utilisation :

        1. Authentification de base —Entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur et le mot de passe du SharePoint compte comme mot de passe.

        2. OAuthAuthentification 2.0 —Entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe du SharePoint compte comme mot de passe, votre SharePoint identifiant unique généré automatiquement comme identifiant client et la chaîne secrète partagée utilisée par les deux et SharePoint Amazon Kendra en tant que secret client.

      2. Choisissez l'une des options d'authentification SharePoint du serveur suivantes, en fonction de votre cas d'utilisation :

        1. Aucun : entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe de votre SharePoint compte comme mot de passe et le nom de domaine de votre serveur.

        2. LDAP—Entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe du SharePoint compte comme mot de passe, le point de terminaison de votre LDAP serveur (y compris le protocole et le numéro de port, par exemple) ldap://example.com:389), et votre base LDAP de recherche (par exemple, dc=example, dc=com).

        3. Manuel —Entrez le nom d'utilisateur de votre SharePoint compte comme nom d'utilisateur, le mot de passe de votre SharePoint compte comme mot de passe et votre remplacement de domaine de messagerie (domaine de messagerie de l'utilisateur ou du groupe de l'annuaire).

      3. Choisissez Save (Enregistrer).

    6. Cloud privé virtuel (VPC) : vous devez également ajouter des sous-réseaux et des groupes VPC de sécurité.

      Note

      Vous devez utiliser un VPC si vous utilisez un SharePoint serveur. Amazon VPC est facultatif pour les autres SharePoint versions.

    7. IAM rôle —Choisissez un rôle existant IAM rôle ou création d'un nouveau IAM rôle pour accéder aux informations d'identification de votre référentiel et au contenu de l'index.

      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 indexFAQ, choisissez Créer un nouveau rôle pour éviter les erreurs.

    8. Choisissez Suivant.

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

    1. Utiliser le journal des modifications : sélectionnez cette option pour mettre à jour votre index au lieu de synchroniser tous vos fichiers.

    2. Analyser les pièces jointes : sélectionnez cette option pour analyser les pièces jointes.

    3. Utiliser des mappages de groupes locaux : sélectionnez cette option pour vous assurer que les documents sont correctement filtrés.

    4. Configuration supplémentaire —Ajoutez des modèles d'expressions régulières pour inclure ou exclure certains fichiers. Vous pouvez ajouter jusqu'à 100 motifs.

    5. Calendrier d'exécution synchronisé pour Frequency —À quelle fréquence Amazon Kendra se synchronisera avec votre source de données.

    6. Choisissez Suivant.

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

    1. Amazon Kendra mappages de champs par défaut —Sélectionnez parmi les Amazon Kendra champs de source de données par défaut générés que vous souhaitez mapper à votre index.

    2. Pour les mappages de champs personnalisés : ajoutez des champs de source de données personnalisés pour créer un nom de champ d'index auquel 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 qu'elle aura été ajoutée avec succès.

API

Pour vous connecter Amazon Kendra à SharePoint

Vous devez spécifier les éléments suivants à l'aide de SharePointConfigurationAPI:

  • SharePointVersion : spécifiez la SharePoint version que vous utilisez lors de la configuration SharePoint. C'est le cas, que vous utilisiez SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 ou SharePoint Online.

  • Nom secret de la ressource Amazon (ARN) : indiquez le nom de la ressource Amazon (ARN) d'un Secrets Manager secret contenant les informations d'authentification que vous avez créées dans votre SharePoint compte. Le secret est stocké dans une JSON structure.

    Pour l'authentification de base SharePoint en ligne, voici la JSON structure minimale qui doit figurer dans votre secret :

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

    Pour l'authentification SharePoint en ligne OAuth 2.0, voici la JSON structure minimale qui doit figurer dans votre secret :

    {
    "userName": "SharePoint account user name"",
    "password": "SharePoint account password",
    "clientId": "SharePoint auto-generated unique client id",
    "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
}

    Pour l'authentification de base du SharePoint serveur, voici la JSON structure minimale qui doit figurer dans votre secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
}

    Pour LDAPl'authentification SharePoint du serveur (si vous devez convertir votre liste de contrôle d'accès (ACL) au format e-mail pour filtrer le contexte utilisateur, vous pouvez inclure le LDAP serveur URL et la base de LDAP recherche dans votre secret), voici la JSON structure minimale qui doit figurer dans votre secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
    "ldapServerUrl": "ldap://example.com:389",
    "ldapSearchBase": "dc=example,dc=com"
}

    Pour l'authentification manuelle du SharePoint serveur, voici la JSON structure minimale qui doit figurer dans votre secret :

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name",
    "emailDomainOverride": "example.com"
}

  • IAM role —Spécifiez le RoleArn moment où vous appelez CreateDataSource pour fournir un IAM rôle autorisé à accéder à votre Secrets Manager secret et pour appeler le public requis APIs pour le SharePoint connecteur et Amazon Kendra Pour de plus amples informations, veuillez consulter .IAM rôles pour les sources SharePoint de données.

  • Amazon VPC—Si vous utilisez SharePoint Server, spécifiez-le dans VpcConfiguration le cadre de la configuration de la source de données. Voir Configuration Amazon Kendra pour utiliser un VPC.

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

  • Proxy Web : s'il faut se connecter à votre SharePoint site URLs via un proxy Web. Vous ne pouvez utiliser cette option que pour le SharePoint serveur.

  • Listes d'indexation : si Amazon Kendra doit indexer le contenu des pièces jointes pour SharePoint répertorier les éléments.

  • Journal des modifications —Si Amazon Kendra doit utiliser le mécanisme du journal des modifications SharePoint des sources de données pour déterminer si un document doit être mis à jour dans l'index.

    Note

    Utilisez le journal des modifications si vous ne le souhaitez pas Amazon Kendra pour numériser tous les documents. Si votre journal des modifications est volumineux, cela peut prendre Amazon Kendra moins de temps pour numériser les documents de la source de SharePoint données que pour traiter le journal des modifications. Si vous synchronisez votre source de SharePoint données avec votre index pour la première fois, tous les documents sont numérisés.

  • Filtres d'inclusion et d'exclusion : vous pouvez spécifier si vous souhaitez inclure ou exclure certains contenus.

    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.

  • Mappages de champs : choisissez de mapper les champs de votre source SharePoint de données à votre Amazon Kendra champs d'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 afin de Amazon Kendra pour effectuer des recherches 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.

  • Filtrage du contexte utilisateur et contrôle d'accès —Amazon Kendra explore la liste de contrôle d'accès (ACL) de vos documents, si vous en avez une ACL pour vos documents. Les ACL informations 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.

En savoir plus

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