{section}
{column}
h1. Administration aspect overview:
The administration view part of the Petals Webconsole allows to perform
several administrative actions on the selected server, but also provide
informations, data and several other details on each item that can be
administrated.
{column}
\\
{column:width=350px}
{panel}{toc}\\ {panel}\\
{column}\\
{section}
h1. Features and functionalities:
The administration view provide several features, splintered into five tabs:
* The first for current server endpoints.
* The second for current server components.
* The third for current server service assemblies.
* The fourth for current server shared libraries.
h3. Endpoints administrative tab
This tab contains a table where each recovered server endpoint is displayed. Each
row provide several informations on the current endpoint, like :
* The endpoint name
* The service name
* The interface name
* The component holder
* And a link to the associated _wsdl_ file
!endpoints-tab.png|thumbnail!
(!) *Warning*: If Petals ESB don't correctly send back the wsdl file, it's sometimes possible
that the link don't work.
If you have a lot of endpoints displayed, the table will automatically _paginate_ the render, and
if you need *to sort* the rows for example by _endpoint name_, you only need to click on the column
title:
!Sorting-feature.png|thumbnail!
(i) *Information:* Think to click on the "Refresh domain", if nothing endpoint is displayed or if you are sure that
one is missing into the table.
h3. Components administrative tab
The main purpose of this tab is to give you access to several administrative features, for each
component present +on the current server+. But this tab also provides to you a lot of valuable
informations into a table, each row represent a component found for the current server and
display its component name (example: _petals-se-rmi_, _petals-bc-soap_, ...), its component type
(_binding component_, _service engine_) and an interesting information the *component state* that
can serve as a sorting filter in the table rendering.
!component-tab.png|thumbnail!
Each table columns allow to perform different action on the associated component of the row:
|| Icon \\
\\ || Action \\ ||
| !start.png|thumbnail!\\ | This first icon allows to start the associated component, \\
It must be into _stop_ or _shutdown_ state. \\ |
| !stop.png|thumbnail!\\ | This icon provides the possibility to _stop_ a started \\
component, on the current server. \\ |
| !shutdown.png|thumbnail!\\ | The _shutdown_ icon give you the possibility to shutdown \\
a component, but it must be stopped first. \\ |
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, the \\
associated component must be shutdown first. \\ |
| !forceunload.png|thumbnail!\\ | The action performed by this icon is very _radical_, \\
it's as if you try to uninstall and unload the \\
associated component. It try to _force_ the uninstall \\
and unload action. \\ |
| !runtime-attributes-button.png|thumbnail!\\ | Access to runtime component attributes can be \\
allowed thank to this icon, but the component must be \\
previously started to return the runtime attributes. \\ |
The toolbar associated to the table allows you to perform the previous action,
but for +all selected component+ thank to checkbox associated to the row:
!component-toolbar.png|thumbnail!
(!) *Warning*: Only one action is performed for all components instead if you
haven't selected them:
It allows you to clear the current server by removing +all components+ (and
associated _service assemblies_ on each), installers and bootstraps ...
As its name indicates, this action aims to clean up the current server.
The following *gray* icons mean, that associated component isn't in _state_
_condition_ to perform the following action:
!start-off.png|thumbnail! !stop-off.png|thumbnail! !shutdown-off.png|thumbnail! !uninstalled-off.png|thumbnail!
+For example:+ For the _stop_ icon becomes *coloured*, the associated component must be in _start_ state
h3. Shared libraries administrative tab
This tab contains administrative management for all shared libraries of the current server. The table
contained into this view display each recovered shared library. Although, unless actions are
possible on the shared libraries, some still available like: _install_, _uninstall_
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, on \\
the associated shared library. \\ |
For associated informations, only shared library _name_ is displayed:
!libraries-tab.png|thumbnail!
\\ !clearall.png|thumbnail!: provides the same action as for component, but applied to shared libraries.
Following this action all shared libraries on the current server should be uninstalled.
h3. Service assemblies tab
This administrative view tab allows to display several informations about recovered service assemblies
on the current selected server. Thank to this tab you can perform several interactions on each deployed
service assembly, actions here are the _same_ that the components tab.
!assemblies-tab.png|thumbnail!
Several informations like service assembly _name_ or the current service assembly _state_ are displayed.
Each table columns allow to perform different action on the associated service assembly of the row:
|| Icon \\
\\ || Action \\ ||
| !start.png|thumbnail!\\ | This first icon allows to start the associated service, \\
assembly It must be into _stop_ or _shutdown_ state. \\ |
| !stop.png|thumbnail!\\ | This icon provides the possibility to _stop_ a started \\
service assembly, on the current server. \\ |
| !shutdown.png|thumbnail!\\ | The _shutdown_ icon give you the possibility to shutdown \\
a service assembly, but it must be stopped first. \\ |
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, the \\
associated service assembly must be shutdown first. \\ |
| !forceunload.png|thumbnail!\\ | The action performed by this icon is very _radical_, \\
it's as if you try to uninstall and unload the \\
associated service assembly. It try to _force_ the \\
uninstall and unload action. \\ |
!clearall.png|thumbnail! : provides the same action as for component, but applied to service assemblies.
Following this action all service assemblies on the current server should be uninstalled
and unloaded.
h3. Attributes configuration during component installation
!installation-component.png|thumbnail!
If the installation *correctly work* the deployed artefact is displayed, but if isn't
correctly installed a _error message_ you are returned. Two installation result behaviours
are different for component and service assembly, during the component installation
you can set installation component attributes thank to the following form:
!attributes-installation.png|thumbnail!
Certain attributes are common for all components like: _acceptorPoolSize_, _processorPoolSize_, _notifications_ ...
But several attributes are very specific on each component, example : _httpHostName_, httpPort, httpAcceptors ...
are only linked to the *petals-bc-soap* component installation.
h3. Runtime features
Two *runtime* features are provided thank to these following icon into component table:
!runtime.png|thumbnail!: allows to modify runtime component _attributes_ for the specified component.
For the feature that allows to modify the *runtime* component attributes, the
following form is dynamically generated in order to display each attributes
discovered for the current component:
!runtime-attributes.png|thumbnail!
(i) *Information:* We advise you to refer to component documentation to know the
meaning of each attributes.
{column}
h1. Administration aspect overview:
The administration view part of the Petals Webconsole allows to perform
several administrative actions on the selected server, but also provide
informations, data and several other details on each item that can be
administrated.
{column}
\\
{column:width=350px}
{panel}{toc}\\ {panel}\\
{column}\\
{section}
h1. Features and functionalities:
The administration view provide several features, splintered into five tabs:
* The first for current server endpoints.
* The second for current server components.
* The third for current server service assemblies.
* The fourth for current server shared libraries.
h3. Endpoints administrative tab
This tab contains a table where each recovered server endpoint is displayed. Each
row provide several informations on the current endpoint, like :
* The endpoint name
* The service name
* The interface name
* The component holder
* And a link to the associated _wsdl_ file
!endpoints-tab.png|thumbnail!
(!) *Warning*: If Petals ESB don't correctly send back the wsdl file, it's sometimes possible
that the link don't work.
If you have a lot of endpoints displayed, the table will automatically _paginate_ the render, and
if you need *to sort* the rows for example by _endpoint name_, you only need to click on the column
title:
!Sorting-feature.png|thumbnail!
(i) *Information:* Think to click on the "Refresh domain", if nothing endpoint is displayed or if you are sure that
one is missing into the table.
h3. Components administrative tab
The main purpose of this tab is to give you access to several administrative features, for each
component present +on the current server+. But this tab also provides to you a lot of valuable
informations into a table, each row represent a component found for the current server and
display its component name (example: _petals-se-rmi_, _petals-bc-soap_, ...), its component type
(_binding component_, _service engine_) and an interesting information the *component state* that
can serve as a sorting filter in the table rendering.
!component-tab.png|thumbnail!
Each table columns allow to perform different action on the associated component of the row:
|| Icon \\
\\ || Action \\ ||
| !start.png|thumbnail!\\ | This first icon allows to start the associated component, \\
It must be into _stop_ or _shutdown_ state. \\ |
| !stop.png|thumbnail!\\ | This icon provides the possibility to _stop_ a started \\
component, on the current server. \\ |
| !shutdown.png|thumbnail!\\ | The _shutdown_ icon give you the possibility to shutdown \\
a component, but it must be stopped first. \\ |
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, the \\
associated component must be shutdown first. \\ |
| !forceunload.png|thumbnail!\\ | The action performed by this icon is very _radical_, \\
it's as if you try to uninstall and unload the \\
associated component. It try to _force_ the uninstall \\
and unload action. \\ |
| !runtime-attributes-button.png|thumbnail!\\ | Access to runtime component attributes can be \\
allowed thank to this icon, but the component must be \\
previously started to return the runtime attributes. \\ |
The toolbar associated to the table allows you to perform the previous action,
but for +all selected component+ thank to checkbox associated to the row:
!component-toolbar.png|thumbnail!
(!) *Warning*: Only one action is performed for all components instead if you
haven't selected them:
It allows you to clear the current server by removing +all components+ (and
associated _service assemblies_ on each), installers and bootstraps ...
As its name indicates, this action aims to clean up the current server.
The following *gray* icons mean, that associated component isn't in _state_
_condition_ to perform the following action:
!start-off.png|thumbnail! !stop-off.png|thumbnail! !shutdown-off.png|thumbnail! !uninstalled-off.png|thumbnail!
+For example:+ For the _stop_ icon becomes *coloured*, the associated component must be in _start_ state
h3. Shared libraries administrative tab
This tab contains administrative management for all shared libraries of the current server. The table
contained into this view display each recovered shared library. Although, unless actions are
possible on the shared libraries, some still available like: _install_, _uninstall_
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, on \\
the associated shared library. \\ |
For associated informations, only shared library _name_ is displayed:
!libraries-tab.png|thumbnail!
\\ !clearall.png|thumbnail!: provides the same action as for component, but applied to shared libraries.
Following this action all shared libraries on the current server should be uninstalled.
h3. Service assemblies tab
This administrative view tab allows to display several informations about recovered service assemblies
on the current selected server. Thank to this tab you can perform several interactions on each deployed
service assembly, actions here are the _same_ that the components tab.
!assemblies-tab.png|thumbnail!
Several informations like service assembly _name_ or the current service assembly _state_ are displayed.
Each table columns allow to perform different action on the associated service assembly of the row:
|| Icon \\
\\ || Action \\ ||
| !start.png|thumbnail!\\ | This first icon allows to start the associated service, \\
assembly It must be into _stop_ or _shutdown_ state. \\ |
| !stop.png|thumbnail!\\ | This icon provides the possibility to _stop_ a started \\
service assembly, on the current server. \\ |
| !shutdown.png|thumbnail!\\ | The _shutdown_ icon give you the possibility to shutdown \\
a service assembly, but it must be stopped first. \\ |
| !uninstall.png|thumbnail!\\ | Uninstall action can be performed by this icon, the \\
associated service assembly must be shutdown first. \\ |
| !forceunload.png|thumbnail!\\ | The action performed by this icon is very _radical_, \\
it's as if you try to uninstall and unload the \\
associated service assembly. It try to _force_ the \\
uninstall and unload action. \\ |
!clearall.png|thumbnail! : provides the same action as for component, but applied to service assemblies.
Following this action all service assemblies on the current server should be uninstalled
and unloaded.
h3. Attributes configuration during component installation
!installation-component.png|thumbnail!
If the installation *correctly work* the deployed artefact is displayed, but if isn't
correctly installed a _error message_ you are returned. Two installation result behaviours
are different for component and service assembly, during the component installation
you can set installation component attributes thank to the following form:
!attributes-installation.png|thumbnail!
Certain attributes are common for all components like: _acceptorPoolSize_, _processorPoolSize_, _notifications_ ...
But several attributes are very specific on each component, example : _httpHostName_, httpPort, httpAcceptors ...
are only linked to the *petals-bc-soap* component installation.
h3. Runtime features
Two *runtime* features are provided thank to these following icon into component table:
!runtime.png|thumbnail!: allows to modify runtime component _attributes_ for the specified component.
For the feature that allows to modify the *runtime* component attributes, the
following form is dynamically generated in order to display each attributes
discovered for the current component:
!runtime-attributes.png|thumbnail!
(i) *Information:* We advise you to refer to component documentation to know the
meaning of each attributes.