FOI: EMBER data access use case diagrams

[yarikoptic]

https://github.com/aplbrain/BBQS-EMBER/tree/dandi_focused/doc/design (ATM still private; let me know who wants access, WiP/inquiry is ongoing to open up) contains

• Access Control Features in EMBER

and then 3 "workflows"

1. Embargoed --> Open

https://github.com/aplbrain/BBQS-EMBER/blob/dandi_focused/doc/design/class_I.mmd

---
config:
  layout: fixed
---
flowchart TB
    addContributor["Add Contributor"] --> contributor["Contributor"]
    projectowner["Project Owner"] --> addContributor & createProject["Create Project"] & defineEmbargoPeriod["Define Embargo Period"]
    createProject --> defineEmbargoPeriod & prepareData["Prepare Data"]
    defineEmbargoPeriod --> reviewProject["Review Project"]
    emberAdmin["EMBER Admin"] --> reviewProject & publishProject["Publish Project"]
    reviewProject --> uploadData["Upload Data"]
    uploadData --> endEmbargo["End Embargo"]
    endEmbargo --> publishProject
    publishProject --> accessData["Access Data"]
    accessData --> endUserNoAccount["End User (No Account)"] & endUserAccount["End User (Account)"]
    contributor --> prepareData
    prepareData --> validateData["validateData"]
    validateData <--> privateDataAccess["Private Data Access"]
    privateDataAccess --> uploadData
    Class_I["Class_I"]
    addContributor@{ shape: trap-b}
    contributor@{ shape: trap-b}
    createProject@{ shape: trap-b}
    defineEmbargoPeriod@{ shape: trap-b}
    prepareData@{ shape: trap-b}
    reviewProject@{ shape: trap-b}
    publishProject@{ shape: trap-b}
    uploadData@{ shape: trap-b}
    endEmbargo@{ shape: trap-b}
    accessData@{ shape: trap-b}
    validateData@{ shape: trap-b}
    privateDataAccess@{ shape: trap-b}
     addContributor:::optional
     defineEmbargoPeriod:::optional
     prepareData:::role
     endEmbargo:::optional
     validateData:::role
     privateDataAccess:::role
    classDef default fill:#fff,stroke:#333,stroke-width:2px
    classDef optional fill:#bbb,stroke:#333,stroke-width:2px
    style Class_I color:#D50000

Loading

II. Restricted (people could apply for access)

https://github.com/aplbrain/BBQS-EMBER/blob/dandi_focused/doc/design/class_II.mmd

---
config:
  layout: fixed
---
flowchart TB
    addContributor["Add Contributor"] --> contributor["Contributor"]
    projectowner["Project Owner"] --> addContributor & createProject["Create Project"] & defineaccesscontrol["Define Access Control"] & addAdministrator["Add Administrator"]
    addAdministrator --> projectAdmin["Project Administrators"]
    projectAdmin --> createProject & defineaccesscontrol & userApproval["User Approval"] & userManagement["User Management"]
    createProject --> defineaccesscontrol & prepareData["PrepareData"]
    defineaccesscontrol --> reviewProject["Review Project"]
    reviewProject --> uploadData["Upload Data"]
    emberadmin["EMBER Admin"] --> uploadData
    uploadData --> publishMetadata["Publish Metadata"] & privateDataAccess["Private Data Access"]
    publishMetadata --> userApproval
    userApproval --> userManagement
    uploadData <--> Userdataaccess["User Data Access (Read)"]
    authorizedEndUser["Authorized End User (With Account)"] --> userApplication["User Application"] & Userdataaccess
    userApplication --> userApproval
    contributor --> privateDataAccess
    prepareData --> validateData["validateData"]
    validateData --> uploadData
    n1[" "] --> n2[" "]
    n3[" "] --> n4[" "]
    Step["Step"]
    OptionalStep["Optional Step"]
    Role["Role"]
    addContributor@{ shape: trap-b}
    createProject@{ shape: trap-b}
    defineaccesscontrol@{ shape: trap-b}
    addAdministrator@{ shape: trap-b}
    userApproval@{ shape: trap-b}
    userManagement@{ shape: trap-b}
    prepareData@{ shape: trap-b}
    reviewProject@{ shape: trap-b}
    uploadData@{ shape: trap-b}
    privateDataAccess@{ shape: trap-b}
    userApplication@{ shape: trap-b}
    validateData@{ shape: trap-b}
    n1@{ shape: anchor}
    n2@{ shape: anchor}
    n3@{ shape: anchor}
    n4@{ shape: anchor}
     addContributor:::optional
     addAdministrator:::optional
     prepareData:::role
     privateDataAccess:::role
     validateData:::role
    classDef default fill:#fff,stroke:#333,stroke-width:2px
    classDef optional fill:#bbb,stroke:#333,stroke-width:2px
    style Class_II color:#D50000

Loading

III. Private (only contributors can access etc)

---
config:
  layout: fixed
---
flowchart TB
    createProject["Create Project"] --> defineAccessControl["Define Access Control"] & prepareData["Prepare Data"]
    projectAdmin["Project Admin"] --> defineAccessControl
    defineAccessControl --> reviewProject["Review Project"]
    reviewProject --> uploadData["Upload Data"]
    validateData["Validate Data"] --> uploadData
    uploadData --> privateDataAccess["Private Data Access"]
    contributor["Contributor"] --> prepareData & validateData & privateDataAccess
    prepareData --> validateData
    projectOwner["Project Owner"] --> createProject & addAdministrator["Add Administrator"] & addContributor["Add Contributor"]
    addAdministrator <--> addContributor
    addAdministrator --> contributor
    emberAdmin["EMBER Admin"] --> reviewProject
    projectAdmin@{ shape: rect}
    contributor@{ shape: rect}
    projectOwner@{ shape: rect}
    addAdministrator@{ shape: trap-b}
    addContributor@{ shape: trap-b}
    emberAdmin@{ shape: rect}
    n1@{ shape: anchor}
     prepareData:::role
     validateData:::role
     privateDataAccess:::role
     addAdministrator:::optional
     addContributor:::optional
    classDef default fill:#fff,stroke:#333,stroke-width:2px
    classDef optional fill:#bbb,stroke:#333,stroke-width:2px
    style Class_III color:#D50000

Loading