Difference between revisions of "Fusion-Excel-Series"
Jump to navigation
Jump to search
(→Example) |
(→Example) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
[[Category:SdmxDataFormat]] | [[Category:SdmxDataFormat]] | ||
| − | |||
[[File:Header fixed Tabs.png|thumb|Fusion Excel Series with header section and tabs]] | [[File:Header fixed Tabs.png|thumb|Fusion Excel Series with header section and tabs]] | ||
[[File:No header.png|thumb|Fusion Excel Series with only the series key as the header (not broken down by dimensions)]] | [[File:No header.png|thumb|Fusion Excel Series with only the series key as the header (not broken down by dimensions)]] | ||
| Line 28: | Line 26: | ||
|- | |- | ||
| dimensionAtObservation || [dimension id] <br/> default TIME_PEREIOD for time series data || Defines which dimension is iterated over on the rows | | dimensionAtObservation || [dimension id] <br/> default TIME_PEREIOD for time series data || Defines which dimension is iterated over on the rows | ||
| + | |- | ||
| + | | detail || '''full''' or '''dataonly''' <br/> default full|| Use '''dataonly''' to exclude series attributes from the output | ||
|- | |- | ||
| slice || [dimension id] <br/> default to N/A || If provided, an Excel worksheet will be created for each distinct value in the dataset for this Dimension | | slice || [dimension id] <br/> default to N/A || If provided, an Excel worksheet will be created for each distinct value in the dataset for this Dimension | ||
| Line 35: | Line 35: | ||
| header || include | exclude <br/> (include is default) || The header refers to the breakdown of Dimension values that sits above each series column. If excluded each column header is simply the series key. | | header || include | exclude <br/> (include is default) || The header refers to the breakdown of Dimension values that sits above each series column. If excluded each column header is simply the series key. | ||
|- | |- | ||
| − | | | + | | fixed || '''keep''' or '''promote''' or '''remove''' <br/> (promote is default) || Describes how to handle Dimension or Series Attribute values which are the same for the whole dataset. |
* '''keep''' - keep the values in the header | * '''keep''' - keep the values in the header | ||
* '''promote''' - remove the values from the header, promote them to a high level 'fixed values' table | * '''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 | * '''remove''' - do not ouput Dimension lables when they have a fixed value | ||
|} | |} | ||
| + | |||
| + | <strong>Note:</strong> The same formatting can be applied using [[Data_Formats|HTTP Accept Headers]] as opposed to using REST query parameters. | ||
=Example= | =Example= | ||
| + | TIME in first column, remainder of Dimensions in column headers:<p/> | ||
| + | https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/.GCI..?format=excel-series&labels=both | ||
| + | |||
| + | REF_AREA in first column, remainder of Dimensions in column headers (in this case only Time), worksheet per SUB_INDICATOR<p/> | ||
| + | https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/.GCI..?format=excel-series&labels=both&dimensionAtObservation=REF_AREA&slice=SUB_INDICATOR | ||
Latest revision as of 03:21, 28 April 2022
Overview
The Fusion-Excel-Series format is not an official SDMX format. It has a similar layout to the Fusion-CSV-Series format, in that a Series is output per Column. The series can iterate values over time, or any other designated dimension to be at the observation level.
The advantages over CSV is that Excel provides a few additional features which are now possible in CSV, these are:
- The ability to slice the data over a Dimension to output a worksheet per Dimension value, e.g slice by FREQ would output Annual Data in one worksheet, Monthly data in another, and so on.
- The ability to promote fixed values to a header. Similar to the Fusion_Excel_Data format, reported values which are the same for the whole worksheet can be reported once in a header section
- Excel's freeze pane feature is used to make the inner table scrollable while keeping the column and row headers in place
- The use of colour to style the output, making the data easier to read
Fusion-Excel-Series is an export format only, supported by Fusion Registry, Fusion Edge Server and Fusion Data Browser.
Fusion-Excel-Series 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.
| Query Parameter | Values | Description |
|---|---|---|
| format | excel-series | Required to output the dataset in fusion-excel-series format |
| dimensionAtObservation | [dimension id] default TIME_PEREIOD for time series data |
Defines which dimension is iterated over on the rows |
| 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 |
| header | exclude (include is default) |
The header refers to the breakdown of Dimension values that sits above each series column. If excluded each column header is simply the series key. |
| 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.
|
Note: The same formatting can be applied using HTTP Accept Headers as opposed to using REST query parameters.
Example
TIME in first column, remainder of Dimensions in column headers:
REF_AREA in first column, remainder of Dimensions in column headers (in this case only Time), worksheet per SUB_INDICATOR
