Report

Document Navigation

Report

Introduction

The report module allows users to write custom MYSQL reports that can be saved and run when needed.

Setup

  1. Before you learn how to use reports you’ll need to make sure your config is setup correctly. Add the following entries into the config.php file in the root directory of your Cmfive project.
    Config::set("report.database", [
     "hostname"  => "DB_HOSTNAME",
     "username"  => "DB_USERNAME",
     "password"  => "DB_PASSWORD",
     "database"  => "DB_NAME",
     "driver"    => "mysql"
    ]);
    
  2. Replace DB_HOSTNAME, DB_USERNAME, DB_PASSWORD and DB_NAME with their respective values.
  3. To clear your config cache to apply your changes.

Writing Reports

Running Reports