Skip to content
Snippets Groups Projects
Commit 7827172a authored by Alexander Schlemmer's avatar Alexander Schlemmer
Browse files

todos during discussion with Timm and Alex

parent 982e479d
No related branches found
No related tags found
No related merge requests found
Pipeline #59027 passed
...@@ -39,11 +39,13 @@ The normative description of all requirements is contained in the non-public pro ...@@ -39,11 +39,13 @@ The normative description of all requirements is contained in the non-public pro
RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for definitions): RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for definitions):
<!-- TODO: Alex, Begründungen -->
- Operability - Operability
- Compatibility - Compatibility
- Transferability - Transferability
- Maintainability - Maintainability
<!--TODO: Maintainability einschränken, weil Demonstrator -->
### Stakeholders ### Stakeholders
...@@ -101,6 +103,7 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for ...@@ -101,6 +103,7 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for
> communication protocols. > communication protocols.
--> -->
<!-- TODO: Timm -->
<b style="color: red; font-size: 32pt">TODO</b> <b style="color: red; font-size: 32pt">TODO</b>
**\<Diagram or Table>** **\<Diagram or Table>**
...@@ -119,12 +122,7 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for ...@@ -119,12 +122,7 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for
![System Landscape Diagram](embed:sl) ![System Landscape Diagram](embed:sl)
<!-- TODO: Mehr content hinzufügen, z.B. Link zur crawler-doc und Paper -->
**\<Diagram or Table>**
**\<optionally: Explanation of technical interfaces>**
**\<Mapping Input/Output to Channels>**
<!-- <!--
## Solution Strategy ## Solution Strategy
...@@ -158,8 +156,6 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for ...@@ -158,8 +156,6 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for
> plan. > plan.
--> -->
<b style="color: red; font-size: 32pt">TODO</b>
### Whitebox Overall System ### Whitebox Overall System
<!-- <!--
...@@ -177,6 +173,8 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for ...@@ -177,6 +173,8 @@ RuQaD's main quality goals are, using the terms from ISO 25010 (see glossary for
> In the best case you will get away with examples or simple signatures. > In the best case you will get away with examples or simple signatures.
--> -->
<!-- TODO: Alex, aufräumen, überschriften wegmachen etc. -->
<b style="color: red; font-size: 32pt">TODO</b> <b style="color: red; font-size: 32pt">TODO</b>
![Building Blocks](embed:buildingBlocks) ![Building Blocks](embed:buildingBlocks)
...@@ -502,9 +500,25 @@ format that is machine-readable and also human-readable at the same time. ...@@ -502,9 +500,25 @@ format that is machine-readable and also human-readable at the same time.
Multiple components of the software use REST interfaces for data exchange. Multiple components of the software use REST interfaces for data exchange.
- Gitlab-API - Gitlab-API
- kadi4mat-export (?) - kadi4mat-export
- LinkAhead - LinkAhead
### FAIR
<!-- TODO: Timm -->
### Dataspaces
<!-- TODO: Timm -->
### ELN-FileFormat / ROCrate
<!-- TODO: Alex -->
### ETL (Extract-Transform-Load)
<!-- TODO: Alex -->
### *\<Concept n>* ### *\<Concept n>*
*\<explanation>* *\<explanation>*
...@@ -550,14 +564,16 @@ Multiple components of the software use REST interfaces for data exchange. ...@@ -550,14 +564,16 @@ Multiple components of the software use REST interfaces for data exchange.
> efficiency or performance. Example: The system reacts to a user’s request within one second. > efficiency or performance. Example: The system reacts to a user’s request within one second.
> - Change scenarios describe a modification of the system or of its immediate environment. Example: > - Change scenarios describe a modification of the system or of its immediate environment. Example:
> Additional functionality is implemented or requirements for a quality attribute change. > Additional functionality is implemented or requirements for a quality attribute change.
-->
## Risks and Technical Debts ## Risks and Technical Debts
<https://docs.arc42.org/section-11/> <!--<https://docs.arc42.org/section-11/>
> A list of identified technical risks or technical debts, ordered by priority > A list of identified technical risks or technical debts, ordered by priority-->
<!-- TODO: Alex macht draft -->
-->
## Glossary ## Glossary
...@@ -569,3 +585,5 @@ Multiple components of the software use REST interfaces for data exchange. ...@@ -569,3 +585,5 @@ Multiple components of the software use REST interfaces for data exchange.
| Transferability (ISO 25010) | "System can be transferred from one environment to another." | | Transferability (ISO 25010) | "System can be transferred from one environment to another." |
| Maintainability (ISO 25010) | "System can be modified, corrected, adapted or improved due to changes in environment or requirements." | | Maintainability (ISO 25010) | "System can be modified, corrected, adapted or improved due to changes in environment or requirements." |
| Compatibility (ISO 25010) | "Two or more systems can exchange information while sharing the same environment." | | Compatibility (ISO 25010) | "Two or more systems can exchange information while sharing the same environment." |
| FAIR | TODO |
| ELN | TODO |
# Base check for FAIRness on LinkAhead Crawler
<!--This decision was made prior to the beginning of the project in the proposal.
Date: 2024-10-01-->
<!-- TODO: Describe: Don't implement fairness check in 4.2 demonstrator, but in linkahead crawler. -->
<!-- TODO: Alex -->
<!-- TODO: Check date of protocol. -->
## Status
Accepted
## Context
<!--Pulling data from Kadi4Mat and publishing it to the EDC-based BatCAT Data Space.-->
## Decision
<!--We will use the LinkAhead Crawler as the base of the RuQaD Demonstrator.
In the BatCAT Data Space LinkAhead is being used as Data and Knowlegde
Management System. Instead of publishing assets directly to the catalog which
would leave us with the task to host and serve the raw data, we can reuse this
infrastructure.
The established way to insert data into LinkAhead following an ETL approach is
the LinkAhead Crawler.
Additionally, the LinkAhead Crawler is a Python framework and Kadi4Mat has a
Python API as well which is a good match.-->
## Consequences
<!--We don't have to take car about the hosting and serving of the data in the data
space. The RuQaD Demonstrator will be a purely functional, i.e. stateless
component.
We have a solid base for defining the mapping from the input data to the
desired output and for defining and checking criteria, e.g. FAIRness criteria.
On the downside, the RuQaD demonstrator will only be usable for system
landscapes and Data Spaces using LinkAhead. However, it is always possible to
just add a LinkAhead instance to any EDC-based data space.-->
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment