Architecture
Layer Responsibilities & Component Mapping
The system’s components are classified into five layers. Layers are separate from each other and communicate through defined interfaces.
Layer |
Defined Role |
Assigned Components |
|---|---|---|
Business Layer |
Core Function: Creating, validating, packaging, and maintaining research data containers, as well as managing the workflow configuration participants see. |
|
Security Layer |
Authentication & Permissions: User login, session handling, roles, and access rights. |
|
Service Layer |
Service Connection: Components that connect the core container to external services (publishing, signing, review, annotation, search registration, execution environment). |
|
UI Layer |
User Interaction: User-facing pages, dashboards, container viewers, and administration interfaces. |
|
Integration & Persistence Layer |
Communication & Persistence: External API communication (REST API) and the shared database. |
|
Key rules:
rdmcandrdmc_metadatabelong to the Business Layer and the UI Layer. In both,handlers/andhelpers/hold the business logic, andviews.py,templates/, andstatic/hold the UI. This keeps the core function separate from the UI.The Service Layer components define and manage the connection to each external service.
All other components connect to
rdmcthrough its API and/or UI.
High-Level Architecture Diagram
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│ RDMC SYSTEM │
├───────────────────┬─────────────────────────────────────────────────┬───────────────────┤
│ SECURITY LAYER │ SERVICE LAYER │ INTEGRATION │
│ │ • rdmc_publish (Publishing) │ & PERSISTENCE │
│ • rdmc_auth │ • rdmc_sign (Signing) │ LAYER │
│ (Login & │ • artifact_evaluation (Review & Evaluation) │ │
│ Permissions) │ • metabase (Semantic Annotation) │ • rdmc_workflow_ │
│ │ • search_portal (Search Registration) │ api (REST API) │
│ │ • ree_service (Execution Environment) │ • Shared │
│ ├─────────────────────────────────────────────────┤ Database │
│ │ UI LAYER │ & Storage │
│ │ • viewer (Container Viewer & Explorer) │ │
│ │ • rdmc_management (Administration Tooling) │ │
│ │ • rdmc (Wizard Views & Dashboards) │ │
│ │ • rdmc_metadata (Metadata Forms) │ │
│ ├─────────────────────────────────────────────────┤ │
│ │ BUSINESS LAYER │ │
│ │ Core Function: │ │
│ │ • rdmc (Core container creation workflow) │ │
│ │ • rdmc_metadata (Metadata & Manifest Engine) │ │
│ │ • rdmc_configuration (Workflow Configuration) │ │
└───────────────────┴─────────────────────────────────────────────────┴───────────────────┘
Component Inventory & Responsibilities
Component |
Purpose |
Layer |
Why It Belongs Here |
|---|---|---|---|
|
Container creation wizard. |
Business + UI |
Implements the core container wizard interface. |
|
Metadata forms, manifest generation and validation. |
Business + UI |
Defines and validates container metadata and manifest generation. |
|
Configures the RDMC workflow options for participants. |
Business |
Controls the workflow configuration that participants go through. |
|
User login, session handling, and access permissions. |
Security |
Manages identity, authentication, and session control. |
|
Container signing. |
Service |
Connects the core container to the external signing service. |
|
Publication to external repositories (Zenodo, Dataverse, Coscine). |
Service |
Connects the core container to the external publication repositories. |
|
Artifact review and evaluation. |
Service |
Connects the core container to the external artifact evaluation service. |
|
Semantic metadata annotation proxy. |
Service |
Connects the container metadata to the external annotation service. |
|
Registers published containers in the search portal. |
Service |
Connects published containers to the external search portal. |
|
Reusable Execution Environment (REE) workbench client. |
Service |
Connects the core container to the external execution environment. |
|
Read-only container viewer with role-based display. |
UI |
Dedicated to user display and exploration, separate from core logic. |
|
Organizer access and administration tooling. |
UI |
Administrative user interface for managing organizer permissions. |
|
REST API for creating containers programmatically. |
Integration & Persistence |
Handles external HTTP API communication with the system. |
|
Global settings and entry points. |
(configuration) |
Not a component: it wires all components together. |
Current Architecture
The diagram below shows the current architecture of the RDMC Creation Workflow platform: the web application with its components, the shared database, and the external systems it talks to (identity provider, REE service, publication repositories, and the search portal). How the individual components work together is described in Project Structure and Component Diagram.
Figure: Architecture of the RDMC Creation Workflow Platform