Table of Contents

Overview

This document documents the mechanisms for generating (and managing) reports on demand (instead of via schedules, which are described here).

...

1. All output_file_N options must point to the same directory, and it must be one of the configured report directories (or the on-demand report directory).
   Output to STDOUT (using output_file_1=-) is not allowed in this situation.
2. All the relative file names given in output_N must be identical (but for the extension).
   this works: format_1=HTML output_file_1=/usr/local/omk/var/reports/on-demand/testme.html format_2=XLSX output_2=/usr/local/omk/var/reports/on-demand/testme.xlsx
   whereas this doesn't: output_file_1=.../test_one.html output_file_2=..../test_two.csv
3. You must add the option actual_name=<the name of your report files minus extension>.
   For the example from step 2 this would be actual_name=testme.
4. You must add the option actual_uuid=<unique identifier>.
   The uuid should follow the UUID V4 standard format , but any globally unique string will do.
   You can use the uuid program to create a a proper uuid.
5. If you want your report to be treated as an instance of a scheduled report, then you must pass the schedule's uuid parameter.
6. If you want report aging, then you have to add a keep_for=<days> option.

If any of the requirements 1 to 5 are not met, then no report metadata json file is created and the GUI will not pick up the manually created report.

In version 3.0.7 and newer, the opReport scheduler logs the actual command line arguments that it uses for generating reports, which should provide a good example of how the parameters line up.