Chapter 25. Administration Console

25.1. Admin Console

The Admin Console is a web-based tool allowing system administrators to monitor and configure services deployed within a running Enterprise Application Platform instance.

25.2. Admin Console and ModeShape

When Enterprise Data Services (EDS) is installed on top of the Enterprise Application Platform (EAP), a plug-in is added to the EAP web-based Admin Console. This allows system administrators to monitor and configure EDS services deployed within a running EAP instance via a web interface.
The following dashboards, specific to ModeShape, are available in the tree hierarchy presented on the left side of the Admin Console:
ModeShape
Repositories
Sequencing Service
Sequencers
Connectors

25.3. Running the Admin Console

Prerequisites

  • JBoss Enterprise SOA Platform must be installed and running.
  • Your user details must be correctly configured in:
    • SOA_ROOT/jboss-as/server/PROFILE/conf/props/soa-users.properties and
    • SOA_ROOT/jboss-as/server/PROFILE/conf/props/soa-roles.properties.

Procedure 25.1. Running the Admin Console

  1. Launch the Console in a Web Browser

    Open http://localhost:8080/admin-console in a web browser.
  2. Authenticate to the Console

    Enter your Username and Password as set in SOA_ROOT/jboss-as/server/PROFILE/conf/props/soa-users.properties.

25.4. Admin Console: ModeShape Dashboard

From the ModeShape dashboard, system administrators have access to the following items:
Summary
Control
From the Control tab administrators can start/restart and stop the ModeShape engine.

25.5. ModeShape Dashboard: Control

Within the Admin Console, system administrators can issue the following commands from the Control tab of the ModeShape Dashboard:

Table 25.1. ModeShape Control Commands Available via Admin Console

Command Description
Start/restart
Start the ModeShape engine (or restart the ModeShape engine if it is already running).
Shutdown
Stop the ModeShape engine.

25.6. Admin Console: Repositories Dashboard

From the Repositories dashboard, the Summary tab displays all repositories and indicates whether they are "UP" or "DOWN".
For a selected repository, system administrators have access to the following items:
Summary
Configuration
Metrics

Note

The configuration cannot be modified via Admin Console.

25.7. Repositories Dashboard: Metrics

Having selected a repository from the Summary tab of the Repositories dashboard, system administrators can then monitor the following metrics from the Metrics tab for the selected repository:

Table 25.2. Repository Metrics Available via Admin Console

Name Description
Total Active Sessions
The number of JCR sessions that are currently active.

25.8. Admin Console: Sequencing Service Dashboard

From the Sequencing Service dashboard, system administrators have access to the following items:
Summary
Metrics

25.9. Sequencing Service Dashboard: Metrics

Within the Admin Console, system administrators can monitor the following metrics from the Metrics tab of the Sequencing Service dashboard:

Table 25.3. Sequencing Throughput Metrics Available via Admin Console

Name Description
Number Of Nodes Sequenced
The number of nodes sequenced.
Number of Nodes Skipped
The number of nodes that were skipped because no sequencers applied.

25.10. Admin Console: Sequencers Dashboard

From the Sequencers dashboard, the Summary tab displays all sequencers deployed to the ModeShape instance and indicates whether they are "UP" or "DOWN".
For a selected sequencer, system administrators have access to the following items:
Summary
Configuration

Note

The configuration cannot be modified via Admin Console.

25.11. Admin Console: Connectors Dashboard

From the Connectors dashboard, the Summary tab displays all connectors and indicates whether they are "UP" or "DOWN".
For a selected connector, system administrators have access to the following items:
Configuration
Metrics
Control

Note

The configuration cannot be modified via Admin Console.

25.12. Connectors Dashboard: Metrics

Having selected a connector from the Summary tab of the Connectors dashboard, system administrators can then monitor the following metrics from the Metrics tab for the selected connector:

Table 25.4. Connector Utilization Metrics Available via Admin Console

Name Description
Total Connections in Use
The number of connections in use.

25.13. Connectors Dashboard: Control

Having selected a connector from the Summary tab of the Connectors dashboard, system administrators then have access to the following controls from the Control tab for the selected connector:

Table 25.5. Connector Control Commands Available via Admin Console

Name Description
Ping
Ping the connector to test availability.