{ "name": "SolveVehicleRoutingProblem", "displayName": "SolveVehicleRoutingProblem", "description": "Solves a vehicle routing problem (VRP) to find the best routes for a fleet of vehicles., A dispatcher managing a fleet of vehicles is often\nrequired to make decisions about vehicle routing. One such decision\ninvolves how to best assign a group of customers to a fleet of\nvehicles and to sequence and schedule their visits. The objectives\nin solving such VRPs are to provide a\nhigh level of customer service by honoring any time windows while\nkeeping the overall operating and investment costs for each route\nas low as possible. The constraints are to complete the routes with\navailable resources and within the time limits imposed by driver\nwork shifts, driving speeds, and customer commitments., This service can be used to determine solutions for such\ncomplex fleet management tasks., Consider an example of delivering goods to grocery stores\nfrom a central warehouse location. A fleet of three trucks is\navailable at the warehouse. The warehouse operates only within a\ncertain time window\u2014from 8:00 a.m. to 5:00 p.m.\u2014during which all\ntrucks must return to the warehouse. Each truck has a capacity\nof 15,000 pounds, which limits the amount of goods it can carry.\nEach store has a demand for a specific amount of goods (in pounds)\nthat needs to be delivered, and each store has time windows that\nconfine when deliveries should be made. Furthermore, the driver can\nwork only eight hours per day, requires a break for lunch, and is\npaid for the time spent driving and servicing the stores. The\ngoal is to create an itinerary for each driver (or route),\nsuch that the deliveries can be made while honoring all the service\nrequirements and minimizing the total time spent on a particular\nroute by the driver. The image below shows three routes obtained\nby solving the above vehicle routing problem.", "category": "", "helpUrl": "https://sampleserver7.arcgisonline.com/server/rest/directories/arcgisoutput/NetworkAnalysis/SanDiego_GPServer/NetworkAnalysis_SanDiego/SolveVehicleRoutingProblem.htm", "executionType": "esriExecutionTypeAsynchronous", "parameters": [ { "name": "orders", "dataType": "GPFeatureRecordSetLayer", "displayName": "Orders", "description": "Specifies one or more locations that the routes of the VRP analysis will visit. An order can represent a delivery (for example, furniture delivery), a pickup (such as an airport shuttle bus picking up a passenger), or some type of service or inspection (a tree trimming job or building inspection, for instance).\n When specifying the orders, you can set properties for each\u2014such as its name or service time\u2014using the following attributes:\n ObjectIDThe system-managed ID field.\n NameThe name of the order. The name must be unique. If the\nname is left null, a name is automatically generated at solve\ntime.DescriptionThe descriptive information about the order. This can contain any textual information for the order and has no restrictions for uniqueness. You may want to store a client's ID number in the Name field and the client's actual name or address in the Description field.\n ServiceTimeThis property specifies the amount of time that will be spent at the\nnetwork location when the route visits it; that is, it stores the\nimpedance value for the network location. A zero or null value\nindicates that the network location requires no service time. The unit for this field value is specified by the time_units parameter.\n TimeWindowStart1The beginning time of the first time window for the\nnetwork location. This field can contain a null value; a null value\nindicates no beginning time. A time window only states when a vehicle can arrive\nat an order; it doesn't state when the service time must be\ncompleted. To account for service time and departure before the time\nwindow ends, subtract ServiceTime from the TimeWindowEnd1 field. The time window fields (TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, and TimeWindowEnd2) can contain a time-only value or a\ndate and time value. If a time field such as TimeWindowStart1 has a\ntime-only value (for example, 8:00 AM), the date is assumed to be\nthe default date set for the analysis. Using date and\ntime values (for example, 7/11/2010 8:00 AM) allows you to set time\nwindows that span multiple days. The time window fields can contain a time-only value or a\ndate and time value. If a time field such as TimeWindowStart1 has a\ntime-only value (for example, 8:00 AM), the date is assumed to be\nthe date specified by the Default Date parameter. Using date and\ntime values (for example, 7/11/2010 8:00 AM) allows you to set time\nwindows that span multiple days. When solving a problem that spans multiple time zones, each order's time-window values refer to the time zone in which the order is located.\n TimeWindowEnd1 The ending time of the first window for the network\nlocation. This field can contain a null value; a null value\nindicates no ending time.\n TimeWindowStart2 The beginning time of the second time window for the\nnetwork location. This field can contain a null value; a null value\nindicates that there is no second time window. If the first time window is null as specified by\nthe TimeWindowStart1 and TimeWindowEnd1 fields, the second time\nwindow must also be null. If both time windows are non null, they can't\noverlap. Also, the second time window must occur after the\nfirst.\n TimeWindowEnd2 The ending time of the second time window for the\nnetwork location. This field can contain a null\nvalue. When TimeWindowStart2 and TimeWindowEnd2 are both\nnull, there is no second time window. When TimeWindowStart2 is not null but TimeWindowEnd2 is null, there is a second time window that has a starting time but\nno ending time. This is valid.\n MaxViolationTime1 A time window is considered violated if the arrival\ntime occurs after the time window has ended. This field specifies\nthe maximum allowable violation time for the first time window of\nthe order. It can contain a zero value but can't contain negative\nvalues. A zero value indicates that a time window violation at the\nfirst time window of the order is unacceptable; that is, the first\ntime window is hard. Conversely, a null value indicates that\nthere is no limit on the allowable violation time. A nonzero value\nspecifies the maximum amount of lateness; for example, a route can\narrive at an order up to 30 minutes beyond the end of its first\ntime window. The unit for this field value is specified by the Time\nField Units parameter Time window violations can be tracked and weighted by the\nsolver. Consequently, you can direct the VRP solver to do one of the following: Minimize the overall violation time regardless of the\nincrease in travel cost for the fleet. Find a solution that balances overall violation time and\ntravel cost. Ignore the overall violation time and minimize\nthe travel cost for the fleet. By assigning an importance level for the Time Window\nViolation Importance parameter, you are essentially choosing one of\nthese options. In any case, however, the solver will\nreturn an error if the value set for MaxViolationTime1 is\nsurpassed.\n MaxViolationTime2 The maximum allowable violation time for the second\ntime window of the order. This field is analogous to the\nMaxViolationTime1 field.\n InboundArriveTimeDefines when the item to be delivered to the order will be ready at the starting depot.The order can be assigned to a route only if the inbound arrive time precedes the route's latest start time value; this way, the route cannot leave the depot before the item is ready to be loaded onto it.This field can help model scenarios involving inbound-wave transshipments. For example, a job at an order requires special materials that are not currently available at the depot. The materials are being shipped from another location and will arrive at the depot at 11:00 a.m. To ensure a route that leaves before the shipment arrives isn't assigned to the order, the order's inbound arrive time is set to 11:00 a.m. The special materials arrive at 11:00 a.m., they are loaded onto the vehicle, and the vehicle departs from the depot to visit its assigned orders.Notes:The route's start time, which includes service times, must occur after the inbound arrive time. If a route begins before an order's inbound arrive time, the order cannot be assigned to the route. The assignment is invalid even if the route has a start-depot service time that lasts until after the inbound arrive time.This time field can contain a time-only value or a date and\ntime value. If a\ntime-only value is set (for example, 11:00 AM), the date is assumed to be\nthe default date set for the analysis. The default date is ignored, however, when any time field in the Depots, Routes, Orders, or Breaks includes a date with the time. In that case, specify all such fields with a date and time (for example, 7/11/2015 11:00 AM).The VRP solver honors InboundArriveTime regardless of the DeliveryQuantities value.If an outbound depart time is also specified, its time value must occur after the inbound arrive time.\n OutboundDepartTimeDefines when the item to be picked up at the order must arrive at the ending depot.The order can be assigned to a route only if the route can visit the order and reach its end depot before the specified outbound depart time.This field can help model scenarios involving outbound-wave transshipments. For instance, a shipping company sends out delivery trucks to pick up packages from orders and bring them into a depot where they are forwarded on to other facilities, en route to their final destination. At 3:00 p.m. every day, a semitrailer stops at the depot to pick up the high-priority packages and take them directly to a central processing station. To avoid delaying the high-priority packages until the next day's 3:00 p.m. trip, the shipping company tries to have delivery trucks pick up the high-priority packages from orders and bring them to the depot before the 3:00 p.m. deadline. This is done by setting the outbound depart time to 3:00 p.m. Notes:The route's end time, including service times, must occur before the outbound depart time. If a route reaches a depot but doesn't complete its end-depot service time prior to the order's outbound depart time, the order cannot be assigned to the route. This time field can contain a time-only value or a date and\ntime value. If a\ntime-only value is set (for example, 11:00 AM), the date is assumed to be\nthe default date set for the analysis. The default date is ignored, however, when any time field in Depots, Routes, Orders, or Breaks includes a date with the time. In that case, specify all such fields with a date and time (for example, 7/11/2015 11:00 AM).The VRP solver honors OutboundDepartTime regardless of the PickupQuantities value.If an inbound arrive time is also specified, its time value must occur before the outbound depart time.\n DeliveryQuantities The size of the delivery. You can specify size in\nany dimension, such as weight, volume, or quantity. You\ncan also specify multiple dimensions, for example, weight and\nvolume. Enter delivery quantities without indicating units.\nFor example, if a 300-pound object needs to be delivered to an\norder, enter 300. You will need to remember that the value is in\npounds. If you are tracking multiple dimensions, separate\nthe numeric values with a space. For example, if you are recording\nthe weight and volume of a delivery that weighs 2,000 pounds and\nhas a volume of 100 cubic feet, enter 2000 100. Again, you need to\nremember the units\u2014in this case, pounds and cubic feet. You also\nneed to remember the sequence in which the values and their corresponding\nunits are entered. Make sure that Capacities for Routes and\nDeliveryQuantities and PickupQuantities for Orders are specified in\nthe same manner; that is, the values must be in the same units.\nIf you are using multiple dimensions, the dimensions must be\nlisted in the same sequence for all parameters. For example, if you specify\nweight in pounds, followed by volume in cubic feet for\nDeliveryQuantities, the capacity of your routes and the pickup\nquantities of your orders must be specified the same way: weight in\npounds, then volume in cubic feet. If you combine units or change the\nsequence, you will get unwanted results with no\nwarning messages. An empty string or null value is equivalent to all\ndimensions being zero. If the string has an insufficient number of\nvalues in relation to the capacity count or dimensions being\ntracked, the remaining values are treated as zeros. Delivery\nquantities can't be negative.\n PickupQuantities The size of the pickup. You can specify size in any\ndimension, such as weight, volume, or quantity. You can\nalso specify multiple dimensions, for example, weight and volume.\nYou cannot, however, use negative values. This field is analogous\nto the DeliveryQuantities field of Orders. In the case of an exchange visit, an order can have\nboth delivery and pickup quantities.\n RevenueThe income generated if the order is included in a\nsolution. This field can contain a null value\u2014a null value\nindicates zero revenue\u2014but it can't have a negative\nvalue. Revenue is included in optimizing the objective\nfunction value but is not part of the solution's operating cost;\nthat is, the TotalCost field in the routes never includes\nrevenue in its output. However, revenue weights the relative\nimportance of servicing orders. Revenue is included in optimizing the objective\nfunction value but is not part of the solution's operating cost;\nthat is, the TotalCost field in the route class never includes\nrevenue in its output. However, revenue weights the relative\nimportance of servicing orders.\n SpecialtyNames A space-separated string containing the names of the\nspecialties required by the order. A null value indicates that the\norder doesn't require specialties. The spelling of any specialties listed in the Orders\nand Routes classes must match exactly so that the VRP solver can\nlink them together. To illustrate what specialties are and how they\nwork, assume a lawn care and tree trimming company has a portion of\nits orders that requires a bucket truck to trim tall trees. The\ncompany enters BucketTruck in the SpecialtyNames field for\nthese orders to indicate their special need. SpecialtyNames is left null for the other orders. Similarly, the company also enters BucketTruck in the SpecialtyNames field of routes that\nare driven by trucks with hydraulic booms. It leaves the field\nnull for the other routes. At solve time, the VRP solver assigns\norders without special needs to any route, but it only assigns\norders that need bucket trucks to routes that have\nthem.\n AssignmentRule Specifies the rule for assigning the order to a route. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Exclude)\u2014The order will be excluded from the\nsubsequent solve operation.1 (Preserve route and relative sequence)\u2014The solver must\nalways assign the order to the preassigned route at the\npreassigned relative sequence during the solve operation. If this\nassignment rule can't be followed, it results in an order\nviolation. With this setting, only the relative sequence is\nmaintained, not the absolute sequence. To illustrate what this\nmeans, imagine there are two orders: A and B. They have sequence\nvalues of 2 and 3, respectively. If you set their AssignmentRule\nfield values to Preserve route and relative sequence, the sequence values for A and B may change after solving because other\norders, breaks, and depot visits can be sequenced before,\nbetween, or after A and B. However, B cannot be sequenced before\nA. 2 (Preserve route)\u2014The solver must always assign the\norder to the preassigned route during the solve operation. A valid\nsequence must also be set even though the sequence may or may not\nbe preserved. If the order can't be assigned to the specified\nroute, it results in an order violation. 3 (Override)\u2014The solver tries to preserve the route\nand sequence preassignment for the order during the solve\noperation. However, a new route or sequence for the order may\nbe assigned if it helps minimize the overall value of the objective\nfunction. This is the default value.4 (Anchor first)\u2014The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order and makes it the first order on that route to minimize the overall value of the objective function.5 (Anchor last)\u2014The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order and makes it the last order on that route to minimize the overall value of the objective function. This field can't contain a null\nvalue.\n CurbApproach Specifies the direction a vehicle may arrive at and depart\nfrom the order. The field value is specified as one of the\nfollowing integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle)\u2014The vehicle can approach and depart the order in either direction, so a U-turn is allowed at the incident. This setting can be chosen if it is possible and practical for a vehicle to turn around at the order. This decision may depend on the width of the road and the amount of traffic or whether the order has a parking lot where vehicles can enter and turn around. 1 (Right side of vehicle)\u2014When the vehicle approaches and departs the order, the order must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)\u2014When the vehicle approaches and departs\nthe order, the curb must be on the left side of the vehicle. A\nU-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left-hand side. 3 (No U-Turn)\u2014When\nthe vehicle approaches the order, the curb can be on either side\nof the vehicle; however, the vehicle must depart without turning\naround. The CurbApproach attribute is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an order on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an order from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an order and not have a lane of traffic between the vehicle and the order, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.\n RouteName The name of the route to which the order is\nassigned. This field is used to preassign\nan order to a specific route. It can contain a null value,\nindicating that the order is not preassigned to any route, and the\nsolver identifies the best possible route assignment for the order.\nIf this is set to null, the Sequence field must also be set to\nnull. After a solve operation, if the order is routed, the\nRouteName field contains the name of the route to which the order is\nassigned.\n SequenceThis indicates the sequence of the order on its\nassigned route. This field is used to specify the\nrelative sequence of an order on the route. This field can contain\na null value specifying that the order can be placed anywhere along\nthe route. A null value can only occur together with a null\nRouteName value. The input sequence values are positive and unique\nfor each route (shared across renewal depot visits, orders, and\nbreaks) but do not need to start from 1 or be\ncontiguous. After a solve operation, the Sequence field contains\nthe sequence value of the order on its assigned route. Output\nsequence values for a route are shared across depot visits, orders,\nand breaks; start from 1 (at the starting depot); and are\nconsecutive. The smallest possible output sequence value for a\nrouted order is 2, since a route always begins at a\ndepot.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "TimeWindowStart1", "type": "esriFieldTypeDate", "alias": "TimeWindowStart1", "length": 8 }, { "name": "TimeWindowEnd1", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd1", "length": 8 }, { "name": "TimeWindowStart2", "type": "esriFieldTypeDate", "alias": "TimeWindowStart2", "length": 8 }, { "name": "TimeWindowEnd2", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd2", "length": 8 }, { "name": "MaxViolationTime1", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime1" }, { "name": "MaxViolationTime2", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime2" }, { "name": "InboundArriveTime", "type": "esriFieldTypeDate", "alias": "InboundArriveTime", "length": 8 }, { "name": "OutboundDepartTime", "type": "esriFieldTypeDate", "alias": "OutboundDepartTime", "length": 8 }, { "name": "DeliveryQuantities", "type": "esriFieldTypeString", "alias": "DeliveryQuantities", "length": 128 }, { "name": "PickupQuantities", "type": "esriFieldTypeString", "alias": "PickupQuantities", "length": 128 }, { "name": "Revenue", "type": "esriFieldTypeDouble", "alias": "Revenue" }, { "name": "SpecialtyNames", "type": "esriFieldTypeString", "alias": "SpecialtyNames", "length": 500 }, { "name": "AssignmentRule", "type": "esriFieldTypeInteger", "alias": "AssignmentRule" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" }, { "name": "CurbApproach", "type": "esriFieldTypeInteger", "alias": "CurbApproach" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "depots", "dataType": "GPFeatureRecordSetLayer", "displayName": "Depots", "description": "Specifies one or more depots for the given vehicle routing problem. A depot\nis a location that a vehicle departs from at the beginning of its\nworkday and returns to at the end of the workday. Vehicles are\nloaded (for deliveries) or unloaded (for pickups) at depots. In some cases, a depot can also act as a\nrenewal location whereby the vehicle can unload or reload and\ncontinue performing deliveries and pickups. A depot has open and\nclose times, as specified by a hard time window. Vehicles can't\narrive at a depot outside of this time window.When specifying the depots, you can set properties for each\u2014such as its name or service time\u2014using the following attributes:\n ObjectID The system-managed ID field.\n Name The name of the depot. The StartDepotName and EndDepotName fields on routes reference the names you specify\nhere. It is also referenced by the route renewals, when\nused. Depot names are not case sensitive but must be nonempty\nand unique.DescriptionThe descriptive information about the depot location. This can contain any textual information and has no restrictions for uniqueness. For example, if you want to note which region a depot is in or the depot's address and telephone number, you can enter the information here rather than in the Name field. \n TimeWindowStart1 The beginning time of the first time window for the\nnetwork location. This field can contain a null value; a null value\nindicates no beginning time. The time window fields (TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, and TimeWindowEnd2) can contain a time-only value or a\ndate and time value. If a time field such as TimeWindowStart1 has a\ntime-only value (for example, 8:00 AM), the date is assumed to be\nthe default date set for the analysis. Using date and\ntime values (for example, 7/11/2010 8:00 AM) allows you to set time\nwindows that span multiple days. When solving a problem that spans multiple time zones, each depot's time-window values refer to the time zone in which the depot is located.\n TimeWindowEnd1 The ending time of the first window for the network\nlocation. This field can contain a null value; a null value\nindicates no ending time.\n TimeWindowStart2 The beginning time of the second time window for the\nnetwork location. This field can contain a null value; a null value\nindicates that there is no second time window. If the first time window is null, as specified by the\nTimeWindowStart1 and TimeWindowEnd1 fields, the second time window\nmust also be null. If both time windows are not null, they can't overlap.\nAlso, the second time window must occur after the first.\n TimeWindowEnd2 The ending time of the second time window for the network\nlocation. This field can contain a null value. When TimeWindowStart2 and TimeWindowEnd2 are both null,\nthere is no second time window. When TimeWindowStart2 is not null but TimeWindowEnd2 is\nnull, there is a second time window that has a starting time but no\nending time. This is valid.\n CurbApproach 0 (Either side of vehicle)\u2014The vehicle can approach and depart the depot in either direction, so a U-turn is allowed at the incident. This setting can be chosen if it is possible and practical for a vehicle to turn around at the depot. This decision may depend on the width of the road and the amount of traffic or whether the depot has a parking lot where vehicles can enter and turn around. 1 (Right side of vehicle)\u2014When the vehicle approaches and departs the depot, the depot must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)\u2014When the vehicle approaches and departs\nthe depot, the curb must be on the left side of the vehicle. A\nU-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left-hand side. 3 (No U-Turn)\u2014When\nthe vehicle approaches the depot, the curb can be on either side\nof the vehicle; however, the vehicle must depart without turning\naround. The CurbApproach attribute is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a depot on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a depot from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at a depot and not have a lane of traffic between the vehicle and the depot, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "TimeWindowStart1", "type": "esriFieldTypeDate", "alias": "TimeWindowStart1", "length": 8 }, { "name": "TimeWindowEnd1", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd1", "length": 8 }, { "name": "TimeWindowStart2", "type": "esriFieldTypeDate", "alias": "TimeWindowStart2", "length": 8 }, { "name": "TimeWindowEnd2", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd2", "length": 8 }, { "name": "CurbApproach", "type": "esriFieldTypeInteger", "alias": "CurbApproach" }, { "name": "Bearing", "type": "esriFieldTypeDouble", "alias": "Bearing" }, { "name": "BearingTol", "type": "esriFieldTypeDouble", "alias": "BearingTol" }, { "name": "NavLatency", "type": "esriFieldTypeDouble", "alias": "NavLatency" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "routes", "dataType": "GPRecordSet", "displayName": "Routes", "description": "Specifies one or more routes that describe vehicle and driver characteristics. A route can have start and end depot service times, a fixed or flexible starting time, time-based operating costs, distance-based operating costs, multiple capacities, various constraints on a driver's workday, and so on. The routes can be specified with the following attributes:\n Name The name of the route. The name must be\nunique. The tool generates a unique name at solve time if\nthe field value is null; therefore, entering a value is optional in\nmost cases. However, you must enter a name if your analysis\nincludes breaks, route renewals, route zones, or orders that are\npreassigned to a route because the route name is used as a foreign\nkey in these cases. Route names not are case\nsensitive.\n StartDepotName The name of the starting depot for the route. This field\nis a foreign key to the Name field in Depots. If the StartDepotName value is null, the route will begin\nfrom the first order assigned. Omitting the start depot is useful\nwhen the vehicle's starting location is unknown or irrelevant to\nyour problem. However, when StartDepotName is null, EndDepotName cannot also be null.Virtual start depots are not allowed if orders or depots are in\nmultiple time zones. If the route is making deliveries and StartDepotName is\nnull, it is assumed the cargo is loaded on the vehicle at a virtual\ndepot before the route begins. For a route that has no renewal\nvisits, its delivery orders (those with nonzero DeliveryQuantities values in Orders) are loaded at the start depot or\nvirtual depot. For a route that has renewal visits, only the\ndelivery orders before the first renewal visit are loaded at the\nstart depot or virtual depot. \n EndDepotName The name of the ending depot for the route. This field is\na foreign key to the Name field in Depots. \n StartDepotServiceTime The service time at the starting depot. This can be used\nto model the time spent loading the vehicle. This field can\ncontain a null value; a null value indicates zero service\ntime. The unit for this field value is specified by the Time\nField Units parameter. The service times at the start and end depots are fixed\nvalues (given by the StartDepotServiceTime and EndDepotServiceTime field values) and do not take into account the actual load for a\nroute. For example, the time taken to load a vehicle at the\nstarting depot may depend on the size of the orders. The\ndepot service times can be assigned values corresponding to a full\ntruckload or an average truckload, or you can make your own time\nestimate.\n EndDepotServiceTime The service time at the ending depot. This can be used to\nmodel the time spent unloading the vehicle. This field can\ncontain a null value; a null value indicates zero service\ntime. The unit for this field value is specified by the Time\nField Units parameter. The service times at the start and end depots are fixed\nvalues (given by the StartDepotServiceTime and EndDepotServiceTime field values) and do not take into account the actual load for a\nroute. For example, the time taken to load a vehicle at the\nstarting depot may depend on the size of the orders. The\ndepot service times can be assigned values corresponding to a full\ntruckload or an average truckload, or you can make your own time\nestimate.\n EarliestStartTime The earliest allowable starting time for the route. This\nis used by the solver in conjunction with the time window of the\nstarting depot for determining feasible route start\ntimes. This field can't contain null values and has a default\ntime-only value of 8:00 AM. The default value is interpreted as\n8:00 a.m. on the default date set for the analysis. When solving a problem that spans multiple time zones, the\ntime zone for EarliestStartTime is the same as the time zone in which the starting depot is located.\n LatestStartTime The latest allowable starting time for the route. This field can't contain null values and has a default\ntime-only value of 10:00 AM. The default value is interpreted as\n10:00 a.m. on the default date set for the analysis. When solving a problem that spans multiple time zones, the\ntime zone for LatestStartTime is the same as the time zone in which the starting depot is located.\n ArriveDepartDelay This field stores the amount of travel time needed to\naccelerate the vehicle to normal travel speeds, decelerate it to a\nstop, and move it off and on the network (for example, in and out\nof parking). By including an ArriveDepartDelay value, the VRP\nsolver is deterred from sending many routes to service physically\ncoincident orders. The cost for this property is incurred between visits to\nnoncoincident orders, depots, and route renewals. For example, when\na route starts from a depot and visits the first order, the total\narrive/depart delay is added to the travel time. The same is true\nwhen traveling from the first order to the second order. If the\nsecond and third orders are coincident, the ArriveDepartDelay value\nis not added between them since the vehicle doesn't need to move.\nIf the route travels to a route renewal, the value is added to the\ntravel time again. Although a vehicle must slow down and stop for a break\nand accelerate afterward, the VRP solver cannot add the\nArriveDepartDelay value for breaks. This means that if a route\nleaves an order, stops for a break, and continues to the next\norder, the arrive/depart delay is added only once, not\ntwice. For example, assume there are five coincident orders in\na high-rise building, and they are serviced by three different\nroutes. This means three arrive/depart delays are incurred;\nthat is, three drivers need to separately find parking places\nand enter the same building. However, if the orders can be\nserviced by one route instead, only one driver needs to\npark and enter the building, and only one arrive/depart delay is\nincurred. Since the VRP solver tries to minimize cost, it attempts\nto limit the arrive/depart delays and thus identify the single-route\noption. (Note that multiple routes may need to be sent when other\nconstraints\u2014such as specialties, time windows, or\ncapacities\u2014require it.) The unit for this field value is specified by the time_units parameter.\n CapacitiesThe maximum capacity of the vehicle. You can specify\ncapacity in any dimension, such as weight, volume, or\nquantity. You can also specify multiple dimensions, for example,\nweight and volume. Enter capacities without indicating units. For example,\nif your vehicle can carry a maximum of 40,000 pounds, enter 40000. You need to remember that the\nvalue is in pounds. If you are tracking multiple dimensions, separate\nthe numeric values with a space. For example, if you are recording\nthe weight and volume of a delivery that weighs 2,000 pounds and\nhas a volume of 100 cubic feet, enter 2000 100. Again, you need to\nremember the units\u2014in this case, pounds and cubic feet. You also\nneed to remember the sequence in which the values and their corresponding\nunits are entered. Remembering the units and the unit sequence is important\nfor a couple of reasons: first, so you can reinterpret the\ninformation later; second, so you can properly enter values for the\nDeliveryQuantities and PickupQuantities fields for the orders. Note that the VRP solver\nsimultaneously refers to Capacities, DeliveryQuantities, and\nPickupQuantities to verify that a route doesn't become\noverloaded. Units can't be entered in the field and the VRP tool can't make unit conversions. You must enter the\nvalues for the three fields using the same units and the same unit\nsequence to ensure that the values are correctly interpreted. If you combine\nunits or change the sequence in any of the three fields, unwanted results occur with no warning messages. It is recommended that you set up a unit and unit-sequence standard\nbeforehand and continually refer to it when you enter values for\nthese three fields. An empty string or null value is equivalent to all values\nbeing zero. Capacity values can't be negative. If the Capacities field has an insufficient number of\nvalues in relation to the DeliveryQuantities or PickupQuantities field for orders, the remaining values are treated as\nzero. The VRP solver only performs a simple Boolean test to\ndetermine whether capacities are exceeded. If a route's capacity\nvalue is greater than or equal to the total quantity being carried,\nthe VRP solver will assume the cargo fits in the vehicle. This\ncould be incorrect, depending on the actual shape of the cargo and\nthe vehicle. For example, the VRP solver allows you to fit a\n1,000-cubic-foot sphere into a 1,000-cubic-foot truck that is 8\nfeet wide. In reality, however, since the sphere is 12.6 feet in\ndiameter, it won't fit in the 8-foot wide truck.\n FixedCost A fixed monetary cost that is incurred only if the route\nis used in a solution (that is, it has orders assigned to it). This\nfield can contain null values; a null value indicates zero fixed\ncost. This cost is part of the total route operating\ncost.\n CostPerUnitTime The monetary cost incurred\u2014per unit of work time\u2014for the\ntotal route duration, including travel times as well as service\ntimes and wait times at orders, depots, and breaks. This field\ncan't contain a null value and has a default value of\n1.0. The unit for this field value is specified by the time_units parameter.\n CostPerUnitDistance The monetary cost incurred\u2014per unit of distance\ntraveled\u2014for the route length (total travel distance). This field\ncan contain null values; a null value indicates zero\ncost. The unit for this field value is specified by the distance_units parameter.\n OvertimeStartTime The duration of regular work time before overtime\ncomputation begins. This field can contain null values; a null\nvalue indicates that overtime does not apply. The unit for this field value is specified by the time_units parameter. For example, if the driver is to be paid overtime when\nthe total route duration extends beyond eight hours,\nOvertimeStartTime is specified as 480 (8 hours * 60 minutes/hour),\ngiven the time units are minutes. \n CostPerUnitOvertime The monetary cost incurred per time unit of overtime work.\nThis field can contain null values; a null value indicates that the\nCostPerUnitOvertime value is the same as the CostPerUnitTime value.\n MaxOrderCountThe maximum allowable number of orders on the route. This\nfield can't contain null values and has a default value of\n30. \n MaxTotalTimeThe maximum allowable route duration. The route duration\nincludes travel times as well as service and wait times at orders,\ndepots, and breaks. This field can contain null values; a null\nvalue indicates that there is no constraint on the route\nduration. The unit for this field value is specified by the time_units parameter.\n MaxTotalTravelTime The maximum allowable travel time for the route. The\ntravel time includes only the time spent driving on the network and\ndoes not include service or wait times. This field can contain null values; a null value indicates\nthat there is no constraint on the maximum allowable travel time. This\nfield value can't be larger than the MaxTotalTime field\nvalue. The unit for this field value is specified by the time_units parameter.\n MaxTotalDistance The maximum allowable travel distance for the\nroute. The unit for this field value is specified by the distance_units parameter. This field can contain null values; a null value indicates\nthat there is no constraint on the maximum allowable travel\ndistance.\n SpecialtyNames A space-separated string containing the names of the\nspecialties required by the order. A null value indicates that the\norder doesn't require specialties. The spelling of any specialties listed in the Orders\nand Routes classes must match exactly so that the VRP solver can\nlink them together. To illustrate what specialties are and how they\nwork, assume a lawn care and tree trimming company has a portion of\nits orders that requires a bucket truck to trim tall trees. The\ncompany enters BucketTruck in the SpecialtyNames field for\nthese orders to indicate their special need. SpecialtyNames is left null for the other orders. Similarly, the company also enters BucketTruck in the SpecialtyNames field of routes that\nare driven by trucks with hydraulic booms. It leaves the field\nnull for the other routes. At solve time, the VRP solver assigns\norders without special needs to any route, but it only assigns\norders that need bucket trucks to routes that have\nthem.\n AssignmentRule Specifies the rule for assigning the order to a route. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): This field can't contain a null\nvalue. 1 (Include)\u2014The route is included in the solve operation.\nThis is the default value. 2 (Exclude)\u2014The route is excluded from the solve\noperation.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 1024 }, { "name": "StartDepotName", "type": "esriFieldTypeString", "alias": "StartDepotName", "length": 500 }, { "name": "EndDepotName", "type": "esriFieldTypeString", "alias": "EndDepotName", "length": 500 }, { "name": "StartDepotServiceTime", "type": "esriFieldTypeDouble", "alias": "StartDepotServiceTime" }, { "name": "EndDepotServiceTime", "type": "esriFieldTypeDouble", "alias": "EndDepotServiceTime" }, { "name": "EarliestStartTime", "type": "esriFieldTypeDate", "alias": "EarliestStartTime", "length": 8 }, { "name": "LatestStartTime", "type": "esriFieldTypeDate", "alias": "LatestStartTime", "length": 8 }, { "name": "ArriveDepartDelay", "type": "esriFieldTypeDouble", "alias": "ArriveDepartDelay" }, { "name": "Capacities", "type": "esriFieldTypeString", "alias": "Capacities", "length": 128 }, { "name": "FixedCost", "type": "esriFieldTypeDouble", "alias": "FixedCost" }, { "name": "CostPerUnitTime", "type": "esriFieldTypeDouble", "alias": "CostPerUnitTime" }, { "name": "CostPerUnitDistance", "type": "esriFieldTypeDouble", "alias": "CostPerUnitDistance" }, { "name": "OvertimeStartTime", "type": "esriFieldTypeDouble", "alias": "OvertimeStartTime" }, { "name": "CostPerUnitOvertime", "type": "esriFieldTypeDouble", "alias": "CostPerUnitOvertime" }, { "name": "MaxOrderCount", "type": "esriFieldTypeInteger", "alias": "MaxOrderCount" }, { "name": "MaxTotalTime", "type": "esriFieldTypeDouble", "alias": "MaxTotalTime" }, { "name": "MaxTotalTravelTime", "type": "esriFieldTypeDouble", "alias": "MaxTotalTravelTime" }, { "name": "MaxTotalDistance", "type": "esriFieldTypeDouble", "alias": "MaxTotalDistance" }, { "name": "SpecialtyNames", "type": "esriFieldTypeString", "alias": "SpecialtyNames", "length": 1024 }, { "name": "AssignmentRule", "type": "esriFieldTypeInteger", "alias": "AssignmentRule" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "breaks", "dataType": "GPRecordSet", "displayName": "Breaks", "description": "These are the rest periods, or breaks, for the routes in a given vehicle routing problem. A break is associated with exactly one route and can be taken after completing an order, while en route to an order, or prior to servicing an order. It has a start time and a duration for which the driver may or may not be paid. There are three options for establishing when a break begins: a time window, a maximum travel time, or a maximum work time. When specifying the breaks, you can set properties for each\u2014such as its name or service time\u2014using the following attributes:\n ObjectID The system-managed ID field.\n RouteName The name of the route to which the break applies. Although\na break is assigned to exactly one route, many breaks can be\nassigned to the same route. This field is a foreign key to the Name field in the\nroutes, so it can't have a null value. \n Precedence Precedence values sequence the breaks of a given route.\nBreaks with a precedence value of 1 occur before those with a value\nof 2, and so on. All breaks must have a precedence value, regardless of\nwhether they are time-window, maximum-travel-time, or\nmaximum-work-time breaks.\n ServiceTime The duration of the break. This field can't contain null\nvalues. The default value is 60. The unit for this field value is specified by the time_units parameter.\n TimeWindowStart The starting time of the break's time window. Both a starting time and end time must be specified. If this field has a value, the MaxTravelTimeBetweenBreaks and\nMaxCumulWorkTime field values must be null, and all other breaks in the\nanalysis must have null values for MaxTravelTimeBetweenBreaks and MaxCumulWorkTime. An error will occur at solve time if a route has multiple\nbreaks with overlapping time windows. The time window fields in breaks can contain a time-only\nvalue or a date and time value. If a time field, such as\nTimeWindowStart, has a time-only value (for example, 12:00 PM), the\ndate is assumed to be the date specified by the default_date\nparameter. Using date and time values (for example, 7/11/2012 12:00\nPM) allows you to specify time windows that span two or more days.\nThis is beneficial when a break should be taken sometime\nbefore and after midnight. When solving a problem that spans multiple time zones, each break's time-window values refer to the time zone in which the associated route, specified by the RouteName field, is located.\n TimeWindowEnd The ending time of the break's time window. Both a starting time and end time must be specified. If this field has a value, MaxTravelTimeBetweenBreaks and\nMaxCumulWorkTime must be null, and all other breaks in the\nanalysis must have null values for MaxTravelTimeBetweenBreaks and MaxCumulWorkTime. \n MaxViolationTime This field specifies the maximum allowable violation time\nfor a time-window break. A time window is considered violated if\nthe arrival time falls outside the time range. A zero value indicates that the time window cannot be violated;\nthat is, the time window is hard. A nonzero value specifies the\nmaximum amount of lateness. For example, the break can begin up to\n30 minutes beyond the end of its time window, but the lateness is\npenalized pursuant to the Time Window Violation Importance\nparameter. This property can be null. A null value with\nTimeWindowStart and TimeWindowEnd values indicates that there is no\nlimit on the allowable violation time. If\nMaxTravelTimeBetweenBreaks or MaxCumulWorkTime has a value,\nMaxViolationTime must be null. The unit for this field value is specified by the time_units parameter.\n MaxTravelTimeBetweenBreaks The maximum amount of travel time that can be accumulated\nbefore the break is taken. The travel time is accumulated either\nfrom the end of the previous break or, if a break has not yet been\ntaken, from the start of the route. If this is the route's final break,\nMaxTravelTimeBetweenBreaks also indicates the maximum travel time\nthat can be accumulated from the final break to the end\ndepot. This field is designed to limit how long a person can\ndrive until a break is required. For instance, if the time unit for the analysis is set to\nminutes, and MaxTravelTimeBetweenBreaks has a value of 120, the\ndriver will get a break after two hours of driving. To assign a\nsecond break after two more hours of driving, the second break's\nMaxTravelTimeBetweenBreaks property must be 120. If this field has a value, TimeWindowStart, TimeWindowEnd,\nMaxViolationTime, and MaxCumulWorkTime must be null for an analysis\nto solve successfully. The unit for this field value is specified by the time_units parameter.\n MaxCumulWorkTime The maximum amount of work time that can be accumulated\nbefore the break is taken. Work time is always accumulated from the\nbeginning of the route. Work time is the sum of travel time and service times at\norders, depots, and breaks. Note, however, that this excludes wait\ntime, which is the time a route (or driver) spends waiting at an\norder or depot for a time window to begin. This field limits how long a person can work\nuntil a break is required. For example, if the time unit for the analysis is set to\nminutes,\nMaxCumulWorkTime has a value of 120, and ServiceTime has a value of\n15, the driver will get a 15-minute break after two hours of\nwork. Continuing with the last example, assume a second break is\nneeded after three more hours of work. To specify this break, enter 315 (five hours and 15 minutes) as the second break's\nMaxCumulWorkTime value. This number includes the MaxCumulWorkTime and ServiceTime values of the preceding break, along with the three\nadditional hours of work time before granting the second break. To\navoid taking maximum-work-time breaks prematurely, remember that\nthey accumulate work time from the beginning of the route and that\nwork time includes the service time at previously visited depots,\norders, and breaks. If this field has a value, TimeWindowStart, TimeWindowEnd,\nMaxViolationTime, and MaxTravelTimeBetweenBreaks must be null for\nan analysis to solve successfully. The unit for this field value is specified by the time_units parameter.\n IsPaidA Boolean value indicating whether the break is paid or\nunpaid. Setting this field value to 1 indicates that the time spent at the break is\nincluded in the route cost computation and overtime determination.\nA value of 0 indicates otherwise. The default value is\n1. \n Sequence Indicates the sequence of the\nbreak on its route. This field can contain null values, which causes the solver to assign the break sequence. If sequence values are specified, they should be positive and unique for each route (shared\nacross renewal depot visits, orders, and breaks) but need not start\nfrom 1 or be contiguous.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "Precedence", "type": "esriFieldTypeInteger", "alias": "Precedence" }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "TimeWindowStart", "type": "esriFieldTypeDate", "alias": "TimeWindowStart", "length": 8 }, { "name": "TimeWindowEnd", "type": "esriFieldTypeDate", "alias": "TimeWindowEnd", "length": 8 }, { "name": "MaxViolationTime", "type": "esriFieldTypeDouble", "alias": "MaxViolationTime" }, { "name": "MaxTravelTimeBetweenBreaks", "type": "esriFieldTypeDouble", "alias": "MaxTravelTimeBetweenBreaks" }, { "name": "MaxCumulWorkTime", "type": "esriFieldTypeDouble", "alias": "MaxCumulWorkTime" }, { "name": "IsPaid", "type": "esriFieldTypeInteger", "alias": "IsPaid" }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "" }, { "name": "time_units", "dataType": "GPString", "displayName": "Time Units", "description": "The time units for all time-based field values in the\nanalysis. Many features and records in a VRP analysis have fields\nfor storing time values, such as ServiceTime for orders and\nCostPerUnitTime for routes. To minimize data entry requirements,\nthese field values don't include units. Instead, all distance-based\nfield values must be entered in the same units, and this parameter\nis used to specify the units of those values. Note that output time-based fields use the same units\nspecified by this parameter.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Minutes", "parameterType": "esriGPParameterTypeOptional", "category": "", "choiceList": [ "Seconds", "Minutes", "Hours", "Days" ] }, { "name": "distance_units", "dataType": "GPString", "displayName": "Distance Units", "description": "The distance units for all distance-based field values in\nthe analysis. Many features and records in a VRP analysis have\nfields for storing distance values, such as MaxTotalDistance and\nCostPerUnitDistance for routes. To minimize data entry\nrequirements, these field values don't include units. Instead, all\ndistance-based field values must be entered in the same units, and\nthis parameter is used to specify the units of those\nvalues. Note that output distance-based fields use the same units\nspecified by this parameter.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Miles", "parameterType": "esriGPParameterTypeOptional", "category": "", "choiceList": [ "Meters", "Kilometers", "Feet", "Yards", "Miles", "NauticalMiles" ] }, { "name": "analysis_region", "dataType": "GPString", "displayName": "Analysis Region", "description": "This parameter is ignored by the service and specifying a value does not have any effect on the analysis.", "direction": "esriGPParameterDirectionInput", "defaultValue": "", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Streets_ND" ] }, { "name": "default_date", "dataType": "GPDate", "displayName": "Default Date", "description": "The default date for time field values that specify a time\nof day without including a date. You can find these time fields in various input parameters, such as the ServiceTime attributes in the orders and breaks parameters.", "direction": "esriGPParameterDirectionInput", "defaultValue": null, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "uturn_policy", "dataType": "GPString", "displayName": "UTurn at Junctions", "description": "Specifies whether to restrict or permit the service area to make U-turns at junctions. To understand the parameter values, consider the following terminology: a junction is a point where a street segment ends and potentially connects to one or more other segments; a pseudojunction is a point where exactly two streets connect to one another; an intersection is a point where three or more streets connect; and a dead end is where one street segment ends without connecting to another. Allow UTurns\u2014U-turns are permitted everywhere. Allowing\nU-turns implies that the vehicle can turn around at any junction and\ndouble back on the same street. This is the default value.No UTurns\u2014U-turns are prohibited at all junctions: pseudojunctions, intersections, and dead ends.\nNote, however, that U-turns may be permitted even when this option is chosen. To prevent U-turns at incidents and facilities, set\nthe CurbApproach field value to\nprohibit U-turns.Allow Dead Ends Only\u2014U-turns are prohibited at all\njunctions, except those that have only one connected street feature (a dead\nend).Allow Dead Ends and Intersections Only\u2014U-turns are prohibited at\npseudojunctions where exactly two adjacent streets meet, but U-turns are permitted\nat intersections and dead ends. This prevents turning around in the middle of the road where one length of road happens to be digitized as two street features.The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.", "direction": "esriGPParameterDirectionInput", "defaultValue": "ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "ALLOW_UTURNS", "NO_UTURNS", "ALLOW_DEAD_ENDS_ONLY", "ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY" ] }, { "name": "time_window_factor", "dataType": "GPString", "displayName": "Time Window Factor", "description": "Specifies the importance of honoring time windows. High\u2014Importance is placed on arriving at stops on time\nrather than minimizing drive times. For example, organizations that make\ntime-critical deliveries or that are concerned with customer\nservice choose High. Medium\u2014Importance\nis balanced between minimizing drive times and arriving within time\nwindows. This is the default value. Low\u2014Importance is placed on minimizing drive times and\nrather than arriving at stops on time. You may want to use this setting\nif you have a growing backlog of service requests. For the purpose\nof servicing more orders in a day and reducing the backlog, you can\nchoose Low even though customers may be inconvenienced with your\nlate arrivals.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Medium", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "High", "Medium", "Low" ] }, { "name": "spatially_cluster_routes", "dataType": "GPBoolean", "displayName": "Spatially Cluster Routes", "description": "Specifies whether routes will be spatially clustered. CLUSTER (True)\u2014Dynamic seed points are automatically created for\nall routes, and the orders assigned to an individual\nroute are spatially clustered. Clustering orders tends to keep\nroutes in smaller areas and reduce how often different route lines\nintersect one another; yet, clustering also tends to increase\noverall travel times. NO_CLUSTER (False)\u2014Dynamic seed points aren't\ncreated. Choose this option if route zones are\nspecified.", "direction": "esriGPParameterDirectionInput", "defaultValue": true, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "route_zones", "dataType": "GPFeatureRecordSetLayer", "displayName": "Route Zones", "description": "Delineates work territories for given routes. A route zone is a polygon feature used to constrain routes to servicing only those orders that fall within or near the specified area. The following are examples of when route zones may be useful:Some of your employees don't have the required permits to perform work in certain states or communities. You can create a hard route zone so they only visit orders in areas where they meet the requirements.One of your vehicles breaks down frequently and you want to minimize response time by having it only visit orders that are close to your maintenance garage. You can create a soft or hard route zone to keep the vehicle nearby.When specifying the route zones, you must set properties for each\u2014such as its associated route\u2014using the following attributes:\n ObjectID The system-managed ID field.\n RouteName The name of the route to which this zone applies. A route zone can have a maximum of one associated route. This field can't contain null values, and it is a foreign key to the Name field in routes.\n IsHardZone A Boolean value indicating a hard or soft route zone. A\nTrue value indicates that the route zone is hard; that is, an order\nthat falls outside the route zone polygon can't be assigned to the\nroute. The default value is 1 (True). A False value (0) indicates\nthat such orders can still be assigned, but the cost of servicing\nthe order is weighted by a function based on the Euclidean\ndistance from the route zone. Basically, this means that as the\nstraight-line distance from the soft zone to the order increases,\nthe likelihood of the order being assigned to the route\ndecreases.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "IsHardZone", "type": "esriFieldTypeInteger", "alias": "IsHardZone" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" }, { "name": "Shape_Area", "type": "esriFieldTypeDouble", "alias": "Shape_Area" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "route_renewals", "dataType": "GPRecordSet", "displayName": "Route Renewals", "description": "Specifies the intermediate depots that routes can visit to reload or unload the cargo they are delivering or picking up. Specifically, a route renewal links a route to a depot. The relationship indicates the route can renew (reload or unload while en route) at the associated depot. Route renewals can be used to model scenarios in which a vehicle picks up a full load of deliveries at the starting depot, services the orders, returns to the depot to renew its load of deliveries, and continues servicing more orders. For example, in propane gas delivery, the vehicle may make several deliveries until its tank is nearly or completely depleted, visit a refueling point, and make more deliveries. Here are a few rules and options to consider:The reload/unload point, or renewal location, can be different from the start or end depot.Each route can have one or many predetermined renewal locations.A renewal location can be used more than once by a single route.In cases where there may be several potential renewal locations for a route, the closest available renewal location is identified by the solver.When specifying the route renewals, you must set properties for each\u2014such as the name of the depot where the route renewal can occur\u2014using the following attributes:\n ObjectIDThe system-managed ID field.\n DepotName The name of the depot where this renewal takes place. This field can't contain a null value and is a foreign key to the Name field in depots. \n RouteName The name of the route to which this renewal applies. This field can't contain a null value and is a foreign key to the Name field in routes.\n ServiceTime The service time for the renewal. This field can contain a null value; a null value indicates zero service time. The unit for this field value is specified by the time_units parameter. The time taken to load a vehicle at a renewal depot may depend on the size of the vehicle and how full or empty the vehicle is. However, the service time for a route renewal is a fixed value and does not take into account the actual load. As such, the renewal service time should be given a value corresponding to a full truckload, an average truckload, or another time estimate of your choice.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "DepotName", "type": "esriFieldTypeString", "alias": "DepotName", "length": 500 }, { "name": "ServiceTime", "type": "esriFieldTypeDouble", "alias": "ServiceTime" }, { "name": "Sequences", "type": "esriFieldTypeString", "alias": "Sequences", "length": 128 } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "order_pairs", "dataType": "GPRecordSet", "displayName": "Order Pairs", "description": "Pairs pick up and deliver orders so they are serviced by the same route. Specifying order pairs prevents the analysis from assigning only one of the orders to a route: either both orders are assigned to the same route, or neither order is assigned. Sometimes it is necessary for the pick up and delivery of orders to be paired. For example, a courier company may need to have a route pick up a high-priority package from one order and deliver it to another without returning to a depot, or sorting station, to minimize delivery time. These related orders can be assigned to the same route with the appropriate sequence using order pairs. Restrictions on how long the package can stay in the vehicle can also be assigned; for example, the package might be a blood sample that must be transported from the doctor's office to the lab within two hours. Some situations may require two pairs of orders. For example, suppose you want to transport a senior citizen from her home to the doctor and then back home. The ride from her home to the doctor is one pair of orders with a desired arrival time at the doctor, while the ride from the doctor to her home is another pair with a desired pickup time. When specifying the order pairs, you must set properties for each\u2014such as the names of the two orders\u2014using the following attributes:\n ObjectID The system-managed ID field.\n FirstOrderName The name of the first order of the pair. This field is a foreign key to the Name field in orders. \n SecondOrderNameThe name of the second order of the pair. This field is a foreign key to the Name field in orders. The first order in the pair must be a pickup order; that is, the value for its DeliveryQuantities field is null. The second order in the pair must be a delivery order; that is, the value for its PickupQuantities field is null. The quantity picked up at the first order must agree with the quantity delivered at the second order. As a special case, both orders may have zero quantities for scenarios where capacities are not used. The order quantities are not loaded or unloaded at depots. \n MaxTransitTimeThe maximum transit time for the pair. The transit time is the duration from the departure time of the first order to the arrival time at the second order. This constraint limits the time-on-vehicle, or ride time, between the two orders. When a vehicle is carrying people or perishable goods, the ride time is typically shorter than that of a vehicle carrying packages or nonperishable goods. This field can contain null values; a null value indicates that there is no constraint on the ride time. The unit for this field value is specified by the timeUnits property of the analysis object. Excess transit time (measured with respect to the direct travel time between order pairs) can be tracked and weighted by the solver. Because of this, you can direct the VRP solver to take one of three approaches:Minimize the overall excess transit time, regardless of the increase in travel cost for the fleet.Find a solution that balances overall violation time and travel cost.Ignore the overall excess transit time and, instead, minimize the travel cost for the fleet. By assigning an importance level for the excess_transit_factor parameter, you are, in effect, choosing one of these\nthree approaches. Regardless of the importance level, the solver\nwill always return an error if the MaxTransitTime value is\nsurpassed.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "FirstOrderName", "type": "esriFieldTypeString", "alias": "FirstOrderName", "length": 500 }, { "name": "SecondOrderName", "type": "esriFieldTypeString", "alias": "SecondOrderName", "length": 500 }, { "name": "MaxTransitTime", "type": "esriFieldTypeDouble", "alias": "MaxTransitTime" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "excess_transit_factor", "dataType": "GPString", "displayName": "Excess Transit Factor", "description": "Specifies the importance of reducing excess transit time of\norder pairs. Excess transit time is the amount of time exceeding\nthe time required to travel directly between the paired orders.\nExcess time can be caused by driver breaks or travel to\nintermediate orders and depots. High\u2014Importance is placed on the least\nexcess transit time between paired orders at the expense of\nincreasing the overall travel costs. This\nsetting is typically used when transporting people between paired orders and\nyou want to shorten their ride time. This is characteristic of taxi\nservices. Medium\u2014Importance is balanced between reducing excess transit time and reducing the\noverall solution cost. This is the default value. Low\u2014Importance is placed on minimizing\noverall solution cost, regardless of excess transit time. This\nsetting is commonly used with courier services. Since couriers\ntransport packages as opposed to people, they don't worry\nabout ride time. Low allows the couriers to service paired\norders in the proper sequence and minimize the overall solution\ncost.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Medium", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "High", "Medium", "Low" ] }, { "name": "point_barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Point Barriers", "description": "Use this parameter to specify one or more points that will act as temporary\nrestrictions or represent additional time or distance that may be\nrequired to travel on the underlying streets. For example, a point\nbarrier can be used to represent a fallen tree along a street or\na time delay spent at a railroad crossing. The tool imposes a limit of 250 points that can be added\nas barriers.When specifying point barriers, you can set properties for each, such as its name or barrier type, using the following attributes:\n\t\t\t\t\t\t\tName The name of the barrier. BarrierType Specifies whether the point barrier restricts travel\ncompletely or adds time or distance when it is crossed. The value\nfor this attribute is specified as one of the following\nintegers (use the numeric code, not the name in parentheses): 0 (Restriction)\u2014Prohibits travel through the barrier. The barrier\nis referred to as a restriction point barrier since it acts as a\nrestriction. 2 (Added Cost)\u2014Traveling through the barrier increases the travel\ntime or distance by the amount specified in the\nAdditional_Time, Additional_Distance, or Additional_Cost field. This barrier type is\nreferred to as an added cost point barrier. Additional_Time The added travel time when the\nbarrier is traversed. This field is applicable only for added-cost\nbarriers and when the Measurement Units parameter is time-based. This field\nvalue must be greater than or equal to zero, and its units are the same as those specified in the\nMeasurement Units parameter. Additional_DistanceThe added distance when the\nbarrier is traversed. This field is applicable only for added-cost\nbarriers and when the Measurement Units parameter is distance-based.. The field value\nmust be greater than or equal to zero, and its units are the same as those specified in the\nMeasurement Units parameter.Additional_CostThe added cost when the\nbarrier is traversed. This field is applicable only for added-cost\nbarriers when the Measurement Units parameter is neither time-based nor distance-based. FullEdgeSpecifies how the restriction point barriers are applied to the edge elements during the analysis. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (False)\u2014Permits travel on the edge up to the barrier but not through it. This is the default value.1 (True)\u2014Restricts travel anywhere on the associated edge. CurbApproachSpecifies the direction of traffic that is affected by the barrier. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle)\u2014The barrier affects travel over the edge in both directions.1 (Right side of vehicle)\u2014Vehicles are only affected if the barrier is on their right side during the approach. Vehicles that traverse the same edge but approach the barrier on their left side are not affected by the barrier. 2 (Left side of vehicle)\u2014Vehicles are only affected if the barrier is on their left side during the approach. Vehicles that traverse the same edge but approach the barrier on their right side are not affected by the barrier. Because junctions are points and don't have a side, barriers on junctions affect all vehicles regardless of the curb approach. The CurbApproach attribute works with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a facility on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a facility from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, to arrive at a facility and not have a lane of traffic between the vehicle and the facility, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "Barrier Type" }, { "name": "Additional_Time", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "Additional_Distance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "AdditionalCost", "type": "esriFieldTypeDouble", "alias": "Additional Cost" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" }, { "name": "FullEdge", "type": "esriFieldTypeInteger", "alias": "Full Edge" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "line_barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Line Barriers", "description": "Use this parameter to specify one or more lines that prohibit travel anywhere\nthe lines intersect the streets. For example, a parade or protest\nthat blocks traffic across several street segments can be modeled\nwith a line barrier. A line barrier can also quickly fence off\nseveral roads from being traversed, thereby channeling possible\nroutes away from undesirable parts of the street\nnetwork. The tool imposes a limit on the number of streets you can\nrestrict using the Line Barriers parameter. While there is no limit to\nthe number of lines you can specify as line barriers, the combined\nnumber of streets intersected by all the lines cannot exceed\n500.When specifying the line barriers, you can set name and barrier type properties for each using the following attributes:\n\t\t\t\t\t\t\tName The name of the barrier.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "polygon_barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Polygon Barriers", "description": "Use this parameter to specify polygons that either completely restrict travel or\nproportionately scale the time or distance required to travel on\nthe streets intersected by the polygons. The service imposes a limit on the number of streets you\ncan restrict using the Polygon Barriers parameter. While there is\nno limit to the number of polygons you can specify as polygon\nbarriers, the combined number of streets intersected by all the\npolygons cannot exceed 2,000.When specifying the polygon barriers, you can set properties for each, such as its name or barrier type, using the following attributes:\n\t\t\t\t\t\t\tName The name of the barrier. BarrierType Specifies whether the barrier restricts travel completely\nor scales the cost (such as time or distance) for traveling through it. The field\nvalue is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Restriction)\u2014Prohibits traveling through any part of the barrier.\nThe barrier is referred to as a restriction polygon barrier since it\nprohibits traveling on streets intersected by the barrier. One use\nof this type of barrier is to model floods covering areas of the\nstreet that make traveling on those streets impossible. 1 (Scaled Cost)\u2014Scales the cost (such as travel time or distance) required to travel the\nunderlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor field. If the streets are partially\ncovered by the barrier, the travel time or distance is apportioned\nand then scaled. For example, a factor of 0.25 means that travel\non underlying streets is expected to be four times faster than\nnormal. A factor of 3.0 means it is expected to take three\ntimes longer than normal to travel on underlying streets. This\nbarrier type is referred to as a scaled-cost polygon barrier. It\ncan be used to model storms that reduce travel speeds in specific\nregions. ScaledTimeFactor This is the factor by which the travel time of the streets\nintersected by the barrier is multiplied. The field value must be greater than zero. This field is applicable only for scaled-cost\nbarriers and when the Measurement Units parameter is time-based. ScaledDistanceFactor This is the factor by which the distance of the streets\nintersected by the barrier is multiplied. The field value must be greater than zero.This field is applicable only for scaled-cost\nbarriers and when the Measurement Units parameter is distance-based. ScaledCostFactor This is the factor by which the cost of the streets\nintersected by the barrier is multiplied. The field value must be greater than zero. This field is applicable only for scaled-cost\nbarriers when the Measurement Units parameter is neither time-based nor distance-based.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "Barrier Type" }, { "name": "ScaledTimeFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Time Factor" }, { "name": "ScaledDistanceFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Distance Factor" }, { "name": "ScaledCostFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Cost Factor" }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" }, { "name": "SHAPE_Area", "type": "esriFieldTypeDouble", "alias": "SHAPE_Area" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "use_hierarchy_in_analysis", "dataType": "GPBoolean", "displayName": "Use Hierarchy", "description": "Specifies whether hierarchy will be used when finding the best\nroutes. Checked (True)\u2014Hierarchy will be used when finding routes. When\nhierarchy is used, the tool identifies higher-order streets, such as\nfreeways, before lower-order streets, such as local roads, and can be used\nto simulate the driver preference of traveling on freeways instead\nof local roads even if that means a longer trip. This is especially\ntrue when finding routes to faraway locations, because drivers on long-distance trips tend to prefer traveling on freeways, where stops, intersections, and turns can be avoided. Using hierarchy is computationally faster,\nespecially for long-distance routes, as the tool identifies the\nbest route from a relatively smaller subset of streets. Unchecked (False)\u2014Hierarchy will not be used when finding routes. If\nhierarchy is not used, the tool considers all the streets and doesn't\nnecessarily identify higher-order streets when finding the route. This is often\nused when finding short-distance routes within a city.This parameter is ignored unless Travel Mode is set to Custom, which is the default value.", "direction": "esriGPParameterDirectionInput", "defaultValue": true, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "restrictions", "dataType": "GPMultiValue:GPString", "displayName": "Restrictions", "description": "The restrictions that will be honored by the tool when finding the best routes.A restriction represents a driving\npreference or requirement. In most cases, restrictions cause roads\nto be prohibited. For instance, using the Avoid Toll Roads restriction will result in a route that will include toll roads only when it is required to travel on toll roads to visit an incident or a facility. Height Restriction makes it possible to route around any clearances that are lower than the height of your vehicle. If you are carrying corrosive materials on your vehicle, using the Any Hazmat Prohibited restriction prevents hauling the materials along roads where it is marked illegal to do so. The values you provide for this parameter are ignored unless Travel Mode is set to Custom.Some restrictions require an additional value to be\nspecified for their use. This value must be associated\nwith the restriction name and a specific parameter intended to work\nwith the restriction. You can identify such restrictions if their\nnames appear in the AttributeName column in the Attribute\nParameter Values parameter. The ParameterValue field should be\nspecified in the Attribute Parameter Values parameter for the\nrestriction to be correctly used when finding traversable roads.Some restrictions are supported only in certain countries; their availability is stated by region in the list below. Of the restrictions that have limited availability within a region, you can determine whether the restriction is available in a particular country by reviewing the table in the Country list section of Network analysis coverage. If a country has a value of Yes in the Logistics Attribute column, the restriction with select availability in the region is supported in that country. If you specify restriction names that are not available in the country where your incidents are located, the service ignores the invalid restrictions. The service also ignores restrictions when the Restriction Usage attribute parameter value is between 0 and 1 (see the Attribute Parameter Value parameter). It prohibits all restrictions when the Restriction Usage parameter value is greater than 0.The tool supports the following restrictions: Any Hazmat Prohibited\u2014The results will not include roads\nwhere transporting any kind of hazardous material is\nprohibited. Availability: Select countries in North America and Europe Avoid Carpool Roads\u2014The results will avoid roads that are\ndesignated exclusively for car pool (high-occupancy)\nvehicles. Availability: All countries Avoid Express Lanes\u2014The results will avoid roads designated\nas express lanes. Availability: All countries Avoid Ferries\u2014The results will avoid ferries. Availability: All countries Avoid Gates\u2014The results will avoid roads where there are\ngates, such as keyed access or guard-controlled\nentryways.Availability: All countries Avoid Limited Access Roads\u2014The results will avoid roads\nthat are limited-access highways. Availability: All countries Avoid Private Roads\u2014The results will avoid roads that are\nnot publicly owned and maintained. Availability: All countries Avoid Roads Unsuitable for Pedestrians\u2014The results will avoid roads that are\nunsuitable for pedestrians. Availability: All countries Avoid Stairways\u2014The results will avoid all stairways on a pedestrian-suitable route. Availability: All countries Avoid Toll Roads\u2014The results will avoid all toll\nroads for automobiles.Availability: All countries Avoid Toll Roads for Trucks\u2014The results will avoid all toll\nroads for trucks.Availability: All countries Avoid Truck Restricted Roads\u2014The results will avoid roads where trucks are not allowed, except when making deliveries.Availability: All countries Avoid Unpaved Roads\u2014The results will avoid roads that are\nnot paved (for example, dirt, gravel, and so on). Availability: All countries Axle Count Restriction\u2014The results will not include roads\nwhere trucks with the specified number of axles are prohibited. The\nnumber of axles can be specified using the Number of Axles\nrestriction parameter.Availability: Select countries in North America and Europe Driving a Bus\u2014The results will not include roads where\nbuses are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countries Driving a Taxi\u2014The results will not include roads where\ntaxis are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countries Driving a Truck\u2014The results will not include roads where\ntrucks are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countries Driving an Automobile\u2014The results will not include roads\nwhere automobiles are prohibited. Using this restriction will also\nensure that the results will honor one-way streets. Availability: All countries Driving an Emergency Vehicle\u2014The results will not include\nroads where emergency vehicles are prohibited. Using this\nrestriction will also ensure that the results will honor one-way\nstreets. Availability: All countries Height Restriction\u2014The results will not include roads\nwhere the vehicle height exceeds the maximum allowed height for the\nroad. The vehicle height can be specified using the Vehicle Height\n(meters) restriction parameter. Availability: Select countries in North America and Europe Kingpin to Rear Axle Length Restriction\u2014The results will\nnot include roads where the vehicle length exceeds the maximum\nallowed kingpin to rear axle for all trucks on the road. The length\nbetween the vehicle kingpin and the rear axle can be specified\nusing the Vehicle Kingpin to Rear Axle Length (meters) restriction\nparameter. Availability: Select countries in North America and Europe Length Restriction\u2014The results will not include roads\nwhere the vehicle length exceeds the maximum allowed length for the\nroad. The vehicle length can be specified using the Vehicle Length\n(meters) restriction parameter. Availability: Select countries in North America and Europe Preferred for Pedestrians\u2014The results will use preferred routes suitable for pedestrian navigation. Availability: Select countries in North America and Europe Riding a Motorcycle\u2014The results will not include roads\nwhere motorcycles are prohibited. Using this restriction will also\nensure that the results will honor one-way streets. Availability: All countries Roads Under Construction Prohibited\u2014The results will not\ninclude roads that are under construction.Availability: All countries Semi or Tractor with One or More Trailers Prohibited\u2014The\nresults will not include roads where semis or tractors with one or\nmore trailers are prohibited. Availability: Select countries in North America and Europe Single Axle Vehicles Prohibited\u2014The results will not\ninclude roads where vehicles with single axles are\nprohibited.Availability: Select countries in North America and Europe Tandem Axle Vehicles Prohibited\u2014The results will not\ninclude roads where vehicles with tandem axles are\nprohibited.Availability: Select countries in North America and Europe Through Traffic Prohibited\u2014The results will not include\nroads where through traffic (non-local) is prohibited.Availability: All countries Truck with Trailers Restriction\u2014The results will not\ninclude roads where trucks with the specified number of trailers on\nthe truck are prohibited. The number of trailers on the truck can\nbe specified using the Number of Trailers on Truck restriction\nparameter.Availability: Select countries in North America and Europe Use Preferred Hazmat Routes\u2014The results will prefer roads\nthat are designated for transporting any kind of hazardous\nmaterials. Availability: Select countries in North America and Europe Use Preferred Truck Routes\u2014The results will prefer roads\nthat are designated as truck routes, such as the roads that are\npart of the national network as specified by the National Surface\nTransportation Assistance Act in the United States, or roads that\nare designated as truck routes by the state or province, or roads\nthat are preferred by truckers when driving in an\narea.Availability: Select countries in North America and Europe Walking\u2014The results will not include roads where\npedestrians are prohibited.Availability: All countries Weight Restriction\u2014The results will not include roads\nwhere the vehicle weight exceeds the maximum allowed weight for the\nroad. The vehicle weight can be specified using the Vehicle Weight\n(kilograms) restriction parameter.Availability: Select countries in North America and Europe Weight per Axle Restriction\u2014The results will not include\nroads where the vehicle weight per axle exceeds the maximum allowed\nweight per axle for the road. The vehicle weight per axle can be\nspecified using the Vehicle Weight per Axle (kilograms) restriction\nparameter.Availability: Select countries in North America and Europe Width Restriction\u2014The results will not include roads where\nthe vehicle width exceeds the maximum allowed width for the road.\nThe vehicle width can be specified using the Vehicle Width (meters)\nrestriction parameter.Availability: Select countries in North America and Europe The Driving a Delivery Vehicle restriction attribute is no longer available. The service will ignore this restriction since it is invalid. To achieve similar results, use the Driving a Truck restriction attribute along with the Avoid Truck Restricted Roads restriction attribute.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.", "direction": "esriGPParameterDirectionInput", "defaultValue": [ "Avoid Carpool Roads", "Avoid Express Lanes", "Avoid Gates", "Avoid Private Roads", "Avoid Unpaved Roads", "Driving an Automobile", "Through Traffic Prohibited" ], "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Any Hazmat Prohibited", "Avoid Carpool Roads", "Avoid Express Lanes", "Avoid Ferries", "Avoid Gates", "Avoid Limited Access Roads", "Avoid Private Roads", "Avoid Toll Roads", "Avoid Truck Restricted Roads", "Avoid Unpaved Roads", "Driving a Bus", "Driving a Delivery Vehicle", "Driving a Taxi", "Driving a Truck", "Driving an Automobile", "Driving an Emergency Vehicle", "Height Restriction", "Length Restriction", "Through Traffic Prohibited", "Use Preferred Hazmat Routes", "Use Preferred Truck Routes", "Walking", "Weight Restriction" ] }, { "name": "attribute_parameter_values", "dataType": "GPRecordSet", "displayName": "Attribute Parameter Values", "description": "Use this parameter to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is\nmeant to avoid or prefer roads, you can further specify the degree\nto which they are avoided or preferred using this\nparameter. For example, you can choose to never use toll roads, avoid them as much as possible, or prefer them.The values you provide for this parameter are ignored unless Travel Mode is set to Custom. If you specify the Attribute Parameter Values parameter from a\nfeature class, the field names on the feature class must match the fields as follows:AttributeName\u2014The name of the restriction.ParameterName\u2014The name of the parameter associated with the\nrestriction. A restriction can have one or more ParameterName field\nvalues based on its intended use.ParameterValue\u2014The value for ParameterName used by the tool\nwhen evaluating the restriction. The Attribute Parameter Values parameter is dependent on the\nRestrictions parameter. The ParameterValue field is applicable only\nif the restriction name is specified as the value for the\nRestrictions parameter. In Attribute Parameter Values, each\nrestriction (listed as AttributeName) has a ParameterName field\nvalue, Restriction Usage, that specifies whether the restriction\nprohibits, avoids, or prefers travel on the roads associated with\nthe restriction as well as the degree to which the roads are avoided or\npreferred. The Restriction Usage ParameterName can be assigned any of\nthe following string values or their equivalent numeric values\nlisted in the parentheses: PROHIBITED (-1)\u2014Travel on the roads using the restriction is completely\nprohibited. AVOID_HIGH (5)\u2014It\nis highly unlikely the tool will include in the route the roads\nthat are associated with the restriction. AVOID_MEDIUM (2)\u2014It\nis unlikely the tool will include in the route the roads that are\nassociated with the restriction. AVOID_LOW (1.3)\u2014It\nis somewhat unlikely the tool will include in the route the roads\nthat are associated with the restriction. PREFER_LOW (0.8)\u2014It\nis somewhat likely the tool will include in the route the roads\nthat are associated with the restriction. PREFER_MEDIUM (0.5)\u2014It is likely the tool will include in the route the roads that\nare associated with the restriction. PREFER_HIGH (0.2)\u2014It is highly likely the tool will include in the route the roads\nthat are associated with the restriction. In most cases, you can use the default value, PROHIBITED,\nas the Restriction Usage value if the restriction is dependent on a\nvehicle characteristic such as vehicle height. However, in some\ncases, the Restriction Usage value depends on your routing\npreferences. For example, the Avoid Toll Roads restriction has the\ndefault value of AVOID_MEDIUM for the Restriction Usage attribute.\nThis means that when the restriction is used, the tool will try to\nroute around toll roads when it can. AVOID_MEDIUM also indicates\nhow important it is to avoid toll roads when finding the best\nroute; it has a medium priority. Choosing AVOID_LOW puts lower\nimportance on avoiding tolls; choosing AVOID_HIGH instead gives it a higher importance and thus makes it more acceptable for\nthe service to generate longer routes to avoid tolls. Choosing\nPROHIBITED entirely disallows travel on toll roads, making it\nimpossible for a route to travel on any portion of a toll road.\nKeep in mind that avoiding or prohibiting toll roads, and thus\navoiding toll payments, is the objective for some. In contrast,\nothers prefer to drive on toll roads, because avoiding traffic is\nmore valuable to them than the money spent on tolls. In the latter\ncase, choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as\nthe value for Restriction Usage. The higher the preference, the\nfarther the tool will go out of its way to travel on the roads\nassociated with the restriction.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "AttributeName", "type": "esriFieldTypeString", "alias": "AttributeName", "length": 255 }, { "name": "ParameterName", "type": "esriFieldTypeString", "alias": "ParameterName", "length": 255 }, { "name": "ParameterValue", "type": "esriFieldTypeString", "alias": "ParameterValue", "length": 25 } ], "features": [ { "attributes": { "OBJECTID": 1, "AttributeName": "Any Hazmat Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 2, "AttributeName": "Avoid Carpool Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 3, "AttributeName": "Avoid Express Lanes", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 4, "AttributeName": "Avoid Ferries", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 5, "AttributeName": "Avoid Gates", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 6, "AttributeName": "Avoid Limited Access Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 7, "AttributeName": "Avoid Private Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 8, "AttributeName": "Avoid Toll Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 9, "AttributeName": "Avoid Truck Restricted Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 10, "AttributeName": "Avoid Unpaved Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 11, "AttributeName": "Driving a Bus", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 12, "AttributeName": "Driving a Delivery Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 13, "AttributeName": "Driving a Taxi", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 14, "AttributeName": "Driving a Truck", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 15, "AttributeName": "Driving an Automobile", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 16, "AttributeName": "Driving an Emergency Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 17, "AttributeName": "Height Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 18, "AttributeName": "Height Restriction", "ParameterName": "Vehicle Height (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 19, "AttributeName": "Length Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 20, "AttributeName": "Length Restriction", "ParameterName": "Vehicle Length (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 21, "AttributeName": "Through Traffic Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" } }, { "attributes": { "OBJECTID": 22, "AttributeName": "Use Preferred Hazmat Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 23, "AttributeName": "Use Preferred Truck Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 24, "AttributeName": "WalkTime", "ParameterName": "Walking Speed (km/h)", "ParameterValue": "5" } }, { "attributes": { "OBJECTID": 25, "AttributeName": "Walking", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 26, "AttributeName": "Weight Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 27, "AttributeName": "Weight Restriction", "ParameterName": "Vehicle Weight (kilograms)", "ParameterValue": "0" } } ], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "populate_route_lines", "dataType": "GPBoolean", "displayName": "Populate Route Lines", "description": "Specifies whether the output route line will be generated. Checked (True)\u2014The output routes will have the\nexact shape of the underlying streets. Unchecked (False)\u2014No shape is generated for the\noutput routes, yet the routes will still contain tabular information about the solution. You can't generate driving directions if\nroute lines aren't created. When the Route Shape parameter is set to True Shape, the\ngeneralization of the route shape can be further controlled using\nthe appropriate values for the Route Line Simplification Tolerance\nparameter. No matter which value you choose for the Route Shape\nparameter, the best routes are always determined by minimizing the\ntravel along the streets, never using the straight-line\ndistance. This means that only the route shapes are different,\nnot the underlying streets that are searched when finding the\nroute.", "direction": "esriGPParameterDirectionInput", "defaultValue": true, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "route_line_simplification_tolerance", "dataType": "GPLinearUnit", "displayName": "Route Line Simplification Tolerance", "description": "The amount by which the geometry of the output lines will be simplified for routes and directions.The value provided for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.The tool ignores this parameter if the populate_route_lines parameter is unchecked (False). Simplification maintains critical\npoints on a route, such as turns at intersections, to define the\nessential shape of the route and removes other points. The\nsimplification distance you specify is the maximum allowable offset\nthat the simplified line can deviate from the original line.\nSimplifying a line reduces the number of vertices that are part of\nthe route geometry. This improves the tool execution\ntime.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "distance": 10, "units": "esriMeters" }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "populate_directions", "dataType": "GPBoolean", "displayName": "Populate Directions", "description": "Specifies whether the tool will generate driving directions for\neach route. Checked (True in Python)\u2014Directions will be generated\nand configured based on the values of the Directions Language,\nDirections Style Name, and Directions Distance Units parameters. Unchecked (False in Python)\u2014Directions will not be generated, and the tool\nwill return an empty Directions layer.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "directions_language", "dataType": "GPString", "displayName": "Directions Language", "description": "The language that will be used when generating\ntravel directions. This parameter is used only when the Populate\nDirections parameter is checked (True in Python). The parameter value can be\nspecified using one of the following two- or five-character language codes: ar\u2014Arabic bs\u2014Bosnian ca\u2014Catalancs\u2014Czech da\u2014Danish de\u2014German el\u2014Greek en\u2014English es\u2014Spanish et\u2014Estonian fi\u2014Finnish fr\u2014French he\u2014Hebrew hr\u2014Croatian hu\u2014Hungarian id\u2014Indonesian it\u2014Italian ja\u2014Japanese ko\u2014Korean lt\u2014Lithuanian lv\u2014Latvian nb\u2014Norwegian nl\u2014Dutch pl\u2014Polish pt-BR\u2014Brazilian\nPortuguese pt-PT\u2014European\nPortuguese ro\u2014Romanian ru\u2014Russian sl\u2014Slovenian sr\u2014Serbian sv\u2014Swedish th\u2014Thaitr\u2014Turkishuk\u2014Ukrainian vi\u2014Vietnamese zh-CN\u2014Simplified\nChinese zh-HK\u2014Traditional Chinese (Hong Kong)\n zh-TW\u2014Traditional Chinese (Taiwan)\nThe tool first searches for an exact match for the specified language including any language localization. If an exact match is not found, it tries to match the language family. If a match is still not found, the tool returns the directions using the default language, English. For example, if the directions language is specified as es-MX (Mexican Spanish), the tool will return the directions in Spanish, as it supports the es language code but not es-MX.If a language supports localization, such as Brazilian Portuguese (pt-BR) and European Portuguese (pt-PT), specify the language family and the localization. If you only specify the language family, the tool will not match the language family and instead return directions in the default language, English. For example, if the directions language specified is pt, the tool will return the directions in English since it cannot determine whether the directions should be returned in pt-BR or pt-PT.", "direction": "esriGPParameterDirectionInput", "defaultValue": "en", "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "directions_style_name", "dataType": "GPString", "displayName": "Directions Style Name", "description": "Specifies the name of the formatting style for the\ndirections. This parameter is used only when the Populate Directions parameter is checked (True in Python). NA Desktop\u2014Turn-by-turn directions suitable\nfor printing. NA Navigation\u2014Turn-by-turn directions designed\nfor an in-vehicle navigation device.NA Campus\u2014Turn-by-turn walking directions designed\nfor pedestrian routes.", "direction": "esriGPParameterDirectionInput", "defaultValue": "NA Desktop", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "NA Desktop", "NA Navigation", "NA Campus" ] }, { "name": "travel_mode", "dataType": "GPString", "displayName": "Travel Mode", "description": "The mode of transportation to model in the analysis. Travel modes are managed in ArcGIS Online and can be configured by the administrator of your organization to reflect your organization's workflows. You need to specify the name of a travel mode that is supported by your organization. To get a list of supported travel mode names, run the Get Travel Modes tool from the Utilities toolbox under the same GIS Server connection you used to access the tool. The Get Travel Modes tool adds a table, Supported Travel Modes, to the application. Any value in the Travel Mode Name field from the Supported Travel Modes table can be specified as input. You can also specify the value from the Travel Mode Settings field as input. This speeds up tool execution, as the tool does not have to find the settings based on the travel mode name. The default value, Custom, allows you to configure your own travel mode using the custom travel mode parameters (UTurn at Junctions, Use Hierarchy, Restrictions, Attribute Parameter Values, and Impedance). The default values of the custom travel mode parameters model traveling by car. You can also choose Custom and set the custom travel mode parameters listed above to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You can try different settings to get the analysis results you want. Once you have identified the analysis settings, work with your organization's administrator and save these settings as part of a new or existing travel mode so that everyone in your organization can run the analysis with the same settings. When you choose Custom, the values you set for the custom travel mode parameters are included in the analysis. Specifying another travel mode, as defined by your organization, causes any values you set for the custom travel mode parameters to be ignored; the tool overrides them with values from your specified travel mode.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Custom", "parameterType": "esriGPParameterTypeOptional", "category": "" }, { "name": "impedance", "dataType": "GPString", "displayName": "Impedance", "description": "Specifies the \nimpedance, which is a value that represents the effort or cost of traveling along road segments or on other parts of the transportation network. Travel time is an impedance: a car may take 1 minute to travel a mile along an empty road. Travel times can vary by travel mode\u2014a pedestrian may take more than 20 minutes to walk the same mile, so it is important to choose the right impedance for the travel mode you are modeling. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.Choose from the following impedance values:TravelTime\u2014Historical and live traffic data is used. This option is good for modeling the time it takes automobiles to travel along roads at a specific time of day using live traffic speed data where available. When using TravelTime, you can optionally set the TravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the vehicle is capable of traveling.Minutes\u2014Live traffic data is not used, but historical average speeds for automobiles data is used.TruckTravelTime\u2014Historical and live traffic data is used, but the speed is capped at the posted truck speed limit. This is good for modeling the time it takes for the trucks to travel along roads at a specific time. When using TruckTravelTime, you can optionally set the TruckTravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the truck is capable of traveling.TruckMinutes\u2014Live traffic data is not used, but the smaller of the historical average speeds for automobiles and the posted speed limits for trucks are used.WalkTime\u2014The default is a speed of 5 km/hr on all roads and paths, but this can be configured through the WalkTime::Walking Speed (km/h) attribute parameter.TimeAt1KPH\u2014The default is a speed of 1 km/hr on all roads and paths. The speed cannot be changed using any attribute parameter.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.Drive Time, Truck Time, and Walk Time impedance values are no longer supported and will be removed in a future release. If you use one of these values, the tool uses the value of the Time Impedance parameter.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Drive Time", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Drive Time", "Truck Time", "Walk Time", "Minutes", "TravelTime", "TruckTravelTime", "TimeAt1KPH", "WalkTime" ] }, { "name": "time_zone_usage_for_time_fields", "dataType": "GPString", "displayName": "Time Zone Usage for Time Fields", "description": "Specifies the time zone for the input date-time fields supported by the tool. This parameter specifies the time zone for the following fields: TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, TimeWindowEnd2, InboundArriveTime, and OutboundDepartTime on orders. TimeWindowStart1, TimeWindowEnd1, TimeWindowStart2, and TimeWindowEnd2 on depots. EarliestStartTime and LatestStartTime on routes. TimeWindowStart and TimeWindowEnd on breaks.\nGEO_LOCAL\u2014The date-time values associated with the orders or depots are in the time zone in which the orders and depots are located. For routes, the date-time values are based on the time zone in which the starting depot for the route is located. If a route does not have a starting depot, all orders and depots across all the routes must be in a single time zone. For breaks, the date-time values are based on the time zone of the routes. For example, if your depot is located in an area that follows eastern standard time and has the first time window values (specified as TimeWindowStart1 and TimeWindowEnd1) of 8 AM and 5 PM, the time window values will be treated as 8:00 a.m. and 5:00 p.m. eastern standard time.UTC\u2014The date-time values associated with the orders or depots are in coordinated universal time (UTC) and are not based on the time zone in which the orders or depots are located. For example, if your depot is located in an area that follows eastern standard time and has the first time window values (specified as TimeWindowStart1 and TimeWindowEnd1) of 8 AM and 5 PM, the time window values will be treated as 12:00 p.m. and 9:00 p.m. eastern standard time, assuming eastern standard time is obeying daylight saving time. Specifying the date-time values in UTC is useful if you do not know the time zone in which the orders or depots are located or if you have orders and depots in multiple time zones, and you want all the date-time values to start simultaneously. The UTC option is applicable only when your network dataset defines a time zone attribute. Otherwise, all the date-time values are always treated as GEO_LOCAL.", "direction": "esriGPParameterDirectionInput", "defaultValue": "GEO_LOCAL", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "GEO_LOCAL", "UTC" ] }, { "name": "save_output_layer", "dataType": "GPBoolean", "displayName": "Save Output Network Analysis Layer", "description": "Specifies whether the analysis settings will be saved as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application such as ArcMap. It is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.\nChecked (True)\u2014The network analysis layer file will be saved. The file is downloaded in a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False)\u2014The network analysis layer file will not be saved. This is the default.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "overrides", "dataType": "GPString", "displayName": "Overrides", "description": "Additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.\n The value for this parameter must be specified in JavaScript Object Notation (JSON). For example, a valid value is of the following form: {\"overrideSetting1\" : \"value1\", \"overrideSetting2\" : \"value2\"}. The override setting name is always enclosed in double quotation marks. The values can be a number, Boolean, or string. The default value for this parameter is no\nvalue, which indicates not to override any solver\nsettings. Overrides are advanced settings that should be\nused only after careful analysis of the results obtained before and\nafter applying the settings. For a list of supported override settings\nfor each solver and their acceptable values, contact Esri Technical Support.", "direction": "esriGPParameterDirectionInput", "defaultValue": "", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "save_route_data", "dataType": "GPBoolean", "displayName": "Save Route Data", "description": "Specifies whether the output includes a .zip file\nthat contains a file geodatabase with the inputs and outputs of\nthe analysis in a format that can be used to share route layers\nwith ArcGIS Online or Portal for ArcGIS.Checked (True)\u2014The route data will be saved as a .zip file. The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Route Data parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False)\u2014The route data will not be saved. This is the default.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "time_impedance", "dataType": "GPString", "displayName": "Time Impedance", "description": "The time-based impedance is a value that represents the travel time along road segments or on other parts of the transportation network.If the impedance for the travel mode, as specified using the Impedance parameter, is time based, the values for the Time Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.", "direction": "esriGPParameterDirectionInput", "defaultValue": "TravelTime", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Minutes", "TravelTime", "TruckTravelTime", "TimeAt1KPH", "WalkTime" ] }, { "name": "distance_impedance", "dataType": "GPString", "displayName": "Distance Impedance", "description": "If the impedance for the travel mode, as specified using the Impedance parameter, is distance based, the values for the Distance Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.The distance-based impedance is a value that represents the travel distance along road segments or on other parts of the transportation network.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Miles", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Kilometers", "Miles" ] }, { "name": "populate_stop_shapes", "dataType": "GPBoolean", "displayName": "Populate Stop Shapes", "description": "Specifies whether the tool will create the shapes for the output assigned and unassigned stops.\nChecked (True)\u2014The output assigned and unassigned stops are created as point features. This can be useful to visualize which stops are assigned to routes and which stops could not be assigned to any route.Unchecked (False)\u2014The output assigned and unassigned stops are created as tables and will not have shapes. This is the default. Use this option only if you don't need your application to visualize the output stops and can work with only the attributes of the stops.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "output_format", "dataType": "GPString", "displayName": "Output Format", "description": "Specifies the format in which the output features will be created. \nFeature Set\u2014The output features will be returned as feature classes and tables. This is the default. JSON File\u2014The output features will be returned as a compressed file containing the JSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more JSON files (with a .json extension) for each of the outputs created by the service. GeoJSON File\u2014The output features will be returned as a compressed file containing the GeoJSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more GeoJSON files (with a .geojson extension) for each of the outputs created by the service.When a file-based output format, such as JSON File or GeoJSON File, is specified, no outputs will be added to the display because the application, such as ArcMap or ArcGIS Pro, cannot draw the contents of the result file. Instead, the result file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Result File parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Result File parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Feature Set", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "Feature Set", "JSON File", "GeoJSON File" ] }, { "name": "ignore_invalid_order_locations", "dataType": "GPBoolean", "displayName": "Ignore Invalid Order Locations", "description": "Specifies whether invalid orders will be ignored when solving the vehicle routing problem.\nChecked (True)\u2014The solve operation will ignore any invalid orders and return a solution, as long as it didn't encounter any other errors. If you need to generate routes and deliver them to drivers immediately, you may be able to ignore invalid orders, solve, and distribute the routes to your drivers. Then resolve any invalid orders from the last solve and include them in the VRP analysis for the next workday or work shift.Unchecked (False)\u2014The solve operation will fail when any invalid orders are encountered. An invalid order is an order that the VRP solver can't reach. An order may be unreachable for a variety of reasons, including when the order is located on a prohibited network element, isn't on the network at all, or is on a disconnected part of the network.", "direction": "esriGPParameterDirectionInput", "defaultValue": true, "parameterType": "esriGPParameterTypeOptional", "category": "Network Locations" }, { "name": "ignore_network_location_fields", "dataType": "GPBoolean", "displayName": "Ignore Network Location Fields", "description": "Specifies whether the network location fields will be considered when locating inputs such as stops or facilities on the network.\nChecked (True in Python)\u2014Network location fields will not be considered when locating the inputs on the network. Instead, the inputs will always be located by performing a spatial search. This is the default value.Unchecked (False in Python)\u2014Network location fields will be considered when locating the inputs on the network.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Network Locations" }, { "name": "out_unassigned_stops", "dataType": "GPRecordSet", "displayName": "Output Unassigned Stops", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "StopType", "type": "esriFieldTypeSmallInteger", "alias": "StopType" }, { "name": "ViolatedConstraints", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraints" }, { "name": "ViolatedConstraint_1", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_1" }, { "name": "ViolatedConstraint_2", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_2" }, { "name": "ViolatedConstraint_3", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_3" }, { "name": "ViolatedConstraint_4", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_4" }, { "name": "Status", "type": "esriFieldTypeInteger", "alias": "Status" }, { "name": "ORIG_FID", "type": "esriFieldTypeInteger", "alias": "ORIG_FID" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_stops", "dataType": "GPRecordSet", "displayName": "Output Stops", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "PickupQuantities", "type": "esriFieldTypeString", "alias": "PickupQuantities", "length": 128 }, { "name": "DeliveryQuantities", "type": "esriFieldTypeString", "alias": "DeliveryQuantities", "length": 128 }, { "name": "StopType", "type": "esriFieldTypeSmallInteger", "alias": "StopType" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "Sequence", "type": "esriFieldTypeInteger", "alias": "Sequence" }, { "name": "FromPrevTravelTime", "type": "esriFieldTypeDouble", "alias": "FromPrevTravelTime" }, { "name": "FromPrevDistance", "type": "esriFieldTypeDouble", "alias": "FromPrevDistance" }, { "name": "ArriveCurbApproach", "type": "esriFieldTypeInteger", "alias": "ArriveCurbApproach" }, { "name": "DepartCurbApproach", "type": "esriFieldTypeInteger", "alias": "DepartCurbApproach" }, { "name": "ArriveTime", "type": "esriFieldTypeDate", "alias": "ArriveTime", "length": 16 }, { "name": "DepartTime", "type": "esriFieldTypeDate", "alias": "DepartTime", "length": 16 }, { "name": "ArriveTimeUTC", "type": "esriFieldTypeDate", "alias": "ArriveTimeUTC", "length": 16 }, { "name": "DepartTimeUTC", "type": "esriFieldTypeDate", "alias": "DepartTimeUTC", "length": 16 }, { "name": "WaitTime", "type": "esriFieldTypeDouble", "alias": "WaitTime" }, { "name": "ViolationTime", "type": "esriFieldTypeDouble", "alias": "ViolationTime" }, { "name": "SnapX", "type": "esriFieldTypeDouble", "alias": "SnapX" }, { "name": "SnapY", "type": "esriFieldTypeDouble", "alias": "SnapY" }, { "name": "SnapZ", "type": "esriFieldTypeDouble", "alias": "SnapZ" }, { "name": "DistanceToNetworkInMeters", "type": "esriFieldTypeDouble", "alias": "DistanceToNetworkInMeters" }, { "name": "ORIG_FID", "type": "esriFieldTypeInteger", "alias": "ORIG_FID" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_routes", "dataType": "GPFeatureRecordSetLayer", "displayName": "Output Routes", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": { "displayFieldName": "", "hasM": true, "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 1024 }, { "name": "ViolatedConstraints", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraints" }, { "name": "ViolatedConstraint_1", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_1" }, { "name": "ViolatedConstraint_2", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_2" }, { "name": "ViolatedConstraint_3", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_3" }, { "name": "ViolatedConstraint_4", "type": "esriFieldTypeInteger", "alias": "ViolatedConstraint_4" }, { "name": "OrderCount", "type": "esriFieldTypeInteger", "alias": "OrderCount" }, { "name": "TotalCost", "type": "esriFieldTypeDouble", "alias": "TotalCost" }, { "name": "RegularTimeCost", "type": "esriFieldTypeDouble", "alias": "RegularTimeCost" }, { "name": "OvertimeCost", "type": "esriFieldTypeDouble", "alias": "OvertimeCost" }, { "name": "DistanceCost", "type": "esriFieldTypeDouble", "alias": "DistanceCost" }, { "name": "TotalTime", "type": "esriFieldTypeDouble", "alias": "TotalTime" }, { "name": "TotalOrderServiceTime", "type": "esriFieldTypeDouble", "alias": "TotalOrderServiceTime" }, { "name": "TotalBreakServiceTime", "type": "esriFieldTypeDouble", "alias": "TotalBreakServiceTime" }, { "name": "TotalTravelTime", "type": "esriFieldTypeDouble", "alias": "TotalTravelTime" }, { "name": "TotalDistance", "type": "esriFieldTypeDouble", "alias": "TotalDistance" }, { "name": "StartTime", "type": "esriFieldTypeDate", "alias": "StartTime", "length": 16 }, { "name": "EndTime", "type": "esriFieldTypeDate", "alias": "EndTime", "length": 16 }, { "name": "StartTimeUTC", "type": "esriFieldTypeDate", "alias": "StartTimeUTC", "length": 16 }, { "name": "EndTimeUTC", "type": "esriFieldTypeDate", "alias": "EndTimeUTC", "length": 16 }, { "name": "TotalWaitTime", "type": "esriFieldTypeDouble", "alias": "TotalWaitTime" }, { "name": "TotalViolationTime", "type": "esriFieldTypeDouble", "alias": "TotalViolationTime" }, { "name": "RenewalCount", "type": "esriFieldTypeInteger", "alias": "RenewalCount" }, { "name": "TotalRenewalServiceTime", "type": "esriFieldTypeDouble", "alias": "TotalRenewalServiceTime" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_directions", "dataType": "GPFeatureRecordSetLayer", "displayName": "Output Directions", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": { "displayFieldName": "", "hasM": true, "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "ObjectID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "RouteName", "type": "esriFieldTypeString", "alias": "RouteName", "length": 1024 }, { "name": "ArriveTime", "type": "esriFieldTypeDate", "alias": "ArriveTime" }, { "name": "SubItemType", "type": "esriFieldTypeSmallInteger", "alias": "SubItemType" }, { "name": "Type", "type": "esriFieldTypeSmallInteger", "alias": "Type" }, { "name": "Text", "type": "esriFieldTypeString", "alias": "Text", "length": 1024 }, { "name": "ElapsedTime", "type": "esriFieldTypeSingle", "alias": "ElapsedTime" }, { "name": "DriveDistance", "type": "esriFieldTypeSingle", "alias": "DriveDistance" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "solve_succeeded", "dataType": "GPBoolean", "displayName": "Solve Succeeded", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_network_analysis_layer", "dataType": "GPDataFile", "displayName": "Output Network Analysis Layer", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_route_data", "dataType": "GPDataFile", "displayName": "Output Route Data", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "out_result_file", "dataType": "GPDataFile", "displayName": "Output Result File", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "output_network_analysis_layer_package", "dataType": "GPDataFile", "displayName": "Output Network Analysis Layer Package", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" } ] }