System Health Widget

The System Health widget is designed to help a systems administrator monitor the components of the EnterWorks system. Therefore, it is recommended this widget be added to the Administrator Dashboard. It may also appear on the Dashboards of non-administrators, however, their permissions may not allow them to set the widget's configuration options other than the title.

Configuring a System Health Widget

To configure a System Health widget:

  1. Configure a new blank widget. For more information about adding and configuring new widgets, see Add a Widget.

  2. Select the Settings icon in the upper right of the new widget’s Activity Bar. Note that a widget’s Activity Bar will not be displayed unless the cursor is hovering over the top of the widget. A Configuration window will appear.

  3. Select System Health from the Type dropdown list on the far right of the Widget Configuration window. The System Health widget configuration options will appear.
  4. Set the widget's Title. It is helpful if the title of a widget reflects the widget’s type, for example "System Health".
  5. The other configuration options for the System Health widget allow you to select the status to be included in the widget’s display. Edit the configuration options as desired.

    System

    Options

    Notes

    EPIM

    Tomcat Master

    Monitor the process that manages the EnterWorks UI and API calls.

    EPIM

    WildflyController

    Monitor the process that coordinates background operations handled by the WildflyWorkers.

    EPIM

    WildflyWorker<n>

    Monitor the processes that perform the background processes (such as imports, exports, validations, and mass edits).

    EPIM

    Database

    Monitor the connection to the EPIM database.

    EPIM

    Job Monitor

    Monitor the Job Monitor, reporting the number of queued, active, and recently failed jobs.

    EPIM

    Application File System Access

    Verify the file system is accessible and is not out of disk space for Tomcat.

    EPIM

    Web File System Access

    Verify each of the WildflyWorker processes can access the file system and are not out of disk space.

    EPX

    Tomcat

    Monitor the EPX Tomcat process

    EPX

    Jboss

    Monitor the JBoss process that orchestrates the movement of work items from activity to activity.

    EPX

    BIC Manager

    Monitor the EPX BIC Manager, which processes all automatic activities in workflows.

    EPX

    EPX User

    The EPX user that is used to launch a work item on the Ping-Enable workflow. Needs to be a member of the EnableWorkflowInitiators group

    EPX

    EPX Password

    Password for the EPX user.

    EPX

    Workflow Process Name

    The name of a simple EPX workflow to be used to verify work items are processing. The system health refresh causes a work item to be created on this process. The work item is created using the specified EPX User and EPX Password.

    EPX

    Starting Point Activity Name

    The name of the starting point activity in the workflow identified by Workflow Process Name on which to create the work item.

    EPX

    End Point Activity Name

    The name of the ending point activity in the workflow identified by Workflow Process Name. The system health refresh checks this activity to verify that the work item created on the starting point activity above arrives within a few seconds, which indicates EPX processing is working correctly.

    EPX

    File System

    Verify that the EPX process can update the file system and has not run out of disk space.

    Enable

    Enable Web

    If IIS is configured, monitor the connectivity to IIS.

  6. Click Apply to save the changes to the widget and close the Configuration window. Click Cancel to close the Configuration window without saving the changes.

If you want your Dashboard configuration to remain after you switch tabs or log out, click the Save Layout button on the Dashboard's Activity Bar, otherwise your Dashboard will revert to its last saved configuration.