Hub: Routes
Routes are groups of orders typically handled in a single vehicle trip.
- 1 Routes List
- 1.1 Filters
- 2 Route Creation
- 3 Route Plan
- 3.1 Editing Route Properties
- 3.2 Deleting Route
- 3.3 Adding Orders
- 3.3.1 Stop Details
- 3.3.2 Editing Stop Geolocation
- 3.3.3 Removing Orders
- 3.4 Route Capacity
- 3.5 Route CO2 Emissions
- 3.6 Adding Driver Breaks
- 3.7 Re-ordering Orders
- 3.8 Optimizing Route with Time Windows
- 3.9 Optimizing Route without Time Windows
- 3.10 Calibrating Route
- 3.11 Reversing Stops in Route
- 3.12 Bulk Update of Committed Date/Time
- 3.13 Bulk Move Orders between Routes
- 3.14 Route Map
- 3.14.1 Road View Toggle
- 3.14.2 Hold View Toggle
- 3.14.3 Bulk Move Orders between Routes
- 3.14.4 Route Tracking
- 3.15 Saving Route Changes
- 3.16 Release Route
- 3.17 Proof of Delivery
- 3.18 Public tracking
- 3.19 Complete Route
- 3.20 Marking Route for Export
- 4 See Also
Routes List
To list routes in the environment, select Routes
from the toolbar:
By default, routes created in the last 7 days are listed. You can select the other two tabs to show routes created in the last 30 days or list all routes in the environment. Full filtering and sorting criteria are only available for the 7-day and 30-day tabs.
Filters
To narrow down the list of routes, you can set a filter in the Filtering section on the left side of the list. The following filters are available:
Field | Operator | Description |
---|---|---|
Created | From/To | Range of route creation date/time. |
Status | Select | Choose the status of a route:
|
Key | Contains | Match the route key. |
Trip | From/To | Range of route trip number. |
Depot | Select | Key of depot assigned to the route. |
Driver | Select | Display name of user assigned to the route. |
Vehicle | Select | Key of vehicle assigned to the route. |
Planned start | From/To | Range of route planned start date/time. |
Planned end | From/To | Range of route planned end date/time. |
Planned duration | From/To | Range of route planned duration. |
Planned distance | From/To | Range of route planned distance. |
Actual start | From/To | Range of route actual start date/time. |
Actual end | From/To | Range of route actual end date/time. |
Actual duration | From/To | Range of route actual duration. |
Actual distance | From/To | Range of route actual distance. |
Route Creation
On the Routes
page, press Create
button to be redirected to Route creation page. Here are the route properties you can specify:
Property | Description |
---|---|
Key | Your unique identifier for the route in this environment. It can be a route number, for example, 1, 2, 3, etc. |
Trip | A number you can use to indicate, for example, the order of routes for the same vehicle on the day, with the first route of the day being 1, a subsequent one being 2, etc. |
Status |
|
Driver | User responsible for the route. Once released, the assigned user sees the route in the mobile app. A driver has permission to start/complete the route. Once the route is started and location tracking enabled, the driver’s location will be displayed on the map inside the route and on the Started Route Driver Position map on Dashboard page, as well as on the recorded vehicle check. The driver’s location can also be optionally displayed on Public tracking page. However, for POD's, the geolocation of the user who records it will be captured (either the driver or participant). If you use vehicle categories functionality, the system can match the user’s and vehicle’s categories. Users without categories can only be assigned to vehicles without categories. Vehicles without categories can be assigned to any user. Assigning categories to users and vehicles is optional. |
Participants | Up to 2 additional users assigned to the route. Once released, the assigned participant sees the route in the mobile app. While the driver retains the ability to start and complete a route, participants will have access to a route to check the list of stops and create POD's for them. |
Route start | If you set up the default depot in Environment settings → Depots, it will be selected by default as a route start but it can be changed. By pressing the Route start field, you can also select other depots from your environment, first stop location (first order recipient’s address), or search address. If you select to search for an address, the Address line 1 field will be displayed below. To enter the address, you can start typing it into Address line 1 and selecting it from the drop-down which appears. If no suitable match is found, press the |
Route end | By default, the Return to start option is selected for a route end but it can be changed. By pressing the Route end field, you can also select depots from your environment, last stop location (last order recipient’s address), or search address. If you select to search for an address, the Address line 1 field will be displayed below. To enter the address, you can start typing it into Address line 1 and selecting it from the drop-down which appears. If no suitable match is found, press the |
Vehicle | Vehicle assigned to the route. If you use vehicle categories functionality, the system can match the user’s and vehicle’s categories. Users without categories can only be assigned to vehicles without categories. Vehicles without categories can be assigned to any user. Assigning categories to users and vehicles is optional. Vehicle dimensions specified in the Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) can be used for route calibration/optimization with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route. |
Area | Area tag. You can set up the default user and vehicle for every area. When the area value is selected, default values from the area will propagate to the User and Vehicle fields. |
Vehicle check on route start | Activate vehicle check in the mobile app when the route is being started. |
Vehicle check on route completion | Activate vehicle check in the mobile app when the route is being completed. |
Planned start | Expected dispatch date/time of the route from the route start. |
Planned end | Expected route end - the return of the vehicle to the route end. |
Planned duration | Duration between Planned start and Planned end. Should be provided in minutes. |
Planned distance | Once the route is calibrated and a route recommended, the expected driving distance to call at all of the route’s stops, start and end points. |
Actual ... | If the route is tracked by the assigned user in the mobile app, the actual timings and distance recorded between the actual start and end of the route. |
If you select the same depot for a route start and end, it will be displayed with a blue “Depot” icon on the map.
If you select different depots as a route start and end points, the start depot will be displayed with a green “Depot” icon and the end depot will be displayed with a red “Depot” icon on the map.
If you select some address for a route start, it will be displayed with a green “Play” icon on the map. If you select some address for a route end, it will be displayed with a red “Stop” icon on the map. These pins can be optionally moved to adjust the address.
By default, the map zoom resets when you move the pin on the map. Press Hold view
at the top of the map to hold the map zoom. This still lets you zoom in and out on the map but it will not be automatically zoomed out when you make some changes in the start/end points.
Press Create and go to route list
to create the route and be redirected to the Routes list. If you press Create and go to route plan
, you will be redirected to the Route plan page for the route.
When you press Create
, contents of the route form will be validated and a route created. When successful, you will see an information message Route has been created
:
The created route will be visible in the Routes list.
Route Plan
When you click on a route card in the Routes list, you can edit the route:
edit route properties
delete the route
add orders
add driver breaks
remove orders
re-order orders
reverse order of orders
optimize the route with time windows
optimize the route without time windows
calibrate the route (without optimisation)
update committed ETA's
move orers between route
view the route on an interactive map
add the route to an export queue of the Geo2 API
Consider the impact of your edits, especially once the route is out of the Planned status.
On Route plan page, the start and end points are displayed as separate cards with the titles “Route start” and “Route end”. Depending on what is selected, there will be displayed:
Depot key
Address
“First/Last stop location”
or “Return to start”
On cards, you will also see the planned time and postal code (if a depot or address is selected).
Editing Route Properties
To quickly edit route properties on the Route plan page, hover over the needed field and press the Edit (Pencil)
button. You can edit a route key, trip number, user, vehicle, and area assigned to a route, enable or disable vehicle checks on route start/completion, and change planned and actual start, duration, distance, and end.
Once a value in a field is changed, press the Done
icon or any other space on the page to save it. If you want to discard changes, press the Cross
icon.
If you change a vehicle, or planned start, the planned timings and distance of the route will be recalculated automatically without modifying the orders list. The "Actual start" field can be edited only if a route is in "Started" status. The actual duration, distance, and end can be changed only if a route is in "Completed" status.
To change multiple route properties at once, you can press the Edit
button at the top right corner of the page. If you want to edit route start and end points, you also need to press the Edit
button.
Press Update
to save your edits. You can press Update and go to route list
, you will be redirected to the Routes list. You can also press Update and go to route plan
, you will be redirected to Route plan page.
If you press Update and export
, orders added to this route will additionally be added to an export queue of the Geo2 API. This is useful if an external application uses the API to pick up routes highlighted by a planner. The Update and export
button becomes enabled when a route has at least 1 order.
Deleting Route
Pressing Delete
will let you delete the route. The route assignment of any orders in the route will be cleared, but orders are otherwise unaffected.
Adding Orders
Pressing Actions → Add orders
button will open a side panel in which you can list orders to add to the route.
You can make use of search templates that you have saved for the Orders list page or use other criteria in Filters
and Sorts
. If you select the same depot as the route start and end points, default filtering by this depot is applied but you can change it. If the route start and end points are different depots or some addresses, filtering by depot will not be selected by default. You can select it on the Add orders dialog.
To include an order in the route, drag its card to the left-hand side list of route orders. To speed up the process, you can use checkboxes, Ctrl+click/Command+click or Shift+click to select multiple orders and add them to the route via the drag-and-drop option. In a route, orders are also referred to as stops.
If a route starts or ends at a depot, orders with depots must match: the delivery depot must align with the start, and the collection depot with the end. Orders without assigned depots can be added to any route, and if a route does not use a depot as its start or end point, any order, with or without a depot, can be added.
Stop Details
Each order brought into the route becomes a stop represented by a card in the left column.
By default, the following properties are shown:
Stop position
Order key (click to be redirected to Order page)
Order weight and volume
Planned stop arrival time (affected by route calibration/optimization)
Required from/to time slots
recipient postal code
Order type - delivery (blue) or collection (orange)
recipient address geo-coding indicator - green (high accuracy), orange (low accuracy), red (failed)
Delete icon - this will remove the order from the route, after you press
Save
Planning instructions (on large screens only)
If you expand the card by pressing the down-arrow v
on the right side of the card, you can additionally see:
Planned time at stop (editable via the pencil icon)
Committed time
Planning and order instructions
Full address
If there is insufficient horizontal space, the text field labels are omitted and only label icons remain:
You will see highlighted required from/to and committed time with red and orange colours if the required/committed time doesn't match the planned time. Red colour - if the difference between required/committed and planned time is more than delivery ETA tolerance (from Environment settings). Orange - if the difference between required/committed and planned time is within delivery ETA tolerance (from Environment settings).
We do not highlight the required/committed time if it's the same as the planned time. Required from/to time slots are always highlighted with a bold font type.
Editing Stop Geolocation
If you want to modify the previously determined address geo-location, you can edit it on Route plan page by pressing the geolocation icon on the stop card.
The Geo Code dialog will be displayed. Checkboxes near the address fields allow you to control which data will be used for geocoding. By default, enabled fields are taken from Environment settings → Geo Code. To check a new geolocation, press the Check Geo Point
button. It is often the case that using all parts of the address will lead to a better location match.
You can also edit latitude and longitude or move the pin on the map to adjust the address.
Once you are happy with the result, press the Save
button. The geolocation icon will be shown in green.
Removing Orders
To remove an order from the route, press the Delete
icon when hovering over the stop card.
To remove several orders at the same time, use Ctrl/Command+click or Shift+click to select multiple stop cards and press the Remove
button above the stop list.
Remember to save changes by pressing the Save
button.
Route Capacity
See more about how a route capacity is calculated:
Above the route map, you will find a summary comparison of the peak weight and volume of the route’s orders versus the weight and volume capacity of the assigned vehicle (“Weight capacity” and “Volume capacity” fields specified in Environment settings → Vehicles) depending on an order type - delivery or collection. If you expand it by pressing the down arrow, v
, you can see how the weight and volume are expected to evolve as the route's stops progress.
Route CO2 Emissions
See how route CO2 emissions are calculated:
The total planned CO2 emissions will be calculated for a current route depending on the route planned distance, multiplied by the emission factor of the vehicle assigned to a route (taken from Environment settings → Vehicles). The units shown depend on Environment settings → Display preferences.
Actual CO2 emissions are calculated from the actual distance, as recorded via device tracking for each completed route, multiplied by the emission factor of the vehicle assigned to the route (taken from Environment settings → Vehicles). To receive reliable data, it is important that location tracking is enabled on devices and that routes are marked as started/completed at the beginning/end of each route. If a route is completed in the mobile app, actual distance is read-only. For routes completed from the Hub user interface or via the API, the actual distance travelled for the route can be edited.
Adding Driver Breaks
It is possible to add driver breaks by pressing the Actions
button and selecting the Add driver break
option.
You will see a prompt to specify the stop duration for this break. You can specify it in minutes or hours. By default, a stop duration time is taken from Environment settings → Routes.
By pressing the Add break
button, a break is added at the end of the stops list. Press Save
to recalibrate the route and update the planned time on the stops. If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for calibration with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
It's possible to drag-and-drop a driver break similar to other stop cards to change its position in the list. You can also edit it by pressing the Edit
button near the time. You can delete the break by pressing the Delete
icon by hovering over the card. Remember to save changes to re-calibrate the route.
Re-ordering Orders
You can drag-and-drop orders in the list to change their stop order. Learn how to do it:
To speed up the process, you can use Ctrl/Command+click or Shift+click to select multiple stop cards and drag-and-drop them to change the stop order.
It is possible to select routes stops on the map by using Shift+Ctrl/Command+click to draw a box on the map. Additionally, you can press on a circle, shape, or rectangle icons at the bottom of the map to draw a figure and select stops. The selected stop cards will be highlighted in grey in the list, so you can drag-and-drop them within the list to change the stop order. You can also press Ctrl/Command and click on the stops to select the required stops.
Once you are happy with the result, press the Save
button. The route will be automatically recalibrated to update the planned time on the stops, route planned duration, distance, and end time. If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for calibration with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
Optimizing Route with Time Windows
To use the Optimize with time windows option, press the Actions
button and choose the Optimize with time windows
option. Route optimization is available when a route has at least 2 orders.
Among these orders, there has to be at least 1 order with the provided required time slots (either “Required from”, or “Required to”, or both of them).
When you press Optimize with time windows
, the geo-locations of the assigned route start/end points and the orders will be used to suggest an optimum driving route as well as to match the required time windows for each order. The time window specified using the Required from
and Required to
fields inside an order is not considered a hard constraint by the system. That is, the system doesn't fail if the stop cannot be visited during the time window; instead, the system tries to find a route that visits the stop during its time window, but if time-window violations are inevitable, the system tries to find a solution that minimizes the time-window violation time for all stops in the problem.
If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for optimization with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
You are not obliged to accept the suggested order but to save changes, remember to press the Save
button.
Before optimization:
After optimization with time windows:
You can also optimize a selection of stops. Use Ctrl+click/Command+click or Shift+click to select multiple stop cards and click on the Optimize selection with time windows
to optimize a part of a route only.
You can only optimize stops that are located next to each other in a stop order. Otherwise, you will see an error message 'Only neighbouring stops can be selected for partial optimization'.
Before partial optimization:
After partial optimization with time windows:
Optimizing Route without Time Windows
To use the Optimize without time windows option, press the Actions
button and choose the Optimize without time windows
option.
When you press Optimize without time windows
, the geo-locations of the assigned route start/end points and the orders will be used to suggest an optimum driving route. The order of the orders may be changed and the planned timings and distance of the route updated. If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for optimization with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
You are not obliged to accept the suggested order but to save changes, remember to press the Save
button.
Optimization with time windows:
Optimization without time windows:
You can also optimize a selection of stops. Use Ctrl+click/Command+click or Shift+click to select multiple stop cards and click on the Optimize selection without time windows
to optimize a part of a route only.
You can only optimize stops that are located next to each other in a stop order. Otherwise, you will see an error message 'Only neighbouring stops can be selected for partial optimization'.
Partial optimization with time windows:
Partial optimization without time windows:
Calibrating Route
To use the Calibrate option, you need to click on the Actions
button and choose the Calibrate
option. When you press Calibrate
, the planned timings and distance of the route will be calculated without modifying the orders list. If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for calibration with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
Automatic calibration is applied in most cases so you do not need to press Calibrate
:
adding orders to a route and closing the Add orders popup
deleting an order from a route and pressing
Save
deleting/updating a route in an order (not in the completed route)
changing time-at-stop on route stops and pressing
Save
changing a route planned start time
changing (shuffling) stop order and pressing
Save
changing vehicle in a route
reversing stops and pressing Save
editing route start/end points
Exceptions when automatic calibration is not applied:
if you manually set up a route inside an order
if you make changes in a depot address or vehicle speed factor
if you change a recipient address in a geocode popup on the stop card
if you change a recipient address inside an orer
You will be notified to re-calibrate the route when automatic calibration is not applied. It is not possible to run calibration or optimization if a route is already completed.
Before calibration:
After auto-calibration (by pressing Save
button):
Reversing Stops in Route
To use the Reverse option, you need to click on the Actions
button and choose the Reverse stops
option. See how to use it:
This means if you choose to, you can reverse the order in which you deliver your orders (to start from the last order and finish on the first one with all stops also reversed accordingly).
Once you are satisfied with the order of stops, press the Save
button. The system will then automatically update the planned time on each order, as well as the planned distance and duration of the route. If you have provided vehicle dimensions in Environment settings → Vehicles (“Gross weight”, “Height”, “Width”, and “Length” fields) for the vehicle assigned to the route, it will be used for optimization with vehicle restrictions. The system will factor these dimensions into route building to generate the most efficient outcomes, for example, to avoid bridges with height restrictions, narrow roads unsuitable for wider vehicles, or areas with weight limits that could affect the selected route.
Bulk Update of Committed Date/Time
The committed ETA for an order lets you indicate that a specific deadline has been agreed with the recipient and that it is important the driver adhere to it. See how to update the committed ETA:
When you press Update committed ETA
and Save
, the planned date/time for each order is copied to its committed ETA. This is useful once you have calibrated the route and you want to indicate to the driver that they must adhere to the planned arrival date/times.
Bulk Move Orders between Routes
Learn how to move orders between routes:
For moving multiple orders from one route to another, you need to select stops in the list by using Ctrl/Command+click or Shift+click, or by choosing route stops on the map by using Shift+Ctrl/Command+click. Once stops are selected, you need to click on the Actions
button and choose the Move to route
option or press the Move to route
button on the map.
On the Move to selected route
dialog, choose the route you want the orders to move to (destination route).
Once the orders are moved, the route the orders came from (source route) is calibrated automatically. We do not apply automatic calibration to the destination route - calibrate it manually once you have finished arranging its stop order.
Route Map
The default route view shows a map for the route on the right-hand side, with the route start/end points and all of the stop locations:
Deliveries are shown with blue location pins, while collections are orange. A filled blue circle indicates multiple orders in the same location. The route between the stops is indicated with straight lines for simplicity. Further details of each stop are shown when you click the location marker.
Road View Toggle
If you enable the Road view
selector on the map, you will see a suggested route on the road network. The Duration takes into account projected traffic conditions.
Hold View Toggle
By default, the map zoom resets when you change the stop order. Press Hold view
to hold the map zoom. This still lets you zoom in and out on the map but it will not be automatically zoomed out when you make some changes in the orders list.
Bulk Move Orders between Routes
To move orders from one route to another, you can select stops on the map one-by-one using Ctrl/Command+click, by drawing an area using Shift+click or figures at the bottom of the map - circle, shape or rectangle. Once stops are selected, they will be highlighted with a red colour.
Next, press the Move to route
button. It is possible to move orders only when the order depot matches the route depot. On the Move to selected route
dialog, choose the route you want the orders to move to (destination route).
Once the orders are moved, the route the orders came from (source route) is calibrated automatically. We do not apply automatic calibration to the destination route - calibrate it manually once you have finished arranging its stop order.
Route Tracking
Once the route is started by a driver in the mobile app, the "Tracking" toggle will be displayed on the route map. Enable it to check the driver's precise location and their actual route. It is required to enable the location tracking both in the device and app settings to get the tracking data. Otherwise, the driver's location will not be displayed.
You can also download the tracking data by pressing the Download
button.
Saving Route Changes
For any edits, press Save
to save them. The route map updates once the route is saved.
Release Route
Once a route is optimized and ready to be started, you need to change the status of the route to Released and save changes. It will be displayed in the mobile app of the assigned driver. A driver needs to click on the Start
button to start the route. All changes will be displayed on the Hub user interface as well.
Proof of Delivery
Once a driver delivers an order and records the proof of delivery (POD), it will be shown on the Route plan page as well:
green icon for successful delivery/collection
orange icon for partially successful delivery/collection
red icon for failed delivery/collection
You can press the POD icon to check its details:
If an order has several recorded POD's, they will be displayed in separate tabs as Pod 1, Pod 2, etc.
You can click on the Download PDF button to save POD as a PDF file. If manual sending of POD is enabled in the POD notification settings, you will see the Email to recipient
button. By pressing it, the POD email will be sent to the recipient's email address.
Learn how to set up POD notification emails in Environment settings:
If you set up public POD notification for successful or failed delivery, emails with related subjects and attached reports will be sent to the recipient email address (if an order has it) and to fixed recipients (only for failed and partially successful emails if email addresses are specified in Environment settings).
By clicking on the Check
button in the email, a recipient will be redirected to the public POD page with all the information recorded. Your environment logo will be displayed at the top of the page.
It's possible to download reports to a device.
You can track the status of the emails sent on Notification history tab inside the Order details.
Public tracking
Learn how to set up public tracking emails in Environment settings:
Depending on Environment Settings, once the status of a route reaches the appropriate value (e.g. in transit), a tracking email/SMS notification will be sent to the recipient's email address/mobile phone number (if an order has them). You can add a public tracking link to it to check the approximate date/time of delivery and the driver's position on the map.
You can track the status of the emails/SMS notifications sent on Notification history tab inside the Order details. By clicking on the Check
button in the email or a tracking link in the SMS, the recipient will be taken to Public tracking page. Your environment logo will be displayed at the top of the page.
Complete Route
To complete a route, a driver needs to click on the Complete
button in the mobile app. The status can be changed in Hub as well.
If a route is completed from the mobile app, you will see the tracked data about the actual distance from the mobile app. If a route is completed from the web or API, it takes the last data from the mobile app however, you can change it on Edit route page.
Marking Route for Export
When you press Export
, the order in the route will be added to the API export queue. This is useful if an external application uses the API to pick up routes/orders highlighted by a planner.