Difference between revisions of "Reports"

From Hornbill
Jump to navigation Jump to search
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
{{bluebanner|[[Main Page|Home]] > [[Administration]] > Reports|[[:Category:Service Manager Administration|Index]]}}
−
__NOTOC__
+
{{IntroAndLinks|Reports are used to collect specific data for your reporting needs. The reports in Hornbill are a point in time, meaning that the data is accurate at the point when the report is run. These types of reports are best used for reporting on lists of data.  There are various different options with reports which will be explored in more detail below. Reports can be created in various formats and can be scheduled for distribution to documents in Document Manager or by email.|
−
{| style="width:100%"
 
−
|[[Main Page|Home]] > [[Administration]] > Reports
 
−
|style="text-align:right;"|[[:Category:Service Manager Administration|Index]]
 
−
|}
 
−
</div>
 
−
{|style="width: 100%"
 
−
|- valign="top"
 
−
|style="width:73%"|
 
−
== 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.
 
−
|style="width:5%"|
 
−
|
 
−
|style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
 
−
== Related Articles ==
 
 
:* [[Report Types]]
 
:* [[Report Types]]
 
:* [[Report_Scheduling|Report Scheduling]]
 
:* [[Report_Scheduling|Report Scheduling]]
 
:* [[Document Manager]]
 
:* [[Document Manager]]
 +
:* [[Application_Entity_Viewer|Application Entity Viewer]]
 
:* [[Advanced Analytics]]
 
:* [[Advanced Analytics]]
−
|}
+
}}
  
−
Reports can be created in various formats and can be scheduled for distribution to documents in Document Manager.
+
== Report List ==
 +
Each Hornbill application will have its own Report List.  These can be accessed by browsing the Admin tool starting at ''Home -> Applications'' and then selecting the application that you with to report on. A ''Reports'' card will displayed if reporting is available for the app.
 +
===Tool Bar ===
 +
{{bullet1|Filter|A filter allows you to located reports that you have already created.}}
 +
{{bullet1|Create New Report|This option start the process of [[#Creating and Editing a Report|creating a new report]]}}
 +
{{bullet1|Delete Selected|This option will only be available when one or more reports have been selected within the Report List}}
 +
 
 +
== Creating and Editing a Report ==
 +
By either selecting the ''Create New Report'' or by clicking on the name of an existing report from within your Report List, you are presented with the options to define your report.
 +
=== Tool Bar ===
 +
{{bullet1|Save|Once the name of the report has been entered within the Report Details, the save option will become available. For both new and existing reports, they must be saved before you can run the report.}}
 +
{{bullet2|Copy Report As|This allows you to create a copy of this report and add it to your list of reports under a different name. This option is only available after the new report has been saved for the first time.}}
 +
{{bullet1|Run|This starts a manual running of the report.  The results of the Run are added to the Report History. This option will not be available when there are unsaved changes on a report.  It will also not be available while a report generation is already running.}}
 +
{{bullet1|Download|Download a definition file for the report. This allows you to share a report definition with another Hornbill instance.  This option is only available after the new report has been saved for the first time.}}
 +
{{bullet1|Upload|Upload a definition file for the report.  This allows you to take a report that has been shared with you and upload it to your Hornbill instance.  Uploading a definition file will overwrite any settings that you have previously set for that report, including the name.}}
 +
 
 +
=== General ===
 +
{{bullet1|Name|The name of the report. This is displayed in the list of reports as well has providing the default title on the report output.}}
 +
{{bullet1|Description|Use this area to describe the report}}
 +
{{bullet1|Report Output Type|}}
 +
{{bullet1|Report Using|}}
 +
{{bullet2|SQL Schema Designer|}}
 +
{{bullet2|Report Entity|}}
 +
{{bullet2|Report Measure|}}
 +
{{bullet1|Report Status|}}
 +
 
 +
=== Data Collection ===
 +
==== Select Tables ====
 +
{{bullet1|Select Tables||}}
 +
{{bullet1|Join||}}
 +
 
 +
==== Select Columns ====
 +
==== Select Filter ====
 +
==== Select Ordering ====
 +
==== Data Preview ====
 +
 
 +
=== Output Formats ===
 +
{{bullet1|Report Output Formats|}}
 +
{{bullet1|Report Layout|}}
 +
{{bullet1|Header Options|}}
 +
{{bullet1|Report Table Options|}}
 +
{{bullet1|Report Chart Options|}}
 +
{{bullet1|Additional Data Formats|}}
 +
 
 +
=== Schedule ===
 +
{{bullet1|Report Schedule|}}
 +
{{bullet1|Publishing|}}
 +
 
 +
=== Report History ===
  
 
===Report Types===
 
===Report Types===
Line 29: Line 64:
 
===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 35: Line 70:
 
* XLSX
 
* 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 setting:  
+
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
 
api.xmlmc.queryExec.maxResultsAllowed
Line 45: Line 80:
 
* reporting.display.maxrows=5000
 
* reporting.display.maxrows=5000
  
−
If either of these limits are exceeded when trying to generate a PDF output, the PDF generation will fail and an entry in the log will explain why.  
+
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
 
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===
  
−
As well as running reports manually, you can also schedule the reports to run and be distributed on definable intervals
+
As well as running reports manually, you can also schedule the reports to run and be distributed on definable intervals: [[Report_Scheduling|'''Scheduling Reports''']].
 +
 
 +
====Table References====
 +
* [[Table Info: Main Request Table|Main Request Table (h_itsm_requests)]]
 +
* [[Table_Info: h_sys_ccodes|ISO Country Codes (h_sys_ccodes)]]
 +
Full schema information and table descriptions can be found in the Application entity viewer located in Hornbill Administration: [[Application_Entity_Viewer|'''''Click here for more info''''']]
  
 
[[Category:Service Manager]][[Category:Administration]]
 
[[Category:Service Manager]][[Category:Administration]]

Revision as of 19:46, 15 October 2021

Home > Administration > Reports Index

Introduction

Reports are used to collect specific data for your reporting needs. The reports in Hornbill are a point in time, meaning that the data is accurate at the point when the report is run. These types of reports are best used for reporting on lists of data. There are various different options with reports which will be explored in more detail below. Reports can be created in various formats and can be scheduled for distribution to documents in Document Manager or by email.

Related Articles

Report List

Each Hornbill application will have its own Report List. These can be accessed by browsing the Admin tool starting at Home -> Applications and then selecting the application that you with to report on. A Reports card will displayed if reporting is available for the app.

Tool Bar

  • Filter
A filter allows you to located reports that you have already created.
  • Create New Report
This option start the process of creating a new report
  • Delete Selected
This option will only be available when one or more reports have been selected within the Report List

Creating and Editing a Report

By either selecting the Create New Report or by clicking on the name of an existing report from within your Report List, you are presented with the options to define your report.

Tool Bar

  • Save
Once the name of the report has been entered within the Report Details, the save option will become available. For both new and existing reports, they must be saved before you can run the report.
  • Copy Report As
This allows you to create a copy of this report and add it to your list of reports under a different name. This option is only available after the new report has been saved for the first time.
  • Run
This starts a manual running of the report. The results of the Run are added to the Report History. This option will not be available when there are unsaved changes on a report. It will also not be available while a report generation is already running.
  • Download
Download a definition file for the report. This allows you to share a report definition with another Hornbill instance. This option is only available after the new report has been saved for the first time.
  • Upload
Upload a definition file for the report. This allows you to take a report that has been shared with you and upload it to your Hornbill instance. Uploading a definition file will overwrite any settings that you have previously set for that report, including the name.

General

  • Name
The name of the report. This is displayed in the list of reports as well has providing the default title on the report output.
  • Description
Use this area to describe the report
  • Report Output Type
  • Report Using
  • SQL Schema Designer
  • Report Entity
  • Report Measure
  • Report Status

Data Collection

Select Tables

  • Select Tables
  • Join

Select Columns

Select Filter

Select Ordering

Data Preview

Output Formats

  • Report Output Formats
  • Report Layout
  • Header Options
  • Report Table Options
  • Report Chart Options
  • Additional Data Formats

Schedule

  • Report Schedule
  • Publishing

Report History

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

Retrieved from "https://wiki.hornbill.com/index.php?title=Reports&oldid=27799"