February 2025

DE-DE ES-LATAM FR-CA FR-FR IT-IT PT-BR

Introduction

This document serves as a reference guide for the Routing & Optimization – Route module in MyGeotab. The Route module uses your unique business objectives to create daily routes, helping you to determine which plans have the most favorable economic impact on your business. When creating your daily plan, choose from various optimization profiles to meet your goals, such as minimizing drive distance or increasing on-time arrivals.

! IMPORTANT: A subscription to Advanced Routing is required to use this module.

Getting started

The Route module can be accessed directly from MyGeotab.

To access the Route module:

! IMPORTANT: To successfully use the Route module, all essential configurations must first be completed in Administration. For more information about Administration, refer to the Optimization Administration User Guide.

Viewing plans

The Plans page displays when you launch Route. The Plans page features a table that displays information about Plans and includes the following actions:

1. Click the Dark Theme (half moon) icon to switch the display to Dark Mode.
2. Click the Light Theme (lightbulb) icon to switch the display to Light Mode.
3. Click the Help Center (person) icon to access help articles.
4. Filter the list of Plans by:
5. 1. Selecting one or more Branches using the Branch menu
   2. Setting the Plan date range as required

   3. ✱ NOTE: The default Plan date range is seven days before and seven days after the current date.

   3. Selecting one or more plan Statuses using the Status menu

6. 

5. Search for a particular Plan by entering the Name (full or partial) in the Search field.
6. Click the + New Draft Plan button to create a new Plan. See Creating a new plan – Single Date or Creating new plans – Multiple Dates section for more information.

7. 

7. View the following information about the Plans:
8. 1. Name – Indicates the name of the Plan. Click the column name to sort from ascending to descending order.
   2. Filled capacity – Indicates the percentage of Resource availability that is used.
   3. Branch – Indicates the operational location of the Plan. Click the column name to sort from ascending to descending order.
   4. Plan date – Indicates the date of the Plan. Click the column name to sort from ascending to descending order.
   5. Unassigned Orders – Indicates the number of orders that are not assigned to a Resource but exist in the Plan.
   6. Resources with work – Indicates the number of Resources with orders assigned.
   7. Drive Duration – Indicates the total driving duration.
   8. Idle duration – Indicates the total available time between assigned orders.
   9. Order duration – Indicates the total duration of all assigned orders.
   10. Date created – Indicates the date the Plan was created. Click the column name to sort from ascending to descending order.
   11. Created by – Indicates the user who created the Plan. Click the column name to sort from ascending to descending order.
   12. Status – Indicates the Plan status:
   13. 1. Draft – Plan has been created. This is the automatic status change after Processing.
       2. Failed – Plan creation process failed.
       3. Processing – Plan is currently being created. Status will automatically change to Draft when complete.
       4. Published – Plan has been finalized and passed to the Dispatch module, becoming the Active Plan for the specified date.
       5. Replaced – Plan was previously Published but a different Plan has since been Published, taking its place as the Active Plan.
       6. Dispatch – Plan was previously Published and is now the Active Plan in the Dispatch module for the plan date.

   14. ✱ NOTE: This status does not apply to future dates.

   15. 

   8. Click the Sorting Options (list) icon to choose one or more columns to sort the list of Plans by.
   9. Click the Columns (gear) icon to switch the order of columns and toggle the visibility on or off.
   10. Click the Notes (speech bubble) icon to view or add notes to the Plan.
   11. Click the three-dot menu to choose from the following actions:
   12. 13. Open – Open the Plan in a new tab.
       14. Publish – Publish the Plan to finalize it, making it the Active Plan, and pass to the Dispatch module.

       15. ✱ NOTE: Only use this action if also using the Dispatch module.

       15. Lock and Publish – Lock all current appointment assignments, and Publish the Plan, while allowing automatic optimization of new or unassigned appointments when the Plan is passed to the Dispatch module.
       16. Compare – Compare the selected Plan with another Plan.
       17. Download - Full Detail – Export the Plan to a CSV file in Advanced Routing format.
       18. Download - Fleet Application – Export the Plan to a CSV file in Basic Routing format.

   13. 

   12. Click the box next to the Name of one or more Plans to select, or the box next to Name column to select all Plans in the list, then
   13. 1. Open in new tabs – Opens the selected Plans in a new tab.
       2. Compare – Provides metrics to compare the selected Plans.

   14. 

   15. ✱ NOTE: Only Plans for the same Branch can be compared.

   16. Comparing plans

   17. Once two or more Plans have been selected, review the key metrics for each in a side-by-side view. The metrics of a Plan are compared to those of the Plan positioned to its immediate left. The following markers may appear if the compared values differ:

   18. Marker	Description
       	Indicates the value is greater than the compared value.
       	Indicates the value is less than the compared value.

   20. You can complete the following actions:

   13. Swap the position of a Plan by clicking the Swap icon to move the Plan panel left or right, or drag the Plan panel to the desired position.
   14. Remove a Plan from the comparison by clicking the Remove icon.
   15. Click Replace this plan and search by name to change out the plan.
   16. Click Select another plan, and search by name to add it to the comparison.
   
   

   Creating a new Plan – Single Date

   1. From the Plans page, click the + New Draft Plan button.
   2. In the New Plan panel, enter your plan Name.
   3. Select the Branch for which to run the plan for.
   4. Select the Plan date you want to create the plan for.
   5. Add orders to your draft plan by:
   6. 1. Uploading a CSV file, or Uploading zones from MyGeotab.

      2. ✱ NOTE: Download the CSV template, and leave the Appointment Date cells blank or set to the same date for all orders. Fill in all other required sections.

      3. Additional options may also appear if applicable:

      2. Toggle on:
      3. 1. Use existing external System Appointments to add appointments previously added via API.

   7. ✱ NOTE: This option can be combined with previously imported CSV Appointments or one or both Upload options.

   8. 1. Use previously imported CSV Appointments to add appointments previously added via CSV.

      2. 

      6. From the Optimization Profile, select from the following options:
      7. 3. Reduce drive time – Reduces drive time by sacrificing On-time arrival.
         4. Balanced – A balanced approach between Reduce drive time and On-time arrival.
         5. On-time arrival – Increases On-time arrival at the expense of drive time.

      8. 

      7. Click Next, and the Plan details page is displayed.
      8. (Optional) Use the dropdown to change the Vehicle Type from the Branch default. This setting defines the plan route type navigation (drive using car or truck-safe roadways).
      9. To add comments about the Plan, click Add note.
      10. The Resources available to work in the selected Branch on the selected date display in the Resources available to work section.
      11. 1. Click the Columns (gear) icon to switch the order of and toggle the visibility of columns in this section

          2. 

          2. Click the Edit (pencil) icon to edit a Resource’s attributes. For more information on how to edit a Resource, refer to the Editing a Resource section.
      11. Click the Next button.

      12. The Plan orders page displays with all the uploaded orders.

      12. From the Plan orders page, you can review, edit, and delete the uploaded orders, upload more orders, or add orders manually. For more information about adding or editing an order, refer to step 3 of the Editing a Plan Order section.

      13. Appointment Identifiers:

      14. 1. If appointments in the CSV file were previously uploaded, an Update label will appear to the right of the pencil icon (Edit order).

          2. 

          2. If appointments from step 5 were included, a CSV or API (external System) label will appear to the left of the Appointment ID.

      15. 

      16. ✱ NOTE: Any orders with an Error, Warning, or Important Information displays at the top of the orders list and is identified with a specific color-coded icon. Any errors must be corrected in order to proceed to the next step, while it is recommended Warnings and Information also be reviewed and edited if needed before proceeding.

      13. (Optional) To view order count, revenue total, and total duration by plan date or to filter order list by issue type (if applicable), click on the Expand (down arrow) icon to expand the section.

      14. 

      14. If required, click the + Appointment button to add an appointment manually. At minimum, fill in all required fields, then click Save or Save and create another.
      15. Click the Create plan button.

      The Plans page displays and the Plan you created displays with Processing status. Once the Plan is created, a notification displays and the Status will change to Draft.

      Creating new Plans – Multiple Dates

      1. From the Plans page, click the + New Draft Plan button.
      2. In the New Plan panel, enter your Plan Name.

      3. ✱ NOTE: A Plan for each date in the CSV file will be created, with the Date automatically appended to the Plan Name you enter.

      3. Select the Branch for which to run the plans for.

      4. ✱ NOTE: All plans will be run for the same Branch, but for each date as specified in the CSV file.

      4. Toggle on the Muti Day slider then,
      5. 1. Set the Plan date to the earliest date in the CSV file to be uploaded
         2. Set the End date to the latest date in the CSV file to be uploaded
      5. Add orders to your draft plans by:
      6. 1. Uploading a CSV file, or Uploading Zones from MyGeotab.

         2. ✱ NOTE: The Appointment Date in the CSV file must be populated for each order.

         2. If applicable, toggle on the option to Use existing external System Appointments (added via API) and/or, Use previously imported CSV Appointments The total number of appointments will be displayed and no additional imports are required.

      7. 

      6. Click Next.

      7. The Plan details page is displayed. All dates with imported or external System orders will be displayed at the top.

      7. Click on the relevant date to review and edit the plan and Resource details.

      8. 

      8. For each plan date:
      9. 1. (Optional) Edit the plan Name
         2. (Optional) Use the dropdown to change the Vehicle Type from the Branch default. This setting defines the plan route type navigation (drive using car or truck-safe roadways, and the default navigation type when Navigation (BETA) is used in Mobile..
         3. (Optional) The Optimization Profile can be customized each plan date. You can select the applicable profile for each of the plan dates as required.
         4. 1. Reduce drive time – Reduces drive time by sacrificing On-time arrival.
            2. Balanced – A balanced approach between Reduce drive time and On-time arrival.
            3. On-time arrival – Increases On-time arrival at the expense of drive time.
         4. (Optional) Add a Note to the plan

      10. 

      9. Review the Resources available to work section.
      10. 5. Click the Columns (gear) icon to switch the order of and toggle the visibility of columns in this section
          6. Click the Edit (pencil) icon to edit a Resource’s attributes. For more information on how to edit a Resource, refer to the Editing a Resource section.

      11. 

      10. Click Next.

      11. The Plan orders page is displayed. Click on each date at the top to review and/or edit the orders. Any orders with an Error, Warning, or Important Information will be at the top of the list and identified by a specific color-coded icon.

      12. ✱ NOTE: Some orders may have labels. See Appointment Identifiers for more information.

      11. (Optional) To view order count, revenue total, and total duration by plan date or to filter order list by issue type (if applicable), click the Expand (down arrow) icon to expand the section.

      12. 

      13. ✱ NOTE: Any plan dates with orders that have Errors will be indicated on the date with a red dot at the top. You must review the Plan orders detail for the marked dates and make any necessary corrections in order to proceed to the next step, while it is recommended to also review Warnings and Information before proceeding. See the Editing a Plan Order section for more information.

      12. Click the Create plan button.

      The Plans page is displayed and the plans you created will be displayed with a status of Processing.

      

      Once the plans are created, a notification will appear and the status will change to Draft.

      ✱ NOTE: Depending on the number of plans and orders created, the processing time increases.

      Editing a Resource

      1. Complete steps 1-9 from the Creating a new plan – Single Date section, or 1-8 (for each date) of the Creating new plans – Multiple Dates section.
      2. Once the Resources available to work section displays:
      3. 1. If there is a blue box with a checkmark, then the Resource is already scheduled to work and their schedule can be edited using the pencil icon.
         2. If there is a white box with no checkmark, then the Resource is not currently scheduled to work (not part of this plan), but you can add the Resource by selecting the pencil icon and editing their shift. They will be added to the plan for the specific date you are currently creating the plan for.
      3. Click the Edit resource (pencil) icon to edit the Resource.
      4. From the top toolbar, edit the Resource’s availability, by adding Available time, adding a Break time range, taking Time off, adding a Break time, creating a Meeting time, or Delete availability.

      5. 

      5. You can also update the following:
      6. 1. Efficiency Rate – Edit the pace at which the Resource can complete an order.
         2. Order groups – Edit the order groups the Resource is capable of performing.
         3. Order types – Edit the types of orders the Resource is capable of performing.
         4. Start Location – Edit where the Resource starts the shift by selecting:
         5. 1. Use branch – The preconfigured address of the Branch the plan is being created for
            2. Use profile– The preconfigured address in the Resources’s profile in Rostering
            3. Customize – Manually input a specific address
         5. End location – Edit where the Resource ends the shift by selecting Use branch, Use profile, or Customize.

      7. 

      6. Click Save changes.

      7. ✱ NOTE: Changes made here will be applied only for the plan with the specific date you are currently creating. The scheduled parameters remain unchanged in the Availability Calendar unless the plan is published, then the Availability Calendar is automatically updated accordingly.

      7. Click Next, then proceed with step 13 of the Creating a new plan – Single Date section, or step 10 of the Creating new plans – Multiple Dates section.

      Editing a Plan Order

      1. Complete steps 1-11 from the Creating a new plan – Single Date section, or steps 1-10 of the Creating new plans – Multiple Dates section.
      2. Once the Plan orders page displays, click the Edit (pencil) icon to edit a specific order.

      3. ✱ NOTE: Only appointments added through a CSV file upload can be edited, existing external System appointments and previously imported CSV appointments cannot.

      3. From the Edit details window, you can edit the following:

      4. ✱ NOTE: Attributes marked with an asterisk (*) are required.

      5. 1. Appointment ID* – Indicates the order identification number.
         2. Order type* – Indicates the type of order or appointment.
         3. Time window start* – Indicates the start time of the appointment arrival time.
         4. Time window end* – Indicates the end time of the appointment arrival time.
         5. Duration* – Indicates the Order’s on-site duration.
         6. Revenue* – Indicates the Order’s revenue.
         7. Location*– Indicates the complete address of the Order. Details are auto-populated based on the selection made using the Search field. Click the X in the Search field, then type full address and make the applicable selection to change the details.
         8. Resource – (Optional) Select Preferred or Must be Resource.
         9. Contact details – Indicates the Customer name*, primary and secondary phone numbers, and Email address.
         10. Preferred contact method – Indicates the Customer’s preferred method of contact of Phone, SMS, or Email.
         11. Do not use contact method – Indicates the method of contact the Customer does not want used.
         12. Add note – Click to edit or remove existing notes, or add new.

      6. 

      4. Click Save.

      Additional options on the Plan orders page

      1. Use the Search field to locate an Order using the Order ID or Customer Name.

      2. 

      2. Click the box next to one or more Orders to select, then click Delete to remove the Orders from the Plan orders list, excluding them from the Plan.
      3. For a Single Date plan only:
      4. 1. Click + Appointment to add an order to the Plan manually. For more information about the fields in the Add Appointment popup window, refer to step 3 from the Editing a Plan Order section

      5. 

      1. Click the down arrow at the top right of the page to expand the order metrics and filter options.

      

      Plan Overview

      Reviewing a Plan

      1. From the Plans page, click on the Plan, you want to review or click the more option (...) and choose Open to open the plan in a new tab.
      2. View Plan metrics such as the Filled Capacity, Orders, and Overview Metrics.

      3. 

      3. From the Schedule Board, you can:
      4. 1. View each scheduled Resource, their individual capacity, assigned appointments (orders), and scheduled availability. Click or hover over the Information (i) icon next to each Resource’s name to view more detailed information about that Resource.
         2. Click the Order by (list) icon to change the sort order by Name, Capacity, or Team.
         3. Find a specific appointment (Order) or Resource by using the Search bar.
         4. Toggle between small, medium, or large view options for the Schedule Board display.

         5. 

         5. Click the Unassigned Appointments (orders) button to view the list of appointments in the plan that are not assigned to a Resource.

         6. 

         6. Click the Open Map button then select one or more Resources to view their assigned route with sequence on a map.

      

      Editing a Plan

      A Plan in a Draft status can be manually modified in various ways such as reassigning appointments between Resources, editing the duration of appointments, resequencing assigned appointments, assigning unassigned appointments, and more.

      1. Once a Plan has been created, click the plan from the Plans list, or click the more option (...) and choose Open to open the plan in a new tab.
      2. Click the Edit button. See the following sections for more information:
      3. 1. Editing an Assigned Appointment
         2. Reassigning an Assigned Appointment
         3. Resequencing an Assigned Appointment
         4. Editing an Unassigned Appointment
         5. Assigning an Unassigned Appointment
         6. Adding an Appointment or Resource: Click + Add, then select
         7. 1. Add Appointment to create an appointment (added as Unassigned). See step 3 of Editing a Plan Order.
            2. Add Resource to schedule an additional Resource. See step 3 of Editing a Resource.

         8. ✱ NOTE: Only a plan in Draft Status can be edited.

         3. Once edits are complete, click the Save button.
         4. (Optional) If you are also using the Dispatch module and you want to finalize the Plan, click Publish then choose Publish or Lock and Publish to make the Plan active and automatically pass it to Dispatch on the plan date.

         ! IMPORTANT: You can run any number of Plans for a given date, but publishing a Plan makes it active. You can replace a published Plan by publishing another up until the day before the Plan date. Once the Plan date is ‘today’s date’ however, you can no longer replace the last published Plan.

         Editing an Assigned Appointment

         1. Click the desired assigned Appointment (order).
         2. From the Appointment detail popup, the following displays:
         3. 1. Verify –Add the applicable event and optional comment.
            2. Notes – View existing or add a new note to the specific appointment
            3. Details – View whether a Locked Resource or Preferred Resource is associated with the appointment.
         3. Click the Edit (pencil) icon and choose from the following options:
         4. 1. Edit – Change the duration of the appointment.
            2. Lock – Lock the current assigned Resource to the appointment.
            3. Unlock – Remove the Locked Resource from the appointment.

            4. ✱ NOTE This displays if the order is Locked.

            4. Unassign – Unassign the appointment from the Resource.
            5. Delete appointment – Remove the appointment from the Plan.

         5. 

         4. Click the Save button to save your edits.

         Reassigning an Assigned Appointment

         1. Click and drag the Assigned Appointment from the assigned Resource’s route to the route of the other Resource.

         2. The Schedule Board filters display the two impacted Resources’ routes, and the Appointment being moved displays in the new route, marked in red.

         3. 

         2. Click Confirm assignment to complete the reassignment.

         Resequencing an Assigned Appointment

         1. Click and drag the desired Appointment along the route to the target position.

         2. ✱ NOTE: The target sequence position will change from green to white as you drag the appointment along the route.

         2. Release at the desired sequence position.

         Editing an Unassigned Appointment

         1. Click the Unassigned Appointments (green triangle) icon to expand the list.
         2. Click the desired unassigned Appointment.
         3. From the Unassigned Appointment detail popup the following displays:
         4. 1. Verify –Add the applicable event and optional comment.
            2. Notes – View existing or add a new note to the specific appointment.
            3. Details – View whether a Locked Resource or Preferred Resource is associated with the appointment.
         4. Click the Edit (pencil) icon and choose from the following options:
         5. 1. Edit – Change the duration of the appointment.
            2. Delete appointment – Remove the appointment from the Plan.
         5. Click the Save button to save your edits.

         Assigning an Unassigned Appointment

         1. Click the Unassigned Appointments (green triangle) icon to expand the list.
         2. Click the desired unassigned Appointment and drag to the desired Resource’s route.

         3. 

         3. Click Confirm assignment to complete the assignment.