Lutece : guide intégrateur
Définir un workflow
Qu'est-ce qu'un workflow dans Lutece ?
Le workflow désigne dans Lutece le circuit de traitement d'un dossier ou d'une demande. Une demande (ou un dossier) passe dans des états différents en fonction de l'avancement de son traitement et des actions effectuées.
Avant de créer un workflow vous devez définir le circuit de traitement de votre dossier ou de votre demande.
Le plugin workflow est utilisé ici, pour la description des fonctionnalités, avec le plugin de gestion des données plugin-directory (annuaire).
Dans notre exemple, voir le schéma ci-dessous, les candidats postulent pour obtenir une bourse.
La collectivité a donc défini un circuit de traitement de la demande. Pour cela, l'administration vérifie si la candidature répond aux critères de recevabilité. Puis en fonction des critères de la demande, celle-ci est transférée au jury compétent pour évaluer les motivations du candidat.
Exemple de circuit de traitement fonctionnel de la demande
Dans le workflow Lutece, pour cet exemple les états seront les suivants :
- Nouvelle demande
- A traiter
- Eligible
- Non éligible
- Transmis
- Evalué
- Lauréat
- Non lauréat
Pour faire passer le dossier d'un état à l'autre, plusieurs actions vont être mises en oeuvre. Pour passer de l'état "nouvelle demande" à "à traiter", une action va être mise en place pour envoyer automatiquement un mail au demandeur avec un accusé réception de sa demande. De l'état "nouvelle demande", le dossier passera à "traité".
Une action manuelle permettra de passer de " à traiter" à "éligible" ou "non éligible", en fonction de la première étude qui est faite par la collectivité.
Les demandes sont dans le plugin utilisant le workflow (ici le plugin directory) sous forme de tableau et les boutons d'action présents au regard de chaque demande permettent d'agir sur cette dernière.
Exemple :
Construire un workflow
Dans le menu de navigation, aller dans la "gestion des workflows". Cliquer sur créer un workflow.
Renseigner le titre du workflow :
Cliquer sur le bouton modification pour créer des états et des actions :
Créer les états
Pour identifier le premier état, cocher "état initial" cela permettra le déclenchement automatique d'une action comme l'envoi d'un mail.
Créer les actions
Ajouter une action
Cliquer sur ajouter une action, et paramétrer-la en indiquant :
- Le nom de l'action
- L'état de départ puis l'état d'arrivée une fois l'action exécutée
- L'icône ou le bouton d'action sur lequel vous allez cliquer dans l'annuaire pour agir sur la demande et la faire passer d'un statut à l'autre
- Vous pourrez ensuite ajouter des tâches à cette action pour y ajouter des traitements automatiques
- Plusieurs types de tâches automatiques sont possibles. Il s'agit de modules supplémentaires à workflow qui doivent être assemblés si vous souhaitez vous en servir. Ces services ne sont pas fournis avec workflow seul.
Paramétrer l'action :
Modifier ensuite l'action pour y ajouter des tâches :
Plusieurs tâches peuvent être disponibles dans la liste :
- Affectation automatique permet par exemple d'attribuer une demande à un groupe de travail selon un critère déterminant. Par exemple, une demande d'un élève qui postule dans un cours d'art dramatique sera attribuée pour évaluation à un groupe de travail "jury d'art dramatique"
- Notifier une entrée du directory permet de configurer une tâche permettant d'envoyer un mail ou un sms si votre service le permet à la personne qui a déposé sa demande
- Notification permet de notifier un groupe de travail interne à l'application de l'arrivée d'une nouvelle demande par exemple.
Dans notre exemple nous allons utiliser "notifier une entrée du directory" pour envoyer un accusé de réception au demandeur
Créer et modifier une tâche
Sélectionner la tâche "notifier une entrée du directory" et modifier-la pour la configurer
Configurer la tâche en remplissant tous les champs.
- Sélectionner l'annuaire de référence sur lequel vous vous appuyez et valider.
- Sélectionner la position de l'e-mail dans l'annuaire pour identifier l'adresse à laquelle doit être envoyée la notification.
- Rédiger le mail. Les champs sont représentés via la syntaxe Freemarker, sous forme de {position_1}. Vous pouvez composer l'e-mail en reprenant l'ensemble des informations saisies par le demandeur en reprenant ces balises. Dans le mail, les valeurs seront remplacées par ce que le demandeur a saisi.
- N'oubliez pas d'associer le workglow à l'annuaire
NB : Ces trois étapes sont très importantes et si elles ne sont pas correctement exécutées.
Si lors des tests, le mail ne vous parvient pas, les causes possibles sont les suivantes :
- Le serveur de messagerie n'a pas été bien configuré (la configuration est à vérifier dans le fichier de propriétés config.properties)
- L'annuaire et le workflow n'ont pas été correctement associés
- Le champ comportant l'e-mail n'a pas été associé dans cette interface
- La syntaxe des balises Freemarker n'a pas été strictement respectée
Exemple d'e-mail restitué au demandeur :
Utiliser un workflow pour exporter un formulaire ou une enquête dans un annuaire
La mise en place et l'utilisation d'un annuaire comporte de multiples avantages, ainsi vous pouvez :
- ajouter la date de création de chacun des enregistrements,
- ajouter des champs de recherche, modifier le libellé d'un champ ou sa présence,
- ajouter des champs pour traiter la demande,
Le worflow sera mis en place en suivant ces étapes :
- Créer le formulaire
- Gérer les processus externes dans le formulaire et créer l'annuaire
- Créer le workflow et associer l'annuaire et le champ e-mail de l'annuaire pour envoyer un e-mail
- Associer le workflow à l'annuaire dans les paramètres avancés de l'annuaire.