Runtime and formatting flags reference for the client or Web Services applications

You can refer to this list of flags and Java™ properties available to use in the Web Services application, Document Studio, and Launcher.
Select a flag from the list below and then see Configuring runtime and formatting flags for the Web Services application or Configuring runtime and formatting flags for the client applications for information on using that flag.
Table 1. Runtime and formatting flags
Flag Value Description
-Dcom.ibm.rational.rpe.disablecommands true, false

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

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

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

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.mc.url A URL.

Example: -Dcom.ibm.rational.rpe.mc.url=http://host:port/rpemc/service

The URL for logging into the Monitor & Control component to manage document generation jobs.
-Dcom.ibm.rational.rpe.mc.user An ID for a user.

Example: -Dcom.ibm.rational.rpe.mc.user=rpe_client

The user ID for logging into the Monitor & Control component to manage document generation jobs.
-Dcom.ibm.rational.rpe.mc.password A password for the user ID.

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

The password for logging into the Monitor & Control component to manage document generation jobs.
-Dcom.ibm.rational.rpe.console.limit A number of characters.

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

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

You can include this flag to enable Rational Publishing Engine to identify your Rational DOORS database. 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.
-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

You can include this flag to enable Rational Publishing Engine to identify your Rational DOORS version. 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.
-Dcom.ibm.rational.rpe.nonunicodefonts A non-Unicode font name or several font names separated by semicolons.

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

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.pdf.truetypefontdirectory A directory or several directories separated by semicolons.

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

If the system has additional fonts installed in a non-default directory, you can specify these font directories.
-Dcom.ibm.rational.rpe.word.multipart STATIC or DYNAMIC

Example: -Dcom.ibm.rational.rpe.word.multipart=DYNAMIC

Breaks Microsoft Word documents into chunks to reduce the size of memory being used at one time to generate the document. When set to STATIC, the output is built when it is serialized, converted into a storable format across a network, on the disk. Large documents can generated if the heap size is large enough to accommodate the memory usage.

When set to DYNAMIC, the output is built as Rational Publishing Engine processes the input for each section divided by a section break element. Sections that contain region elements are serialized on the disk at the end of document generation.

-Dcom.ibm.rational.rpews.url A URL

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

The URL to connect to the Web Services application. This URL might not be editable if the administrator does not permit users to change the location.
-Dosgi.configuration.area A filepath

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

To change the default output location of your document generations, you can change the filepath for this parameter. Specify the same value for the -Dosgi.instance.area and -Dosgi.configuration.area parameters.
-Dosgi.instance.area A filepath

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

To change the default output location of your document generations, you can change the filepath 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

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

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

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

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

A system variable that lists the address of the license server.

Feedback