Skip to content

Latest commit

 

History

History
221 lines (155 loc) · 6.39 KB

README.md

File metadata and controls

221 lines (155 loc) · 6.39 KB
Raw

Kapenta

Generate RESTful APIs for your Pentaho Reports automatically from a YAML configuration file.

Basic Usage

Let's assume you have designed a report called customer_report in Pentaho Report Designer and you want to make this report available via an API.

NOTE: Credit Data provides a "lite" build of Pentaho Report Designer on the prd-ce-lite repository which is a small download and mostly suitable for use with SQL databases

You can create this configuration and save it in a yaml file called configuration.yml

# configuration.yml
host: localhost
port: 4567
apiRoot: /api
reports:
  - name: Customer Report
    version: "1.0.0"
    path: /customer_report
    file: ./customer_report.prpt
    parameters:
      - name: customer_id
        type: Long
        required: true
        default: 0

Running the following command will start a webserver at port 4567

$ bin/kapenta server --config configuration.yml --host "0.0.0.0" --port 4567

The API created will have two end-points, one for generating your report. Example to generate a report for customer with id #1 we'd have:

http://localhost:4567/api/customer_report?customer_id=1

This by default will result in an html report being generated. The server currently supports three output types for a report: PDF, HTML and TEXT

In order to get a PDF report - append .pdf to the path before adding the query parameters or set the Accept header to application/pdf.

For example the same request above can be made a pdf by performing the request in a browser:

http://localhost:4567/api/customer_report.pdf?customer_id=1

In order to get a Text report - append .txt to the path before adding the query parameters or set the Accept header to text/plain.

All output is UTF-8 encoded

An end-point is generated that allows you to see what parameters are accepted by the report.

For example, you could run the following request:

$ curl -G http://localhost:4567/api/customer_report/info

In this case will give you

{
  "reportName" : "Customer Report",
  "version" : "1.0.0",
  "parameters": [
    { "name": "customer_id", "type": "Long", "default" : 0, "required": true }
  ]
}

Generating Configuration

Let's say you have too many reports you want to expose via an API or you're just too busy to write up the YAML configuration by hand you can automagically generate the YAML configuration using the same binary!

Let's assume you have reports in a directory called /var/pentaho_reports. You can use the following command to generate a YAML file called my_api.yml that contains basic configuration for the reports in that directory.

NOTE: The directory must contain valid Pentaho report templates but may also contain other files. The generator only picks up the Pentaho files

$ bin/kapenta generate --directory /var/pentaho_reports --output-file my_api.yml

You can then use the generated YAML file to run your API and you didn't have to write anything!

$ bin/kapenta server --config my_api.yml

The generated configuration file does not configure backup and authentication - so if you need those features you have to add them in yourself. See the Advanced Configuration section, below.

Advanced Configuration

Server Configuration

You can configure the server to bind to a different ip address than localhost and different port than the default 4567.

For example

host: 192.168.1.45
port: 8172

Logging Configuration

The configuration file also expects a some configuration for logging, the required fields for now specify the level and the directory to store log files in.

logging:
  rootLevel: INFO
  directory: ./logs

Report Backups

If you want to be able to store a backup of the reports clients/users have generated via the API you can do so via the following configuration.

The files are saved with the output type that's sent to the requesting clients and are prepended with the timestamp they are generated at using System.currentTimeMillis().

For example a generated text report for hello report would have a backup with name 1483718274331-helloreport.txt

NOTE: Set the directory to a directory that the user running the process has write permissions to.

# Configuration for backup of generated reports
backup:
  # Where to store the generated reports
  directory: /var/log
  # If the directory should have subdirectories for each day
  rollingBackup: true

Rolling Backups

Rolling backups creates a directory per day and stores the reports in the directory with the date they were generated. The directories are named in YYYY-MM-DD format.

For example: 2017-01-01

Configuring Basic Authentication

In order to add some level of security to the API you can configure HTTP Basic Authentication via the configuration file.

Single User authentication

basicAuth:
  user:
    username: foo
    password: foo123

Multiple Users authentication

In order to allow multiple usernames and passwords to authenticate to the API you can use the users key in the basicAuth configuration

basicAuth:
  users:
    - username: foo
      password: foo123
    - username: john
      password: john123

Building

You will need a minimum of Java 21 and Maven 3.8 to build the project.

The project uses the maven assembly plugin to create both a zip and tar archive that contains the compiled application, all it's dependencies and the executable scripts; bin/kapenta.bat file for Windows and a bash (bin/kapenta) file for Linux.

$ git clone https://github.com/nndi-oss/kapenta.git
$ cd kapenta
$ mvn clean install
$ mvn assembly:assembly

The archives will be created in the target directory.

Note on MySQL database drivers

We use MariaDB's client library for connecting to mysql databases.

CONTRIBUTING

See the CONTRIBUTING.md file for more information.

Shout out to Credit Data CRB Ltd for handing the project over for us to maintain.

Copyright (c) 2022, Zikani Nyirenda Mwase, NNDI Copyright (c) 2017 - 2021, Credit Data CRB Ltd