Fusion-Excel-Table - Revision history

Plazarou at 15:06, 19 August 2020

2020-08-19T15:06:21Z

Mnelson at 09:01, 10 August 2020

2020-08-10T09:01:16Z

Mnelson at 08:55, 10 August 2020

2020-08-10T08:55:49Z

Mnelson: /* Formatting Using Query Parameters */

2020-08-05T13:50:24Z

‎Formatting Using Query Parameters

Mnelson: Mnelson moved page Fusion Excel Table to Fusion-Excel-Table

2020-08-04T12:21:39Z

Mnelson moved page Fusion Excel Table to Fusion-Excel-Table

Mnelson at 12:20, 4 August 2020

2020-08-04T12:20:43Z

Mnelson: /* Formatting Using Query Parameters */

2020-08-04T12:20:33Z

‎Formatting Using Query Parameters

Mnelson: Created page with "Category:SdmxDataFormat =Overview= The Fusion-Excel-Table format is not an official SDMX format. It outputs the dataset as a table, where the Dimension placement (rows/c..."

2020-08-04T11:55:33Z

Created page with "Category:SdmxDataFormat =Overview= The Fusion-Excel-Table format is not an official SDMX format. It outputs the dataset as a table, where the Dimension placement (rows/c..."

New page

[[Category:SdmxDataFormat]]

=Overview=
The Fusion-Excel-Table format is not an official SDMX format. It outputs the dataset as a table, where the Dimension placement (rows/columns) can be defined dynamically.

The Dimension can either take one of the following placements:
* Header - The dimension values iterate over the column in the table, i.e column 1 is USD column 2 is GBP. Multiple Dimensions can be assigen to the row
* Row - The dimension values iterate over the rows in the table, i.e row 1 is USD row 2 is GBP. Multiple Dimensions can be assigen to the row
* Slice - one dimension can become a slice, a worksheet will be output per slice value, e.g slice by FREQ would output Annual Data in one worksheet, Monthly data in another, and so on.
* Fixed - determined by the system on output, if the Dimension has a fixed value it is either promoted to the fixed header section or removed from the output (defeined by the user)

Fusion-Excel-Table can be a '''read/write format''', meaning the dataset can be modified and read back in by the Fusion Registry. However by default the format is read only unless it is explicitly asked to be read/write, this is because the additional information written to the workbook to make it read/write can slow down the performance when opening the workbook in Excel.

Fusion-Excel-Table became available from Fusion Registry v10.4.5 onwards

=Formatting Using Query Parameters=
The following URL parameters can be used in a RESTful query for to get data in Excel format.

{| class="wikitable"
|-
! Query Parameter !! Values !! Description
|-
| format || fusion-excel-table|| Required to output the dataset in fusion-excel-series format
|-
| detail || '''full''' or '''dataonly''' default full|| Use '''dataonly''' to exclude series attributes from the output
|-
| slice || [dimension id] default to N/A || If provided, an Excel worksheet will be created for each distinct value in the dataset for this Dimension
|-
| labels || '''id''' or '''name''' or '''both''' (id is default)|| Output Ids or the corresponding name, or id and name
|-
| fixed || '''keep''' or '''promote''' or '''remove''' (promote is default) || Describes how to handle Dimension or Series Attribute values which are the same for the whole dataset.
* '''promote''' - remove the values from the header, promote them to a high level 'fixed values' table
* '''remove''' - do not ouput Dimension lables when they have a fixed value
|}

Note: The same formatting can be applied using [[Data_Formats|HTTP Accept Headers]] as opposed to using REST query parameters.

=Example=

@@ Line 20: / Line 20: @@
 ! Query Parameter !! Values !! Description
 |-
-| format || fusion-excel-table || Required to output the dataset in fusion-excel-series format
+| format || excel-table || Required to output the dataset in fusion-excel-series format
 |-
 | detail ||  '''full''' or '''dataonly''' <br/> default full|| Use '''dataonly''' to exclude series attributes from the output

@@ Line 6: / Line 6: @@
 The Dimension can either take one of the following placements:
-* Header - The dimension values iterate over the column in the table, i.e column 1 is USD column 2 is GBP.  Multiple Dimensions can be assigen to the row
+* Header - The dimension values iterate over the column in the table, i.e column 1 is USD column 2 is GBP.  Multiple Dimensions can be assigned to the row
-* Row - The dimension values iterate over the rows in the table, i.e row 1 is USD row 2 is GBP.  Multiple Dimensions can be assigen to the row
+* Row - The dimension values iterate over the rows in the table, i.e row 1 is USD row 2 is GBP.  Multiple Dimensions can be assigned to the row
 * Slice - one dimension can become a slice, a worksheet will be output per slice value, e.g slice by FREQ would output Annual Data in one worksheet, Monthly data in another, and so on.
 * Fixed - determined by the system on output, if the Dimension has a fixed value it is either promoted to the fixed header section or removed from the output (defeined by the user)

@@ Line 1: / Line 1: @@
 [[Category:SdmxDataFormat]]
 [[File:Excel-table.png|thumb|Time and Counterpart Area Dimensions in rows]]
 =Overview=
 The Fusion-Excel-Table format is not an official SDMX format.  It outputs the dataset as a table, where the Dimension placement (rows/columns) can be defined dynamically.

← Older revision	Revision as of 12:21, 4 August 2020
(No difference)

@@ Line 21: / Line 21: @@
 ! Query Parameter !! Values !! Description
 |-
-| format || fusion-excel-table|| Required to output the dataset in fusion-excel-series format
+| format || fusion-excel-table || Required to output the dataset in fusion-excel-series format
 |-
 | detail ||  '''full''' or '''dataonly''' <br/> default full|| Use '''dataonly''' to exclude series attributes from the output
@@ Line 32: / Line 32: @@
 * '''promote''' - remove the values from the header, promote them to a high level 'fixed values' table
 * '''remove''' - do not ouput Dimension lables when they have a fixed value
 |}