CLI reports how-to

Add new CLI reports
Create new custom reports and add them to the list of available custom reports by committing the new reports to the TeamForge branding repository.

Add new parameter type (or widget)
CLI reports support report configuration through widgets.

Create new SQL query for new CLI reports
As the CLI reports allow flexible report parameter configuration, the final SQL query to pull data from the database needs to be dynamically generated based on the values that you configure for items such as tracker ids, planning folder ids, and so on. Refer to any existing <cli-reports-installation-folder>/pkg/<any-report-folder>/script file while working on the script file for your new report.

Add new chart types
Once data is pulled from the database, same will be sent to the HighCharts in JSON notation.

Report generation
Once you have added a new report, users can configure the parameters and generate reports.