Doc produitsMenu

Plateforme Coveo 7.0 >
Aide à l'administrateur > Connecteurs > Connecteur Atlassian JIRA V2 > Configuration et indexation d'une source Atlassian JIRA V2

Configuration et indexation d'une source Atlassian JIRA V2

Une source définit un groupe de paramètres de configurations pour une instance spécifique de JIRA.

Pour configurer et indexer une source JIRA V2

  1. Dans le serveur Coveo, accédez à l'Outil d'administration (voir Ouverture de l'Outil d'administration).

  2. Sélectionnez Index > Sources et collections.

  3. Dans la section Collections :

    1. Sélectionnez une collection existante dans laquelle vous souhaitez ajouter la nouvelle source.

      OU

    2. Cliquez sur Ajouter pour créer une nouvelle collection (voir Ajout d'une collection).

  4. Dans la section Sources, cliquez sur Ajouter.

    La page Ajouter une source qui apparaît est organisée en trois sections.

  5. Dans la section Paramètres généraux (General Settings) de la page Ajouter une source (Add Source) :

    1. Tapez la bonne valeur pour les paramètres obligatoires suivants :

      Nom

      Un nom descriptif de votre choix pour la source du connecteur.

      Exemple : JIRA V2

      Type de source

      Le connecteur qui est utilisé par cette source. Dans ce cas, sélectionnez Jira v2.

      Note : Si vous n'apercevez pas Jira v2 dans la liste Type de source, veillez à ce que votre environnement réponde aux exigences (voir Exigences du connecteur Atlassian JIRA V2).

      Adresses

      Entrez l’URL de base de votre serveur JIRA.

      Exemples : http://MyJiraServer:8080/

      Champs (Fields)

      Sélectionnez le groupe de champs que vous avez créé plus tôt (voir Vue d'ensemble du déploiement du connecteur Atlassian JIRA V2).

    2. Les paramètres suivants n'ont pas besoin, la plupart du temps, d'être modifiés :

      Appréciation (Rating)

      Changez la valeur seulement si vous souhaitez changer globalement la cote associée à tous les éléments de cette source par rapport à la cote d'autres sources (voir Fonctionnement du classement des résultats de recherche).

      Exemple : Si la source indexe un ancien référentiel, vous devriez définir ce paramètre à Basse afin que, dans l'interface de recherche, les résultats de cette source apparaissent plus bas dans la liste, contrairement à ceux d'autres sources de référentiels actifs.

      Types de document (Document Types)

      Si vous avez défini un groupe personnalisé de types de documents pour cette source, sélectionnez-le (voir Que sont les groupes de types de documents?).

      Langues actives (Active Languages)

      Si vous avez défini des groupes personnalisés de langues actives, veillez à sélectionner celui qui convient le mieux à cette source (voir Ajout et configuration d'un groupe de langues).

      Horaire d'actualisation (Refresh Schedule)

      Intervalle de temps à laquelle l'index est automatiquement actualisé afin de garder le contenu de l'index à jour. Par défaut, l'option Every day donne à CES (Coveo Enterprise Search) la consigne d'actualiser la source chaque jour, à minuit (voir Création ou modification d'un horaire de source).

      La surveillance en direct avec un webhook de JIRA maintient efficacement et continuellement votre source à jour. L’actualisation complète est un filet de sauvetage pour veiller à ce que toutes les modifications soient prises en considération.

      Exemple : Si votre serveur maître de Coveo est arrêté pour entretien pendant une heure et le webhook de JIRA force des modifications pendant cette période, elles ne seront prises en considération que dans l’index à la prochaine actualisation complète.

  6. Dans la section Paramètres et options spécifiques au connecteur (Specific Connector Parameters & Options) de la page Ajouter une source (Add Source) :

    1. Dans le champ Mapping File, le chemin d’accès vers le fichier de correspondances par défaut qui définit comment le connecteur gère les métadonnées a rarement besoin d’être changé.

    2. Vérifiez si vous devez changer les valeurs par défaut des paramètres suivants :

      Support Comment Permissions

      Par défaut, cette case est décochée afin que le problème et ses commentaires soient indexés en tant qu’un seul document, ce qui permet de trouver un document de soit un problème ou ses commentaires. Toutefois, il n’y a pas de restrictions sur la capacité d’utilisateurs de voir les commentaires d’un problème.

      Cochez la case, pour respecter les permissions des commentaires, afin que seuls les utilisateurs qui peuvent voir un commentaire dans JIRA puissent également le voir dans des résultats de recherche. Dans ce cas, un problème et ses commentaires sont indexés dans des documents différents, entraînant une pertinence de recherche moins élevée.

      Index Attachments

      Lorsque sélectionné, CES indexe les fichiers binaires liés à un problème. Les pièces jointes sont indexées avec le même niveau et les mêmes groupes de leur problème commun.

      Index Comments

      Lorsque sélectionné, CES indexe les commentaires sur des problèmes. Les commentaires sont indexés avec le même niveau et les mêmes groupes de leur problème commun. Lorsque des permissions sur les commentaires sont prises en charge, si un commentaire est restreint à un rôle de groupe ou de projet, un ensemble supplémentaire est ajouté dans le groupe ou le projet.

      Index Work Logs

      Lorsque sélectionné, CES indexe une entrée de temps sur un problème. Les journaux de travail sont indexés avec le même niveau et les mêmes groupes de leur problème commun. Si un journal de travail est restreint à un rôle de groupe ou de projet, un ensemble supplémentaire est ajouté dans le groupe ou le projet.

    3. (Facultatif) Dans la section Paramètres, cliquez sur Ajouter un paramètre, puis utilisez le paramètre caché suivant lorsque vous souhaitez utiliser l'authentification Kerberos :

      UseKerberosAuthentication Fournisseur de sécurité CES 7.0.7711+ (juin 2015)

      S’il faut utiliser ou non l’authentification Kerberos. La valeur par défaut est false. Définissez-la à true en analysant une installation de Kerberos.

      ServicePrincipalNames Fournisseur de sécurité CES 7.0.7711+ (juin 2015)

      Le nom du principal du serveur (SPN) personnalisé à utiliser avec l’authentification Kerberos. Le SPN est presque toujours dans le format suivant : HTTP/server.name@server.domain. Si le nom du domaine ne se trouve pas dans le SPN, le connecteur utilise le domaine de l’utilisateur, qui peut être erroné. Utilisez ce paramètre lorsque l’identité d’utilisateur du robot ne se trouve pas dans le même domaine que le serveur JIRA.

      Exemple : Vous utilisez user@domain.com comme identité d’utilisateur pour analyser http://jira.dev.domain.com.

      Notes :

      • Ce paramètre n’est utilisé que lorsque la valeur du paramètre UseKerberosAuthentication est true.

      • Veillez à ce que l’identité d’utilisateur existe dans JIRA et dans AD.

      • Lorsque vous obtenez l’erreur suivante :

        The Kerberos Authentication failed for user 'userIdentity' with the SPN 'HTTP/ServerName'.

        Cela veut dire que l’identité d’utilisateur et/ou le SPN est erroné.

    4. Les cases à cocher Option n'ont généralement pas besoin d'être modifiés :

      Indexer les sous-dossiers (Index Subfolders)

      Gardez cette case cochée (recommandé). En procédant ainsi, tous les sous-dossiers de l'adresse de serveur spécifiée sont indexés.

      Indexer les métadonnées des documents (Index the document's metadata)

      Lorsque sélectionné, CES indexe toutes les métadonnées du document, mêmes celles qui ne sont pas associées à un champ. Les métadonnées orphelines sont ajoutées au body du document afin qu'elles puissent être recherchées à l'aide de requêtes en texte libre.

      Lorsque non-coché (par défaut), seules les valeurs de champs système et personnalisés dont l'attribut Requêtes textuelles est sélectionné pourront être recherchées sans l'aide d'une requête de champ (voir Ajout d'un champ à utiliser pour la recherche et Que sont les requêtes par champs et les requêtes en texte libre?).

      Exemple : Un document contient deux métadonnées :

      • LastEditedBy, renfermant la valeur Hector Smith

      • Department, renfermant la valeur RH

      Dans CES, le champ personnalisé CorpDepartment est lié à la métadonnée Department, et son attribut Free Text Queries est sélectionné.

      Si l'option Indexer les métadonnées des documents n'est pas cochée, rechercher RH retourne le document, car un champ indexe cette valeur. Rechercher hector ne retourne pas le document, car aucun champ n'indexe cette valeur.

      Si l'option Indexer les métadonnées des documents est sélectionnée, rechercher hector retourne également le document, car CES a indexé les métadonnées orphelines.

      Les adresses de document sont sensibles à la casse (Document's addresses are case-sensitive)

      Laissez la case décochée. Ce paramètre doit être coché seulement, dans de rares situations, pour les systèmes dans lesquels des documents distincts peuvent avoir le même nom, mais une casse différente.

      Générer une version HTML en cache des documents indexés (Generate a cached HTML version of indexed documents)

      Si vous cochez cette case (recommandé), en temps d'indexation, CES crée des versions HTML des documents indexés. Dans les interfaces de recherche, les utilisateurs peuvent alors évaluer plus rapidement le contenu en cliquant sur le lien Aperçu rapide plutôt qu'en ouvrant le document d’origine avec l'application originale. Vous devriez décocher ces cases seulement si vous ne souhaitez pas utiliser les liens Aperçu rapide ou si vous souhaitez enregistrer des ressources pendant la génération de la source.

      Ouvrir les résultats avec la version cache (Open results with cached version)

      Laissez cette case décochée (recommandé) afin que, dans les interfaces de recherche, le lien principal de résultats de recherche ouvre le document d'origine avec l'application originale. Vous devriez cocher cette case seulement si vous ne souhaitez pas que les utilisateurs puissent ouvrir le document original, mais qu'ils ne voient que la version HTML du document en tant qu'Aperçu rapide. Dans ce cas, vous devez également sélectionner Générer une version HTML en cache des documents indexés.

  7. Dans la section Sécurité (Security) de la page Ajouter une source :

    1. Dans la liste déroulante Identité d'utilisateur, sélectionnez l'identité d'utilisateur d'analyse JIRA V2 que vous avez créée pour cette source (voir Vue d'ensemble du déploiement du connecteur Atlassian JIRA V2).

    2. Dans la liste déroulante Fournisseur de sécurité, si vous choisissez d'indexer des permissions, sélectionnez le fournisseur de sécurité JIRA V2 que vous avez créé pour cette source (voir Configuration d'un fournisseur de sécurité Atlassian JIRA V2). Sinon, sélectionnez None. Sinon, sélectionnez (aucun).

    3. Cliquez sur Enregistrer (Save) pour enregistrer la configuration de la source.

  8. Si votre contenu de JIRA est entièrement public et vous choisissez de ne pas indexer des permissions de JIRA :

    1. Dans le menu de navigation à gauche, sélectionnez Permissions.

    2. À côté de Permissions, sélectionnez l'option Précise les permissions de sécurité à indexer (Specifies the security permissions to index).

    3. À côté de Utilisateurs autorisés (Allowed Users), veillez à ce qu'un groupe everyone bien connu comme le groupe everyone \S-1-1-0\ d'Active Directory soit ajouté.

    4. Cliquez sur Appliquer les modifications.

  9. Sur la barre d'outils, cliquez sur Régénérer pour commencer l'indexation de votre source.

  10. Confirmez que le processus de génération de la source est exécuté sans erreur :

    • Dans le panneau de navigation situé à gauche, cliquez sur État, puis confirmez que l'indexation se fait sans erreur.

      OU

    • Ouvrez la console CES afin de surveiller les activités de génération de la source (voir Utilisation de la Console CES.

Prochaines étapes?

Vous devriez modifier les paramètres de source avancés (voir Modification de paramètres de source cachés d'Atlassian JIRA V2).