User Documentation
Welcome to the Smart Route Planning. This guide walks you through how to use the application to upload data, view appointments, and generate optimized service routes.
The Home Page is your starting point in the Smart Route Planning system.
You can upload a single CSV file containing appointment data. This file should include job-related information such as: appointment_start,appointment_end,street,zip_code,city,number_of_workers,service_time,skills_needed
- Start and end address
- Street, zip code, and city
- Number of workers required
- Skills needed
Once the CSV is uploaded, the system processes and stores the data for use in route optimization.
The Company Config Page allows users to configure company-specific information that influences route planning and optimization. It includes two main tabs: Addresses and Vehicles.
In the Addresses tab, users can configure global settings for the company:
- Set the start address and finish address used by the routing engine.
- Configure the solver time limit to control how long the optimizer runs.
In the Vehicles tab, users can add and configure available vehicles (or workers) used for service delivery.
- Set the number of workers per vehicle.
- Define working time windows (start and end time).
- Assign skills to vehicles, which can be used for skill-based routing.
Below are additional configuration options available for each vehicle:
|
|
|
- Depot Address: Set a custom start location per vehicle.
- Cost Settings: Configure cost per kilometer and per hour.
- Break Time: Define earliest and latest break times and break duration.
The Calendar Page provides a monthly overview of all appointments and allows you to manage and plan routes efficiently.
- View all appointments for the selected month.
- Navigate between months to explore past or upcoming schedules.
- See which days already have optimized routes.
- Click on a day to open the Map View Page or Daily Plan View Page.
- Click on the week number (left side) to open the Week View.
- Toggle Multiple Selection (top right) to enable selecting multiple days for batch optimization.
By clicking on the number of appointments on a specific day, a modal appears showing detailed job information for that date.
Features of the modal include:
- A searchable list of appointments
- Ability to search by address or keyword
- Display of relevant job metadata
The Week View and Multi Days View pages allow users to manage optimization across multiple days at once. These views provide a high-level overview of the optimization status for a range of dates and enable batch operations.
-
View appointment and route status across multiple days.
-
Click Verify Appointments to validate all addresses.
-
Click Start Optimization to begin optimization for the selected days.
-
Address verification and optimization status are shown for each day:
- 🟡"Pending" if no verification or optimization has been initiated.
- ❌"Failed" if the address validation or optimization failed.
- ✅"Success" if the process completed without errors.
-
If address verification fails for a specific day, users can:
- Click on that day to open the Map View Page.
- Uncheck or adjust the problematic addresses before retrying.
-
After successful optimization, the Vehicle Routes Matrix will be displayed for that day, showing route distribution across available vehicles.
The Map View Page is the core interface for planning and visualizing optimized routes for a specific day. It provides a visual and interactive way to manage appointments, fleet availability, and route results.
- Displays a list of all appointments scheduled for the selected day.
- Users can check or uncheck appointments to include or exclude them from the optimization process.
- Useful for fine-tuning which jobs should be considered in the route plan.
- Shows the list of available vehicles (or workers) for the selected day.
- Users can enable or disable vehicles by checking or unchecking them in the list.
- Only the selected vehicles will be used during optimization.
- After clicking the Start Optimization button (at the top), the system calculates optimized routes.
- Routes are visualized on the map using distinct colors—each color represents a route for a different vehicle.
- The sidebar shows a list of routes, and users can toggle visibility for each route to show or hide it on the map.
- Users can download route data for individual vehicles or download all routes at once.
- A validation report is also available, providing information about any issues or skipped appointments during optimization.
The Daily Plan Page provides a detailed breakdown of the route plans for a specific day. It gives users a structured view of appointments and performance metrics for each vehicle.
- View all routes planned for the selected day, grouped by vehicle.
- See key metrics for each route:
- Total appointments
- Addresses
- Travel distance
- Service time
- Waiting time
- Slack time
- Easily compare workload and timing across vehicles.
- Click the Download button to export the full daily plan.
A Validation Report button is available on the page to review any issues detected during optimization.
- Lists all appointments with errors or warnings.
- Shows details such as:
- Missing address data
- Infeasible time windows
- Unassigned appointments
