GRAF–Outillage pour les nuls / générer le commentaire des schémas

L’outil “GRAF_Workshop” permet de générer automatiquement le commentaire des schémas.
Afin que ce commentaire soit lisible plus facilement, il est préférable d’indexer les différents flux avec des numéros de séquence : A1, A2 et A3 sur notre petit schéma de test :

Dans l’arborescence de travail, nous lançons l’outil GRAF_Workshop, puis nous ouvrons l’onglet “param”. Dans cet onglet, nous allons choisir le fichier référentiel récemment généré en cliquant sur le bouton “choisir fichier flux” :

Sélectionnons le fichier généré le plus récent :

Ouvrons ensuite l’onglet “idFlux”. Nos trois flux apparaissent avec leur identité et le le nom court du schéma auxquels ils appartiennent. Dans le cas d’un référentiel complexe avec beaucoup de schémas, il sera possible de filtrer sur le nom du schéma et de les traiter un par un.

Le bouton “calculer différentiel” permet de construire l’écart entre le commentaire précédent du schéma, et le nouveau. Dans notre cas, le commentaire précédent est vide, le différentiel va donc construire l’intégralité des commentaires
Ouvrons à présent l’onglet “Séquences”.

Les premières colonnes de cet onglet rappellent les flux à commenter et affiche les noms des systèmes (resp modules et composants) source du flux ainsi que les noms des systèmes (resp modules et composants) cibles du flux

Ident Flux	SysS	ModS	SysC	ModC
c_CP_IntAveIhm	Commercial	0	COMMANDES	IHM intranet
CPCC_SaiMetJou	COMMANDES	IHM intranet	COMMANDES	Gérer les commandes
CCCC_Commandes	COMMANDES	Gérer les commandes	COMMANDES	Commandes

Le commentaire du schéma va être généré automatiquement par des règles qui permettent de déterminer un “template de commentaire” par défaut et un “verbe d’action cible” (i.e. un verbe précisant comment le flux agit sur la cible), en fonction du type des objets analysés.

Pour nos trois flux, on trouve :

TemplateDéfaut	RgV
Acteur -> IHM	14
Mod -synchrone-> Mod	1
Mod-ecrit-> base	4

On voit que le premier flux a détecté la règle applicable n° 14, qui propose une formulation associée à un flux entre un acteur et un IHM.
Remarque : si le numéro de la règle est égal à 0, GRAF_Workshop n’a pas trouvé de règle applicable. Il est possible alors de rajouter une règle, de forcer un template de commentaire, ou encore de construire une formulation manuellement. Nous verrons dans un billet ultérieur comment ajouter des règles et des templates, ou changer totalement le paramétrage de la formulation.
Pour appliquer les règles :

• sélectionner les règles dans la colonne “RgV” et faire <ctrl>+<Maj>+V
• sélectionner les templates par défaut dans la colonne “TemplateDéfaut” et faire <Ctrl>+<Maj>+D

Séquence	Phrase
A1	Le "Commercial" interagit avec le module canal "IHM intranet" pour interagir avec l'IHM
A2	Le module canal "IHM intranet" appelle le service "saisir et mettre à jour les commandes" fourni par le module de paramétrage "Gérer les commandes"
A3	Le module de paramétrage "Gérer les commandes" enregistre les commandes dans le silo de données "Commandes"

Le commentaire apparait dans la colonne “phrase”. Nous n’avons plus qu’à saisir le numéro de séquence dans la colonne séquence.