Configuring run time and formatting flags for the client applications
Before you begin
| Flag | Value | Type | Description |
|---|---|---|---|
| -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.enable_commands | true, false Example: -Dcom.ibm.rational.rpe.enable_commands=true |
Rational Publishing Engine flag | Set this flag to true to enable any pre-commands and post-commands execution for the Document Builder application. |
| -Dcom.ibm.rational.rpe.console.limit | A number of characters Default value: 100000 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. |
| -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= |
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 Default value: 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.enable.surrogate.char.processing | true, false Default value: false Example: -Dcom.ibm.rational.rpe.enable.surrogate.char.processing=true |
Rational Publishing Engine flag | In Microsoft Word and PDF output, Unicode surrogates, which are often characters from Asian languages, are removed from the output. You can enable the -Dcom.ibm.rational.rpe.enable.surrogate.char.processing to process these characters correctly during document generation so that they are included in the output as expected. |
| -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 Default value: TEMP\rpe\output 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. 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= |
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.rpeng.cookies |
Example: -Dcom.ibm.rational.rpe.cookies= |
Rational Publishing Engine flag | Enter a secret cookie from Document Builder, for example rpeng-secret. You can use the rpeng/api/secret API to get the secret once successfully logged in. |
| -Dcom.ibm.rational.rpeng.pwd | The user password to authenticate with Document Builder Example: -Dcom.ibm.rational.rpeng.pwd=password |
Rational Publishing Engine flag | To authenticate with the Document Builder application, configure this flag with a password. |
| -Dcom.ibm.rational.rpeng.url | A URL Example:
-Dcom.ibm.rational.rpeng.url= |
Rational Publishing Engine flag | The URL to connect to the Document Builder application. This URL might not be editable if the administrator does not permit users to change the location. |
| -Dcom.ibm.rational.rpeng.usr | The user name to authenticate with Document Builder Example: -Dcom.ibm.rational.rpeng.usr=user |
Rational Publishing Engine flag | To authenticate with the Document Builder application, configure this flag with a user name. |
| -Dcom.ibm.rational.rpe.tls12only | true, false Example: -Dcom.ibm.rational.rpe.tls12only=true |
Rational Publishing Engine flag | 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. |
| -Dosgi.configuration.area | A file path Example:
-Dosgi.configuration.area=@user.home/Application |
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 |
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 |
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. |