Configuring Tomcat server

Tomcat is no longer included with the Smart IT installer. You must use an existing Tomcat server while installing or upgrading Smart IT to version 20.02. While installing or upgrading to Smart IT 20.02 and onward versions, you must specify your Tomcat server details in the User Inputs > Specify Installed/Existing Tomcat folder section. 

To provide communication security among applications, configure SSL for the Apache Tomcat server. If you enabled SSL as part of installation, SSL is already configured. Otherwise, follow the procedure mentioned in this topic. 

Best practice

  • To protect data, use HTTPS to communicate to the Remedy with Smart IT (Smart IT) server. You can do so either through a load balancer or reverse proxy, or by enabling HTTPS on the Smart IT server.
  • Install Remedy with Smart IT and BMC Digital Workplace on separate Tomcat servers. If you want to install Remedy with Smart IT and BMC Digital Workplace on the same Tomcat server, see Smart-IT-troubleshooting.

Before you begin

Perform the Smart IT installation.


To configure SSL for the Tomcat server

For more information about creating a certificate, see http://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html.

Note

The self-signed certificate works only with the universal client. For mobile apps, you must use a signed certificate.

  1. Generate a self-signed certificate by running the following command:
    %JAVA_HOME%\bin\keytool -genkey -alias tomcat -keyalg RSA
    A .keystore file is generated in %USERPROFILE% (Windows) or $HOME (Linux), and the file is protected with a password.

    Note

    For signed certificate this step is not applicable. Use the keystore file provided by your certificate provider for a signed certificate.

  2. Place the generated file in the CATALINA_BASE/external-conf folder.

  3. Update CATALINA_BASE/conf/server.xml to enable HTTPS Connector:

    <Connector port="8443" protocol="org.apache.coyote.http11.Http11Protocol" SSLEnabled="true"
                  maxThreads="150" scheme="https" secure="true"
                  keystoreFile="${catalina.base}/external-conf/.keystore" keystorePass="Bmcmyit1"
                  clientAuth="false" sslProtocol="TLS"
      sslEnabledProtocols="TLSv1.2,TLSv1.1,SSLv2Hello"/>

    A sample server.xml file can be found in the bsmapps\main\server\external\tomcat\conf folder. 

  4. Restart the Tomcat server.
  5. To check the configuration, open https://localhost:8443/smartit/rest/version in a browser.
    Upon initial access, a warning about an non-trusted certificate appears (because this is a self-signed certificate, not generated by a trusted CA).
  6. Click OK to continue.


To move Smart IT application to a new Tomcat server

  1. Install new Tomcat with different port. If you need the same port then stop the existing Tomcat and then install the new Tomcat.
  2. Stop new Tomcat.
  3. Copy smartit.xml file from the old Tomcat conf/Catalina/localhost folder to a new Tomcat conf/Catalina/localhost folder.
  4. Copy sqljdbc4.jar, ojdbc6-11.2.0.4.jar, postgresql-42.2.1.jar and spring-tomcat-weaver-2.5.6.SEC03.jar files from the old Tomcat lib folder to a new Tomcat lib folder.
  5. Copy external-conf folder from the old Tomcat to a new Tomcat.
  6. Configure JVM related parameter:
    1. For Windows:
      1. Open the old Tomcat tomcatXw.exe file.
      2. Open the new Tomcat tomcatXw.exe file.
      3. Copy the Java options from the Java tab of the old Tomcat to the new Tomcat. You should replace the existing paths with the new Tomcat paths.
      4. Copy initial memory pool from the Java tab of the old Tomcat to the new Tomcat.
      5. Copy the maximum memory pool from the Java tab of the old Tomcat to the new Tomcat.
      6. Add <new-tomcat-path>/external-conf to Java ClassPath in the Java tab separated with semicolon. 
    2. For Linux:
      1. Copy the content of <old-tomcat-path>/bin/setenv.sh to <new-tomcat-path>/bin/setenv.sh. You should replace the existing paths with the new Tomcat paths.
  7. Manually re-configure SSL of the new Tomcat.
  8. Update File Deployer services:
    1. Open <SmartIT installation folder>/Smart_IT/filedeployer/conf/armonitor.cfg
    2. (Windows only) Update New Tomcat service name service-name = "xxxx"
    3. Update old Tomcat path with new Tomcat path in armonitor.cfg
  9. If you have rebranded Smart IT on the old Tomcat server, do the following:
    1. From the old Tomcat server, copy the style-smart-it.css file from the %TOMCAT_HOME%/webapps/tenant-custom-res/000000000000001 directory.
    2. Paste the style-smart-it.css  file on the new Tomcat server in the %TOMCAT_HOME%/webapps/tenant-custom-res/000000000000001 directory. If the directory does not exist create it. For more information on rebranding Smart IT, see Rebranding-Smart-IT-on-the-Universal-Client.
  10. Start Tomcat.


Note

If you stop the external Tomcat by using the shutdown.sh script, you may face a delay of 5 seconds in stopping the tomcat.


Where to go from here

Complete the remaining tasks for Configuring-after-installation.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*