ifference between revisions of "EMK:Reports"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
The '''Raw Data Reports Selection Box''' provides a non-editable list of Entity.Traits available for output in CSV form. Ticking the box next to a listed report item automatically includes it in the report batch. | The '''Raw Data Reports Selection Box''' provides a non-editable list of Entity.Traits available for output in CSV form. Ticking the box next to a listed report item automatically includes it in the report batch. | ||
| − | The '''OS Selection Box''' allows pre-defined Output Specifications to be assigned to the Report | + | The '''OS Selection Box''' allows pre-defined Output Specifications to be assigned to the Reports Batch. A list of all pre-defined OS Resources is displayed in the Box. OS Resources with ticked check boxes will be included in the Report Batch. |
| − | + | ||
| + | The '''Output Details Area''' is used to specify the location where the output produced by the specification will be saved. It has the following features: | ||
| + | {|class="wikitable" | ||
| + | |- | ||
| + | | ''Save files to the default directory'' tick box || Causes csv files created when the Resource Batch is executed to be saved in the current Working Directory | ||
| + | |- | ||
| + | | ''Save files to'' tick box || Enables the destination of Report Batch output to be specified | ||
| + | |- | ||
| + | | ''Save files to'' field || The location where Report Batch Output files will be saved (when the 'Save files to' option is enabled) | ||
| + | |- | ||
| + | | '...' button || Opens the standard Windows directory browser to alternatively specify the 'Save file to" location | ||
| + | |- | ||
| + | | ''The view specified folder'' button (folder icon) || Opens the folder specified in the ''Save files to'' field | ||
| + | |- | ||
| + | | ''Run Report Now'' button || Causes the immediate execution of the Report Batch on the Results set selected in the 'Results Set' field | ||
| + | |- | ||
| + | | ''Results Set'' field || A drop down list to select a specific Result Set on which the Report Batch can be immediately executed | ||
| + | |} | ||
| + | |||
| + | |||
| + | '''How to execute a Report Batch''' | ||
| + | |||
| + | A Report Batch can produce output from Run Results in three ways: | ||
| + | #Directly from the Reports Resource Editor using the ''<Run Report now, on -> >'' button. | ||
| + | #By including the name of the Report Batch in the '''''Reports Batch''''' field of the ''Run Window'', in which case the Reports will be generated during Run time. | ||
| + | #On existing Results Sets (without the Report batch in the Run Window) by: | ||
| + | ##browsing for and highlighting a specific Run in the '''Results Panel''' | ||
[[EMK:Outputs | Outputs]] | [[EMK:Outputs | Outputs]] | ||
Revision as of 11:07, 13 November 2012
The Report Resource allows you to Batch several Output types into a single, convenient and re-usable specification. Two generic Report types can be included:
- Raw Data Reports: These provide data for a single Entity.Trait formatted as an Excel-compatible csv file.
- Output Specifications (OS) reports.
The Reports Window contains the following components;
- Report Details Box (provides name and description of Report).
- Raw Data Reports Selection Box
- OS Selection Box
- The Output Details Area
The Raw Data Reports Selection Box provides a non-editable list of Entity.Traits available for output in CSV form. Ticking the box next to a listed report item automatically includes it in the report batch.
The OS Selection Box allows pre-defined Output Specifications to be assigned to the Reports Batch. A list of all pre-defined OS Resources is displayed in the Box. OS Resources with ticked check boxes will be included in the Report Batch.
The Output Details Area is used to specify the location where the output produced by the specification will be saved. It has the following features:
| Save files to the default directory tick box | Causes csv files created when the Resource Batch is executed to be saved in the current Working Directory |
| Save files to tick box | Enables the destination of Report Batch output to be specified |
| Save files to field | The location where Report Batch Output files will be saved (when the 'Save files to' option is enabled) |
| '...' button | Opens the standard Windows directory browser to alternatively specify the 'Save file to" location |
| The view specified folder button (folder icon) | Opens the folder specified in the Save files to field |
| Run Report Now button | Causes the immediate execution of the Report Batch on the Results set selected in the 'Results Set' field |
| Results Set field | A drop down list to select a specific Result Set on which the Report Batch can be immediately executed |
How to execute a Report Batch
A Report Batch can produce output from Run Results in three ways:
- Directly from the Reports Resource Editor using the <Run Report now, on -> > button.
- By including the name of the Report Batch in the Reports Batch field of the Run Window, in which case the Reports will be generated during Run time.
- On existing Results Sets (without the Report batch in the Run Window) by:
- browsing for and highlighting a specific Run in the Results Panel