For the complete documentation index, see llms.txt. This page is also available as Markdown.

Connecteurs Génériques

Workey est livré avec divers connecteurs Java pouvant être utilisés facilement dans vos processus

Connecteurs standard

Nom
Description

Retourne dans un champ multivalué les acteurs appartenant aux unités organisationnelles passées en paramètre et/ou jouant les rôles spécifiés.

Retourne dans un champ multivalué les noms des unités situées dans un intervalle donné dans la hiérarchie des unités par rapport à l'unité à laquelle appartient un acteur donné.

Ajoute un acteur dans le paramètre UO spécifié en temps que lecteur pour le document courant.

Effectue une requête HTTP sur un service REST.

Retourne un identifiant incrémenté automatiquement.

Vérifie le status d'un document en cours de signature avec le service Contrat Privé.

Copie les valeurs des champs portant le même nom depuis le document père vers ses documents fils.

Copie les valeurs des champs portant le même nom depuis le document père vers ses documents descendants (fils, petits-fils, arrières petits-fils etc.)

Copie les valeurs des champs portant le même nom depuis un document fils vers son document père.

Initie un document à signer à l'aide du service Contrat Privé.

Crée un document docx depuis un document Workey.

Transforme un fichier docx en pièce jointe d'un document Workey en fichier pdf.

Recherche et retourne des informations dans l'annuaire utilisateurs.

Fusionne plusieurs fichiers PDF en un seul

Permet de générer une fiche de circulation au format pdf à partir d'un document Workey.

Lance des opérations modélisées sur des documents fils.

Récupére des informations directement dans le LDAP.

Crée un fichier pdf depuis un document Workey.

Ajoute l’ensemble des acteurs de l'unité de l’acteur courant en tant que lecteurs du document.

Exécute un script Groovy en tant que connecteur Workey.

Appel du Webservice Starpage pour générer un PDF à partir des données du formulaire

Connecteurs d'événements

Nom
Description

VelocityMailConnector (preNotification)

Création d'un dossier MG depuis un composant Pièce Jointe.

MailConnectorSaveMail (preNotification)

Ce connecteur permet de d'enregistrer sur disque les courriels de notifications.

GroovyMailConnector (preNotification)

Ce connecteur permet de modifier les notifications à partir de scripts Groovy.

HTMLMailConnector (preNotification)

Connecteur d'événement pour convertir le type de contenu d'un mail texte en html.

Connecteurs Multigest 9

Nom
Description

Création d'un dossier MG depuis un composant Pièce Jointe.

Ce connecteur permet de synchroniser les fichiers d'un composant Pièce Jointe Workey vers un dossier dossiers MG.

Ce connecteur permet de synchroniser les valeurs des champs d'un document Workey vers les métadonnées d'un dossier MG.

ActorsOuMembers

Description

Connecteur: com.clog.workey.connectors.ActorsOuMembers

Action

Ce connecteur retourne dans un champ multivalué les acteurs appartenant aux unités organisationnelles passées en paramètre et/ou jouant les rôles éventuellement spécifiés.

  • Si les deux paramètre sont remplis, c'est l'intersection des acteurs qui est retournée : seuls sont gardés les acteurs appartenant à la fois aux unités et aux rôles.

  • Si l'un des paramètre est vide, il est ignoré.

  • Si les deux paramètres sont vides, l'ensemble des acteurs de la base est retourné.

Seuls les rôles spécifiques à la version du processus courant, et qui ne concernent que le type de document courant sont pris en compte.

Entrée

  1. DN des unités organisationnelless (multivalué, peut être vide)

  2. Nom interne des rôles (multivalué, peut être vide)

  3. (optionnel) Nom de la propriété LDAP concernant le nom de l'acteur a afficher. Seulement utilisé si le paramètres suivant est à "1"

  4. (optionnel) Mettre à "1" si le connecteur est utilisé pour alimenter un domaine de valeur

Sortie

  1. Le DN des acteurs correspondant aux critères d'unité et de rôle

ou bien, si c'est pour alimenter un domaine :

  1. Couples {DN_ACTOR, valeur de la propriete LDAP utilisé en troisième paramètre} des acteurs correspondant aux critères d'unité et de rôle.

ActorsUnitHierarchy

Description

Connecteur: com.clog.workey.connectors.ActorsUnitHierarchy

Action

Ce connecteur retourne dans un champ multivalué les noms des unités situées dans un intervalle donné dans la hiérarchie des unités par rapport à l'unité à laquelle appartient un acteur donné.

Entrée

  1. ID de l'acteur (entier, mono-valué)

  2. Niveau supérieur de l'intervalle hiérarchique (entier, mono-valué)

  3. Niveau inférieur de l'intervalle hiérarchique (entier, mono-valué)

  4. (optionnelle) Nom de la propriété LDAP concernant le nom de l'acteur à afficher

Sortie

  1. La liste des noms internes des unités appartenant à la tranche hiérarchique choisie.

Exemple

Par exemple, avec les paramètres Niveau supérieur=3, Niveau inférieur=1 et Id acteur=1001, le connecteur retournera la liste de toutes les unités situées entre le niveau +1 et +3 de la hiérarchie des unités par rapport à l'unité à laquelle appartient l'acteur identifié par 1001.

Les paramètres Niveau supérieur et Niveau inférieur peuvent être renseignés par des valeurs négatives. La seule restriction étant que Niveau supérieur soit supérieur ou égal à Niveau inférieur.

Avec Niveau supérieur=-1 et Niveau inférieur=-1, on obtient toutes les sous-unités de l'unité de l'acteur identifié. L'identifiant de l'acteur courant peut être obtenu par la fonction STalk userId().

AddReadersFromUo

Description

Connecteur: com.clog.workey.connectors.AddReadersFromUo

Action

Ajoute les membres d'un Unité Organisationnelle en tant que lecteur sur le document courant.

Entrée

  1. DN de l'unité organisationnelle (monovalué)

Sortie

  1. Aucun

ApiRest

Ce connecteur fait, à lui seul, l'objet d'une documentation dédiée ici.

AutoNumbering

Description

Connecteur: com.clog.workey.connectors.AutoNumbering

Action

Ce connecteur retourne une valeur auto-incrémentée tirée d'une table externe. Un paramètre peut lui être transmis pour spécifier la valeur d'une clef associée à cette valeur. Par défaut, la table externe se trouve dans une datasource nommée "workey-incrmt-ds". La table se nomme "INCREMENT" et contient deux colonnes, "ID" et "KEY_VALUE". Ainsi, la table peut être créée par l'ordre SQL suivant (MySQL): create table INCREMENT ( ID int(11) not null, KEY_VALUE text );

Les différents éléments peuvent être configurés à l'aide des propriétés système suivantes :

  • com.clog.workey.connectors.AutoNumbering.datasource: Nom de la source de données

  • com.clog.workey.connectors.AutoNumbering.tableName: Nom de la table externe

  • com.clog.workey.connectors.AutoNumbering.idField: Nom de la colonne contenant l'Id

  • com.clog.workey.connectors.AutoNumbering.keyField: Nom de la colonne comportant la clé

Entrée

  1. (optionnel) Clé à utiliser pour distinguer les différents ID à incrémenter. Le nombre courant est récuperé dans la table en utilisant la requête

Sortie

La nouvelle valeur incrémentée de la colonne "ID".

Attention

Dans les versions dans les versions antérieures à la 6.11.3, si la clé en paramètre d'entrée n'était pas utilisée dans un processus, mais que d'autres connecteurs utilisaient une clé, tous les ID de la table étaient incrémentées par le premier connecteur. A partir de la version 6.11.3, tous les ID sont distincts, la valeur NULL est utilisée s'il n'y a pas de clé passée en paramètre. Cependant, pour conserver l'ancien comportement, vous pouvez définir la propriété système suivante: com.clog.workey.connectors.AutoNumbering.incrementAll=true

CopyFieldsToChildren

Description

Connecteur: com.clog.workey.connectors.CopyFieldsToChildren

Action

Ce connecteur permet de copier des champs du document père vers son document fils. Les champs doivent porter le même nom interne entre le document père et le document fils.

Entrée

  1. Liste des noms internes des champs du document père à recopier (multi-valué)

Sortie

  1. Aucun

CopyFieldsToDescendants

Description

Connecteur: com.clog.workey.connectors.CopyFieldsToDescendants

Action

Ce connecteur permet de copier des champs du document père vers ses documents descendants (fils, petits-fils...). Les champs doivent porter le même nom interne entre le document père et les documents de sa descendance.

Entrée

  1. Liste des noms internes des champs du document père à recopier (multi-valué)

Sortie

  1. Aucun

CopyFieldsToFather

Description

Connecteur: com.clog.workey.connectors.CopyFieldsToFather

Action

Ce connecteur permet de copier des champs d'un document fils vers sont document père. Les champs doivent porter le même nom interne entre le document fils et le document père.

Entrée

  1. Liste des noms internes des champs du document fils à recopier (multi-valué)

Sortie

  1. Aucun

DocxMergeConnector

Description

Connecteur: com.clog.workey.connectors.DocxMergeConnector

Action

Ce connecteur permet la création d'un fichier au format docx depuis un formulaire Workey et y recopie les valeurs contenues dans des champs (texte, listes, tableaux). Le fichier ainsi créé sera enregistré localement ou sur le réseau.

Entrée

Divers champs sont indispensables au paramétrage du connecteur

Nom du champ
Paramètre
Ordre de tri
Typologie
Valeur par défaut

docxSource

Entrée

1

Ligne simple ou Liste (valeur par défaut) Champ monovalué

Nom du document utilisé comme modèle (par ex, template.docx)

templateDir

Entrée

2

Ligne simple(valeur par défaut) champ masqué

Chemin (physique ou relatif) de l’emplacement du modèle (exemple C:\Workey-Tomcat\Tomcat-7.0.40\workey\docx\). Si cette valeur est vide, le chemin défini dans la propriété "DocxMergeConnector.defaultModelsPath" est utilisé.

mergeDir

Entrée

3

Ligne simple(valeur par défaut) champ masqué

Chemin (absolu ou relatif) de l’emplacement du document créé (exemple C:\Workey-Tomcat\Tomcat-7.0.40\workey\docx_fusion). Si cette valeur est vide, le chemin défini dans la propriété "DocxMergeConnector.defaultOutputPath" est utilisé.

printer

Entrée

4

Ligne simple (valeur par défaut) champ masqué

NO_PRINT

attachmentField

Entrée

5

Ligne simple(valeur par défaut) champ masqué

Nom du champ utilisé en tant que valeur par défaut pour accueillir le résultat de la fusion (Exemple Docx_Fusion).

attachmentFieldname

Entrée

6

Ligne simple (expression ou expression calculée) champ masqué

Valeur utilisée en "expression" ou "expression calculée" en stalk selon le gabarit du nom du document attendu (exemple id() + "-" + Nom + " " + Prenom + ".docx")

Docx_Fusion

Sortie

1

Pièce jointe

Facultatif : si vous n'en mettez pas, seul le fichier du dossier spécifié sera créé et le connecteur se terminera sans renseigner de pièce-jointe dans le formulaire

Conseil

A partie de la version 6.10.7 de Workey, il est possible de configurer les paramètres en passant en second paramètre un objet au format JSON, le premier paramètre restant le nom du fichier modèle.

Sortie

  1. Champ pièce jointe où retrouver un doublon du fichier déposé dans le dossier spécifié (facultatif)

Particularités et typologies de champs associées au modèle DOCX

Le principe de la classe java préalablement configurée est de faire correspondre des champs Workey avec les champs du modèle Word (.docx).

Avant de commencer il est impératif de paramétrer Word afin que les guillemets ne soient pas modifiés par le correcteur orthographique.

Allez dans Fichier/Option/Vérification et cliquez sur le bouton option de correction orthographique et décocher la première ligne "Guillements …" (voir copie d'écran ci-dessous)

Depuis les champs Workey on peut insérer les valeurs attendues en préfixant les champs Workey dans le modèle Word par :

Dans ces exemples, on remarquera que l’on peut insérer des valeurs de différents types (champs, tables dynamique, images) tout en prenant en compte des différentes polices de caractères et couleurs associées. Les champs de mon exemple sont entre " ", on a ainsi, à titre d'exemple :

  • Adresse

  • Couleurs

  • Description

Champs multivalués

Depuis la version 6.10.1, Pour afficher les valeurs d'un champ multivalué séparées par une chaîne de caractère, vous pouvez utiliser la fonction join(sep, field). Ainsi pour afficher les Couleurs séparées par des virgules, il faudra mettre : ${join(", ", fields["Couleurs"])}

Insertion de tableaux

On remarque également que l’on peut intégrer des champs de la modélisation dans des tableaux docx.

Pour réaliser cette intégration on nécessite non seulement de faire la correspondance des différents champs mais également d’associer un commentaire (voir image ci-dessous) sur la globalité de la ligne du tableau.

Ce dernier point est crucial si on veut faire correspondre une table dynamique au tableau inséré dans le document docx.

DocxToPdfConnector

Description

Connecteur: com.clog.workey.connectors.DocxToPdfConnector

Action

Ce connecteur permet de transformer des fichiers au format docx contenus dans des champs pièces jointes de document Workey au format pdf.

Le paramétrage pour la mise en place du connecteur DocxToPdfConnector est possible à partir de l'interface "Procédures" dans Workey Designer.

La configuration des propriétés permet de définir l'affichage et le comportement du connecteur. Les valeurs principales sont les suivantes:

Entrée

  1. Champ de type pièce-jointe. Peut être un champ à valeurs multiples. Liste des noms internes des champs pièces jointes contenant les fichiers docx à transformer (multi-valué)

Sortie

  1. Liste des UUID des pièces jointes converties au format pdf. Ces UUID peuvent servir à alimenter un champ pièces jointes.

MergePdfFiles

Description

Classe : com.clog.workey.connectors.MergePdfFiles

Action

Ce connecteur permet de fusionner plusieurs fichiers PDF en un seul.

Un premier paramètre (optionnel) peut contenir la configuration de ce connecteur.

Autant de champs pièce-jointe que voulu peuvent être fusionnés. Si un champ contient plusieurs pièces-jointes, celles-ci seront toutes fusionnées, en sautant éventuellement les fichiers qui ne sont pas des PDF.

En entrée

  1. Configuration JSON (champ texte monovalué, optionnel)

  2. Fichiers PDF (champ pièce-jointe monovalué ou multivalué)

  3. Fichiers PDF (champ pièce-jointe monovalué ou multivalué) ...

NB. En cas de champ pièce-jointe monovalué passé en paramètre, le contenu de ce champ pourra quand même être considéré comme multivalué en séparant les UUID de pièces-jointes par des ";".

En sortie :

  1. Fichier PDF fusionné (champ pièce-jointe monovalué ou multivalué, selon le mode de fusion choisi)

Configuration

Configuration JSON

Le paramètre de configuration JSON permet principalement d'ajouter des fichiers PDF avant ou après l'ensemble des champ pièces-jointe du document Workey.

Propriétés standard

Propriété
Description

destinationFileName

Nom du fichier PDF de destination (par défaut : "merge.pdf")

destinationFileNameField

Champ du document contenant le nom du fichier de destination (par défaut : "MergePdfFiles_destinationFileName")

prependFiles

Liste des fichiers PDF à ajouter au début du fichier fusionné. Ces fichiers doivent se trouver sur le système de fichier du serveur.

appendFiles

Liste de fichiers PDF à ajouter à la fin du fichier fusionné. Ces fichiers doivent se trouver sur le système de fichier du serveur.

sortOrder

Mode de tri des champs pièces-jointes passés en paramètre (NAME (défaut) ou DATE). Il n'est pas possible d'avoir un mode de tri différent pour chacun des champs.

mergeMode

Mode de de fusion (SINGLE (défaut) ou MULTIPLE) (voir ci-dessous)

Mode de fusion

  • SINGLE : Les fichiers PDF en entrées sont tous fusionnés en un seul document.

  • MULTIPLE : Chacun des fichiers PDF en entrée se voit ajouter les fichiers prependFiles et appendFiles. Ces PDF sont remplacés par leur version fusionnée dans le champ pièce-jointe correspondant. Les paramètres sortOrder, destinationFileName et destinationFileNameField n'ont aucun effet dans ce mode de fusion.

Détermination du nom de fichier de destination

Si la propriété "destinationFileNameField" est présente et si le champ est présent dans le document et si sa valeur n'est pas vide, alors cette valeur sera utilisée comme nom de destination du fichier PDF. Sinon, si la valeur de la propriété "destinationFileName" est remplie, c'est elle qui sera utilisée. En dernier lieu, c'est la valeur par défaut "merge.pdf" qui sera choisie.

Dans tous les cas, si le nom de fichier ne se termine pas par ".pdf", cette extension est automatiquement ajoutée.

Propriétés avancées

Propriété
Description

acroFormMode

Mode de fusion des formulaires. Les valeurs possibles sont JOIN_FORM_FIELDS_MODE (défaut) ou PDFBOX_LEGACY_MODE

ignoreAcroFormErrors

Valeur booléenne indiquant s'il faut continuer la fusion en cas d'erreur sur les formulaires PDF (par défaut: true)

documentMergeMode

Mode de fusion des fichiers. Les valeurs possibles sont OPTIMIZE_RESOURCES_MODE (défaut) ou PDFBOX_LEGACY_MODE

Exemple

ou bien, pour le mode multiple :

FicheCirculationConnector

Description

Connecteur: com.clog.workey.connectors.FicheCirculationConnector

Action

Ce connecteur permet de créer une fiche de circulation au format pdf à partir d'un document Workey et l'enregistrer dans un champ pièces jointes.

Entrée

  1. Champ avec l'ID du document donc on souhaite générer la fiche de circulation

  2. Champ pour apporter des précisions sur la fiche de circulation (permet, par exemple, d'ajouter via formule Stalk le sujet du document ou l'ID ou toute autre précision)

  3. Champ Multivalué avec la liste de colonnes à insérer dans la fiche de circulation: 1;2;3;4;5;6 correspondant dans l'ordre à:

    1. Etat

    2. Opération

    3. Effectuée le

    4. Signée

    5. Par l'acteur

    6. Appartenant à l'unité

  4. Champ contenant le nom de la fiche de circulation (permettant ainsi de normer le nom de la fiche par une formule Stalk par exemple)

Sortie

  1. Nom interne du champ de type pièces jointes où sera enregistrée la fiche de circulation générée

SearchUserAttributesConnector

Description

Connecteur: com.clog.workey.connectors.SearchUserAttributesConnector

Action

Ce connecteur récupère des informations dans l'annuaire utilisateurs.

Entrée

  1. Valeur de l'attribut (du critère de filtre) exemple: "elanglet"

  2. Nom de l'attribut (du critère de filtre) exemple: "cn"

  3. Liste des champs à retourner exemple: "mail;phone;sn"

Sortie

  1. Un tableau des valeurs ordonnées alphanumériquement du premier champ à retourner (champ d'entrée 3).

  2. Un tableau des valeurs ordonnées alphanumériquement du deuxième champ à retourner (s'il existe du champ d'entrée 3).

  3. ...

Par exemple: +1 408 555 1862;+5 408 555 1862;+9 408 555 1862

LaunchOperationOnChildren

Description

Connecteur: com.clog.workey.connectors.LaunchOperationOnChildren

Action

Ce connecteur permet de lancer des opérations (modélisées) sur des documents fils.

Entrée

  1. Nom interne d'un champ contenant une liste des valeurs composées de:

    1. Rôle: Nom interne du rôle réalisant l'opération sur le document fils

    2. Opération: Nom interne de l'opération à réaliser sur le document fils

    3. Etat d'arrivée: Nom interne de l'état (modélisé) dans lequel arrivera le document en sortie de l'opération

  2. Nom interne d'un champ contenant la liste des états elligibles du document fils en entrée de l'opération à exécuter:

    1. Etat_1;[Etat_2;...]

Sortie

  1. Aucun

LdapConnector

Description

Connecteur: com.clog.workey.connectors.LdapConnector

Action

Ce connecteur récupère des informations dans le LDAP.

Entrée

  1. Le Base DN

  2. Le filtre de recherche

Sortie

  1. Une chaîne contenant la liste des attributs retournés depuis l'annuaire séparés par des ";".

PdfMergeConnector

Description

Connecteur: com.clog.workey.connectors.PdfMergeConnector

Action

Ce connecteur permet la création d'un fichier au format pdf depuis un formulaire Workey et y recopie les valeurs contenues dans des champs (texte, listes, tableaux). Le fichier ainsi créé sera enregistré localement ou sur le réseau.

Entrée

Divers champs sont indispensables au paramétrage de la classe Java

Nom du champ
Paramètre
Ordre de tri
Typologie
Valeur par défaut

pdfSource

Entrée

1

Ligne simple ou Liste (valeur par défaut) Champ monovalué

Nom du document utilisé comme modèle (par ex, template.pdf)

templateDir

Entrée

2

Ligne simple(valeur par défaut) champ masqué

Chemin (physique ou relatif) de l’emplacement du modèle (exemple C:\Workey-Tomcat\Tomcat-7.0.40\workey\pdf\). Si cette valeur est vide, le chemin défini dans la propriété "PdfMergeConnector.defaultModelsPath" est utilisé.

mergeDir

Entrée

3

Ligne simple(valeur par défaut) champ masqué

Chemin (absolu ou relatif) de l’emplacement du document créé (exemple C:\Workey-Tomcat\Tomcat-7.0.40\workey\pdf_fusion). Si cette valeur est vide, le chemin défini dans la propriété "PdfMergeConnector.defaultOutputPath" est utilisé.

printer

Entrée

4

Ligne simple (valeur par défaut) champ masqué

NO_PRINT

attachmentField

Entrée

5

Ligne simple(valeur par défaut) champ masqué

Nom du champ utilisé en tant que valeur par défaut pour accueillir le résultat de la fusion (Exemple Pdf_Fusion).

attachmentFieldname

Entrée

6

Ligne simple (expression ou expression calculée) champ masqué

Valeur utilisée en "expression" ou "expression calculée" en stalk selon le gabarit du nom du document attendu (exemple id() + "-" + Nom + " " + Prenom + ".docx")

pdf_Fusion

Sortie

1

Pièce jointe

Conseil

A partie de la version 6.10.7 de Workey, il est possible de configurer les paramètres en passant en second paramètre un objet au format JSON, le premier paramètre restant le nom du fichier modèle.

Sortie

  1. Aucun

Typologie des champs associés au modèle PDF

Depuis les champs Workey on peut insérer les valeurs attendues en préfixant les champs Workey dans le modèle Pdf par :

Dans ces exemples, on remarquera que l’on peut insérer des valeurs de différents types (champs, tables dynamique, images) tout en prenant en compte des différentes polices de caractères et couleurs associées. Les champs de mon exemple sont entre " ", on a ainsi, à titre d'exemple :

  • Adresse

  • Couleurs

  • Description

Champs multivalués

Depuis la version 6.10.1, Pour afficher les valeurs d'un champ multivalué séparées par une chaîne de caractère, vous pouvez utiliser la fonction join(sep, field). Ainsi pour afficher les Couleurs séparées par des virgules, il faudra mettre : ${join(", ", fields["Couleurs"])}

Insertion de tableaux

On remarque également que l’on peut intégrer des champs de la modélisation dans des tableaux.

Pour réaliser cette intégration on nécessite non seulement de faire la correspondance des différents champs mais également d’associer un commentaire (voir image ci-dessous) sur la globalité de la ligne du tableau.

Ce dernier point est crucial si on veut faire correspondre une table dynamique au tableau inséré dans le document pdf.

SameUnitActorsAsReaders

Description

Connecteur: com.clog.workey.connectors.SameUnitActorsAsReaders

Action

Ce connecteur permet d’ajouter l’ensemble des acteurs de la même unité de l’acteur courant comme lecteur du document. Les droits d'accès sont aussi répercutés sur les documents fils (et petit-fils, etc.) le cas échéant.

Attention

On notera que seuls les acteurs de l’unité de l’acteur courant au moment de l’opération seront ajoutés comme lecteur potentiels.

Entrée

  1. Aucun

Sortie

  1. Aucun

ScriptConnector

Description

Connecteur: com.clog.workey.connectors.ScriptConnector

Action

Le connecteur ScriptConnector permet d'exécuter un script Groovy en tant que connecteur Workey; évitant ainsi les lourdes manipulations (compilation du connecteur, empaquetage dans un jar avec signature, déploiement du jar, redémarrage du serveur) à chaque modification du connecteur.

Groovy est un language orientée objet qui est compatible avec la JVM. Le code Groovy peut être compilé dynamiquement par le serveur et produire du code directement exécutable par le moteur Workey.

Installation

Afin qu'il puisse fonctionner, le script doit être placé dans le répertoire $SERVER/workey-data/scripts.

Entrée

  1. Nom du script à exécuter (extension .groovy)

  2. D'autres paramètres d'entrée peuvent être passés au script.

Sortie

  1. Le résultat de l'exécution du script

Exécution des scripts

Lors de l'exécution du script, plusieurs variables sont initalisées et accessibles depuis le script :

  • params: l'objet contient les champ envoyés en entrée au connecteur (y compris le nom du script lui-même)

  • document: le document Workey sur lequel le connecteur est exécuté

  • api: une instance non transactionelle de la classe WorkeyAPI

  • logger: un object Logger afin de faciliter l'écriture de messages de log. Le nom du logger est "com.clog.workey.connectors.ScriptConnector.{nom_script}", ce qui donnerait "com.clog.workey.connectors.ScriptConnector.calcul_indemnites" pour un script nommé calcul_indemnites.groovy.

  • result: cette variable représente la valeur de retour du script. Elle doit contenir un tableau d'objets Java (par ex, String[]). Ainsi, pour retourner des informations depuis un script Groovy :

Exemple:

Script Groovy prenant en paramètre 2 valeurs et retournant les totaux formatés HT et TTC dans deux champs de retour.

Après l'exécution du connecteur, le log Workey devrait indiquer :

Exemple avec appel API et bibliothèque externe

Dans cet exemple, nous allons créer un fichier GIF représentant encodant dans code-barre une valeur d'un champ passé en paramètre au connecteur. Le connecteur renvoie ensuite l'UUID de la pièce-jointe crée par API contenant cette image et la date à laquelle elle a été créée.

Pour ce faire, nous utilisons la bibliothèque "zxing 3.3.0", que vous pouvez télécharger sur mavenCentral, le fichier jar téléchargé sera à placer dans le répertoire $TOMCAT_HOME/workey/libs/.

Exemple en Groovy

Connecteur Starpage XML

Description

Connecteur: com.clog.workey.connectors.StarPageXMLConnector

Action

Ce connecteur permet d'appeler le webservice Starpage pour générer un document à partir des données du formulaire Workey.

Configuration

Nécessite les propriétés systèmes suivantes :

  • com.clog.workey.starpage.ws.server: Url d'accès au webservice Starpage (obligatoire)

  • com.clog.workey.starpage.ws.key: Clé d'authentification au webservice (obligatoire)

  • com.clog.workey.starpage.ws.withoutBOM: Nom de la table externe (optionnel, par défaut false)

  • com.clog.workey.starpage.ws.output: Type de fichier attendu en sortie (optionnel, par défaut PDF-C)

Entrée

  1. Nom du scenario Starpage à utiliser (type)

  2. (optionnel) le nom du fichier généré qui apparaîtra dans le champ PJ. Sinon, le nom du fichier est "{type}_{documentId}.{propriete output}"

Sortie

1.UUID pour une sortie vers un champ PJ.

VelocityMailConnector

Ce connecteur permet de transformer le contenu d'une notification à l'aide d'un template Velocity.

Configuration

Il est mis en oeuvre en renseignant/décommentant la propriété suivante dans le fichier catalina.properties:

Recherche des templates

Les templates sont à mettre dans un sous-répertoire "mail" du répertoire de template défini par la propriété com.clog.workey.directory.velocity-templates (le répertoire workey/velocity-templates/mail est donc utilisé par défaut).

Lors de l'envoi d'une notification, le connecteur va se déclencher et voir si un fichier correspondant aux règles suivantes existe, si c'est le cas le moteur Velocity l'utilisera pour créer la nouvelle notification, sinon la notification originale sera envoyée.

Le connecteur recherche d'abord un fichier nommé "{Process_Name}-{Doctype_Name}-{State_Name}.vml" où Process_Name, Doctype_Name et State_Name sont les noms internes du processus, type de document, état courant du document. Si le fichier n'existe pas, il recherche ensuite un fichier "{Process_Name}-{Doctype_Name}.vml", si aucun fichier n'est trouvé, le connecteur ne s'exécute pas.

Modèles Velocity

Le fichier de template Velocity est un fichier HTML ou texte qui contient le nouveau contenu de la notification. Lors de l'application du templates, plusieurs variables sont utilisables:

Variable
Description

Workey_Notification

L'objet com.clog.workey.core.Notification

Workey_Notification_URL

URL d'accès au document

Workey_Notification_Template

Nom du fichier de template utilisé

Workey_Notification_Body

Text de la notification entrée par l'utilisateur

Workey_Notification_BodyText

Texte contenu dans le "Magic Field" *_body

Workey_Notification.notificationType

Type de notification

Workey_Notification.notificationTargetType

Type de destinataires (0: AUTHOR, 1: PREVIOUS, 2: BEFORE_PREVIOUS , 3: SUPERVISOR, 4: SELECTED, 5: FIELD, 6: NEXT, 7: NEXT_WITH_COPY_TO_USER, 8: DELEGATION, 9: PASSIVES, 10: MEMO)

Workey_Document

l'objet com.clog.workey.core.Document

Workey_Document.id

Id du document

Workey_Document.process.designerName

Designer name du process

Workey_Document.docType.designerName

Designer name du type de document

Workey_Document.currentState.designerName

Designer name de l'état courant

Workey_Process_label

Nom localisé du processus

Workey_Doctype_label

Nom localisé du type de document

Workey_State_label

Nom localisé de l'état courant

Workey_Message

L'objet javax.mail.Message

Workey_Message.subject

Sujet du mail

Personnalisation du sujet

Si un fichier mail_subjects.properties est présent dans le répertoire des templates de mail, il est utilisé pour modifier le sujet du mail. Les clés des propriétés obéissent au même regle de nommage que les templates de contenu.

L'encodage du fichier doit être en utf-8.

Script associé

Une fois le template Velocity appliqué, il est possible de modifier la notification en elle-même à l'aide d'un script.

Le connecteur recherche dans le répertoire de scripts/mail (par exemple, workey/scripts/mail) si un fichier ayant le même nom que le template utilisé mais avec l'extension ".groovy" existe. Si c'est le cas, ce script est exécuté.

Un tableau d'objets "args" est passé en paramètre, il comprend le Message à envoyer en première position, et l'objet Notification en seconde position. Les variables "document", "logger" et "api" sont également disponible.

Voici un exemple de script modifiant le sujet, l'expéditeur et le destinataire de la notification. Il ajoute aussi des pièces jointes issues du document, et effectue une copie du mail sur disque.

Notez que si une image est attachée en pièce-jointe, on peut utiliser l'UUID de la pièce jointe pour l'afficher dans le corps du mail de la manière suivante:

MailConnectorSaveMail

Ce connecteur permet de d'enregistrer sur disque les courriels de notifications. Il est utile lors des phases de développement et de test des projets car il permet de vérifier le bon fonctionnement des notifications sans avoir besoin d'un serveur mail opérationnel.

Configuration

Les mails sont enregistrés avec le système de nommage suivant: {timestamp yyyyMMdd_HHmmss}_{threadId}_{codeSujetUnique}_{docId}.eml.

GroovyMailConnector

Ce connecteur permet de modifier les notifications à partir de scripts Groovy.

Configuration

Pour rechercher le script qui sera exécuté, on applique les mêmes règles que pour le connecteur VelocityMailConnector, à la différence que l'on recherche un fichier .groovy et non .vml dans un sous-répertoire mail du répertoire où se trouvent les scripts (défini par la propriété com.clog.workey.directory.scripts).

Exemple de script

Le script suivant permet d'afficher dans les logs les différentes informations concernant la notification à envoyer. Tous les scripts doivent renvoyer le tableau args fourni à la fin del leur traitement.

HTMLMailConnector

Ce connecteur d'événement permet d'indiquer automatiquement que le type de contenu d'un mail est au format Html. Cela permet d'utiliser du code HTML dans le contenu des notifications effectuées par Magic Fields.

Configuration

Par défaut, la conversion ne s'effectue que si le contenu de la notification contient la chaîne " <html>".

Ce comportement est désactivable avec la propriété suivante :

Dans ce cas tous les mails envoyés sont considérés comme étant au format HTML.

Par défaut, les retours à la ligne sont convertis en "<br/>". Ce comportement est désactivable avec la propriété suivante :

Par défaut, l'encodage utilisé est "utf-8", il est possible de le changer avec la propriété suivante :

CreateFolderFromAttachments

Description

Connecteur: com.clog.workey.mg.connectors.CreateFolderFromAttachments

Action

Ce connecteur permet de créer un dossier MG à partir des contenus d'un composant Pièce Jointe.

Entrée

Ce connecteur n'a pas de paramètres d'entrée. Il s'appuie sur le fichier de configuration du connecteur MG (cf. Connecteur Multigest).

Sortie

Code retour du traitement du connecteur.

SyncAttachments

Description

Connecteur: com.clog.workey.mg.connectors.SyncAttachments

Action

Ce connecteur permet de synchroniser les fichiers d'un composant Pièce Jointe Workey vers un dossier dossiers MG.

Entrée

Ce connecteur n'a pas de paramètres d'entrée. Il s'appuie sur le fichier de configuration du connecteur MG et plus particulièmrent sur la partie synchronisation (cf. Connecteur Multigest).

Sortie

Code retour du traitement du connecteur.

SyncFields

Description

Connecteur: com.clog.workey.mg.connectors.SyncFields

Action

Ce connecteur permet de synchroniser les valeurs des champs d'un document Workey vers les métadonnées d'un dossier MG.

Entrée

Ce connecteur n'a pas de paramètres d'entrée. Il s'appuie sur le fichier de configuration du connecteur MG et plus particulièmrent sur la partie synchronisation (cf. Connecteur Multigest).

Sortie

Code retour du traitement du connecteur.

Mis à jour