Difference between revisions of "Set up Connections (DP)"
Jump to navigation
Jump to search
(Created page with "Category:Data Portal Functions To use Fusion Data Portal you must first set the connection(s) to the source data. Several types are available. File:Data Portal Connec...") |
(→Overview) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Data Portal Functions]] | [[Category:Data Portal Functions]] | ||
| + | == Overview == | ||
To use Fusion Data Portal you must first set the connection(s) to the source data. Several types are available. | To use Fusion Data Portal you must first set the connection(s) to the source data. Several types are available. | ||
| − | [[File: | + | [[File:Available Connection Types.png|600px]]<br> |
=== SDMX REST API (V1) === | === SDMX REST API (V1) === | ||
| − | Example: | + | '''Example''': |
https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest | https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest | ||
| + | |||
| + | ==== Connection Properties ==== | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | | URL || SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml | ||
| + | |- | ||
| + | | Updated After || Only pull data updated after the last pull request. The web service must support the updatedAfter query parameter. | ||
| + | |- | ||
| + | | User Name || Optional Username to authenticate with API (using HTTP Basic Authentication). | ||
| + | |- | ||
| + | | Password || Optional Password to authenticate with API (using HTTP Basic Authentication). | ||
| + | |} | ||
=== Eurostat === | === Eurostat === | ||
| + | |||
| + | Please note that as from Regnology Release R1.1.0.00 July 2024, this option is no longer available due to changes beyond our control. Instead, use the https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1 as shown in the example below. | ||
| + | |||
| + | [[File:ESTAT.png|800px]] | ||
| + | |||
| + | |||
| + | '''Previous connection - no longer available.''' | ||
Select this option from the list. This URL will be pre-filled. | Select this option from the list. This URL will be pre-filled. | ||
http://ec.europa.eu/eurostat/SDMX/diss-web/rest | http://ec.europa.eu/eurostat/SDMX/diss-web/rest | ||
| + | ==== Connection Properties ==== | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | | URL || Eurostat's REST API - use default, only change value if the location has moved. | ||
| + | |} | ||
=== File System === | === File System === | ||
| − | Example: | + | '''Example''': |
C:/portal-testing/ | C:/portal-testing/ | ||
| − | Avoid using a complex path contain characters such as spaces etc/ | + | Avoid using a complex path contain characters such as spaces etc. |
| + | |||
| + | ==== Connection Properties ==== | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | | Folder || Path to folder on file system which will be swept for SDMX structures and/or data. Data files should be placed in the relevant subfolder [AgencyId]/[FlowId]/[FlowVersion]. Structure files should be placed under a subfolder named 'structure'. | ||
| + | |- | ||
| + | | On Complete || (File type Connections only). The action performed on completion of processing the data file | ||
| + | |} | ||
If you are using a File System, as well as the folder, you must create sub folders to include the structures and data. | If you are using a File System, as well as the folder, you must create sub folders to include the structures and data. | ||
[[File:File Structure.png|600px]]<br> | [[File:File Structure.png|600px]]<br> | ||
| + | |||
| + | === URL Datasource === | ||
| + | |||
| + | '''Example''':(taken from the Fusion Registry Demo site). | ||
| + | |||
| + | https://demo11.metadatatechnology.com/FusionRegistry/sdmx/v2/data/dataflow/CD2030/CONSOLIDATED/1.0/?c%5BREF_AREA%5D=ABW | ||
| + | |||
| + | ==== Connection Properties ==== | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | | Data URL || URL to a Data file in a supported format. | ||
| + | |- | ||
| + | | Username || Optional Username to authenticate with API (using HTTP Basic Authentication). | ||
| + | |- | ||
| + | | Password|| Optional Password to authenticate with API (using HTTP Basic Authentication). | ||
| + | |} | ||
Latest revision as of 03:08, 2 July 2024
Contents
Overview
To use Fusion Data Portal you must first set the connection(s) to the source data. Several types are available.
SDMX REST API (V1)
Example:
https://demo.metadatatechnology.com/FusionRegistry/ws/public/sdmxapi/rest
Connection Properties
| URL | SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml |
| Updated After | Only pull data updated after the last pull request. The web service must support the updatedAfter query parameter. |
| User Name | Optional Username to authenticate with API (using HTTP Basic Authentication). |
| Password | Optional Password to authenticate with API (using HTTP Basic Authentication). |
Eurostat
Please note that as from Regnology Release R1.1.0.00 July 2024, this option is no longer available due to changes beyond our control. Instead, use the https://ec.europa.eu/eurostat/api/dissemination/sdmx/2.1 as shown in the example below.
Previous connection - no longer available.
Select this option from the list. This URL will be pre-filled.
http://ec.europa.eu/eurostat/SDMX/diss-web/rest
Connection Properties
| URL | Eurostat's REST API - use default, only change value if the location has moved. |
File System
Example:
C:/portal-testing/
Avoid using a complex path contain characters such as spaces etc.
Connection Properties
| Folder | Path to folder on file system which will be swept for SDMX structures and/or data. Data files should be placed in the relevant subfolder [AgencyId]/[FlowId]/[FlowVersion]. Structure files should be placed under a subfolder named 'structure'. |
| On Complete | (File type Connections only). The action performed on completion of processing the data file |
If you are using a File System, as well as the folder, you must create sub folders to include the structures and data.
URL Datasource
Example:(taken from the Fusion Registry Demo site).
https://demo11.metadatatechnology.com/FusionRegistry/sdmx/v2/data/dataflow/CD2030/CONSOLIDATED/1.0/?c%5BREF_AREA%5D=ABW
Connection Properties
| Data URL | URL to a Data file in a supported format. |
| Username | Optional Username to authenticate with API (using HTTP Basic Authentication). |
| Password | Optional Password to authenticate with API (using HTTP Basic Authentication). |
