Difference between revisions of "Reports"

From Hornbill
Jump to navigation Jump to search
Line 30: Line 30:
 
===Output Options===
 
===Output Options===
  
Reports are output by default in '''PDF''' format. Optionally you can choose to output the report in the following formats
+
Reports are output by default in '''PDF''' format. In the ''Output Formats'' section you can also choose to output the report in the following additional formats
  
 
* CSV
 
* CSV
Line 49: Line 49:
  
 
Generation of CSV, XLS, XLSX adhere to the maximum row limit you have set on your instance under the following system setting: api.xmlmc.queryExec.maxResultsAllowed
 
Generation of CSV, XLS, XLSX adhere to the maximum row limit you have set on your instance under the following system setting: api.xmlmc.queryExec.maxResultsAllowed
 +
 +
Please also note that any hidden columns will only be excluded from the visual PDF output, with the data being included in the CSV, XLS and XLSX outputs. If you do not wish the data to be included in these output formats, the column should be removed from the report.
  
 
===Schedule===
 
===Schedule===

Revision as of 11:40, 21 January 2020

Home > Administration > Reports Index

Introduction

Reports are used to collect specific data for your reporting needs. The reports in Hornbill are point in time, meaning that the data is accurate at the point when the report is run. There are various different options with reports which will be explored in more detail below.

Related Articles

Reports can be created in various formats and can be scheduled for distribution to documents in Document Manager.

Report Types

Reports can be created based on Entities, Measures or by using the SQL Schema Designer.

Output Options

Reports are output by default in PDF format. In the Output Formats section you can also choose to output the report in the following additional formats

  • CSV
  • XLS
  • XLSX

When creating reports, the max row limit is set by default on instances to 1000, this can be increased to a maximum of 25000 rows using the following system setting (Home - System - Settings - Advanced):

api.xmlmc.queryExec.maxResultsAllowed

The only exception to this is for the creation of PDF reports output, this is limited to the following max outputs:

  • reporting.display.maxcolumns = 20
  • reporting.display.maxrows=5000

If either of these limits are exceeded when trying to generate a PDF output, the PDF generation will fail. PDF reports can only be generated on in A4 format (either portrait or landscape). Because of this restriction, there could be a scenario where not all included columns will be visible in a PDF report, depending on the data contained in these columns. In this scenario, we can only advise reducing the number of columns or opting for a different output type.

Generation of CSV, XLS, XLSX adhere to the maximum row limit you have set on your instance under the following system setting: api.xmlmc.queryExec.maxResultsAllowed

Please also note that any hidden columns will only be excluded from the visual PDF output, with the data being included in the CSV, XLS and XLSX outputs. If you do not wish the data to be included in these output formats, the column should be removed from the report.

Schedule

As well as running reports manually, you can also schedule the reports to run and be distributed on definable intervals: Scheduling Reports.

Table References

Full schema information and table descriptions can be found in the Application entity viewer located in Hornbill Administration: Click here for more info