--- sourceDocument: Yokohama ServiceNow AI Platform Capabilities sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/servicenow-platform Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama ServiceNow AI Platform Capabilities ft:clusterId : - platcap bundleId : - platcap workflow : - Platform --- # MID Server dashboard # MID Server dashboard {#ariaid-title1} Release version: Yokohama Updated January 30, 2025 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) 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 is a centralized interface for monitoring MID Server operations within ServiceNow. It consolidates reports and gauges drawn from the MID Server Status table, enabling users to track the health, performance, and activity of their MID Servers. Access is through theMID Server \> Dashboardmodule, with an enhanced dashboard available via the Discovery Admin Workspace for users with thediscoveryadminrole. Show full answer Show less To view the dashboard, users must have either the **midserver** or **admin** role, and group-based access respects standard role inheritance. ## Key Features * **Overview tab:** Visualizes MID Server statuses, validation issues, pending upgrades, and job activity, categorized by server capabilities. * **Performance tab:** Displays CPU and memory usage metrics along with lifecycle event history for each MID Server. * **Custom Performance tab:** Allows users to filter MID Servers based on custom selection criteria within specific time frames. * **MID Server Status gauge:** Presents essential information from the *eccagentstatus* table including server name, host, status, validation state, memory and CPU usage, pending and processing jobs, version, and user details. ## Version and Compatibility Indicators The dashboard uses color-coded icons to represent MID Server version compatibility: * **Red:** Incompatible version---MID Server must be upgraded, and any override parameters cleared. * **Yellow:** Compatible family but upgrade recommended. * **Green:** Fully compatible---no upgrade needed. * **Gray:** Version unknown or undetected by the instance. Note that an incompatible version may falsely show as active; users should verify version status for accurate MID Server health. ## User Validation User login names are validated against the MID Server configuration, with color-coded indicators: * **Red:** User lacks the **midserver** role or does not match the configured username, requiring reconfiguration. * **Green:** User is validated with the correct role and configuration. ## Practical Benefits for ServiceNow Customers * Centralized, real-time monitoring of MID Server health and performance helps ensure reliable discovery and integrations. * Role-based access controls maintain security while enabling appropriate visibility for administrators and discovery teams. * Performance metrics and status indicators support proactive troubleshooting and resource management. * Version and user validation alerts assist in maintaining compliance and operational integrity. ## Additional Resources The dashboard complements other MID Server management tasks such as starting/stopping servers, adjusting JVM memory, and handling upgrades. Customers are encouraged to refer to related documentation on system requirements, troubleshooting, parameters, and configuration best practices to optimize MID Server operations. 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. |-| | | [ ] {#c_MIDServerDashboard__table_jmp_fsf_khb} The MID Server Dashboard is available from the MID ServerDashboard module. After upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), you can navigate to WorkspacesDiscovery Admin WorkspaceInsights 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](https://www.servicenow.com/docs/cBGIaDZMBVnfQjODsR_gdg#t_SetupMIDServerRole "To communicate with the instance, MID Servers need a user ID and the appropriate role. Create the user ID for a MID Server and grant the ID the mid_server role. To prevent MID Server validation failure, the system runs business rules to monitor the settings selected for MID Server users.") ## MID Server Overview tab {#c_MIDServerDashboard__section_bkr_xvc_gyb} 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 Performance tab {#c_MIDServerDashboard__section_lvw_cwc_gyb} The Performance tab displays information relating to the MID Server CPU and memory usage, including the life-cycle event history. ## MID Server Custom performance tab {#c_MIDServerDashboard__section_otr_gwc_gyb} The Custom performance tab enables users to set custom MID Server selection criteria to show particular MID Servers in a select time frame. ## 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 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](https://support.servicenow.com/kb_view.do?sysparm_article=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](https://www.servicenow.com/docs/qT6fgXPWhBUgda1kcag3jg "MID Servers automatically upgrade to match the instance build the next time they communicate with the instance after an instance upgrade. Use this procedure only if you want to upgrade a MID Server immediately or retry the upgrade after an Upgrade failed status.") and verify that it is not pinned to an older version with the [mid.version.override](https://www.servicenow.com/docs/zVDyyReZ79sHQcd3DSHNJQ "You can pin all the MID Servers in your environment to a specific version by setting a system property, or you can configure specific versions for individual MID Servers.") 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. {#c_MIDServerDashboard__ul_vcc_5bk_xgb} {#c_MIDServerDashboard__table_ucv_ytv_xv__entry__2} | 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](https://www.servicenow.com/docs/7CRK9lFekoxJY4fHjsqvJw "You must manually validate the MID Server after it is installed to enable it to execute automation tasks. You can invalidate a MID Server you suspect has been compromised to prevent it from accessing automation credentials in the instance or executing outbound ECC probes."). | | 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](https://www.servicenow.com/docs/PT1QtXTlxTxLGwlCPQ2NRw "The instance displays warnings when a MID Server breaches its resource thresholds for CPU and JVM memory usage, enabling users to create email notifications or custom scripts when a breach occurs.") 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](https://www.servicenow.com/docs/PT1QtXTlxTxLGwlCPQ2NRw "The instance displays warnings when a MID Server breaches its resource thresholds for CPU and JVM memory usage, enabling users to create email notifications or custom scripts when a breach occurs.") 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](https://www.servicenow.com/docs/qT6fgXPWhBUgda1kcag3jg "MID Servers automatically upgrade to match the instance build the next time they communicate with the instance after an instance upgrade. Use this procedure only if you want to upgrade a MID Server immediately or retry the upgrade after an Upgrade failed status.") and verify that it is not pinned to an older version with the [mid.version.override](https://www.servicenow.com/docs/zVDyyReZ79sHQcd3DSHNJQ "You can pin all the MID Servers in your environment to a specific version by setting a system property, or you can configure specific versions for individual MID Servers.") 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. {#c_MIDServerDashboard__MID-Version} | | User | The login name of the user. An icon indicates the validity of the user: * Red: Incompatible. The user does not have the[mid_server role](https://www.servicenow.com/docs/cBGIaDZMBVnfQjODsR_gdg#t_SetupMIDServerRole "To communicate with the instance, MID Servers need a user ID and the appropriate role. Create the user ID for a MID Server and grant the ID the mid_server role. To prevent MID Server validation failure, the system runs business rules to monitor the settings selected for MID Server users.") or the user does not match the value in the [mid.instance.username parameter](https://www.servicenow.com/docs/cBGIaDZMBVnfQjODsR_gdg#t_SetupMIDServerRole "To communicate with the instance, MID Servers need a user ID and the appropriate role. Create the user ID for a MID Server and grant the ID the mid_server role. To prevent MID Server validation failure, the system runs business rules to monitor the settings selected for MID Server users.") (in the `config.xml` configuration file). Reconfigure the MID Server user and [verify that it works](https://www.servicenow.com/docs/cBGIaDZMBVnfQjODsR_gdg#t_SetupMIDServerRole "To communicate with the instance, MID Servers need a user ID and the appropriate role. Create the user ID for a MID Server and grant the ID the mid_server role. To prevent MID Server validation failure, the system runs business rules to monitor the settings selected for MID Server users."). * Green: Compatible. The user has the mid_server role and matches the user in the configuration file. {#c_MIDServerDashboard__UserConfig} Note: The user can also have any of the SOAP roles that the [mid_server role](https://www.servicenow.com/docs/cBGIaDZMBVnfQjODsR_gdg#t_SetupMIDServerRole "To communicate with the instance, MID Servers need a user ID and the appropriate role. Create the user ID for a MID Server and grant the ID the mid_server role. To prevent MID Server validation failure, the system runs business rules to monitor the settings selected for MID Server users.") inherits. | [ ] {#c_MIDServerDashboard__table_ucv_ytv_xv} **Related concepts** * [MID Server upgrades](https://www.servicenow.com/docs/0fmzqDHt0iEzymIrRBjJUA "Upgrade MID Servers manually, or automatically through the instance. MID Server automatic upgrade is triggered when the instance upgrades and the MID Server no longer has the same version. The new MID Server package is downloaded from install.service-now.com, replaces the old one, and the MID Server starts with the new version.") * [MID Server File Cleaner](https://www.servicenow.com/docs/UOs_PAj0ZzeS_1dGYhQ26A "A monitor thread runs in the MID Server to clean up old files, to keep the size and quantity of files within the install folder manageable, and to prevent performance issues with the MID Servers.") * [MID Server privileged commands](https://www.servicenow.com/docs/jHZdSShGx_wDoFToSvoktw#c_PrivilegedCommandsForMIDServer "To discover certain information on a host server, the MID Server must run SSH commands with higher privileges. The platform provides default privileged commands for the MID Server to use and the ability to add additional commands to the system.") **Related tasks** * [Manually start, stop, and restart a MID Server](https://www.servicenow.com/docs/IYs5fBPqVEOuqstZJckkXw "If you did not start the MID Server at the end of the installation procedure, you can manually start the MID Server.") * [Set the MID Server JVM memory size](https://www.servicenow.com/docs/KrWcjHIVVy4FOFmLc1ipGA "The MID Server starts with a default JVM memory allocation, but you can modify this setting in the configuration file.") * [Pause the MID Server](https://www.servicenow.com/docs/Q390rqi9OVkNNTzq97iJwA#t_PauseTheMIDServer "Pause the MID Server to temporarily prevent it from polling the ECC Queue for work or sending Discovery results back to the instance.") **Related reference** * [MID Server system requirements](https://www.servicenow.com/docs/4j~DXw_Cfdj1uyhyC10Muw "Use these minimum system requirements to allocate resources for computers hosting MID Servers.") * [Resolving MID Server issues](https://www.servicenow.com/docs/2mQkw_AXv_5F5KtFiT9UwA "Troubleshoot problems with the MID Server to find solutions. Monitor the MID Server to receive alerts about issues as they occur. Troubleshooting procedures exist to resolve specific problems with the MID Server. The Knowledge Base on Hi contains several articles to help you troubleshoot MID Server issues.") * [MID Server properties](https://www.servicenow.com/docs/kCZI01CdDboQJ~Alkf3MFg#r_MIDServerProperties "Properties control the behavior of all MID Servers or a particular MID Server.") * [MID Server parameters](https://www.servicenow.com/docs/9bf6AMU0YzFSeKaPniMXlQ#mid-server-parameters "Parameters control the behavior of a particular MID Server and have lower precedence than MID Server properties.") * [MID Server Configuration Parameter settings and priority](https://www.servicenow.com/docs/zmIKyIToc_JohWVTG6CHNQ "The MID Server's settings reside in multiple tables and the MID Server prioritizes them in a set order. MIDConfigParameter must be defined with the correct type-style builders.") * [MID Server protected records and reserved characters](https://www.servicenow.com/docs/R_UORSGTsWLLds5WDthYMg "Some MID Server records cannot be altered. Certain special characters are pre-defined in XML and cannot be used in passwords.") * [MIDSystem methods](https://www.servicenow.com/docs/8sGrXh3ukCa4vzdmJEPzVw "MIDSystem variables (referred to by the variable name ms.) provide a variety of methods to get information about the MID Server.") * [MID Server heartbeat](https://www.servicenow.com/docs/Cx2YLLAd_cUQAwGVk5QRIw "The instance checks the MID Server for a response every 5 minutes, using a synthetic transaction monitoring system.") *[\>]: and then