| Table of Contents |
|---|
Introduction
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 based on the CP's needs.
This is possible using JSON configuration at a CP level or system level.
Which pages can be configured?
Data
...
Entry
This includes the overview, add, and edit pages.
Participant
Visit
All specimen pages ( like add new fields during collection, aliquot, derive, etc).
List
...
View
The list view page is the table that is displayed when you click on any object.
Participant
Specimen
Specimen cart
Reserved specimen
Order specimens
What can be configured?
Fields to be displayed, i.e., remove unwanted fields or add additional fields
Mandatory or optional
Default value.
Making fields mandatory/optional.
Default values for fields.
Populate values in a field based on a value in another field.
Subsetting dropdown values based on the value of another field.
Skip Adding skip logic (i.e., hide/unhide fields based on the value of another field).
Display calculated fields in overview pages or tables.
Reorder fields.
Group fields in the same line under headers.
Validation rules (edit checks) (Refer to Data Validations(Edit Checks)).
Workflow
...
Configuration
This configuration can be done at two levels.:
System-wide - applies to all protocols
Collection Protocol level - overrides the system setting for that protocol
Remove workflow configurations
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 like above, if this needs to be set , you can set it for all CPs at the system level, follow . Refer to the below 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
CP Level
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.
...
System Level
The user needs 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
To avoid the CP specific dictionary configuration for custom fields, systemSystem-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 append 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 allow will enable you to define CP-specific custom fields without requiring them to create/maintain a CP dictionary.
...
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
...
...
From v6.2:
You can download the default JSON from the user interface. The URLs to download the default JSONs are:
...