Skip to content

Commit

Permalink
Add paragraph about risk of spamming task docs
Browse files Browse the repository at this point in the history
  • Loading branch information
garethbowen committed Jul 28, 2022
1 parent 6e2926d commit 7b288f6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion content/en/apps/reference/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ keywords: tasks workflows

![task](task-with-description.png)

Tasks are configured in the `tasks.js` file. This file is a JavaScript module which defines an array of objects conforming to the Task schema detailed below. When defining tasks, all the data about contacts on the device (both people and places) along with all their reports are available. Tasks are available only for users of type "restricted to their place". Tasks can pull in fields from reports and pass data as inputs to the form that opens when the task is selected, enabling richer user experiences.
Task generation is configured in the `tasks.js` file. This file is a JavaScript module which defines an array of objects conforming to the Task schema detailed below. When defining tasks, all the data about contacts on the device (both people and places) along with all their reports are available. Tasks are available only for users of type "restricted to their place". Tasks can pull in fields from reports and pass data as inputs to the form that opens when the task is selected, enabling richer user experiences.

Task generation occurs on the client periodically and creates documents which track the status of the task over time. To avoid performance issues the developer needs to be conscious about generating too many tasks. For example, to remind a user to do something every day, you could generate one task for each day and fill up the user's device. The recommended approach is to only generate the tasks for the near future, or only once the previous task is resolved. To limit the impact of this misconfiguration, the CHT will only generate tasks that can be completed between 60 days in the past, and (as of 4.0.0) 180 days in the future.

{{< see-also page="apps/features/tasks" title="Tasks Overview" >}}

Expand Down

0 comments on commit 7b288f6

Please sign in to comment.