Document toolboxDocument toolbox

Data Reports

Introduction

A framework that allows to generate advanced and complex reports with various aggregate functions. 

These reports cannot be configured by the user but can be quickly developed and added to the system based on custom order.



A custom report can be run for selected objects like building. The report can aggregate and group selected values from database.
The report UI can also provide feedback for further selection, e.g. when a building is selected, we might be prompted to select one of the tenants in that building. 

A further on the report will include spaces occupied by selected tenant. 

A spreadsheet or PDF can be obtained for any given report. Both can be based on templates with advanced formatting.

Usage

If configuration is done for Custom Reports, users can generate a report from the main interface.

Choose and object from Tree and right click it with mouse button. From context menu select Custom Reports option and then choose one of the reports that are configured by your administrator and an output format.
Reports are done based on selected object in Tree with subtree.



Custom Report Filter Form will open.

Choose one of available filters from combo box.
Filters are predefined by Administrators but can be adjusted using query (same as in advanced search) to match current needs.

After adding conditions for report generation, click on Generate button. Server task window will open indicating status of report generation.

Use the  Get result button to download report or XML file with error message if the report fails. 



Administration

Creating of reports templates is done outside application - this is described on How to prepare report script page.

  1. When report is prepared it can be uploaded to application using Custom reports window in Administration panel.





  2.  After uploading, administrator must perform class and field mapping between names from the report and from the the database.




  3. On Filters tab, prepare predefined filters for each uploaded report.
    Each Filter consists of name, chosen class and chosen class field.




    Created filters will be available for users in Report Filter Form where they will add a query to chosen field.