h1. Configuration et Intallation de Petals View

h1. Introduction

h2. Overview

Petals View is a webapplication dedicated to Petals ESB flows monitoring.

h3. Installation in a nutshell:

* download these components: petals-se-notification.zip & petals-se-kpi.zi;
* download petals view's war (petalsview.war);
* create all sa-kpi you need to get the infos you want (with prior installation and configuration of related components and services assemblies).

h3. How does it work?

* You configure a component so that when it is installed, it will register in petals-se-notification base: "I will send notifications to you".
* Upon reception, petals-se-notification forwards these notifications to petals-se-kpi (configured with its own services assemblies -- sa-kpi).
* What is a sa-kpi? It's a set of filters that will select specific information among the whole flow data. Whenever a notification fits with a sa-kpi, this notification (with selected data only) will be saved in a relational database. This database has to be shared between KPI Service Engine and Petals View.
* Petals View then connects to this database to retrieve informations.
* Messages are saved into the database in a "raw" format. Petals View will give them meaning by naming and organizing them in a human-readable way.

\\
This diagram presents monitoring-related relationships between Petals ESB, various components, SE-notification, SE-KPI, configured sa-kpi and Petals View.
!worddavdf7cef4d8fe2c89965f69ae681bc7de0.png|height=318,width=718!\\
This documentation details Petals View installation in 5 steps:
* First one is to set up the persistent environment, and configuration file for database access.
* Second one is to add to some configurations to make the persistent environment common between Petals View and SE-kpi component.
* Third one is to set up the notification environment, in other words configure the components so that they register in petals-se-notification.
* Fourth one is, through practical examples, to create the sa-kpi which will filter notification (select only the ones we really want to know about).
* Fifth one is to configure the referential in Petals View, to give meaning to the raw data stored in the database.

h2. First stage: setting up persistent environment

If you don't have any MySQL (or PostgreSQL) database server up and ready yet, download and install it following your system's procedure.
Create a database for Petals View:
example: petalview
Create a user with all rights granted to this database
example: user: view
pwd: view
Create the database access configuration file. The name of this file is mandatory:

### Petals View properties file
############
##Globals Informations
jdbc.hibernate.hbm2ddl.auto = update
jdbc.hibernate.show_sql = false
jdbc.initialSize = 0
jdbc.maxActive = 8
jdbc.maxIdle = 8
jdbc.minIdle = 0
jdbc.maxWait = -1

## MySQL Datasource
jdbc.driverClassName = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/petalsview
jdbc.username = view
jdbc.password = view
jdbc.hibernate.dialect = com.ebmwebsourcing.petalsview.persistence.util.MySqlInnoDBDialect

## PostGreSQL Datasource
#jdbc.driverClassName = org.postgresql.Driver
#jdbc.url = jdbc:postgresql://localhost:5432/petalsview
#jdbc.username = view
#jdbc.password = view
#jdbc.hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect
{code}

h2. Stage 2: Configuring Petals View

Download the KPI component (petals-se-kip.zip)
Browse to petals-se-kip.zip/META-INF
Open the jbi.xml file.
On the line <petals-se-kpi:hibernateURL>:

Configuring the components which will emit notifications: follow this procedure for each one of them:
Browse to yourcomponent.zip/META-INF/

Install all Services Assemblies you want to use with these components.

h2. Stage 4: Creating your SA-KPI.zip and corresponding SU-KPI.zip

You can use Petals Studio to create the SA-KPI needed for notification configuration. For this guide, we'll use an example of SA/SU batch to show you how to create them.

<kpi:ContextPolicyEndpoint>true</kpi:ContextPolicyEndpoint>
<kpi:ContextPolicyMeuuid>true</kpi:ContextPolicyMeuuid>
<kpi:ContextPolicyNotifDate>true</kpi:ContextPolicyNotifDate>

<wsnebm:params>
<wsnebm:param><xsl:value-of select="//age:lastname/text()"/></wsnebm:param>
<wsnebm:param><xsl:value-of select="//email/text()"/></wsnebm:param>
</wsnebm:params>
Here you define the paraIHere you define the parameters you want to rattach to your step. Notice that for now, the parameters rattached to an «&nbsp;out&nbsp;» state will not be taken in account.

h2. *Stage 5: Configuring the Referential in Petals View*

Deploy Petals View's war in an application server
Connect to Petals View through any web browser ([http://server/PetalsView|http://server/PetalsView]).
To connect for the first time, use the default admin user (login/password: admin/admin)
_PFor more details on configuring a referential in Petals View, check our PetalsView-UserGuide.pdf_
Click on "Referential Management" in left menu panel.

h3. If you already launch at least one flow in PetalsESB:

Click on the "Unknown" flow type:
its type is automatically filled in and cannot be changed
define its human-readable name.
Click on "CREATE"'
You'll arrive directly on the flow type's edition page. Normally, all steps composing this flow should appear together with their service/interface name. To configure each one and any of the unknown steps:
Click on an "unknown" step:
Functional (human-readable) name: give it the name of your choice
Interface name / Service name: these are automatically filled in with the right info
Start flow? and End flow? checkboxes are used to define whether this step is first and/or last one of the flow.
Success message: the message which will be displayed when step is in "Success" status.
Error message: the message which will be displayed when your step is in "Error" status.
Click on "Submit" to save changes and come back on flow type's edition screen. You can notice that now, the step you defined is not shown on "Unknown tables" anymore, but instead in the referential table.
Click on any defined step to access its edition screen. Under the general informations, you can see a sentence telling if you have associated parameters in your database.
Example: Number of unknown parameters: 1 (you have one associated parameter)
In functional fields click on "ADD" and fill in the following informations:
Index: relates to its rank in notification, will be automatically incremented.
Name: give it the human-readable name of your choice
Global: if you check it, this parameter will not only be visible in step view, but also in global view of any flow of this flow type.
Click on "Submit" to save changes and come back on step's edition screen. Notice that the number of unknown parameters have decreased by one (in our example, it's now 0).
Repeat the procedure to configure any and all steps and parameters.

h3. If you didn't launch any flow in Petals ESB yet:

Click on ''ADD'' button
Give Donnez une valeur numérique au type (cette valeur correspond au ProcessType que vous définirez dans votre modèle de notification) et un nom
exemple : type : 1
nom : Flux test
Click on "CREATE" to save it and go to edition screen of the flow type's referential you just created. Here you can add steps.
Click on "Add" to add and configure steps to your referential (fields in yellow are mandatory)
Functional name: give it the name of your choice
example: Travel agency
Interface name: fill in the qualified name of your interface
example: \{\[http://org.ow2.petals/demo/travelagency/agency/\]} travelAgency
Service name: fill in the qualified name of your Service
example: \{\[http://org.ow2.petals/demo/travelagency/agency\]} travelAgencyService
Start flow? and End flow? checkboxes are used to define whether this step is first and/or last one of the flow.
Success message: the message which will be displayed when step is in "Success" status.
Error message: the message which will be displayed when your step is in "Error" status.
Click on "Submit" to save and go to the edition screen of the step you just created. You can then configure parameters.
Click on "Add" to add parameters to your step.
IIndex: relates to its rank in notification, will be automatically incremented.
Name: give it the human-readable name of your choice
Global: if checked, this parameter will be visible in step view AND in global view of any flow of this flow type.
Click on "Submit" to save the changes.
Repeat the procedure to configure all steps and parameters you want to be shown in Petals View.