IBM BPM, V8.0.1, All platforms > Reference > User interface help reference > Widgets for Process Portal spaces > Administration widgets

Module Health

Use the Module Health widget to evaluate the health of your module and identify potential problems. The widget provides a central place for health information about module topology, system components, system messaging engines, queues, data sources, and failed events.

Module Health interacts with the Module Browser widget. When you select a module from Module Browser, the Module Health widget refreshes to display health information for the selected module.

If administrative security is enabled for Business Space, you must also enable application security for Module Browser to work properly.

The Module Health widget displays overall status for the module. It also groups additional status and health information for major areas of your module, organizing it into the following tabs. If there is a problem with one or more resources (for example, a queue that has reached capacity, or a node agent that is not running), a warning icon appears at the top of each affected tab.

Topology tab

Lists and provides the status of the standalone servers, deployment environments, clusters, and node agents for the module, as well as the status of each.

System Components tab

Lists and provides the status of the Business Process Choreographer, Common Event Infrastructure (CEI) and Service Component Architecture (SCA) applications and services used by the module (for example, the failed event manager, Business Process Choreographer containers, and the Event Service), as well as Business Space widgets and the Business Space Manager.

System Messaging Engine tab

Lists and provides the status of the system messaging engines configured for the module.

Queues tab

Lists and provides the type and status of the system and application queues configured on the system messaging engines used in the module (note that this tab does not show queues for custom messaging engines). The tab uses icons to indicate general queue depth (ranging from empty to approaching maximum) to help you quickly identify queues that are reaching maximum capacity. Queues are not shown for stopped messaging engines.

Data Sources tab

Lists and provides the status of the data sources used by the module. If that the Data Sources tab does not list custom data sources or support cluster data sources that were not configured as part of the deployment environment. In addition, the tab shows the Unavailable status for any data source whose authentication alias is not set (the widget cannot obtain accurate information about the data source). If this happens, use the administrative console to determine the status.

Failed Events tab

If the Recovery subsystem is enabled, lists the number of failed events in the module. This tab provides a total failed event count as well as individual counts for failed SCA, Business Process Choreographer, Java™ Message Service (JMS), and WebSphere MQ events.

When a module is running, the Module Health widget shows only those components, system messaging engines, and data sources that are part of the module (for example, if the module does not contain business processes or human tasks, the System Components, System Messaging Engine, and Data Sources tabs do not list any Business Process Choreographer or Human Task Manager resources). If the module is stopped, however, the widget displays all components, system messaging engines, and data sources on the system, even those not used by the module. To have an accurate idea of your module's health, ensure the module is running before using the Module Health widget.

With the exception of failed events, each item in each tab has an icon to help you assess its status at a glance.

Icon	Status	Tab or Tabs using icon
	Running	Topology System Components System Messaging Engines Data Sources In addition, the icon is used to indicate overall module health.
	Stopped
	Unavailable
	Partially started
	Partially stopped
	Loading This is a transitional status that appears when data is loading and is replaced by status when data is available.
	Queue is empty	Queues
	Queue contains messages
	Queue is approaching maximum capacity (more than 90% full)
	Queue is full
	Warning: There is a problem with one or more resources on the tab	All tabs

• Determining module health
  Use the Module Health widgets to examine the health status of a module and its topology, system components, queues, data sources, and system messaging engines.

Administration widgets

Related tasks:
Determining module health

Related information:
Module Browser widget