Difference between revisions of "Excel Template File"

From Vital Soft Wiki
Jump to: navigation, search
>Johno
(Created page with "= Overview = Each Excel Template report is defined by a definition file that specifies how the report should be created. Each template file must contain a [[#Select Sheet|se...")
 
>Johno
(Overview)
Line 1: Line 1:
 
= Overview =
 
= Overview =
  
Each Excel Template report is defined by a definition file that specifies how the report should be created.  Each template file must contain a [[#Select Sheet|select sheet]], a "Main Sheet" and one or more "Definition sheets".
+
An Excel Template report is defined by a definition (template) file that specifies how the report should be created.  Each template file must contain a "select sheet", a "Main Sheet" and one or more "Definition sheets".
  
 
* Select Sheet
 
* Select Sheet
: This sheet contains local select definitions available only to the current report request.
+
: Like the DocumentDistribution file, the select sheet contains selection definitions.  Selections defined in the template file are local and can only be used by the current report request.
  
 
* Main Sheet
 
* Main Sheet
Line 10: Line 10:
  
 
* Definition Sheets
 
* Definition Sheets
: By default, the spreadsheet contains three sheets that define the standard reporting frequencies: Daily, Weekly and Monthly.
+
: Each definition sheet is a '''template''' of the sheet that will be created when the report is executed.
 
 
: The name of the sheet must match the report frequency that is passed via vsreload:
 
 
 
:: /VSJOBS/JVSRELOAD task Load=N Print=Daily
 
 
 
: Additional custom frequency sheets can be added, for example BoardReports, Finance, Tuesday etc.
 
 
 
: Custom frequencies are executed via a call to JVSRELOAD
 
 
 
:: /VSJOBS/JVSRELOAD task Load=N Print=BoardReports
 
 
 
: [[Setting up Document Distribution|Document Distribution Overview]]
 
 
 
: ''Note: Whenever a new frequency sheet is added, a corresponding change must be made to the vReportFrequencies variable in the main [[Vitalsigns.xls|Vital Signs configuration file]].''
 
  
 
= Select Sheet =
 
= Select Sheet =
  
 
'''This sheet contains the names and definitions of all global selections that have been defined.''' Selections defined in the select sheet of the DocumentDistribution file are global and are accessible to all report requests.  A selection consists of one or more steps that share the same [[Defining a Selection|selection name]].
 
'''This sheet contains the names and definitions of all global selections that have been defined.''' Selections defined in the select sheet of the DocumentDistribution file are global and are accessible to all report requests.  A selection consists of one or more steps that share the same [[Defining a Selection|selection name]].

Revision as of 19:49, 19 April 2013

Overview

An Excel Template report is defined by a definition (template) file that specifies how the report should be created. Each template file must contain a "select sheet", a "Main Sheet" and one or more "Definition sheets".

  • Select Sheet
Like the DocumentDistribution file, the select sheet contains selection definitions. Selections defined in the template file are local and can only be used by the current report request.
  • Main Sheet
This sheet contains a list of definition sheets to execute. The main sheet allows you to specify a selection that applies to the definition sheet and also a banding value. Specifying a banding field will cause "Sheet Level" banding to be applied.
  • Definition Sheets
Each definition sheet is a template of the sheet that will be created when the report is executed.

Select Sheet

This sheet contains the names and definitions of all global selections that have been defined. Selections defined in the select sheet of the DocumentDistribution file are global and are accessible to all report requests. A selection consists of one or more steps that share the same selection name.