Configuring run time and formatting flags for the client applications
You can add properties called flags to the Launcher and Document Studio configuration files to specify certain parameters for your applications.
Before you begin
| Flag | Value | Type | Description |
|---|---|---|---|
-Dcom.ibm.rational.rpe.config.oslcServiceProviders.pwd |
String Example:
|
PUB 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:
|
PUB flag | The username required for performing OAuth-OSLC authentication with the
-Dcom.ibm.rational.rpe.config.oslcServiceProviders flag. |
-Dcom.ibm.rational.rpe.enable_commands |
true, false Example:
|
PUB flag | Set this flag to true to enable any pre-commands and post-commands execution for the Publishing Document Builder application. |
-Dcom.ibm.rational.rpe.console.limit |
A number of characters Default value: 100000 characters Example:
|
PUB flag | You can control the size of the log information that is kept in the console view. |
-Dcom.ibm.rational.rpe.desktop.release_license_idle_timeout |
Default value: 1800 seconds (30 minutes) |
PUB flag | Set the time period in which the license will time out if Launcher or Document Studio is open and unused without a document-style report generation job in progress. |
-Dcom.ibm.rational.rpe.doors.data |
The data argument to pass to the DOORS®
command line. Example:
|
PUB flag | You can include this flag to identify your PUB database
so that (PUB) does
not have to identify it. Setting this value improves performance when your Engineering Requirements
Management DOORS is
stable or your document-style report 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 that is 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 |
DOORS
command-line options Example: |
PUB flag | You can specify command-line options for 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 DOORS
executable file Example: -Dcom.ibm.rational.rpe.doors.home= |
PUB flag | You can include this flag to identify your DOORS
version so that PUB does not
have to identify it. Setting this value improves performance when your DOORS is
stable or your document-style report 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 that is 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:
|
PUB flag |
When a IBM Engineering Requirements Management DOORS module is linked to other modules, IBM Engineering Lifecycle Optimization - Publishing (PUB) must open those linked modules in the background as a document-style report generates. Also, when layout DXL code is used, modules are opened in the background until the DXL completes. In both cases, 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 The default value is false and the registry key does not have an effect on the document-style report generation process. |
-Dcom.ibm.rational.rpe.enable.surrogate.char.processing |
true, false Default value: false Example:
|
PUB 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-style report generation so that they are included
in the output as expected. |
-Dcom.ibm.rational.rpe.html_toc_level |
A number of characters Example:
|
PUB flag | PUB supports unlimited table of contents levels for HTML documents. To enable the higher number of levels, set the value by using this parameter in the .ini file. The higher table of contents levels is supported for both HTML split and nonsplit documents. When HTML split is used, the breadcrumbs also support multiple levels. |
-Dcom.ibm.rational.rpe.nonunicodefonts |
A non-Unicode font name or several font names separated by semicolons.
Example:
|
PUB flag | You can specify fonts to use in PUB 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. Nonunicode fonts do not always generate properly in Microsoft Word output. Set the font to |
-Dcom.ibm.rational.rpe.output.default |
A temp directory Default value: TEMP\rpe\output Example:
|
PUB 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 that are separated by semicolons.
Example: -Dcom.ibm.rational.rpe.pdf.truetypefontdirectory= |
PUB flag | If the system has additional fonts that are installed in a nondefault directory, you can specify these font directories. |
-Dcom.ibm.rational.rpeng.cookies |
Example: |
PUB flag | Enter a secret cookie from Publishing 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 Publishing Document
Builder Example:
|
PUB flag | To authenticate with the Publishing Document Builder application, configure this flag with a password. |
-Dcom.ibm.rational.rpeng.url |
A URL Example: -Dcom.ibm.rational.rpeng.url= |
PUB flag | The URL to connect to the Publishing 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 to authenticate with Publishing Document
Builder Example: |
PUB flag | To authenticate with the Publishing Document Builder application, configure this flag with a username. |
-Dcom.ibm.rational.rpe.tls12only |
true, false Example:
|
PUB flag | When set to true, PUB communicates only in Transport Layer Security (TLS) 1.2 mode. PUB 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
Data/IBM/PUB_qualifier_date/Launcher/workspace/ |
Standard Java flag | To change the default output location of your document-style report 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/PUB_qualifier_date/Launcher/workspace/ |
Standard Java flag | To change the default output location of your document-style report 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-style report 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:
|
Standard Java flag | Set this flag to an abbreviation for a language to set the locale for your document-style report generations. See HTML Language Code Reference for more examples of language codes. |
-Duser.timezone |
GMT+offset Example:
|
Standard Java flag | PUB converts the date and time to the time zone of the computer where PUB is installed, not to the time zone of the server where the document-style report 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 PUB to start
on virtual machines. Increase the value to improve performance when generating large document-style reports in other environments, not virtual machines. –Xmx is a standard Java parameter that is not unique to PUB. |
DGAAS_CONCURRENT_LIMIT |
The maximum number of users to perform concurrent document-style report generation. Default
value: |
PUB flag | (Optional) If you want to perform concurrent
document-style report generation by using the Publishing Document
Builder,
specify a number that is the maximum limit of users. If you are deploying the
|
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:
|
PUB flag | A system variable that lists the address of the license server. |
-DENABLE_ALTER_TABLE |
true, false Example:
|
PUB flag | Set the ENABLE_ALTER_TABLE flag to enable PUB
Publishing Document
Builder
to alter tables in the database when it launches. The PUB
Publishing Document
Builder
performs the alterations based on the values of other flags such as
MAX_DOCUMENT_SIZE_ALLOWED. |
-DMAX_DOCUMENT_SIZE_ALLOWED |
A number of characters Example:
-DMAX_DOCUMENT_SIZE_ALLOWED=52428800Note: The above value is in
bytes, which is equivalent to 50 MB. Set the appropriate value based on requirement.
|
PUB flag | Set the MAX_DOCUMENT_SIZE_ALLOWED flag to specify the maximum
size of large object column in the database table that stores the generated output. This flag must
be used with the ENABLE_ALTER_TABLE flag. |