Installing the WAR File Using js-install Scripts¶

Follow this procedure to install JasperReports Server using the WAR file distribution. The js-install shell scripts, supported on Windows, Linux, and Mac, do most of the work for you.

Prerequisites for installing the WAR file

1. Install a supported version of the Java Development Kit (JDK). See the TIBCO Jaspersoft Supported Platforms Datasheet document on the Documentation section of the Jaspersoft Community website for a list.
2. Create and set the JAVA_HOME system environment variable to point to the Java JDK location.

3. Locate or install one of the following application servers. See the Jaspersoft Platform Support Guide for supported versions:

4. Apache Tomcat

   • JBoss EAP or Wildfly (additional steps may be required for JBoss EAP or Wildfly. Please see Additional Steps for Using JBoss EAP, JBoss Web Server or Wildfly ).

     1. Locate or install the

        PostgreSQL, MySQL, Oracle, SQL Server, or DB2

        database. If you use DB2, follow the steps in Additional Steps for Using DB2 and js-install Scripts.

     Note

     The target database can be on a remote server. The application server should reside on the local machine.

     For an optional pre-install validation test, run js-install`` .bat/sh test. See js-install Script Test Mode for more information.

     To install the WAR file using js-install scripts

     The scripts are intended for the bash shell.

     Note

     If installing to non-Linux Unix platforms such as IBM AIX, FreeBSD, or Solaris, the bash shell is required for using the js-install scripts.

     1. Extract all files from

        js-jrs``_10.1.0

        _bin.zip. Choose a destination, such as:

   • On Windows: C:\Jaspersoft

   • On Linux: /home/<user>

   • On Mac: /Users/<user>

     The directory, on Linux_bin, appears in the file location you choose.

     1. Copy the <dbType>_master.properties file for your database from sample_conf and paste it to buildomatic:

   • Copy from: <js-install>/buildomatic/sample_conf/

   • Paste to: <js-install>/buildomatic

For example, if your database is PostgreSQL, copy postgresql_master.properties to <js-install>/buildomatic.

1. Rename the file that you copied to default_master.properties.

2. Edit the default_master.properties file to add the settings for your database and application server. Sample Values for the default_master.properties File lists sample property values for each supported database.

   Sample Values for the default_master.properties File

   Database	Sample Property Values
   PostgreSQL	appServerType=tomcat [jboss-eap-8, wildfly, skipAppServerCheck] appServerDir=c:\Program Files\Apache Software Foundation\Tomcat 11.0 dbHost=localhost dbUsername=postgres dbPassword=postgres
   MySQL	appServerType=tomcat [jboss-eap-8, wildfly, skipAppServerCheck] appServerDir=c:\Program Files\Apache Software Foundation\Tomcat 11.0 dbUsername=root dbPassword=password dbHost=localhost
   Standard Oracle options	appServerType=tomcat [jboss-eap-8, wildfly, skipAppServerCheck] appServerDir=c:\Program Files\Apache Software Foundation\Tomcat 11.0 dbUsername=jasperserver dbPassword=password sysUsername=system sysPassword=password dbHost=hostname dbVersion=oracleDbVersion (for example, 12, 19c, 21c, 23ai, 26ai and so on)
   Additional options for Oracle CDB with common users	If you are using Oracle CDB and you want to use a common Jaspersoft user, then use the settings for Oracle with the following changes: dbUsername=c##jasperserver sid=orclcdb If you are using sample databases: foodmart.dbUsername=c##foodmart sugarcrm.dbUsername=c##sugarcrm
   DB2	appServerType=tomcat [jboss-eap-8, wildfly, skipAppServerCheck] appServerDir=c:\Program Files\Apache Software Foundation\Tomcat 11.0 dbUsername=db2inst1 dbPassword=password dbHost=localhost If you use DB2, follow the steps in Additional Steps for Using DB2 and js-install Scripts
   SQL Server	appServerType=tomcat [jboss-eap-8, wildfly, skipAppServerCheck] appServerDir=c:\Program Files\Apache Software Foundation\Tomcat 11.0 dbUsername=sa dbPassword=sa dbHost=localhost
   Additional options for all databases	(Optional) jrws.deploy.webapps=true (Optional) jrws.repo.url=http://localhost:8080/repo (Optional) jrws.jrio.url=http://localhost:8080/jrio By default, JasperReports Web Studio applications are installed into the same application server as JasperReports Server, as configured in the appServerDir property. If you do not want to deploy the JasperReports Web Studio applications, set jrws.deploy.webapps=false. In that case the integrated JasperReports Web Studio stops working. From JasperReports Server, you can still view the Open in Editor option. This option must be disabled from the context menu. For steps on how to disable the Open in Editor option, refer to the JasperReports Server Administrator Guide. If you have already deployed JasperReports Web Studio on another server you can skip deploying it with JasperReports Server and just point to that remote applications by setting: jrws.deploy.webapps=false jrws.repo.url=http://<jasper-reports-webstudio-host>:8080/repo jrws.jrio.url=http://<jasper-reports-webstudio-host>:8080/jrio

   For the Split installation, configure the additional settings in the default_master.properties file as described in Additional Buildomatic Configuration for Split Installation Upgrade.

   Note

   When the property appServerType is set to skipAppServerCheck, buildomatic skips any application server validation.

   Backslashes in paths must be doubled in properties files, for example:
   appServerDir=C:\\Apache Software Foundation\\Tomcat 11.0.

   The dbUsername must be the same as the Oracle user name. In addition, buildomatic does with the “sys as sysdba” syntax.

   For Oracle without CDB with common users, do not use the c##jasperserver dbUsername. Use the standard jasperserver dbUsername instead.

   Note

   On Linux, if Tomcat is installed using apt-get, yum, or rpm, see Tomcat Installed Using apt-get/yum.

3. In case DB2, SQL Server or Oracle databases are used you must install the required JDBC driver. For steps to install, see Installing Database Vendor JDBC Drivers.

4. Run the js-install script:

   1. Start your database server.

   2. Stop your application server.

   3. Open Command Prompt as Administrator on Windows or open a terminal window on Linux and Mac OSX.

   4. Run the js-install script for the version and files that you want, as shown in the following table:

      Commands	Description
      cd <js-install>/buildomatic
      js-install .bat (Windows) ./js-install .sh (Linux and Mac OSX)	Installs JasperReports Server and JasperReports Web Studio, sample data, and sample databases (foodmart and sugarcrm)
      js-install .bat minimal (Windows) ./js-install .sh minimal (Linux and Mac OSX)	Installs JasperReports Server and JasperReports Web Studio, but not the sample data and sample databases

      If you encounter errors during the js-install script execution, see Error Running js-install Scripts (.bat/sh).

5. Set Java JVM Options (required), as described in Setting JVM Options for Application Servers.

6. Set up the license (required) as described in Setting Up the JasperReports Server License.

Installing Chrome/Chromium¶

You need to install and configure Chrome/Chromium to export the reports and dashboards to PDF and other output formats.

For information about configuring Chrome/Chromium in JasperReports Server, see the JasperReports Server Administrator Guide.