{section}
{color:#333333} {color}{column}
h1. {color:#000000}{*}Introduction:*{color}
{color:#333333}In this document I quote the Petals Webconsole use cases and present these in different scenarios.{color}
{color:#333333}All scenarios can be taken into account as tutorials by describing correct interactions which must be{color}
{color:#333333}performed between user and the Webconsole.{color}
h1. {color:#000000}{*}Administration use cases:*{color}
{gliffy:name=Administration_Use_Cases\|align=left\|size=L\|version=1}
{color:#333333}* *{color}
{color:#333333}I propose to you a simple scenario where you'll learn to install the petals-se-pojo and{color}
{color:#333333}one service assembly associated to this component, next install one shared library and{color}
{color:#333333}to finish how to uninstall these previous artifacts in order to return to a clean Petals ESB{color}
{color:#333333}node.{color}
{color:#333333}{+}In first{+}{color} {color:#333333}part I present to you a small tutorial/scenario about{color} {color:#333333}{*}component management{*}{color} {color:#333333}which present{color}
{color:#333333}the differents use cases about component installation, component start action, how to edit{color}
{color:#333333}runtime component attributes, ect ...{color}
{color:#333333}After the first part the scenario will tend towards{color} {color:#333333}{*}service assembly management{*}{color}{color:#333333}, and to finish{color}
{color:#333333}one part of{color} {color:#333333}{*}shared library management{*}{color}{color:#333333}.{color}
{color:#333333}For the following scenario the petals-se-pojo will be used, the first use case is "{color}{color:#333333}{_}install component{_}{color}{color:#333333}"{color}
h3.
h2. {color:#333333}Install component steps:{color}
{color:#333333}To access to the component installation functionality you need select the server where you want to install{color}
{color:#333333}the component (here{color} {color:#333333}{_}server 2{_}{color}{color:#333333}), go to{color} {color:#333333}{_}administration{_}{color} {color:#333333}tab, next{color} {color:#333333}{_}components{_}{color} {color:#333333}tab and to finish click on{color} {color:#333333}{_}install..._{color} {color:#333333}button{color}
!install-component-scenario.png|thumbnail!
The Webconsole display to you the component installation page, in this page (for our scenario) you need to select _local_
for the installation type (because we assume that the component to install is located locally on our computer) and click on _Parcourir..._ button
in order to search the component in your computer directories.
!install-component-scenario2.png|thumbnail!
Select the _petals-se-pojo_ component zip archive.
!install-component-scenario3.png|thumbnail!
After returning to the component installation page click on _install_ button.
!install-component-scenario4.png|thumbnail!
The Webconsole load the component installer on the Petals ESB node in order to
return the +installation attributes+ which can be configured during the component
installation.
!install-component-scenario5.png|thumbnail!
The previous displaying installation attributes are +specific to petals-se-poj{+}{+}o+ component, other
component may have different attributes. You can change attributes values, after that you
need to click on _submit_ button in order to terminate component process installation.
Now you see the final result of installation component step, the petals-se-pojo component is
installed but shutdown. In the next step we will see how to start it.
!install-component-scenario6.png|thumbnail!
h2. {color:#333333}{*}Start component steps:*{color}
{color:#333333}In this part we see how to start the previous installed petals-se-pojo component, don't worry it's very simple \!{color}
{color:#333333}To start a component it{color} {color:#333333}{+}must be in shutdown or stopped state{+}{color} {color:#333333}otherwise its state is incorrect to the action you want{color}
{color:#333333}to perform.{color}
{color:#333333}To start a one component you only need to click on the link{color} {color:#333333}{_}start button{_}{color} {color:#333333}on the component row{color}
!start-component-scenario1.png|thumbnail!
{color:#333333}As the result you can see the following state changement on the petals-se-pojo row (in component table){color}
!start-component-scenario2.png|thumbnail!
Now for our scenario we will install one service assembly for the pojo component
h2. {color:#333333}{*}Install service assembly steps:*{color}
{color:#333333}For now and in order to follow our scenario we will install one service assembly on the previous installed{color}
{color:#333333}{_}petals-se-pojo{_}{color} {color:#333333}component. For that you need to go in the service assembly tab (of administration Webconsole{color}
{color:#333333}part), this tab allows you to perform several{color} {color:#333333}{+}management action on service assemblies{+}{color}{color:#333333}, it's here where we{color}
{color:#333333}find the{color} {color:#333333}{+}installation functionality{+}{color}{color:#333333}.{color}
{info:title=Linked state between component and service assembly}{color:#333333}Quick reminder:{color}
{color:#333333}In order to install one service assembly, the dedicate component must have started or stopped state.{color}
{color:#333333}If you need to shutdown a component all these sevice assemblies must be in shutdown state.{color}
{color:#333333}And to uninstall one component all associated service assemblies must be uninstalled in first.{color}
{info}
!install-sa-scenario1.png|thumbnail!
{color:#333333}Next the Webconsole display to you the installation service assembly page. In this page you need to select{color}
{color:#333333}{_}local{_}{color} {color:#333333}type installation, because in our scenario the pojo service assembly is located on our computer.{color}
{color:#333333}After that you need to click on{color} {color:#333333}{_}Parcourir..._{color} {color:#333333}button in order to select the service assembly in your computer{color}
{color:#333333}directories.{color}
!install-sa-scenario2.png|thumbnail!
Your web navigator provide to you an interface for search the +pojo service assembly archive+
!install-sa-scenario3.png|thumbnail!
When the archive is selected you only need to click on _install_ button to perform the pojo
service assembly installation
!install-sa-scenario4.png|thumbnail!
After the Webconsole provide the pojo service assembly to the selected Petals ESB node,
the node try to install this service assembly. If the installation is correctly performed the following
message will be displayed
!install-sa-scenario5.png|thumbnail!
This screen informs you that all service units of the service assembly was correctly installed, but why ?
Because if your service assembly contains several service units, certain +may misfired+ during the installation
process. If one or several service units *wasn't correctly installed* the Petals Webconsole will warn you. In
both cases you need to click on _continue_ button to return to the service assemblies management table.
After returning to service assemblies management table, you can see the previous installed pojo service
assembly but, on its dedicated row its state is *shutdown*.
!install-sa-scenario6.png|thumbnail!
The next step in our scenario will start this previous service assembly.
h2. {color:#333333}{*}Start service assembly steps:*{color}
{color:#333333}In this step we will see how to{color} {color:#333333}{+}start{+}{color} {color:#333333}the previous installed pojo service assembly (currently in{color} {color:#333333}{*}shutdown{*}{color} {color:#333333}state){color}
{color:#333333}don't worry about that it's very simple to do, because you just need one click on the right button{color} :-)
To start an installed service assembly you just need to click on the associated _start_ button displayed on its row
!install-sa-scenario7.png|thumbnail!
If the start process is correctly performed the service assembly management table is normally redisplayed, but with
the changed state for pojo component to +started+, otherwise it's an *error occurred* during the starting process ...
!install-sa-scenario8.png|thumbnail!
Now that we have seen how to install a component and its linked service assembly, it only remains for us in the
administration tab, to see how to install a shared library.
h2. {color:#333333}{*}Install shared library steps:*{color}
{color:#333333}In this part we'll just see how to install one shared library.{color}
{color:#333333}In order to perform one shared library installation "Rendez-vous" in{color} {color:#333333}{_}Administration{_}{color} {color:#333333}tab and in the sub tab named{color}
{color:#333333}{_}Shared Libraries{_}{color}{color:#333333}. For install a shared library form the shared libraries management tab you just need to click on{color}
{color:#333333}{_}install..._{color} {color:#333333}button, and the Petals Webconsole will return you to the shared library installation page.{color}
!install-sl-scenario1.png|thumbnail!
After that the Webconsole displays to you the shared library installation page. In this page for our scenario
you need to select _local_ for installation type choice, because in our scenario we take in account the shared
library which will be installed +is located in your local computer+. Then you need to click on _Parcourir..._ button
in order to select the desired shared library.
!install-sl-scenario2.png|thumbnail!
Normally after you click on _Parcourir..._ button your web navigator open to you a new window that allows you
to select one shared library in your director hierarchy (+the shared library must be an .zip archive+).
!install-sl-scenario3.png|thumbnail!
When you have validated the shared library selection, you only need to click on _install_ button in order to
perform the shared library installation on the current container.
!install-sl-scenario4.png|thumbnail!
If the Petals container +correctly install+ the shared library you will normally see the installed library in the
shared library management list.
!install-sl-scenario5.png|thumbnail!
Oops, our scenario is unfortunately already finished ... but you learnt several thing, how to install/start component,
install/start service assembly, install one shared library ...
But wait you still need to clean your container :-)
Then we will see how to clean your Petals ESB node in the next part.
h2. {color:#333333}{*}Uninstall shared library steps:*{color}
How you uninstall one shared library ? Nothing complicated, you only need to click on the _uninstall_ button
on +current row+ of the desired shared library which you want to uninstall.
!install-sl-scenario6.png|thumbnail!
Following this action the current container try to uninstall the shared library and if the result is +conclusive+
the shared library management list should no longer see the previous shared library.
!uninstall-sl-scenario1.png|thumbnail!
In the next part we will see how to uninstall the previous installed service assembly.
h2. {color:#333333}{*}Uninstall service assembly steps:*{color}
During this current section, you will learn how to uninstall a service assembly process.
Before uninstall a service assembly you need to take in account its +current state+, but why ?
Because to respect the service assembly life cycle ...
For correclty uninstall a service assembly its must be in +shutdown state+ before performing
uninstallation process, and for performing a shutdown action this service assembly must be
in +stopped state+ ...
Therefore we need to perform a stop action on our service assembly before, because it's
in +started state+.
To realize this stop action you simply need to click on the _stop_ button assigned to this action on
the service assembly current row.
!uninstall-sa-scenario1.png|thumbnail!
Just after the current container perform this stop action, you should normally see the pojo service
assembly with its state switch to +stopped+. Now you need to +shutdown+ it before completing the
uninstallation process, for that just click on the _shutdown_ button of the service assembly current
row.
!uninstall-sa-scenario2.png|thumbnail!
If the shutdown process is successfully performed, you should see the pojo service assembly in
+shutdown+ state. Great, it only remains for you to uninstall the pojo service assembly by clicking
on the +uninstall+ button of the current row.
!uninstall-sa-scenario3.png|thumbnail!
Finally the service assembly uninstallation process is terminated and you +shouldn't normally see+
+that the pojo service assembly+ in the service assembly management list.
!uninstall-sa-scenario4.png|thumbnail!
Our scenario is nearly done, it only remains to uninstall the pojo component in order to
correctly clean our container, it's what we see in the next part.
h2. {color:#333333}{*}Uninstall component steps:*{color}
We will see now how to uninstall one component and its linked process. As well as
one service assembly, a component follows its _lifecycle_ in our container (for this part
you can also see the JBI specification).
{gliffy:name=Component_lifecycle_state_diagram\|align=left\|size=L\|version=1}Therefore we begin by stop the pojo component by clicking on the _stop_ button
of the pojo component row.
!uninstall-sa-scenario1.png|thumbnail!
After the container stop your component, its current state should be changed to
+stopped+. In order to follow the component lifecycle you need now to +shutdown+ the
component and for that you only need to click on the _shutdown_ button.
!uninstall-sa-scenario2.png|thumbnail!
When your component is +shutdown+ it's only remains to performs the uninstallation action.
For this last action you need to click on _uninstall_ button of your pojo component row.
!uninstall-sa-scenario3.png|thumbnail!
If all goes well, +you shouldn't normally see+ the pojo component in the component management
list.
!uninstall-sa-scenario4.png|thumbnail!
Slim, our use case is already over but during this tutorial you learned several functionalities of the administration tab
of Petals Webconsole. Many advanced functionalities like runtime component attribute configuration, logger level
configuration, server properties configuration ... are present but not shown here.
{color:#333333} {color}{column}
h1. {color:#000000}{*}Introduction:*{color}
{color:#333333}In this document I quote the Petals Webconsole use cases and present these in different scenarios.{color}
{color:#333333}All scenarios can be taken into account as tutorials by describing correct interactions which must be{color}
{color:#333333}performed between user and the Webconsole.{color}
h1. {color:#000000}{*}Administration use cases:*{color}
{gliffy:name=Administration_Use_Cases\|align=left\|size=L\|version=1}
{color:#333333}* *{color}
{color:#333333}I propose to you a simple scenario where you'll learn to install the petals-se-pojo and{color}
{color:#333333}one service assembly associated to this component, next install one shared library and{color}
{color:#333333}to finish how to uninstall these previous artifacts in order to return to a clean Petals ESB{color}
{color:#333333}node.{color}
{color:#333333}{+}In first{+}{color} {color:#333333}part I present to you a small tutorial/scenario about{color} {color:#333333}{*}component management{*}{color} {color:#333333}which present{color}
{color:#333333}the differents use cases about component installation, component start action, how to edit{color}
{color:#333333}runtime component attributes, ect ...{color}
{color:#333333}After the first part the scenario will tend towards{color} {color:#333333}{*}service assembly management{*}{color}{color:#333333}, and to finish{color}
{color:#333333}one part of{color} {color:#333333}{*}shared library management{*}{color}{color:#333333}.{color}
{color:#333333}For the following scenario the petals-se-pojo will be used, the first use case is "{color}{color:#333333}{_}install component{_}{color}{color:#333333}"{color}
h3.
h2. {color:#333333}Install component steps:{color}
{color:#333333}To access to the component installation functionality you need select the server where you want to install{color}
{color:#333333}the component (here{color} {color:#333333}{_}server 2{_}{color}{color:#333333}), go to{color} {color:#333333}{_}administration{_}{color} {color:#333333}tab, next{color} {color:#333333}{_}components{_}{color} {color:#333333}tab and to finish click on{color} {color:#333333}{_}install..._{color} {color:#333333}button{color}
!install-component-scenario.png|thumbnail!
The Webconsole display to you the component installation page, in this page (for our scenario) you need to select _local_
for the installation type (because we assume that the component to install is located locally on our computer) and click on _Parcourir..._ button
in order to search the component in your computer directories.
!install-component-scenario2.png|thumbnail!
Select the _petals-se-pojo_ component zip archive.
!install-component-scenario3.png|thumbnail!
After returning to the component installation page click on _install_ button.
!install-component-scenario4.png|thumbnail!
The Webconsole load the component installer on the Petals ESB node in order to
return the +installation attributes+ which can be configured during the component
installation.
!install-component-scenario5.png|thumbnail!
The previous displaying installation attributes are +specific to petals-se-poj{+}{+}o+ component, other
component may have different attributes. You can change attributes values, after that you
need to click on _submit_ button in order to terminate component process installation.
Now you see the final result of installation component step, the petals-se-pojo component is
installed but shutdown. In the next step we will see how to start it.
!install-component-scenario6.png|thumbnail!
h2. {color:#333333}{*}Start component steps:*{color}
{color:#333333}In this part we see how to start the previous installed petals-se-pojo component, don't worry it's very simple \!{color}
{color:#333333}To start a component it{color} {color:#333333}{+}must be in shutdown or stopped state{+}{color} {color:#333333}otherwise its state is incorrect to the action you want{color}
{color:#333333}to perform.{color}
{color:#333333}To start a one component you only need to click on the link{color} {color:#333333}{_}start button{_}{color} {color:#333333}on the component row{color}
!start-component-scenario1.png|thumbnail!
{color:#333333}As the result you can see the following state changement on the petals-se-pojo row (in component table){color}
!start-component-scenario2.png|thumbnail!
Now for our scenario we will install one service assembly for the pojo component
h2. {color:#333333}{*}Install service assembly steps:*{color}
{color:#333333}For now and in order to follow our scenario we will install one service assembly on the previous installed{color}
{color:#333333}{_}petals-se-pojo{_}{color} {color:#333333}component. For that you need to go in the service assembly tab (of administration Webconsole{color}
{color:#333333}part), this tab allows you to perform several{color} {color:#333333}{+}management action on service assemblies{+}{color}{color:#333333}, it's here where we{color}
{color:#333333}find the{color} {color:#333333}{+}installation functionality{+}{color}{color:#333333}.{color}
{info:title=Linked state between component and service assembly}{color:#333333}Quick reminder:{color}
{color:#333333}In order to install one service assembly, the dedicate component must have started or stopped state.{color}
{color:#333333}If you need to shutdown a component all these sevice assemblies must be in shutdown state.{color}
{color:#333333}And to uninstall one component all associated service assemblies must be uninstalled in first.{color}
{info}
!install-sa-scenario1.png|thumbnail!
{color:#333333}Next the Webconsole display to you the installation service assembly page. In this page you need to select{color}
{color:#333333}{_}local{_}{color} {color:#333333}type installation, because in our scenario the pojo service assembly is located on our computer.{color}
{color:#333333}After that you need to click on{color} {color:#333333}{_}Parcourir..._{color} {color:#333333}button in order to select the service assembly in your computer{color}
{color:#333333}directories.{color}
!install-sa-scenario2.png|thumbnail!
Your web navigator provide to you an interface for search the +pojo service assembly archive+
!install-sa-scenario3.png|thumbnail!
When the archive is selected you only need to click on _install_ button to perform the pojo
service assembly installation
!install-sa-scenario4.png|thumbnail!
After the Webconsole provide the pojo service assembly to the selected Petals ESB node,
the node try to install this service assembly. If the installation is correctly performed the following
message will be displayed
!install-sa-scenario5.png|thumbnail!
This screen informs you that all service units of the service assembly was correctly installed, but why ?
Because if your service assembly contains several service units, certain +may misfired+ during the installation
process. If one or several service units *wasn't correctly installed* the Petals Webconsole will warn you. In
both cases you need to click on _continue_ button to return to the service assemblies management table.
After returning to service assemblies management table, you can see the previous installed pojo service
assembly but, on its dedicated row its state is *shutdown*.
!install-sa-scenario6.png|thumbnail!
The next step in our scenario will start this previous service assembly.
h2. {color:#333333}{*}Start service assembly steps:*{color}
{color:#333333}In this step we will see how to{color} {color:#333333}{+}start{+}{color} {color:#333333}the previous installed pojo service assembly (currently in{color} {color:#333333}{*}shutdown{*}{color} {color:#333333}state){color}
{color:#333333}don't worry about that it's very simple to do, because you just need one click on the right button{color} :-)
To start an installed service assembly you just need to click on the associated _start_ button displayed on its row
!install-sa-scenario7.png|thumbnail!
If the start process is correctly performed the service assembly management table is normally redisplayed, but with
the changed state for pojo component to +started+, otherwise it's an *error occurred* during the starting process ...
!install-sa-scenario8.png|thumbnail!
Now that we have seen how to install a component and its linked service assembly, it only remains for us in the
administration tab, to see how to install a shared library.
h2. {color:#333333}{*}Install shared library steps:*{color}
{color:#333333}In this part we'll just see how to install one shared library.{color}
{color:#333333}In order to perform one shared library installation "Rendez-vous" in{color} {color:#333333}{_}Administration{_}{color} {color:#333333}tab and in the sub tab named{color}
{color:#333333}{_}Shared Libraries{_}{color}{color:#333333}. For install a shared library form the shared libraries management tab you just need to click on{color}
{color:#333333}{_}install..._{color} {color:#333333}button, and the Petals Webconsole will return you to the shared library installation page.{color}
!install-sl-scenario1.png|thumbnail!
After that the Webconsole displays to you the shared library installation page. In this page for our scenario
you need to select _local_ for installation type choice, because in our scenario we take in account the shared
library which will be installed +is located in your local computer+. Then you need to click on _Parcourir..._ button
in order to select the desired shared library.
!install-sl-scenario2.png|thumbnail!
Normally after you click on _Parcourir..._ button your web navigator open to you a new window that allows you
to select one shared library in your director hierarchy (+the shared library must be an .zip archive+).
!install-sl-scenario3.png|thumbnail!
When you have validated the shared library selection, you only need to click on _install_ button in order to
perform the shared library installation on the current container.
!install-sl-scenario4.png|thumbnail!
If the Petals container +correctly install+ the shared library you will normally see the installed library in the
shared library management list.
!install-sl-scenario5.png|thumbnail!
Oops, our scenario is unfortunately already finished ... but you learnt several thing, how to install/start component,
install/start service assembly, install one shared library ...
But wait you still need to clean your container :-)
Then we will see how to clean your Petals ESB node in the next part.
h2. {color:#333333}{*}Uninstall shared library steps:*{color}
How you uninstall one shared library ? Nothing complicated, you only need to click on the _uninstall_ button
on +current row+ of the desired shared library which you want to uninstall.
!install-sl-scenario6.png|thumbnail!
Following this action the current container try to uninstall the shared library and if the result is +conclusive+
the shared library management list should no longer see the previous shared library.
!uninstall-sl-scenario1.png|thumbnail!
In the next part we will see how to uninstall the previous installed service assembly.
h2. {color:#333333}{*}Uninstall service assembly steps:*{color}
During this current section, you will learn how to uninstall a service assembly process.
Before uninstall a service assembly you need to take in account its +current state+, but why ?
Because to respect the service assembly life cycle ...
For correclty uninstall a service assembly its must be in +shutdown state+ before performing
uninstallation process, and for performing a shutdown action this service assembly must be
in +stopped state+ ...
Therefore we need to perform a stop action on our service assembly before, because it's
in +started state+.
To realize this stop action you simply need to click on the _stop_ button assigned to this action on
the service assembly current row.
!uninstall-sa-scenario1.png|thumbnail!
Just after the current container perform this stop action, you should normally see the pojo service
assembly with its state switch to +stopped+. Now you need to +shutdown+ it before completing the
uninstallation process, for that just click on the _shutdown_ button of the service assembly current
row.
!uninstall-sa-scenario2.png|thumbnail!
If the shutdown process is successfully performed, you should see the pojo service assembly in
+shutdown+ state. Great, it only remains for you to uninstall the pojo service assembly by clicking
on the +uninstall+ button of the current row.
!uninstall-sa-scenario3.png|thumbnail!
Finally the service assembly uninstallation process is terminated and you +shouldn't normally see+
+that the pojo service assembly+ in the service assembly management list.
!uninstall-sa-scenario4.png|thumbnail!
Our scenario is nearly done, it only remains to uninstall the pojo component in order to
correctly clean our container, it's what we see in the next part.
h2. {color:#333333}{*}Uninstall component steps:*{color}
We will see now how to uninstall one component and its linked process. As well as
one service assembly, a component follows its _lifecycle_ in our container (for this part
you can also see the JBI specification).
{gliffy:name=Component_lifecycle_state_diagram\|align=left\|size=L\|version=1}Therefore we begin by stop the pojo component by clicking on the _stop_ button
of the pojo component row.
!uninstall-sa-scenario1.png|thumbnail!
After the container stop your component, its current state should be changed to
+stopped+. In order to follow the component lifecycle you need now to +shutdown+ the
component and for that you only need to click on the _shutdown_ button.
!uninstall-sa-scenario2.png|thumbnail!
When your component is +shutdown+ it's only remains to performs the uninstallation action.
For this last action you need to click on _uninstall_ button of your pojo component row.
!uninstall-sa-scenario3.png|thumbnail!
If all goes well, +you shouldn't normally see+ the pojo component in the component management
list.
!uninstall-sa-scenario4.png|thumbnail!
Slim, our use case is already over but during this tutorial you learned several functionalities of the administration tab
of Petals Webconsole. Many advanced functionalities like runtime component attribute configuration, logger level
configuration, server properties configuration ... are present but not shown here.