Fixing out of memory errors

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 Document Studio application:
    1. Open the rpe-studio.ini configuration file with a text editor.
      The default location for the file is PUB_install_dir/studio/rpe-studio.ini.
    2. Locate the Java heap setting: -Xmx1024m
    3. Increase the value.
      On most systems, 1500 MB is the maximum value.
      Example: -Xmx1280m
    4. Save and close the file.
  • Increase the Java heap size for the Launcher application:
    1. Open the rpe-launcher.ini configuration file with a text editor.
      The default location for the file is PUB_install_dir/launcher/rpe-launcher.ini.
    2. Locate the Java heap setting: -Xmx1024m
    3. Increase the value.
      On most systems, 1500 MB is the maximum value.
      Example: -Xmx1280m
    4. Save and close the file.
  • Remove some of the tables from your template. For document-style reports with more than 15,000 data results and a large number of tables, IBM Engineering Lifecycle Optimization - Publishing (PUB) might display out of memory issues when generating the document-style reports into Microsoft Word and PDF outputs. If there are fewer tables in the template to process, PUB might be able to process the document-style reports 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:
    1. In the Document Specification view, select the Microsoft Word output.
    2. In the Properties view, locate the multipart property.
    3. 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 document-style report 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 PUB 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-style report generation. Use the STATIC value for templates that contain region elements.
    4. 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.
    5. Select all content by pressing Ctrl+A.
    6. 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-style report into chunks and generate them separately.