Dashlets Page-Wise Configuration Design Brainstorm

Owned by ravinder kumar
Last updated: May 25, 2021
6 min read

Title

Dashlet Page Wise Configuration.

Problem Statement

Ability to inject dashlets widgets into any page via configuration.

 

 

Solution is divided into 3 phases :-

  1. Create Configuration for the Dashlets <CREATION>

  2. Linking the page id to the Dashlets Configuration <LINKING>

  3. Rendering the Dashlets <RENDERING>

Proposed Solutions

CREATION PHASE

  1. This phase deals in creation of the dashlets configuration.

  2. Use the Report Service API’s to store the configuration just like we’re doing for the Admin Reports.

  3. In order to prevent these dashlets widget to show in admin Dashboard list page we’ll make use of two cols -

    1. report_type: 'dashlet'

    2. type: ‘private'

  4. Following are the PROS of using the report service API’s for storing dashlets configuration.

    1. Parameterization support ($slug, $board, $state and $channel).

    2. Tags Support

    3. Life Cycle support - Draft, Live and Retired

    4. Can also be clubbed with Summaries API’s.

    5. Authorized Roles field to target specific role to access the Dashboard.

    6. Link to Documentation - http://docs.sunbird.org/latest/apis/reports/

  5. Sample Create API payload

    { "request": { "report": { "title": "title of the report", "description": "Description of the report", "authorizedroles": [ "ORG_ADMIN"