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 :

Liez les éléments d' Enterprise Architect avec leurs homologues dans Jira
Créer des éléments Enterprise Architect basés sur des éléments Jira, et vice-versa
Synchroniser les changements entre Enterprise Architect et Jira, au fur et à mesure des besoins
Réaliser une analyse de traçabilité
Ajouter des commentaires aux éléments Jira d' Enterprise Architect

Lorsque Pro Cloud Server est installé sur votre système, il fournit une prompt pour installer également le composant facultatif des plug-ins d'intégration ; 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 des plug-ins d'intégration comprend :

Serveur d'intégration (SBPI) (sbpi.exe)
Le fichier .exe du plug-in 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 listera alors tous les éléments Jira renvoyés par le filtre. Ces filtres sont configurés dans Jira dans un dossier Favoris pour chaque utilisateur se connectant, avant Enterprise Architect ne demande que le plug-in d'intégration se connecte à eux. 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 les Exigences d' Enterprise Architect aux User Stories Jira, créez un filtre qui affichera les User Stories pertinentes.

Jira lui-même a deux options d'installation, Jira Cloud et Jira Server. L'option Jira Server étant progressivement supprimée, ces procédures supposent que vous travaillez avec Jira Cloud . Cependant, si vous travaillez avec Jira Server, il y a quelques commentaires dans les procédures pour tenir compte de cela.

Jetons d'accès

Lorsque Jira est hébergé sur un serveur Atlassian et non hébergé localement, il nécessite l'utilisation d'un TokenID créé sur le site Atlassian, pour un seul utilisateur prédéfini défini pour se connecter à Atlassian. Consultez les pages du site Web d'Atlassian sur les jetons d'accès - 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 cloud (https://confluence.atlassian.com/cloud/api-tokens-938839638.html). Voir les liens sous En savoir plus ci-dessous.

Conditions préalables

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

Utiliser une installation sous licence de Pro Cloud Server avec le composant Integration Plug-ins, comme nous venons de le voir
Sélectionnez l'option "Activer les fonctionnalités Pro ( Fonctionnalités , WebEA et intégration)" dans la configuration du Pro Cloud Server pour chaque système de gestionnaire de base de données hébergeant vos modèles Enterprise Architect
Avoir un accès physique au réseau entre le serveur PCS et le serveur Jira hébergeant l'installation Jira externe et ses données
Disposer des informations d'identification de l'utilisateur pour accéder aux données externes
Avoir un dossier "Favoris" des filtres appropriés configurés dans Jira, comme nous venons de le voir
Utiliser 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 sont à 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 du 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 favoris dans Jira

L'intégration Jira du 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 favoris 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 ('Filters | Vue All Filters'). Dans la liste des filtres, vous pouvez utiliser l'icône étoile pour ajouter le filtre à vos filtres étoilés.
Ce filtre (et les éléments qu'il renvoie) doit maintenant être accessible à 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 boîte de 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 'Integration Plugin', 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 Jira Server, la valeur par défaut est 'HTTP'
Dans le champ 'Server Name/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 , il doit s'agir de <account>.atlassian.net
- Pour une installation 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 Jira Server, la valeur par défaut est '8080'
Quitter la 'Base URL' vide pour Jira Cloud et pour une installation par défaut de Jira Server. Le champ peut être obligatoire pour les configurations de serveur Jira autres que celles par défaut.
Note que les champs des étapes 8 à 11 sont concaténés pour créer une adresse Web ; c'est-à-dire : <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 d' Enterprise Architect sera invité à entrer ses informations d'identification Jira personnelles, ce qui peut donner 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 d' 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 des Items ", "Modifier des Items " et/ou "Publier 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 messages de discussion dans Jira à l'aide d' Enterprise Architect .
Si vous souhaitez que le plug-in Jira ignore les erreurs liées à SSL qui se produisent à la suite de la communication avec Jira, cochez la case « Ignorer les erreurs SSL ».
Vous pouvez laisser d'autres champs vides ou définir leurs valeurs par défaut. Cliquez sur le bouton OK pour terminer la configuration. Cela vous ramène à l'onglet « Intégration » de la fenêtre du client de configuration du Pro Cloud Server .

Identifier les modèles Enterprise Architect pour Jira

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

En bas à gauche de l'écran, le panneau "Fournisseurs de données" répertoriant Jira en tant que fournisseur de données
En bas à droite de l'écran, le panneau '' Jira '' est lié à: '' affichant une liste de contrôle des modèles Enterprise Architect à partir de votre ou vos gestionnaires de base de données Pro-enabled

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 aller dans 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 de 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 avec lesquels travailler dans ce modèle Enterprise Architect .
Sélectionnez le projet Jira pour afficher une liste de filtres utilisateur.

Si rien ne s'affiche ici, vous ne disposez peut-être pas des privilèges suffisants pour afficher les projets. Cependant, si vous n'avez pas créé de filtres d'utilisateurs pour vous, la liste contient simplement '[ ]' ou un message d'information.

(Si vous ne pouvez pas voir 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 s'il y a une étape que vous avez manquée ou une condition préalable qui est pas satisfait. Vous pouvez également consulter la rubrique d'aide de Dépannage .)

Cartographie des données

Pour que Jira et Enterprise Architect échangent sans problème des éléments de données, vous devez révision et - si nécessaire - modifier :

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 expliquées en détail dans la rubrique d'aide à la 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 de 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 dans 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 qui sont liés aux éléments Enterprise Architect
' Items liés au contexte actuel' pour afficher uniquement les éléments Jira qui sont 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 de la fenêtre Propriétés , de la fenêtre Notes , de la fenêtre Inspecteur et de l'onglet Discuter de la fenêtre Discuter & Révision possède des onglets ou versions distincts de la fenêtre pour afficher les propriétés, notes , fonctionnalités et discussions (respectivement) de l'élément sélectionné. Celles-ci sont illustrées dans le Rubrique d'aide Détails de l' Item externe .

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

Après avoir créé une communication de travail 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 liés Enterprise Architect avec toutes les modifications apportées aux éléments Jira

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

Apprendre encore plus

Plugins d'intégration
Atlassian Access Tokens (ressource en ligne)
Créer un jeton d'accès (ressource en ligne)
Dépannage