Deploying the monitor and control servlet on Apache Tomcat

Deploy the monitor and control servlet .war file on an Apache Tomcat server using these steps.

Before you begin

You must install Apache Tomcat and Rational® Publishing Engine with the monitor and control servlet feature before you can deploy the monitor and control servlet.

Procedure

  1. Open the Apache Tomcat Manager in a browser: http://server:port/manager/html. Example: http://localhost:8080/manager/html.
  2. In the Deploy section, enter the details for the rpemc.war file.
    • If the .war file is on a different server than Apache Tomcat, enter the following information in the Deploy directory or WAR file located on server section:
      1. Context Path: Enter /rpemc as the name for the monitor and control servlet application. This entry is a part of the URL used for configuring the client.
      2. XML Configuration file URL: You are not required to enter a value in this field.
      3. WAR or Directory URL: The path to rpemc.war. Example: %RPE_HOME%\web services\rpemc\rpemc.war
    • If the .war file is on the same server as Apache Tomcat, enter the following information in the WAR file to deploy section:
      1. Select WAR to upload: The path to rpemc.war. Example: %RPE_HOME%\web services\rpemc\rpemc.war
  3. Click Deploy.
  4. Create Apache Tomcat users and roles for the monitor and control servlet.
    1. Open the tomcat-users.xml file, which is located by default in $CATALINA_HOME\conf\tomcat-users.xml.
    2. Add the rpe_mc_client and rpe_mc_admin roles.
      <role rolename="rpe_mc_client"/>
      <role rolename="rpe_mc_admin"/>
    3. Add at least one administrator and one client user. Assign the administrator both roles and the client user the rpe_mc_client role. For example:
      <user username="rpe_admin" password="password" roles="rpe_mc_admin,rpe_mc_client"/>
      <user username="rpe_client" password="password" roles="rpe_mc_client"/>
    4. Optional: Add additional users. Example:
      <user username="user1" password="password" roles="rpe_mc_client"/>
  5. Set these Java Options in Apache Tomcat.
    1. In the Apache Tomcat application files, right-click the startup file you use to start the server.
    2. Click Properties.
    3. Select the Java tab.
    4. In the Java options field, enter the following options:
      -Dcom.ibm.rational.rpe.mc.url=http://host:port/rpemc/service
      -Dcom.ibm.rational.rpe.mc.user=rpe_client
      -Dcom.ibm.rational.rpe.mc.password=password
    5. Click OK.
  6. Restart Apache Tomcat.

Results

After you complete the deployment, the monitor and control servlet administration console is available at: http://server:port/rpemc/ui/index.html. See Managing document generation jobs in the monitor and control servlet for information on using the administration console.

What to do next

On the end user computers, specify the URL of the monitor and control servlet for a remote server. See Setting monitor and control servlet preferences.


Feedback