1 Introduction
2 Export Dashboard (v6.3)
3 Create Dashlets
4 Adding Dashlets
5 Managing Dashlets (v6.3)
- 5.1 Viewing Dashlets
- 5.2 Editing Dashlets:
  - 5.2.1 Editing Name and Description
  - 5.2.2 Editing Dashlet Definition
    - 5.2.2.1 JSON File
- 5.3 Delete Dashlets
  - 5.3.1 Note:
- 5.4 Exporting Dashlet Definition
- 5.5 Import Dashlet Definition
- 5.6 Embed Dashlets
6 Re-order Dashlets
- 6.1 Steps to Re-order System Catalog Dashboard
- 6.2 Steps to Re-order CP Dashboard

Introduction

OpenSpecimen allows Super Admins to configure graphical dashboards at multiple levels. Institute admins can configure dashboards at the CP level only.

Per Collection Protocol
Per Catalog

A Dashboard can be configured per local needs, and its context is used.

Export Dashboard (v6.3)

You can export the dashboard summary as a PDF file.

Navigate to 'Collection Protocols' → Select a CP.
From the participants-list-view page, click on 'More' → Dashboard.

Click on the 'Print' button.

When you click the print button, a PDF file with the CP name followed by the counters and dashlets is exported.

Create Dashlets

Dashlets can be created using the query module in OpenSpecimen. For more information, refer. Dashboard Changes Using Query.

Adding Dashlets

Navigate to the Catalog of your choice, Click on the Dashboard Icon → Add ‘Dashlet’ → Select the Dashlet → Click on 'Add'

Managing Dashlets (v6.3)

Super admins and Institute Admins can see the "Dashlets" card under "Extras".

Viewing Dashlets

It is possible to view all dashlets.

Navigate to 'Extras' → Dashlets
You can search for the dashlet you wish to view using filters.

Click on the title of the dashlet to view the graph/counter.

Clicking on 'Done' will lead you to the dashlet list page.

Editing Dashlets:

A dashlet can be edited to change the name, description or its graphical representation.

Editing Name and Description

Click on the 'Edit' icon beside the dashlet title.

Enter the new title and click on 'Update'.

Editing Dashlet Definition

In some cases, after you create a dashlet using a query, you would like to edit the dashlet for

Better graphical representation
Combine two dashlets, to show two different criteria in one bar graph
Move the dashlet from one OpenSpecimen instance to other

For such cases, you need to edit the dashlet definition, which is a JSON file. Below is an example of creating a dashlets for specimens collected and distributed in the last quarter.

Create a query with condition as mentioned below. For more details, refer to the wiki page

Create a bar type dashlet with cumulative count of specimen ID as the metrics (Y axis) and the collection date(X axis) as category. See the attached image below. For more details, refer to the wiki page.

Create a query with the below conditions.

Create a bar type dashlet with cumulative count of specimen ID as the metrics (Y axis) and the order execution date(X axis) as category. See the attached image below. For more details, refer to the wiki page.

Refer to the export section below and download both the dashlet definition files.
Combine the two definition files.

JSON File

Example 1: Specimen Collected and Distributed in last quarter

To customize the dashlet for specific collection protocols—ensuring it retrieves records from only one or two protocols—simply add the following syntax at the beginning of your criteria.

CollectionProtocol.shortTitle in (\"<CP_NAME_1>\",\"CP_NAME_2\") and

Refer to the import section below and import the file. Attached file for reference.

The dash lets with both conditions of specimens collected and distributed will be created. See the image below

{
  "name" : "dash-sys-coll-dist-lastquat",
  "title" : "Specimen Collected and Distributed in last quarter",
  "type" : "CHART",
  "dataSource" : {
    "options" : {
      "dataSources" : [ {
        "type" : "AQL",
        "options" : {
          "category" : {
            "expr" : "Specimen.createdOn",
            "title" : "Creation Time"
          },
          "metrics" : [ {
            "expr" : "c_count(Specimen.id)",
            "title" : "Collected Specimens"
          } ],
          "criteria" : "Specimen.createdOn exists and Specimen.collectionStatus = \"Collected\" and date_range(Specimen.createdOn, last_cal_qtr)"
        }
      }, {
        "type" : "AQL",
        "options" : {
          "category" : {
            "expr" : "Specimen.specimenOrders.executionDate",
            "title" : "Distribution Time"
          },
          "metrics" : [ {
            "expr" : "c_count(Specimen.id)",
            "title" : "Distributed Specimens"
          } ],
          "criteria" : "Specimen.specimenOrders.executionDate exists and   Specimen.specimenOrders.orderStatus = \"EXECUTED\" and   date_range(Specimen.specimenOrders.executionDate, last_cal_qtr)"
        }
      } ],
      "categoryType" : "date"
    },
    "type" : "SERIES_MIXER"
  },
  "chartOpts" : { },
  "activityStatus" : "Active"
}

Example 2: Trends in Specimen Collection per Type

{
    "name": "combined_cumulative_chart",
    "title": "Combined Cumulative Chart",
    "type": "CHART",
    "dataSource": {
        "options": {
            "dataSources": [
                {
                    "type": "AQL",
                    "options": {
                        "criteria": "date_range(Specimen.extensions.SpecimenCollectionEvent.time,last_cal_month, 12) and  date_format(Specimen.extensions.SpecimenCollectionEvent.time,\"%month2%/%year4%\") any  and  Specimen.type = \"Fresh Tissue\"",
                        "metric": {
                            "expr": "c_count(distinct Specimen.id)",
                            "title": "Fresh Tissue"
                        },
                        "category": {
                            "expr": "date_format(Specimen.extensions.SpecimenCollectionEvent.time,\"%month2%/%year4%\")",
                            "title": "Date"
                        }
                    }
                },
                {
                    "type": "AQL",
                    "options": {
                        "criteria": "date_range(Specimen.extensions.SpecimenCollectionEvent.time,last_cal_month, 12) and  date_format(Specimen.extensions.SpecimenCollectionEvent.time,\"%month2%/%year4%\") any  and  Specimen.type = \"Saliva\"",
                        "metric": {
                            "expr": "c_count(distinct Specimen.id)",
                            "title": "Saliva"
                        },
                        "category": {
                            "expr": "date_format(Specimen.extensions.SpecimenCollectionEvent.time,\"%month2%/%year4%\")",
                            "title": "Date"
                        }
                    }
                }
            ]
        },
        "type": "SERIES_MIXER"
    },
    "chartOpts": {
    "scales": {
      "yAxes": [
        {
          "ticks": {
            "beginAtZero": true
          }
        }
      ],
      "xAxes": []
    },
    "type": "line"
  },
  "activityStatus": "Active"
}

Delete Dashlets

You can delete a dashlet that is not required any more.

Click on the 'Delete' icon.

Note:

It should not be attached at any protocol level or system level.
Check that the value under the 'Dashboards' column is 0. If not, you will have first to remove the dashlet from all the dashboards.

Exporting Dashlet Definition

Click on the 'Export' icon.

Import Dashlet Definition

You can modify the exported dashlet definitions and import the JSON back. Also, the dashlets can be exported from one instance and imported to another instance of OpenSpecimen.

Click on the 'Import' button.

Choose the updated JSON file → 'Import'.

Embed Dashlets

OpenSpecimen provides an embed option so that the dashlets can be embedded into other web pages, such as a university site, biobank site etc., using the HTML tag. Only the Super admins can see the embed option after they log in.

Log in as Super Admin
Click on the three dots in the corner of the dashlet → Embed.

A pop-up will open with the HTML tag that can be added to the web page.

Re-order Dashlets

The order of dashlets can be changed within a Catalog or CP. All admin's can re-arrange these dashboards.

Steps to Re-order System Catalog Dashboard

Users who have access to the catalog can add/remove/re-arrange the dashlets attached to it.

Go to the 'Catalogs' → System Catalog → Dashboard.
Drag the dashlets in the expected order.
Click on 'Save' at the bottom of the page.

Steps to Re-order CP Dashboard

Similar steps can be followed for a CP dashboard. Admins who have access to collection protocol can add/remove/re-arrange the dashlets attached to it.

Navigate to CP → Select a CP, and from the overview page, click on 'Settings' → Dashboard.

Dashboard