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 TIBCO Jaspersoft Platform Support Guide for supported versions: |
• | Apache Tomcat |
• | JBoss EAP or Wildfly |
4. | Locate or install the |
|
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.
|
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 TIB_js-jrs_7.9.0_bin.zip. Choose a destination, such as C:\Jaspersoft on Windows, /home/<user> on Linux, or /Users/<user> on Mac. |
The directory, TIB_js-jrs_7.9.0_bin, appears in the file location you choose.
2. | 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.
3. | Rename the file you copied to default_master.properties. |
4. | 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. |
Database |
Sample Property Values |
PostgreSQL |
appServerType=tomcat [jboss-eap-7, wildfly, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 9.0 dbHost=localhost dbUsername=postgres dbPassword=postgres |
MySQL |
appServerType=tomcat [jboss-eap-7, wildfly, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 9.0 dbUsername=root dbPassword=password dbHost=localhost |
appServerType=tomcat [jboss-eap-7, wildfly, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 9.0 dbUsername=jasperserver dbPassword=password sysUsername=system sysPassword=password dbHost=hostname |
|
Additional options for Oracle CDB with common users |
If you are using Oracle CDB and you want you want tuse 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
|
Additional options for Oracle CDB with common users and TIBCO driver |
If you are using the TIBCO driver for Oracles, use the settings for Oracle and Oracle CDB, and also set SupportLinks to true in the AddtionalAdminOptions section, for example: AdditionalAdminOptions=;SupportLinks=true
Do not set this property if you are using the vendor's Oracle driver. For more information, seehttp://media.datadirect.com/download/docs/jdbc/alljdbc/index.html#page/jdbcconnect/supportlinks.html |
DB2 |
appServerType=tomcat [jboss-eap-7, wildfly, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 9.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-7, wildfly, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 9.0 dbUsername=sa dbPassword=sa dbHost=localhost |
|
On Linux, if Tomcat is installed using apt-get, yum, or rpm, see Tomcat Installed Using apt-get/yum. |
5. | Run the js-install scripts: |
a. | Start your database server. |
b. | Stop your application server. |
c. | Open Command Prompt as Administrator on Windows or open a terminal window on Linux and Mac OSX. |
d. | Run the js-install script for the version and files 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, sample data, and sample databases (foodmart and sugarcrm) |
js-install.bat minimal (Windows) ./js-install.sh minimal (Linux and Mac OSX) |
Installs JasperReports Server, but not the sample data and sample databases |
If you encounter errors during the js-install script execution, see Error Running js-install Scripts (js-install.bat/sh).
6. | Set Java JVM Options (required), as described in Setting JVM Options for Application Servers. |
7. | Set up the license (required) as described in Setting Up the JasperReports Server License. |
|
To view the output log, look in: <js-install>/buildomatic/logs/js-install-<date>.log |
|
Installing JasperReports Server automatically generates encryption keys that reside on the file system. These keys are stored in a dedicated TIBCO TIBCO keystore. Make sure this keystore is properly secured and backed up, as described in the TIBCO JasperReports Server Security Guide. |
Installing Chrome/Chromium
You need to install and configure Chrome/Chromium to export the reports
For information about configuring Chrome/Chromium in JasperReports Server, see the TIBCO JasperReports Server Administrator Guide.