{note}This user guide is for current 2.0.x branch version of the Petals Webconsole (2.0.6).
This documentation will have to evolve according to developments undertaken on the trunk.{note}
{section}
{column}
h1. What is the WebConsole ?
It's a web application that allow to:
* Manage Petals domain
* Test Petals services
* Monitor message exchanges
{column}
{column:width=350px}
{panel}{toc}{panel}
{column}
{section}
h1. Overview
!overview.png|thumbnail!
Petals Webconsole is divided into three parts as detailed below:
These three parts are:
* Connection Part
* Domain Part
* Server Part
!all-parts.png|thumbnail!
h3. Connection Part
This view part is the the little purple headband to the page top, its contains two buttons:
* Change server
* Manage connections
The *Change server* button allows to dynamically change the _current_ server connection. For example if you are
logged on _Server 0_ you can try to connect to another server like _Server 1._
The *Manage connections* button allows to _manipulate_ all declared connections for the Webconsole.
h3. Domain Part
This view part contains a menu which represent all _discovered servers_ from the recovered Petals topology,
when the Webconsole succeeded a connection to a server declared into the *webconsole.xml* configuration file.
Two element types are displayed:
| !Refresh-domain.png|thumbnail!\\ | A click performed on this type allow to _update_ the \\
current domain, where the WebConsole is \\
connected. |
| !Server.png|thumbnail!\\ | A click performed on this type allow to _update_ the \\
Server Part, with linked informations to the \\
selected server. \\ |
h3. Server Part
This view part allow to display several informations about the current selected server,
and performe several interactions on it. I this part of the view, three main tabs are
available:
* Administration
* Test
* Monitoring
!Three-parts-view.png|thumbnail!
The *Administration* tab allows to manage components, shared libraries and service assemblies, but also get several
informations about endpoints exposed from Petals ESB. Other secondary features are also available like modify
runtime component attributes and modify level of component loggers.
The *Test* tab allows to performe test, check availability of exposed services, analyse services responses.
In order to make available this tab, one _petals-se-rmi_ must be:
* _Installed_ and _started_ on at least one node of the current topology
* _Declared_ into the webconsole.xml configuration file
The *Monitoring* tab allows to define monitoring filters, manage them and display informations of each filter.
The main feature is still the message exchanges monitoring, with a detailed overview of each exchange
and several information charts.
This documentation will have to evolve according to developments undertaken on the trunk.{note}
{section}
{column}
h1. What is the WebConsole ?
It's a web application that allow to:
* Manage Petals domain
* Test Petals services
* Monitor message exchanges
{column}
{column:width=350px}
{panel}{toc}{panel}
{column}
{section}
h1. Overview
!overview.png|thumbnail!
Petals Webconsole is divided into three parts as detailed below:
These three parts are:
* Connection Part
* Domain Part
* Server Part
!all-parts.png|thumbnail!
h3. Connection Part
This view part is the the little purple headband to the page top, its contains two buttons:
* Change server
* Manage connections
The *Change server* button allows to dynamically change the _current_ server connection. For example if you are
logged on _Server 0_ you can try to connect to another server like _Server 1._
The *Manage connections* button allows to _manipulate_ all declared connections for the Webconsole.
h3. Domain Part
This view part contains a menu which represent all _discovered servers_ from the recovered Petals topology,
when the Webconsole succeeded a connection to a server declared into the *webconsole.xml* configuration file.
Two element types are displayed:
| !Refresh-domain.png|thumbnail!\\ | A click performed on this type allow to _update_ the \\
current domain, where the WebConsole is \\
connected. |
| !Server.png|thumbnail!\\ | A click performed on this type allow to _update_ the \\
Server Part, with linked informations to the \\
selected server. \\ |
h3. Server Part
This view part allow to display several informations about the current selected server,
and performe several interactions on it. I this part of the view, three main tabs are
available:
* Administration
* Test
* Monitoring
!Three-parts-view.png|thumbnail!
The *Administration* tab allows to manage components, shared libraries and service assemblies, but also get several
informations about endpoints exposed from Petals ESB. Other secondary features are also available like modify
runtime component attributes and modify level of component loggers.
The *Test* tab allows to performe test, check availability of exposed services, analyse services responses.
In order to make available this tab, one _petals-se-rmi_ must be:
* _Installed_ and _started_ on at least one node of the current topology
* _Declared_ into the webconsole.xml configuration file
The *Monitoring* tab allows to define monitoring filters, manage them and display informations of each filter.
The main feature is still the message exchanges monitoring, with a detailed overview of each exchange
and several information charts.