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

The MID Server installer automates the installation of a MID Server on a Windows computer.

Before you begin

Verify that the host computer meets the MID Server system requirements.

Role required: admin or mid_server

Important: The MID Server installer package does not include the Java Runtime Environment (JRE). You must install the JRE separately on each MID Server host before running the installer or verify that the correct version is already running on the host. If a supported version is present, ensure that the JAVA_HOME environment variable is pointed to that JRE or that java is available in the PATH environment.

No OpenJDK versions were tested for use with the MID Server in the London release.

About this task

You can install a MID Server on a 32-bit or 64-bit Windows computer. Ensure that your JRE version matches that of the MID Server you install, either 32-bit or 64-bit.

You can install one or more MID Servers on a supported Windows computer. For details on installing multiple MID servers, see Multiple MID Server deployments.

Click this link to view the installation video:

Procedure

  1. Verify that the MID Server host has the correct JRE installed.
    The supported JRE version required for the MID Server host is any version in the Java 1.8 family, later than 1.8.0_152. Java 9 and 10 families are not supported.
  2. If the MID Server host does not have the JRE installed or is running an unsupported version, download and install the correct version, and then configure either of the following:
    • Set the JAVA_HOME environment variable to point to a supported JRE.
    • Make java available in the PATH running environment.
  3. Log in to the Windows host machine where you want to install the MID Server.
  4. Create a folder for the MID Server on the top level of the drive such as ServiceNow\MID Server1.
  5. Download the MID archive file into the new folder.
  6. Right-click the archive and select Extract All.
  7. Navigate to the service-now\<mid server name>\agent folder that was created when the file was extracted.
  8. Run installer.bat to start the MID Server installer.
    To configure the MID Server manually, skip to this step.
  9. 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.
  10. Click Test your connection to validate the credentials and instance information. If you encounter any errors, verify the information that you input.
  11. Click Next.
  12. Configure the MID name parameters (see table).

    MID parameters

    Field Description
    MID Server name Enter any MID Server name.
    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.
  13. Click Next to view the summary.
    Installer screen
  14. Click Start MID Server.
    The local host starts the MID Server.
    When the MID Server service starts, it verifies that it is the only active (not down) MID Server with that name. If the MID Server discovers another active MID Server with the same name, the starting MID Server waits 5 minutes and sends another query. The MID Server repeats this query three times and logs each attempt in the agent log. If the MID Server still detects a duplicate after this cycle, it creates a record in the MID Server Issue [ecc_agent_issue] table and shuts itself down.
    Note: The record in the MID Server Issue [ecc_agent_issue] table cannot be resolved automatically by the instance. Close this record manually for accounting purposes. Either mark the issue Resolved or delete it.
  15. Click Mid Servers List Page.
    The installer opens the MID Server list from your instance.
  16. 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.
  17. From Related Links, click Validate.
    The MID Server Validated changes to Yes.
  18. 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
  19. 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 Servers > 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.
  20. 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.
  21. To restart a stopped MID Server, use any of these procedures:
    • In the instance, navigate to MID Servers > Servers and open the record for a Down server. Under Related Links, click Restart MID.
    • Windows command line: In the MID Server home directory (agent), run Restart.bat.
    • Windows Services console: Right click ServiceNow <MID Server name>, and then select Start.

What to do next

Configure MID Server parameters, which control several aspects of MID Server functionality, including proxy servers, debugging, and upgrade.

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.

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 one of these procedures:
    • Windows command line: From the MID Server home directory, for example from the agent folder, type 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.
  3. Double-click the UninstallMID-NT.bat file.
  4. Check in the Windows Services console for a service named ServiceNow WMI Collector. If it is running, open a command prompt, navigate to agent\bin\sw_wmi\tools, and double-click uninstall_wmi.bat
Feedback