In OpenSpecimen, there are standard fields for participant, visit, and specimen pages. However, these fields must not be relevant for your study, or you would want to create new fields based on the CP requirements. Using this feature, super administrators can configure the user interface.
This is possible using JSON configuration at a CP level or system level.
Collection Protocol level - overrides the system setting for that protocol
Collection Protocol Level Configuration
To import/export workflows:
Go to the collection protocols overview page.
Click on the 'More' button.
Select Export Workflows or Import Workflows.
System Level Configuration
Once JSON is created for the data dictionary, you can set it for all CPs at the system level. Refer to the steps:
Navigate to 'Settings'.
Under 'Biospecimen', set the 'System Workflows' property with the new JSON.
Refresh the browser to take effect of the settings.
Remove Workflow Configuration
Go to CP Overview → More → Import workflows
Choose the file EmptyWorkflow.json and import it. Once you import this, the CP level workflow will be erased.
If you want to replace the file uploaded at the system level with the default file attached: Navigate to Settings → Biospecimen→ System Workflows
Custom Field Configuration via System-Level JSON
System-level JSON is enhanced to show the custom field in any CP to avoid the CP-specific dictionary configuration for custom fields. The UI automatically appends the CP-specific custom fields when a system-level dictionary is used for displaying the add/edit/overview pages. This is subject to the condition that the system-level dictionary doesn't have any custom fields in it.
This allows you to define a system-wide dictionary and yet will enable you to define CP-specific custom fields without requiring them to create/maintain a CP dictionary.
CP should not have any CP level workflow attached so that it will use the system level workflow as default.
This feature is supported at the below levels.
Collection Protocol Custom Fields
Registration Custom fields
Visit Custom fields
Specimen Custom fields
Example JSON Files
Listed below are the examples of the configuration that can be done using JSON.
Default JSON files for the configuration that contains - dictionary (all fields for the participant, visit, and specimen), default participant-list, and specimen-list columns and filters are added below