Reports

A report is a CSV file sent in a scheduled email. The CSV content is managed by:

  • HCQL query (certificates), HRQL query (requests)

  • CSV fields shown

Prerequisites

You may need Teams.

How to configure Reports

1. Log in to Horizon Administration Interface.

2. Access Reports from the drawer or card: Reports.

3. Click on Add report.

4. Fill in the mandatory fields.

Details

  • Enable (boolean):
    Tells whether the reporting task should be enabled. Set by default at true.

  • Name* (string input):
    Enter a meaningful report name. It must be unique.

  • Cron scheduling expression in Quartz format* (cron expression):
    Enter a Cron scheduling expression (in Quartz format). The default expression is built to run the task every hour.

Recipients

Click on Add report recipient to add a recipient.

You can either target:

  • A static (recipient): you will need to set a valid email address.

  • A team contact: you will need to select one of the enabled teams.

  • A team manager: you will need to select one of the enabled teams.

Email

Common fields

  • From* (string input):
    Enter the email address that will appear in the "From" field of the email.

  • Subject* (string input):
    Enter the subject of the email.

  • Body (string input):
    Enter the body of the email.

  • Is HTML (boolean): (boolean):
    Sets whether the email body contains HTML code (true) or plain text (false). The default value is set to false.

ReportType

The report type determines how the CSV report will be sent. Depending on the user’s choice, a set of parameters may appear.

If set to link_email, a temporary link will be made available in the email notification dictionary. In this case, the user must set a retention period to specify how long the CSV can be downloaded for.

  • The provided email format is a relative URL, and the expected instance hostname should be prefixed to it.

  • The user should add the temporary link to the email body.

  • Retention Period* (finite duration):
    Specify the period during which the report can be downloaded after generation. Using long periods is not recommended.

If set to attachment_email, then the report CSV will be attached to the email. In this case, the user can specify whether or not to compress the file.

  • CSV file name (string input):
    Enter the name that will be given to the attached csv file.

  • Compress file (boolean): (boolean):
    Sets whether the CSV must be compressed using gzip and adds the .csv.gz extension to the file.

HQL

  • HQL Type* (select):
    Either chose Certificate or Request. It will define the HQL Query type to set and the enabled CSV fields.

  • Query (string input or select):
    HCQL (Certificate) or HRQL (Request). You can select one of your saved queries.

CSV

You can select which fields will appear on the CSV file.

5. Click on the save button.

You can run Execute report, edit Edit report or delete Delete report the report .