CompleteConfiguration

Introduction

This page describes in detail all issues concerning installation of Aperte Reports.

JNDI Configuration

Aperte Reports requires external resources accessible by JNDI. Only datasource configuration is required to run application, but JMS and Mail settings are necessary for its full functionality.

Sample configuration can be found on SampleJNDIConfiguration page.

Datasource

Aperte Reports is configured to use a JNDI datasource named:

jdbc/aperte-reports

Liferay's application server (on which Aperte Reports is deployed) should provide access to this datasource.

Sample configuration concerns Tomcat with HSQL DB, for other environment please refer to your application server and database documentation.

JMS

To enable background and cyclic reporting features, Aperte Reports requires configured JMS resources:

1. JMS connection factory:

jms/ConnectionFactory

1. JMS queues:

jms/GenerateReportQueue
jms/ProcessReportQueue

For Aperte Reports in version < 2.4 the following names should be used:

jms/queue/CyclicOrderResponse
jms/queue/GenerateReport

With version 2.3, Aperte Reports supports JMS outside J2EE container, for example on Tomcat with external JMS provider such as Active MQ.

Sample configuration assumes usage of ActiveMQ with its default settings as external, standalone JMS provider, accessible via tcp protocol.

Report email notifications

To enable sending the result of background reports to an email address the application server should provide mail session JNDI resource:

mail/session

Please configure it to use your SMTP server. Sample configuration uses gmail as SMTP server.

Building from sources

In order to build application from source code, one is required to install a Subversion client and Apache Maven. If those requirements are met, go to Google Code Source section and follow instruction to check out the project (with Git).

Next, go to the checked out source code, to the directory containing parent pom.xml file, and issue a build maven command:

mvn clean install

GPG sign

In order to disable GPG sign configuration -> skip section should be added to maven-gpg-plugin entry in pom.xml:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-gpg-plugin</artifactId>
  ...
  <configuration>
    <skip>true</skip>
  </configuration>
</plugin>