Jobs' Parameters

Job Type
​

Job type can be one of the following predefined text values: "service", "pickup", "delivery" or "pickup-delivery".
The last 3 types are used with the capacity parameter for both users (vehicle capacity) and jobs (required capacity).
​
A "service" job is simply a location to be visited. 'Capacity' parameters are ignored.

A "pickup" job is a location at which a vehicle picks up cargo which decreases the available capacity of the vehicle. Thus, the number of "pickup" jobs a vehicle can fulfill in one route is limited by the vehicle's capacity.
​

A "delivery" job is a location at which a vehicle drops off cargo presumed to have been loaded before the route starts.
​

A "pickup-delivery" job results in two separate activities that are always planned in one route: one to pick up cargo at the record's location, and one to deliver it (after the pickup) to the Delivery address, which is mapped below in the 'Pickup-delivery' jobs section.

You may map any text or picklist fields on this parameter.
​

Duration:
​

Duration, in minutes, of execution of the activity (service, pickup or delivery).
​
​Note: as long as no mapping is defined or the mapped field is empty, and the default value is empty, Mapsly will use the default meeting duration from the user’s Traveling preferences. If you set the default value here, it will override user’s default duration for this object.
​

Priority:
​

Use this parameter to differentiate jobs' priority: “1” is the highest and “10” is the lowest. When it is not possible for participating users to fulfill all jobs, jobs with lower priorities may be omitted from resulting routes and will be shown as ‘unassigned’.
​

The default priority is 4, and in most cases, you’ll want to use priorities 4 or higher, as priority 2 is reserved for existing meetings (when building routes “around” exiting meetings) and priority 3 for lunch breaks. For example, if you use priority 1 for a job, it may push out existing fixed-time meetings or a lunch break from out of a route.

Preparation time:
​

Time, in minutes, is required after the arrival at the location before the activity execution can start. This can be used to model a search for parking.
​

For several activities in a row in the same location preparation time is planned only once.
​

Departure delay:
​

Time, in minutes, is required to finalize the activity before the departure or execution of the next activity at the same location.
​

Unlike ‘Preparation time’, ‘Departure delay’ is planned for every activity even if they are executed in a row at the same location.
​

This parameter may become useful when ‘Duration’ is mapped on the duration of a calendar meeting, and you’d like to plan time required to depart from the location.
​

Note: as long as no mapping is defined, or the mapped field is empty, and the default value is empty, Mapsly will use the default departure delay from the user’s Traveling preferences. If you set the default value here, it will override user’s default departure delay for this object.
​

Required skills:
​

One or multiple skills that the job requires. A skill is any text value: user will be assigned to a job only if the user has all the skills required by the job.
​

To list multiple skills, separate them by a comma, or use a multi-choice picklist field, or a JSON array of text values like [“skill 1”, “skill 2”].
​

You may map any text, as well as single- or multi-choice picklist field on this parameter.​
​

Required capacity:
​

One or multiple integer values that indicate the capacity required by the job. The number and meaning of capacity values here must match capacity dimensions in the vehicle types used in a routing session.
​

The capacity parameter is only used with “pickup”, “delivery” and “pickup-delivery” jobs and is ignored for “service” jobs.
​

To indicate multiple capacity dimensions, list integer values separated by commas. For example, if there are two dimensions, such as volume and weight and a job requires (takes up) 50 weight units and 20 height units, they need to be indicated as “50, 20".
​

Alternatively, you may use a multi-picklist field with picklist items with integer values or a text field containing a JSON array like [50, 20].
​

Allowed users:
​

Use this parameter to indicate user(s) who are allowed to fulfil the job.
​

The field must contain a user ID in your data source, or multiple such IDs separated by commas, or a JSON array of strings with such IDs.
​

Disallowed users:
​

Use this parameter to indicate user(s) who are NOT allowed to fulfill the job.
​

The field must contain a user ID in your data source, or multiple such IDs separated by commas, or a JSON array of strings with such IDs.
​

Max time in vehicle:
​

Applies only to “delivery” and “pickup-delivery” jobs. Indicates the maximum time, in minutes, the cargo can spend in a vehicle before it’s delivered.
​

Availability:
​

Use parameters in this section to indicate when a job can be fulfilled. There are 3 ways to indicate availability:
​

#1. If there’s one availability window for the job (no matter if it covers a few hours within one day or spans weeks): map a DateTime or text field containing the date/time when the job becomes available on the ‘Available from’ parameter and a DateTime/text field with the date/time value when the job stops being available on ‘Available to’.
​

#2. If the job is available within certain hours every business day, map a text field containing the opening time (in the 12-hour or 24-hour format) on ‘Available from’ and a text field containing the closing time on ‘Available to’. For example: “9:00 am” and “6 pm”.
​

#3. If there are multiple availability time windows each expressed in a pair of DateTime values, map a text field on either of the availability parameters that contains a JSON array with these pairs:
​
​[{“from”:”…”, “to”:”…”}, {“from”:”…”, “to”:”…”}]
​
The following formats are supported:
​
​2025-04-10 06:00:00
​2025-12-25T06:00:00Z
​2025-12-25T06:00:00
​

If you’d like to set a default availability window, you may only use 12- or 24-hour time values, as described in #2.
​

Pickup-delivery jobs:
​

Parameters in this section are only used in “pickup-delivery” jobs and govern the execution of the delivery part of the job, while similar parameters above govern the pickup.
​
​Delivery location:
​

You may map only the Address, or only the coordinates, or both at once.

If you mapped both the Address and the coordinate fields and their values are not empty at the time when the routing is built, the coordinates will take priority.
​

If the picked-up cargo is by default delivered to a central location, you may enter this location into the ‘Default value’ fields.
​

Availability:
​

Works the same as for the jobs' availability described above.