How to Set JVM Options for Jaspersoft Servers for Clarity PPM

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

How to Set JVM Options for Jaspersoft Servers: Java Virtual Machine (JVM) runtime parameters normally need to be explicitly set so that the memory settings have values that are larger than the default settings and required to achieve optimal performance.

Environment

Release: All supported Jaspersoft releases

Resolution

For Windows:

This only applies outside of Windows Service if you use startup.bat to start services

• Stop the Jaspersoft services 
• Navigate to Jaspersoft Installed folder cd <js-install>/apache-tomcat/bin/ and edit setenv.bat
• Look out for JAVA_OPTS and update the default parameters below:
  • SET "JAVA_OPTS=-Xms1024m -Xmx2048m -XX:PermSize=32m

Note: If you are using a Windows Service, follow the instructions here to set up Maximum Memory: Configuring Jaspersoft as a Windows Service

For Non Windows:

• Stop the Jaspersoft services 
• Navigate to Jaspersoft Installed folder  <js-install>/apache-tomcat/bin/ and edit setclasspath.sh
• Look out for JAVA_OPTS and update the default parameters below: 
  • SET "JAVA_OPTS=-Xms1024m -Xmx2048m -XX:PermSize=32m

You may set a higher memory, based on what free RAM your server OS has available

Additional Information

• The JVM allocation are already optimized on SAAS Systems so no changes are required
• Refer to Hardware Sizing for Jaspersoft Servers