Working With Reports
Generating Reports
Users can generate a report from within a folder. The generated PDF outputs are always saved in the folder where the report is generated.
To generate a report from an existing template
Navigate to any folder in the Repository (click on the Repository button from the Navigation Menu then navigate to a folder)
Click on the button at the top right of the item list
In the popup menu, click Generate Report
Type a name in the Report Name field
Select a template from the Report Template dropdown
(Optional) Enable the Sign report toggle to insert your signature into the report. To create or update a signature, see My Account
(Optional) Click on the Preview button to see how the report will render for this folder
Click on the Generate Report button. The report will be saved as a PDF into the current folder
Managing Report Templates
To better understand the features of the templating language, start by reviewing our Jinja2 Quick Reference and Placeholder Reference. For comprehensive information about the templating language, refer to the Jinja2 documentation.
To create a report template
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Click on the New Report Template button
Type a name for the template into the field at the top of the page
Click on the Template tab
Make the desired changes to the template. See Jinja2 Quick Reference and Placeholder Reference for details
(Optional) Click on the Styles, Static Data, or Snapshots tabs and make desired adjustments. See Auxiliary Information for details
(Optional) Preview the template:
- Click on the Select Folder button and select a folder for testing
- (Optional) Enable the Signed toggle to insert your signature into the report
- Click on the Generate Preview button
Click on the Save button
To edit a report template
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Select a report template from the table
Click on the Edit button above the table
(Optional) Edit the name of the template in the field at the top of the page
Click on the Template tab
(Optional) Make the desired changes to the template. See Jinja2 Quick Reference and Placeholder Reference for details
(Optional) Click on the Styles, Static Data, or Snapshots tabs and make desired adjustments. See Auxiliary Information for details
(Optional) Preview the template:
- Click on the Select Folder button and select a folder for testing
- (Optional) Enable the Signed toggle to insert your signature into the report
- Click on the Generate Preview button
Click on the Save button
To preview a report template
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Select a report template from the table
Click on the Edit button above the table
Click on the Select Folder button and select a folder for testing
(Optional) Enable the Signed toggle to insert your signature into the report
Click on the Generate Preview button
To enable or disable a report template
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Set the Active toggle next to the report template's name
To delete a report template
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Select a report template from the table
Click on the Delete button above the table
Click on the Yes button to confirm
Report Template Files
Report template files are static files that are referenced in your report templates (e.g. a logo image). These files can be referenced by name or ID in your template. See Placeholder Reference - Global Functions for details.
To upload a report template file
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Click on the Upload button in the Report Template Files section of the page
Click in the blue box to activate the file selection dialog or simply drag files into the blue box; repeat as required for other files
Click on the Start Upload button to start upload
Click on the X button to minimize the File Uploads dialog
To check upload status, click on the Details button from the upload progress notification at the top of the screen
To rename a report template file
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Select an item from the table in the Report Template Files section of the page
Click on the Rename button above the table
In the popup dialog, type a new name for the file
Click on the Rename button or press the Enter key to save. To discard your changes, click on the Cancel button or press the Escape key
To delete a report template file
Click on the Settings button from the Navigation Menu
Click on the Report Templates tab
Select an item from the table in the Report Template Files section of the page
Click on the Delete button above the table
Click on the Yes button to confirm