7.1. Run a Report Template

In the My Folders section click the arrow next to Templates to expand this folder and select the subfolder for the template you want to run a report off of.

Locate the template you want to run the report off of and double click on it to open up the report definition interface.                                   

Template Name, Template Creator, and Template Description are for informational purposes only. They are hard coded when the template is created. At the report definition stage it is not possible to change them.

Report Name is required. Reports stored in the same folder must have unique names.

Report Description is optional but may help distinguish among similar reports.

Report Columns lists the columns that will display in the output. This is derived from the template and cannot be changed during report definition.

The Filters tab allows you to set filter values for the filter fields selected in the template. These will vary based on what filter types you are working with. Most filters require you to choose something form a drop-down list. Dates may require you to use manual input rather than a widget. All dates entered manually should be formatted as yyyy-mm-dd.

Next, you will select output options. Select one or more output formats. In this example the report output will be available as an Excel spreadsheet only. There are other options, such as a CSV file, an HTML table (for display in the staff client or browser), or a bar chart.                                                   

Select Run as soon as possible for immediate output. It is also possible to set up reports that run automatically at future dates or intervals. If you want the report to be recurring, check the Recurring Report box and select the Recurrence Interval as described in Recurring Reports. In this example, as this is a report that will only be run once, the Recurring Report box is not checked.

It is optional to fill out an email address where a completion notice can be sent. The email will contain a link to password-protected report output (staff login required). You can enter one email address or multiple addresses separated by commas.

Select a folder for the report’s output.

Click Save Report. You will get a confirmation dialogue box that the Action Succeeded. Click OK. 

Once saved, the report will appear in the Reports and Output folders you selected and remain until you delete them or they are removed by a long-term data cleanup process.