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.

Note: To be able to generate reports, users require Folder->View and File->Upload permissions and to be able to navigate to a folder and change its contents. In addition, to be able to view any generated report, the Files->View permission is required and to view images that may be linked into a report, users require the Images->View permission.

To generate a report from an existing template
  1. Navigate to any folder in the Repository. (If not in a folder, click on the  Folder  button from the left-hand sidebar then choose a folder)

  2. Click Generate Report*

  3. Enter a name in the Report Name field

  4. Select a Report Template from the drop down list

  5. (optionally) Toggle Sign Report to enabled in order to insert your signature in the report. To add a signature, see [Use Profile]

  6. (optionally) click Preview

  7. Click Generate Report Report will be saved as a PDF into the current folder

*If you don't have this option it may not be enabled for your deployment.

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 templating language, refer to documentation of the Jinja2 templating language

Note: The “Manage report templates” permission flag is required to create or edit report templates.

To create a report template
  1. Click on the  Setting  button from the left-hand sidebar

  2. Click on the Report Templates tab*

  3. Click the New Report Template button

  4. Adjust the report template

    a. Type a name in the name field

    b. Adjust contents of the Template tab, see [Jinja2 Quick Reference] and [Placeholder Reference] for details

    c. (Optionally) Adjust content of the Style, Static and Snapshots tabs, see [Auxiliary Information] for details

  5. To preview the report template

    a. Click Select Folder from the top-right hand corner and choose a folder for testing

    b. (Optionally) Toggle Signed to include a signature

    c. Click the Generate Preview button to see the results

  6. Click Save

To edit a report template
  1. Click on the  Setting  button from the left-hand sidebar

  2. Select the Report Templates tab*

  3. From the list of templates, click on the name of an existing template to open it OR click the on a row in the table and then click the Edit button

    a. (Optionally) Edit the name template in the textbox at the top of the page

    b. (Optionally) Adjust contents of the Template tab, see [Jinja2 Quick Reference] and [Placeholder Reference] for details

    c. (Optionally) Adjust content of the Style, Static and Snapshots tabs, see [Auxiliary Information] for details

  4. To preview the changes

    a. Click Select Folder from the top-right hand corner and choose a folder for testing

    b. (Optionally) Toggle Signed to include a signature in the preview

    c. Click the Generate Preview button to see the results

  5. Click Save

To preview a report template
  1. Click on the  Setting  button from the left-hand sidebar

  2. Click on the Report Templates tab*

  3. From the list of templates, click on the name of an existing template to open it OR click the on a row in the table and then click the Edit button

  4. To preview the changes

  5. Click Select Folder from the top-right hand corner and choose a folder for testing

  6. (Optionally) Toggle Signed to include a signature in the preview

  7. Click the Generate Preview button to see the results

To enable or disable a report template
  1. Click on the  Setting  Settings button from the left-hand sidebar

  2. Select Report Templates tab*

  3. Click the toggle beside the report to disable

*The user-level Manage report templates permission is required for editing report templates. In addition, the reporting tools add-on is required for reporting functionality.