The Feature Registry

The feature registry is the single source of truth for everything that is configurable in the participant workflow. Adding an entry here is sufficient to make a feature appear in the edit UI, be persisted to the database, and be rendered in the preview — no changes are needed in views or templates for standard feature types.

Each entry in the registry describes one configurable aspect of the workflow: its label, which workflow step it belongs to, whether it can be toggled on and off, and what options it exposes. Options themselves declare their input type (radio, multiselect, or free text) and, where needed, a dependency on the value of a sibling option so that irrelevant sub-options are hidden automatically.

Example Entries

The following examples illustrate the three most common patterns.

A simple toggle feature with a radio option

{
    "key": "rdmc_upload",
    "label": "RDMC Upload Section",
    "step": "Artifact Initialization",
    "description": "Allow participants to upload an existing RDMC via drag and drop.",
    "default": True,
    "options": [
        {
            "key": "visibility",
            "label": "Upload Section Visibility",
            "type": "radio",
            "choices": [
                {"value": "show", "label": "Yes, show the upload section"},
                {"value": "hide", "label": "No, hide the upload section"},
            ],
            "default": "",
        }
    ],
}

A feature with a multiselect option and a dependent sub-option

{
    "key": "resource_upload",
    "label": "Resource Upload",
    "step": "Artifact Initialization",
    "sub_step": "Resources of Artifacts",
    "description": "Choose how participants can submit their research resource.",
    "default": True,
    "options": [
        {
            "key": "mode",
            "label": "Upload Mode",
            "type": "radio",
            "choices": [
                {"value": "both",        "label": "Both"},
                {"value": "url_only",    "label": "External Repository"},
                {"value": "device_only", "label": "Upload from Device"},
            ],
            "default": "",
        },
        {
            "key": "device_type",
            "label": "Device Upload Options",
            "type": "radio",
            "depends_on": {
                "option_key": "mode",
                "show_when": ["both", "device_only"],
            },
            "choices": [
                {"value": "both",           "label": "File and Directory"},
                {"value": "file_only",      "label": "File Only"},
                {"value": "directory_only", "label": "Directory Only"},
            ],
            "default": "",
        },
    ],
}

Note

The depends_on rule hides device_type unless mode is both or device_only. This is enforced both server-side (preview rendering) and client-side (the edit form).

A togglable feature with a free-text option

{
    "key": "artifact_evaluation",
    "label": "Artifact Evaluation",
    "step": "Publication",
    "description": "Show the Artifact Evaluation prompt on the publish page.",
    "default": None,
    "togglable": True,
    "options": [
        {
            "key": "url",
            "label": "Conference Submission Link",
            "type": "text",
            "default": "",
        }
    ],
}

Note

Setting togglable: True renders Yes/No radio buttons above the options. When the organiser selects No, the options block is hidden. default: None means no pre-selected state.

Where Data Is Stored

All feature state is persisted in a single JSON field on the configuration record. The structure mirrors the registry: one key per feature, containing an enabled flag and an options sub-dict. This means adding a new feature to the registry requires no database migration — the JSON field absorbs it automatically.