FI Web UI Clean Up
Responsible team member | @Christina Riley | |
---|---|---|
Current Team Member | @Christina Riley @Annie Martin | |
Status | In Progress | |
Targeted release Date | ||
Scoping Complete Date | ||
Epic Link | ||
LOE | ||
Priority |
Status
# | Step | Status |
---|---|---|
1 | Responsible prepares rough business analysis/reqs doc (data dictionaries) | In progress |
2 | Get CHAI review | |
3 | Get Akros Review | |
4 | Get Ona feedback | |
5 | Responsible - 1 iteration for feedback | |
6 | Ona sign off | |
7 | Ona tech spec scoping | |
8 | Ona LOE | |
9 | Ona scheduling |
The following tickets are detailed in this document:
https://smartregister.atlassian.net/browse/RVL-408
https://smartregister.atlassian.net/browse/RVL-700
https://smartregister.atlassian.net/browse/RVL-603
https://smartregister.atlassian.net/browse/RVL-295
https://smartregister.atlassian.net/browse/RVL-347https://smartregister.atlassian.net/browse/RVL-91
https://smartregister.atlassian.net/browse/RVL-92
This page is split into two sections - updates for the Web UI Monitoring section and updates for the Web UI Planning section further below.
Web UI Monitoring: Map View & Right-hand side Indicator Display
Default, Selectable, & Longitudinal views / indicators: Several pieces of information should be visualised by default and longitudinally across plans. These may or may not be selectable (i.e toggle on & off). Longitudinal and default-view indicators include index cases, family registration, and potential areas of transmission (PAOTs).
Default, selectable, and longitudinal requirements per indicator are documented on the 'Plan definition goals' tab of web ui data dictionary in columns M-O highlighted in light yellow.
The ‘Case Confirmation' indicator should be shown by default in both the map view (as a marked structure) and always selected / not clickable on the indicators listed on the right hand side, and include longitudinal data.
Map view (indicators should always be visible):
Index case cross-hair icon should show in bold green for active index case(s)
Index case cross-hair icon should show in normal yellow for historical index cases
Q: How many historical index cases should be visible? Do we want this to be number bound (i.e. last 3, 5, or 20 cases)? Or time bound (i.e. historical cases within past 4 months, 1 year, 3 years)?
Indicator list on right-hand side: The 'Case Confirmation' header should be differentiated from the other indicators to show that it is not clickable and always selected (shown with greater weight font and a colored, non-black background).
Recommend using the following:
‘Case Confirmation’ header = black font with greater weight
Background = light grey to differentiate from other indicators
Q: When multiple index cases are detected within a focus over the duration of an active plan, should this indicator become dynamic (i.e. 2 of 4 active index cases detected?) Should the plan expiration be extended to x number of days from the most recent index case in the focus?
The ‘Family Registration’ indicators should be selected by default when the page loads (showing ALL structures in the focus area) and should have the indicator list header highlighted in green indicating that it is currently selected, and include longitudinal data.
Map view:
All structures (historically added & newly added) should be visible
Even if the default-selected family registration is deselected, all structures should remain visible on the map UI
Structures with families registered should have pink business status (both registered historically and registered under the current plan)
Structures with no completed family registration task should have a yellow business status
Indicator list on right-hand side: The ‘Family Registration’ indicators should be selected by default when the page loads (showing all structures in the focus area) and should have the indicator list header highlighted in green indicating that it is currently selected (this can be deselected).
The ‘PAOT’ indicator should be shown by default view and longitudinally to see both current and historic PAOTs (not mutually exclusive).
Map View:
All PAOTs (historically added & newly added) should be visible
Current/active PAOTs should have a bold green icon
Inactive PAOTs in focus should be in normal yellow
Indicator list on right-hand side:
This indicator is dynamic and the denominator should update as PAOTs are added
Q: Should this always be visible or toggle on/off?
Q: How many inactive PAOTs should be visible? Do we want this to be number bound (i.e. most recent but currently inactive 3, 5, or 20 PAOTs)? Or time bound (i.e. historical/inactive PAOTs within past 4 months, 1 year, 3 years)?
Plan-specific & non-default views / indicators: Other pieces of information should only be viewable for the given plan and are selectable / clickable but are not shown by default. These include BCC, RACD / blood screening, ITN distribution, IRS spraying, and mosquito collection points & larval breeding sites. These indicators do not include longitudinal data. As of Feb 4th, 2020 - no changes need to be made to these indicators.
Note: Only one task at a time will be shown as displaying more than one will require complex logic to generate the colours as displayed on the Android app
The header of the right panel should reflect the actual plan type displayed (currently it is showing ‘Routine Investigation' for Reactive plans
Q: Should entomological collection points be viewable historically?
Web UI Monitoring: Indicator Calculations & Indicator Text
See Web UI Goals and Progress Indicator visualization scoping page for historic calculations.
Progress indicators and goal target definitions are documented on the 'Plan definition goals' tab of web ui data dictionary and the Reveal dashboards, including variable-specific calculations highlighted in light green. The list has been reordered to reflect the order of indicators that should be displayed in the Web UI.
Indicator list on right-hand side:
The text for goalTargetMeasure (in white text) should be pulled from Column D. Current changes needing to be made are as follows:
BCC should read ‘Measure: BCC Activities Complete’
This change also need to be made in BIOPHICS as per ticket https://smartregister.atlassian.net/browse/RVL-841
The text for ‘Progress: x of y activit(y/ies) complete (zz%)’ should be updated as follows to read:
For BCC: ‘Progress: x of y activity complete’
For ICC: ‘Progress: x of y activities complete’
Q: Do we want to remove the percentage here as originally requested? In foci with multiple index cases for one plan, this may be relevant.
For all other tasks: ‘Progress: x of y activities) complete (zz%)’
The calculation for RACD & MBS tasks should be as follows:
= [# of individuals tested on MBS/RACD form] / [# of eligible individuals registered]
Web UI Monitoring: Data syncing after plan expiry for expired, current, & newly created plans
Data entered offline but synced after a plan has expired does sync to the dashboard for that plan for all current releases. Currently longitudinal data (i.e. family registration) for the expired plan will populate for a plan created after this data syncing occurred.
However, the longitudinal data (i.e. family registration) for the expired plan will not populate / update for a plan that was created prior to the data syncing. Q: Do we want to change data syncing for longitudinal data to dynamically update for current plans in-progress? This seems complicated.
Web UI Planning: Field label edits
The ‘create plan’ page in the web UI planning module has a field that currently reads ‘Focus Investigation Status’ with a dropdown for A1-B2 classifications. This field should read “Focus Classification”.
In the future, this should autpopulate via integration with BIOPHICS once the location & focus have been selected.
Q: Do we want to integrate this feature now?
We do not need an additional ‘Focus Investigation Status’ field in the planning module.
This site is no longer maintained. Please visit docs.opensrp.io for current documentation.