Manifest File Structure

Features of the Manifest File

The manifest file provides detailed metadata about RDMC, including the following:

  • Metadata Information:

    • Owner

    • Authors

    • RDMC Title

    • Artifacts inside the RDMC

    • Artifacts Details

  • Functionality:

    • Users can review all metadata details of the RDMC.

    • The manifest file contains metadata and resource information, including resource paths, types, and more.

  • Structure:

    The manifest file is divided into three main sections:

    1. Context: Contains general information such as title, owner, author, and other key metadata.

    2. Security Settings: Includes all security-related information, such as encryption layers and access control.

    3. Containerization Info: Provides details about containerization and related configurations.

Example Manifest File (YAML)

A typical manifest.rdmc example is given below. User can download the file using the link:

version: 0.0.1
file_path: ..\manifest.rdmc
RDMC Title: Example RDMC
Artifacts inside the RDMC: Example Artifact 1; Example Artifact 2
RDMC metadata:
  Authors: null
  Owner: null
  Reference to PID-RDMC-Preversion: null
  Release Date: null
  Manifest-Schemaversion: null
  Licence: null
  Artefacts + EEs checksum: null
  Additional Data:
    Review Badges: null
    Keywords: null
    PID: null
  context_information: null
Access control / Encryption layer:
  security_layer: null
Artifacts Details:
    - artifact_name: Example Artifact 1
      access_level: Public
      artifact_details: Example RDMC\Example Artifact 1.md
      files:
         - title: Example_File_1
           file_name: Public/Example_File_1.csv
           type: Data
           item_type: file
      folders:
         - title: Example_Folder_1
           folder_name: Public/Example_Folder_1
           type: Software
           item_type: folder
    - artifact_name: Example Artifact 2
      access_level: Restricted
      artifact_details: Example RDMC\Example Artifact 2.md
      files:
         - title: Example_File_2
           file_name: Restricted/Example_File_2.csv
           type: Data
           item_type: file
      folders:
         - title: Example_Folder_2
           folder_name: Restricted/Example_Folder_2
           type: Software
           item_type: folder
  containerization_information: null
  references to metadata file:
    authors: null
    version: null
    title: null
    licence: null
  Reference to source: null
  Type: null
  PID: null
RDMC-workflow-configurations:
  Setup instructions: null
  security settings: null
Execution Environment:
  OS / Reference to concrete environment: null