Getting Started

This article gives you the basic information you need to install and test Java Report Engine.

Requirements#

  • Java 1.8 or later (beginning with version 12.5)
    • Download the JDK, the JRE is not enough
  • A Java Report Engine license key (request a trial license key if you don't have one)
  • Apache Maven

Adding WindwardReports Maven Package to Project#

To add a reference to the WindwardReports Maven dependency, add the following <repository> to your <repositories> section in the project's POM.xml file:

.
.
<repositories>
.
.
<repository>
<id>windward-maven-repo</id>
<name>windward-maven-repo</name>
<url>https://windward.mycloudrepo.io/public/repositories/windward-group</url>
</repository>
</repositories>
.
.

Then add the following <dependency> to the <dependencies> section in the POM.xml:

.
.
<dependencies>
.
.
<dependency>
<groupId>net.windward</groupId>
<artifactId>WindwardReports</artifactId>
<version>VERSION_NUMBER</version>
</dependency>
</dependencies>
.

Replace VERSION_NUMBER with the version of the Windward Java Engine you want to use. (Example: 22.1.0.85)

Your project now had WindwardReports as a dependency.

Installing WindwardReports via Zip File#

If you do not want to use maven to make use of our reporting engine, we offer the engine, along with all its dependencies as a collection of JARs in a ZIP file on our website. If you choose to go this route, follow these steps to add the JARs as references to your Java project:

  1. Download the ZIP file from the link above and extract it
  2. Create a new Java project in Intellij, or open your existing project
  3. Click File -> "Project Structure"

  1. Then click on "Modules":

  1. Then click on the "Dependencies" tab:

  1. Then click the plus button:

  1. Then click browse:

  1. Navigate to the extracted ZIP file with all the jars:

  1. Then click "Apply", then "OK":

Set CLASSPATH#

The Installation Wizard added the Engine jar files to your CLASSPATH when it was executed, but if some of those jar files were already in your CLASSPATH, then you have duplicates. Even if the duplicates are identical files, Java still views them as different classes with the same name, and they can cause obscure problems later. We strongly recommend removing any duplicate entries from your CLASSPATH.

If for some reason you must manually add the Java Report Engine jar files to the CLASSPATH, we suggest adding to your environment variables this entry:

WR_JARS=C:\PATH\TO\JARS\FILE

This allows you to move the jar files later and only change one environment variable. Once this is set, add the following to your CLASSPATH (all jar files, including WindwardReports.jar, in the jars\ directory):

%WR_JARS%

Your Java project now has all the references it needs to make use of our report generation engine.

Adding WindwardReports.properties File#

To add your license key or any report properties, you need to add a WindwardReports.properties file to the root of your file structure:

For mor information about the properties file, check out this article. <!---NEEDS LINK to properties reference doco--->

Entering Your License Key#

Copy and paste your license key into the WindwardReports.properties file. For example (this is not a valid key):

license=vt0OucWy76Z9g9hH9xb+3cz2rSAJQE/HnM84UYnU30hJJGa\
Hnh9VmeMFxyf5lLL2t7+d4yqZTxZ60Xn+tZ4WSjEX1Rqn1Gt\
2BQt122a7zS6xUEL99bO3czy58D94u3Jnh8vVySkl6KfC3\
rlth7+scz2rSANSc1H9ZTq2en+zW7NKfzl

The key is a single string. If you wish to break up the string across several lines, be sure to place a "\" (backslash) at the end of each line except the last line of the license file. The "\" must be the last character of the line; there can't be a space or any other character after it.

To learn more about the different properties we provide for report generation, check out this article. <!---NEEDS LINK to java props doco--->

Whats Next#

You should checkout the samples we have on out github that makes use of the WindwardReports Maven package.