Petals View Tutorial Sommaire

Transcription

1 Petals View Tutorial Sommaire Introduction...2 Présentation Générale...2 Notre tutoriel...2 1) Technologies nécessaires :...3 2) PetalsView Tutorial...3 3) Mise en place de l'environnement de persistence ) Base de données MySQL ) Fichier petals view.properties ) Configuration du Composant SE KPI ) Configuration de Petals View...4 4) Création de votre SA KPI : sa KPI tutorial.zip ) Importer les sa du répertoire PetalsView SA dans Petals Studio ) Création de vos su kpi ) jbi.xml ) Configuration des feuilles de style (.xsl)...7 5) Mise en place de l'environnement de notification ) PetalsESB ) Configuration des composants ) Installation des composants dans Petals ESB ) Petals View ) Installation de Petals View dans un serveur d'application Tomcat ) Connection à Petals View ) Consultation des flux non référencés )Configuration du Référentiel dans Petals View ) Création du nouveau référentiel de flux ) Création de la première étape ) Création de la seconde étape ) Création de la troisième étape...16

2 Introduction Présentation Générale Petals View est une application web de supervision fonctionnelle de flux transitant dans le bus PetalsESB. Pour que cette supervision soit possible, il vous faut télécharger les composants petals se notification.zip et petals se kpi.zip ainsi que le war de l'application petalsview.war et crééer les sa kpi correspondant à vos besoins (ainsi que tous les composants et sa nécessaires à votre cas d'utilisation). Le mécanisme permettant de créer des notifications : un composant s'enregistre auprès du petals se notification, pour lui signifier qu'il doit faire l'objet de notification. petals se notification envoie toutes les notifications concernant ce composant au petals se kpi qui possède ses propres sa kpi. Les sa kpi sont des filtres de ces notifications, Si une notification correspond au filtre, elle est enregistrée dans une base de données. (Cette base de données doit être commune au se kpi et à Petals View) Petals View se connecte à cette même base de données et lit les informations enregistrées. Les messages enregistrés sont à l'état brut. Petals View permet de donner du sens à ces messages en les organisant et en le nommant de façon explicite. Le schéma suivant représente comment s'organise les relations entre Petals ESB, les composants, le se notification, le se kpi, les sa kpi et Petals View. Notre tutoriel View. Dans ce tutoriel nous verrons comment mettre en place les notifications dans Petals ESB et lire les flux dans Petals Le scénario choisi est : trouver la liste des défenseurs d'une équipe de foot d'un pays lors de l'euro2008. Dans le schéma suivant, nous montrons comment nous allons procéder pour mettre en oeuvre notre scénario et les points sur lesquels nous allons notifier et afficher des informations dans Petals View.

3 1) Technologies nécessaires : Base de données : MySQL 5.x ( Serveur d'application : Apache Tomcat 6.x ( 60.cgi) Petals Studio ( studio/ version 1.0) petals platform 3.0.x.zip ( petals esb.html version 3.0.5) petals bc filetransfer 2.4.x.zip ( jbi components.html version 2.4.2) petals bc soap 4.0.x.zip ( jbi components.html version 4.0.2) petals se eip 2.4.x.zip ( jbi components.html version 2.4.3) petals se kpi 1.0.x.zip ( jbi components.html version SNAPSHOT) petals se notification 1.0.x.zip ( jbi components.html version 1.0.2) PetalsView Tutorial.zip ( view/) 2) PetalsView Tutorial Deziper PetalsView Tutorial Il est composé de différents sous dossiers : PetalsView docs : contient les documentations utilisateurs, un script de création des tables, le fichier petals view.properties, le fichier foot.xml, le fichier content xml. PetalsView SA : ici vous trouverez les SA necessaires à notre scénario. PetalsView SA KPI : un fichier petals sa kpi tutorial.zip qui contient toutes les su déjà configurées. PetalsView webapp : le fichier PetalsView.war à installer dans un serveur d'application Tomcat 3) Mise en place de l'environnement de persistence 3.1) Base de données MySQL Si vous ne possédez pas de serveur de base de données MySQL téléchargez le et Créer votre base de données pour Petals View : exemple : petalview Créer un utilisateur avec les droits nécessaires sur cette base de données exemple : user : view pwd : view installez le. 3.2) Fichier petals view.properties Ouvrez le fichier (qui se trouve dans PetalsView docs) et modifiez les informations si nécessaire pour qu'elles correspondent à votre nom de base de données, votre utilisateur et son mot de passe ainsi que l'adresse du serveur MySQL Enregistrez les modifications.

4 3.3) Configuration du Composant SE KPI Aller dans petals se kpi.zip/meta_inf Ouvrir le fichier jbi.xml A la ligne <petals se kpi:hibernateurl> : mettre l'adresse où se trouve le fichier petals view.properties exemple : file:///home/user/bureau/ petals view.properties Enregistrer les modifications 3.4) Configuration de Petals View Aller dans PetalsView webapp/ PetalsView.war/WEB INF/spring Ouvrez le fichier petals view annotation.xml A la ligne <property > dans les guillemets de value mettre l'adresse où se trouve le fichier petals view.properties exemple : file:///home/user/bureau/ petals view.properties 4) Création de votre SA KPI : sa KPI tutorial.zip Ici nous allons tout d'abord importer les sa fournies dans le répertoire PetalsView SA dans Petals Studion, car ainsi nous aurons accès facilement aux informations dont nous avons besoins pour construire nos su kpi. 4.1) Importer les sa du répertoire PetalsView SA dans Petals Studio Lancez votre Petals Studio et choississez votre workspace. Dans la fenêtre en haut à gauche, faîtes un click droit sur ''Service Assembly Projects'' Cliquez ensuite sur import/service Assembly Parcourez vos dossiers pour atteindre PetalsView SA et choississez sa EIP FootballPoolWebService provide.zip et cliquez sur ''valider''.

5 Réitérez la même opération pour toutes les sa du dossier PetalsView SA. 4.2) Création de vos su kpi Dans cette étape nous allons définir toutes les su nécessaires à notre scénario. Faites un click droit sur ''Service Assembly Projects'' Cliquez ensuite sur New/KPI Configuration Watched Service(s) : ici, nous allons choisir les endpoints sur lesquels vont porter les notifications, dans notre exemple sélectionnez les trois endpoints proposés, puis cliquez sur next.

6 Watcher Configuration : ici nous allons déterminer si nos su seront en In Out Status ou Fault. Le FileTransfert est en InOnly nous allons donc cocher Status/In/Fault L'EIP est en InOnly nous allons donc cocher Status/In/Fault Le BC SOAP est en InOut nous allons donc cocher In/Out/Fault cliquez sur next/suivant Deployment Configuration : nous allons donner un nom à notre sa kpi : par exemple sa KPI tutorial cliquez sur finish/fin 4.3) jbi.xml Chaque su a son propre fichier jbi.xml. Nous allons regarder de quoi est composé ce fichier pour qu'il soit spécifique au KPI. Nous allons regarder le fichier jbi.xml de la su KPI FootballEIPService consume In.

7 Ici, les informations importantes se situent au niveau des balises : <kpi:topicexpressioncontent>petals:component/cdk/producer/in[@wstop:topic='true']</kpi:topicexpressioncontent> La valeur en rouge définie sur quel type nous nous situons, ici sur du In. Dans cette balise, seule cette information varie. <kpi:messagecontentsoainterfacenamespace> <kpi:messagecontentsoainterfacename>footballpooleip</kpi:messagecontentsoainterfacename> <kpi:messagecontentsoaservicenamespace> <kpi:messagecontentsoaservicename>footballpooleipservice</kpi:messagecontentsoaservicename> <kpi:messagecontentsoaendpoint>footballpoolwebserviceeip</kpi:messagecontentsoaendpoint> Ici, les valeurs des balises définissent les informations des services sur lesquels on souhaite notifier et filtrer les notifications. <kpi:transformpolicy>su KPI FootballPoolEIPService consume In.xsl</kpi:TransformPolicy> La valeur de cette balise est le nom de la feuille de style rattachée à cette su. 4.4) Configuration des feuilles de style (.xsl) A l'heure actuelle, la récupération d'informations dans le message ne peut se faire que sur les su In. Dans notre exemple, nous allons avoir besoin d'informations porter par la su KPI FootballPoolEIPService consume In et par la su KPI copyresponse consume In. La feuille de style su KPI FootballPoolEIPService consume In.xsl : Les informations importantes sont ici le processtype sa valeur doit être la même pour toutes les feuilles de style d'un même processus. C'est cette valeur qui va permettre de mettre en lien les flux enregistrés dans la base et le référentiel s'y rapportant. Cette valeur ne peut être la même pour deux processus différents. Entre les balises <wsnebm:params> </wsnebm:params> nous allons définir le paramètre que nous voulons récupérer pour l'afficher ensuite dans Petals View. Décommentez les balises <wsnebm:param> </wsnebm:paras> La valeur est : <xsl:value of select="//*[local name()='scountryname']/text()"/>

8 La feuille de style su KPI copyresponse consume In.xsl : Ici nous allons ajouter notre paramètre, comme précédemment : vous devez définir dans la première balise ''m'' ajouter : xmlns:m=' vous dévez décommenter les balises <wsnebm:param> </wsnebm:paras> mettre la valeur : <xsl:value of select="//*/m:alldefendersresult/*/text()"/> Vos su kpi sont prètes. Il ne reste plus maintenant qu'à les exporter pour qu'on puisse les installer dans Petals ESB. Click droit sur vos su kpi/petals/fast Export for Petals Faites la même opérations pour chaque su kpi. Vous avez, maintenant, les neufs archives à installer dans Petals ESB. 5) Mise en place de l'environnement de notification Vous devez créer dans votre répertoire tmp les deux dossiers nécessaires à notre exemple : foot et footresponse. La création de ces dossiers doit se faire avant le lancement de PetalsESB. 5.1) PetalsESB Ouvrez un terminal et situez vous dans le répertoire petals platform 3.0.5/bin tapez la commande :./startup.sh C (pour un lancement en mode console)

9 5.2) Configuration des composants Ici, vous devrez faire la même procédure pour les trois composants à notifier (BC SAOP, FileTransfert et EIP). Nous vous montrerons l'exemple pour le composant petals bc filetransfer zip. Aller dans petals bc filetransfer zip/META_INF Ouvrir le fichier jbi.xml A la ligne <petalscdk:notifications> : mettre la valeur à true. Enregistrez les modifications. Faire la même manipulation, pour les deux autres composants. 5.3) Installation des composants dans Petals ESB Installer le composant petals se notification zip Attention : il faut installer le SE Notification avant tout autre composant. Il vous est donc conseillé d'utiliser un Petals ESB vierge. Installer les autres composants configurés : petals bc filetransfer zip, petals bc soap zip, petals se eip zip et petals se kpi SNAPSHOT.zip Installer toutes les SA du répertoire PetalsView SA Installer toutes les sa KPI x.zip (9 au total) que vous avez créé dans Petals Studio Vous pouvez vérifier que tout fonctionne correctement, en enregistrant le fichier foot.xml dans le répertoire tmp/foot. 6) Petals View 6.1) Installation de Petals View dans un serveur d'application Tomcat Mettre PetalsView.war (qui se trouve dans le dossier PetalsView webapp) que vous avez configuré au chapitre 3.4 dans votre serveur Tomcat. Vous pouvez lancer votre serveur Tomcat, Petals View est prêt. Connectez vous y avec votre navigateur (exemple : 6.2) Connection à Petals View Petals View intégre directement au démarrage des utilisateurs par défaut de l'application, avec des mots de passe associés. Ici, nous allons nous connecter avec l'utilisateur admin (mot de passe admin) qui possède tous les droits sur l'application.

10 6.3) Consultation des flux non référencés Après avoir mis une première fois le fichier foot.xml dans le répertoire foot, vous pouvez vérifier dans Petals View que tout a bien fonctionné. Il suffit de cliquer dans ''Vue Globale'', puis sur le bouton ''Voir tous les flux'' et le flux devrait apparaître avec comme type ''Unknown''. Si vous cliquez sur 1, vous pourrez constater que les trois étapes sont bien en status : ''Succés''

11 6.4)Configuration du Référentiel dans Petals View Pour configurer le référentiel, cliquez sur ''Gestion du Référentiel'' dans le menu de gauche ) Création du nouveau référentiel de flux Comme un premier flux a été lancé, l'application l'a dédecté et le met en inconnu. Il suffit de cliquez sur ''Inconnu'' pour créer le nouveau référentiel avec les informations contenus dans notre flux. Ici, Type correspond au ProcessType des feuilles de style des su kpi. La valeur n'est pas éditable car nous créons le référentiel à partir d'un flux inconnu. Le nom est celui que vous voulez donnez à votre flux.dans notre exemple, ce sera : FluxTest Cliquez sur CREER.

12 Vous arrivez sur l'écran suivant : 6.3.2) Création de la première étape Pour créer la première étape, il vous suffit de cliquer sur le troisième lien (FootballPo.../FootballPo...) du tableau ''Liste des étapes inconnues''. Ici les champs ''Nom Interface'' et ''Nom Service'' sont pré remplis par les informations du l'étape du flux Inconnus. Vous devez seulement renseigner les champs en jaunes qui sont obligatoires. Dans notre exemple : Le nom fonctionnel est le nom que l'on choisit de donner à une étape. C'est à vous de le définir. Ici nous avons choisi : State Name Début flux?/ Fin flux? : servent à savoir si une étape est définie comme le début du flux ou la fin. Une même étape peut être à la fois l'étape de départ et l'étape de fin.dans notre exemple, nous savons que l'étape portant sur l'eip est la première donc, il faut cocher seulement Début flux?. Message de succès : est l'information qui s'affichera quand l'étape sera notée en succés, c'est à vous de le définir. Dans notre exemple, nous allons mettre OK. Message d'erreur : est l'information qui s'affichera quand l'étape sera notée en échec, c'est à vous de le définir, mais ce champ n'est pas obligatoire. Dans notre exemple, nous allons mettre KO.

13 Cliquez sur SOUMETTRE. Vous arrivez sur l'écran suivant : L'étape que vous venez de définir n'apparaît plus dans le tableau ''Liste des étapes inconnues'' Cliquez sur le nom fonctionnel de votre nouvelle étape pour pouvoir ajouter un paramètre et accéder à la page de visualisation de l'étape.

14 Vous pouvez savoir ici, si des paramètres inconnus sont associés à votre étape, selon la valeur du champ : ''Nombre de paramètres inconnus'' Pour créer un paramètre, dans le tableau Champs fonctionnels cliquez sur le bouton AJOUTER La valeur de l'index se crée automatiquement. Déterminez le nom que vous voulez attribuer à votre paramètre, dans notre exemple nous avons choisi State. Le paramètre Global signifie que ce paramètre pourra être visible dans le tableau de vue de tous les flux d'un type, dans le détail d'un flux et dans le détail d'une étape. Cochez ce paramètre. Cliquez sur SOUMETTRE Votre première étape est maintenant définie. Vous pouvez aller vérifier que la nouvelle étape est bien prise en compte en cliquant dans le menu de gauche Supervision des flux / Flux FluxTest Vous devriez avoir l'écran suivant :

15 Vous remarquerez que par rapport à la date du jour le flux apparaît et que la date de début est spécifiée. Le statut du flux est toujours en cours car nous n'avons pas encore défini d'étape de fin. Le paramètre du nom du pays apparaît dans le tableau ) Création de la seconde étape Ici, nous allons définir l'étape portant sur le BC SOAP : Vous devez vous situez dans Gestion du référentiel / FluxTest et cliquez sur le premier lien (FootballPo.../FootballPo...) du tableau ''Liste des étapes inconnues''. Les ''Nom interface'' et ''Nom service'' sont pré remplis. Vous devez renseigner les champs : Nom fonctionnel : Etape 2 : Search Ici l'étape n'est ni une étape de début, ni une étape de fin. Message de succès : OK Message d'erreur : KO Cliquez sur SOUMETTRE. La seconde étape est maintenant définie, cliquez sur son nom fonctionnel dans le tableau des ''Etapes''. Vous arrivez sur l'écran suivant. La valeur du champ ''Nombre de pramètres inconnus'' est à 0. Nous n'avons pas définis de paramètre pour cette étape.

16 6.3.4) Création de la troisième étape Nous allons définir la troisième et dernière étape de notre flux, cette dernière porte sur le FileTransfert. Vous devez vous situer dans Gestion du référentiel / Flux FluxTest et cliquez sur le dernier lien du tableau ''Liste des étapes inconnues''. Les champs ''Nom interface'' et ''Nom service'' sont pré remplis. Vous devez renseigner les champs : Nom fonctionnel : Defender Name Cochez Fin de Flux? Message de succès : OK Message d'erreur : KO Cliquez sur SOUMETTRE. Dans cette étape, nous avons configuré dans notre feuille de style de la su kpi la récupération d'un paramètre. Nous allons donc créer ce nouveau paramètre, cliquez sur le nom fonctionnel de l'étape trois, cliquez sur AJOUTER dans le tableau Champs fonctionnels. L'index est auto incrémenté. Nom : Defender Cochez Global Cliquez sur SOUMETTRE. Votre troisième étape est maintenant configurée. Dans Supervision des flux / Flux FluxTest, vous pourrez voir l'écran suivant :

17 Vous pouvez remarquer que le flux est maintenant en succés et que les deux paramètres définis apparaissent dans le tableau général. La date de fin est elle aussi renseignée. Si vous cliquez sur le chiffre 1 vous pourrez accéder au détail du flux et voir l'écran suivant : Vous êtes maintenant prêt à utiliser Petals View pour vos besoins.