ifference between revisions of "EMK:Output Specs"

From EMK Wiki
Jump to navigation Jump to search
Line 4: Line 4:
  
  
−
The OutputSpecs window has the following components:
+
The Output Specs window has the following components:
 
*The ''''OS Details Box:'''' Used to identify ''(Name)'' and describe ''(Description)'' the OS Resource.
 
*The ''''OS Details Box:'''' Used to identify ''(Name)'' and describe ''(Description)'' the OS Resource.
 
*The ''''OS Partition Box:'''' Specifies how the results data will be summarised and presented.
 
*The ''''OS Partition Box:'''' Specifies how the results data will be summarised and presented.
Line 10: Line 10:
  
 
Note: OS Reports can be produced from previously generated data from the ''''Results window'''' or ''''Results Menu''''.
 
Note: OS Reports can be produced from previously generated data from the ''''Results window'''' or ''''Results Menu''''.
 +
 +
==The Output Specs Details Box==
 +
 +
'''OS Details Box Fields'''
 +
{|class="wikitable"
 +
|-
 +
| ''Name'' || OS Resource name - used to reference the OS in other Resources.
 +
|-
 +
| ''Description'' || Free text field for supplementary information.'
 +
|-
 +
| ''Prefilters'' || specifies a date range that the OS will only process data for - this allows the OS to be used on multiple Results sets covering disparate date ranges and only extract results for a common period.
 +
|}
 +
 +
==Formatting Check Boxes==
 +
 +
The Formatting Check Boxes are used to control the output of headers in columns and rows in the output.  If the OS Resource is used when both boxes are left unchecked, then a heading only appears once in the output.  For example a parent row heading will only appear with the first child row heading as in the table below:
 +
 +
{|class="wikitable"
 +
|-
 +
| Parent Row Heading 1 || Child Row Heading 1
 +
|-
 +
|  || Child Row Heading 2
 +
|-
 +
| || Child Row Heading 3
 +
|-
 +
| Parent Row Heading 2 || Child Row Heading 1
 +
|-
 +
|  || Child Row Heading 2
 +
|-
 +
|  || Child Row Heading 3
 +
|}
  
  
 
[[EMK:Outputs | Back to Outputs]]
 
[[EMK:Outputs | Back to Outputs]]

Revision as of 15:52, 12 November 2012

Example OutputSpec Window

An Output specification (OS) Resource allows you to define custom Reports in a tabular form using Run Output data. Reports generated using OS Resources are in text based, comma separated (csv) form.


The Output Specs window has the following components:

  • The 'OS Details Box:' Used to identify (Name) and describe (Description) the OS Resource.
  • The 'OS Partition Box:' Specifies how the results data will be summarised and presented.
  • Two 'Formatting Check Boxes:' Repeat Column headings and Repeat Row headings - which determine whether the parent column and row headings appear once per column or row (Boxes unchecked), or for every column and row of the columns they apply to (Boxes checked) respectively.

Note: OS Reports can be produced from previously generated data from the 'Results window' or 'Results Menu'.

The Output Specs Details Box

OS Details Box Fields

Name OS Resource name - used to reference the OS in other Resources.
Description Free text field for supplementary information.'
Prefilters specifies a date range that the OS will only process data for - this allows the OS to be used on multiple Results sets covering disparate date ranges and only extract results for a common period.

Formatting Check Boxes

The Formatting Check Boxes are used to control the output of headers in columns and rows in the output. If the OS Resource is used when both boxes are left unchecked, then a heading only appears once in the output. For example a parent row heading will only appear with the first child row heading as in the table below:

Parent Row Heading 1 Child Row Heading 1
Child Row Heading 2
Child Row Heading 3
Parent Row Heading 2 Child Row Heading 1
Child Row Heading 2
Child Row Heading 3


Back to Outputs

Retrieved from "http://emk.energylink.co.nz/index.php?title=EMK:Output_Specs&oldid=1499"