Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home London Platform Capabilities Now Platform capabilities MID Server MID Server installation Install a MID Server on Linux

    Install a MID Server on Linux

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Install a MID Server on Linux

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

    Before you begin

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

    Role required: admin, 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.

    The supported JRE version required for the MID Server host is any version in the Java 1.8 family, 1.8.0_152 or later. Java 9 and 10 families are not supported.

    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 Linux computer. Ensure that your JRE version matches that of the MID Server you install, either 32-bit or 64-bit.

    Click this link to view the installation video:

    Procedure

    1. Verify that the MID Server host has the correct JRE installed.
    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. From the Linux command line, type mkdir -p /servicenow/mid server name to create the installation directory. You need to have read/write/execute permissions on this folder.
    4. Extract the downloaded MID Server archive file, mid.os.zip into the servicenow/mid server name/ directory. Use the MID Server name created in the instance or create a new name that you will use for this MID Server moving forward.
      The resulting directory structure is /servicenow/<mid server name>/agent.
    5. Change to the servicenow/mid server name /agent directory, and enter the following command to start the MID Server installer: ./installer.sh.
      If you prefer to manually configure the MID Server instead, skip to this step.
    6. 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 user 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.
    7. Click Test your connection to validate the credentials and instance information. If you encounter any errors, verify the information that you input.
    8. Click Next.
    9. Configure the MID name parameters (see table).

      Configure MID name parameters

      Table 1.
      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.
    10. Click Next to view the summary.
      Installer screen
    11. 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.
    12. Click Mid Servers List Page.
      The installer opens the MID Server list from your instance.
    13. 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.
    14. From Related Links, click Validate.
      The MID Server Validated changes to Yes.
    15. To configure the MID Server manually, change to the servicenow/mid server name /agent directory, and then edit the config.xml file as follows:
      1. Find the element <parameter name="url" value="https://YOUR_INSTANCE.service-now.com" /> 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. 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
    16. Start the MID Server and verify that it is active.
      1. In the MID Server home directory (agent), execute the shell script start.sh to start the new MID Server.
      2. Log into the instance and navigate to MID Servers > Servers to verify that your new MID Server has a Status or 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.
    17. To configure the MID Server to restart automatically when the host is restarted, run ${base_install_dir}/agent/bin/mid.sh install as root.
      This command installs the MID Server as a daemon service and adds the auto start scripts to the init.d directory.
      Note: You cannot install more than one MID Server service as a daemon on a Linux host. This is a limitation of the Tanuki wrapper service.
    18. To stop the MID Server, navigate to the MID Server home (agent) directory and execute the stop.sh shell script.
    19. To restart a stopped MID Server, navigate to the MID Server home (agent) directory and execute the restart-service.sh script, using one of these commands:
      • ./restart-service.sh
      • sh restart-service.sh
      • bash restart-service.sh

    What to do next

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

    Uninstall a Linux 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. From the MID Server home directory (agent directory) type stop.sh.
    2. From a command prompt, go to the \agent\bin directory in the MID Server installation directory.
    3. Confirm that the MID Server is stopped by executing the bin/mid.sh status shell script.
    4. After the MID Server stops, delete the files in the agent directory.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Install a MID Server on Linux

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Install a MID Server on Linux

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

      Before you begin

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

      Role required: admin, 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.

      The supported JRE version required for the MID Server host is any version in the Java 1.8 family, 1.8.0_152 or later. Java 9 and 10 families are not supported.

      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 Linux computer. Ensure that your JRE version matches that of the MID Server you install, either 32-bit or 64-bit.

      Click this link to view the installation video:

      Procedure

      1. Verify that the MID Server host has the correct JRE installed.
      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. From the Linux command line, type mkdir -p /servicenow/mid server name to create the installation directory. You need to have read/write/execute permissions on this folder.
      4. Extract the downloaded MID Server archive file, mid.os.zip into the servicenow/mid server name/ directory. Use the MID Server name created in the instance or create a new name that you will use for this MID Server moving forward.
        The resulting directory structure is /servicenow/<mid server name>/agent.
      5. Change to the servicenow/mid server name /agent directory, and enter the following command to start the MID Server installer: ./installer.sh.
        If you prefer to manually configure the MID Server instead, skip to this step.
      6. 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 user 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.
      7. Click Test your connection to validate the credentials and instance information. If you encounter any errors, verify the information that you input.
      8. Click Next.
      9. Configure the MID name parameters (see table).

        Configure MID name parameters

        Table 1.
        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.
      10. Click Next to view the summary.
        Installer screen
      11. 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.
      12. Click Mid Servers List Page.
        The installer opens the MID Server list from your instance.
      13. 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.
      14. From Related Links, click Validate.
        The MID Server Validated changes to Yes.
      15. To configure the MID Server manually, change to the servicenow/mid server name /agent directory, and then edit the config.xml file as follows:
        1. Find the element <parameter name="url" value="https://YOUR_INSTANCE.service-now.com" /> 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. 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
      16. Start the MID Server and verify that it is active.
        1. In the MID Server home directory (agent), execute the shell script start.sh to start the new MID Server.
        2. Log into the instance and navigate to MID Servers > Servers to verify that your new MID Server has a Status or 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.
      17. To configure the MID Server to restart automatically when the host is restarted, run ${base_install_dir}/agent/bin/mid.sh install as root.
        This command installs the MID Server as a daemon service and adds the auto start scripts to the init.d directory.
        Note: You cannot install more than one MID Server service as a daemon on a Linux host. This is a limitation of the Tanuki wrapper service.
      18. To stop the MID Server, navigate to the MID Server home (agent) directory and execute the stop.sh shell script.
      19. To restart a stopped MID Server, navigate to the MID Server home (agent) directory and execute the restart-service.sh script, using one of these commands:
        • ./restart-service.sh
        • sh restart-service.sh
        • bash restart-service.sh

      What to do next

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

      Uninstall a Linux 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. From the MID Server home directory (agent directory) type stop.sh.
      2. From a command prompt, go to the \agent\bin directory in the MID Server installation directory.
      3. Confirm that the MID Server is stopped by executing the bin/mid.sh status shell script.
      4. After the MID Server stops, delete the files in the agent directory.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login