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.

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

###########
### 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}

{code}
<petals-se-kpi:hibernateURL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petals-se-kpi="http://petals.ow2.org/components
/petals-se-kpi/version-1.0-SNAPSHOT" xmlns:kpi-config="http://petals.ow2.org/components/petals-
se-kpi/specific" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-x">file:///home/user/Bureau/petals-view.properties
</petals-se-kpi:hibernateURL>
{code}

If you use MySQL or Oracle database, You need to copy mysql-connector-java-5.1.x.jar or oracle-jdbc-10g.jar in your petals-se-kpi component with the others dependencies.

<bean
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="location" value="file:////home/strino/Bureau/petals-view.properties"/>
</bean>
{code}

Save the changes.

If you use MySQL database or Oracle database, You need to copy mysql-connector-java-5.1.x.jar or oracle-jdbc-10g.jar in PetalsView/ WEB-INF/lib.

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.
A SA-KPI is composed of: a META-INF folder which will contain jbi.xml file and the su-kpi.zip.
example of a jbi.xml file from a sa-kpi.zip :

{code:lang=xml}
<jbi version="1.0" xmlns="http://java.sun.com/xml/ns/jbi">
<service-assembly>
<identification>
<name>sa-in</name>
<description>SA in.</description>
</identification>
<service-unit>
<identification>
<name>su-notif-in</name>
<description>su in description.</description>
</identification>
<target>
<artifacts-zip>su-notif-in.zip</artifacts-zip>
<component-name>petals-se-kpi</component-name>
</target>
</service-unit>
</service-assembly>
</jbi>
{code}

A SU-KPI is composed of: a META-INF folder containing SU's jbi.xml file and a special file, modelNotification.xls
example of jbi.xml file of a SU:
{code:lang=xml}
<?xml version="1.0" encoding="UTF-8"?>
<!--JBI descriptor for the PEtALS' "petals-se-kpi" component (WS-Notification).
Originally created for the version 1.0-SNAPSHOT of the component. -->

<jbi:jbi version="1.0" xmlns:notification="http://petals.ow2.org/petals-se-notification"
xmlns:wsn-br="http://docs.oasis-open.org/wsn/br-2"
xmlns:kpi="http://petals.ow2.org/petals-se-kpi"
xmlns:jbi="http://java.sun.com/xml/ns/jbi"
xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:st="http://www.ebmwebsourcing.com/wsnotification/specificTypes">

<!-- Import a Service into PEtALS or Expose a PEtALS Service => use a BC. -->
<jbi:services binding-component="false">

<!-- Expose a PEtALS Service => consumes a Service. -->
<jbi:consumes
interface-name="wsn-br:NotificationBroker"
service-name="notification:NotificationBrokerService"
endpoint-name="NotificationBrokerServiceEndpoint">

<!-- CDK specific fields -->
<petalsCDK:operation>Subscribe</petalsCDK:operation>
<petalsCDK:mep>InOut</petalsCDK:mep>
<!-- Component specific elements -->
<!-- Subscription to process on init : -->
<kpi:TopicExpressionDialect>http://docs.oasis-open.org/wsn/t1/TopicExpression/Full</kpi:TopicExpressionDialect>
<kpi:TopicExpressionNamespace>http://petals.ow2.org/topic</kpi:TopicExpressionNamespace>
<kpi:TopicExpressionPrefix>petals</kpi:TopicExpressionPrefix>
<kpi:TopicExpressionContent>petals:component/cdk/producer/in[@wstop:topic='true']</kpi:TopicExpressionContent>

<kpi:MessageContentXpath>boolean(/*[local-name()='publishBusinessEntity'])</kpi:MessageContentXpath>
<kpi:MessageContentXpathDialect>http://www.w3.org/TR/1999/REC-xpath-19991116</kpi:MessageContentXpathDialect>
<kpi:MessageContentSOADialect>http://www.ebmwebsourcing.com/wsnotification/soaparameter</kpi:MessageContentSOADialect>

<kpi:MessageContentSOAInterfaceNamespace>http://org.ow2.petals/demo/travelagency/agency/</kpi:MessageContentSOAInterfaceNamespace>
<kpi:MessageContentSOAInterfaceName>travelAgency</kpi:MessageContentSOAInterfaceName>
<kpi:MessageContentSOAServiceNamespace>http://org.ow2.petals/demo/travelagency/agency/</kpi:MessageContentSOAServiceNamespace>
<kpi:MessageContentSOAServiceName>travelAgencyService</kpi:MessageContentSOAServiceName>

<kpi:TransformPolicy>/modelNotification.xsl</kpi:TransformPolicy>

<kpi:ContextPolicyCorrelationId>true</kpi:ContextPolicyCorrelationId>
<kpi:ContextPolicyInterface>true</kpi:ContextPolicyInterface>
<kpi:ContextPolicyEndpoint>true</kpi:ContextPolicyEndpoint>
<kpi:ContextPolicyMeuuid>true</kpi:ContextPolicyMeuuid>
<kpi:ContextPolicyNotifDate>true</kpi:ContextPolicyNotifDate>
<kpi:ContextPolicyService>true</kpi:ContextPolicyService>
<kpi:ContextPolicyStatus>true</kpi:ContextPolicyStatus>

<kpi:ProcessPolicyAction>create</kpi:ProcessPolicyAction>
</jbi:consumes>
</jbi:services>

{code}
<xsl:stylesheet version='1.0' xmlns:xsl='http://www.w3.org/1999/XSL/Transform' >

<wsnebm:param><xsl:value-of select="//email/text()"/></wsnebm:param>
</wsnebm:params>
</wsnebm:NotifyContent>
</xsl:template>
</xsl:stylesheet>
{code}