Final Travel Allowance Support in Find Matching Resources

This enhancement introduces support for final travel allowance configuration in the FindMatchingResources (FMR) API operation, which is used to identify the most appropriate resource for a given activity. A new request parameter, finalTravelSupport, allows integrators to specify whether the API should take into account the resource’s travel allowance to their final (end) location when evaluating assignment feasibility.

When finalTravelSupport is set to true, the API operations factors in the final travel settings defined for the mobile worker’s resource type. These settings determine whether travel time to the final location is excluded, fully included, or partially allowed after shift end. By applying this logic, the API operations ensures that resources recommended for an activity are aligned with both the work requirements and their end of day travel constraints.

For example, if a mobile worker's shift ends at 6:00 PM and their configuration allows 30 minutes of travel after the work time end, assigning them a job that ends at 5:50 PM and requires 45 minutes of travel to the final location would exceed their allowed limits. With finalTravelSupport enabled, the API evaluates this constraint and instead suggests another resource whose shift and final travel configuration can fully accommodate the job and minimize the chances of entering overtime.

Find Matching Resources API Operation Changes

Request Changes: Final Travel Support

The new field finalTravelSupport is added to the criteria object of the findMatchingResources API call:

"criteria": {
    "properties": {
        "finalTravelSupport": {
            "type": "boolean",
            "title": "Support Final Travel",
            "description": "If the finalTravelSupport = True or is not specified, then the function uses the value of the estimated final travel according to the resource type configuration (as 0, full value or partial value).\n Note that the system only estimates the final travel if the resource's end location is known, otherwise usage of this new parameter doesn't change the result, because the estimated final travel is 0 in that case."
        },
...
    }
}

Example of Final Travel Support usage

{
    "criteria": {
        "finalTravelSupport": true,
        "resourcePreference": 0.0,
        "workSkill": 100,
        "workTime": 10,
        "workZone": 100,
        "includeResources": "technicians"
    },
 
...
 
}

Business Benefit

• Improve resource selection accuracy by considering end-of-day travel constraints during availability evaluation.
• Reduce scheduling errors and rework by prioritizing resources who can feasibly complete the activity within shift and travel limits, avoiding unnecessary overtime.

Steps to Enable

Modify the findMatchingResources API request by setting the finalTravelSupport parameter to true.