Skip to content

Commit 4c2562f

Browse files
feat: Add task notifications documentation (#1992)
* Update content/en/building/tasks/tasks-overview.md Co-authored-by: Andra Blaj <andra@medic.org> * Update content/en/building/tasks/tasks-overview.md Co-authored-by: Andra Blaj <andra@medic.org> * clean up * more clean up * address feedback * add image --------- Co-authored-by: Andra Blaj <andra@medic.org>
1 parent 5a5d957 commit 4c2562f

File tree

5 files changed

+20
-0
lines changed

5 files changed

+20
-0
lines changed

content/en/building/branding/android.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ To proceed you need to have ready the following:
4747

4848
- The URL of your CHT server so users don't have to type it in post install.
4949
- The app logo and title.
50+
- Notification icon.
5051
- Translations for your supported languages (most flavors don't need to customize translations though).
5152

5253
Also be sure to have a working **[Development Environment](/community/contributing/code/android/development-setup)**.

content/en/building/reference/app-settings/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The following settings do not need to be specified. They should only be defined
4747
| outgoing_deny_with_alphas | When `true`, deny all messages to recipient phone numbers containing letters (eg. `Safaricom`). Intended to avoid [message loops]({{% ref "building/messaging/message-loops" %}}) with non-numeric senders used by gateways. A boolean. | true | 3.3.0 |
4848
| outgoing_deny_with_alphas | When `true`, deny all messages to recipient phone numbers containing letters (eg. `Safaricom`). Intended to avoid [message loops]({{% ref "building/messaging/message-loops" %}}) with non-numeric senders used by gateways. A boolean. | true | 3.3.0 |
4949
| task_day_limit | The number of days before a task is due to show the due date. | 4 | 3.9.0 |
50+
| max_task_notifications | The maximum number of task notifications to show at once. | 8 | 5.1.0 |
5051
| app_url | The URL of the app, eg: "https://demo.app.medicmobile.org" | | 3.10.0 |
5152
| task_days_overdue | Display number of overdue days in tasks list | false | 3.13.0 |
5253
| languages | Array of objects with `locale` and `enabled` properties representing respectively the 2 or 3 letter language code and whether that language should be enabled. <br/>If unset it falls back to the previous behavior of relying on the `enabled` property of each translation document `messages-XX.properties`. This fallback behavior is now deprecated and will be removed in the next major version (5.0). This `languages` configuration property will be required for CHT 5.0+. | | 4.2.0 |

content/en/building/reference/app-settings/user-permissions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Permissions can be assigned to user roles either directly in `base_settings.json
4343
| `can_export_dhis` | Allows export of DHIS2 metrics |
4444
| `can_export_feedback` | Allows export of user feedback |
4545
| `can_export_messages` | Allows export of reports and messages |
46+
| `can_get_task_notifications` | Allows users to receive task notifications |
4647
| `can_log_out_on_android` | Displays logout menu item in hamburger menu for Android users and can be used to log out from the application |
4748
| `can_update_places` | Allows editing of place documents |
4849
| `can_update_reports` | Allows editing of report documents |

content/en/building/tasks/tasks-overview.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,23 @@ Older configurations that do not implement the new priority score will continue
5454
{{< card link="tasks-prioritization.png" image="tasks-prioritization.png" method="resize">}}
5555
{{< /cards >}}
5656

57+
58+
59+
## Android task alerts/notifications
60+
61+
{{< callout >}}
62+
Available from CHT Core 5.1.0 and CHT Android 1.7.0.
63+
{{< /callout >}}
64+
65+
Android notifications can be configured to remind users of their tasks. When this [permission]({{< relref "building/reference/app-settings/user-permissions" >}}) is active, a notification is sent daily for each due or overdue task, up to a defined limit. Each notification displays the specific task title and description. The notification content is customizable and can be [translated]({{< relref "building/translations/localizing" >}}) via the `android.notification.tasks.contentText` key, which supports the following parameters:
66+
- `taskTitle` The task title.
67+
- `contact` The contact that the task is about.
68+
69+
{{< figure src="tasks-notification.jpg" link="tasks-notification.jpg" caption="A task notification." >}}
70+
71+
Additional configuration can be done in the [app settings]({{< relref "building/reference/app-settings" >}}) to control the maximum number of notifications that can be shown at once.
72+
73+
5774
### Quick guides
5875

5976
For more details and guides, see the following sections:
33.5 KB
Loading

0 commit comments

Comments
 (0)