Installing ReportFactory Lite on Apache Tomcat

Prerequisites

Before installing ReportFactory Lite, ensure the following components are set up:

  • Java JDK 17.0.14 or later is installed

  • Apache Tomcat 9.0.102 is installed and running

Installation Steps

Step 1: Download and Extract Package

  1. Download and unzip the ReportFactory Lite file

  2. The extracted contents includes the following folders and files:

Step 2: Deploy WAR File

  1. Copy report-factory-lite.war to Tomcat webapps folder

  2. Start Tomcat

  3. If Tomcat is running, the report-factory-lite.war will explode and report-factory-lite directory will be created

Configuration

Step 1: Setup Report Engine Directory Structure

  1. Copy the report-engine directory from the extracted package to a secure location on your server
    Unix/Linux Example: sudo cp -r report-engine /opt/arflite/
    Windows Example: Copy the report-engine folder to D:\workspace\arflite\

  2. Verify the directory structure includes the following folders:

    /opt/arflite/report-engine/
├── config/                                (Used in standalone mode)
├── reports/                               (Generated report output)
├── templates/                             (Report templates)
└── templates/other-assets/                (Company logos and images)

  3. Set proper permissions to ensure Tomcat user has read/write access:

Unix/Linux:

sudo chown -R tomcat:tomcat /opt/arflite/
sudo chmod -R 755 /opt/arflite/
sudo chmod -R 777 /opt/arflite/report-engine/output/

Windows:

  • Right-click on the arflite folder

  • Go to Properties > Security

  • Grant Full Control to the user running Tomcat service

Step 2: Navigate to Configuration Directory

Navigate to: Tomcat-Directory/webapps/report-factory-lite/WEB-INF/classes

Step 3: Edit Application Properties

Open the application.properties file in a text editor and update the following configurations:

Configuration Parameters:

spring.application.name=report-factory-lite
# API Key
app.api-key=C3E91D6B7A2F549E80DCCB6F

# Report locations
app.report.template-location=/opt/tomcat9/arflite/templates/
app.report.output-location=/opt/tomcat9/arflite/reports/
app.report.delete-after-generation=Y

# security
app.aes.encryption-key=A3F67C9D8E0B2451F68C3E91D6B7A2F549E80DCCB6F1E392A3D5C7F8421B6D3E
app.aes.encryption-iv=F1B27498D2E3A6C75089F4BA3D65C2E7
app.aes.enabled=0

app.license-key=X/JSjK9/OIsPfeG564pzui+2breTDNeYp4ULVsTWO2w=

API Key(app.api-key): Replace with your custom API key for the web service. You can generate any random string and use it as API key.

Report Template Location(app.report.template-location): Specify the folder where templates are stored

Report Output Location(app.report.output-location): Define the folder where generated reports should be stored.

Delete Output Location(app.report.delete-after): Y: Generated reports are deleted immediately. N: Reports will be stored at app.report.output-location.

AES Encryption(app.aes.enabled): Enable encryption if required by setting app.aes.enabled=1

Note: If app.aes.enabled=1, then JSON data sent in requests must be AES-encrypted.

You can generate your own key and iv for AES encryption.

Step 4: Restart Tomcat

Restart Tomcat and ensure the server is up and running.

Verification

After installation and configuration, verify the deployment by accessing: http://host:port/report-factory-lite

The application should be accessible and ready for API requests or APEX integration.

Important Notes

  • Ensure the Tomcat user has read permissions on the templates and logos directories

  • Ensure the Tomcat user has write permissions on the output directory

  • Sample templates and folder structure are provided in the report-engine directory

  • Keep the report-engine directory in a secure location outside the web application directory

  • Use absolute paths in the configuration to avoid any path resolution issues

Updated on
Download
Testing with Postman