Install CMS UI on an Existing Tomcat

  • KM03717372
  • 28-Sep-2020
  • 28-Sep-2020


This Document shows the steps to Install CMS UI on an Existing Tomcat


  • It is strongly recommended to secure the existing Tomcat installation. To do this, enable the HTTPS protocol, use the latest TLS, and use the latest ciphers.
  • The installation directory must not contain spaces, and can use only English letters (a-z), digits (0-9), the hyphen sign ('-'), and the underscore sign (_).

HTTP Protocol is disabled by default, and standalone CMS UI is no longer accessible with the HTTP protocol. However, if necessary, you can still enable HTTP communications by setting to False the following settings into the <Tomcat installation path>\conf\esapi\ file, and then restart the UCMDB Server:

  1. Download and install Apache Tomcat version 8.5.24

  2. Unzip the file CMS_UI-<display_version_number> to an accessible location.

  3. Go to the folder where you extracted the contents and in the ucmdb_browser_config.xml file (located at <CMS_UI_installation_folder>\conf), configure the connection to UCMDB as follows:

    • protocol. CMDB Server protocol
    • host_name. CMDB Server name
    • host_port. CMDB Server port
    • context_name. CMDB Server context name


      • If the root context has a default value “/” this setting can be omitted.
      • UCMDB and CMS UI must have the same protocol.
  4. Change the UCMDB integration user credentials. For information on how to change the UCMDB integration user credentials, see How to Change the UCMDB Integration User Credentials in the Related topics section.
  5. Update the context.xml file in the Tomcat conf folder to include the configuration files in the class path. It can be found under <Tomcat installation path>\conf\context.xml.

    Add under the <context> tag:

    <Environment name="ucmdb_browser_home" value="<folder path of the UCMDB_Browser_installation_folder>" type="java.lang.String" override="false"/>

    For example:

    <Environment name="ucmdb_browser_home" value="C:\ucmdb-browser-install\" type="java.lang.String" override="false"/>

    Note The conf folder should not be part of the path setting for value, as shown in the example above.

  6. Place the .war files under the webapps folder of Tomcat (located at <Tomcat installation path>\webapps).

  7. Start the Tomcat server.

  8. Go to http://<server name>:<tomcat port>/ucmdb-browser.