/
List View Configuration
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

List View Configuration

Owned by Satish Lakhani (Unlicensed)

Introduction

Below are the pages with lists like the view across the application. These list views can be configurable:

  • Participants

  • Specimens

  • Specimen cart

  • Reserved Specimens

  • Collection Protocol List

  • Order Specimen List

  • Container Specimen List

List view pages do not support the Custom Form fields. Eg: Forms attached at Registration Form Level, Specimen Form level etc.

What can be configured?

  1. Columns

  2. Sorting order

  3. Filters (on the right-hand side)

  4. Conditional data display: Fixed criteria can be set to display only specific participants and specimens. For example, display only aliquots.

JSON Attributes and Uses

Attribute

Usage

Attribute

Usage

name

Name of the list configuration.
Ex: participant-list-view or specimen-list-view, or common.

data

listview

To set the default landing page, you can choose between the participant list view or the specimen list view.

By default, the participant list view is selected unless specified otherwise in the data property.

To make the specimen list view the default, configure it as follows: "listView": "cp-specimens".

columns

Columns to be displayed in list view.

expr

The properties of an object that can be displayed in a list include:

  • For example: Participant.ppid or Specimen.label

You can also specify a combination of two fields as shown below:

  • concat(Participant.firstName, " ", Participant.lastName)

  • years_between(current_date(), Participant.dateOfBirth)
    Additionally, for details on adding different attribute types, refer to https://openspecimen.atlassian.net/wiki/x/YAAIBg wiki page

caption

The caption for the column that will appear in the table header.

metainfo

Meta information regarding the column or field to be displayed is as follows:

For example, setting "showLink": "true" will enable a hyperlink on the field, allowing users to redirect to the corresponding object.

criteria

To display records in a list, specific criteria must be met.

For example, "Participant.id exists" indicates that only records with a valid participant ID will be shown.

orderBy

expr

Name of the property in the object. Ex: Participant.regDate

direction

You can order the results in either ascending or descending order.
For example, use desc to sort in descending order.
If no order is specified, the default will be ascending order.

filters

To configure the filters on which the filtering of data should be performed.

expr

The property of an object that will be displayed in the list includes attributes such as:

  • Participant.ppid

  • Specimen.label

caption

The caption for the column that will appear in the table header.

metainfo

Metadata regarding the column or field used for filters. For example: "phi":"true" — this setting will conceal this field from users who do not have access to phi.

List View Configurations

The pages below have detailed information for each level.

Related content

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com