| Page Properties | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This document is archived.
The latest version is available at the GitHub wiki of the FAIR DataPoint repository: https://github.com/DTL-FAIRData/FAIRDataPoint/wiki/FAIR-Data-Point-Specification.
Introduction
Purpose
The purpose of this document is to specify the FAIR Data Point (FDP) software. This document includes requirements, architecture and design of the FDP software. This specification is primarily intended to be a reference for developing the first version of the FDP software by the DTL FAIR engineering team.
...
In this section we use elements from the Archimate notation. The ArchiMate modelling language is an open and independent Enterprise Architecture standard that supports the description, analysis and visualisation of architecture within and across business domains. ArchiMate is one of the open standards hosted by The Open Group and is fully aligned with TOGAF.
Figure 4 depicts a view of the current architecture of the FDP using Archimate's Application layer notation. From top down, we have the Archimate's Application Interface representing the FDP's API. This API is currently composed of two parts, the Metadata Provider API and the FAIR Data Accessor API. The Metadata Provider API is the public interface of the Metadata Provider Service. Similarly, the FAIR Data Accessor API is the public interface of the FAIR Data Accessor Service.
...
The details of what each of these metadata object represent are given in the Metadata section below in this document. Also, the details of the FAIR Data Point API are given below in this document at the Application Programming Interface (API) section.
|
Fig. 4 - FAIR Data Point's Archimate Application layer architecture |
Metadata
The FAIR Data Point metadata about four entities, namely, the FAIR Data Point itself, the collection of datasets, each one of the offered datasets and the data within each of the dataset
...
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
 |
| Fig. 5 - FDP metadata |
| Term Name: identifier | |
|---|---|
| URI: | http://purl.org/dc/terms/identifier |
| Label: | Identifier |
| Definition: | An unambiguous and persistent reference to the FDP. |
| Comment: | Recommended best practice is to identify the resource by means of a string conforming to a formal identification system. |
| Has Range: | http://www.w3.org/2000/01/rdf-schema#Literal |
| Version: | http://dublincore.org/usage/terms/history/#identifierT-001 |
| Term Name: license | |
| URI: | http://purl.org/dc/terms/license |
| Label: | License |
| Definition: | A document describing the conditions for access and usage of the FDP. |
| Has Range: | http://purl.org/dc/terms/LicenseDocument |
| Version: | http://dublincore.org/usage/terms/history/#license-002 |
| Term Name: title | |
| URI: | http://purl.org/dc/terms/title |
| Label: | Title |
| Definition: | The name of the FDP. |
| Has Range: | http://www.w3.org/2000/01/rdf-schema#Literal |
| Version: | http://dublincore.org/usage/terms/history/#titleT-002 |
| Term Name: description | |
| URI: | http://purl.org/dc/terms/description |
| Label: | Description |
| Definition: | A human-readable description of the FDP. |
| Has Range: | |
| Version: | http://dublincore.org/usage/terms/history/#descriptionT-001 |
| Term Name: hasVersion | |
| URI: | http://purl.org/dc/terms/hasVersion |
| Label: | |
| Definition: | The version of the FDP software. |
| Has Range: | |
| Version: | http://dublincore.org/usage/terms/history/#hasVersion-003 |
| Term Name: Metadata Version | |
| URI: | http://purl.org/dc/terms/hasVersion |
| Label: | |
| Definition: | The version of the FDP API specification implemented in this FDP deployment. |
| Has Range: | |
| Version: | http://dublincore.org/usage/terms/history/#hasVersion-003 |
| Term Name: issued | |
| URI: | http://purl.org/dc/terms/issued |
| Label: | Date Issued |
| Definition: | Date of formal issuance (e.g., deployment) of the FDP. |
| Has Range: | http://www.w3.org/2000/01/rdf-schema#Literal |
| Version: | http://dublincore.org/usage/terms/history/#issued-003 |
| Term Name: modified | |
| URI: | http://purl.org/dc/terms/modified |
| Term Name: publisher | |
| URI: | http://purl.org/dc/terms/publisher |
| Label: | Publisher |
| Definition: | The entity responsible for making the FDP available. |
| Has Range: | http://purl.org/dc/terms/Agent |
| Version: | http://dublincore.org/usage/terms/history/#publisherT-001 |
...
Figure 6 depicts the HATEOAS RESTful API of FDP. In the figure, the upper-left green box represents the FDP service and responds to requests to the root URL, hereby represented as "/".
|
| Fig. 6 - FDP HATEOAS API |
When the FAIR Data Point Service root URL receives an HTTP GET request (e.g., http://145.100.59.120:8082/fdp/), the Metadata Service returns the FDPMetadata resource. This resource contains information about the FDP itself such as the owner (organisation or individual), FDP version, API version, etc. The content of the FDPMetadata resource is based on the Repository concept defined in the Open Initiative Archive Protocol for Metadata Harvesting (OAI-PMH). Following the HATEOAS guidelines, the FDPMetadata resource also provides a link to the CatalogMetadata resource.
...
Once the user select one of the available datasets, the dataset metadata page is displayed. Figure 9 depicts the mockup of a dataset metadata page.
 |
| Fig. 9 - Dataset metadata page |
Additional references
...