Difference between revisions of "Fusion Edge Server Properties"
(→Limiting Series and Observations) |
(→Limiting Supported Structure Formats) |
||
| Line 26: | Line 26: | ||
format.structure=[format1],[format2] | format.structure=[format1],[format2] | ||
| + | |||
| + | This property defines which formats are supported, if this property is not provided all formats will be supported. If this property is provided, only the formats in this list will be supported. | ||
| + | |||
| + | Each [format] is a VND header which is used to represent the format, sett [[Data_Formats]] for a list of supported VND Headers. | ||
| + | |||
| + | The supported formats are: | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Structure Format !! VND Header | ||
| + | |- | ||
| + | | SDMX EDI || application/vnd.sdmx.structure;version=edi | ||
| + | |- | ||
| + | | application/vnd.sdmx.structure+xml;version=1.0 || SDMX v1.0 | ||
| + | |- | ||
| + | | application/vnd.sdmx.structure+xml;version=2.0 || SDMX v2.0 | ||
| + | |- | ||
| + | | application/vnd.sdmx.structure+xml;version=2.1 || SDMX v2.1 | ||
| + | |- | ||
| + | | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet|| Excel | ||
| + | |- | ||
| + | | application/vnd.fusion.json || Fusion JSON | ||
| + | |- | ||
| + | | application/vnd.sdmx.json || SDMX JSON| | ||
| + | } | ||
| + | |||
| + | '''Example:''' <br/> | ||
| + | format.structure=application/vnd.sdmx.structure;version=edi,application/json | ||
Revision as of 06:14, 30 April 2020
Contents
Overview
The Fusion Edge Server provides configuration options on various aspects of the Edge Server. To set these configurations, create a file under the Edge Server Directory with the name: edgeserver.properties.
Public URL
The Edge Server application and web service URL should be defined in the edge server properties file. These URLs are used in responses to structure queries which include links to associated reference metadata, and stub structures which link back to the full artefact.
The URLs are split into two parts, the application URL, which should be a reference to the public application server, and the rest url which is the POSTfix URL to the web service, for example:
app.url=https://myserver.myorg.org/Edge rest.url=/sdmx
The above setting would make the SDMX web service entry point: https://myserver.myorg.org/Edge/sdmx
Limiting Series and Observations
To place a limit on the number of series and the number of observations that can be queried via the web service the following two properties are supported:
limit.obs=12345 limit.series=1234
The numeric value indicates the maximum number of series or observations that can be returned from a single data query.
If the limit is exceeded an HTTP status code of 413 (Payload Too Large) will be returned to the client.
Limiting Supported Structure Formats
To enforce a restriction on which structure formats are supported use the format.structure property as follows:
format.structure=[format1],[format2]
This property defines which formats are supported, if this property is not provided all formats will be supported. If this property is provided, only the formats in this list will be supported.
Each [format] is a VND header which is used to represent the format, sett Data_Formats for a list of supported VND Headers.
The supported formats are:
| Structure Format | VND Header |
|---|---|
| SDMX EDI | application/vnd.sdmx.structure;version=edi |
| application/vnd.sdmx.structure+xml;version=1.0 | SDMX v1.0 |
| application/vnd.sdmx.structure+xml;version=2.0 | SDMX v2.0 |
| application/vnd.sdmx.structure+xml;version=2.1 | SDMX v2.1 |
| application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Excel |
| application/vnd.fusion.json | Fusion JSON |
| application/vnd.sdmx.json |
} Example: |
