Reading time: 7 Min

Overview of the Monitoring page

The Monitoring page gives you an up-to-date, at-a-glance consolidated overview of system health, including the status of activity processing, agents, and imports.

This visibility not only helps you ensure and verify the import of data and the sending of policy, but also provides insight into the activity and processing loads on your iManage SPM Service.

For example, if you experience a slight slowdown on a given page, but also notice a spike in pending system activity processing at that time, you can monitor that processing in near-real time and potentially avoid the need to contact iManage Support. 

Accessing the Monitoring page

The Monitoring page is available to users with the Monitoring role. By default, this role is unassigned.

To access the Monitoring page, select Monitoring in from the left navigation pane. The Monitoring page appears.

TIP:

The Monitoring page can be bookmarked.

When you access the page, monitoring data is displayed in panels across a number of sections, and if there are any errors or warnings, these are displayed on banners at the top of the page.

The following sections contains more information about the data, and the banners and other elements on the page:

Understanding monitoring data 

The Monitoring page consists of three (or if email responder is connected, four) main sections. 

Information on the Monitoring page is updated every 30 seconds, but you can also manually refresh the page by selecting the Update button in the upper-right area of the page. 

Overview

The Overview section provides a high-level summary of system health. This section contains three panels:

System Activities

The System Activities panel displays the status of ongoing tasks being processed at the iManage SPM Service level—that is, for the whole system rather than just the tasks initiated by the signed-in user. These tasks may relate to notifications, self-maintaining rules, reports, and so on.

A chart is displayed showing the number of tasks awaiting processing during the preceding hour. The last time that all tasks were processed is also provided. When processing is underway, a count of the remaining tasks is given. Refer also to Other informational and interactive elements.

Calculate

The Calculate panel shows the status of policy calculations.

For example, if a user adds 1,000 matters to a collection, the status may change from Idle (All caught up) to Calculating. When calculation is underway, a count of the remaining items to be calculated is shown. As with other panels, a chart may be displayed.

Send

The Send panel indicates the sending status of policies to downstream systems—that is, via agents. It provides an amalgamated snapshot of policy sending across all agents, which is particularly useful for systems with a large number of agents.

Similar information on a per-agent basis is available in the Agents section.

NOTE:

You may occasionally see a send number of "0" items: this simply indicates that there is no policy information to be sent at that time. 

Agents 

The Agents panel displays the list of agents registered with SPM server along with the agent service status (running or stopped). It also displays additional details regarding whether an agent is up to date, when the service stopped, a friendly name for easy identification, and visibility into errors that occurred.

The Agents section displays a panel for each agent connected (or formerly connected) to iManage SPM. Each panel includes pertinent information for that agent, including:

  • Agent Name (unique identifier).

    TIP:

    The unique identifier of an agent is the name displayed in the agent list, before any _libraryname suffix.

    For example, for an agent displayed as WORK01_library1, the unique identifier is WORK01.
    For on-premises agents, the unique identifier can also be found in the corresponding CFG file, as the value of the uniqueAgentIdentifier parameter.

  • Sending/Connection status, as applicable.
  • Pending policy send count.
  • Pending policy send chart.
  • Errors. If an agent has errors, including users exceeding the claims limit—which means they may not have access to some restricted items to which they had been granted access—you can view these, as described in and Other informational and interactive elements.

    NOTE:

    If an agent fails, notifications can be sent to designated users. For more information on how to add users for receiving notifications, refer to the System Alerts section in Settings>Notifications.

For more information about agents in iManage SPM, see the corresponding installation or integration documentation for each agent in iManage Help Center.

Remove a disconnected agent from the Agents section

If an agent is disconnected from iManage SPM, you can remove it from the panel.

  1. Select the
    icon on the panel of the disconnected agent that you want to remove.
  2. Select Stop Tracking Agent. A confirmation message appears and the panel is removed.

The agent is no longer displayed. If the agent is reconnected, it appears again in the list when the panel is refreshed (manually or automatically).

NOTE:

You cannot remove connected agents.

Imports 

The Imports panels let you monitor the status of imports—such as those of client, user, or activity information—from source systems. In a similar fashion to the agents section, you'll find a panel for each import connected to iManage SPM. In addition to the import status, you can view the frequency for a given import. 

For more information about imports and how to set them up for:

As with other panels, relevant charts may be displayed.

If an import has errors, you can view these, as described in Other informational and interactive elements.

TIP:

For imports from iManage Work at cloudimanage.com, you can manage activity outliers—that is, system or other privileged accounts in your organization may perform a high number of activities for valid purposes—from the Activity Feeds section under Settings>General.


Remove imports from imports panel

You can remove disconnected imports, if required. To do so:

  1. Select the
    icon on the panel of the (disconnected) import that you want to remove.
  2. Select Stop Tracking. A confirmation dialog displays.
  3. Select Yes. The import panel is removed.

    NOTE:

    The panel for a removed disconnected import will re-appear in the list if import is restarted, or otherwise run again.

Email Responder

If you are using iManage Security Policy Manager Service in the Cloud and have configured the SPM Email Responder Service, this panel will be displayed. The status of the email responder service is shown, and includes time of last email sent.

For more information about the SPM Email Responder Service, refer to iManage Security Policy Manager Email Responder Service Installation Guide.

Other informational and interactive elements 

The monitoring dashboard is designed for your intuitive, efficient and effective use. To this end, it includes a number of helpful features, as follows:

Color-coded banners

Banners at the top of the page highlight errors and warnings for quick viewing, and these are color-coded to indicate severity.

Similar messages are grouped together, and when applicable, you can select the banner to view more details about the error or warning.

Status badges

Panels in each main section have their own status badges—such as Idle, Calculating, Warning—for quick insight into status as relevant for that panel. These badges are color-coded for clarity, and to help prioritize higher-severity issues.

Error count indicator

Any errors or warnings that may require your attention are indicated and enumerated on the main navigation bar, beside Monitoring. These persist until resolved.

The indictor is color-coded to reflect the highest severity of any errors or warnings present. 

Figure: Error count indicator showing one high-severity error

Error details

You have the option to view error details on panels, where applicable. 

When there is a single error of a given type, a View Error button is available for selection on the panel.

When there are multiple errors of a given type, you can select the

icon and then select View Errors.

Automatic and manual page refresh

The monitoring page data automatically refreshes every 30 seconds. You can manually refresh as required, by selecting the Update button in the upper-right area of the page.

Interactive charts 

Line charts are displayed when activity relevant to a panel—for example calculation activity in the Calculate panel—is underway or has occurred in the past hour.

The charts show useful recent information and help to understand trends.

You can view more granular details of the data points—plotted at  15-minute intervals— by hovering over the chart line.