Jaspersoft Internal Developers and Advanced Developers

This chapter is for Jaspersoft Internal Developers and for Advanced Developers who want to use some of the additional options available through the buildomatic property settings.

Internal Developers and Advanced Developers

As of Release 4.7, Jaspersoft has setup an internal Maven repository using the Artifactory server software. This repository holds all third party components required to build the source code. It also acts as a proxy for the standard public Maven repositories such as repo1.maven.org.

This internal repository is convenient for internal Jaspersoft developers because the developer can point to one location to get all dependencies resolved.

In default_master.properties, internal developers should comment out maven.build.type=repo and repo-path=<path>:

# maven.build.type=repo

# repo-path=<path>

External developers (customers) who download the jasperreports-server-<ver>-src.zip package from jaspersoft.com should set all the properties described in Configuring the Buildomatic Properties before building JasperReports Server.

Additional buildomatic property settings are available for advanced external developers. If you're an external developer working within an enterprise or on a project that has an internal Maven repository server, you can use the mirror value. The following property settings and values will enable a local Maven repository:

maven.build.type=mirror

mvn-mirror=<repo-url>

If you're an external developer with other build configurations to add, you can do this with the maven.build.type=custom property setting. If you set this value, the following file will be used as the template to set up the JasperReports Server build configuration:

<js-path>/buildomatic/conf_source/templates/maven_settings_custom.xml

You can edit this file to add whatever configurations you want.

When buildomatic auto-setup is complete, you can see the final maven settings file used for the JasperReports Server here:

<js-path>/buildomatic/build_conf/default/maven_settings_custom.xml

Additional Properties in default_master.properties

You can use the properties in the table below for various customizations of the JasperReports Server build:

Property Setting

Purpose

SKIP_TEST_ARG=skipTests

Enable this property to skip unit test execution. This will speed the source build.

VERBOSE_LOGGING=true

Enable this property to increase the INFO logging from the Maven package. Maven is a verbose build tool, and as of Release 5.1 the logging level for JasperReports Server builds has been decreased.

OFFLINE_ARG=-o

Enable this property if you want to build in “offline” mode. To run in offline mode you need to have successfully built JasperServer at least once.

SKIP_EXPORT_FILES=true

Enable this property to skip the copying of files that set up the command line import-export configuration. This saves time on file copying.

maven.build.type=repo

Use this setting for the build type if you've downloaded the source code zip package from the jaspersoft.com site, and you're building the source code as a customer (external developer) would build it. You'll also need to set the repo-path property. maven.build.type=repo is the default value used in the sample <dbType>_master.properties files.

maven.build.type=community

Use this setting for the build type if you're building only the Community source code. This setting supports Community members who have checked out JasperReports Server source code from the Community site:

code.jaspersoft.com/svn/repos/jasperserver

maven.build.type=mirror

If you're an external developer who has a central Maven style repository for your enterprise or project, you can use this setting to specify the local central repository. If you set this property value, you should also set the mvn-mirror property.

maven.build.type=custom

If you're an external developer whose build requires additional configurations, you can use this property value to support them. In this case, use the following template file:

<js-path>/buildomatic/conf_source/templates/
maven_settings_custom.xml
.

You can manually edit this file to add more configurations. The file will be processed by buildomatic and copied to its final location after executing a buildomatic command:

buildomatic/build_conf/default/maven_settings_custom.xml

mvn-mirror=<repo-url>

mvn-mirror=http://mvnrepo.jaspersoft.com:8081/artifactory/repo

The value shown is the default repo-url used by Jaspersoft internal development.

repo-path=<path>

Set a local path value for this property if you are using maven.build.type=repo (this is the default configuration from the source code zip download from jaspersoft.com).

tibco-driver-path=<path>

Set a local path value for this property if you are using deploy-tibco-drivers=true (by default it is set to false).

deploy-tibco-drivers=true

Set to true if you want to add additional data connectivity drivers to JasperReports Server application.

Integration Tests

To run optional integration tests, use the following commands:

Commands for Running Integration Tests

Commands

js-ant drop-js-db
js-ant create-js-db
js-ant init-js-db-pro

js-ant run-integration-tests-pro

Changes to Repository Structure in 6.0

In JasperReports Server 6.0, we changed the repository location of JavaScript-related files. In releases earlier than 6.0, JavaScript files are here:

<js-path>/jasperserver-war/src/main/webapp/scripts/

As of 6.0 these files are here:

<js-pro-path>/jasperserver-war/src/main/webapp/scripts/bower_components/jrs-ui/src

If you customize JavaScript files, in addition to editing your source files, you need to optimize the JavaScript. See the JasperReports Server Ultimate Guide for more information.

Version: 
Feedback