Configuring Jaspersoft as a Windows Service

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

How to configure Jaspersoft as a Windows service?

Environment

Any Supported Jaspersoft releases with Clarity

Resolution

Prerequisites: It is necessary to have the correct Java executables referenced in the PATH environment variable.

1. Navigate to the bin folder inside the Tomcat folder.
2. Type "service install JasperReports", JasperReports being the name of the service, and execute it to create the service.
   

   

3. Edit the newly created service by executing "tomcat9w.exe //ES//JasperReports" from the above directory.
4. We see a service dialog open up. Navigate to the Java tab to edit the JVM configuration.
5. Add the below JVM parameters under section Java Options:
   -XX:MetaspaceSize=256m
   -Duser.home=C:\Users\Administrator
   
   • • Duser.home is the home folder of the user that was used to install Jaspersoft
     NOTE: The JVM parameters below in RED are no longer supported in Jaspersoft 9 with Java 17.0.x - if you are on an earlier Jaspersoft and Java version you may add them as well:
   • -XX:+UseConcMarkSweepGC
     -XX:+CMSClassUnloadingEnabled
   • Only use those for Jaspersoft 8.1.1 and earlier versions with earlier Java versions such as JDK 11 or else the server will not start as described here: Jaspersoft 9 does not run as Windows Service with Java 17.0.x
6. Specify values for Initial Pool Memory and Maximum Pool Memory. Thread stack size remains as 2048.
   

   

7. Apply the changes and launch the service from Windows services console.