Le but de ce document est de décrire les étapes pour mettre en place un Workflow.

Dans Freedom un Workflow est appelé “Cycle de vie”.

Pour mettre en place un cycle de vie, il faut créer ou modifier plusieurs choses :

• Un fichier PHP qui définit le fonctionnement du cycle de vie (Etats, transitions,..)
• Une famille de cycle de vie utilisant le fichier PHP précédent
• Un document cycle de vie basé sur la famille précédente. Il est possible de créer plusieurs cycles de vie basés sur la même famille de cycle de vie.
• Une famille de documents sur laquelle le cycle de vie sera appliqué. Il est possible d'affecter un cycle de vie à plusieurs familles de documents.
• Un profil général affecté au cycle de vie ou un profil particulier pour chaque étape du cycle de vie. Cela permet de gérer qui a le droit de faire quoi sur chaque étape du cycle de vie.
• Il est possible également de créer un masque particulier pour chaque étape du cycle de vie pour afficher ou masquer certains champs en fonction de l'état d'avancement du document dans le cycle.
• Les modèles de courriel à envoyer.
• Les déclencheurs pour ajouter des alarmes suivant des critères de temps.

Dans ce document, nous allons décrire toutes les étapes nécessaires à la mise en place du cycle de vie ci-dessous :

Dans cet exemple, un document peut avoir 4 états :

• Brouillon
• Validé,
• Archivé
• Poubelle

Les transitions pour passer d'un état à un autre sont nommées :

• Validation : Pour passer de l'état « Brouillon » à l'état « Validé »
• Correction : Pour passer de l'état « Validé » à l'état « Brouillon »
• Archivage : Pour passer de l'état « Validé » à l'état « Archivé »
• Destruction : Pour passer de l'état « Brouillon » à « Poubelle » ou de l'état « Validé » à l'état « Poubelle »

Pour décrire ces états et ces transitions, il faut créer un fichier PHP comme indiqué au chapitre suivant.

Le fichier PHP définissant le cycle de vie, sera placé dans le dossier « /usr/share/what/FDL » Son nom sera sous la forme : « Class.WDocTestCycle1.php » correspond au nom de la classe de la famille de cycle de vie que nous allons créer au chapitre suivant. Voici le contenu de ce fichier qui permet de définir notre cycle de vie :

 <?php
include_once("FDL/Class.WDoc.php");
 
Class WDocTest extends WDoc {
 
var $attrPrefix="WDT";
var $firstState="wdt_Draft";
 
var $transitions = array("wdt_Approvement"=>array(),
			 "wdt_Correction"=>array(),
			 "wdt_Chechin"=>array(),
			 "wdt_Destroy"=>array());
 
 var $cycle = array(array("e1"=>"wdt_Draft",
			  "e2"=>"wdt_Approved",
			  "t"=>"wdt_Approvement"),
		    array("e1"=>"wdt_Approved",
			  "e2"=>"wdt_Check",
			  "t"=>"wdt_chechin"),
		    array("e1"=>"wdt_Approved",
			  "e2"=>"wdt_Draft",
			  "t"=>"wdt_Correction"),
		    array("e1"=>"wdt_Draft",
			  "e2"=>"wdt_Obsolete",
			  "t"=>"wdt_Destroy"),
		    array("e1"=>"wdt_Approved",
			  "e2"=>"wdt_Obsolete",
			  "t"=>"wdt_Destroy"));
}
?>

Commentaires sur les variables :

• $firstState : État initial. Si cette variable n'est pas initialisée, le document sera dans un état indéterminé à la création ce qui en général, n'est pas souhaitable.
• $cycle : Cette variable permet de définir le nom des états et des transitions. Elle permet également de définir quelle transition utilisée pour passer d'un état à un autre
• $transition : Cette variable détermine le nom des transitions

Attention :

• Le nom de la « class » doit correspondre au nom du fichier et au nom indiqué dans les attributs de la famille (attention également au respect des minuscules/majuscules).
• Il est possible de modifier ce fichier à tout moment¹⁾. Les modifications sont immédiatement prises en compte dans tous les documents utilisant cette famille de cycle de vie.
• Il ne faut pas utiliser de caractères spéciaux (accents) et d'espaces dans le nom des transitions et des étapes (Pour avoir des accents dans les documents finaux, il faut passer par gettext pour traduire les différents termes)

Il n'est pas possible de créer une famille cycle de vie dans Freedom. Il faut donc créer cette famille dans OOo et l'importer dans Freedom. Vous trouverez dans ce fichier la définition de cette famille :

Dans ce paramétrage, la seule chose vraiment importante est le nom de la classe et donc du fichier PHP à utiliser. Dans notre cas, c'est « WDocTest »

Pour importer dans Freedom ce fichier (wtest.ods) OpenOffice.org contenant la définition de la famille, il faut se rapporter à la documentation concernant l'importation de familles. Mais en résumé, cette commande, permet d'importer cette famille dans Freedom :

/usr/share/what/wsh.php --api=freedom_import --file=wtest.ods

Remarques :

• Il faut obligatoirement créer le fichier PHP de définition du cycle avant d'importer la famille sinon l'importation échouera.
• Une fois cette famille de cycle de vie importée, elle apparaît dans la liste des familles mais pas dans la liste des cycles de vie.

Une fois la famille importée, il faut créer un document basé sur cette famille. Ce document apparaîtra dans la liste des cycles de vie disponible. C'est sur ce document qu'il sera possible d'affecter un profil et donc des droits différents en fonction des besoins.

Voici comment créer ce document :

• Sélectionnez la famille de cycle de vie “Test” importée précédemment.
• Faire un clic-droit sur cette famille et sélectionnez “Créer cycle de test”.
• Donnez un titre à votre document cycle de vie.

Une fois ce document créé, il est possible de voir graphiquement le cycle de vie en cliquant sur le 'Voir le graphe' :

Remarque :

• Il est possible de modifier le fichier PHP « Class.WDocTest.php » et de voir instantanément le changement au niveau du graphe dans ce document cycle de vie et dans tous les documents créés à partir de la famille cycle de vie importée précédemment.
• Il est possible de supprimer, modifier et ajouter des états et des transitions

Le cycle de vie créé doit être associé à une famille de document.

Pour affecter un cycle de vie à une famille, il faut :

1. Sélectionner la famille de documents de votre choix
2. Sélectionner « Choisir un cycle »
3. Sélectionner le cycle de vie créé précédemment

Une fois le cycle choisi, les document de cette famille sont lié à ce nouveau cycle. Si des documents de cette famille étaient déjà liés à un autre cycle, ceux-ci ne sont impactés par ce changement.

Remarque : Il est possible d'utiliser un même cycle de vie pour plusieurs familles de documents.

L'initialisation du cycle de vie permet de réinitialiser les attributs du cycle. Ceci est nécessaire lors de la première édition ou lors du modification du fichier de définition du cycle (classe documentaire). ensuite en éditant ce dernier de sélectionner :

• un profil en fonction de l'état
• une couleur en fonction de l'état
• un masque en fonction de l'état

Pour initialiser un cycle de vie, il faut :

• Sélectionner le document cycle de vie créé précédemment
• Cliquer sur “Initialisation”

Une fois le cycle de vie initialisé, des attributs correspondants aux états sont ajoutés à la famille du cycle de vie.

Pour voir ces attributs ajoutés, il faut :

• Faire un clic droit sur la famille de cycle de vie importée
• Sélectionner “Éditer les attributs”

ATTENTION : Il est conseillé d'initialiser le cycle de vie une fois les états et transitions figés car ensuite, il n'est plus possible de supprimer les attributs ajoutés à la famille du cycle de vie.

L'affectation d'un profil au document cycle de vie permet d'affecter des droits différents pour chaque étape de ce cycle. Pour cela, il faut :

• Sélectionner le document de cycle de vie dans le dossier de recherche « les cycles »
• Sur le document du cycle de vie, sélectionner « Sécurité/Changer de profil » et sélectionner « Contrôle dédié »
• Sur le document du cycle de vie et sélectionner « Sécurité / Accessibilité »
• Dans le tableau qui apparaît, il faut cliquer sur les petits rectangles gris à droite des groupes pour faire apparaître des cases à cocher

* Il faut sélectionner les cases à cocher en fonction de vos besoins et valider

Pour plus d'information sur la gestion des profils, il faut suivre la documentation correspondante.

Pour plus d'explications sur la modification des droits du profil, il faut suivre la documentation sur les profils

Remarques :

• Par défaut, un simple utilisateur n'a pas accès aux transitions du cycle de vie. Il faut donc obligatoirement modifier le profil pour autoriser les personnes à modifier les étapes du cycle de vie.
• L'administrateur de Freedom a accès à toutes les étapes d'un cycle de vie et à tout moment et quelque soit les transitions autorisées.
• Il n'est pas possible d'affecter un profil à un document cycle de vie. Il faut obligatoirement créer un « Contrôle dédié ». Cependant, il est possible d'affecter un profil différent pour chaque étape du cycle de vie une fois le cycle initialisé.
• Il est possible de créer un cycle de vie générique avec de nombreuses étapes et transitions. A partir de là, il est possible de créer plusieurs documents de cycles de vie avec chacun un profil différent.

Avant de tester le cycle de vie, il faut affecter des droits différents à au moins deux utilisateurs au niveau du profil et voir comment évolue le document en fonction des états. En fonction de l'état du document et de l'utilisateur, les boutons permettant de passer d'un état à un autre sont modifiés.

Pour tester le cycle de vie il faut simplement créer un nouveau document basé sur la famille utilisant ce cycle de vie.

Remarque : L'administrateur de Freedom a toujours accès à tous les boutons de changement d'état quelque soit le paramétrage du cycle de vie.

Pour gérer encore plus finement les droits, il est possible d'affecter un profil différent sur chaque étape du cycle de vie.

Pour cela, il faut créer un profil différent pour chaque étape du cycle de vie. Pour créer un profil, il faut suivre cette documentation.

Ensuite, il faut modifier le document cycle de vie et affecter les profils aux différents états

Remarque : Cela est possible seulement si le cycle de vie à été initialisé comme indiqué dans un chapitre précédent.

Pour identifier plus facilement dans quel état est le document, il est possible d'affecter des couleurs différentes pour chaque état du cycle de vie. Pour cela, il faut :

• Modifier le document cycle de vie
• Indiquer pour chaque état du cycle de vie, la couleur souhaitée

Une fois les couleurs définies, voici le résultat obtenu dans les différents écrans :

• Changement d'état d'un document sous forme de liste déroulante

• Liste des documents dans le module “Une Famille”

En fonction de l'état du document il est possible d'afficher ou masquer certains champs en appliquant un masque différent à chaque étape.

Pour créer un masque, il faut :

• Depuis le module “Gestion documentaire”, sélectionner le menu “Création / Document système”.
• Dans la liste “hérite de”, sélectionner “masque de saisie.
• Dans la liste “pour” sélectionner une famille.
• Indiquer le nom du masque de saisie
• Pour chaque attribut, il est possible de modifier sa visibilité et son obligation

Pour affecter un masque sur une étape du cycle de vie, il faut :

• Créer un masque différent pour chaque étape comme expliqué ci-dessous.
• Modifier le document cycle de vie.
• Indiquer pour chaque état du cycle de vie, le masque souhaité.

Remarque : Pour retrouver facilement la liste des masques de saisie, il est possible de sauvegarder une recherche simple basée sur la famille “masque de saisie”

Si le masque ne suffit pas pour renseigner différentes parties du document, il est possible d'associer un contrôle de vue par état. Le contrôle de vue permettra d'avoir des masques différents par états. Le profilage de chaque contrôle de vue permettra d'appliquer différent masques suivant l'utilisateur.

Version 2.11.12

Les états du cycle définissent l'état du document à un moment donné. Il sont définis par des adjectifs comme 'validé', 'archivé', 'contrôlé'. Pour chacun de ces états, une activité peut être définie afin d'indiquer ce que doit faire celui qui a en charge du document. Cette activité peut être par exemple 'rédaction','vérification','à confirmer'. Les activités peuvent être notées dans les attributs 'activité' du cycle de vie. Ils peuvent ainsi être différent par instance de cycle. Ils peuvent aussi être définis dans la classe du cycle, dans ce cas les attributs seront non modifiable par l'interface. Dans l'exemple ci-dessous, pour l'état 'validé' nous avons défini l'activité 'en cours d'archivage'.

Lorsqu'on a défini une activité, on peut aussi définir qui doit faire l'activité. Bien qu'une activité puisse être réalisée à plusieurs, un seul responsable peut être désigné. Un document ne peut être affecté qu'à un seul utilisateur à la fois.

On peut récupérer l'acteur à partir d'attribut relation (type 'docid') référençant un utilisateur. Cet attribut peut être récupéré à partir du document (attribut ou paramètre de famille) ou à partir du cycle (attribut ou paramètre de famille du cycle). Dans l'exemple ci-dessus, le documentaliste sera affecté comme responsable lorsque le document passera dans l'état archivé. Si vous cochez “auto-verrouillage” le document sera verrouillé pour l'acteur. Si vous cochez “courriel automatique”, un courriel d'affectation sera envoyé à l'acteur au moment du changement d'état.

Une fois l'utilisateur affecté, il peut ré-affecter le document s'il a le droit d'éditer le document. Dans ce cas le menu “ré-affecter” apparaîtra sur le document. L'affectation est une des propriétés du document. On retrouvera la personne responsable lorsqu'on consulte les propriétés du document. Pour connaître la liste des documents qui vous sont affectés on peut utiliser le service portail “mes documents affectés” depuis l'application portail. Ce service utilise la recherche 'MY_AFFECT_DOCS' qui peut être utilisés aussi dans la gestion documentaire et comme flux RSS.

Pour aller plus loin dans l'utilisation des cycles de vie, il faut suivre le chapitre correspondant dans le manuel de programmation.