About the License

Abstract

Learn how to correctly install the Pull Reports™ license file.


Pull Reports™ Community Edition

Free

Pull Reports™ Community Edition may only be used under the terms of the Pull Reports™ end user license agreement. Downloading Pull Reports™ from the Pull ReportsMaven repository constitutes acceptance of the license agreement.

Pull Reports™ Community Edition supports many features including the ability to export reports to the json, xml, csv, html, and htmltable formats and definition of <canned_queries>. Each installation of Pull Reports™ Community Edition may configure at most five <report>s. Using Pull Reports™ Standard Edition features within a Pull Reports™ Community Edition deployment is not permitted except in evaluation mode.

Pull Reports™ Community Edition does not require a license file to download and install. Installation and use of Pull Reports™ Community Edition is free of charge.

Evaluation Mode

Pull Reports™ Community Edition may be run in evaluation mode via the license.evaluation.mode configuration property. When in evaluation mode, Pull Reports™ Standard Edition features are available but limited to 100 results.

Additionally, the Ad Hoc Report Creator displays a footer message when run in evaluation mode.

Pull Reports™ Standard Edition

Requires license file

Pull Reports™ Standard Edition may only be used under the terms of the Pull Reports™ end user license agreement. Downloading Pull Reports™ from the Pull ReportsMaven repository constitutes acceptance of the license agreement. Additionally, Pull Reports™ Standard Edition requires a valid license file to be used in a production environment. Purchase a license from https://www.pullreports.com.

Pull Reports™ Standard Edition supports additional Export Report REST API formats: kml, geojson, map, htmltree, and jsontree .

License File Installation

The pullreports.license file is read at Servlet container start up and contains the license term (end date) and number of permitted <report>s. The license.file configuration property sets the license file location. The default location is at the root of the Java Virtual Machine classpath. A common root classpath location is the installation WAR's WEB-INF/classes directory, but any other classpath location is permitted such as $CATALINA_HOME/lib in a Tomcat Servlet Container.

License File Verification

Pull Reports™ performs the following license checks on initialization:

  • If the provided license file is invalid or the total number of configured <report>s exceeds the number permitted by the license, Pull Reportslogs an error message and exits.

  • If the current date is after the license end date (license expiration), Pull Reports™ limits the Pull Reports™ Standard Edition additional Export Report REST API formats to 100 records. Formats supported by the Pull Reports™ Community Edition license will continue to work without restriction.

    Additionally, the Ad Hoc Report Creator displays a footer message when the license is expired.

After initialization, Pull Reports™ writes the license term and number of permitted <report>s to the ADMIN logger.