Using Different Service Time Settings

This sample describes how to use and integrate the different service time settings of xTour correctly.

Benefits

Prerequisites

Please ensure following prerequisites are fulfilled before you start with the use case:

Concepts

Programming Guide

Service times per stop

The fields serviceTimePerStop of sites and vehicles count once for each stop. So with these fields the user can indicate necessary events like registering at a site or preparing a vehicle for loading/unloading.

Assuming that registering at Site1 takes five minutes, i.e. 300 seconds and preparing Vehicle1 for loading takes one minute, i.e. 60 seconds, these two request objects could look as follows.


                var Site1 = {
                    "$type": "CustomerSite",
                    "id": "Site1",
                    "routeLocation": {
                        "$type" : "OffRoadRouteLocation",
                        "offRoadCoordinate": {
                            "x": 6.097412,
                            "y": 49.609597
                        }
                    },
                    "serviceTimePerStop": 300.0
                };

                var Vehicle1 = {
                    "ids": ["vehicle1"],
                    "serviceTimePerStop": 60.0
                };
            

Service times per task

In addition to the standard task-dependent fields TransportOrder.serviceTimeForPickup, TransportOrder.serviceTimeForDelivery and VisitOrder.serviceTime, the fields Vehicle.serviceTimeFactorForOrders and DepotSite.serviceTimeFactorForOrders can extend or reduce this service time per task. These factors can be used for modelling different vehicle and depot site equipments etc. The vehicle dependent factor can be ignored by a specific site by setting ignoreVehicleDependentServiceTimeFactorForOrders to true. For example this may be useful if a site itself is well equipped and can compensate the missing equipment of a vehicle that would slow down the loading/unloading process.

Assume that Vehicle1 as described above is equipped with a forklift, but Vehicle2 is not. So the loading/unloading process of Vehicle2 would be slower for each task to be carried out, e.g. one and a half times compared to Vehicle1. Assume that Site1 as described above does not provide a forklift on its own but Site2 does. This means, the vehicle dependent factor for each task could be ignored here. In addition, assume that there are more employees at Site2 which leeds to loading/unloading in half of the time compared to Site1. This could look as follows.


                    var Site2 = {
                        "$type": "DepotSite",
                        "id": "Site2",
                        "routeLocation": {
                            "$type" : "OffRoadRouteLocation",
                            "offRoadCoordinate": {
                                "x": 6.097755,
                                "y": 49.614325
                            }
                        },
                        "serviceTimePerStop": 300.0,
                        "serviceTimeFactorForOrders": 0.5,
                        "ignoreVehicleDependentServiceTimeFactorForOrders": true
                    };

                    var Vehicle2 = {
                        "ids": ["vehicle2"],
                        "serviceTimePerStop": 60.0,
                        "serviceTimeFactorForOrders": 1.5
                    };
                

Example

In the following example you will see the consequences of the different service time settings. Assume the following orders have to be executed.


            var "orders" = [
                {
                    "$type": "PickupDeliveryOrder",
                    "id": 1,
                    "serviceTimeForPickup": 90.0,
                    "serviceTimeForDelivery": 120.0,
                    "pickupLocationId": "Site1",
                    "deliveryLocationId": "Site2"
                },
                {
                    "$type": "VisitOrder",
                    "id": 2
                    "locationId": "Site1",
                    "serviceTime": 600.0
                },
                {
                    "$type": "VisitOrder",
                    "id": 3
                    "locationId": "Site2",
                    "serviceTime": 600.0
                }
            ];
        

The following picture shows the service times per tasks and stops of a tour that would result from the above settings with the different vehicles.

Service times per task and stop