W4 EXTENSION BUS GUIDE DES CONNECTEURS ET DES PLUGINS. Référence: EXTBUS_CONNECTORS_046_FR

Transcription

1 W4 EXTENSION BUS GUIDE DES CONNECTEURS ET DES PLUGINS Référence: EXTBUS_CONNECTORS_046_FR

2

3 W4 EXTENSION BUS GUIDE DES CONNECTEURS ET DES PLUGINS Référence: EXTBUS_CONNECTORS_046_FR

4

5 W4. Tous droits réservés. L'acquisition du présent document confère un droit d'utilisation incessible, non exclusif et personnel et non un droit de propriété. L'utilisation, la copie, la reproduction et la distribution du présent document sont permises à condition: 1. que la mention de droits d'auteur ci-dessus figure sur toutes les copies et que cette mention de droits d'auteur et la présente mention d'autorisation apparaissent conjointement ; 2. que le présent document ne soit utilisé qu'à des fins d'information et non commerciales ; 3. que le présent document ne soit modifié de quelque manière que ce soit. Tous les produits et marques cités sont la propriété de leurs titulaires respectifs. Les informations contenues dans ce document pourront faire l objet de modifications sans préavis.

6

7 Sommaire Connecteur W4JavaMail 9 (W4JavaMail 1.0) Ajout du nœud connecteur 9 (W4JavaMail 2.0) Ajout du nœud connecteur 11 Acteurs et rôles pour W4JavaMail 14 Configuration W4JavaMail 15 Paramètres de configuration 15 Déploiement des fichiers modèle 17 (W4JavaMail 1.0) Écriture des modèles de courrier 17 (W4JavaMail 2.0) Écriture des modèles de courrier 21 Connecteur catchmessage 23 Ajout d un nœud connecteur catchmessage 23 Activation d une étape mise en attente d un événement 25 Acteurs et rôles pour catchmessage 25 Connecteur updatemetadata 27 Ajout d un nœud connecteur updatemetadata 27 Utilisation du plugin updatemetadata 28 Acteurs et rôles pour updatemetadata 32 W4 Extension Bus Guide des connecteurs et des plugins 5

8 Connecteur copydocument 33 Ajout d un nœud connecteur copydocument 33 Utilisation du plugin copydocument 34 Acteurs et rôles pour copydocument 38 Connecteur createfolder 39 Ajout d un nœud connecteur createfolder 39 Utilisation du plugin createfolder 40 Acteurs et rôles pour createfolder 44 Connecteur generatedocument 45 Ajout d un nœud connecteur generatedocument 45 Utilisation du plugin generatedocument 46 Configuration du connecteur generatedocument 52 Acteurs et rôles pour generatedocument 53 Connecteur w4webservice 55 Ajout d un nœud connecteur w4webservice 55 Utilisation du plugin w4webservice Utilisation du plugin w4webservice Acteurs et rôles pour w4webservice 58 Connecteur NOP 59 Ajout d un nœud connecteur NOP 59 Utilisation du plugin NOP 60 Acteurs et rôles pour le connecteur NOP 60 6 Sommaire

9 Connecteurs d assignation externe 61 Fonction pickup et connecteur XPathFileProcessor 63 Configuration des répertoires de pickup 64 Ajout d un noeud connecteur XPathFileProcessor 65 Utilisation du plugin XPathFileProcessor 65 Exemples de syntaxe pour les expressions XPath 66 Acteurs et rôles pour XPathFileProcessor 67 Ajout d un type personnalisé dans le système de GED 69 W4 Extension Bus Guide des connecteurs et des plugins 7

10 8 Sommaire

11 Chapitre 1 1 Connecteur W4JavaMail Cette section décrit l utilisation du connecteur W4JavaMail dédié à l envoi de courrier électronique sur des serveurs SMTP. Il existe deux versions du connecteur W4JavaMail, version 1.0 et version 2.0, dont les différences sont les suivantes : Acheminement du courrier : W4JavaMail 1.0 prend en charge les adresses uniquement. W4JavaMail 2.0 prend en charge, outre les adresses , les variables contenant soit des noms d acteurs W4 soit des adresses . Serveurs SMTP : W4JavaMail 1.0 prend en charge une seule configuration de serveur SMTP. W4JavaMail 2.0 permet de configurer plusieurs serveurs SMTP. W4JavaMail est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.6 et ultérieures pour la version 1.0 et versions 7.1 et ultérieures pour la version 2.0. Dans cette section : > 1.1 (W4JavaMail 1.0) Ajout du nœud connecteur, page 9 > 1.2 (W4JavaMail 2.0) Ajout du nœud connecteur, page 11 > 1.3 Acteurs et rôles pour W4JavaMail, page 14 > 1.4 Configuration W4JavaMail, page 15 > 1.5 (W4JavaMail 1.0) Écriture des modèles de courrier, page 17 > 1.6 (W4JavaMail 2.0) Écriture des modèles de courrier, page (W4JavaMail 1.0) Ajout du nœud connecteur Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type W4 Extension Bus Guide des connecteurs et des plugins 9

12 puis Mailing dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez W4JavaMail 1.0. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud. Dans le dossier Attributs étendus / Extended attributes, renseignez obligatoirement les quatre propriétés suivantes : A / To - Spécifiez un ou plusieurs destinataires pour le courrier, sous forme d adresse (il est impossible de spécifier des noms d'acteurs) ; Contenu : fichier modèle / Content: Template file - Spécifiez le nom du fichier modèle pour le contenu du courrier (ce fichier peut être un fichier texte ou HTML) ; De / From - Spécifiez l expéditeur du courrier, sous forme d adresse (il est impossible de spécifier un nom d'acteur) ; Sujet : fichier modèle / Subject: Template file - Spécifiez le nom du fichier qui contiendra le modèle pour le sujet du courrier (ce fichier doit être un fichier texte). Tout ou partie de ces attributs étendus peuvent être transformés en variables, et inversement. Pour cela, il vous faudra modifier le fichier XML de description du connecteur, W4JavaMail.xml, situé sous <ProcessComposer_Home>\plugins\mailing\javamail. Vous devrez créer les entrées correspondantes à l intérieur de l élément <VARIABLES>, soit par exemple : <VARIABLES> <VARIABLE array="true" type="string" mode="in"> <NAME id="from"> <LABEL lang="fr">de</label> <LABEL lang="en">from</label> </NAME> </VARIABLE> </VARIABLES> Veuillez noter que ce type de modification nécessite de modifier le numéro de version du connecteur (attribut version de l élément CONNECTOR). Toutes les variables destinées à être utilisées dans les fichiers modèles doivent être déclarées en tant que variables étendues, en entrée. Pour cela, utilisez le plugin par défaut du connecteur : 10 Chapitre 1 Connecteur W4JavaMail

13 Fig 1.1 Plugin par défaut Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier 1.2 (W4JavaMail 2.0) Ajout du nœud connecteur Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis Mailing dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez W4JavaMail 2.0. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud. Le connecteur W4JavaMail 2.0 dispose d un plugin permettant de configurer l expéditeur et les destinataires, le sujet et le contenu du courrier, ainsi que l ajout de pièces jointes. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : W4 Extension Bus Guide des connecteurs et des plugins 11

14 sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Dans cette section : > Onglet Expéditeur, page 12 > Onglets A, CC et CCI, page 12 > Onglet Objet, page 13 > Onglet Corps, page 13 > Onglet Pièces jointes, page 14 > Onglet Variables, page 14 Onglet Expéditeur L expéditeur peut être renseigné de trois manières : sélectionnez le bouton d option de l expéditeur puis saisissez l adresse de courrier électronique de l expéditeur dans le champ de saisie. sélectionnez le bouton d option Variable contenant le nom de l expéditeur puis sélectionnez la variable appropriée (de type Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. sélectionnez le bouton d option Variable contenant l de l expéditeur puis sélectionnez la variable appropriée (de type Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. Onglets A, CC et CCI Les destinataires (onglet A), destinataires en copie (onglet CC) et les destinataires en copie cachée (onglet CCI) peuvent être renseignés de plusieurs manières. Pour renseigner des rôles et/ou acteurs et/ou adresses de courrier électronique : Sélectionnez les variables appropriées (de type Chaîne de caractères et de cardinalité Mono ou Multi) dans les cadres Variables contenant des rôles / Variables contenant des noms d acteurs ou Variables contenant des s. et / ou : Saisissez le rôle et/ou l acteur et/ou l adresse de courrier électronique dans les zones de saisie. Cliquez sur le bouton Ajouter. Le rôle / l acteur / l adresse de courrier électronique s affiche dans la boîte de liste. Réitérez ces actions pour chaque rôle / acteur / adresse à ajouter. Pour supprimer un élément de la liste, sélectionnez cet élément puis cliquez sur le bouton Supprimer. 12 Chapitre 1 Connecteur W4JavaMail

15 Onglet Objet L objet peut être renseigné de plusieurs manières : sélectionnez le bouton d option Objet du courrier puis saisissez le sujet du courrier électronique dans le champ de saisie (limité à 2000 caractères). sélectionnez le bouton d option Variable contenant l objet du courrier puis sélectionnez la variable appropriée (de type Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. si l objet du courrier doit être fourni par le nom d un fichier modèle : Sélectionnez le bouton d option Nom du fichier modèle puis saisissez le nom du fichier modèle approprié dans le champ de saisie. ou : Sélectionnez le bouton d option Variable contenant le nom du fichier modèle puis sélectionnez la variable appropriée (de type EcmDoc ou Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. Dans le cadre de l utilisation d un fichier modèle, si ce fichier doit être analysé pour le remplacement des paramètres de substitution, sélectionnez la case à cocher correspondante. Onglet Corps Le contenu du courrier peut être renseigné de plusieurs manières : Sélectionnez le bouton d option Corps de l puis saisissez le contenu du courrier électronique dans le champ de saisie (limité à 2000 caractères) Sélectionnez le bouton d option Variable contenant le corps de l puis sélectionnez la variable appropriée (de type Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. Si le contenu du courrier doit être fourni par un fichier modèle : Sélectionnez le bouton d option Nom du fichier modèle puis saisissez le nom du fichier modèle approprié dans le champ de saisie. ou : Sélectionnez le bouton d option Variable contenant le nom du fichier modèle puis sélectionnez la variable appropriée (de type EcmDoc ou Chaîne de caractères et de cardinalité Mono) dans la liste déroulante. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. Dans le cadre de l utilisation d un fichier modèle, si ce fichier doit être analysé pour le remplacement des paramètres de substitution, sélectionnez la case à cocher correspondante. Dans la liste déroulante Type de contenu, sélectionnez : Automatique pour laisser le connecteur décider du type - HTML ou texte - du courrier Texte ou HTML pour forcer l utilisation du type choisi par l utilisateur W4 Extension Bus Guide des connecteurs et des plugins 13

16 NOTE Le fichier templateexample.txt, disponible sous <W4ExtensionBus_Home>/product/connectors/extended/w4mail_2_0/re sources, est un exemple de fichier modèle. Onglet Pièces jointes Les documents peuvent être mis en pièces jointes de plusieurs manières : Sélectionnez les variables appropriées (de type EcmDoc et de cardinalité Mono ou Multi) dans le cadre Variables documents à attacher en pièce jointe. et / ou : Sélectionnez les variables appropriées (de type Chaîne de caractères et de cardinalité Mono ou Multi) dans le cadre Variables contenant des chemins vers des fichiers à attacher. et / ou : Saisissez le chemin vers le fichier dans la zone de saisie. Cliquez sur le bouton Ajouter. Le chemin s affiche dans la boîte de liste. Réitérez ces actions pour chaque chemin à ajouter. Pour supprimer un élément de la liste, sélectionnez cet élément puis cliquez sur le bouton Supprimer. Onglet Variables Cet onglet répertorie les variables de procédure. Sélectionnez celles qui seront utilisées dans les modèles et devant être remplacées par le connecteur. 1.3 Acteurs et rôles pour W4JavaMail Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur W4JavaMail, Process Engine crée automatiquement un acteur nommé W4JavaMail, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur W4JavaMail, vous devez lui attribuer le rôle extensionconnector. 14 Chapitre 1 Connecteur W4JavaMail

17 1.4 Configuration W4JavaMail Le connecteur W4JavaMail est installé par défaut sous : [W4JavaMail 1.0] <W4ExtensionBus_Home>/product/connectors/extended/w4mail [W4JavaMail 2.0] <W4ExtensionBus_Home>/product/connectors/extended/w4mail_2_0/ Le sous-répertoire resources comporte le fichier de configuration du connecteur. Y sont également stockés les fichiers modèles pour l objet et le corps des courriers. Dans cette section : > Paramètres de configuration, page 15 > Déploiement des fichiers modèle, page Paramètres de configuration La configuration du connecteur W4JavaMail se fait via duplication du fichier default_javamail.properties, disponible à l emplacement suivant : [W4JavaMail 1.0] <W4ExtensionBus_Home>/product/connectors/extended/w4mail/resources [W4JavaMail 2.0] <W4ExtensionBus_Home>/product/connectors/extended/w4mail_2_0/resou rces Le fichier copié doit être renommé javamail.properties. Ce fichier comporte en premier lieu les clés smtphost et smtpport. Les autres clés sont réparties entre les sections : SMTP authentication for sending - Activation de l authentification SMTP. Multiple SMTP server configuration - Configuration de plusieurs serveurs SMTP. localization - Définition de la langue par défaut pour les templates. Basic authentication for document download - Activation d une authentification vers le serveur web à partir duquel des documents doivent être téléchargés pour ajout en pièces jointes. Custom object declaration - Définition d objets personnalisés pour étendre les capacités du connecteur. Dans cette section : > smtpserver et smtphost, page 16 > Authentification SMTP, page 16 > Configuration de plusieurs serveurs SMTP, page 16 > Localisation, page 16 > Authentification basic, page 16 > Objets personnalisés, page 17 W4 Extension Bus Guide des connecteurs et des plugins 15

18 smtpserver et smtphost La clé smtphost précisant le serveur SMTP à utiliser doit être renseignée par un nom de machine ou une adresse IP, soit par exemple : smtphost=mercurey.w4.fr La clé smtpport précisant le port de connexion vers le serveur SMTP est facultative. Authentification SMTP Par défaut l authentification SMTP est désactivée. Si elle doit être activée, vous devez en plus renseigner un identifiant et un mot de passe. Configuration de plusieurs serveurs SMTP La configuration de plusieurs serveurs SMTP suit le principe suivant : à chaque serveur SMTP déclaré est associé un filtre comportant un modèle d'adresse . Veuillez noter que l'ordre de définition des serveurs est important : chaque filtre est analysé dans l'ordre de définition des serveurs et le premier filtre dont le modèle est en adéquation avec l'adresse traitée entraîne l'utilisation du serveur associé. Localisation Lorsqu aucun fichier template n est disponible dans la langue du destinataire ou lorsque le destinataire n a aucune langue définie, le template chargé sera celui de la langue par défaut définie dans cette section. Authentification basic Il est possible d'effectuer une authentification de type basic vers le serveur web à partir duquel des documents doivent être téléchargés pour être ajoutés en pièces jointes aux courriers. Une définition doit être fournie pour chaque URL nécessitant une authentification, soit par exemple : remoteauthentication.definitions=myapplication Si vous devez fournir plusieurs définitions, séparez-les par des virgules. Il s'agit ensuite, pour chaque définition, de fournir un préfixe d'url à partir de laquelle l'authentification est nécessaire. Tous les documents à télécharger dont l'url commence par ce préfixe bénéficieront de l'authentification : remoteauthentication.myapplication.urlprefix= 16 Chapitre 1 Connecteur W4JavaMail

19 Enfin, pour chaque définition, l identifiant et le mot de passe de l utilisateur ayant la permission d accès au document doivent être spécifiés, soit par exemple : remoteauthentication.myapplication.username=administrator remoteauthentication.myapplication.password=password Objets personnalisés Pour accéder dans les templates à des données externes, les objets personnalisés qui devront être chargés peuvent être déclarés dans cette section Déploiement des fichiers modèle Les fichiers template sont à déployer dans le dossier : [W4JavaMail 1.0] <ProcessEngine_Home>/extbus/product/extended/w4mail/resources [W4JavaMail 2.0] <ProcessEngine_Home>/extbus/product/extended/w4mail_2_0/resources ou à placer dans le classpath de W4 Extension Bus. Il est recommandé de placer les fichiers dans le dossier mentionné ci-dessus. Vous pouvez utiliser un sous-dossier, auquel cas vous devez préciser le sous-dossier dans la variable W4 contenant le nom du fichier. Si par exemple template.txt est placé dans le dossier <ProcessEngine_Home>/extbus/product/extended/w4mail/resources/folder, vous devez déclarer folder/template.txt comme valeur de variable dans Process Composer. 1.5 (W4JavaMail 1.0) Écriture des modèles de courrier Le fichier modèle du sujet doit être un fichier texte. Il est recommandé d utiliser un fichier d extension.txt. Pour le fichier modèle du contenu, il existe deux possibilités : le modèle est fourni dans un fichier texte (.txt recommandé) ; le courrier sera alors envoyé en tant que texte brut. le modèle est fourni dans un fichier HTML (fichier d extension.html ou.htm) ; le courrier sera alors envoyé au format HTML. Les sections ci-dessous vous fournissent les éléments nécessaires à la programmation de vos modèles de courrier. W4 Extension Bus Guide des connecteurs et des plugins 17

20 Affichage des informations sur la tâche en cours Identifiant du dossier : ${workcase_id} Nom du dossier : ${workcase_name} Identifiant de la tâche : ${task_id} Affichage d une variable mono valuée ${variable name= mono_string } Affichage d'une variable multi valuée ${loop variable="multi_string"} ${value} ${end_loop} Mise en page des variables multi valuées Il est possible de mettre en page facilement une variable multi-valuée à l'aide des attributs prefix et suffix. Exemple avec une variable de nom multi_string contenant comme valeurs Valeur1, Valeur2, Valeur3 et Valeur4. Cas 1 affichera : ${loop variable="multi_string"} (prefix)${value}(suffix) ${end_loop} Cas 2 (prefix)valeur1(suffix) (prefix)valeur2(suffix) (prefix)valeur3(suffix) (prefix)valeur4(suffix) ${loop variable="multi_string" suffix="false"} (prefix)${value}(suffix) ${end_loop} 18 Chapitre 1 Connecteur W4JavaMail

21 affichera : Cas 3 (prefix)valeur1(suffix) (prefix)valeur2(suffix) (prefix)valeur3(suffix) (prefix)valeur4 affichera : ${loop variable="multi_string" prefix="false"} (prefix)${value}(suffix) ${end_loop} Valeur1(suffix) (prefix)valeur2(suffix) (prefix)valeur3(suffix) (prefix)valeur4(suffix) L'attribut suffix permet par exemple de jouer avec une virgule comme séparateur des valeurs tout en gardant un message très propre (Attention! Le code doit être écrit sur une seule ligne, sans retour chariot) : affichera : ${loop variable="multi_string" suffix="false"}${value}, ${end_loop} au lieu de : Valeur1, Valeur2, Valeur3, Valeur4 Valeur1, Valeur2, Valeur3, Valeur4, Formatage d'une variable de type date L'attribut datepattern peut être ajouté, soit sur le mot-clé variable, soit sur le mot-clé value. Il permet de préciser le formatage souhaité pour une date. Par exemple : affichera : ${variable name=mono_date datepattern="dd/mm/yyyy"} 06/11/2007 W4 Extension Bus Guide des connecteurs et des plugins 19

22 au lieu de : Tue Nov 06 11:28:03 CET 2007 Toute la syntaxe de SimpleDateFormat est prise en compte par cet attribut. Pour plus de détails, veuillez vous reporter à la Javadoc de Sun. Mise en pièces jointes de documents Il est possible d'attacher des documents aux courriers. Ces documents peuvent résider : en local sur la machine sur laquelle s'exécute W4 Extension Bus, soit par exemple : C:\path C:/path distant de la machine sur laquelle s'exécute W4 Extension Bus, à l'aide d'un montage réseau, soit par exemple : Z:\path sur une application web, soit par exemple : ftp://serveur/document.txt Pour mettre un document en pièce jointe, il faut utiliser le mot-clé : ${attacheddocument path="path/to/file"} L'attribut path contient le chemin d'accès au document. Il est possible de spécifier pour l'attribut path un chemin local ou de type URL (voir ci-dessus). Le connecteur peut aussi renommer, via l attribut name, le document qu'il va joindre au courrier : ${attacheddocument path="path/to/file" name="newfilename.txt"} Utilisation des attributs Les attributs sans espace peuvent être spécifiés sans caractères " ni '. Les syntaxes suivantes sont possibles : key=value key="value" key='value' key="with space" key='with space' Il est possible d'utiliser des mots-clé dans les attributs dynamiques, soit par exemple : ${attacheddocument path=" name=filename}"} 20 Chapitre 1 Connecteur W4JavaMail

23 1.6 (W4JavaMail 2.0) Écriture des modèles de courrier IMPORTANT Attention! Les modèles de la version 1.0 du connecteur ne sont pas compatibles avec la version 2.0. L'utilisation d'un modèle est indispensable à l'envoi de courriers localisés. NOTE Le fichier templateexample.txt, disponible sous <W4ExtensionBus_Home>/product/connectors/extended/w4mail_2_0/resour ces, est un exemple de fichier modèle. Le nom du fichier doit respecter le modèle <nom>_<langue>[.<extension>]. Ce nommage doit également être respecté lors de la spécification du nom du modèle dans le plugin Process Composer ; le connecteur se chargera alors de localiser le fichier correspondant à la langue de l'utilisateur. Si aucun fichier template n'est trouvé, le fichier par défaut est utilisé. Le fichier par défaut est : soit <nom>[.<extension>] si le paramètre defaultlanguage, précisant la langue par défaut, pour les utilisateurs n'ayant pas de langue ou pour les s dont l'adresse est soit fournie par saisie directe soit contenue dans une variable, vaut null ou chaîne vide ; soit <nom>_<defaultlanguage>[.<extension>]. Le paramètre defaultlanguage peut être modifié dans le fichier de propriétés du connecteur (fichier default_javamail.properties sous W4ExtensionBus_Home/product/connectors/extended/w4mail_2_0/resources). Par défaut la valeur est chaîne vide. Veuillez noter que le fichier correspondant à la langue par défaut est toujours obligatoire même si aucun destinataire de l' n'utilise la langue en question. Il est possible d'étendre les données accessibles dans le template en développant des objets personnalisés (CustomObject). Un système de chargement intelligent des templates permet d'organiser le répertoire resources du connecteur et d'éviter la dispersion des modèles à plusieurs endroits : le template est recherché dans un sous-répertoire de ressources portant le nom de la procédure concernée suivi du nom du nœud concerné ; en cas de recherche infructueuse, la recherche se poursuit dans un sous-répertoire portant uniquement le nom de la procédure ; en cas de recherche infructueuse, la recherche se poursuit dans le répertoire resources ; en cas de recherche infructueuse, on tente de charger le template en tant que ressource du classpath ; en cas d'échec, une erreur est retournée et le connecteur est mis en attente. W4 Extension Bus Guide des connecteurs et des plugins 21

24 22 Chapitre 1 Connecteur W4JavaMail

25 Chapitre 2 2 Connecteur catchmessage Cette section décrit l utilisation du connecteur catchmessage permettant de modéliser la mise en attente d un événement par une tâche. Le connecteur catchmessage est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.6 et ultérieures. Le connecteur catchmessage est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/simple/connector. Dans cette section : > 2.1 Ajout d un nœud connecteur catchmessage, page 23 > 2.2 Activation d une étape mise en attente d un événement, page 25 > 2.3 Acteurs et rôles pour catchmessage, page Ajout d un nœud connecteur catchmessage Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis Evénement / Event dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Réception d un message / Catch message. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud. Dans le dossier Attributs étendus / Extended attributes, renseignez : pour Sujet de l événement / Event topic, saisissez une description facultative qui pourra aider à identifier l événement lors d une recherche (par exemple, dans W4 Admin for Java, ce texte apparaît dans le champ Description de l événement) W4 Extension Bus Guide des connecteurs et des plugins 23

26 pour Nom de l événement / Event name, saisissez le nom de l événement à créer. Cet événement sera automatiquement créé lorsque l étape correspondant au nœud connecteur catchmessage deviendra active. Pour connaître la marche à suivre pour annuler la mise en attente de la tâche par l événement, veuillez vous reporter à la section suivante : > 2.2 Activation d une étape mise en attente d un événement, page 25 Vous avez la possibilité d ajouter des variables étendues. Pour cela, utilisez le plugin par défaut du connecteur : Fig 2.1 Ajout de variables étendues Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touche ENTREE de votre clavier 0 POUR AJOUTER UNE NOUVELLE VARIABLE : 1 Sélectionnez le bouton Ajouter / Add. Une nouvelle ligne s ajoute à la suite des lignes préexistantes. 2 Saisissez le nom de la variable dans la colonne Nom / Name, puis sélectionnez les valeurs appropriées dans les colonnes Type, Arité / Arity et Mode. 3 Procédez de même pour chaque variable à ajouter. 4 Sélectionnez le bouton OK. Dans la fenêtre Association de variables / Variable mappings, vous pouvez constater que les variables nouvellement créées apparaissent dans la colonne Variables connecteur / Connector variables. 24 Chapitre 2 Connecteur catchmessage

27 Sélectionnez les variables de procédures appropriées dans les colonnes Variables de procédure en entrée / Procedure In Variables et Variables de procédure en sortie / Procedure Out Variables, le cas échéant, pour compléter l association des variables. 2.2 Activation d une étape mise en attente d un événement La création de l événement par l activation de l étape correspondant au nœud connecteur catchmessage aura pour effet de suspendre la création de la tâche suivante dans la procédure. Lorsque cette tâche devra être créée, vous devrez faire passer l événement de l état Créé à l état Survenu, via API ou via l interface d administration W4 Admin for Java. Pour effectuer cette action via API, veuillez consulter les documents suivants : Javadoc W4 BPM API (interfacebpmeventservice, méthode occur) Javadoc API Java (wfjlib.jar) (classe TWFevent, méthode wfeventoccurred) Pour effectuer cette action via W4 Admin for Java, veuillez consulter le Manuel d utilisation de W4 Admin for Java. 2.3 Acteurs et rôles pour catchmessage Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur catchmessage, Process Engine crée automatiquement un acteur nommé CatchMessage auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur CatchMessage, vous devez lui attribuer le rôle extensionconnector. W4 Extension Bus Guide des connecteurs et des plugins 25

28 26 Chapitre 2 Connecteur catchmessage

29 Chapitre 3 3 Connecteur updatemetadata Cette section décrit l utilisation du connecteur updatemetadata permettant de mettre à jour les métadonnées d un document résidant dans un système de GED. Le connecteur updatemetadata est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.6 et ultérieures. Le connecteur updatemetadata est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/simple/connector. Dans cette section : > 3.1 Ajout d un nœud connecteur updatemetadata, page 27 > 3.2 Utilisation du plugin updatemetadata, page 28 > 3.3 Acteurs et rôles pour updatemetadata, page Ajout d un nœud connecteur updatemetadata Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis GED / ECM dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Mise à jour de métadonnées d un document / Update document metadata. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud. Sur la fenêtre Association de variables / Variable mapping, vous pouvez constater qu une variable doc2update, représentant le document dont les métadonnées doivent être mises à jour, est présente dans la colonne Variables connecteur / Connector variables. Sélectionnez les variables EcmDoc appropriées dans les colonnes Variables de procédure en entrée / Procedure In Variables et Variables de procédure en sortie / Procedure Out Variables pour compléter l association des variables. W4 Extension Bus Guide des connecteurs et des plugins 27

30 3.2 Utilisation du plugin updatemetadata Le connecteur updatemetadata dispose d un plugin permettant de : sélectionner la variable EcmDoc de votre processus correspondant au document dont les métadonnées doivent être mises à jour ; faciliter la connexion aux différents référentiels (repository) du gestionnaire de documents W4 Document Manager ; visualiser l'architecture des différents référentiels pour y sélectionner le type de document correspondant au document dont les métadonnées doivent être mises à jour ; visualiser les métadonnées du documents pour y associer des variables de procédure. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Connexion Cet onglet permet de renseigner les paramètres de connexion du plugin au gestionnaire de documents W4 Document Manager : Fig 3.1 Plugin updatemetadata (1/4) Dans le cadre Connexion / Connection, renseignez les paramètres de connexion : Login - Identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; 28 Chapitre 3 Connecteur updatemetadata

31 Mot de passe / Password - Mot de passe de l'identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Serveur / Server - Nom ou adresse IP du serveur W4 Engine hébergeant le gestionnaire de document ; Instance - Nom de l'instance du serveur W4 Engine hébergeant le gestionnaire de document. Sélectionnez la case à cocher Mémoriser la connexion / Save connection si vous souhaitez, lors de vos prochaines utilisations du plugin, que les informations de connexion soient pré-renseignées à l'ouverture (à l'exception du mot de passe). Vous pourrez alors sélectionner la connexion dans la liste déroulante Historique des connexions / Connection history. Sélectionnez la case à cocher Mémoriser le mot de passe / Save password si vous souhaitez, lors de vos prochaines utilisations du plugin, que le mot de passe soit pré-renseigné à l'ouverture (sous réserve que le champ Mémoriser la connexion / Save connection soit sélectionné). Sélectionnez le bouton Connection / Connexion. L'onglet Type de document / Document type s'affiche. Type de document Cet onglet affiche l'arborescence du gestionnaire de document et permet de sélectionner le type de document approprié : Fig 3.2 Plugin updatemetadata (2/4) Le cadre Source du document / Document source affiche les systèmes de GED disponibles dans le gestionnaire de document. Sélectionnez le système de GED dans lequel est stocké le document dont les métadonnées doivent être mises à jour. Dans cadre Types de documents disponibles / Available document type, sélectionnez le type de document approprié. Sélectionnez l'onglet Mapping. W4 Extension Bus Guide des connecteurs et des plugins 29

32 Mapping Cet onglet affiche les métadonnées du type de document sélectionné dans l'onglet précédent et permet d y associer des variables de procédure : Fig 3.3 Plugin updatemetadata (3/4) Dans le champ Mode, sélectionnez : Valeur / Value pour attribuer une valeur à la métadonnée Variable pour associer une variable de procédure à la métadonnée Variable [remplacer] / Variable [replace] pour associer une variable de procédure à une métadonnée de type tableau de chaînes de caractères (la valeur de la variable remplace les valeurs éventuellement présentes dans le tableau de chaînes de caractères) Variable [cumuler] / Variable [append] pour associer une variable de procédure à une métadonnée de type tableau de chaînes de caractères (la valeur de la variable s'ajoute aux valeurs éventuellement présentes dans le tableau de chaînes de caractères) Valeur [remplacer] / Value [replace] pour attribuer une valeur à une métadonnée de type tableau de chaînes de caractères (la valeur saisie remplace les valeurs éventuellement présentes dans le tableau de chaînes de caractères) Valeur [cumuler] / Value [append] pour attribuer une valeur à une métadonnée de type tableau de chaînes de caractères (la valeur saisie s'ajoute aux valeurs éventuellement présentes dans le tableau de chaînes de caractères) Dans la colonne Valeur / Value correspondante, saisissez ou sélectionnez les valeurs appropriées. Sélectionnez l'onglet Options. Options Cet onglet propose plusieurs options permettant de paramétrer l'utilisation du plugin : 30 Chapitre 3 Connecteur updatemetadata

33 Fig 3.4 Plugin updatemetadata (4/4) Dans le cadre Connexion / Connection, vous pouvez choisir la connexion qui sera sélectionnée par défaut dans la liste Historique des connexions / Connection history de l'onglet Connexion / Connection. Sélectionnez la case à cocher Connexion automatique / Automatic connection si vous souhaitez que la connexion soit tentée dès l'ouverture du plugin. Le plugin s'ouvrira alors sur l'onglet Type de document source / Type of source document. NOTE La case à cocher Connexion automatique n'est disponible que pour les connexions pour lesquelles le mot de passe a été sauvegardé Pour que la connexion automatique fonctionne, vous devez avoir sélectionné la case à cocher Mémoriser la connexion sur l'onglet Connexion Sélectionnez la case à cocher Afficher une boîte de dialogue / Display a popup si vous souhaitez pouvoir visualiser les stack traces dans une boîte de dialogue en cas d'erreurs de connexion aux différents systèmes de GED. Par défaut, ces informations s affichent dans la partie inférieure du plugin. Dans le cadre Format de saisie des dates / Date format, sélectionnez l'une des deux options possibles : Utiliser le format de la culture locale / Use local culture format pour utiliser le format de date configuré pour la machine hôte du gestionnaire de documents Utiliser un format spécifique / Use specific format pour définir le format à utiliser. Vous devez alors renseigner un masque de saisie du type YY/mm/dd ou MM/DD/YYYY par exemple dans le champ Format de saisie des dates / Date format Sélectionnez le bouton Sauvegarder / Save pour enregistrer les modifications apportées aux options. W4 Extension Bus Guide des connecteurs et des plugins 31

34 Signalement des erreurs Les avertissements et erreurs de configuration sont signalés dans le cadre Problèmes identifiés qui s'affiche dans la partie inférieure du plugin. Finalisation Lorsque vous avez correctement renseigné les différents onglets du plugin, sélectionnez OK pour valider. Une nouvelle activité fondée sur les paramétrages effectués à l'aide du plugin s'affiche dans le dossier Activités / Activities de l'environnement de travail. Dans le champ Activité du connecteur / Connector activity de la fenêtre de propriétés du nœud robot, on remarque que cette nouvelle activité a été automatiquement associée au nœud robot. Dans le dossier Attributs étendus / Extended atributes de la fenêtre de propriétés du nœud connecteur, vous pouvez constater que les trois propriétés doctype, source et sourcepath ont été automatiquement renseignées. 3.3 Acteurs et rôles pour updatemetadata Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur updatemetadata, Process Engine crée automatiquement un acteur nommé UpdateMetaData, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur UpdateMetaData, vous devez lui attribuer le rôle extensionconnector. 32 Chapitre 3 Connecteur updatemetadata

35 Chapitre 4 4 Connecteur copydocument Cette section décrit l utilisation du connecteur copydocument permettant de modéliser la copie d un document dans un dossier (le document et son dossier de destination ne doivent pas nécessairement être situés sur le même système de GED). Le connecteur copydocument est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.7 et ultérieures. Le connecteur copydocument est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/simple/connector. Dans cette section : > 4.1 Ajout d un nœud connecteur copydocument, page 33 > 4.2 Utilisation du plugin copydocument, page 34 > 4.3 Acteurs et rôles pour copydocument, page Ajout d un nœud connecteur copydocument Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis GED / ECM dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Copie d un document / Copy document. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud robot. Sur la fenêtre Association de variables / Variable mapping, vous pouvez constater que deux variables doc2copy et doc2create, représentant respectivement le document à copier et le document à créer (issu de la copie), sont présentes dans la colonne Variables connecteur / Connector variables. W4 Extension Bus Guide des connecteurs et des plugins 33

36 Sélectionnez les variables EcmDoc appropriées, dans la colonne Variables de procédure en entrée / Procedure In Variables pour la variable doc2copy et dans la colonne Variables de procédure en sortie / Procedure Out Variables pour la variable doc2create, pour compléter l association des variables. 4.2 Utilisation du plugin copydocument Le connecteur copydocument dispose d un plugin permettant de : sélectionner les variables EcmDoc de votre processus correspondant au document à copier et au document à créer ; faciliter la connexion aux différents référentiels (repository) du gestionnaire de documents W4 Document Manager ; visualiser l'architecture des différents référentiels pour y sélectionner le type de document source et le type de document cible ; visualiser et positionner les propriétés du document cible. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Déclaration des documents et dossiers Dans le cadre Source document / Document source, sélectionnez la variable EcmDoc représentant le document à copier. Dans le cadre Destination document / Document destination, sélectionnez la variable EcmDoc représentant le document à créer. Dans le cadre Dossier parent / Parent folder, renseignez le dossier du système de GED cible dans lequel vous souhaitez créer le document. Vous avez deux possibilités : sélectionnez le bouton d option Utiliser une variable / Use a variable pour choisir dans la liste déroulante une variable de type EcmDoc ou String (dans ce cas, la variable doit contenir le chemin d accès au dossier parent) ou : sélectionnez le bouton d option Utiliser le dossier sélectionné / Use selected folder pour que le document soit créé dans le dossier sélectionné dans l onglet Type de document de destination / Type of destination document. 34 Chapitre 4 Connecteur copydocument

37 Connexion Cet onglet permet de renseigner les paramètres de connexion du plugin au gestionnaire de documents W4 Document Manager : Fig 4.1 Plugin copydocument (1/3) Dans le cadre Connexion / Connection, renseignez les paramètres de connexion : Login - Identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Mot de passe / Password - Mot de passe de l'identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Serveur / Server - Nom ou adresse IP du serveur W4 Engine hébergeant le gestionnaire de document ; Instance - Nom de l'instance du serveur W4 Engine hébergeant le gestionnaire de document. Sélectionnez la case à cocher Mémoriser la connexion / Save connection si vous souhaitez, lors de vos prochaines utilisations du plugin, que les informations de connexion soient pré-renseignées à l'ouverture (à l'exception du mot de passe). Vous pourrez alors sélectionner la connexion dans la liste déroulante Historique des connexions / Connection history. Sélectionnez la case à cocher Mémoriser le mot de passe / Save password si vous souhaitez, lors de vos prochaines utilisations du plugin, que le mot de passe soit pré-renseigné à l'ouverture (sous réserve que le champ Mémoriser la connexion / Save connection soit sélectionné). Sélectionnez le bouton Connexion / Connection. L'onglet Type de document source / Type of source document s'affiche. W4 Extension Bus Guide des connecteurs et des plugins 35

38 Type de document source Cet onglet affiche l'arborescence du gestionnaire de document et permet de sélectionner le type de document du document source : Fig 4.2 Plugin copydocument (2/3) Le cadre Source du document / Document source affiche les systèmes de GED disponibles dans le gestionnaire de document. Sélectionnez le système de GED approprié et, dans ce système de GED, le répertoire approprié. Dans cadre Types de documents disponibles / Available document type, sélectionnez le type de document approprié. Sélectionnez l'onglet Type de document de destination / Type of destination document. Type de document destination Cet onglet affiche l'arborescence du gestionnaire de document et permet de sélectionner le type de document du document cible. Le cadre Source du document / Document source affiche les systèmes de GED disponibles dans le gestionnaire de document. Sélectionnez le système de GED approprié et, dans ce système de GED, le répertoire approprié. Dans cadre Types de documents disponibles / Available document type, sélectionnez le type de document approprié. Sélectionnez l'onglet Mapping. 36 Chapitre 4 Connecteur copydocument

39 Mapping Cet onglet affiche et permet de positionner les propriétés du document cible : Fig 4.3 Plugin copydocument (3/3) Pour chaque propriété, dans le champ Mode, sélectionnez : Valeur / Value pour attribuer à la propriété une valeur à saisir dans la colonne Valeur / Value ; Propriété source / Source property pour attribuer à la propriété le contenu d une propriété du document source à sélectionner dans la colonne Valeur / Value ; Variable pour associer à la propriété une variable de procédure à sélectionner dans la colonne Valeur / Value. Sélectionnez l'onglet Options. Options Cet onglet propose plusieurs options permettant de paramétrer l'utilisation du plugin. Dans le cadre Connexion / Connection, vous pouvez choisir la connexion qui sera sélectionnée par défaut dans la liste Historique des connexions / Connection history de l'onglet Connexion / Connection. Sélectionnez la case à cocher Connexion automatique / Automatic connection si vous souhaitez que la connexion soit tentée dès l'ouverture du plugin. Le plugin s'ouvrira alors sur l'onglet Type de document source / Type of source document. NOTE La case à cocher Connexion automatique n'est disponible que pour les connexions pour lesquelles le mot de passe a été sauvegardé W4 Extension Bus Guide des connecteurs et des plugins 37

40 Pour que la connexion automatique fonctionne, vous devez avoir sélectionné la case à cocher Mémoriser la connexion sur l'onglet Connexion Sélectionnez la case à cocher Afficher une boîte de dialogue / Display a popup si vous souhaitez pouvoir visualiser les stack traces dans une boîte de dialogue en cas d'erreurs de connexion aux différents systèmes de GED. Par défaut, ces informations s affichent dans la partie inférieure du plugin. Dans le cadre Format de saisie des dates / Date format, sélectionnez l'une des deux options possibles : Utiliser le format de la culture locale / Use local culture format pour utiliser le format de date configuré pour la machine hôte du gestionnaire de documents Utiliser un format spécifique / Use specific format pour définir le format à utiliser. Vous devez alors renseigner un masque de saisie du type YY/mm/dd ou MM/DD/YYYY par exemple dans le champ Format de saisie des dates / Date format Sélectionnez le bouton Sauvegarder / Save pour enregistrer les modifications apportées aux options. Finalisation Lorsque vous avez correctement renseigné les différents onglets du plugin, sélectionnez OK pour valider. Une nouvelle activité fondée sur les paramétrages effectués à l'aide du plugin s'affiche dans le dossier Activités / Activities de l'environnement de travail. Dans le champ Activité du connecteur / Connector activity de la fenêtre de propriétés du nœud robot, on remarque que cette nouvelle activité a été automatiquement associée au nœud robot. Dans le dossier Attributs étendus / Extended atributes de la fenêtre de propriétés du nœud connecteur, vous pouvez constater que les propriétés DestinationDocType, DestinationPath, soucedocpath, sourcepath, destination source et source ont été automatiquement renseignées. 4.3 Acteurs et rôles pour copydocument Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur copydocument, Process Engine crée automatiquement un acteur nommé CopyDocument, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur CopyDocument, vous devez lui attribuer le rôle extensionconnector. 38 Chapitre 4 Connecteur copydocument

41 Chapitre 5 5 Connecteur createfolder Cette section décrit l utilisation du connecteur createfolder permettant de créer des dossiers avec des métadonnées dans un système de GED. Le connecteur createfolder est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.7 et ultérieures. Le connecteur createfolder est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/simple/connector. Dans cette section : > 5.1 Ajout d un nœud connecteur createfolder, page 39 > 5.2 Utilisation du plugin createfolder, page 40 > 5.3 Acteurs et rôles pour createfolder, page Ajout d un nœud connecteur createfolder Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis GED / ECM dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Création d un dossier / Create folder. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud robot. Sur la fenêtre Association de variables / Variable mapping, vous pouvez constater qu une variable doc2create, représentant le répertoire à créer, est présente dans la colonne Variables connecteur / Connector variables. Sélectionnez la variable EcmDoc appropriée dans la colonne Variables de procédure en sortie / Procedure Out Variables pour compléter l association des variables. W4 Extension Bus Guide des connecteurs et des plugins 39

42 5.2 Utilisation du plugin createfolder Le connecteur createfolder dispose d un plugin permettant de : sélectionner les variables EcmDoc de votre processus correspondant au dossier à créer ; faciliter la connexion aux différents référentiels (repository) du gestionnaire de documents W4 Document Manager ; visualiser l'architecture des différents référentiels pour y sélectionner le type de dossier à créer ; visualiser et positionner les propriétés du dossier cible. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Déclaration des dossiers Dans le cadre Dossier à créer / Folder to create, sélectionnez la variable EcmDoc représentant le dossier à créer. Dans le cadre Dossier parent / Parent folder, renseignez le dossier du système de GED cible dans lequel vous souhaitez créer le dossier. Vous avez deux possibilités : sélectionnez le bouton d option Utiliser une variable / Use a variable pour choisir dans la liste déroulante une variable de type EcmDoc ou String (dans ce cas, la variable doit contenir le chemin d accès au dossier parent) ou : sélectionnez le bouton d option Utiliser le dossier sélectionné / Use selected folder pour que le dossier soit créé dans le dossier sélectionné dans l onglet Type de dossier / Folder type. Connexion Cet onglet permet de renseigner les paramètres de connexion du plugin au gestionnaire de documents W4 Document Manager : 40 Chapitre 5 Connecteur createfolder

43 Fig 5.1 Plugin createfolder (1/3) Dans le cadre Connexion / Connection, renseignez les paramètres de connexion : Login - Identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Mot de passe / Password - Mot de passe de l'identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Serveur / Server - Nom ou adresse IP du serveur W4 Engine hébergeant le gestionnaire de document ; Instance - Nom de l'instance du serveur W4 Engine hébergeant le gestionnaire de document. Sélectionnez la case à cocher Mémoriser la connexion / Save connection si vous souhaitez, lors de vos prochaines utilisations du plugin, que les informations de connexion soient pré-renseignées à l'ouverture (à l'exception du mot de passe). Vous pourrez alors sélectionner la connexion dans la liste déroulante Historique des connexions / Connection history. Sélectionnez la case à cocher Mémoriser le mot de passe / Save password si vous souhaitez, lors de vos prochaines utilisations du plugin, que le mot de passe soit pré-renseigné à l'ouverture (sous réserve que le champ Mémoriser la connexion / Save connection soit sélectionné). Sélectionnez le bouton Connexion / Connection. L'onglet Type de dossier / Folder type s'affiche. Type de dossier Cet onglet affiche l'arborescence du gestionnaire de document et permet de sélectionner le type de dossier approprié : W4 Extension Bus Guide des connecteurs et des plugins 41

44 Fig 5.2 Plugin createfolder (2/3) Le cadre Source du document / Document source affiche les systèmes de GED disponibles dans le gestionnaire de document. Sélectionnez le système de GED approprié et, dans ce système de GED, le répertoire approprié. Dans cadre Types de dossiers disponibles / Available folder type, sélectionnez le type de dossier approprié. Sélectionnez l'onglet Mapping. Mapping Cet onglet affiche et permet de positionner les propriétés du dossier à créer : 42 Chapitre 5 Connecteur createfolder

45 Fig 5.3 Plugin createfolder (3/3) Pour chaque propriété, dans le champ Mode, sélectionnez : Valeur / Value pour attribuer à la propriété une valeur à saisir dans la colonne Valeur / Value ; Variable pour associer à la propriété une variable de procédure à sélectionner dans la colonne Valeur / Value. Sélectionnez l'onglet Options. Options Cet onglet propose plusieurs options permettant de paramétrer l'utilisation du plugin. Dans le cadre Connexion / Connection, vous pouvez choisir la connexion qui sera sélectionnée par défaut dans la liste Historique des connexions / Connection history de l'onglet Connexion / Connection. Sélectionnez la case à cocher Connexion automatique / Automatic connection si vous souhaitez que la connexion soit tentée dès l'ouverture du plugin. Le plugin s'ouvrira alors sur l'onglet Type de document source / Type of source document. NOTE La case à cocher Connexion automatique n'est disponible que pour les connexions pour lesquelles le mot de passe a été sauvegardé Pour que la connexion automatique fonctionne, vous devez avoir sélectionné la case à cocher Mémoriser la connexion sur l'onglet Connexion Sélectionnez la case à cocher Afficher une boîte de dialogue / Display a popup si vous souhaitez pouvoir visualiser les stack traces dans une boîte de dialogue en cas d'erreurs de connexion aux différents systèmes de GED. Par défaut, ces informations s affichent dans la partie inférieure du plugin. W4 Extension Bus Guide des connecteurs et des plugins 43

46 Dans le cadre Format de saisie des dates / Date format, sélectionnez l'une des deux options possibles Utiliser le format de la culture locale / Use local culture format pour utiliser le format de date configuré pour la machine hôte du gestionnaire de documents Utiliser un format spécifique / Use specific format pour définir le format à utiliser. Vous devez alors renseigner un masque de saisie du type YY/mm/dd ou MM/DD/YYYY par exemple dans le champ Format de saisie des dates / Date format Sélectionnez le bouton Sauvegarder / Save pour enregistrer les modifications apportées aux options. Finalisation Lorsque vous avez correctement renseigné les différents onglets du plugin, sélectionnez OK pour valider. Une nouvelle activité fondée sur les paramétrages effectués à l'aide du plugin s'affiche dans le dossier Activités / Activities de l'environnement de travail. Dans le champ Activité du connecteur / Connector activity de la fenêtre de propriétés du nœud robot, on remarque que cette nouvelle activité a été automatiquement associée au nœud robot. Dans le dossier Attributs étendus / Extended atributes de la fenêtre de propriétés du nœud connecteur, vous pouvez constater que les trois propriétés DocType, source, soucepath et parentfolder ont été automatiquement renseignées. 5.3 Acteurs et rôles pour createfolder Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur createfolder, Process Engine crée automatiquement un acteur nommé CreateFolder, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur CreateFolder, vous devez lui attribuer le rôle extensionconnector. 44 Chapitre 5 Connecteur createfolder

47 Chapitre 6 6 Connecteur generatedocument Cette section décrit l utilisation du connecteur generatedocument utilisé pour la génération dans un système de GED d un fichier résultat basé sur un modèle. Le connecteur generatedocument est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 6.7 et ultérieures. Le connecteur generatedocument est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/extended/w4documentgenerator. Dans cette section : > 6.1 Ajout d un nœud connecteur generatedocument, page 45 > 6.2 Utilisation du plugin generatedocument, page 46 > 6.3 Configuration du connecteur generatedocument, page 52 > 6.4 Acteurs et rôles pour generatedocument, page Ajout d un nœud connecteur generatedocument Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis GED / ECM dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Génération d un document / Generate document. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au nœud robot. W4 Extension Bus Guide des connecteurs et des plugins 45

48 6.2 Utilisation du plugin generatedocument Le connecteur generatedocument dispose d un plugin permettant de : sélectionner la variable EcmDoc de votre processus correspondant au document à créer, le format du document cible, le modèle sur la base duquel le document sera créé, et la liste des variables à associer ; faciliter la connexion aux différents référentiels (repository) du gestionnaire de documents W4 Document Manager ; visualiser l'architecture des différents référentiels pour y spécifier la localisation du document à produire ainsi que son type ; visualiser et positionner les propriétés du document cible. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier L'interface du plugin s'affiche : Fig 6.1 Plugin generatedocument (1/6) Dans le cadre Document à créer / Document to create, sélectionnez la variable EcmDoc représentant le document à créer. 46 Chapitre 6 Connecteur generatedocument

49 Paramètres de génération Sous l onglet Génération du document / Document generation paramaters, dans le cadre Type de génération / Generation type, sélectionnez le format du document à générer parmi les possibilités suivantes : Fichier plat RTF PDF HTML DocBook Dans le cadre Nom du fichier modèle / Template file name, renseignez le nom du fichier modèle. Vous avez deux possibilités : sélectionnez le bouton d option Variable pour choisir dans la liste déroulante une variable de type String. Vous pouvez également cliquer sur pour spécifier une variable métier, ou une expression comportant des données métier. ou : sélectionnez le bouton d option Constante pour renseigner le nom du fichier modèle à utiliser. Pour la conception du fichier modèle, veuillez consulter le fichier modèle exemple templateexample.txt disponible sous W4ExtensionBus_Home\product\connectors\extended\w4documentgenerator\resourc es Le fichier modèle devra être créé et placé dans ce même répertoire resources. Dans le cadre Variables attachées / Attached variables, sélectionnez les variables de procédure appropriées. Sélectionnez successivement les onglets Création du document / Document localisation parameters et Connexion au gestionnaire de documents / Connection to datamanager. Connexion au gestionnaire de documents Cet onglet permet de renseigner les paramètres de connexion du plugin au gestionnaire de documents W4 Document Manager : W4 Extension Bus Guide des connecteurs et des plugins 47

50 Fig 6.2 Plugin generatedocument (2/6) Dans le cadre Connexion / Connection, renseignez les paramètres de connexion : Login - Identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Mot de passe / Password - Mot de passe de l'identifiant pour l'accès au gestionnaire de documents W4 Document Manager ; Serveur / Server - Nom ou adresse IP du serveur W4 Engine hébergeant le gestionnaire de document ; Instance - Nom de l'instance du serveur W4 Engine hébergeant le gestionnaire de document. Sélectionnez la case à cocher Mémoriser la connexion / Save connection si vous souhaitez, lors de vos prochaines utilisations du plugin, que les informations de connexion soient pré-renseignées à l'ouverture (à l'exception du mot de passe). Vous pourrez alors sélectionner la connexion dans la liste déroulante Historique des connexions / Connection history. Sélectionnez la case à cocher Mémoriser le mot de passe / Save password si vous souhaitez, lors de vos prochaines utilisations du plugin, que le mot de passe soit pré-renseigné à l'ouverture (sous réserve que le champ Mémoriser la connexion / Save connection soit sélectionné). Sélectionnez le bouton Connexion / Connection. L'onglet Localisation s'affiche. Localisation Cet onglet permet de spécifier le dossier dans lequel le document sera généré : 48 Chapitre 6 Connecteur generatedocument

51 Fig 6.3 Plugin generatedocument (3/6) Dans le cadre Dossier parent / Parent folder, renseignez le dossier du système de GED cible dans lequel vous souhaitez créer le document. Vous avez deux possibilités : sélectionnez le bouton d option Utiliser une variable / Use a variable pour choisir dans la liste déroulante une variable de type EcmDoc ou String (dans ce cas, la variable doit contenir le chemin d accès au dossier parent) ou : sélectionnez le bouton d option Utiliser le dossier sélectionné / Use selected folder pour que le document soit créé dans le dossier sélectionné dans l onglet Type de document / Document type. Sélectionnez l'onglet Type de document / Document type. Type de document Cet onglet affiche l'arborescence du gestionnaire de document et permet de sélectionner le type de document GED à attribuer au document à créer : W4 Extension Bus Guide des connecteurs et des plugins 49

52 Fig 6.4 Plugin generatedocument (4/6) Le cadre Source du document / Document source affiche les systèmes de GED disponibles dans le gestionnaire de document. Sélectionnez le système de GED approprié et, dans ce système de GED, le répertoire approprié. Dans cadre Types de documents disponibles / Available document type, sélectionnez le type de document approprié. Sélectionnez l'onglet Correspondances des métadonnées / Metadata mapping. Correspondances des métadonnées Cet onglet affiche et permet de positionner les propriétés du document cible : Fig 6.5 Plugin generatedocument (5/6) 50 Chapitre 6 Connecteur generatedocument

53 Pour chaque propriété, dans le champ Mode, sélectionnez : Valeur / Value pour attribuer à la propriété une valeur à saisir dans la colonne Valeur / Value ; Variable pour associer à la propriété une variable de procédure à sélectionner dans la colonne Valeur / Value. Sélectionnez le menu Outils / Tools Options. Options La boîte de dialogue Options propose plusieurs options permettant de paramétrer l'utilisation du plugin : Fig 6.6 Plugin generatedocument (6/6) Dans le cadre Connexion / Connection, vous pouvez choisir la connexion qui sera sélectionnée par défaut dans la liste Historique des connexions / Connection history de l'onglet Connexion / Connection. Sélectionnez la case à cocher Connexion automatique / Automatic connection si vous souhaitez que la connexion soit tentée dès l'ouverture du plugin. Le plugin s'ouvrira alors sur l'onglet Type de document source / Type of source document. NOTE La case à cocher Connexion automatique n'est disponible que pour les connexions pour lesquelles le mot de passe a été sauvegardé Pour que la connexion automatique fonctionne, vous devez avoir sélectionné la case à cocher Mémoriser la connexion sur l'onglet Connexion Sélectionnez la case à cocher Afficher une boîte de dialogue / Display a popup si vous souhaitez pouvoir visualiser les stack traces dans une boîte de dialogue en cas d'erreurs de connexion aux différents systèmes de GED. Par défaut, ces informations s affichent dans la partie inférieure du plugin. Dans le cadre Format de saisie des dates / Date format, sélectionnez l'une des deux options possibles : Utiliser le format de la culture locale / Use local culture format pour utiliser le format de date configuré pour la machine hôte du gestionnaire de documents W4 Extension Bus Guide des connecteurs et des plugins 51

54 Utiliser un format spécifique / Use specific format pour définir le format à utiliser. Vous devez alors renseigner un masque de saisie du type YY/mm/dd ou MM/DD/YYYY par exemple dans le champ Format de saisie des dates / Date format Sélectionnez le bouton Sauvegarder / Save pour enregistrer les modifications apportées aux options. Finalisation Lorsque vous avez correctement renseigné les différents onglets du plugin, sélectionnez OK pour valider. Une nouvelle activité fondée sur les paramétrages effectués à l'aide du plugin s'affiche dans le dossier Activités / Activities de l'environnement de travail. Dans le champ Activité du connecteur / Connector activity de la fenêtre de propriétés du nœud robot, on remarque que cette nouvelle activité a été automatiquement associée au noeud robot. Dans le dossier Attributs étendus / Extended atributes de la fenêtre de propriétés du noeud connecteur, vous pouvez constater que les propriétés DocType, souce, generationtype, sourcepath et parentfolder ont été automatiquement renseignées. Si des métadonnées ont été renseignées, vous pouvez constater que leurs valeurs y figurent également. Dans la fenêtre Association de variables / Variable mapping, on constate que deux variables connecteur doc2create et templatename, représentant respectivement le document à créer et le fichier modèle, ont été ajoutées et automatiquement associées conformément aux données renseignées lors de l utilisation du plugin. 6.3 Configuration du connecteur generatedocument Le fichier de configuration par défaut du connecteur generatedocument se nomme default_documentgenerator.properties et est situé sous W4ExtensionBus_Home\product\connectors\extended\w4documentgenerator\resourc es Ce fichier comporte les paramètres de configuration pour chaque format supporté (fichier plat, RTF, DocBook, PDF et HTML). IMPORTANT Ne modifiez pas ce fichier. Pour modifier la configuration par défaut, créez un fichier documentgenerator.properties dans le répertoire resources, et ajoutez-y les clés appropriées. Toute clé trouvée dans ce fichier prévaut sur la clé correspondante dans le fichier de configuration par défaut. 52 Chapitre 6 Connecteur generatedocument

55 6.4 Acteurs et rôles pour generatedocument Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur generatedocument, Process Engine crée automatiquement un acteur nommé GenerateDocument, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur GenerateDocument, vous devez lui attribuer le rôle extensionconnector. W4 Extension Bus Guide des connecteurs et des plugins 53

56 54 Chapitre 6 Connecteur generatedocument

57 Chapitre 7 7 Connecteur w4webservice Cette section décrit l utilisation des connecteurs w4webservice pour l invocation de services web dans les modélisations Process Composer. BUSINESS FIRST est livré avec deux connecteurs w4webservice: w4webservice 1.0 pour l invocation d un service web w4webservice 2.0 pour l invocation d un enchaînement de services web, avec la possibilité de récupérer le résultat de l invocation d un appel précédent Les connecteurs w4webservice sont automatiquement installés par W4 Extension Bus et directement disponibles dans les modélisations Process Composer. Les connecteurs w4webservice sont installés par défaut sous : <W4ExtensionBus_Home>/product/connectors/extended/w4webservice Dans cette section : > 7.1 Ajout d un nœud connecteur w4webservice, page 55 > 7.2 Utilisation du plugin w4webservice 1.0, page 56 > 7.3 Utilisation du plugin w4webservice 2.0, page 57 > 7.4 Acteurs et rôles pour w4webservice, page Ajout d un nœud connecteur w4webservice Ajoutez un nœud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce nœud, sélectionnez Etape connecteur / connector step dans le champ Type spécifique / Specific type puis Web Service dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez Web Service call : 1.0 ou Web Service call : 2.0. Sur la fenêtre de modélisation, l icône a été attribuée au nœud robot. W4 Extension Bus Guide des connecteurs et des plugins 55

58 7.2 Utilisation du plugin w4webservice 1.0 Le connecteur w4webservice 1.0 dispose d un plugin permettant de configurer l invocation d un service web. Affichage du plugin Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Connexion Renseignez les champs suivants pour la connexion au service web, et pour la sélection de l opération souhaitée : URL web Service - Saisissez l URL d accès au service web. Il s agit de l URL du fichier WSDL décrivant le service web. Port - Sélectionnez le port du service web correspondant à l opération souhaitée parmi celles exposées par le service web. Operation - Sélectionnez l opération souhaitée. Association des propriétés Les onglets Propriétés en entrée / Propriétés en sortie permettent d associer les propriétés en entrée et sortie du connecteur w4webservice. Pour chaque propriété, vous pouvez : associer la propriété à une valeur associer la propriété à une variable ne procéder à aucune association Pour associer la propriété à une valeur, sélectionnez VALEUR dans la colonne Mode, puis saisissez la valeur adéquate dans la colonne Expression. Pour associer la propriété à une variable, sélectionnez VARIABLE dans la colonne Mode, puis sélectionnez la variable adéquate dans la liste déroulante de la colonne Expression. 56 Chapitre 7 Connecteur w4webservice

59 Dans le cas de l onglet Propriétés en entrée uniquement, vous pouvez associer une expression. 0 POUR ASSOCIER UNE EXPRESSION À UNE PROPRIÉTÉ 1 Sélectionnez VARIABLE dans la colonne Mode. 2 Double-cliquez dans la colonne Expression. 3 Double-cliquez sur le bouton près de la liste déroulante. Une fenêtre flottante s affiche: Fig 7.1 Saisie d une expression à associer à une variable Pour utiliser l aide à la saisie pour insérer une variable de dossier ou une propriété de dossier, appuyez sur les touches CTRL+SPACE de votre clavier. Pour utiliser l aide à la saisie pour insérer un attribut, saisissez un point immédiatement après la variable puis appuyez sur les touches CTRL+SPACE de votre clavier. Il est possible de combiner une variable et une valeur, ou de combiner des expressions entre elles, par l utilisation des opérateurs arithmétiques (+, -, *, /). Il est possible d utiliser plusieurs niveaux d imbrication pour construire des expressions complexes en utilisant plusieurs niveaux de parenthèses ouvrantes et fermentes, permettant ainsi de modifier l ordre de priorité des opérateurs booléens en fonction du niveau de complexité de l expression souhaitée. NOTE La syntaxe utilisée pour l expression doit être compatible JEXL 2. Avant toute validation, le bouton Vérifier vous permet de procéder à une vérification syntaxique de l expression. 7.3 Utilisation du plugin w4webservice 2.0 Le connecteur w4webservice 2.0 dispose d un plugin permettant de configurer un enchaînement d appels de services web. Pour l affichage du plugin, veuillez vous reporter à la documentation du connecteur w4webservice 1.0 : > Affichage du plugin, page 56 W4 Extension Bus Guide des connecteurs et des plugins 57

60 Pour la connexion à un service web et la sélection de l opération souhaitée, veuillez vous reporter à la documentation du connecteur w4webservice 1.0 : > Connexion, page 56 Pour l association des propriétés en entrée et en sortie, veuillez vous reporter à la documentation du connecteur w4webservice 1.0 : > Association des propriétés, page 56 0 POUR UTILISER LE PLUGIN DU CONNECTEUR W4WEBSERVICE Afficher le plugin. 2 Cliquez sur Ajouter pour configurer une invocation à un service web. 3 Renseignez les paramètres de connexion au service web. 4 Procédez à l association des propriétés du service web. Pour récupérer le résultat d un appel précédent dans une expression, sélectionnez l appel souhaité dans la section Appel précédent de la liste déroulante affichée lorsque l aide à la saisie est demandée sur la fenêtre de saisie de l expression. 5 Réitérez les étapes 1 à 4 pour chaque appel supplémentaire souhaité. NOTE Pour afficher la configuration d un appel, sélectionnez-le dans la liste. NOTE Pour supprimer la configuration d un appel, sélectionnez-le puis cliquez sur Supprimer. 6 Cliquez sur OK. 7.4 Acteurs et rôles pour w4webservice Lors de l envoi vers le serveur Process Engine d une procédure comportant un nœud connecteur w4webservice, Process Engine crée automatiquement un acteur nommé WebService, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur WebService, vous devez lui attribuer le rôle extensionconnector. 58 Chapitre 7 Connecteur w4webservice

61 Chapitre 8 8 Connecteur NOP Cette section décrit l utilisation du connecteur NOP. Le connecteur NOP (acronyme de No OPeration) est utilisé dans une modélisation pour réaliser un traitement décorrélé des étapes du processus. Exemple d'utilisation : on ajoute un connecteur NOP avant le nœud de fin pour mettre à jour une variable métier, par exemple pour faire passer un statut de l'état en cours à l'état traité. Le connecteur NOP est automatiquement installé par W4 Extension Bus et directement disponible dans les modélisations Process Composer. Le connecteur NOP est installé par défaut sous : <W4ExtensionBus_Home>/product/connectors/simple/connector Dans cette section : > 8.1 Ajout d un nœud connecteur NOP, page 59 > 8.2 Utilisation du plugin NOP, page 60 > 8.3 Acteurs et rôles pour le connecteur NOP, page Ajout d un nœud connecteur NOP Ajoutez un noeud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce noeud, sélectionnez Etape connecteur / connector step dans le champ Type spécifique / Specific type puis Divers dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez NOP. Sur la fenêtre de modélisation, l icône a été attribuée au noeud. W4 Extension Bus Guide des connecteurs et des plugins 59

62 8.2 Utilisation du plugin NOP Le connecteur NOP dispose d un plugin permettant d ajouter aisément des variables connecteur qu il vous suffit ensuite d associer à des variables de procédure. Affichage du plugin Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier Création des variables 0 POUR CRÉER ET ASSOCIER LES VARIABLES 1 Affichez le plugin NOP. 2 Cliquez sur Ajouter pour créer une variable connecteur. 3 Renseignez les nom, type, cardinalité et mode. 4 Réitérez les étapes 2 à 3 pour toute variable supplémentaire souhaitée. NOTE Pour supprimer une variable, sélectionnez-la plus cliquez sur Supprimer. 5 Validez par OK. Une fois créées, les variables connecteur doivent être associées à des variables de procédure, constantes, propriétés de dossier, ou expressions dans la fenêtre Affectations. 8.3 Acteurs et rôles pour le connecteur NOP Lors de l envoi vers le serveur Process Engine d une procédure comportant un noeud connecteur NOP, Process Engine crée automatiquement un acteur nommé nop, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur nop, vous devez lui attribuer le rôle extensionconnector. 60 Chapitre 8 Connecteur NOP

63 Chapitre 9 9 Connecteurs d assignation externe Cette section décrit la possibilité de déléguer l assignation des tâches à des connecteurs d assignation. Dans cette section : > Utilisation des connecteurs d assignation, page 61 > Acteurs et rôles W4 Engine pour les connecteurs d assignation, page 62 Utilisation des connecteurs d assignation Dans votre modélisation Process Composer, sélectionnez le noeud correspondant à l étape dont l assignation doit être déléguée à un connecteur dédié. Dans la fenêtre des propriétés de ce noeud, dans le dossier Assignation, sélectionnez le mode Assignation externe puis, dans le champ Externe, le connecteur approprié parmi les connecteurs d assignation disponibles : Responsable - Assignation au responsable d un acteur Distribution sauf une liste d acteurs - Assignation en mode distribution à un rôle, à l exception d un ou plusieurs acteurs membres de ce rôle Distribution sauf un rôle - Assignation en mode distribution à un rôle, à l exception des acteurs également membres d un autre rôle Libre-service sauf une liste d acteurs - Assignation en libre-service à un rôle, à l exception d un ou plusieurs acteurs membres de ce rôle Libre-service sauf un rôle - Assignation en libre-service à un rôle, à l exception des acteurs également membres d un autre rôle Libre-service sur une intersection de rôles - Assignation en libre-service aux acteurs membres à la fois de tous les rôles spécifiés Procédez ensuite aux associations de variables dans la fenêtre Assignation externe. Pour plus de détails, veuillez consulter le Manuel de référence de Process Composer. W4 Extension Bus Guide des connecteurs et des plugins 61

64 Si les connecteurs d assignation disponibles en standard ne permettent pas de répondre à votre problématique d assignation : > Utiliser un connecteur d assignation spécifique, page 62 Acteurs et rôles W4 Engine pour les connecteurs d assignation Lors de l envoi vers le serveur W4 Engine d une procédure faisant appel à un connecteur d assignation, W4 Engine crée automatiquement un acteur pour le connecteur concerné. Cet acteur est nommé : assignment_manager pour le connecteur Responsable assignment_roleexceptactorsdistribution pour le connecteur Distribution sauf une liste d acteurs assignment_roleexceptroledistribution pour le connecteur Distribution sauf un rôle assignment_roleexceptactorspool pour le connecteur Libre-service sauf une liste d acteurs assignment_roleexceptrolepool pour le connecteur Libre-service sauf un rôle assignment_roleintersectionpool pour le connecteur Libre-service sur une intersection de rôles Vous devez attribuer à ces acteurs le rôle extensionconnector. Utiliser un connecteur d assignation spécifique Si les connecteurs disponibles en standard ne permettent pas de répondre à votre problématique d assignation il vous est possible de développer un connecteur d assignation spécifique. Ce connecteur devra hériter de W4AssignmentConnector. Il sera nécessaire de surcharger la méthode public List<BPMAssignee> getassignees() throws W4ConnectorExecutionException afin de retourner la liste des entités auxquelles devra être adressée la tâche. Note : Un BPMAssignee peut être défini par un BPMId d acteur ou de rôle. Enfin, pour utiliser le connecteur dans votre modélisation, vous devrez, dans la fenêtre des propriétés du noeud approprié, sélectionner le mode Assignation externe dans le dossier Assignation, puis votre connecteur d assignation spécifique dans le champ Externe. 62 Chapitre 9 Connecteurs d assignation externe

65 Chapitre Fonction pickup et connecteur XPathFileProcessor Cette section décrit d une part la fonction pickup de W4 Extension Bus, utilisée pour scruter régulièrement un répertoire de pickup afin de déclencher la création d une instance de processus à l arrivée d un nouveau document, et d autre part le connecteur XPathFileProcessor utilisé pour exploiter des données issues d un fichier XML dans les variables d un processus. Dans cette section : > Fonction pickup, page 63 > Connecteur XPathFileProcessor, page 64 > 10.1 Configuration des répertoires de pickup, page 64 > 10.2 Ajout d un noeud connecteur XPathFileProcessor, page 65 > 10.3 Utilisation du plugin XPathFileProcessor, page 65 > 10.4 Exemples de syntaxe pour les expressions XPath, page 66 > 10.5 Acteurs et rôles pour XPathFileProcessor, page 67 Fonction pickup La fonction pickup est automatiquement lancée avec W4 Extension Bus, versions 8.5 et ultérieures. Pour pouvoir utiliser cette fonction, vous devez configurer un ou plusieurs répertoires de pickup, et votre processus Process Composer doit comporter une variable de type EcmDoc. Le répertoire de pickup est analysé à intervalles réguliers et un nouveau dossier workflow est créé lorsqu un nouveau document est détecté. Tous les types de documents sont compatibles avec la fonction pickup. Veuillez noter cependant que seuls les documents XML peuvent faire l objet d une récupération de données par le connecteur XPathFileProcessor. Cas d utilisation de la fonction pickup : Suivi de courrier / facture. Déclenchement d une procédure de traitement suite à la réception d un document. W4 Extension Bus Guide des connecteurs et des plugins 63

66 Connecteur XPathFileProcessor Le connecteur XPathFileProcessor sera souvent utilisé conjointement avec la fonction pickup mais pourra également être utilisé de façon indépendante. Cas d utilisation conjointe fonction pickup / connecteur XPathFileProcessor : saisie d une demande de badge dans un ERP-RH. Saisie de la demande de badge dans une application externe produisant un fichier XML avec les données saisies, puis validation et traitement dans une procédure. Le connecteur XPathFileProcessor est automatiquement installé par W4 Extension Bus et directement disponible dans la modélisation, dans Process Composer, versions 8.5 et ultérieures. Le connecteur XPathFileProcessor est installé par défaut sous <W4ExtensionBus_Home>/product/connectors/ 10.1 Configuration des répertoires de pickup La fonction pickup se configure dans le fichier extbus.<instancename>.properties situé par défaut sous ProcessEngine_Home\sys Les paramètres à configurer sont les suivants : PARAMETRE extbus.pickupfeature.class extbus.pickups extbus.pickup.<pickupname>.source extbus.pickup.<pickupname>.path extbus.pickup.<pickupname>.filter extbus.pickup.<pickupname>.ecmdocvari able extbus.pickup.<pickupname>.procedure DESCRIPTION Pour activer la fonction pickup, ce paramètre doit être positionné sur eu.w4.extbus.feature.pickup.pickup Pour spécifier les noms des pickups. Exemple : extbus.pickups=pickupname1,pickup2name Chaque pickup doit être défini ensuite à l aide des paramètres ci-dessous. Pour spécifier le système de GED à utiliser pour le pickup considéré. Exemple : extbus.pickup.pickupname1.source=eecm-src Pour spécifier le dossier*** du système de GED à analyser. Exemple : extbus.pickup.pickupname1.path=/source Pour spécifier l extension des fichiers à charger. Exemple : extbus.pickup.pickupname1.filter=xml Pour spécifier le nom de la variable dans laquelle sera stocké le chemin du fichier chargé. Exemple : extbus.pickup.pickupname1.ecmdocvariable=ecmdoc Pour spécifier le nom de la procédure sur laquelle un dossier devra être créé lorsqu un fichier sera chargé. Exemple : extbus.pickup.pickupname1.procedure=myprocedure 64 Chapitre 10 Fonction pickup et connecteur XPathFileProcessor

67 PARAMETRE extbus.pickup.<pickupname>.time extbus.pickup.<pickupname>.sourcemove extbus.pickup.<pickupname>.pathmove extbus.pickup.<pickupname>.sourceerror Move extbus.pickup.<pickupname>.patherrorm ove DESCRIPTION Pour spécifier l intervalle de temps, en secondes, entre deux analyses du contenu du dossier. Exemple : extbus.pickup.pickupname1.time=1 Pour spécifier le système de GED dans lequel le fichier chargé sera déposé à l issue du traitement. Exemple : extbus.pickup.pickupname1.sourcemove=eecm-src Pour spécifier le dossier*** du système de GED dans lequel le fichier chargé sera déposé à l issue du traitement. Exemple : extbus.pickup.pickupname1.pathmove=/copy Pour spécifier le système de GED dans lequel le fichier chargé sera déposé en cas d erreur pendant le traitement. Exemple : extbus.pickup.pickupname1.sourceerrormove=eecm-src Pour spécifier le dossier*** du système de GED dans lequel le fichier chargé sera déposé en cas d erreur pendant le traitement. Exemple : extbus.pickup.pickupname1.patherrormove=/error *** Ces trois dossiers doivent appartenir au même repository mais n appartiennent pas nécessairement à la même source Ajout d un noeud connecteur XPathFileProcessor Ajoutez un noeud d étape robot à votre procédure. Dans la fenêtre des propriétés de ce noeud, sélectionnez Etape connecteur / Connector step dans le champ Type spécifique / Specific type puis File Processor dans le champ Catégorie du connecteur / Connector category. Enfin, dans le champ Nom du connecteur / Connector name, sélectionnez XPathFileProcessor. Sur la fenêtre de modélisation, vous pouvez constater que l icône a été attribuée au noeud robot Utilisation du plugin XPathFileProcessor Le connecteur XPathFileProcessor dispose d un plugin permettant : W4 Extension Bus Guide des connecteurs et des plugins 65

68 de sélectionner la variable EcmDoc de votre processus correspondant au document dont les données doivent être exploitées ; d associer les données du document à des variables de dossier. Pour afficher le plugin : double-cliquez sur le nœud robot correspondant au connecteur dans la fenêtre de modélisation ou : double-cliquez sur le bouton du champ Nom du connecteur / Connector name dans la fenêtre de propriétés du nœud robot. ou : sélectionnez le nœud robot correspondant au connecteur dans la fenêtre de modélisation puis appuyez sur la touchée ENTREE de votre clavier L association des données du document à des variables de dossier se fait via des expressions utilisant la syntaxe du langage de requête XPath. L association se fait au moyen de trois colonnes : Source expression XPath, Valeur/Variable source et Variable de destination. Il existe deux possibilités : Pour définir l expression dans le plugin, sélectionnez EXPRESSION dans la colonne Source expression XPath, puis saisissez l expression dans la colonne Valeur/Variable source. Pour que l expression soit évaluée à l exécution, sélectionnez VARIABLE dans la colonne Source expression XPath, puis sélectionnez dans la colonne Valeur/Variable source la variable qui contiendra l expression XPath. Dans la colonne Variable de destination, sélectionnez la variable de dossier appropriée ou saisissez une expression comportant des données métier Exemples de syntaxe pour les expressions XPath Exemple 1 Dans le fichier XML suivant : Pour obtenir le titre du premier livre, on saisira l expression : /bookstore/book[1]/title Pour obtenir la liste des titres, on saisira l expression : /bookstore/book/title <?xml version="1.0" encoding="iso "?> <bookstore> <book> <title lang="eng">harry Potter</title> <price>29.99</price> </book> <book> <title lang="eng">learning XML</title> <price>39.95</price> </book> </bookstore> 66 Chapitre 10 Fonction pickup et connecteur XPathFileProcessor

69 Exemple 2 Dans le fichier XML suivant : Le format yyyy/mm/dd doit être respecté pour le champ date. Pour les champs occupant plusieurs lignes, veillez à sélectionner l option Multi dans Application Composer. <?xml version="1.0" encoding="iso "?> <claimform> <customer> <id>1</id> <lastname>kenderv</lastname> <firstname>joakim</firstname> < >[email protected]</ > </client> <claim> <type>location</type> <incidentdate>2011/10/04 00:00:00</incidentDate> <description>brakes broken. Repair is not feasible.</description> </customer> </claimform> 10.5 Acteurs et rôles pour XPathFileProcessor Lors de l envoi vers le serveur Process Engine d une procédure comportant un noeud connecteur XPathFileProcessor, Process Engine crée automatiquement un acteur nommé XPathFileProcessor, auquel sont assignées les tâches associées au connecteur. Pour que ces tâches soient correctement assignées à l acteur XPathFileProcessor, vous devez lui attribuer le rôle extensionconnector. W4 Extension Bus Guide des connecteurs et des plugins 67

70 68 Chapitre 10 Fonction pickup et connecteur XPathFileProcessor

71 Chapitre Ajout d un type personnalisé dans le système de GED Cette section décrit l ajout d un type personnalisé dans le système de GED. L exemple fourni s applique à Alfresco. Un type correspond à une fiche GED, c est-à-dire à l ensemble des métadonnées associées à un document. Dans Alfresco, il est courant d utiliser le type cm:content. Il arrive cependant fréquemment qu un type personnalisé doive être créé. Dans l exemple ci-dessous, deux nouvelles fiches sont créées dans Alfresco : fiche contrat, avec pour métadonnées : nom_assure et prenom_assure fiche photo, avec pour métadonnée : etat Pour ajouter ces fiches, éditer le fichier defaultcustommodel.xml, sous <Alfresco_Home>\tomcat\webapps\alfresco\WEB-INF\classes\alfresco\model\ et ajouter la section suivante : <types> <type name="custom:contrat"> <title>contrat</title> <parent>cm:content</parent> <properties> <property name="custom:nom_assure"> <type>d:text</type> </property> <property name="custom:prenom_assure"> <type>d:text</type> </property> </properties> </type> <type name="custom:photo"> <title>photo</title> <parent>cm:content</parent> <properties> <property name="custom:etat"> <type>d:text</type> </property> </properties> </type> W4 Extension Bus Guide des connecteurs et des plugins 69

72 </types> Relancer Alfreco pour prendre en compte l ajout des nouvelles fiches. 70 Chapitre 11 Ajout d un type personnalisé dans le système de GED

73 Illustrations Plugin par défaut 11 Ajout de variables étendues 24 Plugin updatemetadata (1/4) 28 Plugin updatemetadata (2/4) 29 Plugin updatemetadata (3/4) 30 Plugin updatemetadata (4/4) 31 Plugin copydocument (1/3) 35 Plugin copydocument (2/3) 36 Plugin copydocument (3/3) 37 Plugin createfolder (1/3) 41 Plugin createfolder (2/3) 42 Plugin createfolder (3/3) 43 Plugin generatedocument (1/6) 46 Plugin generatedocument (2/6) 48 Plugin generatedocument (3/6) 49 Plugin generatedocument (4/6) 50 Plugin generatedocument (5/6) 50 Plugin generatedocument (6/6) 51 Saisie d une expression à associer à une variable 57 W4 Extension Bus Guide des connecteurs et des plugins 71

74 72 Illustrations

75 Index C E F catchmessage, connecteur 23 Connecteur catchmessage 23 Connecteur copydocument 33 Connecteur createfolder 39 Connecteur generatedocument 45 Connecteur Mise à jour de métadonnées d un document 28, 34, 40, 46 Connecteur No Operation 59 Connecteur NOP 59 Connecteur updatemetadata 27 Connecteur W4JavaMail 9, 11 Connecteur w4webservice 55 Connecteur w4webservice,w4webservice, connecteur 55 Connecteur XPathFileProcessor 63, 65 Connecteurs d assignation externe 61 Connecteurs, plugin par défaut 10, 24 copydocument, connecteur 33 copydocument, plugin 34 createfolder, connecteur 39 createfolder, plugin 40 EcmDoc 28 Fonction pickup 63 W4 Extension Bus Guide des connecteurs et des plugins 73

76 G N P U V W generatedocument, connecteur 45 generatedocument, plugin 46 No Operation, connecteur 59 No Operation, plugin 60 NOP, connecteur 59 NOP, plugin 60 Pickup 63 Plugin du connecteur copydocument 34 Plugin du connecteur createfolder 40 Plugin du connecteur generatedocument 46 Plugin du connecteur updatemetadata 28 Plugin du connecteur XPathFileProcessor 65 Plugin No Operation 60 Plugin NOP 60 Plugin par défaut, connecteurs 10, 24 Plugin w4webservice Plugin w4webservice updatemetadata, connecteur 27 updatemetadata, plugin 28 Variable CmsDoc 28 W4JavaMail, connecteur 9, 11 w4webservice 1.0 plugin 56 w4webservice 2.0, plugin 57 w4webservice, connecteur Index

77 X XPathFileProcessor, connecteur 63, 65 XPathFileProcessor, plugin 65 W4 Extension Bus Guide des connecteurs et des plugins 75

78 W4 EXTENSION BUS GUIDE DES CONNECTEURS ET DES PLUGINS Référence: EXTBUS_CONNECTORS_046_FR