Skip to content

Commit

Permalink
feat(#1481): update Aggregate Target documentation (#1483)
Browse files Browse the repository at this point in the history
* feat: update Aggregate Target documentation

* chore: more info
  • Loading branch information
Benmuiruri authored Aug 12, 2024
1 parent 7b3dc5f commit 064e51a
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 1 deletion.
59 changes: 58 additions & 1 deletion content/en/apps/features/supervision/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,63 @@ Selecting an aggregate widget opens the detailed view with the data for each ind

{{% alert title="Note" %}} Aggregate targets were introduced in v3.9, and can be configured for both online and offline users. Aggregate targets are based on the widgets seen by CHWs, and dependent on the data that has been synced. If a CHW or the supervisor has not synced, then the aggregate target will not be up to date. {{% /alert %}}

### Filtering Aggregate Targets

The ability for one user to manage multiple areas / facilities was introduced in v4.9.0. With that change it was important for users who manage multiple areas to filter aggregate targets by the respective facilities. The ability for users to filter Aggregate Targets was introduced in v4.10.0.

The following images show the various screens CHW supervisors see in Aggregate Targets. The example user in this illustration manages two facilities: **First Health Facility** and **Second Health Facility**

<br clear="all">

{{< figure src="multi-facility-aggregate-supervisor-landing" link="multi-facility-aggregate-supervisor-landing.png" class="right col-6 col-lg-8" >}}

This is the landing page for the Aggregate Targets for a user who manages multiple areas / facilities.

The name of the facility appears in the breadcrumbs of the aggregate widgets on the Left Hand Side list and underneath the Target Title.

On the Top Right the user can click the **Filter** button to open the sidebar and change the Aggregate Targets of the other facilities.


<br clear="all">

<br clear="all">

{{< figure src="multi-facility-aggregate-supervisor-filter" link="multi-facility-aggregate-supervisor-filter.png" class="right col-6 col-lg-8" >}}

Clicking the **Filter** button opens the sidebar, which allows the user to filter the Aggregate Targets by **Facility** or **Reporting Period**

Selecting the Second Health Facility in the filter updates the Facility name in the breadcrumbs of the aggregate widgets on the Left Hand Side list and underneath the Target Title.

<br clear="all">

<br clear="all">

{{< figure src="multi-facility-aggregate-supervisor-period" link="multi-facility-aggregate-supervisor-period.png" class="right col-6 col-lg-8" >}}

Filtering the Aggregate Targets by **Reporting Period** adds the name of the previous month to the breadcrumbs of the aggregate widgets on the Left Hand Side list and in the Target details.

<br clear="all">

<br clear="all">

{{< figure src="one-facility-aggregate-supervisor-period" link="one-facility-aggregate-supervisor-period.png" class="right col-6 col-lg-8" >}}

Users who manage one area / facility can only filter their Aggregate Targets by **Reporting Period**.

The name of the facility **does not** appear in the breadcrumbs of the aggregate widgets on the Left Hand Side list or underneath the Target Title.

Filtering the Aggregate Targets by **Reporting Period** adds the name of the previous month to the breadcrumbs of the aggregate widgets on the Left Hand Side list and in the Target Details.

<br clear="all">

{{% alert title="Note" %}}
- The list of facilities in the sidebar are sorted in alphabetic order.
- The default filter option for the facilities filter is the first facility in the sorted `array` of user Facilities.
- The default filter option for the reporting period is `This month`.
- The facility filter label in this example (Health Facility) is the `name_key` of the facility `contact_type` configured in the the [app-settings]({{< relref "apps/reference/app-settings/hierarchy" >}})
- The reporting period label in this example (Reporting Period) is added as a translation key `analytics.target.aggregates.reporting_period`.
{{% /alert %}}

## Supervisor Tasks

The CHT can be configured to create [Tasks]({{< relref "apps/features/tasks" >}}) for Supervisors to help plan their performance management reviews. Tasks can be generated based on routine CHW supervision interactions, or data-driven based on specific events (e.g. to follow up with health workers whom haven’t submitted any forms in x period of time). Using Supervisor tasks to ensure that the right actions are taken for the right CHWs at the right time strengthens supervisory program design through routine assessments and timely feedback.
Expand All @@ -48,7 +105,7 @@ This can be used to manage both CHW and CHW supervisor roles.

CHT hierarchies tend to mimic geographical areas but Supervisors often manage CHWs across multiple geographical areas. (Offline) Supervisors who manage multiple areas can see data for all the different areas they manage from one app.

{{% alert title="Note" %}} The ability for one user to replicate data from multiple areas was introduced in v4.9.0. A video demonstration of setting up a multi-facility user and what this looks like from a user's perspective can be found [on the forum](https://forum.communityhealthtoolkit.org/t/support-for-supervisors-who-need-to-manage-multiple-areas/3497/2?u=michael) and in the [June 2024 CHT Round-up](https://youtu.be/hrhdrzP41gE?si=_7wglk7Nm7CCSFbY&t=606). _NOTE: Users assigned multiple areas will not see Aggregate Targets_. {{% /alert %}}
{{% alert title="Note" %}} The ability for one user to replicate data from multiple areas was introduced in v4.9.0. A video demonstration of setting up a multi-facility user and what this looks like from a user's perspective can be found [on the forum](https://forum.communityhealthtoolkit.org/t/support-for-supervisors-who-need-to-manage-multiple-areas/3497/2?u=michael) and in the [June 2024 CHT Round-up](https://youtu.be/hrhdrzP41gE?si=_7wglk7Nm7CCSFbY&t=606). {{% /alert %}}



Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 064e51a

Please sign in to comment.