Overview
ToDos can be created in the Eleos Platform and displayed on the driver’s Dashboard, signifying that the driver needs to complete certain actions as defined in the ToDo. ToDo items can be used to list tasks that drivers need to complete, including instructions on how to complete them and a due date. The ToDo prompts a form for drivers to fill out, where they can submit any documents necessary to complete the ToDo. This is what a ToDo placard would look like on the driver dashboard.
The following steps and examples can be used to create an expiration ToDo in the Eleos Platform and link it to the driver dashboards.
Step 1: Create New Document Type
- Login to the Eleos Platform.
- Click Document Hub in the header and select Platform Dashboard.
- Again, in the header row, select App Configuration and select Document Types from the drop down.
- To add a new document type, scroll to the bottom.
- Type the new document name into the Name textbox.
- When finished, press save to update your changes.
Step 2: Create a Corresponding Platform Form for ToDo.
- Login to the Eleos Platform.
- Click Document Hub in the header and select Platform Dashboard.
- Again, in the header row, select App Configuration and then select Forms from the drop-down menu.
- Create an Expiration Form for the ToDo you intend to add. For this example, I will use ForkLift. Use the example screenshot on the next page as a guide to set up the Expiration form. For document type, be sure to select the new document type you added in Step 1.
Step 3: Add ToDos to the dashboard.
- Login to the Eleos Platform.
- Click Document Hub in the header and select Platform Dashboard.
- Again, in the header row, select App Configuration and select Dashboard.
- Click on the dashboard you would like to add ToDos to. If you wish to add ToDos to multiple dashboards, you will have to repeat this process for each dashboard. At the bottom, click on Add a card, and change the Type to "TODOs". Click save at the top of the page.
Step 4: Default ToDos vs Custom ToDos.
Default ToDos already implemented
As a part of the TMWSuite default implementation, we have some general ToDos implemented that are useful. The default ToDos that are created come from the ELEOS.usp_CreateToDos_Mappings procedure, so you can view that stored procedure for an example on how to create your own ToDos. We currently have 3 categories of ToDos implemented in this stored procedure, Expiration Mappings: Driver ToDos, Tractor ToDos, and Trailer ToDos
Driver ToDos from Expiration Mappings
This includes any documents a driver may have that are expiring soon and is referencing the dbo.Expiration table for drivers. Any documents that are expiring soon according to the dbo.Expiration table that has not already been completed, and are within the DisplayLeadDays coming from the ELEOS.ToDosMapping table will have ToDo displayed for the driver, as long as the above steps have been completed, and there is a form associated with the ToDo, and a document type for the document expiring.
Tractor ToDos from Expiration Mappings
If there are any ToDos associated with the Tractor according to the dbo.Expiration table, a ToDo will be created as long as the document types and forms are set up correctly.
Trailer ToDos from Expiration Mappings
If there are any ToDos associated with the Trailer according to the dbo.Expiration table, a ToDo will be created as long as the document types and forms are set up correctly.
NOTE: YOU WILL NEED TO ADD THE DEFAULT EXPIRATION MAPPINGS TO THE ELEOS.ToDosMappings TABLE FOR EACH OF THESE DEFAULT TODOS.
For the ToDo to be populated for the driver, the ToDosMapping table will need to have the expiration type and expiration code inserted. For example, if you wanted drivers to complete a ToDo for their license expiring, insert the following template into the ToDosMapping table:
INSERT INTO ELEOS.ToDosMapping(
ExpirationType,
ExpirationCode,
DisplayLeadDays,
DisplayName,
Description,
ActionType,
FormCode,
ScanType,
MediaId,
Disabled )
SELECT ExpirationType = 'DRV'
,ExpirationCode = 'LIC'
,DisplayLeadDays = 30
,DisplayName = 'Your License Will Expire in 30 Days.'
,Description = 'Test Description'
,ActionType = 'transaction-editor'
,FormCode = 'LICENSE-EXPIRATION'
,ScanType = NULL
,MediaId = NULL
,Disabled = 0
Creating Custom ToDos
To create a custom ToDo for drivers to complete, you will need to complete all the DriveAxle steps above first and, you will need to add this logic to the ELEOS.usp_ToDos_Custom procedure. Use the defaults created in the CreateToDos_Mapping procedure as a template if you wish, as it has all the required fields for a ToDo. However, the main difference between this custom procedure and the defaults is that for custom ToDos you will be inserting these values directly into the ELEOS.ToDos table. I will provide an example template for use below when adding a custom ToDo for drivers to complete:
;INSERT INTO ELEOS.ToDos (
[ExternalSource]
,[ExternalId]
,[DriverId]
,[DisplayName]
,[Description]
,[ActionType]
,[FormCode]
,[MetaDataFormCode]
,[ScanType]
,[MediaId]
,[Completed]
,[DueDate] )
SELECT [ExternalSource] = 'license'
,[ExternalId] = E.[exp_key]
,[DriverId] = @p_UserName
,[DisplayName] = 'License Expiring'
,[Description] = 'Your license is expiring soon, please scan a picture of your license after it is renewed'
,[ActionType] = 'scan-flow'
,[FormCode] = '{form code}'
,[MetaDataFormCode] = '{form code}'
,[ScanType] = 'document'
,[MediaId] = '{id of any media items you wish to display for this todo}'
,[Completed] = 0
,[DueDate] = E.[exp_expirationdate]
FROM dbo.Expiration E
WHERE NOT EXISTS( SELECT NULL
FROM ELEOS.ToDos T
WHERE @p_UserName = T.[DriverId]
AND E.[exp_key] = T.[ExternalId] )
For these custom ToDos, since we are inserting directly into the ToDos table, there is no need to insert the ToDo into the ToDosMapping table. You can still add this to ToDosMapping to have more values to pull from during ToDo processing, but that step isn't necessary.