geolba/tethys.backend
2
0
Fork 1
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

Update 'DataArchitectureDiagram'

Kaimbacher 2023-04-25 14:38:15 +00:00
parent 3389233939
commit 6ddf380d7e
1 changed files with 84 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

166
DataArchitectureDiagram.md

@ -1,82 +1,84 @@
<center> <h1>Data Architecture Diagram</h1> </center> <center> <h1>Data Architecture Diagram</h1> </center>
![Image](./data_diagram.drawio.svg) ![Image](./data_diagram.drawio.svg)
# 1. Data Sources https://gitea.geologie.ac.at/geolba/tethys.backend/wiki/raw/data_diagram.drawio.svg
TETHYS collects and manages scanned geological maps, spatial data sets, and other types of research outputs. # 1. Data Sources
The general guideline for publishing research data <a href="https://tethys.at/docs/HandbuchTethys.pdf#page=12" target="_blank">(manual, p. 11-2)</a> is providing information on how to prepare data sources for deposit (helpful for depositors and repository staff):
TETHYS collects and manages scanned geological maps, spatial data sets, and other types of research outputs.
- the types of file formats that are acceptable. All **allowed file fomats** must be enabled by the administrator in the database table **'mime_types'**. Also see <a href="https://gitea.geologie.ac.at/geolba/tethys.backend/wiki/Database#tethys-lookup-tables" target="_blank">(db lookup tables)</a> The general guideline for publishing research data <a href="https://tethys.at/docs/HandbuchTethys.pdf#page=12" target="_blank">(manual, p. 11-2)</a> is providing information on how to prepare data sources for deposit (helpful for depositors and repository staff):
- what kind of data can be included in the research data repository,
- the file upload limits (512MB), - the types of file formats that are acceptable. All **allowed file fomats** must be enabled by the administrator in the database table **'mime_types'**. Also see <a href="https://gitea.geologie.ac.at/geolba/tethys.backend/wiki/Database#tethys-lookup-tables" target="_blank">(db lookup tables)</a>
- what CC licenses can be used, - what kind of data can be included in the research data repository,
- the strategy for deleting datasets, - the file upload limits (512MB),
- how to handle the use of external research data, - what CC licenses can be used,
- the required use of keywords - the strategy for deleting datasets,
- Note that the uploaded data will be reviewed. - how to handle the use of external research data,
- the required use of keywords
# 2. Metadata Schema - Note that the uploaded data will be reviewed.
The **Metadata format guidelines** <a href="https://tethys.at/docs/HandbuchTethys.pdf#page=9" target="_blank">(manual, p. 8-10)</a> on the other hand, provides information on the specific types of metadata that should be included with the data. This may include information on the format and structure of the metadata, as well as the types of information that should be included. Tethys RDR is using three metadata standards (**Dublin Core, DataCite and ISO10130**) as well as one descriptive metadata element (dataset type). The dataset type is one of the following metadata elements: Analysis, Measurements, Monitoring, Remote Sensing, Geographic Information System (GIS), Models, and Mixed Type. # 2. Metadata Schema
# 3. Storage Infrastructure The **Metadata format guidelines** <a href="https://tethys.at/docs/HandbuchTethys.pdf#page=9" target="_blank">(manual, p. 8-10)</a> on the other hand, provides information on the specific types of metadata that should be included with the data. This may include information on the format and structure of the metadata, as well as the types of information that should be included. Tethys RDR is using three metadata standards (**Dublin Core, DataCite and ISO10130**) as well as one descriptive metadata element (dataset type). The dataset type is one of the following metadata elements: Analysis, Measurements, Monitoring, Remote Sensing, Geographic Information System (GIS), Models, and Mixed Type.
This is the physical or virtual infrastructure used to store the data and metadata in the repository. By using **PostgreSQL**, TETHYS is able to manage large volumes of metadata and provide fast and secure access to this information. The data files are stored on an **Ubuntu 22.04 file server** with **ext4**partition. # 3. Storage Infrastructure
# 4. Data processing and curation workflows This is the physical or virtual infrastructure used to store the data and metadata in the repository. By using **PostgreSQL**, TETHYS is able to manage large volumes of metadata and provide fast and secure access to this information. The data files are stored on an **Ubuntu 22.04 file server** with **ext4**partition.
... # 4. Data processing and curation workflows
# 5. Data Discovery ...
TETHYS supports data discovery in various ways # 5. Data Discovery
## TETHYS REST API TETHYS supports data discovery in various ways
Tethys Metadata and File downloads can be queried by a REST API (Representational State Transfer Application Programming Interface), ## TETHYS REST API
which allows repository staff to interact with the Tethys system and retrieve metadata and data files programmatically.
Tethys Metadata and File downloads can be queried by a REST API (Representational State Transfer Application Programming Interface),
- **metadata API**: e.g.: [metadata for dataset 209](https://tethys.at/api/dataset/200) which allows repository staff to interact with the Tethys system and retrieve metadata and data files programmatically.
- **file download**: e.g. [file for dataset 209: api/file/download/1009](https://www.tethys.at/api/file/download/1009)
- **metadata API**: e.g.: [metadata for dataset 209](https://tethys.at/api/dataset/200)
## Tethys Frontend - **file download**: e.g. [file for dataset 209: api/file/download/1009](https://www.tethys.at/api/file/download/1009)
The datasets can always be found through the Data Frontend, https://tethys.at/search, browsing by subject, author, language or year, or by searching the metadata fields title, author or keyword. To enhance the discoverability of the datasets, TETHYS RDR stimulates adding as many metadata and other relevant documentation as possible. ## Tethys Frontend
## Solr Search Index The datasets can always be found through the Data Frontend, https://tethys.at/search, browsing by subject, author, language or year, or by searching the metadata fields title, author or keyword. To enhance the discoverability of the datasets, TETHYS RDR stimulates adding as many metadata and other relevant documentation as possible.
All visible metadata and some metadata extracted from data files are indexed and searchable by Solr. ## Solr Search Index
## DataCite DOI Fabrica All visible metadata and some metadata extracted from data files are indexed and searchable by Solr.
Tethys Repository assigns a DOI for each published dataset. ## DataCite DOI Fabrica
Therefore the datasts are also accessible via DOI Fabrica: e.g. https://doi.datacite.org/dois/10.24341%2Ftethys.200
Tethys Repository assigns a DOI for each published dataset.
# 6. Authentication and authorization systems: Therefore the datasts are also accessible via DOI Fabrica: e.g. https://doi.datacite.org/dois/10.24341%2Ftethys.200
TETHYS provides an Access Control List (ACL) system that is used to manage users, user roles and permissions. # 6. Authentication and authorization systems:
![title](./tethys_acl.png)
TETHYS provides an Access Control List (ACL) system that is used to manage users, user roles and permissions.
- accounts: This table stores information about the users of the system. Each user is assigned a unique identifier, and the table includes fields for the user's name, email address, and timestamps. ![title](./tethys_acl.png)
- roles: This table stores information about the roles that are available in your application. Each role has a unique identifier and a name that describes the role. TETHYS is using the following rules: - accounts: This table stores information about the users of the system. Each user is assigned a unique identifier, and the table includes fields for the user's name, email address, and timestamps.
- admin role: for editing user accounts, roles and permissions - roles: This table stores information about the roles that are available in your application. Each role has a unique identifier and a name that describes the role. TETHYS is using the following rules:
- submitter role: Submitters submit original research datasets. Submitters are responsible for ensuring that their submissions meet the repository's guidelines and standards.
- editor role: TETHYS editors are responsible for overseeing the content and quality of the research repository. They review submissions to ensure they meet the repository's standards and may provide feedback to submitters. They may also work with reviewers to ensure that submissions are evaluated fairly. - admin role: for editing user accounts, roles and permissions
- reviewer role: Reviewers are responsible for evaluating submissions to the research repository. They may be assigned specific submissions to review, and they provide feedback on the quality and relevance of the research. Reviewers typically have expertise in the field related to the research and may be asked to provide a written report or score to help the editor make a decision about whether to accept or reject the submission. - submitter role: Submitters submit original research datasets. Submitters are responsible for ensuring that their submissions meet the repository's guidelines and standards.
- editor role: TETHYS editors are responsible for overseeing the content and quality of the research repository. They review submissions to ensure they meet the repository's standards and may provide feedback to submitters. They may also work with reviewers to ensure that submissions are evaluated fairly.
- permissions: This table stores information about the permissions that are available for the roles. Each permission has a unique identifier, a name that describes the permission, and a short code that represents the permission. - reviewer role: Reviewers are responsible for evaluating submissions to the research repository. They may be assigned specific submissions to review, and they provide feedback on the quality and relevance of the research. Reviewers typically have expertise in the field related to the research and may be asked to provide a written report or score to help the editor make a decision about whether to accept or reject the submission.
- role_has_permissions: This table stores the relationship between roles and permissions. Each row in this table represents a role that has been granted a specific permission. - permissions: This table stores information about the permissions that are available for the roles. Each permission has a unique identifier, a name that describes the permission, and a short code that represents the permission.
- link_account_roles: This table stores the relationship between users (Accounts) and roles. Each row in this table represents a user that has been assigned a specific role. - role_has_permissions: This table stores the relationship between roles and permissions. Each row in this table represents a role that has been granted a specific permission.
# 7. System Integration - link_account_roles: This table stores the relationship between users (Accounts) and roles. Each row in this table represents a user that has been assigned a specific role.
System Integration with other systems involves integrating the research repository with other systems, such as project management tools, data platforms and reporting tools. # 7. System Integration
By providing the Open Archives Initiative Protocol for Metadata Harvesting (**OAI-PMH**) any other data provider can harvest TETHYS metadata. An example would be the **Bielefeld Academic Search Engine BASE**: https://www.base-search.net/Search/Results?q=coll:fttethysrdr&refid=dctablede System Integration with other systems involves integrating the research repository with other systems, such as project management tools, data platforms and reporting tools.
Matomo is used to track statistics data for TETHYS. Matomo is an open-source web analytics platform that can be used to track user behavior on a website. By providing the Open Archives Initiative Protocol for Metadata Harvesting (**OAI-PMH**) any other data provider can harvest TETHYS metadata. An example would be the **Bielefeld Academic Search Engine BASE**: https://www.base-search.net/Search/Results?q=coll:fttethysrdr&refid=dctablede
Matomo is used to track statistics data for TETHYS. Matomo is an open-source web analytics platform that can be used to track user behavior on a website.