Introduction
This document outlines steps to control Navigation and Trip Planner features within your Eleos application, which includes enabling/disabling navigation and setting default route options.
Enabling/Disabling Navigation or Trip Planner
Trip Planner and turn-by-turn Navigation are related to one another but are controlled separately. If Trip Planner is enabled the user will see a suggested route found for the Load run. There is also a HOS Driving Range in Trip Planner:
If Navigation is enabled, a user will also be able to click on a green arrow icon that will provide turn by turn directions for along the route.
![]() | ![]() |
There is also Move Pin and Route to Stop in Trip Planner when Navigation is enabled:
Within the Eleos API documentation there is a section for Loads that explains the two features in their platform. https://dev.eleostech.com/platform/#operation/getLoads
Eleos controls these features from a master level, so if you have Trip Planner and Navigation on, they suppress them if needed. Since Eleos requests a Support Request, and often clients may have various ways they want to control things internally, we recommend having Eleos toggle both on and using the Database settings to control either.
Database Layer
Both Navigation and Trip Planner are found for your integration in Databases in your TMS under either Procedures or Functions dependent on which integration version you are using.
Trip Planner (Map Overview for Load)
trip_planner_enabled | boolean Nullable Controls whether the Trip Planner will be shown for this load, which allows drivers to see an overview map of their whole trip. To enable Trip Planner, set this to true. To prevent Trip Planner from showing, set this to false. If this flag is not specified, the default value depends on your account. If Trip Planner is available to your drivers at no additional cost, it will be shown by default. If showing Trip Planner will incur additional charges, it is opt-in and will not be shown by default. Trip Planner is available in version 1.36 and above. Enabling Trip Planner for drivers running previous versions of the app will have no effect. |
Locate the script “ELEOS.usp_GetLoads_Trips_Custom_Template”, which is responsible for selecting load-level properties. (Note that with SQL Contracts implemented the procedure name is ELEOS.usp_GetLoads_Trips_Custom_Template, but for those clients that have not received the SQL Contracts Upgrade yet, they may see an older version of the procedure: ELEOS.usp_GetLoads_Trips).
- TripPlannerEnabled = @False at the load level and this will remove the map.
- TripPlannerEnabled = @True will display the map.
Navigation (Turn by Turn Routing)
prevent_navigation | boolean Nullable When true, turn-by-turn navigation is disabled for stop navigation and POI navigation. This flag overrides prevent_navigation at the stop level. Default value is false. |
Locate the script “ELEOS.usp_StopNavigation_Custom_Template” within the database. (Note that with SQL Contracts implemented the procedure name is ELEOS.usp_StopNavigation_Custom_Template, but for those clients that have not received the SQL Contracts Upgrade yet, they may see an older version of the scripting: ELEOS.udf_StopNavigation).
- PreventNavigation = @False will allow navigation.
- PreventNavigation = @True will disable navigation.
Be mindful to ensure you are not changing COALESCED values, otherwise if set earlier in the process, it will defer to that.
Integration Layer
For Navigation to be enabled properly you also must verify the proper Geotab settings in the “appsettings” file within the integration.
In the “appsettings” file locate the “Geotab” object where its properties are being defined:
For navigation to show, a latitude and longitude must exist, this is done by setting “Enabled” to true as well as “GeocodeStops” to true:
Since the GeocodeStops logic may also be often used by customers for lat/long creations, many have this true regardless of if they use Geotab or not, or even if they have navigation disabled. This could be for automatic lat/long creations for master data, or geocoding lat/longs for other routing products. Check with ASR if you are unsure.
It is best to leave this True unless it is conflicting with other software you have that generates lat/longs for you.
How to Set Default Route Options in the Database
It is possible to set default Route Options in the database including route properties, truck properties, and cargo properties. One example of this is setting the Route Options to avoid toll roads by default.
To set a Route Option as default, first locate the script “ELEOS.usp_StopNavigation_Custom_Template” to make modifications within the database. (Note: With SQL Contracts implemented the procedure name is ELEOS.usp_StopNavigation_Custom_Template, but for those clients that have not received the SQL Contracts Upgrade yet, they may see an older version of the scripting: ELEOS.udf_StopNavigation).
If SQL Contracts are implemented, to set a Route Option as enabled by default (checked by default in the application for drivers), use the instructions in the ELEOS.usp_StopNavigation_Custom_Template to set the column to True (1) within the #ASR_StopNavigation table for the Route Option being enabled. Below is a screenshot of the usage instructions for ELEOS.usp_StopNavigation_Custom_Template.
If SQL Contracts are not yet implemented, then the change to enable a Route Option by default would be made in ELEOS.udf_StopNavigation by changing the value for the relevant setting to "@True". Below is a screenshot of how to enable the “Avoid Toll Roads” option as an example, by inserting into the @Navigation table in the ELEOS.udf_StopNavigation. The screenshot also shows the other Route Options that can be set in the database.
Enabling a Route Option in the database will ensure that the Avoid Toll Roads option is checked by default in the Route Options in the application.
Note: When route options are set in the database it sets the defaults for drivers in the application, but drivers are still able to change the Route Options within the application after starting navigation by clicking “Route to Stop” on the selected stop on the load. The right side shows what the Route Options look like within the application.