Get Started!

˂ Return to Main FAQ
˂ Return to Reports FAQ

The Custom Reports menu provides a location to create and view any custom reports that have been generated. Custom Reports are written in the HQL language (https://docs.jboss.org/hibernate/orm/3.3/reference/en-US/html/queryhql.html) and can be created, edited and deleted by XTAM System Administrators only. Users with the global role Auditor may only view custom reports.

To Create a New Custom Report

1

Login to XTAM with a System Administrator account.

2

Navigate to Reports > Custom Reports and click the Create button.

3

Enter a Name and optional Description in the appropriate fields.

4

Enter your custom HQL statement into the HQL field.

Use the Example menu to select a pre-built report example that will load a sample custom report. You may customize these example reports as necessary and use the Save button to make it available to your users.

5

Click the Save button to save your new custom report.

Click the API Documentation link to open the interactive REST API documentation to further help with the construction of your HQL statements.

To View the results of a custom report, simply click on the report’s Name or its View button. When viewed, the results will be queried and displayed as found. From within a custom report, the following options are available:

  • Search is only available if the functionality was included in your HQL statement. See the example report Example Report with Enabled Search to see how Search is enabled.
  • Export is available to export the available on-screen data to either a CSV or PDF file.

Columns will be displayed as defined in your HQL statement. The Columns selector will allow you to show or hide each column in the report.

 
 

Copyright © 2019 Xton Technologies, LLC. All rights reserved.