Checklists¶
A checklist lists tasks a user should complete, with progress. Create one with New content, then Checklist, or build one inside a resource centre with Add task list.
Tasks and goals¶
Each task has a label and a completedWhen goal that marks it done. It can also have:
- A description: one line shown under the label.
- A Show me target (
contentId): a walkthrough, process, announcement or resource. When set, the task shows a Show me button that starts the walkthrough or process, shows the announcement, or opens the document. Leave it empty for a task that points at nothing.
| Goal | Done when |
|---|---|
element-appears |
A given element is present on the page |
url-matches |
The page URL matches a pattern |
last-step-completed |
The linked walkthrough reaches its last step. Needs a Show me target |
element-clicked |
A given element is clicked |
field-filled |
A given field has a value |
content-completed |
Another walkthrough or process is completed |
manual |
The reader ticks it, and can untick it |
A manual task has a tick button the reader can reach with the keyboard. It is the right goal for work Guidepost cannot see, such as "tell your lead".
How ticks happen¶
A checklist shown in the resource centre watches the page while the centre is open and while it is closed, so the tick is already there when the reader opens it. Clicks are caught as they happen. Field, page, element-appears and content goals are checked again every second and a half while they are open.
Options¶
| Option | Effect |
|---|---|
Collapse when done (hideCompleted) |
A finished list shrinks to a single "Done" line |
Start over when published (resetOnPublish) |
Every reader's ticks are cleared when you publish a new version. Off by default |
Ticks are kept by task id. Publishing a change keeps every tick whose task still exists; a task you delete simply stops counting. Turn on resetOnPublish for a list that should restart, such as a yearly review.
Display¶
resource-center shows the checklist as a Tasks tab in the resource centre. launcher shows a standalone progress launcher on matching pages. A launcher checklist with no items shows nothing, and Checks warns with checklist-empty.
Worked example¶
Onboarding for a new adjuster:
- New content, Checklist: "Getting started".
- Add tasks: "Open a claim" (Show me the intake walkthrough, goal
last-step-completed), "Attach a document" (element-clickedon the Attach button), "Add a note" (field-filledon the Notes field), "Tell your lead" (manual, with the description "A short message is enough"). - Display
resource-center. Publish. - Open the resource centre on the page and watch tasks tick as the user works.
Gotchas¶
- A
last-step-completedtask with no Show me target cannot complete, and Checks blocks publishing it. Goals other thanlast-step-completed,content-completedandmanualrely on the host page's elements. If the application renames them the task never ticks. The locator recovery rules apply as for any anchor. - Progress is stored in the browser profile under the local user id, with no network. Another browser or machine starts from zero.
- There is no standalone checklist page; a checklist always lives in the resource centre or a launcher.
- A list can be listed in several centres; its ticks are shared, because progress belongs to the checklist.