MID Server dashboard

  • Release version: Australia
  • Updated March 12, 2026
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of MID Server dashboard

    The MID Server dashboard in ServiceNow provides a centralized interface for monitoring MID Server operations. It presents reports and gauges based on data from theMID Server Status [eccagentstatus]table. Accessible via theMID Server > Dashboardmodule, the dashboard helps administrators track MID Server health, performance, and job processing status.

    Show full answer Show less

    After upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), users can also access an enhanced MID Server dashboard through Workspaces > Discovery Admin Workspace > Insights.

    Access requirements:

    • To view the MID Server dashboard, users need the midserver or admin role.
    • The Discovery Admin Workspace requires the discoveryadmin role.
    • Role permissions are managed through standard ServiceNow group-based role inheritance.

    Dashboard Tabs and Features

    • Overview tab: Displays graphs detailing MID Server statuses, highlighting validation issues, pending upgrades, and active jobs. It also shows MID Servers organized by capability.
    • Performance tab: Shows CPU and memory usage statistics for MID Servers, including lifecycle event history.
    • Custom performance tab: Allows users to define custom selection criteria and time frames to focus on specific MID Servers.

    MID Server Status Gauge and Information

    The status gauge provides key details about each MID Server, including:

    • Name and Host name
    • Status and Validation state
    • Memory and CPU usage percentages during configured sampling intervals (default 30 minutes, adjustable)
    • Pending and processing ECC queue jobs
    • Version compatibility with the instance
    • User login linked to the MID Server

    Version icons indicate compatibility status:

    • Red: Incompatible version; MID Server must be upgraded and not pinned by the mid.version.override property.
    • Yellow: Compatible family but upgrade recommended.
    • Green: Fully compatible; no upgrade needed.
    • Gray: Version cannot be detected by the instance.

    User icons indicate role compatibility:

    • Red: User lacks the midserver role or does not match the configured username; requires reconfiguration.
    • Green: User has appropriate roles and matches configuration.

    Note: The status gauge does not automatically mark a MID Server as down if its version is incompatible; always verify the MID Server version on the dashboard to ensure accurate status.

    Practical Use and Next Steps

    ServiceNow customers can use the MID Server dashboard to proactively monitor MID Server health, resource usage, and job queues, helping to maintain efficient discovery and integration processes. Ensuring MID Servers are correctly validated and upgraded prevents processing interruptions.

    For troubleshooting and configuration, customers should refer to related resources such as:

    • MID Server upgrades and version management
    • Resource threshold alerts for CPU and memory usage
    • Manual MID Server controls (start, stop, restart)
    • JVM memory size settings and pause controls

    Proper role assignment and version compliance are critical for reliable MID Server operations and dashboard visibility.

    The MID Server dashboard is a central place for MID Server users to monitor ongoing operations. The dashboard consists of reports and gauges that display information from the MID Server Status table.

    Links to each of the MID Server sectionsEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

    The MID Server Dashboard is available from the MID Server > Dashboard module.

    After upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), you can navigate to Workspaces > Discovery Admin Workspace > Insights and use the enhanced dashboard.

    Note:
    To access the MID Server Dashboard, the user must have the mid_server or admin role. The Discovery Admin Workspace requires the discovery_admin role. Group-based access follows standard ServiceNow role inheritance; ensure users in the group have the appropriate role assigned. For role setup, see Create the MID Server user and grant the role

    MID Server Overview tab

    The Overview tab provides graphs showing the status of MID Servers, including any validation issues or pending upgrades and jobs. The tab also displays which MID Servers by capability.

    MID Server overview tab.

    MID Server Performance tab

    The Performance tab displays information relating to the MID Server CPU and memory usage, including the life-cycle event history.

    Performance tab layout.

    MID Server Custom performance tab

    The Custom performance tab enables users to set custom MID Server selection criteria to show particular MID Servers in a select time frame.

    Custom performance tab.

    MID Server status gauge

    The MID Server Status gauge on the dashboard displays basic information about each MID Server. This information comes from the MID Server Status [ecc_agent_status] table.
    Figure 1. MID Server Dashboard gauge
    The MID Server Dashboard gauge

    If the version is not compatible, the MID Server status is not changed to Down in the MID Server dashboard. So it might still appear to be processing commands when it actually is not doing so. You must check the MID Server Version on the dashboard.

    See KB0535181 for additional MID Server troubleshooting information.

    The icons in the Version column indicates the following:
    • Red: Incompatible. The MID Server and instance do not belong to the same release. You must upgrade the MID Server and verify that it is not pinned to an older version with the mid.version.override property. The MID Server will not be upgraded until the parameter is cleared.
    • Yellow: Compatible, but an upgrade is recommended. This indicates that the MID Server version belongs to the same family as the instance, but not the same version.
    • Green: Compatible. No upgrade necessary.
    • Gray: Incompatible. The instance cannot detect the version.
    Column Description
    Name The name of the MID Server.
    Host name The name of the system that hosts the MID Server.
    Status The status of the MID Server.
    Validated Whether or not the MID Server was validated.
    Max memory used % The highest percent usage of memory on the system that hosts the MID Server, in the configured sampling interval. The default interval is 30 minutes, but this value is user configurable. See MID Server resource threshold alerts for details.
    Mean CPU used % The average percent usage of CPU on the system that hosts the MID Server, in the configured sampling interval. The default interval is 30 minutes, but this value is user configurable. See MID Server resource threshold alerts for details.
    Pending jobs Number of pending ECC queue jobs for that MID Server.
    Processing jobs Number of processing ECC queue jobs for that MID Server.
    Version The version of the MID Server. An icon indicates the validity of the MID Server:
    • Red: Incompatible. The MID Server and instance do not belong to the same release. You must upgrade the MID Server and verify that it is not pinned to an older version with the mid.version.override property. The MID Server will not be upgraded until the parameter is cleared.
    • Yellow: Compatible, but an upgrade is recommended. This indicates that the MID Server version belongs to the same family as the instance, but not the same version.
    • Green: Compatible. No upgrade necessary.
    • Gray: Incompatible. The instance cannot detect the version.
    User The login name of the user. An icon indicates the validity of the user:
    • Red: Incompatible. The user does not have themid_server role or the user does not match the value in the mid.instance.username parameter (in the config.xml configuration file). Reconfigure the MID Server user and verify that it works.
    • Green: Compatible. The user has the mid_server role and matches the user in the configuration file.
    Note:
    The user can also have any of the SOAP roles that the mid_server role inherits.