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