Common Modifications

This page describes how to make the most common changes to the configuration system without going into implementation detail. The goal is to identify what needs to change and where the change belongs conceptually.

Adding a New Feature

Add an entry to the feature registry (feature_registry.py) following the patterns in The Feature Registry. The edit UI, persistence, and preview page will all pick it up automatically.

If the new feature needs a custom input widget beyond radio, multiselect, or text (for example, a date picker or a file selector), a corresponding branch must be added in the edit template to handle that input type, and the POST parsing logic must be extended to read the new format correctly.

If the feature requires a tag-style input (comma-separated free values rendered as removable chips), follow the same pattern as the existing custom visibility levels or custom resource types: store the value as a comma-separated string in a hidden input and manage the chip UI with the shared addTagTo / removeTagFrom JS helpers.

Changing a Feature Label or Description

Edit the label or description field of the relevant entry in the feature registry. The change propagates to the edit UI, the preview, and the feature summary on the share page with no further action needed.

Reordering Features

The edit UI renders features in the order they appear in the registry list. To change the order, reorder the entries in FEATURE_REGISTRY. The same applies to options within a feature.

Changing Which Steps Appear in the Preview Sidebar

The preview sidebar is driven by WORKFLOW_PREVIEW_STEPS, a separate list in the same registry file. Add, remove, or rename entries there to match the actual workflow. Sub-steps are defined as children of their parent step entry.

Adding a New Question to the Default Pool

Create a new row in the relevant question model (Artifact Details or Metadata), scoped to the configuration you want to extend. If you want the question available in all future configurations by default, add it programmatically in a data migration or a post-save signal that runs when a new configuration is created.

For metadata questions, always set manifest_properties so the manifest generator knows which manifest field to populate from the answer.

Modifying the Access Control Roles

Roles are defined as a choices enum on the ConfigurationRole model. To add a new role, extend the enum and run a migration. The invite form’s role selector is populated dynamically from those choices, so no template change is needed. If the new role should carry different permissions within the wizard, the wizard’s permission checks must also be updated to recognise it.

Adjusting Question Import on Configuration Copy

When a configuration is created from an import source, questions are duplicated row by row. If you add a new question-related model in the future (for example, question groups or scoring rubrics), extend the cloning logic to include those rows as well, otherwise the import will produce an incomplete copy.