Configuring run time and formatting flags for the Remote services application on Apache Tomcat

You can add properties called flags to the Remote services application files to specify certain parameters for your applications.

Before you begin

Review the list of run time and formatting flags available to use for the Remote services application, and then select one to use to complete this task.
Table 1. Run time and formatting flags
Flag Value Type Description
-Dcom.ibm.rational.rpe.config.oslcServiceProviders A full file path, UNC path, or HTTP location
Example:

-Dcom.ibm.rational.rpe.config.oslcServiceProviders=
C:\rpe\oslcServiceProviders.xml

Rational® Publishing Engine flag For configuring the OAuth-OSLC authentication method for Rational DOORS® Web Access data sources. You must enter valid base_url, consumer_key, and secret property values in the oslcServiceProviders.xml file specified for this flag. For more information see Creating oslcServiceProviders.xml file for OAuth-OSLC authentication and refer to the sample in the Rational Publishing Engine installation directory: %RPE_HOME%/config/oslcServiceProviders-sample.xml
-Dcom.ibm.rational.rpe.config.oslcServiceProviders.pwd String

Example: -Dcom.ibm.rational.rpe.config.oslcServiceProviders.pwd=password

Rational Publishing Engine flag The password required for performing OAuth-OSLC authentication with the -Dcom.ibm.rational.rpe.config.oslcServiceProviders flag.
-Dcom.ibm.rational.rpe.config.oslcServiceProviders.usr String

Example: -Dcom.ibm.rational.rpe.config.oslcServiceProviders.usr=user

Rational Publishing Engine flag The user name required for performing OAuth-OSLC authentication with the -Dcom.ibm.rational.rpe.config.oslcServiceProviders flag.
-Dcom.ibm.rational.rpe.disablecommands true, false

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

Rational Publishing Engine flag For additional security, you can set this flag to disable any pre-commands and post-commands from being executed by the Remote services application.
-Dcom.ibm.rational.rpe.mc.maxerrorcount A number

Example: -Dcom.ibm.rational.rpe.mc.maxerrorcount=

Rational Publishing Engine flag The number of times the client attempts to connect with the Monitor & Control component to list a document generation job. The default number of times is 3. Generally, if the server cannot be contacted after 6 consecutive attempts, then the server is probably down and the administrator must restart it.
-Dcom.ibm.rational.rpe.console.limit A number of characters

Example: -Dcom.ibm.rational.rpe.console.limit=90000

Rational Publishing Engine flag You can control the size of the log information kept in the console view. By default, the maximum size is set to 100000 characters.
-Dcom.ibm.rational.rpe.doors.data The data argument to pass to the Rational DOORS command line

Example: -Dcom.ibm.rational.rpe.doors.data=36677@localhost

Rational Publishing Engine flag You can include this flag to identify your Rational DOORS database so that Rational Publishing Engine does not have to identify it. Setting this value improves performance when your Rational DOORS is stable or your document generation is set up on a computer where running the reg.exe command is not permitted. When this flag is configured, it overrides the value specified for the doors_param property in a document specification. You can specify this flag as either a system or a Java™ Runtime variable. Java Runtime variables take precedence over system variables.

You must set new_instance property to true when configuring this flag.

-Dcom.ibm.rational.rpe.doors.flags Rational DOORS command-line options

Example: -Dcom.ibm.rational.rpe.doors.flags="-addins file path"

Rational Publishing Engine flag You can specify command-line options for Rational DOORS. You can specify this flag as either a system or a Java Runtime variable. Java Runtime variables take precedence over system variables.
-Dcom.ibm.rational.rpe.doors.home The path to the Rational DOORS executable file
Example:

-Dcom.ibm.rational.rpe.doors.home=
C:\Program Files (x86)\IBM\Rational\DOORS\9.5\bin\doors.exe

Rational Publishing Engine flag You can include this flag to identify your Rational DOORS version so that Rational Publishing Engine does not have to identify it. Setting this value improves performance when your Rational DOORS is stable or your document generation is set up on a virtual machine where running the reg.exe command is not permitted. When this flag is configured, it overrides the value specified for the doors_home property in a document specification. You can specify this flag as either a system or a Java Runtime variable. Java Runtime variables take precedence over system variables.

You must set new_instance property to true when configuring this flag.

-Dcom.ibm.rational.rpe.dxl.enable.memory.management true, false

Example: -Dcom.ibm.rational.rpe.dxl.enable.memory.management=true

Rational Publishing Engine flag

When a Rational DOORS module is linked to other modules, Rational Publishing Engine must open those linked modules in the background as a document generates. Also, when layout DXL code is used, modules are opened in the background until the DXL completes.

In both cases, Rational DOORS client memory is being used to open and close the modules in the background. You can configure a registry key so that when a memory limit is reached, the background processes close when they finish reading the current object and only reopen the object again if necessary.

When -Dcom.ibm.rational.rpe.dxl.enable.memory.management is set to true, users can set a registry key to define this memory limit, otherwise the default memory limit set in the DXL code of 2GB is used. See Troubleshooting a Rational DOORS document generation for more information about the registry key.

The default value is false and the registry key does not have an effect on the document generation process.

-Dcom.ibm.rational.rpe.nonunicodefonts A non-Unicode font name or several font names separated by semicolons.

Example: -Dcom.ibm.rational.rpe.nonunicodefonts=Akshar

Rational Publishing Engine flag You can specify fonts to use in Rational Publishing Engine that are not Unicode fonts. The non-Unicode fonts you specify must be installed on the same computer that the client applications are running on.

Non-unicode fonts do not always generate properly in Microsoft Word output. Set the font to Arial Unicode MS or any other font able to render this character and the output generates correctly.

-Dcom.ibm.rational.rpe.output.default A temp directory

Example: -Dcom.ibm.rational.rpe.output.default=C:\RPE\output

Rational Publishing Engine flag You can change the temporary directory to a different location from the default, which is %TEMP%\rpe\output. You can specify this flag as either a system or a Java Runtime variable. Java Runtime variables take precedence over system variables.
-Dcom.ibm.rational.rpe.pdf.truetypefontdirectory A directory or several directories separated by semicolons.
Example:

-Dcom.ibm.rational.rpe.pdf.truetypefontdirectory=
C:\Windows\Fonts;d:\fontlib

Rational Publishing Engine flag If the system has additional fonts installed in a non-default directory, you can specify these font directories.
-Dcom.ibm.rational.rpe.rpews.scheduler.pwd The user password to authenticate with the report scheduler.

Example: -Dcom.ibm.rational.rpe.rpews.scheduler.pwd=password

Rational Publishing Engine flag To authenticate with the report scheduler component of the Remote services application, configure this flag with a password.
-Dcom.ibm.rational.rpe.rpews.scheduler.url The URL to the report scheduler.
Example:

-Dcom.ibm.rational.rpe.rpews.scheduler.url=
http://server:port/rpews/scheduler

Rational Publishing Engine flag To authenticate with the report scheduler component of the Remote services application, configure this flag with a URL.
-Dcom.ibm.rational.rpe.rpews.scheduler.usr The user name to authenticate with the report scheduler.

Example: -Dcom.ibm.rational.rpe.rpews.scheduler.usr=user

Rational Publishing Engine flag To authenticate with the report scheduler component of the Remote services application, configure this flag with a user name.
-Dcom.ibm.rational.rpe.wstimeout Time in milliseconds

Example: -Dcom.ibm.rational.rpe.wstimeout=35000

Rational Publishing Engine flag The Launcher times out when creating complex document specifications that are configured to use a remote publishing engine. If you find that the client is timing out too soon, increase the timeout value. The default timeout value is 30000 milliseconds.
-Dcom.ibm.rational.rpews.pwd The user password to authenticate with the Remote services.

Example: -Dcom.ibm.rational.rpews.pwd=password

Rational Publishing Engine flag To authenticate with the Remote services application, configure this flag with a password.
-Dcom.ibm.rational.rpews.url A URL
Example:

-Dcom.ibm.rational.rpews.url=
http://server:port/rpews/

Rational Publishing Engine flag The URL to connect to the Remote services application. This URL might not be editable if the administrator does not permit users to change the location.
-Dcom.ibm.rational.rpews.usr The user name to authenticate with the Remote services.

Example: -Dcom.ibm.rational.rpews.usr=user

Rational Publishing Engine flag To authenticate with the Remote services application, configure this flag with a user name.
-Dosgi.configuration.area A file path
Example:

-Dosgi.configuration.area=@user.home/Application
Data/IBM/Rational/RPE_qualifier_date/Launcher/workspace/

Standard Java flag To change the default output location of your document generations, you can change the file path for this parameter. Specify the same value for the -Dosgi.instance.area and -Dosgi.configuration.area parameters.
-Dosgi.instance.area A file path
Example:

-Dosgi.instance.area=@user.home/Application
Data/IBM/Rational/RPE_qualifier_date/Launcher/workspace/

Standard Java flag To change the default output location of your document generations, you can change the file path for this parameter. Specify the same value for the -Dosgi.configuration.area and -Dosgi.instance.area parameters.
-Duser.country A country code
Example for Brazilian Portuguese:

-Duser.country=BR
-Duser.language=pt

Standard Java flag Set this flag to an abbreviation for a country that corresponds to your language code to set the locale for your document generations. It is only necessary to include -Duser.country when translations are available for the specific language it references when combined with -Duser.language.
-Duser.language A language code

Example for Japanese: -Duser.language=ja

Standard Java flag Set this flag to an abbreviation for a language to set the locale for your document generations. See HTML Language Code Reference for more examples of language codes.
-Duser.timezone GMT+offset

Example: -Duser.timezone=GMT+02:00

Standard Java flag Rational Publishing Engine converts the date and time to the time zone of the computer where Rational Publishing Engine is installed, not to the time zone of the server where the document is generating remotely. To specify the date and time to be that of the server, enter GMT and the number of hours offset the location of the server is from Greenwich Mean Time.
–Xmx<value>m The Java heap setting

Example: –Xmx512m

IBM® Java Runtime Environment flag Decrease the value for this parameter in the product configuration files to enable Rational Publishing Engine to start on virtual machines.

Increase the value to improve performance when generating large documents in other environments, not virtual machines.

–Xmx is a standard Java parameter that is not unique to Rational Publishing Engine.

TELELOGIC_LICENSE_FILE The license server value listed in the TELELOGIC_LICENSE_FILE system variable in the form of port@license_server_hostname_or_IP_address.

Example: 19353@LicenseServer2

Rational Publishing Engine flag A system variable that lists the address of the license server.

Procedure


Feedback