Skip to main content
Version Pentaho
Hitachi Vantara Lumada and Pentaho Documentation

Increase the Memory Limit in Report Designer

  1. Last updated
  2. Save as PDF

Pentaho Report Designer's startup script uses the default memory settings for your Java environment, which may be insufficient for your work. If you're experiencing an OutOfMemory exception, you must increase the amount of heap space available to Report Designer by changing the Java options that set memory allocation. Follow the directions below to accomplish this.

In the examples below, the memory size notations are m for megabytes and g for gigabytes. You can use whichever is most appropriate for your situation.

  1. Exit Report Designer if it is currently running.
  2. Edit the report-designer script and modify the value of -Xmx to allocate more memory to Report Designer's JVM instance.

    Linux/Solaris shell script:

    "$_PENTAHO_JAVA" "-Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH" -XX:MaxPermSize=256m -Xmx2g -jar "$DIR/launcher.jar" $@

    Windows batch file:

    set OPT="-XX:MaxPermSize=256m" "-Xmx2g"
  3. Start Report Designer and ensure that there are no memory-related exceptions.

The Java virtual machine instance that Report Designer uses now has access to more heap space, which should solve OutOfMemory exceptions and increase performance.