Configuring remote flags for the Web Services application

You can add parameters called flags to application server configuration files to specify certain parameters for your Web Services application.

Before you begin

Review the list of remote flags available to use for the Web Services application and select one to use to complete this task.
Table 1. Remote flags
Flag Value Description
-Dcom.ibm.rational.rpe.docgen.concurrentlimit A number

Example: -Dcom.ibm.rational.rpe.docgen.concurrentlimit=5

Set the maximum number of concurrent Rational® Publishing Engine document generation requests that can run at one time. If the limit is reached, the subsequent job requests are placed in a queue to start after the current jobs finish.
-Dcom.ibm.rational.rpe.remote.debug true, false

Example: -Dcom.ibm.rational.rpe.remote.debug=true

You can review more detailed log information for debugging document generation issues.
-Dcom.ibm.rational.rpe.remote.filestore A filepath that begins with \\

Example: -Dcom.ibm.rational.rpe.remote.filestore=\\storage\rpe\files

If you are configuring a load balancing environment, you can designate the location of the shared storage directory.
-Dcom.ibm.rational.rpe.remote.ignorelanguage true, false

Example: -Dcom.ibm.rational.rpe.remote.ignorelanguage=true

When set to true, the Web services application ignores the -Duser.country and -Duser.language flags set by the user and sets the default language specified for the server by the administrator.
-Dcom.ibm.rational.rpe.remote.javaopts Heap size

Example: -Dcom.ibm.rational.rpe.remote.javaopts=-Xmx1280m

You can increase the amount of memory allocated to generating documents by the Web Services application. The default value is -Xmx1024m.

If you are using a 32-bit Java™ Runtime Environment (JRE) for the Web Services application, you can adjust the heap size from 1 to 1.5 GB. If you are using a 64-bit JRE for the Web Services application, you can adjust the heap size to higher than 1.5 GB.

-Dcom.ibm.rational.rpe.remote.jre An absolute path to the Java Runtime Environment application files.

Example: -Dcom.ibm.rational.rpe.remote.jre=C:\Program Files\Java\jre7

You can specify a path to a Java Runtime Environment different from the one contained in the Rational Publishing Engine application files, which is located in %RPE_HOME%\jre.
-Dcom.ibm.rational.rpe.remote.jrearch 32 or 64 bits.

Example: -Dcom.ibm.rational.rpe.remote.jrearch=32

If Rational Publishing Engine does not detect the correct version of the Java Runtime Environment to run document generations, you can specify which version must be used.
-Dcom.ibm.rational.rpe.remote.rpecommandjar An absolute path to the rpecommand.jar file.

Example: -Dcom.ibm.rational.rpe.remote.rpecommandjar=C:\Program Files\Rational\Publishing Engine

If Rational Publishing Engine does not detect the correct the path to the rpecommand.jar, you can specify the path that must be used.
-Dcom.ibm.rational.rpe.remote.showconsole true, false.

-Dcom.ibm.rational.rpe.remote.debug must also be set to true.

Example:

-Dcom.ibm.rational.rpe.remote.showconsole=true
-Dcom.ibm.rational.rpe.remote.debug=true

Windows icon: You can open the detailed log information from com.ibm.rational.rpe.remote.debug in a separate console on Windows computers. Do not use this property if the application server is running as a Windows NT service.
-Dcom.ibm.rational.rpe.remote.workarea An absolute path that the user has write access to.

Example: -Dcom.ibm.rational.rpe.remote.workarea=C:\temp

The location where temporary files are created during document generation. If no path is specified, the temporary directory for the system is used.
-Dcom.ibm.ws.classloader.encodeResourceURLs true, false

-Dcom.ibm.rational.rpe.remote.debug must also be set to true.

Example:

-Dcom.ibm.ws.classloader.encodeResourceURLs=false
-Dcom.ibm.rational.rpe.remote.debug=true

Required only for WebSphere® Application Server 8. This flag prevents URLs from being encoded. When URLs are encoded by WebSphere Application Server 8, they cannot be read by Rational Publishing Engine.

About this task

You can configure one or more of the remote flags for these application servers:

WebSphere Application Server

Procedure

  1. Open the administrative console in a browser. Example: http://server:port/ibm/console/logon.jsp
  2. Expand Servers > Server Types.
  3. Click WebSphere application servers.
  4. Open the server properties by clicking the server_name.
  5. In the Server infrastructure section, expand Java and Process Management.
  6. Click Process definition.
  7. In the Additional Properties section, click Java Virtual Machine.
  8. In the Additional Properties section, click Custom properties.
  9. Click New to add the flag.
  10. In the Name field, enter the name of the flag you selected.
  11. From the name of the flag you copied, delete the -D from the beginning. For example, -Dcom.ibm.rational.rpe.flag becomes com.ibm.rational.rpe.flag.
  12. In the Value field, enter the parameter for the flag.
  13. Optional: Enter a description indicating the purpose of using the flag.
  14. Click OK.
  15. Restart the server.

Apache Tomcat

Procedure

  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 flag you selected and its corresponding value. Example:
    -Dcom.ibm.rational.rpe.flag=value
  5. Click OK.
  6. Restart Apache Tomcat.

Feedback