Dashboard filters for custom dashboards

[vinayvenu]

As part of this epic, we will support filters on the custom dashboard.

With this epic, we will provide options to define filters for Custom Dashboards.

Filters will need to be defined on a per-dashboard basis at the minimum because the filter on each dashboard can be different.

Current configuration style

Given below is a sample My Dashboard filter. This is present as part of the organisation config of an organisation. Each filter is marked against a specific subject type.

[
  {
    "type": "Address",
    "widget": "Default",
    "titleKey": "Address",
    "subjectTypeUUID": "9f2af1f9-e150-4f8e-aad3-40bb7eb05aa3"
  },
  {
    "type": "Address",
    "widget": "Default",
    "titleKey": "Address",
    "subjectTypeUUID": "ea7e5c94-5e90-4288-803d-6a1aa9d80acd"
  },
  {
    "type": "GroupSubject",
    "widget": "Default",
    "titleKey": "Phulwari",
    "subjectTypeUUID": "9f2af1f9-e150-4f8e-aad3-40bb7eb05aa3",
    "groupSubjectTypeUUID": "ea7e5c94-5e90-4288-803d-6a1aa9d80acd"
  },
  {
    "type": "Concept",
    "scope": "programEncounter",
    "titleKey": "Growth Faltering",
    "conceptName": "Growth Faltering Status",
    "conceptUUID": "a5067bcc-d333-4c80-a0f2-d61df9d210d3",
    "conceptDataType": "Coded",
    "scopeParameters": {
      "programUUIDs": [
        "352d906c-b386-496c-ba23-91b1468a5613"
      ],
      "encounterTypeUUIDs": [
        "02c72b2b-19f0-4f75-b734-dcad5601881b"
      ]
    },
    "subjectTypeUUID": "9f2af1f9-e150-4f8e-aad3-40bb7eb05aa3"
  }
]

Changes required

• We need the dashboard uuid to be part of this configuration
• We need a new place to store this new configuration type to ensure backwards compatibility. Move dashboard configuration to new table. Keep old configuration and maintain it for default dashboard cards.
• Change app designer to give an option to provide dashboard name as well. Save in two different places - organisation_config and dashboard_filter (new table)
• Sync dashboard_filter table to app and start using it
• New app will exclusively use the dashboard_filter to show dashboards. Old MyDashboard will be removed
• Send these dashboard filters (based on dashboard) to each report card to apply the filter

Tasks

• New db design for dashboard_filter
• Sync of dashboard_filter to client
• Usage of dashboard_filter on organisations using myDashboard
• New screen for filters on Custom Dashboard (on home as well as dashboard screens)
• Sending of dashboard_filter to new dashboards
• Change of app designer to have a new field for Dashboard name
• Save of dashboard filters on server (remember to keep old dashboard content)
• Removal of flag "showTotalForProgram" in orgConfig.settings, introduced as part of avni-client card

Out of scope

Deprecation of MyDashboard

There are some features that are still available in MyDashboard that prevent us from migrating over to this new structure. Since these are out of scope for this epic, we will not be migrating over all MyDashboards to Custom Dashboard. The missing features are

• Autorefresh
• Today/Tomorrow in the filters
• showTotalForProgram where we optionally add or remove cards based on configuration 868

Stories

Beta Give feedback

1. Implementation of dashboard filters on standard report cards avni-client#912
   7 of 7
   +0
2. Add parameters to standard report card types in Custom Dashboard avni-webapp#937
   +0
3. Show and remember Dashboard applied filters avni-client#1004
   +0
   
4. Support Locations in Dashboard filters avni-client#1002
   +0
   
5. Incomplete Display of Encounter Types and concepts in Dashboard Card Filter avni-client#991
   bug +1
   
6. Display of Question Group Concepts in Filters List can be removed. avni-client#992
   +0
7. Add Dashboard filters avni-webapp#936
   +0
   
8. Remove subject type from Custom Dashboard filters avni-webapp#967
   +0
9. [Tech only] Add dashboard_filter to the database avni-server#518
   +0
10. Implementation of filters on non-standard report card types avni-client#913
    +0

[vinayvenu]

We will need to add the ability to have default values here. See https://app.zenhub.com/workspaces/avni-product-635b73bded85e50018871ae6/issues/gh/avniproject/avni-client/828