General Settings

Below are a list of values in General Settings. The settings defined in this page would be the default values used for planning.

Field name Type Description
Location
Country Option Country of your input addresses.
Will affect the geocoding results of your input addresses.
Timezone Option For time adjustment to your location timezone.
Map
Map Option Currently supporting OpenStreetMap.
Geocoding
Add Text String For City of your input addresses to improve the geocoding result.
Refer to How To Improve Accuracy Of Geocoding
Time
Loading Time (mins) Integer For specifying the time your driver needs to load the goods at the depot, which will affect the starting run time of the vehicle.
Overwritten by the Loading Time specified for the Depot.
Refer to How To Set Different Loading Times For Each Depot Respectively
Buffer (%) Integer For traveling time adjustment between the stops to account for the speed of the vehicle.
The higher the number, the longer the time taken for the travel.
Refer to How To Set Buffer For Your Deliveries
Service Time (mins) Integer For specifying the time your driver needs to unload and deliver the goods at the stops.
Overwritten by the Service Time of the stops.
Refer to How To Set Service Time For Your Stops
Limit
Max. Time / Run (mins) Integer For specifying the maximum time limit per run.
Once this time limit is exceeded, the jobs will be assigned to the next vehicle if applicable.
Refer to How To Customize Your Runs
Max. Distance / Run Integer For specifying the maximum distance limit per run.
Once this distance limit is exceeded, the stops will be assigned to the next vehicle if applicable.
Refer to How To Customize Your Runs
Max. Stops / Run Integer For specifying the maximum stops limit per run.
Once this stops limit is reached, the jobs will be assigned to the next vehicle if applicable.
Refer to How To Customize Your Runs
Max. Time / Day Integer For specifying the maximum time limit per day.
Once this time limit is reached, the jobs will be assigned to the next vehicle if applicable.
Refer to How To Set Time, Distance And Stops Limits For Your Vehicles.
Max. Distance / Day Integer For specifying the maximum distance limit per day.
Once this distance limit is exceeded, the stops will be assigned to the next vehicle if applicable.
Refer to How To Set Time, Distance And Stops Limits For Your Vehicles.
Max. Stops / Day Integer For specifying the maximum stops limit per day.
Once this stops limit is reached, the jobs will be assigned to the next vehicle if applicable.
Refer to How To Set Time, Distance And Stops Limits For Your Vehicles.
Max. Runs Integer For specifying the maximum runs per vehicle per day.
Once this run limit is exceeded, the jobs will be assigned to the next vehicle if applicable.
Refer to How To Customize Your Runs
Enable Distribute Workload Checkbox For distributing the stops amongst your vehicles.
Only supports simple homogenous runs with single Vehicle Type, Depot etc.
Distribute Workload Type Option
    Values:

  • Distribute by time – Systems tries to compute total time to complete all the stops; and divides the stops amongst the vehicles.
  • Distribute by stops – Systems divides the stops amongst the vehicles, by setting Max stops = Total number of stops / Total number of vehicles
Split Load Checkbox For splitting stops based on Load ID amongst your vehicles.
Can be used to prevent the same vehicle from visiting stops with the same Load ID multiple times.
Refer to How To Use The Load ID To Split The Stops Amongst Your Vehicles
Export Run Prefix String Will include this prefix text in your run upon exporting of CSV.
Refer to How To Append A Prefix To The Run Number In Your CSV Export
Plan
Depot Selection Option Affects the assigning of depot to stops for planning.
Available options: Default, Nearest, Dynamic.
Default uses your assigned Depot to the stops for planning.
Nearest and Dynamic would allow the systems to automatically assign a Depot to your Stops.
Refer to How To Use The Automatic Depot Selection Feature
Distance Unit Option Units for distance, km or miles.
Priority Values Option

Affects the assignment of stops and vehicles.

    Values:

  • Lower value priority is lower priority
    Highest value to represent first priority
    –  e.g. 5 (first), 4 (second), 3 (last)
  • Lower value priority is higher priority
    Lowest value to represent first priority
    – e.g. 1 (first), 2 (second), 3 (last)

Refer to How To Reverse The Use Of Priority Values For Planning.
Release Pre-assign To Checkbox Determines whether the stops that cannot be finished by the pre-assigned vehicles to be served by other available vehicles.
Refer to How To Allow The Pre-Assign Stops To Be Assigned To Other Vehicles
Checkbox Generate runs that priorite furthest stop back to depot.
Refer to How To Generate Reverse Open Path For Your Runs.
Import
Append To Address Checkbox For including or excluding specific address field columns during CSV import for creation of stops.
Refer to How To Include City, State, Postal Code And Country Information Into Address Field For CSV Import
Export
Include Line Address Checkbox For exporting of line address fields during CSV export for stops.
Will return the line address fields originally imported through CSV.
Refer to How To Use Line Address For CSV Import/Export
Include Distance Between Stops Checkbox For exporting of Distance between stops during CSV export for stops.
Refer to How To Export The Traveling Time And Distance Between Stops In CSV After Planning
Include Traveling Time Between Stops Checkbox For exporting of Traveling Time during CSV export for stops.
Refer to How To Export The Traveling Time And Distance Between Stops In CSV After Planning
Default Post Target URL String For POSTing the planned stops information in JSON format to your URL.
Webhook
Webhook URL String For use with API requests to send a notification to the targeted URL when the planning is complete.
Note that the URL link to retrieve the planned routes will expire in 10 minutes.
Refer to Routing Engine API
Back To Tutorials