Newsletter Janvier 2021

Qu'est-ce qu'une Collection ?

Au premier regard, nous comprenons rapidement ce qu'est une Collection. Une Collection regroupe un ensemble de documents Polarion (Livedocs),  chacun des documents étant soit dans sa version courante (Head), soit dans une révision historique ou relative à une  Baseline. Pourquoi voudrions-nous créer et matérialiser une Collection de révisions de documents ?

Considérons des LiveDocs de Polarion contenant ou référençant des artefacts (Work Items exigences, tests, etc.) à différents niveaux de leur cycle de développement, par exemple l'ensemble des documents de spécification pour la version 1 d'un système.

Quand l'équipe système a terminé la version V1 de sa spécification, elle veut partager exclusivement cette version avec l'équipe de développement logiciel, tout en continuant à faire évoluer ses exigences systèmes vers une nouvelle version V2.  Jusqu'alors, une approche pouvait être de créer des branches de chacun des documents en stockant ces documents versionnés dans un dossier donné. Ce mode de fonctionnement pouvait conduire à des risques d'erreurs, car le contexte proposé aux développeurs de l'équipe logicielle n'était pas "borné" : en suivant notre exemple l'équipe de développement logiciel avait pour consigne d'utiliser la version 1, mais ils pouvaient cependant également accéder à la version 2 des documents de spécification.  La traçabilité entre Work Items pouvait également être non cohérente en regard de ces différentes versions.

​

Les Collections vont nous permettre de gérer ce regroupement logique de nos documents de spécification, généralement pour une version majeure du projet, en nous apportant visibilité et cohérence des documents et de la traçabilité entre Work Items au sein d'une collection et aussi entre les collections. En effet,  la version active et courante d'un LiveDoc ne peut être contenue que dans une seule Collection. Travailler avec les Collections permet donc  de s’assurer que les équipes travaillent avec les bonnes versions d’une spécification, que les liens créés entre Work Items  pointent vers les bonnes versions de la spécification.

Les Collections viennent compléter favorablement les fonctions de Baseline (au niveau projet et documents) pour faciliter les audits et le suivi de la conformité réglementaire, par notamment la fermeture et l'archivage d'une Collection.  Lors d'une phase d'audit, il sera plus aisé de borner le périmètre de la revue sur une configuration donnée du projet.

Comment créer des Collections et y ajouter des documents

Le lien vers les Collections est présenté pour chaque nouveau projet. Sur un projet existant, il faut via l'administration projet ajouter le nouveau topic Collections dans le panneau de navigation gauche.

Suite à la création et nommage de la collection, nous pouvons sélectionner soit la révision courante d'un  document (il sera donc modifiable dans le contexte de la collection) soit une révision donnée ou une baseline. Il nous semble plus cohérent dans une collection de pointer une baseline qu'une révision donnée mais les deux sont possibles pour permettre les différents cas d'usage.
 

Parcourir les documents de la Collection

Quand nous travaillons dans le contexte d'une Collection, l'interface est bornée aux documents contenus dans la Collection. Dans le volet de navigation de gauche, nous ne voyons que les documents de la Collection. Notez l'indication de la Collection active par un bandeau vert : vous pouvez cliquer sur ce lien pour revenir sur la liste des Collections.

Pour reprendre notre exemple précédent, un développeur de l'équipe logicielle pourra accéder et travailler sur ces documents en toute indépendance des autres documents (et autres versions des mèmes documents !) qui n’appartiennent pas à la Collection.

Lier des Work Items dans le contexte de la Collection

Les actions possibles comme la création des liens entre Work Items sont également définies par le périmètre de la Collection. Une validation des liens s'effectue en temps réel lorsqu'un utilisateur veut relier par un lien de traçabilité un Work Item à un autre, par exemple une exigence système à une exigence logicielle. En d’autres termes, vous ne pouvez lier les Work Items entre eux que s'ils appartiennent à la même Collection, ce qui assure leur cohérence au sein même de la Collection.

Créer des Collections multi-projets

Puisque la fonctionnalité Collections est nouvelle, elle continue de s'enrichir de nouvelles possibilités.   Vous pouvez ajouter et gérer des documents issus d'autres projets à vos Collections, ce qui est très pertinent si on considère un projet Polarion pour l'équipe Système, un projet Polarion pour l'équipe logicielle. Pour faciliter la navigation et la compréhension du périmètre de travail, la barre de navigation affiche le projet courant et le dossier qui contient le document. Ceci permet de suivre et comprendre aisément l’origine des documents​.

Baseline de Collections

Les Collections viennent compléter et enrichir le principe de Baseline en permettant de représenter des configurations ou état du projet à un instant donné. En reprenant le concept d’une Baseline de Document, une Collection peut désormais être mise en Baseline. Le lien vers cette Baseline est proposé lorsque nous affichons la  vue history  de la Collection.

Ce qui est surtout intéressant c'est qu'il devient possible de naviguer sur les documents de la Collection en se plaçant dans le contexte de la Baseline.  A nouveau, le bandeau de navigation nous informe de manière précise en nous donnant la Collection ainsi que la Baseline ou nous nous trouvons.

Réutilisation de Collection

Enfin, les documents contenus dans une Collection peuvent être "réutilisés" d'une Collection à une autre, y compris entre projets. En une seule opération, vous pouvez ajouter l'ensemble des documents d'une Collection à celle courante sans avoir à ajouter manuellement chacun des documents dans une version ou Baseline donnée.

Dans le cas ou des documents de la Collection source se trouveraient dans leur révision Head, les documents seront figés dans la Collection cible sur leurs révisions courantes, du fait que la version Head d'un document ne peut être présente que dans une seule une même Collection.

Pour éviter toute confusion, réutiliser des documents d'une Collection à une autre ne veut pas dire dupliquer ces documents. En effet il n'y a pas de création de nouveaux documents comme le fait la fonction Reuse proposée pour un LiveDoc.

Les Collections offrent donc un nouveau moyen pour mieux gérer en parallèle des configurations multiples, pour communiquer et travailler entre équipes autour de périmètres ou contextes de projets communs ou différents. Elles permettent de cadrer et borner la présentation et la gestion des données au contexte désiré représenté par la Collection, offrant ainsi une meilleure compréhension des éléments du projet et aussi simplement une navigation plus fluide car limitée aux éléments requis et nécessaires.  Par ses fonctionnalités les collections permettront de regrouper rapidement les documents de spécification à présenter lors d'un audit réglementaire.

Le même principe s'applique lorsque l'on veut personnaliser sa page d'accueil personnelle ou du projet  avec des liens vers d'autres pages comme les pages d'accueil des dossiers.

Cependant parfois, nous voulons proposer des vues plus dynamiques, c’est-à-dire que les liens proposés se mettent à jour automatiquement en fonction du contenu du projet. Ainsi, nous pouvons lister les liens vers le ou les documents mais en demandant l'ouverture du document avec les panneaux  latéraux   comme les signatures, la corbeille, etc.

Ainsi le clic sur TOC ouvrira le document avec la table des matières ouverte sur le côté droit.

La R&D Polarion a prévu dans son API (mot barbare qui veut dire Application Programming  Interface) des méthodes pour construire le lien web vers le document (createPortalLink), avec des options permettant d'indiquer quel volet latéral on veut afficher (exemple: sidebarSignatures)

Cependant, ces options ne sont pas toujours présentes. Ceci ne nous empêche cependant pas d'ouvrir les autres volet pour ouvrir par exemple la table des matières, ou encore directement la corbeille du document (que nous vous conseillons de vider régulièrement !). Ceci s'effectue  en ajoutant manuellement cette option sidebar dans la construction du lien, par exemple : ?sidebar=toc.

Nous vous livrons le code complet de cet exemple ci-dessous, il vous suffit de renseigner votre document et votre dossier sur les deux premières lignes et vous pourrez naviguer vers votre document de manière dynamique avec l'affichage de votre choix. Il conviendra bien sûr de remplacer ce renseignement statique du document par un paramètre de choix du document sur la page, par exemple.

La R&D Polarion a prévu dans son API (mot barbare qui veut dire Application Programming Interface) des méthodes pour construire le lien web vers le document (createPortalLink), avec des options permettant d'indiquer quel volet latéral on veut afficher (exemple: sidebarSignatures)Cependant, ces options ne sont pas toujours présentes. Ceci ne nous empêche cependant pas d'ouvrir les autres volet pour ouvrir par exemple la table des matières, ou encore directement la corbeille du document (que nous vous conseillons de vider régulièrement !). Ceci s'effectue en ajoutant manuellement cette option sidebar dans la construction du lien, par exemple : ?sidebar=toc.Nous vous livrons le code complet de cet exemple ci-dessous, il vous suffit de renseigner votre document et votre dossier sur les deux premières lignes et vous pourrez naviguer vers votre document de manière dynamique avec l'affichage de votre choix. Il conviendra bien sûr de remplacer ce renseignement statique du document par un paramètre de choix du document sur la page, par exemple.
​

Si vous désirez afficher d'autres vues du document (Planning, Test Runs, etc.) nous avons la liste exhaustive des liens donc n'hésitez pas à nous consulter.

Nous pourrions imaginer un tableau de bord des documents qui proposera aux utilisateurs de l'afficher dans la vue de son choix en cliquant sur le lien correspondant.