Difference between revisions of "Report Definition"

From EMK Wiki
Jump to navigation Jump to search
 
(30 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
| Width="175" Align="Left"|
 
| Width="175" Align="Left"|
 
:Through the '''Create''' tab in the report section.
 
:Through the '''Create''' tab in the report section.
−
| Width="350" Align="Center"|[[File:CreateSaved.PNG|right]]
+
| Width="250" Align="Center"|[[File:CreateSaved.PNG|right]]
 
|}
 
|}
  
Line 19: Line 19:
 
* [[Time Series Data|Time-series]] (Monthly) data selection
 
* [[Time Series Data|Time-series]] (Monthly) data selection
  
 +
==Report Settings Panel==
  
−
==Report Settings Panel==
 
  
−
[[File:Creating.PNG|600px|right]]
+
[[File:Creating.PNG|700px|Center]]
 +
 
  
 
{|class="wikitable" style="text-align: left; color: black;"
 
{|class="wikitable" style="text-align: left; color: black;"
−
| Width="150" Align="Center"|'''Setting'''
+
! Width="75" Align="Center"|'''Setting'''
−
| Width="300"|'''Description'''
+
! Width="200" Align="Center"|'''Description'''
−
| Width="200"|'''Values'''
+
! Width="300" Align="Center"|'''Comment'''
 +
|-
 +
|
 +
:'''Date Range'''
 +
|
 +
:Defines the range of dates for which data is included in the report
 +
|
 +
:Uses the standard Ellserve [[Date Picker Configuration|date picker]]
 
|-
 
|-
 
|
 
|
 
:'''Report Name'''  
 
:'''Report Name'''  
 
|
 
|
−
:Unique Name to identify each individual Report Definition
+
:Unique Name to identify a defined report.
 
|
 
|
−
:User defined, can be anything
+
:Can be left blank of definition will not be saved
 
|-
 
|-
 
|
 
|
 
:'''Group by'''
 
:'''Group by'''
 
|
 
|
−
:Controls how the data is grouped together in the report. Changing this field will cause the fields in the Report Values area below to change
+
:Determines how the report groups output data
 
|
 
|
−
:Can be grouped by Account, Category or ICP
+
:*'''Account:''' Report will contain a line for each account active during the selected date range
 +
:*'''Category:''' Account time-series data will be aggregated to a selected account group level (e.g. business unit or GL code)
 +
:*'''ICP:'''  Report will contain a line for each connection (ICP) active during the selected date range
 +
 
 +
'NOTE: with the account grouping a connection (ICP) may appear twice in the output if the connection
 +
switched account number during the reporting time frame
 +
 
 +
'NOTE: with the ICP grouping connections will only show the most recently associated account number
 
|-
 
|-
 
|
 
|
Line 49: Line 64:
 
|
 
|
 
:CSV - Report will be downloaded as a CSV file which can be viewed in excel
 
:CSV - Report will be downloaded as a CSV file which can be viewed in excel
−
:HTML - Report will open in a new tab as a HTML file  
+
:HTML - Report will open in a new tab onscreen as a HTML file  
 
|-
 
|-
 
|
 
|
−
:Report Settings
+
:'''Report Settings'''
 
|
 
|
−
:Report Aggregation controls the period over which report data is aggregated. For example if monthly is selected then the Report Data will be outputted in monthly totals
+
:Defines the level of aggregation of time-series data.
 
|
 
|
 
:Monthly, Quarterly, Annually
 
:Monthly, Quarterly, Annually
 
|-
 
|-
−
|
+
 
−
:Date Range
 
−
|
 
−
:Controls the range of dates for which data is included in the report
 
−
|
 
−
:Date From, Date To
 
 
|}
 
|}
  
−
<span style="color:#2E5894"> '''>> To Run or Save the current Report Definition click on the corresponding button at the bottom left of the box'''</span>
 
  
 +
[[Ellserve:Ellserve|Home]] - [[Reporting|Parent]]
  
−
[[Ellserve:Ellserve|Home]] - [[Ellserve:Reporting|Back]]
+
==Descriptive data selection==
 +
[[File:Report Values2.PNG|600px|right]]
 +
 
 +
[[Descriptive Data|Descriptive data]] can be selected for reports with '''Account''' or '''ICP''' grouping.
  
−
== The Report Values Area ==
 
−
[[File:Report Values2.PNG|600px|right]]
 
−
When "Account" or "ICP" are selected in the Group By field, the two boxes to the right will be shown.
 
  
 
The ''Selected Values'' box displays the values which will be shown on the report and the ''Unselected Values'' box shows values which can be shown but currently will not be.
 
The ''Selected Values'' box displays the values which will be shown on the report and the ''Unselected Values'' box shows values which can be shown but currently will not be.
Line 83: Line 93:
  
 
[[File:Report Values 3.PNG|left]]
 
[[File:Report Values 3.PNG|left]]
−
When "Category" is selected in the Group By field, the ''Select Group'' box (shown to the left) will be shown instead of the two boxes above. This provides a drop down list of "categories" through which the data in the Report can be sorted by. For example if you were to select business unit then the aggregated data for each separate business unit would be shown in the Report.
+
For reports with a "Category" grouping, the ''Select Group'' drop down control will replace the value selection boxes . This controls provides a drop down list of "categories" for data aggregation. For example: if the '''business unit''' category is selected then a single row of aggregated data for each business unit will appear in the report.
 +
 
 +
''NOTE: A particular category may not appear in the report for the following reasons:
 +
* No invoices activity took place for any account in the category over the reporting period
 +
* The report [[Filtering Functions|filter]] setting removed any accounts that would have appeared under the category.''
  
−
[[Ellserve:Ellserve|Home]] - [[Ellserve:Reporting|Back]]
+
[[Ellserve:Ellserve|Home]] - [[Reporting|Parent]]
  
−
== Account Data Values ==
+
==Time-Series Data Selection==
 
[[File:Report values 4.PNG|right]]
 
[[File:Report values 4.PNG|right]]
−
The ''Account Data Values'' appear at the bottom of the page and are used to control what actual recorded data is displayed in a report.
+
The ''Account Data Values'' are the [[Time Series Data|time-series data]] elements that will be aggregated and reported.
 +
 
 +
A column will appear for every selected data value under each aggregation period.  For example a report aggregating data quarterly for the 2012 calendar year would show four columns for the data value '''normalised consumption'''.
  
−
<span style="color:#2E5894">'''>> To edit these fields''' click on the blue pencil to the left of the row you wish to edit. Three drop down boxes will appear (as is shown in the top row of the example). Select the values you want to be displayed in the Report, and then click the blue tick to confirm your selection. </span>
+
Data values are added to the report using the [[Monthly Value Picker|monthly value picker]].
  
−
The top row of the example will display "Energy Consumption Invoiced" when the tick is clicked and that data along with the "Energy Consumption Normalised" and "Energy Consumption Variance" data will be displayed in the Report.
+
[[Ellserve:Ellserve|Home]] - [[Reporting|Parent]]
  
−
<span style="color:#2E5894">'''>> Rows can be deleted''' by clicking the cross beside the row to be deleted.</span>
+
==Usage==
  
−
Another blank row is automatically added when the current row being edited is confirmed.
+
[[Running Reports|Click here]] to see how to create and run reports.
  
−
[[Ellserve:Ellserve|Home]] - [[Ellserve:Reporting|Back]]
+
[[Ellserve:Ellserve|Home]] - [[Reporting|Parent]]

Latest revision as of 14:45, 4 October 2013

Important Note: The report filter operates similarly to, but independently of the filter in the  data section section.
Filters set in the report section will be applied at report run time.
Filters set in the data section will be ignored at report run time.

The Create Report page

Access
Through the Create tab in the report section.
CreateSaved.PNG

The create report page has three functional area:

Report Settings Panel

Center


Setting Description Comment
Date Range
Defines the range of dates for which data is included in the report
Uses the standard Ellserve date picker
Report Name
Unique Name to identify a defined report.
Can be left blank of definition will not be saved
Group by
Determines how the report groups output data
  • Account: Report will contain a line for each account active during the selected date range
  • Category: Account time-series data will be aggregated to a selected account group level (e.g. business unit or GL code)
  • ICP: Report will contain a line for each connection (ICP) active during the selected date range
'NOTE: with the account grouping a connection (ICP) may appear twice in the output if the connection
switched account number during the reporting time frame

'NOTE: with the ICP grouping connections will only show the most recently associated account number
Render As
Determines what format the report will be outputted in.
CSV - Report will be downloaded as a CSV file which can be viewed in excel
HTML - Report will open in a new tab onscreen as a HTML file
Report Settings
Defines the level of aggregation of time-series data.
Monthly, Quarterly, Annually


Home - Parent

Descriptive data selection

Report Values2.PNG

Descriptive data can be selected for reports with Account or ICP grouping.


The Selected Values box displays the values which will be shown on the report and the Unselected Values box shows values which can be shown but currently will not be.

>> To move values between the two boxes highlight the value to be moved and then click on the left arrow to move it from Selected Values to Unselected Values or vice-versa.



Report Values 3.PNG

For reports with a "Category" grouping, the Select Group drop down control will replace the value selection boxes . This controls provides a drop down list of "categories" for data aggregation. For example: if the business unit category is selected then a single row of aggregated data for each business unit will appear in the report. 

NOTE: A particular category may not appear in the report for the following reasons:
* No invoices activity took place for any account in the category over the reporting period
* The report filter setting removed any accounts that would have appeared under the category.

Home - Parent

Time-Series Data Selection

Report values 4.PNG

The Account Data Values are the time-series data elements that will be aggregated and reported.

A column will appear for every selected data value under each aggregation period. For example a report aggregating data quarterly for the 2012 calendar year would show four columns for the data value normalised consumption.

Data values are added to the report using the monthly value picker.

Home - Parent

Usage

Click here to see how to create and run reports.

Home - Parent

Retrieved from "http://emk.energylink.co.nz/index.php?title=Report_Definition&oldid=5646"