Excel Reporting Template Data Format

From Fusion Registry Wiki
Revision as of 10:52, 30 March 2020 by Mnelson (talk | contribs) (Overview)
Jump to navigation Jump to search


Overview

The Reporting Template Data format is not an official SDMX format. It was developed by Metadata Technology initially as a format for data collection, simplifying the data reporting process by building an Excel workbook which prebuilds all the observation cells the Data Provider is expected to report. This design means the data reporter only has to concern themselves with filling in the observation values, and not deciding what classification ids they need to report for each Dimension (like the Fusion-Excel data format).

However, due to the flexability of the format, which allows each Agency to design the layout of each worksheet tailored for each Dataflow, the use cases were extended to support Reporting Templates as a data dissemination format. So from Fusion Registry 10.2.x and higher, it is possible to query for a data in this format.

The Reporting Template Data format differs from all the other CSV and Excel style data formats as there is no set layout. The layout (rows and columns) and inclusion / exclusion of information, such as Attributes, is designed in the Fusion Registry by creating a Reporting Template Definition. The output dataset is built into a table in Excel, with the table populated with the observation values, and optionally observation attributes (if it has been designed to include this information).

Report template

For more information on this format, click here.

Formatting Using Query Parameters

The following URL parameters can be used in a RESTful query for to get data in Excel format.

  • format=reporttemplate
  • partial=true

The partial parameter is used to indicate that the output excel file should build the output table based on the data in the response. The alternative is to build the output table based on the full universe of data for that dataset, and populate the cells with those in the dataset.

Example

https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest/data/WB,GCI,1.0/GHA.GCI..?format=reporttemplate

Note: The same formatting can be applied using HTTP Accept Headers as opposed to query parameters.