Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.

Install a MID Server on Windows

Log in to subscribe to topics and get notified when content changes.

Install a MID Server on Windows

Install MID Servers with the MID Server installation package and verify it is active. The package includes an installer that automatically configures OpenJDK to run in the environment. The MID Server can use an existing JRE rather than the provided OpenJDK. Uninstall the MID Server to redeploy it.

Before you begin

  • Verify that the host computer satisfies the MID Server system requirements.
  • Ensure that the Microsoft Application Experience Lookup Service is enabled on the MID Server host. If this service is disabled, the MID Server auto-upgrade might fail, causing the MID Server to go down. For information on managing issues with the Application Experience service, see KB0597552.

Role required: admin or mid_server

Set up indicator for installation phaseEnsure 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

About this task

OpenJDK version 1.8.0_181 is bundled with the MID Server installer package and is installed on the host for all new MID Servers. The installer automatically configures OpenJDK to run in your environment. No additional configuration is required. This version supports both 32-bit and 64-bit MID Servers. For the best performance, install the 64-bit MID Server for your operating system. The MID Server requires a minimum JRE version 1.8.0_161, and recommended version 1.8.0_181. If you are using a lower version than 1.8.0_161, you may see encryption related issues.
Note: ServiceNow will discontinue support for 32-bit MID Servers in a future release.
Upgraded MID Servers might use different Java versions depending on their release level.
  • MID Servers upgraded from Kingston and earlier use the OpenJDK provided with the MID Server installer. This version of the OpenJDK was tested and certified for use with these MID Servers.
  • MID Servers upgraded from London continue to use the same JRE you configured for London. The MID Server supports JRE 1.8.

Click this link to view the installation video:

Procedure

  1. Log in to the Windows host machine where you want to install the MID Server.
  2. Create a folder for the MID Server on the top level of the drive such as ServiceNow\MID Server1.
  3. Download the MID archive file into the new folder.
  4. Right-click the archive and select Extract All.
  5. Navigate to the service-now\<mid server name>\agent folder that was created when the file was extracted.
  6. Run installer.bat to start the MID Server installer.
    To configure the MID Server manually, skip to step 16.
  7. Use the installer to enter the following information.

    An example MID Server installation

    Field Description
    ServiceNow instance URL Enter the full URL of your instance, for example:

    https://mycompanyinstace.service-now.com

    ServiceNow MID Server username Enter the name of the MID Server user that you already created. The MID Server user must have the mid_server role.
    ServiceNow MID Server password Enter the password for the user in the ServiceNow MID Server username.
    Use proxy Select this check box if your MID Server communicates through a proxy to connect to the instance.
    Note: Your proxy server must use Basic Authentication for the MID server to connect to the instance.
    Proxy host Enter the proxy server host name or IP address. Do not include the protocol in the host name. For example, enter proxyserver.domain.com, not https://proxyserver.domain.com.
    Proxy port Enter the port through which the proxy server communicates. If you leave this field blank, it should use the proxy server's default port number.
    Proxy username Enter the user name that has administrator rights to the proxy server.
    Proxy password Enter the password for the user name.
  8. Click Test your connection to validate the credentials and instance information. If you encounter any errors, verify the information that you input.
  9. Click Next.
  10. Configure the MID name parameters (see table).

    MID parameters

    Field Description
    MID Server name Enter a MID Server name.
    Caution: MID Server names cannot begin with mid.server.
    MID Service wrapper name Modify this field if necessary. It is populated automatically by prefixing snc_mid_ to the MID Server name. In most cases, you do not need to modify this.
    MID Server wrapper display name Modify this field if necessary. It is populated automatically by prefixing ServiceNow MID Server_ to the MID Server name. In most cases, you do not need to modify this.
  11. Click Next to view the summary.
    Starting the MID Server
  12. Click Start MID Server.
    The local host starts the MID Server.
    Note: If the MID Server fails to start, the cause might be a duplicate name or multiple services that point to the same executable path. See MID Server fails to start for details.
  13. Click Mid Servers List Page.
    The installer opens the MID Server list from your instance.
  14. Select the MID Server name from the list.
    Note: It may take a few seconds for the MID Server time to establish a connection with your instance.
    The system displays the MID Server record.
  15. From Related Links, click Validate.
    The MID Server Validated changes to Yes.
  16. To configure the MID Server manually, edit the config.xml file with a text editor such as WordPad:
    1. Find the element <parameter name="url" value="https://YOUR_INSTANCE.service-now.com" /> element and change the value to the URL of your instance.
    2. Enter the MID user credentials in the mid.instance.username and mid.instance.password parameters.
      By default, the MID Server, uses basic authentication for SOAP messages. The password value is also encrypted authentication.
    3. (Optional) Find the <parameter name="name" value="YOUR_MIDSERVER_NAME_GOES_HERE" /> element and change the value for the MID Server name.
    4. (Optional) Enter connection information for the proxy server. Remove the appropriate comment tags from the proxy configuration information.
      For example, you can configure these parameters:
      • mid.proxy.use_proxy
      • mid.proxy.host
      • mid.proxy.port
      • mid.proxy.username
      • mid.proxy.password
  17. Start the MID Server and verify that it is active.
    1. In the MID Server home directory (agent), execute the batch file start.bat to start the new MID Server.
    2. Log into the instance and navigate to MID Server > Servers to verify that the Status of your new MID Server is Up.
      Additional log information appears here:
      • The MID Server log on the instance.
      • The corresponding agent0.log.0 and wrapper logs (wrapper.log) in the MID Server agent\logs folder.
  18. To stop the MID Server, use either of these procedures:
    • Windows command line: From the MID Server home directory (agent) run stop.bat.
    • Windows Services console: Right click ServiceNow <MID Server name>, and then select Stop.
  19. To restart a stopped MID Server, use either of these procedures:
    • Windows command line: In the MID Server home directory (agent),
    • Windows Services console: Right click ServiceNow <MID Server name>, and then select Start.

Configure Windows MID Server service credentials

MID Server service credentials are required to manage the MID Server service on the host machine, including its ability to successfully auto-upgrade.

About this task

By default, the MID Server service runs as a Local System account. This account has privileges to create and run the MID Server service and to download, create, and move files for the MID Server auto-upgrade process.

Windows service credentials are not the same as the MID Server user credentials, which allow communication between the MID Server and the instance. You must configure both of these credentials separately. See Create the MID Server user and grant the role for instructions on MID Server user credentials.

Attention: This procedure is optional. Allowing the MID Server service to run as a Local System account is sufficient for a majority of users.

Procedure

  1. Open the Windows Services console.
  2. Double-click the ServiceNow <MID Server name> service for each MID Server.
  3. Select the Log On tab.
  4. Set Log on as privileges with the user account (local or on a domain) that has local admin access to the MID Server host.
    The MID Server upgrade process deploys a temporary Windows service which requires local administrator privileges.
  5. In the General tab, set the Startup type.
    The field is set to Automatic by default.
  6. Click OK.
  7. Restart the ServiceNow <MID Server name> service, and make sure that ServiceNow\<MID Server name>\agent\logs\agent0.log does not have error messages. If the MID Server does not start, see the ServiceNow knowledge article Review the agent log for MID Server errors (article KB0535148).
  8. On the instance to which this MID Server is connected, navigate to MID Server > Servers. If Discovery is installed, alternately navigate to Discovery > MID Servers.

    All MID Servers connected to this instance are listed.

  9. Make sure that the Status of the MID Server you just installed is Up.

Manually install a MID Server as a Windows Service

If you did not start the MID server at the end of the installation procedure, you can manually install the MID Server to run as a Windows service.

Before you begin

Role required: admin

About this task

You can install a MID Server as a Windows service in these operating systems:
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016

Procedure

  1. Open the agent directory in the directory you created for the MID Server installation files. For example, the path might be C:\ServiceNow\MID Server1\agent.
  2. Right-click the start.bat file, and select Properties.
  3. Select the option to Run as administrator.
  4. Double-click the start.bat file to install the Windows service.

Configure a MID Server on Windows to use an existing JRE

You can choose to use an existing JRE for your MID Server rather than the OpenJDK provided with the MID Server installer.

Before you begin

Ensure that your JRE version is supported. See MID Server system requirements for details.

Role required: admin

About this task

By electing to use your own JRE, you are responsible for upgrading it as necessary. For a detailed procedure and cautions regarding changing the JRE, see KB0778272.

Procedure

  1. Navigate to this file in the MID Server installation directory:
    agent/conf/wrapper-override.conf
  2. To specify the existing Java executable that you want to use, add this line to the file:
    wrapper.java.command={your_java_executable}

    For more information, see the Java service wrapper property documentation.

  3. Save the file.

Uninstall a Windows MID Server

The MID Server runs as a stand-alone service. You can remove a stand-alone MID Server service to accommodate such tasks as redeploying the MID Server to another host machine or changing the unique name of a MID Server when deploying multiple MID Servers.

Before you begin

Role required: admin

Procedure

  1. Stop the running MID Server service, using either of these procedures:
    • Windows command line: From the MID Server home (agent) directory, run stop.bat.
    • Windows Services console: From the Windows Services console, right-click the ServiceNow MID Server name and then select stop.
  2. From a command prompt, go to the \agent\bin directory in the MID Server installation directory and double-click the UninstallMID-NT.bat file.
  3. Check the Windows Services console for a service named ServiceNow WMI Collector. If the service is running, open a command prompt, navigate to agent\bin\sw_wmi\tools, and double-click uninstall_wmi.bat

What to do next

Validate the MID Server to prepare it for use.
Feedback