Eleos - How To Use The Action Request Feature : ASR Solutions

Overview

In the 1.59 version of the mobile application, Eleos introduced the Action Requests feature. Action Requests are notifications that appear within the app, overlaying the existing UI, and require user acknowledgment and response before further interaction with the app can continue.

To ensure safety and minimize distractions, Eleos delays Action Requests while drivers are in turn-by-turn navigation or in the in-motion locking screen. These requests will automatically display once the driver exits these screens. Additionally, only one Action Request can be active for a user at a time, ensuring that drivers are never overwhelmed with multiple requests that each require acknowledgment.

When configured, users have the option to snooze an Action Request for 15 minutes, allowing them to temporarily dismiss it and address it later. However, this snooze functionality can also be disabled based on configurations as the action requests are created and sent.

This feature can be used to help ensure that drivers acknowledge crucial information during their daily operations. For example, an Action Request can be used to deliver an urgent safety reminder and require confirmation of a key step during a specific stop. However, since only one Action Request can be active at a time and because these requests take precedence over other app functions they should be used sparingly and reserved for only critical information that requires immediate attention.

The Action Requests feature is only available after receiving the Q1 2025 release of ASR's Eleos Integration

Enabling, Disabling, And Configuring The Action Request Feature

Action Requests can be enabled or disabled within the appsettings.json file where the integration is deployed. A client can configure the interval at which pending action requests are processed. This interval is in seconds, and the lower this value the more frequently pending Action Requests are processed and the higher this value, the less frequently these will be processed.

Within the appsettings.json file under the general “Settings” section, the “ActionRequestsEnabled” setting should be set to either true or false to enable or disable this feature, and the “ActionRequestIntervalSeconds” setting should be configured to an integer value greater than zero.

Note our recommended default value for the “ActionRequestIntervalSeconds” setting is 60.

How Action Requests Work

Action Requests are triggered from the database connected to your integration and are audited in the ELEOS.ActionRequests table. This table serves as a history table and queue table that tracks the details of each Action Request as individual records and whether these Action Requests were successful or unsuccessful in reaching the user.

When Action Requests are created and pending, the integration’s background service (when enabled and configured via the settings mentioned in the previous section), will run on a set interval and process these pending requests in the table. This processing from the integration’s background service is what handles reaching out to Eleos’s API, making the HTTPS request for an Action Request, and updating the table accordingly based on the response received from Eleos. When the HTTPS request is successful, this results in the Action Request being made for the user and it being displayed on their mobile device. When this fails, the integration will retry the Action Request for the user up to 10 times.

When an Action Request reaches the user’s mobile device and overlays their current UI it will have either one or two actions, depending on how the request was configured, and one must be selected for acknowledgement. Once an action on the Action Request is selected it will launch the associated form tied to that action defined in Eleos App Manager that then must be submitted to fully complete the Action Request. Note that the only action type Eleos currently supports for actions on an Action Request is “New Message”.

The above screenshots show how the action that will be on the Action Request is defined in the Eleos App Manager platform and show the action type of “New Message”. This also shows that this action launches the form called “Action Request Test”.

The above screenshots show the Action Request, with the action and associated form defined in the previous screenshots, reaching the user’s mobile device. The user in this example must select “Acknowledge” on the screenshot on the left then complete the “Action Request Test” form on the screenshot on the right. While they do have the option to snooze in this example, once the 15-minute snooze time is reached they will be presented with the same Action Request UI except with the only option being the “Acknowledgement” action.

Snoozing an Action Request can only be done until the maximum 15-minute period has elapsed then the request must be completed by the user. If a user snoozes a request but needs to complete it sooner and does not want to wait 15 minutes, they can find the request while it is snoozed in their menu options.

Note above shows how this appears in landscape mode (on the left) and portrait mode (on the right).

How Action Requests Are Created

As mentioned in the above sections, Action Requests are created and triggered from the database connected to your integration and can be done using the ELEOS.usp_CreateActionRequest stored procedure. This procedure handles taking the required and provided parameters for configuring an Action Request and inserting it into the ELEOS.ActionRequests table. While this procedure can be run manually from a database to create Action Requests that are one-off for users, this stored procedure can also be called as a part of other SQL processes to automatically create Action Requests depending on your needs.

When the ELEOS.usp_CreateActionRequest stored procedure is called, the following parameters listed below can be specified for changing how the action request is created and looks, some parameters are required for calling the procedure:

@p_Username
@p_Title
@p_Body

These parameters are required when creating an Action Request and determine which user the request is for, the title of the request, and the body of the request that reflects how it displays within the app shown in red highlighted area below:

Note that an Action Request is also required to have at least one action as well so if an action is not defined using the parameters from the first action or second action in the bullet lists below, the action request will fail and not be sent.

@p_Action1Code
@p_Action1Type
@p_Action1Label
@p_Action1ButtonColor
@p_Action1ButtonColorDark
@p_Action1IconRef
@p_Action1FormCode
@p_Action1ShowFormEditor

These parameters are used for defining how the first action on the Action Request looks. If only the “@p_Action1Code” parameter is supplied, and if it is configured to an action’s code that exists in Eleos App Manager, then this existing definition of this action from Eleos App Manager will be used and shown as an option for the user.

Note the type for this existing action in Eleos App Manager must be “New Message”.

If the “@p_Action1Code” parameter is not supplied, the entire action must be defined through SQL using the remaining parameters for the first action. See the example below called “ACTION REQUESTS WITH ACTIONS DEFINED THROUGH SQL” for an example on how these parameters should be supplied.

If the “@p_Action1Code” parameter is supplied and additional parameters for the first action are also supplied, this will change how the existing action from Eleos App Manager appears but will not alter the definition of the action within Eleos App Manager, this only changes the action’s appearance during the Action Request. See the example below called “ACTION REQUESTS WITH ACTIONS DEFINED IN ELEOS APP MANAGER AND OVERWRITTEN THROUGH SQL” for an example on how these parameters should be supplied.

@p_Action2Code
@p_Action2Type
@p_Action2Label
@p_Action2ButtonColor
@p_Action2ButtonColorDark
@p_Action2IconRef
@p_Action2FormCode
@p_Action2ShowFormEditor

These parameters, like the ones previously mentioned, are used for defining how the second action on the Action Request looks and follow the same principles for how they can be configured.

@p_Sound
@p_SnoozeEnabled
@p_OverwriteExisting
@p_ExternalReference

These parameters are used for configuring additional properties for the Action Request such as playing a sound when the user receives the request, determining if the user has the option to snooze the request for 15 minutes or not, and indicating whether the request will overwrite any existing request the user has displayed.

Note because a user can only have one Action Request displayed to them at a time, the “@p_OverwriteExisting” parameter can be utilized to delete any existing Action Request not yet completed and will instead display the new one taking precedence over the prior request.

In addition, note the “@p_ExternalReference” parameter is only used for Action Request lookups typically when this feature is implemented in a custom process and can be excluded when creating requests manually.

@p_ActionRequestId

This last parameter is an output parameter used for returning and storing the id of action requests as they are created and is required when calling the procedure but can be defaulted to NULL if you are not prefilling data on actions defined through SQL. See the sub section called “PREFILLING DATA ON SQL DEFINED ACTIONS FOR ACTION REQUESTS” for more information on how you can prefill data if actions are created through SQL.

The sub sections below provide examples and SQL scripting for manually creating Action Requests for a few common configurations. Note for the red text in the examples provided below, you must replace these values with the appropriate data specific to your environment:

Action Request With One Action Defined In Eleos App Manager

In this example the SQL executes the procedure, providing the minimum required parameters to create an Action Request for a user that contains one action defined within Eleos App Manager that the user must select and submit the associated form for to complete the Action Request.

Note the option for snoozing the request is enabled by default when the parameter is not specified and the option for overwriting existing requests is disabled by default when this parameter is also not specified.

EXEC ELEOS.usp_CreateActionRequest
     @p_Username            = 'ENTER USERNAME HERE'
    ,@p_Title               = 'Example One'
    ,@p_Body                = 'This example shows one action defined from App Manager.'
    ,@p_Action1Code         = 'ENTER ACTION CODE HERE'
    ,@p_ActionRequestId     = NULL
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC

Action Request With Two Actions Defined In Eleos App Manager

In this example the SQL executes the procedure to create an Action Request for a user that contains two actions that are defined within Eleos App Manager that the user will have the option of choosing. Selecting either action and submitting the associated form will result in the action request being completed.

EXEC ELEOS.usp_CreateActionRequest
     @p_Username            = 'ENTER USERNAME HERE'
    ,@p_Title               = 'Example Two'
    ,@p_Body                = 'This example shows two actions defined from App Manager.'
    ,@p_Action1Code         = 'ENTER FIRST ACTION CODE HERE'
    ,@p_Action2Code         = 'ENTER SECOND ACTION CODE HERE'
    ,@p_ActionRequestId     = NULL
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC

Action Request With Actions Defined In Eleos App Manager And Overwritten Through SQL

In this example the SQL executes the procedure, to create an Action Request for a user that contains two actions that each have their existing definitions pulled from Eleos App Manager through the “@p_Action1Code” and “@p_Action2Code” parameters and are changed by additional parameters altering how these actions look only for the Action Request.

In the example screenshot below this shows the actions from the previous example updated to have different labels, colors, and icons.

EXEC ELEOS.usp_CreateActionRequest
     @p_Username                = 'ENTER USERNAME HERE'
    ,@p_Title                   = 'Example Three'
    ,@p_Body                    = 'This example shows two existing actions updated with SQL.'
    ,@p_Action1Code             = 'ENTER FIRST ACTION CODE HERE'
    ,@p_Action1Label            = 'Confirm'
    ,@p_Action1ButtonColor      = '#AF52DE'
    ,@p_Action1ButtonColorDark  = '#AF52DE'
    ,@p_Action1IconRef          = 'recommendation'
    ,@p_Action2Code             = 'ENTER SECOND ACTION CODE HERE'
    ,@p_Action2Label            = 'Reject'
    ,@p_Action2ButtonColor      = '#A2845E'
    ,@p_Action2ButtonColorDark  = '#A2845E'
    ,@p_Action2IconRef          = 'reject-load'
    ,@p_ActionRequestId         = NULL
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC

Action Request With Actions Defined Through SQL

In this example the SQL executes the procedure, passing in all parameters for the first and second action and specifically passing in NULL for the “@p_Action1Code” and “@p_Action2Code” parameters to indicate that these actions are not defined by existing action but instead created through SQL. It should be noted though as shown in this example that an existing form code defined in Eleos App Manager does still need to be provided. These two actions will be created and displayed to the driver and the configured form code will be launched for the action the user chooses.

Additional note when defining actions through SQL the “@p_Action1Type” and “@p_Action2Type” parameters must be ‘transaction-editor’ as this creates the action as a “New Message” type which is the only type Eleos currently supports.

EXEC ELEOS.usp_CreateActionRequest
     @p_Username                = 'ENTER USERNAME HERE'
    ,@p_Title                   = 'Example Four'
    ,@p_Body                    = 'This example shows two actions created with SQL.'
    ,@p_Action1Code             = NULL
    ,@p_Action1Type             = 'transaction-editor'
    ,@p_Action1Label            = 'Yes'
    ,@p_Action1ButtonColor      = '#7BD811'
    ,@p_Action1ButtonColorDark  = '#1BD811'
    ,@p_Action1IconRef          = 'documents'
    ,@p_Action1FormCode         = 'ENTER FIRST FORM CODE HERE'
    ,@p_Action1ShowFormEditor   = 1
    ,@p_Action2Code             = NULL
    ,@p_Action2Type             = 'transaction-editor'
    ,@p_Action2Label            = 'No'
    ,@p_Action2ButtonColor      = '#FFCC00'
    ,@p_Action2ButtonColorDark  = '#DFCC00'
    ,@p_Action2IconRef          = 'feedback'
    ,@p_Action2FormCode         = 'ENTER SECOND FORM CODE HERE'
    ,@p_Action2ShowFormEditor   = 1
    ,@p_ActionRequestId         = NULL
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC

Additional Configurations On Action Requests

This last additional example shows how snoozing, sounds, and overwriting on Action Requests can be configured. This additional configuration through the inclusion of the SQL parameters can be applied to any prior example shown above and when doing so will remove the orange snooze option, seen on previous example screenshots and will also replace an Action Request that may still be up on a user’s device.

EXEC ELEOS.usp_CreateActionRequest
     @p_Username            = 'ENTER USERNAME HERE'
    ,@p_Title               = 'Overwriting Example'
    ,@p_Body                = 'This example disables snoozing plays a sound and overwrites.'
    ,@p_Action1Code         = 'ENTER ACTION CODE HERE'
    ,@p_Sound               = 'honk'
    ,@p_SnoozeEnabled       = 0
    ,@p_OverwriteExisting   = 1
    ,@p_ActionRequestId     = NULL
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC

Note on the 1.59.2 version (and below) of the application, there exists a known issue with Eleos where overwriting Action Requests may not fully refresh in the application correctly. This has been primarily noticed when overwriting Action Requests do not contain either a second action or the snooze option only when the previous request did have either of these configured. The workaround for mitigating this on the effected versions is by clicking into the action of the Action Request and then backing out of the launched form to trigger the overwriting Action Request to be manually refreshed again.

Prefilling Data On SQL Defined Actions For Action Requests

When actions on Action Requests are specifically defined through SQL, they do not exist within Eleos App Manager to be configured for prefilling. Because of this, if SQL defined actions need to be prefilled, they require the use of the ELEOS.usp_CreateActionRequest procedure (to initially define the actions) and additional SQL to insert the prefilled data on those actions. This prefilled data is inserted and audited on the subsequent table ELEOS.ActionRequestData. When inserting into this table you must know the field code names on the action’s associated form in Eleos App Manager that you want data prefilled for. These field code names will be what you want to replace for “ENTER FIELD CODE NAME HERE” and the values you want these prefilled as will be what you want to replace for “ENTER PREFILLED VALUE HERE”. The “@p_ActionRequestId” output parameter is also used differently in this example when calling the ELEOS.usp_CreateActionRequest procedure as this needs to be stored in a variable to use during the insert into ELEOS.ActionRequestData.

Below provides example SQL that shows how this is put together and can be used as a template or guide and changed for your specific use.

DECLARE @ActionRequestId VARCHAR(100)
 
EXEC ELEOS.usp_CreateActionRequest
     @p_Username                = 'ENTER USERNAME HERE'
    ,@p_Title                   = 'Prefill Example'
    ,@p_Body                    = 'This example shows two actions prefilled from SQL.'
    ,@p_Action1Code             = NULL
    ,@p_Action1Type             = 'transaction-editor'
    ,@p_Action1Label            = 'Yes'
    ,@p_Action1ButtonColor      = '#7BD811'
    ,@p_Action1ButtonColorDark  = '#1BD811'
    ,@p_Action1IconRef          = 'documents'
    ,@p_Action1FormCode         = 'ENTER FIRST FORM CODE HERE'
    ,@p_Action1ShowFormEditor   = 1
    ,@p_Action2Code             = NULL
    ,@p_Action2Type             = 'transaction-editor'
    ,@p_Action2Label            = 'No'
    ,@p_Action2ButtonColor      = '#FFCC00'
    ,@p_Action2ButtonColorDark  = '#DFCC00'
    ,@p_Action2IconRef          = 'feedback'
    ,@p_Action2FormCode         = 'ENTER SECOND FORM CODE HERE'
    ,@p_Action2ShowFormEditor   = 1
    ,@p_ActionRequestId         = @ActionRequestId OUTPUT
 
 
INSERT INTO ELEOS.ActionRequestData
(
     ActionRequestId
    ,ActionNumber
    ,FieldName
    ,FieldValue
)
VALUES
(    --THESE VALUES ARE FOR THE FIRST ACTION AND ITS FORM
     @ActionRequestId
    ,1
    ,'ENTER FIELD CODE NAME HERE'
    ,'ENTER PREFILLED VALUE HERE'
),
(    -- THESE VALUES ARE FOR THE SECOND ACTION AND ITS FORM
     @ActionRequestId
    ,2
    ,'ENTER FIELD CODE NAME HERE'
    ,'ENTER PREFILLED VALUE HERE'
)
 
 
SELECT TOP 1 *
FROM ELEOS.ActionRequests
WHERE Username = 'ENTER USERNAME HERE'
ORDER BY InsertedDt DESC
 
SELECT TOP 1 *
FROM ELEOS.ActionRequestData
WHERE ActionRequestId = @ActionRequestId

For demonstration purposes below shows using the above SQL to create the same action with the same form for both the first and second actions on the Action Request but prefilling these differently.

Eleos - How To Use The Action Request Feature Print