Manuel Utilisateur ENIGMA 15/04/ , rue Saint Sulpice Centre Tertiaire de l Arsenal DOUAI

Transcription

1 Manuel Utilisateur 15/04/2008 ENIGMA

2 Cahier de réalisation ENIGMA Page 2 Sommaire I. Introduction :... 3 II. Les répertoires de l application... 3 III. Les plugins... 4 a. CmdDos... 4 b. CSV2XML... 4 c. XslTransform... 4 d. MailPop... 5 e. MailSMTP... 5 f. connexionbdd... 6 g. connexionbddout... 6 h. Outlook... 7 i. ConnexionReseau... 7 j. Edi2Xml... 7 IV. Démarrer Enigma... 8 V. Le routeur... 8 a. Paramétrage du routeur... 8 b. Démarrer le routeur c. Arrêter le routeur VI. XmlMapping VII. Le journal d événements a. Ouvrir le journal d événements b. Enregistrer le journal d événements c. Supprimer le contenu du journal d événements... 20

3 Cahier de réalisation ENIGMA Page 3 I. Introduction : Enigma est une application permettant de récupérer des données par connexion réseau, pop, smtp, base de données. De transformer les données et de les renvoyer par mail ou de les insérer dans une base de données. Cette application permet de paramétrer un enchainement d action et de configurer chaque action. Une fois configuré on démarre l enchainement et l ensemble des actions s effectuent en boucle. II. Les répertoires de l application Config_bdd_out Ce dossier contient les fichiers de configuration d insertion des données utilisé pour le fonctionnement du plugin connexionbddout. Log Ce dossier contient les différents fichiers de LOG. Ces fichiers sont modifiés à chaque fois que le routeur fonctionne. Pour chaque plugin, on enregistre les messages de LOG correspondant au plugin dans le fichier de LOG portant le nom du plugin. Maillin Ce dossier fait parti de la première version d enigma. Il contient les fichiers à traiter par les plugins. Mailout Ce dossier fait parti de la première version d enigma. Il contient les fichiers issu du traitement par les plugins. Plugins Ce dossier contient l ensemble des plugins utilisable par l application Enigma. Ce sont des DLL. Setup Ce fichier contient les fichiers de configuration généraux de l application ENIGMA et du routeur. Structure Ce fichier contient l ensemble des fichiers de structure des plugins. Chaque plugin possède un fichier de structure. Ce fichier de structure est un fichier XML permettant de décrire l ensemble des paramètres de configuration nécessaire au bon fonctionnement du plugin.

4 Cahier de réalisation ENIGMA Page 4 UserConfig Ce dossier contient l ensemble des fichiers de configuration crée par l utilisateur pour le paramétrage de ces plugins. Ces fichiers contiennent les valeurs des paramètres utilisés par les plugins. Ces fichiers sont créés à partir des fichiers de structure et utilisé par les plugins lors de leur utilisation. Ces fichiers sont créés ou modifié dans l interface de configuration du routeur ou dans l application XMLGenCongig. III. Les plugins a. CmdDos Ce plugin permet d exécuter une commande dos. Il prend comme paramètre de configuration : EXE : une commande DOS. CMDos est un plugin d execution. b. CSV2XML Ce plugin permet de transformer un fichier au format.csv ou.txt en un fichier xml. Ce plugin prend comme paramètres de configuration : FICHIER_ TRANSFORMATION : contenant les régle de transformation permettant de passer de la structure CSV à la structure XML NOM_FICHIER : expression régulière permettant de restreindre le traitement des fichiers en entrés (exemple : Dans le groupe de fichiers en entrée je ne souhaite traiter que les fichiers ayant la date «06 02» dans leur nom et une extension.csv et les fichiers ayant la date «07 02» dans leur nom et une extension.txt, la valeur du paramètres pattern sera donc : *06 02.csv ;*07 02.txt Ce plugin est un plugin de traitement. Il prend des fichiers.csv ou.txt en entrée et sort des fichiers.xml. c. XslTransform Ce plugin permet de transformer un fichier XML en un autre fichier XML en passant par un fichier XSLT contenant les règles de transformation.

5 Cahier de réalisation ENIGMA Page 5 Ce plugin prend comme paramètres de configuration : FICHIER_ XSLT : contenant le chemin vers le fichier XSLT permettant la transformation. Ce plugin est un plugin d entrée/sortie. Il prend des fichiers.xml en entrée et sort des fichiers.xml. d. MailPop Ce plugin permet de se connecter à un serveur de messagerie POP pour en récupérer les mails. De filtrer les mails par l objet. D extraire les différentes parties du mail : pièces jointes, corps du message... Ce plugin prend comme paramètres de configuration : SERVEUR : contenant l adresse ip du serveur. USER : contenant l identifiant pour la connexion au serveur PASSWORD : contenant le mot de passe pour la connexion au serveur KEYWORDS : contenant les mots clés pour filtrer les mails. Zéro, une ou plusieurs expressions régulières séparées par des points virgules. DELETE : true ou false qui vous permet de décider si oui ou non les s doivent être supprimés du serveur de messagerie. Ce plugin est un plugin d entrée. Il renvoie des mails et leurs pièces jointes. e. MailSMTP Ce plugin permet de se connecter à un serveur de messagerie SMTP pour envoyer des mails. Ce plugin prend comme paramètres de configuration : SERVEUR : contenant l adresse ip du serveur. USER : contenant l identifiant pour la connexion au serveur PASSWORD : contenant le password pour la connexion au serveur SUJET : contenant le sujet du mail CORPS : contenant le corps du mail HTML : détermine si oui ou non le mail doit etre envoyé au format HTML FROM : contenant l adresse de l emettteur DESTINATAIRES : contient la ou les adresses s des destinataires séparé par des points virgules.

6 Cahier de réalisation ENIGMA Page 6 Ce plugin est un plugin de sortie. Il récupère les fichiers généré par le précédent plugin et les envoie en pièce jointe par mails. f. connexionbdd Ce plugin permet de se connecter à une base de données (MySql, Oracle ou SQLServer). D exécuter une requête SQL de sélection. D extraire le résultat et de l enregistrer dans un fichier XML. Ce plugin prend comme paramètres de configuration : SERVEUR : contenant l adresse ip du serveur. BDD : contenant le nom de la base de données DRIVER : contenant le driver de connexion à la BDD si la base est du type MySQL USER : contenant l identifiant pour la connexion à la base de données PASSWORD : contenant le mot de passe pour la connexion à la base de données SQL_COMMAND : contenant la requête SQL de selection TYPE : contenant le type de la base de données : MySQL, ORACLE, SQLServer CHEMIN_FICHIER : contenant le chemin ou vous voulez enregistrer le fichier XML de résultat NOM_FICHIER : contenant le nom que vous souhaitez donner à votre fichier XML de résultat Ce plugin est un plugin d entrée. Il génére un fichier XML correspondant au résultat de la requête SQL passée en paramètre. g. connexionbddout Ce plugin permet de se connecter à une base de données (MySql, Oracle ou SQLServer) et d insérer les données d un fichier XML qui lui est passé en entrée dans la base de données. L insertion se fait grâce à un fichier contenant des règles permettant de passé de la structure XML à la structure de la BDD. Ce plugin prend comme paramètres de configuration : SERVEUR : contenant l adresse ip du serveur. BDD : contenant le nom de la base de données DRIVER : contenant le driver de connexion à la BDD si la base est du type MySQL USER : contenant l identifiant pour la connexion à la base de données PASSWORD : contenant le mot de passe pour la connexion à la base de données FICHIER_CONFIG : contenant le chemin du fichier de configuration contenant les régles pour l insertion des données.

7 Cahier de réalisation ENIGMA Page 7 TYPE : contenant le type de la base de données : MySQL, ORACLE, SQLServer Ce plugin est un plugin de sortie. Il récupère le ou les fichiers XML généré par le plugin précédent et insère les données de ces fichiers dans la base de données. h. Outlook Ce plugin permet de se connecter à votre Outlook pour en récupérer les mails. De filtrer les mails par l objet. D extraire les différentes parties du mail : pièces jointes, corps du message... Ce plugin prend comme paramètres de configuration : KEYWORDS : contenant les mots clés pour filtrer les mails. Zéro, une ou plusieurs expressions régulières séparées par des points virgules. Ce plugin est un plugin d entrée. Il renvoie des mails et leurs pièces jointes. i. ConnexionReseau Ce plugin permet de se connecter au dossier d un serveur pour en récupérer les fichiers en filtrant les fichiers par nom. Ce plugin prend comme paramètres de configuration : SERVEUR : contenant l adresse ip du serveur. USER : contenant l identifiant pour la connexion au serveur PASSWORD : contenant le mot de passe pour la connexion au serveur KEYWORDS : contenant les mots clés pour filtrer les fichiers. Zéro, une ou plusieurs expressions régulières séparées par des points virgules. Ce plugin est un plugin d entrée. Il renvoie des fichiers. j. Edi2Xml Ce plugin permet de transformer un fichier.txt EDI en fichier XML à partir de son guideline. Ce plugin prend comme paramètres de configuration : KEYWORDS : contenant les filtres sur les fichiers d entrées. De la forme : debut*.csv ; *.txt

8 Cahier de réalisation ENIGMA Page 8 CHEMIN_GUIDELINE : contenant le chemin complet vers le dossier des guidelines avec un «/» à la fin. FICHIER_GUIDELINE : contenant un fichier de guideline précis. Ce plugin est un plugin d entrée/sortie. Il prend des fichiers.txt en entrée et sort des fichiers.xml. IV. Démarrer Enigma Pour démarrer ENIGMA, cliquer sur l icône nommé Routeur.exe. V. Le routeur a. Paramétrage du routeur Avant de démarrer pour la première fois le routeur, il faut le paramétrer. C'est à dire configurer un ensemble de taches successives qu il va devoir effectuer de façon répétitive. Pour cela, allez dans configuration/configurer le routeur (traitement sur les messages). La fenêtre de paramétrage du routeur apparait :

9 Cahier de réalisation ENIGMA Page 9 Dans la fenêtre de configuration du routeur affichée ci dessous vous pouvez voir que le routeur a déjà des paramètres. Ces paramètres sont organisé selon un arbre d éléments : La racine principale représente le routeur : «paramétrage du routeur» Les branches de premier niveau 1 représentent les groupes de taches. Ici nous avons un groupe de taches nommé «mail». Les branches de second niveau 2 représentent les taches. Ici nous avons une tache appelé «connexion». Les branches de troisième niveau 3 représentent les modules. Ici nous avons le module «connexionbddout». Les branches de quatrième niveau 4 représentent les paramètres des modules. Ici nous avons une serie de 7 paramètres «serveur», «bdd», «driver» AJOUTER UN NOUVEAU GROUPE DE TACHES : Pour ajouter un nouveau groupe de taches, cliquer sur le nœud principal «parametrage du routeur» puis cliqué sur le bouton «ajouter».

10 Cahier de réalisation ENIGMA Page 10 1 Le nouveau groupe de taches apparait dans l arbre (comme dans l image ci dessus) : Par défaut il est nommé «sans_nom». En cliquant sur le groupe de taches créé vous pouvez modifier le nom du groupe de tache en écrivant le nouveau nom dans la case 1 (voir ci dessus). SUPPRIMER UN GROUPE DE TACHES EXISTANT : Pour supprimer un groupe de taches, cliquez sur le groupe de taches puis cliquez sur le bouton «supprimer». Le groupe de taches est supprimé. AJOUTER UNE TACHE : Pour ajouter une nouvelle tache, cliquez sur le groupe de taches auquel vous souhaitez ajouter une tache puis cliquez sur le bouton «ajouter».

11 Cahier de réalisation ENIGMA Page 11 1 La nouvelle tache apparait dans l arbre (comme dans l image ci dessus) : Par défaut elle est nommée «Tache sans nom». En cliquant sur la tache créée vous pouvez modifier son nom en écrivant le nouveau nom dans la case 1 (voir ci dessus). SUPPRIMER UNE TACHE: Pour supprimer une tache, cliquez sur la tache puis cliquez sur le bouton «supprimer». La tache est supprimée. AJOUTER UN MODULE : Pour ajouter un nouveau module, cliquez sur la tache a laquelle vous souhaitez ajouter un module puis cliquez sur le bouton «ajouter».

12 Cahier de réalisation ENIGMA Page Le nouveau module apparait dans l arbre (comme dans l image ci dessus) : Par défaut il est nommé «Module_sans_nom». En cliquant sur le module créé, vous pouvez modifier le nom du module, en sélectionnant le plugin que vous désirez affecter au module, dans la liste déroulante 1. Si des fichiers de configuration, pour le plugin que vous avez choisi, existent déjà ces fichiers apparaissent dans la liste déroulante 2. Vous pouvez alors choisir l un des fichiers existants pour configurer votre plugin. Pour chaque fichier de configuration existant vous pouvez modifier les valeurs de chaque paramètre (voir les explications pour configurer les paramètres d un module). Ou vous pouvez choisir de créer un nouveau fichier de configuration. Si aucun fichier de configuration pour le plugin sélectionné n est disponible, l application vous demandera de créer un nouveau fichier de configuration. (voir les explications pour la création d un nouveau fichier de configuration pour un module). SUPPRIMER UN MODULE : Pour supprimer un module, cliquez sur le module puis cliquez sur le bouton «supprimer». Le module est supprimé. CONFIGURER LES PARAMETRES D UN MODULE : Après avoir sélectionné un plugin pour le module, si des fichiers de configuration existent pour ce plugin, ils apparaissent dans la liste déroulante 2 (voir image ci dessus). Par défaut, le

13 Cahier de réalisation ENIGMA Page 13 premier fichier de configuration est sélectionné et les paramètres et leurs valeurs apparaissent dans l arbre : 1 Pour modifier la valeur d un paramètre, il vous suffit de cliquer sur le paramètre puis de modifier sa valeur dans la zone 1 qui apparait (voir image ci dessus). Pour chaque paramètre vous aurez, dans la zone de configuration 1, une phrase d explication et une zone de saisie. Selon le type du paramètre vous aurez soit un champ texte à une ligne, un champ texte à plusieurs ligne ou liste déroulante. A chaque fois que vous modifiez un paramètre vous voyez sa nouvelle valeur apparaitre dans l arbre. CREER UN NOUVEAU FICHIER DE CONFIGURATION POUR UN MODULE : Pour créer un nouveau fichier de configuration pour un plugin, cliquez sur le module dans l arbre puis dans liste des fichiers de configuration, sélectionnez «nouveau fichier de configuration» :

14 Cahier de réalisation ENIGMA Page 14 1 L application vous invite à donner un nom à votre nouveau fichier de configuration. Entrez votre nom de fichier dans la case 1, puis cliquez sur le bouton «enregistrer nouveau fichier». Votre nouveau fichier de configuration est crée et les valeurs de ses paramètres sont à vide :

15 Cahier de réalisation ENIGMA Page 15 Vous pouvez à présent entrer vos valeurs pour vos paramètres. ENREGISTREMENT DE LA CONFIGURATION DU ROUTEUR : Après avoir configuré le routeur, cliquer sur la petite croix en haut à droite, et lorsque l application vous propose d enregistrer les modifications, cliquez sur «oui».* b. Démarrer le routeur Pour démarrer le routeur, vous avez deux possibilités : Cliquez sur «Démarrer» qui se trouve dans l encadré «commandes standards» Cliquez dans le menu commandes/demarrer le routeur

16 Cahier de réalisation ENIGMA Page 16 c. Arrêter le routeur Pour arrêter le routeur, vous avez deux possibilités : Cliquez sur «Arrêter» qui se trouve dans l encadré «commandes standards» Cliquez dans le menu commandes/arrêter le routeur

17 Cahier de réalisation ENIGMA Page 17 VI. XmlMapping Pour accéder à l outil XMLMapping, allez dans le menu «configuration» et cliquez sur «mapping des données». La fenêtre de l outil de mapping apparait :

18 Cahier de réalisation ENIGMA Page 18 1 : Cliquer sur le bouton «ouvrir un premier fichier xml» pour ouvrir le premier fichier qui va vous servir pour le mapping des données. L arbre XML du premier fichier choisi apparait dans la zone 2. 2 : Zone contenant l arbre XML du premier fichier XML choisi. 3 : Cliquer sur le bouton «ouvrir un second fichier xml» pour ouvrir le second fichier qui va vous servir pour le mapping des données. L arbre XML du second fichier choisi apparait dans la zone 3. 4 : Zone contenant l arbre XML du second fichier XML choisi. 5 : Lorsque vous sélectionnez un champ dans l arbre XML du premier fichier (Zone 2), celui ci apparait dans cette case et est prêt à être éventuellement mappé. 6 : Lorsque vous sélectionnez un champ dans l arbre XML du second fichier (Zone 4), celui ci apparait dans cette case et est prêt à être éventuellement mappé. 7 : Lorsque vous avez sélectionné les deux champs que vous souhaitez mappé et si une règle XSLT peut être appliquée au mapping de ces deux champs, le champ «instruction XSLT» se dégrise. Vous pouvez alors spécifier une règle XSLT pour le mapping des données.

19 Cahier de réalisation ENIGMA Page 19 8 : Le bouton «ajouter ce mapping» permet d ajouter le mapping des données. Une fois ajouté, le mapping apparait dans la zone 9. 9 : La zone contient la liste des règles de mapping que vous avez créé. Un lien «supprimer» vous permet, à tout moment, de supprimer une règle de mapping. 10 : Le bouton «enregistrer le mapping» vous permet d enregistrer votre fichier de mapping XSLT. VII. Le journal d événements Le journal d événements est l interface graphique qui vous permet de visualiser les LOGS générés lors de l exécution du routeur. a. Ouvrir le journal d événements Pour ouvrir le journal d événements et visualiser les LOGS, cliquez sur «afficher le journal» ou allez dans le menu «Journal» et cliquez sur «afficher le journal d événements». La fenêtre des LOGS apparait :

20 Cahier de réalisation ENIGMA Page 20 b. Enregistrer le journal d événements Pour enregistrer le journal d événements, cliquez sur «enregistrer le journal» dans la fenêtre du routeur ou allez dans le menu «Journal» et cliquez sur «enregistrer le journal d événements». c. Supprimer le contenu du journal d événements Pour supprimer le contenu du journal d événements, dans le menu «Journal» cliquez sur «vider le journal d événements». La totalité des LOGS sera supprimée.