Introduction to Buildomatic Source Build Scripts

The JasperReports Server source code comes with a set of configuration and build scripts based on Apache Ant known as the buildomatic scripts. You'll find these scripts in the following directory:

<js-src>/jasperserver/buildomatic

The buildomatic scripts automate most aspects of configuring, building, and deploying the source code. Apache Ant is bundled into the source code distribution to simplify the setup.

Downloading and Unpacking JasperReports Server Source Code

Downloading the Source Archive

Unpacking the Source Archive

Unpack the jasperreports-server-6.1.0-src.zip file to a directory location, such as C: or /home/<user>. The resulting location is referred to as <js-src> in this document.

Source Code Package Structure

After you've unpacked the zip file, the folder directory has the following structure:

Check Apache Ant

The Apache Ant tool is bundled (pre-integrated) into the source code distribution package so you don't need to download or install Ant to run the buildomatic scripts. For example:

cd <js-src>/jasperserver/buildomatic

js-ant help   or

./js-ant help (Linux)

If you don't use the bundled version of Apache Ant, we recommend version 1.9.4 or later. Versions earlier than 1.8.1 are not compatible.

Configuring the Buildomatic Properties

The buildomatic scripts are found at the following location:

<js-src>/jasperserver/buildomatic

Use the buildomatic scripts to build the source code and configure settings for a supported application server and database. The file for configuring these settings is default_master.properties. The source distribution includes a properties file for each type of database. You'll add your specific settings to this file and rename it to:

default_master.properties

PostgreSQL

cd <js-src>/jasperserver/buildomatic

copy sample_confpostgresql_master.properties default_master.properties[/code]                    

cp sample_conf/postgresql_master.properties default_master.properties[/code]                    

appServerType=tomcat8 (or tomcat5/6/7, jboss/-as-7, glassfish2/3, skipAppServerCheck)[/code]                    

appServerDir = /home/<user>/apache-tomcat-7.0.26[/code]                    

maven = C:apache-maven-3.0.4binmvn.bat[/code]

maven = /home/<user>/apache-maven-3.0.4/bin/mvn[/code]                    

repo-path = C:jasperreports-server-6.1.0-srcjasperserver-repo[/code]

repo-path = /home/<user>/jasperreports-server-6.1.0-src/jasperserver-repo[/code]                    

MySQL

cd <js-src>/jasperserver/buildomatic

appServerDir = /home/<user>/apache-tomcat-7.0.26[/code]                    

maven = C:apache-maven-3.0.4binmvn.bat[/code]

maven = /home/<user>/apache-maven-3.0.4/bin/mvn[/code]                    

repo-path = C:jasperreports-server-6.1.0-srcjasperserver-repo[/code]

repo-path = /home/<user>/jasperreports-server-6.1.0-src/jasperserver-repo[/code]                    

Build Source Code

Now that you've set up your default_master.properties file, you can build the source code.

To build JasperReports Server:

After executing each Ant target in “Commands for Building JasperReports Server”, look for the message BUILD SUCCESSFUL.

Commands for Building JasperReports Server

Commands

Description

cd <js-src>/jasperserver/buildomatic

(Optional) Clears the buildomatic/build_conf/default directory.

Used for loading the databases

js-ant build-ce

Builds the community source code

js-ant build-pro

Builds the commercial source code

js-ant create-load-js-db-pro

(Optional) Creates and loads the jasperserver database, imports core bootstrap data

js-ant deploy-webapp-pro

(Optional) Deploys the jasperserver-pro war file to the application server

Set Java Options and jasperserver License

JasperReports Server needs Java memory options that are larger than the standard defaults. Additionally, a jasperserver.license is required to execute at runtime.

Set Increased JAVA_OPTS Settings

JasperReports Server needs greater heap and permgen memory settings for all functionality to operate. For testing your deployed JasperServer you should set your JAVA_OPTS to the same default values described in the JasperReports Server Installation Guide. For a 64-bit system the settings would be similar to the following:

Linux:

          export JAVA_OPTS="$JAVA_OPTS -Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m"[/code]        

Windows:

          set JAVA_OPTS=%JAVA_OPTS% -Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m [/code]        

You should add these settings to your application server startup script:

For details on setting Java memory options, please see Setting Java JVM Options.

Starting JasperReports Server

You can now start your application server or restart GlassFish. Your database should already be running.

Logging into JasperReports Server

You can now log into JasperReports Server through a web browser:

Enter the login URL with the default port number:

http://localhost:8080/jasperserver-pro

Log into JasperReports Server as superuser or jasperadmin:

User ID: superuser    Password: superuser

User ID: jasperadmin   Password: jasperadmin

If you're unable to log in or have other problems, refer to Troubleshooting, or the JasperReports Server Installation Guide, which provides additional troubleshooting information.

JasperReports Server Log Files

If you encounter any startup or runtime errors you can check the application server log files. For Apache Tomcat you'll find the log file here:

<tomcat>/logs/catalina.out

Also check the jasperserver.log file. You can increase the debug output level by editing the log4j.properties file.

The JasperReports Server runtime log is here:

<tomcat>/webapps/jasperserver-pro/WEB-INF/logs/jasperserver.log

The log4j.properties file is here:

<tomcat>/webapps/jasperserver-pro/WEB-INF/log4j.properties