Skip to main content

Introduction

🧩 Core Concepts​

OpenCDMP is built around four main entities that work together to provide a structured and flexible approach to managing OMPs:

1. Blueprints​

Blueprints define the overall structure of a Plan by specifying its Sections and the content within each section.

  • Sections: Each Blueprint is divided into multiple Sections, which can include various input fields and optional Descriptions.
  • Customization: Tailor Blueprints to standardize the format and requirements of OMPs according to industry standards or specific project needs.

2. Plans​

A Plan is the primary entity and main output of the OpenCDMP platform, representing a comprehensive OMP.

  • Multiple Descriptions: Contains multiple Descriptions of various inputs or outputs.
  • Structured by Blueprints: Inherits the structure and content defined by the selected Blueprint, ensuring consistency and completeness.
  • Collaboration Features: Invite users to a Plan with different roles and access rights—Viewer, Contributor, Reviewer, etc.
    • Access Levels: Grant access to the entire Plan or specific Sections for fine-grained control.
  • Export and Deposit Options:
    • Export: Export the Plan in various formats (XML, JSON, DOCX, PDF) for both human and machine readability.
      • Custom Exports: Use the pluggable export mechanism to implement your own export plugins.
    • Deposit: Deposit OMPs directly to repositories for DOI assignment.
      • Custom Deposits: Use the pluggable deposit mechanism to implement your own deposit plugins for different repositories.

3. Description Templates​

Description Templates define the structure of a Description within a Plan, supporting a variety of input types to capture detailed information.

  • Supported Input Types:
    • Select: Dropdown menus for predefined options.
    • Boolean Decision: Yes/No choices.
    • RadioBox and CheckBox: Multiple-choice selections.
    • Text: Open-ended text fields.
    • File Upload: Attach documents or files.
    • Date: Calendar selection for dates.
    • External References: Integration with external data sources via APIs.
  • Customization: Configure Description Templates to meet specific data collection needs.

4. Descriptions​

Descriptions are detailed entries within a Plan that provide information about specific inputs or outputs.

  • Integration with Sections: Included in various Sections of a Plan as defined by the Blueprint.
  • Detailed Information: Offer a granular level of detail for comprehensive documentation.

5. References​

References are complex informations that can be used either for a Plan or a Description. The user can add his own reference or select an existing one. The source of an existing reference can be:

  • Internal: already be available for selection by the system.
  • External: come from external APIs.