If the Document Studio or the Launcher applications time
out with an out-of-memory error, you can adjust the Java™ heap parameters in the product configuration
files to improve performance.
Before you begin
Check your system hardware requirements to confirm that your
system can accommodate the increase in the Java heap size.
About this task
The default value for the heap size is 1 GB. Most systems
today can handle this value; however, if you are seeing the out of
memory error, you can increase this value up to 1.5 GB.
Procedure
- Increase the Java heap
size for the Remote services application:
- Complete the task Configuring remote flags for the Remote
services application on WebSphere® Application Server or Apache Tomcat by adding the -Dcom.ibm.rational.rpe.remote.javaopts flag
and increasing the heap size from the default setting of -Xmx1024m. Example: -Dcom.ibm.rational.rpe.remote.javaopts=-Xmx1280m
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. For generating large documents that
use all of the memory available despite an increased heap size, upgrade
to the 64-bit JRE to see a performance improvement when generating
these large documents.
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.
- Increase the Java heap
size for the Document Studio application:
- Open the rpe-studio.ini configuration
file with a text editor. The default location for the file
is RPE_HOME/studio/rpe-studio.ini.
- Locate the Java heap
setting: -Xmx1024m
- Increase the value. Check Sizing the Java heap for
information on selecting a value. On most systems, 1500 MB is the
maximum value. Example: -Xmx1280m
- Save and close the file.
- Increase the Java heap
size for the Launcher application:
- Open the rpe-launcher.ini configuration
file with a text editor. The default location for the file
is RPE_HOME/launcher/rpe-launcher.ini.
- Locate the Java heap
setting: -Xmx1024m
- Increase the value. Check Sizing the Java heap for
information on selecting a value. On most systems, 1500 MB is the
maximum value. Example: -Xmx1280m
- Save and close the file.
- Remove some of the tables from your template.
For documents with more than 15,000 data results and a large number
of tables, Rational® Publishing Engine might
display out of memory issues when generating the documents into Microsoft Word and PDF outputs.
If there are fewer tables in the template to process, Rational Publishing Engine might
be able to process the documents correctly without reducing the amount
of data contained in them.
- Remove any output formats that are not required
from the document specification.
- If you are generating Microsoft Word output, set the multipart property
in the document specification:
- In the Document Specification view, select the Microsoft Word output.
- In the Properties view, locate the multipart property.
- Enter one of the following values:
- STATIC: When set to STATIC,
the output is built when the entire report is serialized on the disk,
which means that the output is converted into a storable format across
a network. Large documents can be generated if the heap size is large
enough to accommodate the memory usage. Use STATIC when
you include region elements in your templates.
- DYNAMIC: When set to DYNAMIC, instead of
waiting until the entire report is serialized on the disk, the output
is built as Rational Publishing Engine processes
the input for each section that is divided by a section break element.
If you specify DYNAMIC to generate a template
that contains a region element, you might not see improved generation
performance. When a template contains a region element, the entire
template must still be serialized on the disk at the end of document
generation. Use the STATIC value for templates
that contain region elements.
- Save the document specification and generate the output.
When you open the Microsoft Word
output document, the file does not appear to have data in it.
- Select all content by pressing Ctrl+A.
- Update the fields by pressing Shift+F9.
- If you have tried all of these workarounds and still receive
the out of memory error, break your document into chunks and generate
them separately.