1 Introduction
2 Which pages can be configured?
- 2.1 Data Entry
- 2.2 List View
3 What can be configured?
4 Workflow Configuration
- 4.1 Collection Protocol Level
- 4.2 Collection Group Protocol Level
- 4.3 System Level
5 Remove Workflow Configuration
- 5.1 CP Level
- 5.2 System Level
6 Custom Fields Configuration
- 6.1 Custom Fields Display
7 Default JSON Files

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.

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 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.
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.
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 (Refer to Data Validations(Edit Checks)).

Workflow Configuration

This configuration can be done at three levels:

System-wide - applies to all protocols
Collection Protocol Group level - applies to all protocols in the group and overrides system setting for them.
Collection Protocol level - overrides the system and/or CP group setting for that protocol

Collection Protocol Level

To import/export workflows:

Go to the collection protocols overview page.
Click on the 'More' button.
Select Export Workflows or Import Workflows.

Collection Group Protocol Level

To import/export workflows:

Go to the collection protocol group overview page.
Click on the 'Workflows'.
Select ‘Export' or 'Import’.

System Level

JSON can be set for all CPs at the system level. When OpenSpecimen is installed, there is already a default system-level JSON set in the Settings. This contains the list view and aliquot/derivative creation screen configurations. Refer to the steps to edit system JSON:

Navigate to 'Settings'.
Under 'Biospecimen', set the 'System Workflows' property with the new JSON.
Refresh the browser to take effect of the settings.

You can configure different pages of OpenSpecimen through System JSON. The different sections of JSON are mentioned below:

Remove Workflow Configuration

Custom Fields Configuration

Custom Fields Display

If you define custom fields in system or CP level JSON, any changes to the form needs changes in respective JSONs too.

The feature where custom fields automatically appear without JSON configuration was implemented in v9.0.

Customize Screens (JSON)