====== DOCUMENTATION ======

====== TUTORIAUX ======

  * [[workflow:tutoriaux:stamp | Tâche de tamponnage automatique ]].

====== REFERENCES ======

===== Tâches =====

Liste des status d'une tâche :
^ Status ^ Définition ^
| NEW      | Nouvelle pochette|
| EVALUATE| Pochette à évaluer |
| EXECTASK| |
| PENDING | |
| TOCHECK | |

^ Désignation ^ Description ^ Script ^ Exemple ^
| MAJ de champ | Affecte une nouvelle valeur à un champ. Cette valeur peut être fixe(écrite "en dur") ou dynamique (issue d'un autre champ ou d'un paramètre d'une étape précédente) | @TABLE_CHAMP=<valeur%%|%%@parametre%%|%%@TABLE_CHAMP2>   | @FACTURE_VALIDE=@validefact|
| Attente | La tâche se met en attente (rien n'est effectuée) | nothing //ou// rien //ou// chaine vide | Utile pour bloquer le workflow à une étape en attente de réalisation d'une condition particulière |
| Fin | Indique que la tâche doit mettre fin au workflow (maj WFBAG_STATUS=CLOSED). | end //ou// fin | |
| Attacher des fichiers | Attache documents issus d'une table en indiquant la valeur d'un de ses champs (max 10 documents)| attach:<table,champ,requete_id,valeur_du_champ> | |
| Notification par mail | Envoi un email aux adresses spécifiées (séparées par une virgule ou un point virgule). Le mail contient un lien vers ezged et redirige vers la tâche. | email:<adresse_email1[(,%%|%%;)adresse_email2 ...]> | email:florian@ezdev.fr,arnaud@ezdev.fr |
| Envoi des fichiers par mail | Envoi des documents de la pochette par email | ermailf:florian@ezdev.fr,arnaud@ezdev.fr | emailf:<adresse_email1[(,%%|%%;)adresse_email2 ...]> | |
| Envoi dans la bannette | Envoi des documents de la pochette par bannette | bannette:<id_expediteur>,<groupe ou utilisateur, ...>  | bannette:1,Commerciaux,fabrice (Envoi au groupe des commerciaux + utilisateur fabrice)|
| Incrémenter un entier | Ajoute à la valeur du champ @CHAMP la valeur entière //valeurX// | incr:@CHAMP:<valeurX>  | incr:@FACTURE_COMPTEUR:1 |
| Executer script python |script::<script python> | Exécute le script python indiqué (chemin absolu ou relatif au répertoire des scripts). | SCRIPT::monscript.py |

==== MAJ de champ ====
La mise-à-jour de champ ne peut se faire que sur un champ présent sur la table principale de la requête à partir de laquelle le ou les documents sont rentrés dans le workflow.

On peut utiliser les macros suivantes :
  * @now
  * @userid
  * @username

=== Via texte fixe ===
Par texte fixe on entend du texte que vous saisissez "en dur" et qui ne provient ni d'un autre champ, ni d'un paramètre de tâche.

Un exemple de mise-à-jour de champ avec un texte libre
  @FACTURE_STATUS = "Validation compta"
  
=== Via un champ ===
On peut mettre à jour un champ en lui affectant la valeur d'un autre champ. Les deux champs (celui à mettre à jour et celui duquel on récupère la valeur) doivent se trouver sur la même table. Et cette table DOIT être la table principale de la requête.

  @FACTURE_LIB=@FACTURE_Fournisseur

La mise-à-jour d'un champ dans un autre va trouver son utilité si on l'a combine avec un texte fixe.
  @FACTURE_LIB="Facture de " + @FACTURE_Fournisseur

=== Via un paramètre ===
Fonctionnement similaire à la mise-à-jour via un champ sauf que l'on référence un paramètre d'une tâche de workflow.

  @FACTURE_VALIDE=@factvalid
  
Ici on met à jour le champ //FACTURE_VALIDE// avec la valeur du paramètre //factvalid// qui aura été précédemment (i.e lors d'une étape précédente) saisie par un utilisateur.

==== script:: ====

Les paramètres suivants (dans cet ordre) sont envoyés au script python qui est exécuté:
  - instance   : Le nom de l'instance (par défaut //instance//)
  - jobqueueid : Le numéro du travail de type "Serveur de Workflow".
  - secusrid   : L'ID de l'utilisateur auquel appartient le travail.
  - WFBAG_ID   : L'ID de la pochette de workflow.
  - WTASK_ID  : L'ID de la tâche qui est exécutée.

==== email:: et emailf:: ====

L'adresse de l'expéditeur sera l'email de l'utilisateur ezged d'identifiant 1 (i.e //admin// dans la configuration
de base).



===== Conditions =====

^ Script ^ Description ^ Exemple ^
| EVAL::<expression booléenne> | Evalue l'expression booléenne qui suit EVAL:: | EVAL::5>4 |
| SCRIPT::<script python> | Exécute le script python indiqué (chemin absolu ou relatif au répertoire des scripts). | SCRIPT::monscript.py |
| FLAGF::<parametre workflow> | | |
| FLAGT::<parametre workflow> | | |
| <expression python> | Evalue l'expression python en procédant à certaines substitutions de variables | |

==== script:: ====

Les paramètres suivants (dans cet ordre) sont envoyés au script python qui est exécuté:
  - instance   : Le nom de l'instance (par défaut //instance//)
  - jobqueueid : Le numéro du travail de type "Serveur de Workflow".
  - secusrid   : L'ID de l'utilisateur auquel appartient le travail.
  - WFBAG_ID   : L'ID de la pochette de workflow.
  - WFCOND_ID  : L'ID de la condition qui est évaluée.

==== Expression python ====
L'expression python sera ici une expression booléenne puisque l'objectif pour une condition est de retourner Vrai ou Faux (0 ou 1)

Notons qu'avant d'être évaluée l'expression python va éventuellement subir quelques substitutions.

Voici les variables qui peuvent être substituées :\\
**@UN_CHAMP_DE_TABLE** sera substitué par la valeur du champ.\\
**@un_param_workflow** sera substité par la valeur du paramètre workflow correspondant.

Si le champ est à //NULL// dans la base de donnée, python va récupérer la __chaîne de caractère__ //None//
Ainsi donc si vous souhaitez tester si le champ FACTFOUR_NUM est à NULL voici la condition à saisir:
  @FACTFOUR_NUM == 'None'
  
Les champs qui peuvent être référencés sont:
  * Les champs sélectionnés par la requête à partir de laquelle le ou les documents auront été ajouté à la pochette de workflow.
  * Tout les champs de la table principale de la requête source.

==== Exécuté en tant que ====
Cette fonctionnalité permet d'exécuter une requête avec un identifiant utilisateur autre qu'admin.

Pour l'utiliser, il faut paramétrer un Valideur ID sur la tâche du workflow.
Paramètre de la tâche > cliquez sur le bouton + > cliquez sur Paramètre ID valideur.

{{:1.png?400|}}

Une fois le formulaire renseigné, retournez sur l'étape du scénario, dans la liste des conditions, renseignez une condition et dans la colonne "Exécuté en tant que" saisissez le nom de la variable qui représentera l'identifiant du valideur.

{{:2.png?400|}}