Skip to main content
Version: Unreleased

Details

This page contains the detailed information for the Auto Trigger feature. It was split out from the main introduction to keep the overview concise while preserving all important guidance.

Key Features​

  • Report Scheduling: Users can define schedules for when reports should be generated and sent, using CRON syntax (for example, 0 8 * * * for daily at 8 AM) or interval syntax (@every 1h). CRON generators such as CronTab can help craft expressions. The schema uses a schedule.cron field for this purpose.
  • Multiple Data Sources: Reports can pull data from Elasticsearch queries or external API endpoints.
  • Data Transformations: Apply JavaScript transformations to process and manipulate data before output. Python support is planned for a future release.
  • Multiple Output Formats: Generate reports in PDF, HTML, CSV, or JSON formats, optionally with visualizations.
  • Flexible Delivery: Configure multiple delivery channels (email, Matrix, Browser, SNMP, API) for each report.
  • Customizable Actions: Execute actions like saving data to Elasticsearch after report generation.
  • User-Friendly Editor: The JSON editor in the dashboard includes a validation schema enabling autocomplete and type-hinting — press Ctrl+Space to trigger suggestions.

The schema uses a flat structure with pipeline, sources, transform, output, and delivery fields, replacing the older functionReferenceList approach.

  • Access the Auto Trigger dashboard via the Reports tab in the left-side navigation menu.
  • View, edit or delete defined reports from the list view. The list shows the name, last run status and an actions menu (Edit, Run Now, Delete).
  • Create new reports using Add New Report.

Execution & history​

  • Each execution (manual via Run Now or scheduled) is recorded with timestamp, status (RUNNING, SUCCESS, FAILURE), message and references to generated outputs.
  • Generated outputs are stored and downloadable from the execution history. Outputs can also be produced without a transport configured (useful for saving files only).
  • View detailed logs for each execution to diagnose issues.

Full schema​

For the full JSON schema used by the Auto Trigger editor and async job definitions, see the API path: api/asyncJobs/schema.

See Also​