Overview
The To Do service enables you to assign and track tasks for specific mobile app users. To Dos appear on the user's dashboard with a due date and require the user to complete a defined action before the To Do can be closed.
Common use cases include:
Updating CDLs or medical cards
Certifying completion of training courses
Reviewing and approving hours
Submitting incident reports
How it works
To Dos are powered by your backend systems through two client web services: a To Do service, which the Platform calls to fetch active To Do’s for a user, and your Messaging service, which receives the completed submission when a user finishes a To Do.
To Do Types
Before creating a To Do, determine which type best fits the required action.
Type | Function |
|---|---|
| Prompts the user to scan a document or image |
| Prompts the user to complete a pre-specified form |
| Prompts the user to watch a pre-specified video |
To Do Lifecycle
A To Do follows a five-step lifecycle from creation to completion.
Creation: Assign a 'To Do' to a user from one of your systems via API (e.g., dispatch, safety, or payroll).
Assignment: The mobile app calls your To Do service, retrieves the new To Do, and displays it on the user's dashboard with the configured due date.
Completion: The user taps the To Do, completes the required action, and submits.
Verification State: The Platform delivers the submission to your messaging service, and the To Do enters a "Pending Verification" state while your team reviews it.
TIP: The "Pending Verification" state is intentional. It gives users confirmation that they have completed their part while your team reviews the submission.
Cleared: Once approved, your web service should stop returning the To Do in order to remove it from the user's mobile app.
Data sources
The data for each To Do comes directly from your backend systems. Your To Do web service is responsible for fetching and formatting the data the Platform needs to display each To Do. Depending on the To Do type, this may require reaching out to different internal systems.
For example, a payroll-related To Do would pull from your payroll system, while a document rescan To Do might pull from your document management system.
NOTE: The Platform does not store To Do data. To Do’s are fetched from your To Do web service each time a user opens the mobile app.
Required Web Services
Two web services must be configured to support To Dos.
To Do Service: Called by the Platform to retrieve the list of active To Do’s for a given user. Your service is responsible for returning the correct To Do type, due date, action configuration, and any pre-filled form data.
Messaging Service: Receives the completed form, scanned document, or video completion event when a user finishes a To Do.
IMPORTANT: To Dos will not appear in the mobile app until both web services are configured and returning valid responses. Navigate to App Administration > Service Config in App Manager to configure your service endpoints.