Mise en place d’un workflow de validation de contenu dans Confluence


Publié par
Gael COURCELLE

22 février 2017

Vous souhaitez maîtriser le contenu des articles qui sont publiés dans votre Confluence ? Les add-ons Comala Workflow et Comala Publishing sont là pour vous. Cet article vous propose de suivre la mise en place d’un workflow de publication d’une version web d’un journal. Le workflow a été défini et deux espaces Confluence sont disponibles. L’un servira de Draft durant toute la rédaction de l’article et jusqu’à sa validation, l’autre accueillera l’article validé et mis en forme, dans un espace ouvert au public. Nous verrons dans un premier temps comment configurer le workflow puis les fonctionnalités offertes à l’utilisateur pour la rédaction de son article, et enfin l’automatisation de la publication de l’article fraîchement validé par le rédacteur en chef.

Installation et Configuration de Comala Workflow

Une fois l’add-on installé via la marketplace d’Atlassian, il faut instancier un workflow. Ce dernier peut être partagé pour toute l’instance ou bien spécifique à un espace. Un nouveau menu Workflows apparaît dans le bouton d’administration de votre espace :

image2016-9-19 14-13-52

Plusieurs Workflow types sont proposés lors de l’installation de l’add-on et peuvent être utilisés. Pour faciliter le workflow de notre article de journal je propose de rajouter un workflow de « validation d’article ». Cet ajout se fait depuis l’administration de l’add-on. Pour définir le workflow, utilisez la syntaxe wiki-markup, ce langage bien qu’un peu ancien, a l’avantage d’être rapidement pris en main. Pour plus de détails, je vous conseille de consulter la documentation complète de Comala.

Le paramétrage

Nous allons à présent nous occuper de définir les paramètres du workflow. Ces paramètres devront être instanciés lors de l’utilisation du workflow dans un espace. Dans cet exemple, je définis deux paramètres :

  • Un premier de type « groupe », qui va définir l’ensemble des utilisateurs Confluence qui feront partie du groupe « Secrétaire de Rédaction » (on se servira de ce paramètre dans la configuration du workflow).
  • Un second de type « user », qui définira l’unique « Rédacteur en Chef » de notre espace (de la même manière, il aura des droits additionnels).
{workflowparameter:Secrétaire de Rédaction|description=Secrétaire de Rédaction|type=group}
secretaire-de-redaction
{workflowparameter}
{workflowparameter:Rédacteur en Chef|description=Il recueille les propositions de sujets, en propose, peut assurer lécriture de certains.|type=user}
@user@
{workflowparameter}

Les statuts

Partie principale de notre workflow, la définition des différents états. On détermine ici les différentes étapes de validation, de l’état initial à l’état final. On profitera ici des paramètres définis juste au-dessus. Pour plus de détails sur les possibilités offertes par l’add-on, c’est par ici.

{state:Proposition|submit=En cours de rédaction}
{state}
{state:En cours de rédaction|submit=Relecture}
{state}
{state:Relecture|approved=Maquette|rejected=En cours de rédaction}
{approval:Relecture terminée|assignable=true|user=@Rédacteur en Chef@}
{state}
{state:Maquette|approved=Validation|rejected=En cours de rédaction}
{approval:Maquette|assignable=true|user=@Secrétaire de Rédaction@}
{state}
{state:Validation|approved=Published|rejected=En cours de rédaction}
{approval:Validation|assignable=true|user=@Rédacteur en Chef@}
{state}
{state:Published|final=true|hideselection=true}
{state}

Les triggers

Dernière configuration de notre workflow, la définition des triggers. Ces derniers permettent, par exemple, en fonction d’un changement d’état de déclencher une action (assigner la page à un utilisateur, positionner des meta-data Confluence, publier la page dans un espace public…).

Nous verrons cette partie plus en détails dans la description de l’add-on Comala Publishing.

{trigger:statechanged|state=Published}
    {publish-page}
{trigger}

Visualisation

Une fois la configuration terminée, Comala Workflow offre la possibilité de visualiser cette configuration sous forme graphique. Cette dernière pouvant servir de base de documentation du workflow.

FRworkflow

Instanciation du workflow dans un espace Confluence

Nous venons de voir comment définir un workflow qui est maintenant disponible dans l’administration des workflows d’un espace. Une fois le workflow sélectionné, il va falloir instancier les paramètres propres à l’espace :

image2016-9-19 13-43-35

Ici l’utilisateur pwhite aura le rôle de Rédacteur en chef de l’espace et les membres du groupe Secrétaire de Rédaction auront tous le rôle du même nom. Ainsi chaque étape du workflow utilisant ces paramètres bénéficiera de cette initialisation.

Utilisation du workflow

Une fois le workflow instancié pour l’espace, l’utlisateur aura directement la possibilité de voir le statut de sa page dans Confluence. Dans notre exemple, suite à la rédaction d’une proposition d’article, le premier état de notre workflow Proposition a automatiquement été sélectionné pour cet article.

image2016-9-19 13-59-42

Un nouveau menu apparaît sur la page. Il va permettre de faire passer l’article d’un statut à un autre jusqu’à la dernière validation avant publication. Ce menu ne sera visible que pour les utilisateurs qui disposent des droits pour faire passer l’article d’un statut à l’autre dans le workflow (voir plus haut dans la configuration des paramètres).

image2016-9-19 14-2-2

 

Automatisation de la publication d’un article dans un espace public

Configuration des espaces avec Comala Publishing

Comme vu précédemment nous avons mis en place deux espaces : l’un qui regroupe les propositions et la rédaction des articles et le second, ouvert au public, qui rassemblera l’ensemble des articles validés. A l’image de ce qui est proposé par Comala Workflow, un nouveau menu d’administration est disponible pour l’espace. Nous avons l’espace Sport qui sert d’espace de travail, alors que l’espace Sport Official, ci-dessous, contient les articles validés.

image2016-9-19 14-22-36

 

Automatisation de la publication

Lors de la configuration du workflow dans Comala Workflow, une instruction est rendue disponible dans la partie « triggers ». En utilisant tout simplement la balise publish-page, cette dernière va profiter de la configuration précédemment définie de l’espace de publication cible et déclenchera automatiquement sa publication dès l’instant où notre page arrivera dans l’état Published. Concrètement, la page et l’ensemble de ses pages filles seront copiées dans l’espace dit « Officiel » qui sera ensuite automatiquement publié.

{trigger:statechanged|state=Published}
    {publish-page}
{trigger}

Conclusion

Nous venons de voir une rapide présentation des add-ons Comala Workflow et Comala Publishing. Dans cet exemple le workflow représenté est relativement simple. Si votre workflow se complexifie et que vous vous sentez limité par les capacités de configuration de workflow, la meilleure solution s’appelle JIRA. Vous disposerez ainsi de toute la souplesse nécessaire ! Néanmoins la simplicité de configuration et d’utilisation de Comala expliquent leur popularité sur la Marketplace d’Atlassian !

Si vous avez la moindre question, n’hésitez pas à nous contacter.