System management console screen

The main view of the System Management Console displays an overall status of Sterling Order Management System Software Application Platform.

Each of the three main types of screens refreshes with the updated information every 5 minutes. All other screens within the console do NOT refresh with the updated information.

Table 1. System management console
Actions   Description
The following actions are accessible from the Tools menu.
Create Monitoring Group This action takes you to the Monitor Group Details Screen where you can create a new monitor group for an API, Agent, Integration Server, or JMS Queue.
Trace Components This action takes you to the Traced Components List Screen where you can view and add traces.
View Live Agent or Integration Servers This action takes you to the Live Agent or Integration Servers Screen where you can view and control agent or integration servers.
Status Bar

The status bar contains icons that represent various information about the entire system. You can keep the status bar visible always so that any problems in the application are immediately visible when the icons change.

Icons Icon Name Description
security
User The tooltip of this icon displays information about the user that is logged in to the System Management Console.
timezone
Locale The tooltip of this icon displays information about the active locale.
stop
Trace This icon shows the status of the trace feature within the System Management console. Tracing can be turned on or off by clicking this icon. When tracing is off, the icon displays a red circle with an X. When tracing is on, the icon displays a green circle with a checkmark. Trace must always be turned off unless you are trying to debug a problem within the System Management console. When trace is turned on, informative messages are output to the Appender configured in the log4jconfig.xml. When the trace is turned on, the screens in the System Management console perform much more slowly than usual.
appserverdown
All Application Hosts This icon represents the state of ALL application hosts. It displays the appropriate color (normal, red, yellow, or disabled) representing the worst state of all application hosts. For example, if all application servers for one host are down, the icon here is disabled. If all application servers are running, but one application server has exceeded its response time threshold, the icon displays in red. If all application servers are running and have no problems, the icon displays normally.
apibad
All API Groups This icon represents the state of ALL API groups. It displays the appropriate color (normal, red, or yellow) representing the worst state of all API groups.
agentbad
All Agents/Integration Server Groups This icon represents the state of ALL agent or integration server groups. It displays the appropriate color (normal, red, or yellow) representing the worst state of all agent or integration server groups.
jms
All JMS Queue Groups This icon represents the state of ALL JMS queue groups. It displays the appropriate color (normal, red, or yellow) representing the worst state of all JMS queue groups.
Table 2. System management console screen, clients
Clients

Between the Clients and Application Hosts sections of the screen, the arrows are labeled with information about the requests and responses from the client and servers.

On the arrow pointing to the application host, the number of requests per second is displayed. This number represents the number of HTML requests (per second) coming from users of the Application Console for the last persist interval. This indicates the load on the application servers that are coming from the users.

On the arrow pointing to the client, the average response time across all application servers is displayed. This number gives a general idea of the response time that the users of the Application Console are experiencing.

Table 3. System management console screen, application hosts
Icons Icon Name Description
application_server_icon
Application Hosts Application Hosts

For each application host (physical machine) that is running application servers, the following information is displayed in the Application Hosts window.

The progress bar next to the icon indicates the highest percentage of cache that is used by any application server running on the host.

Next to the progress bar, the highest response time of any application server that is running on that host is displayed.

The name of the application host that is displayed.

To view the Application Hosts Summary Screen, single-click (or right-click and select Details) on the application host.

appservergroupgood
Normal Response time Normal - All application servers are running normally with good response times.
appservergroupbad
Response Time Above Threshold Red - One or more application servers are running with a response time that exceeds the set threshold.
agentservergroupwarning
Response Time Near Threshold Yellow - One or more application servers are running with a response time that is close to the set threshold.
appservergrouppartiallydown
Server Down Normal with Yellow - Some of the application servers are down. This icon appears only if multiple application servers are running on the host, and one or more application servers is down while there is at least one application server that is still running.
appservergroupdown
All Servers Down Disabled with Red - All application servers are down.
Table 4. System management console screen, API groups
Icons Icon Name Description
apigroupicon
API Groups API Groups

For each API monitor group, the following information is displayed in the API Groups window.

The API group name is displayed under the icon. The number of active APIs in the group is displayed in parentheses next to the group name. An API is considered to be active if it has been called during the last persist interval.

To view the API Groups Summary Screen, single-click (or right-click and select "Details") on the API group.

apigroupgood
Normal API Response Time Normal - All APIs are running normally with good response times.
The API response time is above the threshold
API Response Time Above Threshold Red - One or more APIs are running with a response time that exceeds the set threshold.
The API response time is near the threshold
API Response Time Near Threshold Yellow - One or more APIs are running with a response time that is close to the set threshold.
Table 5. System management console screen, database
Fields Description
Database

System Management does not monitor the database in any way. It is recommended that you use a third-party database monitoring software in addition to the System Management Console.

The Database window displays information about the database that the application is using.

Driver Name The name of the database driver used to connect to the METADATA database.
Driver Version The version of the database driver used to connect to the METADATA database.
Database Version The complete database version information is available as a tooltip on the database icon.
Actions Description
Clear Cache This action clears all cache for the database, which includes the cache for all application, agent and integration servers.
Table 6. System management console screen, agent, or integration server groups
Icons Icon Name Description
agentgroupicon
Agent/Integration Server Groups Agents or Integration Server Groups

For each agent or integration server monitor group, the following information displays in the Agent or Integration Server Groups window.

The agent or integration server group name is displayed under the icon. The number of active agents and integration servers in the group is displayed in parentheses next to the group name. An agent or integration server is considered to be active if it had any activity during the last persist interval.

To view the Agent and Integration Server Summary Screen, single-click (or right-click and select Details) on the agent or integration server group.

agentservergroupgood
Normal Number of Pending Tasks Normal - All agents have several pending tasks less than the set threshold.
agentservergroupbad
Pending Tasks Above Threshold Red - One or more agents have several pending tasks that exceed the set threshold.
agentservergroupwarning
Pending Tasks Near Threshold Yellow - One or more agents have several pending tasks that are close to the set threshold.
Table 7. System management console screen, JMS queue groups
Icons Icon Name Description
jmsqueuegroupicon
JMS Queue Group JMS Queue Groups

For each JMS queue monitor group, the following information displays in the JMS Queue Groups window.

The JMS queue group name that is displayed.

To view the JMS Queue Summary Screen, single-click (or right-click and select Details) on the JMS queue group.

jmsgroupgood
Normal Number of Messages Normal - All queues have several messages lower than the set threshold.
jmsgroupbad
Messages Above Threshold Red - One or more queues have several messages that exceed the set threshold.
jmsgroupwarning
Messages Near Threshold Yellow - One or more queues have several messages that are close to the set threshold.