Data Reporting Template - Revision history

Vmurrell at 11:36, 3 November 2025

2025-11-03T11:36:04Z

Vmurrell at 16:50, 13 September 2023

2023-09-13T16:50:02Z

Vmurrell at 14:57, 4 September 2023

2023-09-04T14:57:08Z

Vmurrell: /* Instruction Worksheet */

2021-05-10T13:48:18Z

‎Instruction Worksheet

Vmurrell at 09:18, 5 May 2021

2021-05-05T09:18:36Z

Mnelson: /* Instruction Worksheet */

2020-07-14T19:57:39Z

‎Instruction Worksheet

Mnelson: /* Instruction Worksheet */

2020-07-14T19:55:49Z

‎Instruction Worksheet

Mnelson: /* Instruction Worksheet */

2020-07-14T19:55:35Z

‎Instruction Worksheet

Mnelson: /* Instruction Worksheet */

2020-07-14T19:55:06Z

‎Instruction Worksheet

Mnelson: /* Instruction Worksheet */

2020-07-14T19:54:54Z

‎Instruction Worksheet

← Older revision		Revision as of 11:36, 3 November 2025
Line 1:		Line 1:
−	~~[[Category:Functions]]~~
	[[Category:Structural Metadata]]		[[Category:Structural Metadata]]
	[[Category:How_To]]		[[Category:How_To]]

@@ Line 1: / Line 1: @@
 [[Category:Functions]]
 [[Category:How_To]]
 = Overview =

@@ Line 1: / Line 1: @@
 [[Category:Functions]]
 = Overview =
 A Data Reporting Template is a metadata driven Excel Form to enable Data Providers to easily report data.  The form is Metadata Driven as the definition of each Worksheet takes into account:

@@ Line 46: / Line 46: @@
 **bold**
 ***bold and italic***
-\n New Line (or alternatively enter a carriage return when typing the text using the report template wizard)
+\n New Line (or alternatively enter a carriage return when typing the text using the report template wizard)*
 </pre>
 === Checking Table Summary Worksheet ===

@@ Line 8: / Line 8: @@
 * Whether to exclude fixed Dimension values, or place them in the Header
 * How to report Attribute values such as Observation Confidentiality, Status or Pre-Break values
-* Constraints are used to determine the universe of data, each form can contain a diffent universe of data depending on which Data Provider the form is generated for
+* Constraints are used to determine the universe of data, each form can contain a different universe of data depending on which Data Provider the form is generated for
-* Mathmatical Validation Rules can be used to inject formual and checking tables into the Worksheet
+* Mathematical Validation Rules can be used to inject formula and checking tables into the Worksheet
-A Reporting Template definition is created in the Fusion Registry and describes the contents and layout of one Excel Workbook. Each workbook contains at least one worksheet which is backed by the Dataflow that the data collection is for.  A workbook may contian multiple worksheets, enabling one excel file to be used to submit data for multiple datasets.  The Fusion Registry provides both a web User Interface and web services to generate the Excel Workbook for a Reporting Template for a specific Data Provider.  The contents of the Excel workbook are dynamically obtained based on who the Data Provider is.  This enables a single data collection template to be set up for multiple data providers, where each provider's workbook contains only the worksheets, and data cells they need to report data for.
+A Reporting Template definition is created in the Fusion Registry and describes the contents and layout of one Excel Workbook. Each workbook contains at least one worksheet which is backed by the Dataflow that the data collection is for.  A workbook may contain multiple worksheets, enabling one excel file to be used to submit data for multiple datasets.  The Fusion Registry provides both a web User Interface and web services to generate the Excel Workbook for a Reporting Template for a specific Data Provider.  The contents of the Excel workbook are dynamically obtained based on who the Data Provider is.  This enables a single data collection template to be set up for multiple data providers, where each provider's workbook contains only the worksheets, and data cells they need to report data for.
 As of Fusion Registry 10.1.0 it is also possible to use a Reporting Template as a way to describe a data output format.  This enables a user to query for data from the Fusion Registry web service, and the Fusion Registry will construct the output excel file according to the layout of the reporting template.
@@ Line 46: / Line 46: @@
 **bold**
 ***bold and italic***
-\n New Line (or alternativley enter a carrige return when typing the text using the report template wizard)
+\n New Line (or alternatively enter a carriage return when typing the text using the report template wizard)
 </pre>
 === Checking Table Summary Worksheet ===
-If Data Validation rules exist in the Fusion Reigstry against the Dataflow, these rules will be written as Excel Formula in the Data Worksheet.  A read only worksheet will be included which contains a high level summary of rules that exist and which rules have been violated (where the reported value does not match the value expected from the mathmatical expression)
+If Data Validation rules exist in the Fusion Registry against the Dataflow, these rules will be written as Excel Formula in the Data Worksheet.  A read only worksheet will be included which contains a high level summary of rules that exist and which rules have been violated (where the reported value does not match the value expected from the mathematical expression)
 === Data Worksheets ===
-The Data worksheets contain tables of cells for data entry.  Each Data Worksheet is linked to a single [[Dataflow_-_Structural_Metadata_Management|Dataflow]].  The table layout is based on the Dimensions of the [[Data_Structure_Definition_(DSD)_-_Structural_Metadata_Management|Data Structure Definition]] for which the data is for.  The Dimensions in the Headers and Rows are defined at design time by the owner of the Reporting Template.  The values in the headers and rows (the Dimension members) are derived by dertermining the reporting universe for the data reporter.  The reporting universe may change based on Data Provider, as [[Reporting_Constraints_-_Structural_Metadata_Management|reporting rules]] for each Data Provider may differ, and as such the reporting template data worksheets may differ in content and size depending on who the template was created for.
+The Data worksheets contain tables of cells for data entry.  Each Data Worksheet is linked to a single [[Dataflow_-_Structural_Metadata_Management|Dataflow]].  The table layout is based on the Dimensions of the [[Data_Structure_Definition_(DSD)_-_Structural_Metadata_Management|Data Structure Definition]] for which the data is for.  The Dimensions in the Headers and Rows are defined at design time by the owner of the Reporting Template.  The values in the headers and rows (the Dimension members) are derived by determining the reporting universe for the data reporter.  The reporting universe may change based on Data Provider, as [[Reporting_Constraints_-_Structural_Metadata_Management|reporting rules]] for each Data Provider may differ, and as such the reporting template data worksheets may differ in content and size depending on who the template was created for.
 == Floating Point Errors ==
@@ Line 196: / Line 196: @@
 # The Dimensions that are set to be Variable in the Report Templates definition.
-The first aspect is based on the Data Structure Definition used by the Dataflow.  The full universe can be calculated by multiplying the length of each Codelist for each Dimension defined by the Data Structure Definition.  This Universe can be quite large, and generally needs further restictions by applying the 2nd aspect, the Content Constraints.   Note the Frequency Dimenison is excluded from this calculation because when the Excel workbook is generated, it is generated for a specific Time Period or Range.  The Time Period is defined using SDMX Date formatting, for example a template generated for 2002-2004 would fix the Frequency for the excel workbook to Annual.
+The first aspect is based on the Data Structure Definition used by the Dataflow.  The full universe can be calculated by multiplying the length of each Codelist for each Dimension defined by the Data Structure Definition.  This Universe can be quite large, and generally needs further restrictions by applying the 2nd aspect, the Content Constraints.   Note the Frequency Dimension is excluded from this calculation because when the Excel workbook is generated, it is generated for a specific Time Period or Range.  The Time Period is defined using SDMX Date formatting, for example a template generated for 2002-2004 would fix the Frequency for the excel workbook to Annual.
 The second aspect helps to tailor a worksheet to a specific collection or Data Provider.  Take for example a Data Structure with 4 Dimensions with the given number of possible values; Frequency (8), Domain(20), Reference Area(240), and Indicator (65k).  The total reporting universe if 20 * 240 * 65k is 312million cells (we do not include Frequency in the calculation).  The Data Structure may be re-used across multiple Dataflows; Central Government Debt, Trade, Balance of Payments, etc.  Each Dataflow only collects data for a subset of Indicators, and fixes the Domain.  In this instance there would be a Content Constraint defined to restrict <b>Domain</b> to a single value for the Trade Dataflow, and restrict the Indicators to only the ones which are collected for Trade say 30.  The universe of data is now only 1 * 240 * 20 or 4,800 observation cells.  The next layer of restrictions can be applied to either the Provision Agreement, or Data Provider.  When the collection is from UK organisations, the <b>Reference Area</b> Dimension only allows the UK to be reported. Now the excel file will only contain 20 cells for the United Kingdom to complete for the Trade collection.
@@ Line 231: / Line 231: @@
 <br/><b>EUR = FR * DE</b>
-If FR is not present in the worksheet the ‘default to zero’ logic were assumed, this would result in any reported value, other than zero, for EUR to fail the rule.  It is therefore important to build the validation rules with care, or at least ensure the user who is reporting a value for EUR is not restricted from reporting the relevent inputs for this validation rule.
+If FR is not present in the worksheet the ‘default to zero’ logic were assumed, this would result in any reported value, other than zero, for EUR to fail the rule.  It is therefore important to build the validation rules with care, or at least ensure the user who is reporting a value for EUR is not restricted from reporting the relevant inputs for this validation rule.
 = Workbook Locale =
@@ Line 263: / Line 263: @@
 The workbook contains the required metadata to read it back in, even if the report template definition has been subsequently changed or deleted since the workbook’s initial creation.  As long as the Fusion Registry contains the same Provision Agreement and Dataflow that the worksheet references, and the Data Structure Definition has not had any changes to the number of, or order of Dimensions, then the worksheet will be read back in.
 = Populating a Workbook from a Dataset =
-A Data Provider can to export a Workbook for a Report Template and have it prepopulated with data.  This can be achieved either by using the Fusion Registry Data Transformation services in order to 'inject' the data from a dataset in a different format into their workbook.  The Data Transformation Service needs to know what the desired output data format is. Refer to the [[Data_Formats]] table to lookup the correct Accept Header to use.
+A Data Provider can to export a Workbook for a Report Template and have it pre-populated with data.  This can be achieved either by using the Fusion Registry Data Transformation services in order to 'inject' the data from a dataset in a different format into their workbook.  The Data Transformation Service needs to know what the desired output data format is. Refer to the [[Data_Formats]] table to lookup the correct Accept Header to use.
 Alternatively, if the Fusion Registry is being used as a Data Store (or virtual store) on the Data Provider’s data, then the Data Provider can simply ask for a Reporting Template for a given time period with existing data already included.

@@ Line 36: / Line 36: @@
 <pre>
-# Heading 1
+# Heading 1     - Note for all heading the space after the # symbol
 ## Heading 2
 ### Heading 3
@@ Line 46: / Line 46: @@
 **bold**
 ***bold and italic***
 </pre>

@@ Line 31: / Line 31: @@
 === Instruction Worksheet ===
 An instruction worksheet is an optional worksheet. It can be used to transmit any textual information to the user of the worksheet.  The instruction sheet content is text, with support for the following markdown syntax:
 <pre>
@@ Line 44: / Line 47: @@
 ***bold and italic***
 </pre>
 === Checking Table Summary Worksheet ===

@@ Line 45: / Line 45: @@
 </nowiki>
-[[File:Rt-instruction-sheet.png|left|thumb]]
+[[File:Rt-instruction-sheet.png|center|thumb]]
 === Checking Table Summary Worksheet ===