Remote flags reference for the Remote services application

Refer to this table for a list of the remote flags and Java™ properties that you can use in the Remote services application.
Select a flag from the list and then see the Configuring remote flags topic on WebSphere® Application Server or Apache Tomcat for information about using that flag.
Table 1. Remote flags
Flag Value Description
-Dcom.ibm.rational.rpe.docgen.concurentlimit A number

Example: -Dcom.ibm.rational.rpe.docgen.concurentlimit=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.license.attempts.count A number

Example: -Dcom.ibm.rational.rpe.license.attempts.count=2

The number of times to check for an available license. The default value is 1 time. If the value entered is less than 1, the value is ignored.
-Dcom.ibm.rational.rpe.license.retry.timeout A number in seconds

Example: -Dcom.ibm.rational.rpe.license.retry.timeout=6

The number of seconds to wait between attempts to check for an available license. The default value is 5 seconds.
-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 file path 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 that are set by the user and sets the default language that is 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 that is allocated to generating documents by the Remote services application. The default value is -Xmx1024m.

If you are using a 32-bit Java Runtime Environment (JRE) for the Remote services application, you can adjust the heap size from 1 to 1.5 GB. If you are using a 64-bit JRE for the Remote 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 that is 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 systems. 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.rational.rpe.ssl A security type:
  • SSL
  • SSLv2
  • SSLv3
  • TLS
  • TLSv1
  • TLSv1.1

Example: -Dcom.ibm.rational.rpe.ssl=TLSv1

When set to a specific security type, Rational Publishing Engine communicates only in that security type.

For TLS v1.2, configure the -Dcom.ibm.rational.rpe.tls12only flag instead. If both -Dcom.ibm.rational.rpe.tls12only and -Dcom.ibm.rational.rpe.ssl are configured, -Dcom.ibm.rational.rpe.tls12only takes precedence.

-Dcom.ibm.rational.rpe.tls12only true, false

Example: -Dcom.ibm.rational.rpe.tls12only=true

When set to true, Rational Publishing Engine communicates only in Transport Layer Security (TLS) 1.2 mode. Rational Publishing Engine does not check other Java Virtual Machine property settings to identify which Secure Sockets Layer (SSL) protocol is in use.

If both -Dcom.ibm.rational.rpe.tls12only and -Dcom.ibm.rational.rpe.ssl are configured, -Dcom.ibm.rational.rpe.tls12only takes precedence.

-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.

Feedback