Branding SDMX Downloads - SuperWEB2
SuperWEB2 users can download data from Table View in a variety of formats, including SDMX (Statistical Data and Metadata eXchange) Version 2.0:
The two available SDMX options are:
- An archive (.zip) file containing the SDMX data set (.xml) and the SDMX structure definition (.xml).
- SDMX structure definition (.xml).
Unlike downloads to Excel and CSV formats, which save wafers, SDMX downloads save cubes.
If you use the Job Queue Manager, you also need to configure SDMX settings in the Job Queue Manager as well as in SuperWEB2. For more information, see Job Queue Manager.
There are a number of parameters you can configure in <tomcat_home>\webapps\webapi\WEB-INF\web.xml.
Locate the following section:
<!-- SDMX configuration -->
<context-param>
<description>SDMX agency Id </description>
<param-name>AGENCY_ID</param-name>
<param-value>AGENCY_ID</param-value>
</context-param>
<context-param>
<description>SDMX agency name </description>
<param-name>AGENCY_NAME</param-name>
<param-value>AGENCY_NAME</param-value>
</context-param>
<context-param>
<description>SDMX user generated structure agency id</description>
<param-name>USER_GENERATED_STRUCTURE_AGENCY_ID</param-name>
<param-value>USER_GENERATED_STRUCTURE_AGENCY_ID</param-value>
</context-param>
<context-param>
<description>SDMX relative standard error id</description>
<param-name>RSE_CONCEPT_ID</param-name>
<param-value>RSE</param-value>
</context-param>
<context-param>
<description>SDMX relative standard error name</description>
<param-name>RSE_CONCEPT_NAME</param-name>
<param-value>Relative standard error</param-value>
</context-param>
<context-param>
<description>SDMX relative standard error description</description>
<param-name>RSE_CONCEPT_DESCRIPTION</param-name>
<param-value></param-value>
</context-param>
The parameters are as follows:
Parameter | Description | Valid Characters |
---|---|---|
AGENCY_ID | The SDMX agency ID. This value will be used in the SDMX The Agency ID is also written to the codelists in the SDMX structure definition file. | A-Z, a-z, 0-9, -, _, : and '.' |
AGENCY_NAME | The SDMX agency name. The Agency ID and Agency Name are written to the sender field in the headers of the SDMX structure definition file and the SDMX data file. | A-Z, a-z, *, @, 0-9, _, -and $ |
USER_GENERATED_STRUCTURE_AGENCY_ID | The user generated agency ID. This is written to the Agency ID field of the KeyFamilies section of the SDMX structure definition file. | A-Z, a-z, *, @, 0-9, _, -and $ |
RSE_CONCEPT_ID | The Relative Standard Error ID. | A-Z, a-z, *, @, 0-9, _, -and $ |
RSE_CONCEPT_NAME | The Relative Standard Error Name. For a weighted database that contains Relative Standard Error data, the SDMX message indicates the cell relative standard error in the GenericData SDMX message. The ConceptScheme includes an RSE concept and the KeyFamily components include an attribute for RSE. | |
RSE_CONCEPT_DESCRIPTION | The Relative Standard Error Description. By default the description is empty. When a description is not set, the <description> is not generated in the SDMX output |
Survey Date
You can also set the survey date for the database, by editing <tomcat_home>\webapps\webapi\WEB-INF\database-metadata.xml
Add an entry in the following format inside the <properties> ... </properties>
element:
<entry key="ATTRIBUTE|SURVEY-DATE|uri:/database/bank">2010-03-05</entry>
The date is in ISO-8601 format: YYYY-MM-DD. Make sure you include the correct database ID (in this example the database ID is bank).
Restart Tomcat or the SuperWEB2 service after making these changes.