This document provides details about the built-in reports provided by the analytics plugin. It also provides instructions for installing the reports as well as details of the script that can be used to install all the reports.

All the built-in reports are present in the reports directory. Within this directory, there are separate directories for each report.

The following files are present in each report directory:

• v_report_xxx - This is the DDL for the view corresponding to the report
• report_xxx - This is the DDL corresponding to the database table/stored procedure corresponding to the report
• README - This includes the documentation for the report as well as the curl command to create the report
• xxx.png - This is a screenshot for the report

In order to create a report, you need to do the following:

1. Run the DDL inside the v_report_xxx to create the view.
2. Run the DDL inside report_xxx to create the stored procedure.
3. Run the curl command within the README

In addition, we also provide the reports_setup.sh script. This script automatically creates all the reports in the reports directory.

• Bash shell (Linux, macOS, or Windows Git Bash)
• MySQL client installed and accessible in PATH
• Kill Bill running with the Kill Bill Analytics plugin installed
• Appropriate permissions for the MySQL database and Kill Bill API

Run the script as follows:

./setup_reports.sh

By default, the script installs DDLs and creates all reports.

The script uses environment variables to configure MySQL and Kill Bill settings. Defaults are provided if variables are not set:

You can export environment variables before running the script to override defaults:

export KILLBILL_HOST=192.168.1.10
export MYSQL_PASSWORD=mysecret
export INSTALL_DDL=false

./setup_reports.sh

• Run with default configuration:

./setup_reports.sh

• Skip DDL installation:

export INSTALL_DDL=false
./setup_reports.sh

• Disable dropping existing reports:

export DROP_EXISTING_REPORT=false
./setup_reports.sh

• Override Kill Bill host and MySQL password:

export KILLBILL_HOST=192.168.1.10
export MYSQL_PASSWORD=mysecret
./setup_reports.sh

The following table provides an overview of all the available reports.