Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: data request flow #13

Open
vancauwe opened this issue Jan 28, 2025 · 1 comment
Open

chore: data request flow #13

vancauwe opened this issue Jan 28, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@vancauwe
Copy link
Contributor

This issue will map out theoretically how the user will interact with different components from data browsing to data download.
For simplification, the back-end of the UI was not made explicit in the sequence diagram.

sequenceDiagram
    participant C as Chemist
    participant S as Solr (UI)
    participant Q as Qlever (UI)
    participant D-UI as Download Data Page
    participant QDB as Qlever (Database)
    participant S3 as S3 Database
    
    C->>S: search through data for NMR
    C->>Q: 
    Note over C,Q: (Sparql query) GET all NMR
    S->>C: return NMR data URIs
    Q->>C: 
    C->>D-UI: go to page
    C->>D-UI: input NMR data URIs (copy/paste or file?)
    D-UI-->>D-UI: 
    D-UI->>QDB: from NMR data URIs get NMR data filepath in S3
    Note over D-UI, QDB: (Sparql query) GET data filepath for data URI
    D-UI->>S3: for each NMR data filepath, get data from S3
    Note over D-UI, S3: (API call) GET data from data filepath
    S3->>D-UI: return data files 
    D-UI->>QDB: get high level metadata for each NMR data file
    Note over D-UI, QDB: (Sparql query) GET campaign+batch data for data URI
    D-UI->>QDB: get metadata for each NMR data file
    Note over D-UI,QDB: (Sparql query) GET metadata tied to data URI
    D-UI -->> D-UI: bundle data and metadata in Zip file
    D-UI->>C: return Zip for download

Loading
@vancauwe vancauwe added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Jan 28, 2025
@vancauwe vancauwe added this to cat+ Jan 28, 2025
@sabinem
Copy link
Member

sabinem commented Jan 28, 2025

@vancauwe I think you should add a data catalog and also solr as search option, like this below:

sequenceDiagram
    participant C as Chemist
    participant F as Frontend: Datacatalog
    participant S as Solr (UI)
    participant Q as Qlever (UI)
    participant D-UI as Download Data Page
    participant QDB as Qlever (Database)
    participant S3 as S3 Database
    
    C ->> F: search on Frontend with Option Solr and Sparql
    Note over F,Q: (Option: Sparql query) GET all NMR
    F->>Q: search through data for NMR
    Q->>F: return NMR data URIs (Sparql)
    Note over F,S: (Option Solr query) GET all NMR
    F->>S: 
    S->>F: return NMR data URIs (Solr)
    F->>D-UI: go to page
    F->>D-UI: input NMR data URIs (copy/paste or file?)
    D-UI-->>D-UI: 
    D-UI->>QDB: from NMR data URIs get NMR data filepath in S3
    Note over D-UI, QDB: (Sparql query) GET data filepath for data URI
    D-UI->>S3: for each NMR data filepath, get data from S3
    Note over D-UI, S3: (API call) GET data from data filepath
    S3->>D-UI: return data files 
    D-UI->>QDB: get high level metadata for each NMR data file
    Note over D-UI, QDB: (Sparql query) GET campaign+batch data for data URI
    D-UI->>QDB: get metadata for each NMR data file
    Note over D-UI,QDB: (Sparql query) GET metadata tied to data URI
    D-UI -->> D-UI: bundle data and metadata in Zip file
    D-UI->>C: return Zip for download

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
Status: No status
Development

No branches or pull requests

4 participants