Procédure pas à pas : intégration de Jira

Cette procédure pas à pas vous aide à configurer et à utiliser la capacité d'intégration de Pro Cloud Server pour intégrer vos modèles Enterprise Architect aux projets Jira Software correspondants, via l'option d'installation Cloud .

En utilisant l'intégration avec Jira, vous pouvez :

Relier les éléments Enterprise Architect à leurs homologues dans Jira
Créer des éléments Enterprise Architect basés sur des éléments Jira et vice-versa
Synchronisez les modifications entre Enterprise Architect et Jira, selon les besoins
Effectuer une analyse de traçabilité
Ajouter des commentaires aux éléments Jira depuis Enterprise Architect

Lorsque Pro Cloud Server est installé sur votre système, il fournit une prompt pour installer également le composant Plug-ins d'intégration facultatif ; par défaut, le composant est installé dans le dossier C:\Program Files (x86)\ Sparx Systems \ Pro Cloud Server \SBPI\ (en supposant qu'une machine 64 bits est utilisée). Le composant Plug-ins d'intégration comprend :

Serveur d'intégration (SBPI) (sbpi.exe)
Le fichier plug-in .exe pour chacun des nombreux outils intégrés, y compris celui pour Jira (JiraSbpi.exe)

Le plug-in JiraSbpi.exe interagit avec le système de suivi des problèmes d'Atlassian. Il est capable de répertorier les filtres favoris d'un utilisateur (également appelés filtres étoilés ). Chaque filtre répertorie ensuite tous les éléments Jira renvoyés par le filtre. Ces filtres sont configurés dans Jira dans un dossier Favoris pour chaque utilisateur qui se connecte, avant qu'Enterprise Enterprise Architect ne demande au plug-in d'intégration de s'y connecter. Vous ne pouvez afficher que les éléments Jira qui font partie d'un filtre, créez donc des filtres appropriés dans Jira. Par exemple, si vous souhaitez lier Exigences Enterprise Architect aux User Stories de Jira, créez un filtre qui affichera les User Stories pertinentes.

Jira propose deux options d'installation : Jira Cloud et Jira Server. L'option Jira Server est en cours de suppression, ces procédures supposent donc que vous travaillez avec Jira Cloud . Cependant, si vous travaillez avec Jira Server, certaines procédures contiennent des commentaires pour vous en tenir compte.

Jetons d'accès

Lorsque Jira est hébergé sur un serveur Atlassian et non localement, il nécessite l'utilisation d'un TokenID créé sur le site Atlassian, pour un seul ensemble d'utilisateurs prédéfinis pour la connexion à Atlassian. Consultez les pages du site Web Atlassian sur les jetons d'accès cloud une révision générale (https://www.atlassian.com/software/access/guide/elements/api-token-controls#what-are-api-token-controls) et une discussion sur la création de jetons (https://confluence.atlassian.com/cloud/api-tokens-938839638.html). Consultez les liens sous En savoir plus ci-dessous.

Prérequis

Afin de configurer l'intégration entre Jira et Enterprise Architect , vous devez d'abord :

Utilisez une installation sous licence de Pro Cloud Server avec le composant Plug-ins d'intégration, comme indiqué ci-dessus
Sélectionnez l'option « Activer Fonctionnalités Pro (OSLC, WebEA et intégration) » dans la configuration Pro Cloud Server pour chaque système de gestion de base de données hébergeant vos modèles Enterprise Architect
Avoir un accès réseau entre le serveur PCS et le serveur Jira hébergeant l'installation Jira externe et ses données
Avoir des informations d'identification d'utilisateur pour accéder aux données externes
Créez un dossier « Favoris » de filtres appropriés configurés dans Jira, comme indiqué ci-dessus
Utilisez Enterprise Architect Corporate , Unified ou Ultimate Edition v14 ou version ultérieure

Nous supposerons que :

Le serveur d'intégration et le plug-in d'intégration Jira doivent être exécuter sur la même machine que le Pro Cloud Server
Vous définissez les options du serveur d'intégration à l'aide de l'onglet « Intégration » dans le client de configuration Pro Cloud Server plutôt qu'en manipulant manuellement le registre ou les fichiers de configuration ou en utilisant l'interface WebConfig

Définir des filtres étoilés dans Jira

L'intégration Jira de Pro Cloud Server permet d'accéder aux éléments renvoyés par les filtres étoilés de Jira. Avant d'utiliser l'intégration, vous devez vous assurer que certains filtres étoilés ont été configurés pour renvoyer les éléments que vous souhaitez rendre accessibles dans Enterprise Architect .

Pour définir des filtres étoilés dans Jira, suivez ces étapes :

Dans Jira, sélectionnez le menu déroulant « Filtres », puis « Vue tous les filtres ».
En haut à droite de la liste des filtres, cliquez sur le bouton « Créer un filtre ».
Ajustez les paramètres de filtre/recherche (tels que Projet et Type ), puis utilisez l'option « Enregistrer sous » pour enregistrer un nouveau filtre.
Revenez maintenant à la liste de tous les filtres ('Filtres | Vue tous les filtres'). Dans la liste des filtres, vous pouvez utiliser l'icône en forme d'étoile pour ajouter le filtre à vos filtres favoris.
Ce filtre (et les éléments qu'il renvoie) devraient maintenant être accessibles à l'intégration Jira du Pro Cloud Server

Identifier Jira sur Pro Cloud Server et Enterprise Architect

Suivez ces étapes :

Double-cliquez sur l'icône du bureau « Pro Cloud Config » pour ouvrir la fenêtre du client Pro Cloud Config.
Sélectionnez l'onglet « Intégration » et cochez la case « Activer les intégrations ». Dans le champ « Port », saisissez le numéro du port sur lequel le serveur d'intégration écoute les requêtes du Pro Cloud Server .
Cliquez sur le bouton Ajouter. La dialogue « Ajouter un fournisseur de données » s'affiche.
Cochez la case « Activé ».
Dans le champ « Nom », saisissez un nom de connexion approprié, tel que « Jira ».
Dans le champ « Fournisseur », cliquez sur la flèche déroulante et sélectionnez « Jira » ; cela ajoute automatiquement « Jira » au champ « Préfixe ».
Dans le panneau « Plugin d'intégration », dans le champ « Port », saisissez le numéro du port que le serveur d'intégration utilisera pour communiquer avec le plug-in Jira.
Dans le champ « Protocole », cliquez sur la flèche déroulante et sélectionnez le protocole que le plug-in Jira utilisera pour communiquer avec Jira.
- Pour une installation par défaut de Jira Cloud , cela doit être « HTTPS »
- Pour une installation de Jira Server, la valeur par défaut est « HTTP »
Dans le champ « Nom du serveur/IP », saisissez le nom du serveur ou l'adresse IP que le plug-in Jira utilisera pour communiquer avec Jira.
- Pour une installation par défaut de Jira Cloud , cela doit être <account>.atlassian.net
- Pour une installation de Jira Server, la valeur par défaut est <nom du serveur ou de l'hôte>
Dans le champ « Port », saisissez le numéro du port que le plug-in Jira utilisera pour communiquer avec Jira.
- Pour une installation par défaut de Jira Cloud , cela doit être « 443 »
- Pour une installation de Jira Server, la valeur par défaut est « 8080 »
Quittez la « base » Le champ URL est vide pour Jira Cloud et pour une installation Jira Server par défaut. Le champ peut être obligatoire pour les configurations Jira Server autres que celles par défaut.
Note que les champs des étapes 8 à 11 sont concaténés pour créer une adresse Web, soit : <protocole>://<serveur>:<port>/baseURL ( baseURL inclus si le champ n'est pas vide).
Si vous laissez les champs « Utilisateur » et « Mot de passe » vides, chaque utilisateur Enterprise Architect sera invité à saisir ses informations d'identification Jira personnelles, ce qui peut offrir une meilleure convivialité.
Si vous préférez définir des valeurs dans les champs « Nom d'utilisateur » et « Mot de passe », les valeurs seront utilisées en combinaison pour accéder aux données dans Jira. Tous les utilisateurs actuels Enterprise Architect de l'installation Jira utiliseront le même ensemble d'informations d'identification pour lire les données externes.
Cochez les cases « Créer Items », « Modifier Items » et/ou « Poster des discussions » si nécessaire pour permettre aux utilisateurs du plug-in Jira de créer et/ou de mettre à jour des éléments et/ou de créer des publications de discussion dans Jira à l'aide Enterprise Architect .
Si vous souhaitez que le plug-in Jira ignore les erreurs liées à SSL qui se produisent à la suite d'une communication avec Jira, cochez la case « Ignorer les erreurs SSL ».
Vous pouvez laisser les autres champs vides ou les définir sur leurs valeurs par défaut. Cliquez sur le bouton OK pour terminer la configuration. Vous revenez alors à l'onglet « Intégration » de la fenêtre Client de configuration Pro Cloud Server .

Identifier les modèles Enterprise Architect dans Jira

Dans l'onglet « Intégration » de la fenêtre Client de configuration Pro Cloud Server , vous verrez maintenant :

En bas à gauche de l'écran, le panneau « Fournisseurs de données » répertoriant Jira comme fournisseur de données
En bas à droite de l'écran, le panneau « Jira est lié à : » affiche une liste de contrôle des modèles Enterprise Architect de vos gestionnaires de base de données compatibles Pro

Vous pouvez soit cliquer sur la case à cocher en regard de chaque modèle Enterprise Architect que vous souhaitez lier à Jira, soit cliquer sur l'

pour les sélectionner tous en même temps.

Cliquez sur le bouton Quitter.

Redémarrez le service PCS pour appliquer les modifications que vous avez apportées.

Vous pouvez maintenant accéder à l’un de vos modèles Enterprise Architect et vérifier l’intégration avec Jira.

Test l'intégration

Dans Enterprise Architect ouvrez l'un des modèles que vous avez sélectionnés dans la liste : « Jira » est lié à. Voir l'image ci-dessus.

Sélectionnez l'option du ruban Spécialiser > Outils > Systeme d'intégration .
Dans la barre d'outils de la fenêtre Données externes, cliquez sur la flèche déroulante à droite de l'icône « globe ».
Sélectionnez « Jira » dans la liste ; cela ajoute le fournisseur au fil d'Ariane dans la barre d'outils.
Cliquez sur « Jira » dans le fil d'Ariane pour afficher une liste des fournisseurs Jira qui ont été configurés et liés à ce modèle. Si rien n'est répertorié, aucun fournisseur n'a été lié à ce modèle.
Cliquez sur le fournisseur qui a été configuré et lié à ce modèle pour afficher une liste des projets Jira qui sont maintenant disponibles pour la sélection afin de travailler avec ce modèle Enterprise Architect .
Sélectionnez le projet Jira pour afficher une liste de filtres utilisateur.

Si rien ne s'affiche ici, il se peut que vous ne disposiez pas des privilèges suffisants pour afficher les projets. Cependant, si aucun filtre utilisateur n'a été créé pour vous, la liste contient simplement « [ ] » ou un message d'information.

(Si vous ne voyez pas Jira ou une liste de projets Jira, consultez les procédures de cette rubrique ou les rubriques plus larges et plus détaillées de la section Plugins d'intégration pour voir si vous avez manqué une étape ou si une condition préalable n'est pas satisfaite. Vous pouvez également consulter la rubrique d'aide Dépannage .)

Cartographie des données

Pour que Jira et Enterprise Architect puissent échanger des éléments de données de manière fluide, vous devez révision et, si nécessaire, éditer :

Quel type d'élément Jira correspond à quel type d'élément Enterprise Architect , et
Quelle propriété d’un élément Jira correspond à quelle propriété d’un élément Enterprise Architect .

Ces tâches sont entièrement expliquées dans la rubrique Aide Configuration , qui utilise Jira comme exemple de fournisseur de données.

Révision des données Jira

Lorsque vous avez testé la communication entre Enterprise Architect et Jira, dans la fenêtre Données externes, vous avez ouvert le fil d’Ariane pour afficher une liste des projets Jira.

Lorsque vous sélectionnez l’un des projets, vous cliquez à nouveau sur la flèche déroulante et sélectionnez l’un des filtres de la liste, qui répertorie ensuite les éléments de ce filtre dans le corps de la fenêtre.

Si cette liste est trop longue, vous pouvez cliquer sur l'icône « Hamburger » dans la barre d'outils de la fenêtre et sélectionner des options telles que :

« Items liés » pour afficher uniquement les éléments Jira liés aux éléments Enterprise Architect
« Items liés au contexte actuel » pour afficher uniquement les éléments Jira liés à l'élément Enterprise Architect actuellement sélectionné ou
« Éléments non liés » pour afficher uniquement les éléments Jira qui n'ont pas encore été liés aux éléments Enterprise Architect

Sélectionnez l'option appropriée, si nécessaire, puis explorez le contenu des éléments Jira sélectionnés. Chacune des fenêtres Propriétés , Notes , Inspecteur et onglet Discuter de la fenêtre Discuter et Révision possède des onglets ou versions distincts de la fenêtre pour afficher les propriétés, notes , fonctionnalités et les discussions (respectivement) de l'élément sélectionné. Ceux-ci sont illustrés dans la Rubrique d'aide Détails Item externe .

Travailler avec les éléments Jira et les éléments Enterprise Architect

Après avoir créé une communication fonctionnelle entre Enterprise Architect et Jira, vous pouvez :

Créer un nouvel élément dans Enterprise Architect lié à un élément Jira
Créer un nouvel élément Jira lié à un élément dans Enterprise Architect
Lier un élément existant dans Enterprise Architect à un élément Jira
Mettre à jour l'élément Jira avec les modifications apportées à l'élément Enterprise Architect
Mettre à jour l'élément Enterprise Architect avec les modifications apportées à l'élément Jira
Mettre à jour tous les éléments Enterprise Architect liés avec toutes les modifications apportées aux éléments Jira

Ces actions sont toutes expliquées dans la rubrique d’aide Lier Items , qui utilise Jira comme exemple de fournisseur de données.

Apprendre encore plus

Plugins d'intégration
Atlassian Access Tokens (ressource en ligne)
Create an Access Token (ressource en ligne)
Dépannage