arcgis.network.analysis module

orders

Required FeatureSet. Specify one or more orders (up to 2,000). These are the locations that the routes of the vehicle routing problem (VRP) analysis should 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).

routes

Required FeatureSet. Specify one or more routes (up to 100). A route specifies vehicle and driver characteristics; after solving, it also represents the path between depots and orders.

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. When specifying the routes, you can set properties for each one by using attributes.

time_units

Optional String. The time units for all time-based field values in the analysis. Allowed values: Seconds, Minutes, Hours, or Days

analysis_region

Optional String. Specify the region in which to perform the analysis. If a value is not specified for this parameter, the tool will automatically calculate the region name based on the location of the input points.

uturn_policy

Optional String. Use this parameter to restrict or permit the service area to make U-turns at junctions.

The parameter can have the following values:

• ALLOW_UTURNS-U - turns are permitted everywhere. Allowing

U-turns implies that the vehicle can turn around at any junction and double back on the same street. This is the default value.

• NO_UTURNS-U - turns are prohibited at all junctions: pseudo-junctions, intersections, and dead-ends.

Note, however, that U-turns may be permitted even when this option is chosen.

• ALLOW_DEAD_ENDS_ONLY-U - turns are prohibited at all junctions, except those that have only one connected street feature (a dead end).

• ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY-U - turns are prohibited at pseudo-junctions where exactly two adjacent streets meet, but U-turns are permitted

at intersections and dead ends. This prevents turning around in the middle of the road where one length of road happened 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.

spatially_cluster_routes

Optional Boolean. If true, the dynamic seed points are automatically created for all routes and the orders assigned to an individual route are spatially clustered. This will reduce route intersections. When using route_zones set this parameter to False.

route_renewals

Optional FeatureSet . Specifies the intermediate depots that routes can visit to reload or unload the cargo they are delivering or picking up.

excess_transit_factor

Optional String. Rates the importance of reducing excess transit time of order pairs. Excess transit time is the amount of time exceeding the time required to travel directly between the paired orders. Excess time can be caused by driver breaks or travel to intermediate orders and depots. Allowed values: High, Medium or Low.

line_barriers

Optional FeatureSet . Specify polylines that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

use_hierarchy_in_analysis

Optional Boolean. Specify whether hierarchy should be used when finding the best routes. True means use hierarchy when finding routes.

attribute_parameter_values

Optional Dict. Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction.

route_line_simplification_tolerance

Optional Float. Specify by how much you want to simplify the geometry of the output lines for routes and directions.The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.The tool also ignores this parameter if the populate_route_lines parameter is false. Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points.

directions_language

Optional String. Determines the output language of the directions.

travel_mode

Optional String. Specify the mode of transportation to model in the analysis.

time_zone_usage_for_time_fields

Optional String. Specifies the time zone for the input date-time fields supported by the tool. The default is GEO_LOCAL.

overrides

Optional Dict. Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.

time_impedance

Optional String. Specify the time-based impedance, which 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 value for time_impedance and impedance parameters should be identical. Otherwise the service will return an error.

populate_stop_shape

Optional Boolean. Specify if the tool should create the shapes for the output assigned and unassigned stops.

gis

Optional GIS . If provided this connection is used to perform the operation.

ignore_network_location_fields

Optional bool, Specifies whether the network location fields will be considered when locating inputs such as stops or facilities on the network.

• True - Network 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.

• False - Network location fields will be considered when locating the inputs on the network.

incidents

Required FeatureSet . Specify one or more incidents (up to 1,000). These are the locations from which the tool searches for the nearby locations. When specifying the incidents, you can set properties for each one, such as its name or service time, by using attributes. The incidents can be specified with the following attributes:

• Name - The name of the incident. The name is used in the driving directions. If the name is not specified, a unique name prefixed with Location is automatically generated in the output routes and directions.

• ID - A unique identifier for the incident. The identifier is included in the output routes (as the IncidentID field) and can help join additional information from the output routes, such as the total travel time or total distance, to attributes from your incidents or vice versa. If the ID isn’t specified, the service autogenerates a unique identifier for each incident.

• AdditionalTime-The amount of time spent at the incident, which is added to the total time of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are time based. The default value is 0. If you are finding the closest fire stations from fire incidents to estimate response times, the AdditionalTime attribute can store the amount of time it takes firefighters to hook up their equipment at the location of the incident before they can begin fighting the fire.

• AdditionalDistance- The extra distance traveled at the incident, which is added to the total distance of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are distance based. The default value is 0. Generally, the location of an incident, such as a home, isn’t exactly on the streets; it is set back somewhat from the road. This attribute value can be used to model the distance between the actual incident location and its location on the street, if it is important to include that distance in the total travel distance.

• CurbApproach - Specifies the direction a vehicle may arrive at and depart from the incident. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  Setting	Description
  Either side of vehicle	The vehicle can approach and depart the order in either direction, so a U-turn is allowed at the order. This setting can be chosen if it is possible and desirable for your 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 pull in and turn around.
  right side of vehicle	When 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 like buses that must arrive with the bus stop on the right side.
  left side of vehicle	When the vehicle approaches and departs the order, the curb must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like buses that must arrive with the bus stop on the left-hand side.
  No U-Turn	When the vehicle approaches the order, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around.

  The CurbApproach property 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 incident 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 incident 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 incident and not have a lane of traffic between the vehicle and the incident, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

• Attr_TravelTime: Specifies the amount of time for cars, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to model the time spent at the incident. For example, if you are finding the three closest fire stations from a fire incident, the attribute can store the amount of time spent at the fire incident. This could be the time it takes for firefighters to hook up their equipment and begin fighting the fire. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

• Attr_TruckTravelTime: Specifies the amount of time for trucks, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to model the time spent at the incident. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

• Attr_WalkTime: Specifies the amount of time for pedestrians, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to model the time spent at the incident. The value for this attribute is included in the total travel time for the route and is also displayed in walking directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

• Attr_Miles: Specifies the distance in miles that will be added to the total distance of the route between the incident and the closest facility. Generally the locations of the incidents are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual incident location and its location on the street if it is important to include that distance in the total travel distance. The default value is 0.

• Attr_Kilometers: Specifies the distance in kilometers that will added to the total distance of the route between the incident and the closest facility. Generally the locations of the incidents are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual incident location and its location on the street if it is important to include that distance in the total travel distance. The default value is 0.

• Cutoff_TravelTime: Specify the travel time for cars, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_TravelTime is not set for an incident, the service will use the value specified as the defa``ultCutoff parameter. The value for the Cutoff_TravelTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_TruckTravelTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_TruckTravelTime is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TruckTravelTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_WalkTime: Specify the travel time for pedestrians, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_WalkTime is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_WalkTime attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_Miles: Specify the travel distance in miles at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_Miles is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Miles attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_Kilometers: Specify the travel distance in kilometers at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_Kilometers is not set for an incident, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Kilometers attribute allows the ability to overwrite the defaultCutoff value on a per incident basis. The default value for this attribute is null which indicates not to use any cutoff.

• TargetFacilityCount: Specify the number of facilities that need to be found for the incident. If TargetFacilityCount is not set for an incident, the service will use the value specified as the defaultTargetFacilityCount parameter. The value for the TargetFacilityCount attribute allows the ability to overwrite the defaultTargetFacilityCount value on a per incident basis. The default value for this attribute is null which causes the service to use the value set for the defaultTargetFacilityCount parameter. If the TargetFacilityCount attribute is set to a value other than null, the defaultTargetFacilityCount value is overwritten.

• Bearing: Specify the direction the vehicle or person is moving in. Bearing is measured clockwise from true north and must be in degrees. Typically, values are between 0 and 360; however, negative values are interpreted by subtracting them from 360 degrees.

• BearingTol: Short for bearing tolerance, this field specifies the maximum acceptable difference between the heading of a vehicle and a tangent line from the point on a street where Network Analyst attempts to locate the vehicle. The bearing tolerance is used to determine whether the direction in which a vehicle is moving generally aligns with the underlying road. If they align within the given tolerance, the vehicle is located on that edge; if not, the next nearest eligible edge is evaluated.

facilities

Required FeatureSet . Specify one or more facilities (up to 1,000). These are the locations that are searched for when finding the closest location. mWhen specifying the facilities, you can set properties for each one, such as its name or service time, by using attributes. The facilities can be specified with the following attributes:

• Name - The name of the facility. The name is used in the driving directions. If the name is not specified, a unique name prefixed with Location is automatically generated in the output routes and directions.

• ID - A unique identifier for the facility. The identifier is included in the output routes (as the FacilityID field) and the output closest facilities as FacilityID fields. The FacilityID field can be used to join additional information from the output routes, such as the total travel time or total distance, to attributes from your facilities. If the ID isn’t specified, the service autogenerates a unique identifier for each facility.

• AdditionalTime-The amount of time spent at the facility, which is added to the total time of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are time based. The default value is 0. If you are finding the closest fire stations to fire incidents, AdditionalTime can store the time it tends to takes a crew to don the appropriate protective equipment and exit the fire station.

• AdditionalDistance - The extra distance traveled at the facility, which is added to the total distance of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are distance based. The default value is 0. Generally the location of a facility, such as a fire station, isn’t exactly on a street; it is set back somewhat from the road. AdditionalDistance can model the distance between the actual facility location and its location on the street, if it is important to include that distance in the total travel distance.

• CurbApproach: Specifies the direction a vehicle may arrive at and depart from the facility. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  Setting	Description
  Either side of vehicle	The vehicle can approach and depart the order in either direction, so a U-turn is allowed at the order. This setting can be chosen if it is possible and desirable for your 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 pull in and turn around.
  right side of vehicle	When 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 like buses that must arrive with the bus stop on the right side.
  left side of vehicle	When the vehicle approaches and departs the order, the curb must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like buses that must arrive with the bus stop on the left-hand side.
  No U-Turn	When the vehicle approaches the order, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around.

  The CurbApproach property was designed to work with both kinds 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, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the facility, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

• Attr_TravelTime: Specifies the amount of time for cars, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The attribute value can be used to specify the turnout time for the facility. For example, when finding the three closest fire stations from a fire incident, this attribute can be used to store the time it takes a crew to don the appropriate protective equipment and exit the fire station. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

• Attr_TruckTravelTime: Specifies the amount of time for trucks, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

• Attr_WalkTime: Specifies the amount of time for pedestrians, in minutes, that will be added to the total travel time of the route between the incident and the closest facility. The value for this attribute is included in the total travel time for the route and is also displayed in walking directions as service time. A zero or null value indicates that the facility requires no service time. The default value is 0.

• Attr_Miles: Specifies the distance in miles that will added to the total distance of the route between the incident and the closest facility. Generally the locations of the facilities are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual facility location and its location on the street if it is important to include that distance in the total travel distance. The default value is 0.

• Attr_Kilometers: Specifies the distance in kilometers that will added to the total distance of the route between the incident and the closest facility. Generally the locations of the facilities are not exactly on the streets but are set back somewhat from the road. This attribute value can be used to model the distance between the actual facility location and its location on the street if it is important to include that distance in the total travel distance. The default value is 0.

• Cutoff_TravelTime: Specify the travel time for cars, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_TravelTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TravelTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_TruckTravelTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_TruckTravelTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_TruckTravelTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_WalkTime: Specify the travel time for trucks, in minutes, at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. Cutoff_WalkTime is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_WalkTime attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_Miles: Specify the travel distance in miles at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_Miles is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Miles attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

• Cutoff_Kilometers: Specify the travel distance in kilometers at which to stop searching for facilities for a given incident. Any incident beyond the cutoff value will not be searched. If Cutoff_Kilometers is not set for a facility, the service will use the value specified as the defaultCutoff parameter. The value for the Cutoff_Kilometers attribute allows the ability to overwrite the defaultCutoff value on a per facility basis. The default value for this attribute is null which indicates not to use any cutoff.

• Bearing: Specify the direction the vehicle or person is moving in. Bearing is measured clockwise from true north and must be in degrees. Typically, values are between 0 and 360; however, negative values are interpreted by subtracting them from 360 degrees.

• BearingTol: Short for bearing tolerance, this field specifies the maximum acceptable difference between the heading of a vehicle and a tangent line from the point on a street where Network Analyst attempts to locate the vehicle. The bearing tolerance is used to determine whether the direction in which a vehicle is moving generally aligns with the underlying road. If they align within the given tolerance, the vehicle is located on that edge; if not, the next nearest eligible edge is evaluated.

measurement_units

Required parameter. Specify the units that should be used to measure and report the total travel time or travel distance for the output routes. The tool finds the closest facility by measuring the travel time or the travel distance along streets. The units you choose for this parameter determine whether the tool will measure driving distance or driving time to find what is closest. Choose a time unit to measure driving time. To measure driving distance, choose a distance unit. Your choice also determines in which units the tool will report total driving time or distance in the results.

Choice list:[‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘Nautical Miles’, ‘Seconds’, ‘Minutes’, ‘Hours’, ‘Days’]

number_of_facilities_to_find

Optional integer. Specify the number of closest facilities to find per incident. This is useful in situations, such as a fire, where multiple fire engines may be required from different fire stations. You can specify, for example, to find the three nearest fire stations to a fire. The tool can find up to 100 facilities from each incident.

travel_direction

Optional string. Specify whether you want to search for the closest facility as measured from the incident to the facility or from the facility to the incident.

• Facility to Incident - Direction of travel is from facilities to incidents.

• Incident to Facility - Direction of travel is from incidents to facilities.

Using one of the parameter values can find different facilities as the travel time along some streets may vary based on the travel direction and one-way restrictions. For instance, a facility may be a 10-minute drive from the incident while traveling from the incident to the facility, but while traveling from the facility to the incident, it may be a 15-minute journey because of different travel time in that direction. If you are setting a value for Time of Day, traffic may also cause the Facility to Incident and Incident to Facility options to return different results.

Fire departments commonly use the Facility to Incident value for the parameter since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident). A retail store (facility) is more concerned with the time it takes the shoppers (incidents) to reach the store; therefore, stores commonly choose Incident to Facility.

Choice list: [‘Incident to Facility’, ‘Facility to Incident’]

time_of_day

Optional datetime. Specifies the time and date at which the routes should begin or end. The value is used as the start time or end time for the route depending on the value for the Time of Day Usage parameter. If you specify the current date and time as the value for this parameter, the tool will use live traffic conditions to find the closest facilities and the total travel time will be based on traffic conditions.

Specifying a time of day results in more accurate estimation of travel time between the incident and facility because the travel times account for the traffic conditions that are applicable for that date and time. The Time Zone for Time of Day parameter specifies whether this time and date refer to UTC or the time zone in which the facility or incident is located.

uturn_at_junctions

Optional string. The U-Turn policy at junctions. Allowing U-turns implies the solver can turn around at a junction and double back on the same street.

Given that junctions represent street intersections and dead ends, different vehicles may be able to turn around at some junctions but not at others-it depends on whether the junction represents an intersection or dead end. To accommodate, the U-turn policy parameter is implicitly specified by how many edges connect to the junction, which is known as junction valency. The acceptable values for this parameter are listed below; each is followed by a description of its meaning in terms of junction valency. Allowed-U-turns are permitted at junctions with any number of connected edges. This is the default value. Not Allowed-U-turns are prohibited at all junctions, regardless of junction valency. Note, however, that U-turns are still permitted at network locations even when this setting is chosen; however, you can set the individual network locations’ CurbApproach property to prohibit U-turns there as well. Allowed only at Dead Ends-U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end). Allowed only at Intersections and Dead Ends-U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge). Oftentimes, networks have extraneous junctions in the middle of road segments. This option prevents vehicles from making U-turns at these locations.

Choice list: [‘Allowed’, ‘Not Allowed’, ‘Allowed Only at Dead Ends’, ‘Allowed Only at Intersections and Dead Ends’]

line_barriers

Optional FeatureSet . Specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. A line barrier can also quickly fence off several roads from being traversed, thereby channeling possible routes away from undesirable parts of the street network.

The tool imposes a limit on the number of streets you can restrict using the Line Barriers parameter. While there is no limit on the number of lines you can specify as line barriers, the combined number of streets intersected by all the lines cannot exceed 500. When specifying the line barriers, you can set a name property for each one by using the following attribute:

• Name: The name of the barrier.

restrictions

Optional string. Specify which restrictions should be honored by the tool when finding the best routes between incidents and facilities. A restriction represents a driving preference or requirement. In most cases, restrictions cause roads to be prohibited, but they can also cause them to be avoided or preferred. For instance, using an Avoid Toll Roads restriction will result in a route that will include toll roads only when it is absolutely required to travel on toll roads in order 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 as illegal to do so. Below is a list of available restrictions and a short description. Some restrictions require an additional value to be specified for their desired use. This value needs to be associated with the restriction name and a specific parameter intended to work with the restriction. You can identify such restrictions if their names appear under the AttributeName column in the Attribute Parameter Values parameter. The ParameterValue field should be specified in the Attribute Parameter Values parameter for the restriction 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 check whether the restriction is available in a particular country by looking at the table in the Country List section of the Data coverage for network analysis services web page. 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 whose Restriction Usage parameter value is between 0 and 1 (see the Attribute Parameter Value parameter). It prohibits all restrictions whose Restriction Usage parameter value is greater than 0. The tool supports the following restrictions:

Choice list:[‘Any Hazmat Prohibited’, ‘Avoid Carpool Roads’, ‘Avoid Express Lanes’, ‘Avoid Ferries’, ‘Avoid Gates’, ‘Avoid Limited Access Roads’, ‘Avoid Private Roads’, ‘Avoid Roads Unsuitable for Pedestrians’, ‘Avoid Stairways’, ‘Avoid Toll Roads’, ‘Avoid Toll Roads for Trucks’, ‘Avoid Truck Restricted Roads’, ‘Avoid Unpaved Roads’, ‘Axle Count Restriction’, ‘Driving a Bus’, ‘Driving a Delivery Vehicle’, ‘Driving a Taxi’, ‘Driving a Truck’, ‘Driving an Automobile’, ‘Driving an Emergency Vehicle’, ‘Height Restriction’, ‘Kingpin to Rear Axle Length Restriction’, ‘Length Restriction’, ‘Preferred for Pedestrians’, ‘Riding a Motorcycle’, ‘Roads Under Construction Prohibited’, ‘Semi or Tractor with One or More Trailers Prohibited’, ‘Single Axle Vehicles Prohibited’, ‘Tandem Axle Vehicles Prohibited’, ‘Through Traffic Prohibited’, ‘Truck with Trailers Restriction’, ‘Use Preferred Hazmat Routes’, ‘Use Preferred Truck Routes’, ‘Walking’, ‘Weight Restriction’, ‘Weight per Axle Restriction’, ‘Width Restriction’]

attribute_parameter_values

Optional FeatureSet . Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly 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 feature class, the field names on the feature class must match the fields as described below:

• AttributeName: Lists the name of the restriction.

• ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.

• ParameterValue: The value for ParameterName used by the tool when evaluating the restriction.

  Attribute Parameter Values is dependent on the Restrictions parameter. The ParameterValue field is applicable only if the restriction name is specified as the value for the Restrictions parameter.

  In Attribute Parameter Values, each restriction (listed as AttributeName) has a ParameterName field value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1)- Travel on the roads using the restriction is completely prohibited.

  • AVOID_HIGH (5) - It is highly unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_MEDIUM (2) - It is unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_LOW (1.3) - It is somewhat unlikely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_LOW (0.8) - It is somewhat likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_MEDIUM (0.5) - It is likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_HIGH (0.2) - It is highly likely for the tool to include in the route the roads that are associated with the restriction.

  In most cases, you can use the default value, PROHIBITED, for the Restriction Usage if the restriction is dependent on a vehicle-characteristic such as vehicle height. However, in some cases, the value for Restriction Usage depends on your routing preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the tool will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the tool will go out of its way to travel on the roads associated with the restriction.

route_line_simplification_tolerance

Optional LinearUnit. Specify by how much you want to simplify the geometry of the output lines for routes and directions. The tool ignores this parameter if the Route Shape parameter isn’t set to True Shape. Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points. The simplification distance you specify is the maximum allowable offset that the simplified line can deviate from the original line. Simplifying a line reduces the number of vertices that are part of the route geometry. This improves the tool execution time.

directions_language

Optional string. Specify the language that should be used when generating driving directions.

This parameter is used only when the Populate Directions parameter is checked, or set to True.

The parameter value can be specified using one of the following two- or five-character language codes:

Choice list: [‘ar-Arabic’, ‘cs-Czech’, ‘de-German’, ‘el-Greek’, ‘en-English’, ‘es-Spanish’, ‘et-Estonian’, ‘fr-French’, ‘he-Hebrew’, ‘it-Italian’, ‘ja-Japanese’, ‘ko-Korean’, ‘lt-Lithuanian’, ‘lv-Latvian’, ‘nl-Dutch’, ‘pl-Polish’, ‘pt-BR-Brazilian’, ‘Portuguese’, ‘pt-PT-European’, ‘Portuguese’, ‘ru-Russian’, ‘sv-Swedish’, ‘th-Thai’, ‘tr-Turkish’, ‘zh-CN-Simplified’, ‘Chinese’]

If an unsupported language code is specified, the tool returns the directions using the default language, English.

directions_style_name

Optional string. Specify the name of the formatting style for the directions. This parameter is used only when the Populate Directions parameter is checked, or set to True. The parameter can be specified using the following values:

NA Desktop: Generates turn-by-turn directions suitable for printing.

NA Navigation: Generates turn-by-turn directions designed for an in-vehicle navigation device.

Choice list: [‘NA Desktop’, ‘NA Navigation’]

travel_mode

Optional string. Specify 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 better reflect your organization’s workflows. You need to specify the name of a travel mode supported by your organization.

To get a list of supported travel mode names, run the GetTravelModes tool from the Utilities toolbox available under the same GIS Server connection you used to access the tool. The GetTravelModes 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 Travel Mode Settings field as input. This speeds up the tool execution as the tool does not have to lookup 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 may want to 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 may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization’s administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

accumulate_attributes

Optional list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis.

For each cost attribute that is accumulated, a Total_[Cost Attribute Name]_[Units] field is populated in the outputs created from the tool.

ignore_invalid_locations

Optional bool. Specifies whether locations that cannot be located on the network should be included in the output. Default is True.

facilities

Required FeatureSet . Specify one or more facilities (up to 1,000). The tool chooses the best locations from the set of facilities you specify here. In a competitive analysis, in which you try to find the best locations in the face of competition, the facilities of the competitors are specified here as well. When defining the facilities, you can set properties for each one, such as the facility name or type, by using attributes. Facilities can be specified with the following fields: Name-The name of the facility. The name is included in the name of output allocation lines if the facility is part of the solution.

• FacilityType - Specifies whether the facility is a candidate, required, or competitor facility. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Candidate) - A facility that may be part of the solution.

  • 1 (Required) - A facility that must be part of the solution.

  • 2 (Competitor) - A rival facility that potentially removes demand from your facilities. Competitor facilities are specific to the Maximize Market Share and Target Market Share problem types; they are ignored in other problem types. Weight-The relative weighting of the facility, which is used to rate the attractiveness, desirability, or bias of one facility compared to another. For example, a value of 2.0 could capture the preference of customers who prefer, at a ratio of 2 to 1, shopping in one facility over another facility. Factors that potentially affect facility weight include square footage, neighborhood, and age of the building. Weight values other than one are only honored by the maximize market share and target market share problem types; they are ignored in other problem types.

• Capacity - The Capacity field is specific to the Maximize Capacitated Coverage problem type; the other problem types ignore this field. Capacity specifies how much weighted demand the facility is capable of supplying. Excess demand won’t be allocated to a facility even if that demand is within the facility’s default measurement cutoff. Any value assigned to the Capacity field overrides the Default Capacity parameter (Default_Capacity in Python) for the given facility.

• CurbApproach - Specifies the direction a vehicle may arrive at or depart from the facility. 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)-The facility can be visited from either the right or left side of the vehicle.

  • 1 (Right side of vehicle)-Arrive at or depart the facility so that it is on the right side of the vehicle. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side so that passengers can disembark at the curb.

  • 2 (Left side of vehicle)-Arrive at or depart the facility so that it is on the left side of the vehicle. When the vehicle approaches and departs the facility, the curb must be on the left side of the vehicle. This is typically used for vehicles such as buses that must arrive with the bus stop on the left-hand side so that passengers can disembark at the curb.

  The CurbApproach property 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 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, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the incident, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

measurement_units

Required string. Specify the units that should be used to measure the travel times or travel distances between demand points and facilities. The tool chooses the best facilities based on which ones can reach, or be reached by, the most amount of weighted demand with the least amount travel. The output allocation lines report travel distance or travel time in different units, including the units you specify for this parameter.

Choice list: [‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘NauticalMiles’, ‘Seconds’, ‘Minutes’, ‘Hours’, ‘Days’]

problem_type

Optional string. Specifies the objective of the location-allocation analysis. The default objective is to minimize impedance.

• Minimize Impedance: This is also known as the P-Median problem type. Facilities are located such that the sum of all weighted travel time or distance between demand points and solution facilities is minimized. (Weighted travel is the amount of demand allocated to a facility multiplied by the travel distance or time to the facility.) This problem type is traditionally used to locate warehouses, because it can reduce the overall transportation costs of delivering goods to outlets. Since Minimize Impedance reduces the overall distance the public needs to travel to reach the chosen facilities, the minimize impedance problem without an impedance cutoff is ordinarily regarded as more equitable than other problem types for locating some public-sector facilities such as libraries, regional airports, museums, department of motor vehicles offices, and health clinics. The following list describes how the minimize impedance problem type handles demand: * A demand point that cannot reach any facilities, due to setting a cutoff distance or time, is not allocated. * A demand point that can only reach one facility has all its demand weight allocated to that facility. * A demand point that can reach two or more facilities has all its demand weight allocated to the nearest facility only.

• Maximize Coverage: Facilities are located such that as much demand as possible is allocated to solution facilities within the impedance cutoff. Maximize Coverage is frequently used to locate fire stations, police stations, and ERS centers, because emergency services are often required to arrive at all demand points within a specified response time. Note that it is important for all organizations, and critical for emergency services, to have accurate and precise data so that analysis results correctly model real-world results. Pizza delivery businesses, as opposed to eat-in pizzerias, try to locate stores where they can cover the most people within a certain drive time. People who order pizzas for delivery don’t typically worry about how far away the pizzeria is; they are mainly concerned with the pizza arriving within an advertised time window. Therefore, a pizza-delivery business would subtract pizza-preparation time from their advertised delivery time and solve a maximize coverage problem to choose the candidate facility that would capture the most potential customers in the coverage area. (Potential customers of eat-in pizzerias are more affected by distance, since they need to travel to the restaurant; thus, the attendance maximizing or market share problem types would better suit eat-in restaurants.) The following list describes how the Maximize Coverage problem handles demand: * A demand point that cannot reach any facilities due to cutoff distance or time is not allocated. * A demand point that can only reach one facility has all its demand weight allocated to that facility. * A demand point that can reach two or more facilities has all its demand weight allocated to the nearest facility only.

• Maximize Capacitated Coverage: Facilities are located such that all or the greatest amount of demand can be served without exceeding the capacity of any facility. Maximize Capacitated Coverage behaves like either the Minimize Impedance or Maximize Coverage problem type but with the added constraint of capacity. You can specify a capacity for an individual facility by assigning a numeric value to its corresponding Capacity field on the input facilities. If the Capacity field value is null, the facility is assigned a capacity from the Default Capacity property. Use-cases for Maximize Capacitated Coverage include creating territories that encompass a given number of people or businesses, locating hospitals or other medical facilities with a limited number of beds or patients who can be treated, or locating warehouses whose inventory isn’t assumed to be unlimited. The following list describes how the Maximize Capacitated Coverage problem handles demand: * Unlike Maximize Coverage, Maximize Capacitated Coverage doesn’t require a value for the Default Measurement Cutoff; however, when an cutoff is specified, any demand point outside the cutoff time or distance of all facilities is not allocated. * An allocated demand point has all or none of its demand weight assigned to a facility; that is, demand isn’t apportioned with this problem type. * If the total demand that can reach a facility is greater than the capacity of the facility, only the demand points that maximize total captured demand and minimize total weighted travel are allocated.

  Note

  You may notice an apparent inefficiency when a demand point is allocated to a facility that isn’t the nearest solution facility. This may occur when demand points have varying weights and when the demand point in question can reach more than one facility. This kind of result indicates the nearest solution facility didn’t have adequate capacity for the weighted demand, or the most efficient solution for the entire problem required one or more local inefficiencies. In either case, the solution is correct.

• Minimize Facilities: Facilities are chosen such that as much weighted demand as possible are allocated to solution facilities within the travel time or distance cutoff; additionally, the number of facilities required to cover demand is minimized. Minimize Facilities is the same as Maximize Coverage but with the exception of the number of facilities to locate, which in this case is determined by the solver. When the cost of building facilities is not a limiting factor, the same kinds of organizations that use Maximize Coverage (emergency response, for instance) use Minimize Facilities so that all possible demand points will be covered. The following list describes how the Minimize Facilities problem handles demand: * A demand point that cannot reach any facilities due to a cutoff distance or time is not allocated. * A demand point that can only reach one facility has all its demand weight allocated to that facility. * A demand point that can reach two or more facilities has all its demand weight allocated to the nearest facility only.

• Maximize Attendance: Facilities are chosen such that as much demand weight as possible is allocated to facilities while assuming the demand weight decreases in relation to the distance between the facility and the demand point. Specialty stores that have little or no competition benefit from this problem type, but it may also be beneficial to general retailers and restaurants that don’t have the data on competitors necessary to perform market share problem types. Some businesses that might benefit from this problem type include coffee shops, fitness centers, dental and medical offices, and electronics stores. Public transit bus stops are often chosen with the help of Maximize Attendance. Maximize Attendance assumes that the farther people have to travel to reach your facility, the less likely they are to use it. This is reflected in how the amount of demand allocated to facilities diminishes with distance. The following list describes how the Maximize Attendance problem handles demand: * A demand point that cannot reach any facilities due to a cutoff distance or time is not allocated. * When a demand point can reach a facility, its demand weight is only partially allocated to the facility. The amount allocated decreases as a function of the maximum cutoff distance (or time) and the travel distance (or time) between the facility and the demand point. * The weight of a demand point that can reach more than one facility is proportionately allocated to the nearest facility only.

• Maximize Market Share: A specific number of facilities are chosen such that the allocated demand is maximized in the presence of competitors. The goal is to capture as much of the total market share as possible with a given number of facilities, which you specify. The total market share is the sum of all demand weight for valid demand points. The market share problem types require the most data because, along with knowing your own facilities’ weight, you also need to know that of your competitors’ facilities. The same types of facilities that use the Maximize Attendance problem type can also use market share problem types given that they have comprehensive information that includes competitor data. Large discount stores typically use Maximize Market Share to locate a finite set of new stores. The market share problem types use a Huff model, which is also known as a gravity model or spatial interaction. The following list describes how the Maximize Market Share problem handles demand:

  • A demand point that cannot reach any facilities due to a cutoff distance or time is not allocated.

  • A demand point that can only reach one facility has all its demand weight allocated to that facility.

  • A demand point that can reach two or more facilities has all its demand weight allocated to them; furthermore, the weight is split among the facilities proportionally to the facilities’ attractiveness (facility weight) and inversely proportional to the distance between the facility and demand point. Given equal facility weights, this means more demand weight is assigned to near facilities than far facilities.

  • The total market share, which can be used to calculate the captured market share, is the sum of the weight of all valid demand points.

• Target Market Share: Target Market Share chooses the minimum number of facilities necessary to capture a specific percentage of the total market share in the presence of competitors. The total market share is the sum of all demand weight for valid demand points. You set the percent of the market share you want to reach and let the solver choose the fewest number of facilities necessary to meet that threshold. The market share problem types require the most data because, along with knowing your own facilities’ weight, you also need to know that of your competitors’ facilities. The same types of facilities that use the Maximize Attendance problem type can also use market share problem types given that they have comprehensive information that includes competitor data. Large discount stores typically use the Target Market Share problem type when they want to know how much expansion would be required to reach a certain level of the market share or see what strategy would be needed just to maintain their current market share given the introduction of new competing facilities. The results often represent what stores would like to do if budgets weren’t a concern. In other cases where budget is a concern, stores revert to the Maximize Market Share problem and simply capture as much of the market share as possible with a limited number of facilities. The following list describes how the target market share problem handles demand:

  • The total market share, which is used in calculating the captured market share, is the sum of the weight of all valid demand points.

  • A demand point that cannot reach any facilities due to a cutoff distance or time is not allocated.

  • A demand point that can only reach one facility has all its demand weight allocated to that facility.

  • A demand point that can reach two or more facilities has all its demand weight allocated to them; furthermore, the weight is split among the facilities proportionally to the facilities’ attractiveness (facility weight) and inversely proportional to the distance between the facility and demand point. Given equal facility weights, this means more demand weight is assigned to near facilities than far facilities.

Choice list:[‘Maximize Attendance’, ‘Maximize Capacitated Coverage’, ‘Maximize Coverage’, ‘Maximize Market Share’, ‘Minimize Facilities’, ‘Minimize Impedance’, ‘Target Market Share’]

default_measurement_cutoff

Optional float. Specifies the maximum travel time or distance allowed between a demand point and the facility it is allocated to. If a demand point is outside the cutoff of a facility, it cannot be allocated to that facility. The default value is none, which means the cutoff limit doesn’t apply. The units for this parameter are the same as those specified by the Measurement Units parameter. The travel time or distance cutoff is measured by the shortest path along roads. This property might be used to model the maximum distance that people are willing to travel to visit stores or the maximum time that is permitted for a fire department to reach anyone in the community. Note that demand points have Cutoff_Time and Cutoff_Distance fields, which, if set accordingly, overrides the Default Measurement Cutoff parameter. You might find that people in rural areas are willing to travel up to 10 miles to reach a facility while urbanites are only willing to travel up to two miles. Assuming Measurement Units is set to Miles, you can model this behavior by setting the default measurement cutoff to 10 and the Cutoff_Distance field value of the demand points in urban areas to 2.

target_market_share

Optional float. This parameter is specific to the Target Market Share problem type. It is the percentage of the total demand weight that you want the chosen and required facilities to capture. The solver chooses the minimum number of facilities needed to capture the target market share specified here. The default value is 10 percent.

measurement_transformation_factor

Optional float. Provides a parameter value to the equations specified in the Measurement Transformation Model parameter. The parameter value is ignored when the impedance transformation is of type linear. For power and exponential impedance transformations, the value should be nonzero.

The default value is 1.

time_of_day

Optional datetime. Specify the time at which travel begins. This property is ignored unless Measurement Units are time based. The default is no time or date. When Time of Day isn’t specified, the solver uses generic speeds-typically those from posted speed limits. Traffic constantly changes in reality, and as it changes, travel times between facilities and demand points also fluctuate. Therefore, indicating different time and date values over several analyses may affect how demand is allocated to facilities and which facilities are chosen in the results. The time of day always indicates a start time. However, travel may start from facilities or demand points; it depends on what you choose for the Travel Direction parameter. The Time Zone for Time of Day parameter specifies whether this time and date refer to UTC or the time zone in which the facility or demand point is located.

uturn_at_junctions

Optional string. The U-Turn policy at junctions. Allowing U-turns implies the solver can turn around at a junction and double back on the same street. Given that junctions represent street intersections and dead ends, different vehicles may be able to turn around at some junctions but not at others-it depends on whether the junction represents an intersection or dead end. To accommodate, the U-turn policy parameter is implicitly specified by how many edges, or streets, connect to the junction, which is known as junction valency. The acceptable values for this parameter are listed below; each is followed by a description of its meaning in terms of junction valency.

• Allowed: U-turns are permitted at junctions with any number of connected edges, or streets. This is the default value.

• Not Allowed: U-turns are prohibited at all junctions, regardless of junction valency.

• Allowed only at Dead Ends: U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end).

• Allowed only at Intersections and Dead Ends: U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge). Oftentimes, networks modeling streets have extraneous junctions in the middle of road segments. This option prevents vehicles from making U-turns at these locations. This parameter is ignored unless Travel Mode is set to Custom.

Choice list: [‘Allowed’, ‘Not Allowed’, ‘Allowed Only at Dead Ends’, ‘Allowed Only at Intersections and Dead Ends’]

line_barriers

Optional FeatureSet . Specify one or more lines that prohibit travel anywhere the lines intersect the streets. For example, a parade or protest that blocks traffic across several street segments can be modeled with a line barrier. A line barrier can also quickly fence off several roads from being traversed, thereby channeling possible routes away from undesirable parts of the street network. The tool imposes a limit on the number of streets you can restrict using the Line Barriers parameter. While there is no limit on the number of lines you can specify as line barriers, the combined number of streets intersected by all the lines cannot exceed 500. When specifying the line barriers, you can set a name property for each one by using the following attribute:

• Name: The name of the barrier.

use_hierarchy

Optional boolean. Specify whether hierarchy should be used when finding the shortest path between the facilities and demand points.

Checked (True): Use hierarchy when measuring between facilities and demand points. When hierarchy is used, the tool prefers higher-order streets (such as freeways) to lower-order streets (such as local roads), and can be used to simulate the driver preference of traveling on freeways instead of local roads even if that means a longer trip. This is especially true 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, especially for long-distance routes, since the tool can determine the best route from a relatively smaller subset of streets.

Unchecked (False): Do not use hierarchy when measuring between facilities and demand points. If hierarchy is not used, the tool considers all the streets and doesn’t prefer higher-order streets when finding the route. This is often used when finding short-distance routes within a city. The tool automatically reverts to using hierarchy if the straight-line distance between facilities and demand points is greater than 50 miles, even if you have set this parameter to not use hierarchy.

attribute_parameter_values

Optional FeatureSet . Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly prefer them. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. If you specify the Attribute Parameter Values parameter from a feature class, the field names on the feature class must match the fields as described below:

• AttributeName: Lists the name of the restriction.

• ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.

• ParameterValue: The value for ParameterName used by the tool when evaluating the restriction. Attribute Parameter Values is dependent on the Restrictions parameter. The ParameterValue field is applicable only if the restriction name is specified as the value for the Restrictions parameter. In Attribute Parameter Values, each restriction (listed as AttributeName) has a ParameterName field value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1) - Travel on the roads using the restriction is completely prohibited.

  • AVOID_HIGH (5) - It is highly unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_MEDIUM (2) - It is unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_LOW (1.3) - It is somewhat unlikely for the tool to include in the route the roads that are associated with the restriction

  • PREFER_LOW (0.8) - It is somewhat likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_MEDIUM (0.5) - It is likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_HIGH (0.2) - It is highly likely for the tool to include in the route the roads that are associated with the restriction.

  In most cases, you can use the default value, PROHIBITED, for the Restriction Usage if the restriction is dependent on a vehicle-characteristic such as vehicle height. However, in some cases, the value for Restriction Usage depends on your routing preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the tool will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the tool will go out of its way to travel on the roads associated with the restriction.

travel_mode

Optional string. Specify 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 better reflect your organization’s workflows. You need to specify the name of a travel mode supported by your organization.

To get a list of supported travel mode names, run the GetTravelModes tool from the Utilities toolbox available under the same GIS Server connection you used to access the tool. The GetTravelModes 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 Travel Mode Settings field as input. This speeds up the tool execution as the tool does not have to lookup 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 may want to 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 may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization’s administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

accumulate_attributes

Optional list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis.

For each cost attribute that is accumulated, a Total_[Cost Attribute Name]_[Units] field is populated in the outputs created from the tool.

ignore_invalid_locations

Optional bool. Specifies whether the tool should ignore invalid locations when locating inputs such as stops or facilities on the network. * True - Invalid locations will be ignored when locating inputs on the network. This is the default. * False - Invalid locations will not be ignored when locating inputs on the network. Instead, the tool will return an error if it encounters an invalid location.

origins

Required FeatureSet . Specify locations that function as starting points in generating the paths to destinations. You can add up to 200 origins. When specifying the origins, you can set properties for each one, such as its name or the number of destinations to find from the origin, by using attributes. The origins can be specified with the following attributes:

• Name - The name of the origin. The name can be an unique identifier for the origin. The name is included in the output lines (as the OriginName field) and in the output origins (as the Name field) and can be used to join additional information from the tool outputs to the attributes of your origins. If the name is not specified, a unique name prefixed with Location is automatically generated in the output origins. An auto-generated origin name is not included in the output lines.

• TargetDestinationCount-The maximum number of destinations that must be found for the origin. If a value is not specified, the value from the Number of Destinations to Find parameter is used. Cutoff-Specify the travel time or travel distance value at which to stop searching for destinations from the origin. Any destination beyond the cutoff value will not be considered. The value needs to be in the units specified by the Time Units parameter if the impedance attribute in your travel mode is time based or in the units specified by the Distance Units parameter if the impedance attribute in your travel mode is distance based. If a value is not specified, the value from the Cutoff parameter is used.

• CurbApproach - Specifies the direction a vehicle may depart from the origin. 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)-The vehicle can depart the origin in either direction, so a U-turn is allowed at the origin. This setting can be chosen if it is possible and practical for your vehicle to turn around at the origin. This decision may depend on the width of the road and the amount of traffic or whether the origin has a parking lot where vehicles can enter and turn around.

  • 1 ( Right side of vehicle)-When the vehicle departs the origin, the origin 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 depart from the bus stop on the right-hand side.

  • 2 (Left side of vehicle)-When the vehicle departs the origin, the curb must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must depart from the bus stop on the left-hand side.

  • 3 (No U-Turn)-For this tool, the No U-turn (3) value functions the same as Either side of vehicle. The CurbApproach property 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 origin 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 depart the origin 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 depart from an origin and not have a lane of traffic between the vehicle and the origin, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

travel_mode

Optional string. Specify 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 better reflect your organization’s workflows. You need to specify the name of a travel mode supported by your organization.

To get a list of supported travel mode names, run the GetTravelModes tool from the Utilities toolbox available under the same GIS Server connection you used to access the tool. The GetTravelModes 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 Travel Mode Settings field as input. This speeds up the tool execution as the tool does not have to lookup 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 travelling by car. You may want to 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 may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization’s administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

distance_units

Optional string. Specify the units that should be used to measure and report the total travel distance between each origin-destination pair.

Choice list:[‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘NauticalMiles’]

number_of_destinations_to_find

Optional integer. Specify the maximum number of destinations to find per origin. If a value for this parameter is not specified, the output matrix includes travel costs from each origin to every destination. Individual origins can have their own values (specified as the TargetDestinationCount field) that override the Number of Destinations to Find parameter value.

time_of_day

Optional datetime. Specifies the time and date at which the routes should begin. If you are modeling the driving travel mode and specify the current date and time as the value for this parameter, the tool will use live traffic conditions to find the best routes and the total travel time will be based on traffic conditions.

Specifying a time of day results in more accurate routes and estimations of travel times because the travel times account for the traffic conditions that are applicable for that date and time. The Time Zone for Time of Day parameter specifies whether this time and date refer to UTC or the time zone in which the stop is located. The tool ignores this parameter when Measurement Units isn’t set to a time-based unit.

point_barriers

Optional FeatureSet . Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or time delay spent at a railroad crossing.

The tool imposes a limit of 250 points that can be added as barriers. When specifying the point barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The point barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Restriction)-Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

  • 2 (Added Cost)-Traveling through the barrier increases the travel time or distance by the amount specified in the Additional_Time or Additional_Distance field. This barrier type is referred to as an added-cost point barrier.

• Additional_Time: Indicates how much travel time is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the measurement units are time based. This field value must be greater than or equal to zero, and its units are the same as those specified in the Measurement Units parameter.

• Additional_Distance: Indicates how much distance is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the measurement units are distance based. The field value must be greater than or equal to zero, and its units are the same as those specified in the Measurement Units parameter.

polygon_barriers

Optional FeatureSet . Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

The service imposes a limit on the number of streets you can restrict using the Polygon Barriers parameter. While there is no limit on the number of polygons you can specify as the polygon barriers, the combined number of streets intersected by all the polygons should not exceed 2,000. When specifying the polygon barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The polygon barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the barrier restricts travel completely or scales the time or distance for traveling through it. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Restriction)-Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

  • 1 (Scaled Cost)-Scales the time or distance required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor fields. If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor 0.25 would mean that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 would mean it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It might be used to model storms that reduce travel speeds in specific regions.

• ScaledTimeFactor: This is the factor by which the travel time of the streets intersected by the barrier is multiplied. This field is applicable only for scaled-cost barriers and only if the measurement units are time based. The field value must be greater than zero.

• ScaledDistanceFactor: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers and only if the measurement units are distance based. The attribute value must be greater than zero.

use_hierarchy

Optional boolean. Specify whether hierarchy should be used when finding the shortest paths between stops. Checked (True): Use hierarchy when finding routes. When hierarchy is used, the tool prefers higher-order streets (such as freeways) to lower-order streets (such as local roads), and can be used to simulate the driver preference of traveling on freeways instead of local roads even if that means a longer trip. This is especially true 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, especially for long-distance routes, since the tool can determine the best route from a relatively smaller subset of streets. Unchecked (False): Do not use hierarchy when finding routes. If hierarchy is not used, the tool considers all the streets and doesn’t prefer higher-order streets when finding the route. This is often used when finding short routes within a city.

The tool automatically reverts to using hierarchy if the straight-line distance between facilities and demand points is greater than 50 miles (80.46 kilometers), even if you have set this parameter to not use hierarchy. This parameter is ignored unless Travel Mode is set to Custom. When modeling a custom walking mode, it is recommended to turn off hierarchy since the hierarchy is designed for motorized vehicles.

attribute_parameter_values

Optional FeatureSet . Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly prefer them. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. If you specify the Attribute Parameter Values parameter from a feature class, the field names on the feature class must match the fields as described below:

• AttributeName: Lists the name of the restriction.

• ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.

• ParameterValue: The value for ParameterName used by the tool when evaluating the restriction. Attribute Parameter Values is dependent on the Restrictions parameter. The ParameterValue field is applicable only if the restriction name is specified as the value for the Restrictions parameter. In Attribute Parameter Values, each restriction (listed as AttributeName) has a ParameterName field value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1) - Travel on the roads using the restriction is completely prohibited.

  • AVOID_HIGH (5) - It is highly unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_MEDIUM (2) - It is unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_LOW (1.3) - It is somewhat unlikely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_LOW (0.8) - It is somewhat likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_MEDIUM (0.5) - It is likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_HIGH (0.2) - It is highly likely for the tool to include in the route the roads.

  In most cases, you can use the default value, PROHIBITED, for the Restriction Usage if the restriction is dependent on a vehicle-characteristic such as vehicle height. However, in some cases, the value for Restriction Usage depends on your routing preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the tool will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the tool will go out of its way to travel on the roads associated with the restriction.

origin_destination_line_shape

Optional string. The resulting lines of an OD cost matrix can be represented with either straight-line geometry or no geometry at all. In both cases, the route is always computed along the street network by minimizing the travel time or the travel distance, never using the straight-line distance between origins and destinations.

Straight Line: Straight lines connect origins and destinations. None: Do not return any shapes for the lines that connect origins and destinations. This is useful when you have a large number of origins and destinations and are interested only in the OD cost matrix table (and not the output line shapes).

Choice list:[‘None’, ‘Straight Line’]

overrides

Optional string. Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. The value for this parameter needs to 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 quotes. The values can be a number, Boolean, or string. The default value for this parameter is no value, which indicates not to override any solver settings. Overrides are advanced settings that should be used only after careful analysis of the results obtained before and after applying the settings. A list of supported override settings for each solver and their acceptable values can be obtained by contacting Esri Technical Support.

time_impedance

Optional string. Specify the time-based impedance.

output_format

Optional. Specify the format in which the output features are created.

Choose from the following formats:

• Feature Set - The output features are returned as feature classes and tables. This is the default.

• JSON File - The output features are 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 - The output features are 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.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

ignore_network_location_fields

Optional boolean. Specifies whether the network location fields will be considered when locating inputs such as stops or facilities on the network.

• True - Network 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.

• False - Network location fields will be considered when locating the inputs on the network.

The default value is false.

locate_settings

Optional dictionary containing additional input location settings. Use this parameter to specify settings that affect how inputs are located, such as the maximum search distance to use when locating the inputs on the network or the network sources being used for locating. To restrict locating on a portion of the source, you can specify a where clause for a source.

The dictionary of parameters can be assigned to the ‘default’, or to the ‘overrides’ key which holds the dictionary of parameters for each override, types of override are ‘origins’, ‘destinations’, ‘point_barriers’, ‘line_barriers’, ‘polygon_barriers’. Use the LocateSettings class to create the dictionary for each override or for the default.

from arcgis.network import LocateSettings
locate_settings = LocateSettings(tolerance=5000, tolerance_units=ToleranceUnits.meters, allow_auto_relocate=True, sources=[{"name": "Routing_Streets"}])
result = route_layer.solve(stops=stops, locate_settings={"default": locate_settings.to_dict()})

stops

Required FeatureSet . Specify the locations you want the output route or routes to visit. You can add up to 10,000 stops and assign up to 150 stops to a single route. (Assign stops to routes using the RouteName attribute). When specifying the stops, you can set properties for each one, such as its name or service time, by using attributes. The stops can be specified with the following attributes:

• Name: The name of the stop. This name is used when generating driving directions. It is common to pass the name of a business, person, or street address at the stop. If a value is not specified, an automatically generated name such as Location 1 or Location 2 is assigned to each stop.

• TimeWindowStart: The earliest time the stop can be visited. Specify this attribute if you want to limit when a route can arrive at a stop; for instance, you may want to make deliveries to a restaurant between busy lunch and dinner hours (for example, sometime between 2:00 and 4:30 p.m.) to facilitate the work for you and the restaurant staff.

  The value is specified as an integer that represents the number of milliseconds since epoch (January 1, 1970).

  This value can be specified either in UTC or local time, depending on the value given for the timeWindowsAreUTC parameter.

  If you specify this attribute, you also need to specify the TimeWindowEnd attribute.

• TimeWindowEnd: The latest time the stop can be visited. Together, the TimeWindowStart and TimeWindowEnd attributes make up the time window within which a route can visit the stop. As with TimeWindowStart, the TimeWindowEnd value is specified as an integer that represents the number of milliseconds since epoch (January 1, 1970) and is interpreted as UTC or local time, depending on the value specified for the timeWindowsAreUTC parameter.

  The time window specified using the TimeWindowStart and TimeWindowEnd attributes is not considered a hard constraint by the service. That is, the service doesn’t fail if the stop cannot be visited during the time window; instead, the service tries to find a route that visits the stop during its time window, but if time window violations are inevitable, the service tries to find a solution that minimizes the time-window violation time for all stops in the problem.

  If a route has to arrive early at the stop, a wait time is added to the total travel time of the route. Similarly, if the route arrives late at the stop, a violation time is added to the total travel time of the route. For example, If the time window on the stop is set as 10:00 AM to 11:00 AM and the earliest a route can reach the stop is 11:25 AM, a violation of 25 minutes is added to the total travel time.

• RouteName: The name of the route to which the stop belongs. Use this attribute to group stops into different routes and, therefore, solve multiple routes in a single request. For example, if you want to find two distinct routes - a route with 4 stops and another with 6 stops - set RouteName to Route1 for each of the four stops and Route2 for each of the 6 stops. The service will produce two distinct routes and driving directions for each group of stops in a single request.

  If RouteName is not specified for any stops, all stops belong to the same route. If RouteName is not specified for some stops, those stops are treated as unassigned and are not included in any route.

• Sequence: The output routes will visit the stops in the order you specify with this attribute. Within a group of stops that have the same RouteName value, the sequence number should be greater than 0 but not greater than the total number of stops. Also, the sequence number should not be duplicated. If Reorder Stops To Find Optimal Routes is checked (True), all but possibly the first and last sequence values for each route name are ignored so the tool can find the sequence that minimizes overall travel for each route. (The settings for Preserve Ordering of Stops and Return to Start determine whether the first or last sequence values for each route are ignored.)

• CurbApproach: Specify the direction a vehicle may arrive at and depart from the stop. One of the integers listed in the Coded value column in the following table must be specified as a value of this attribute. The values in the Setting column are the descriptive names for the CurbApproach attribute values that you may have come across when using ArcGIS Network Analyst extension extension software.

  Setting	Description
  Either side of vehicle	The vehicle can approach and depart the stop in either direction, so a U-turn is allowed at the stop. This is the default value. This setting can be chosen if it is possible and desirable for your vehicle to turn around at the stop. This decision may depend on the width of the road and the amount of traffic or whether the stop has a parking lot where vehicles can pull in and turn around.
  right side of vehicle	When the vehicle approaches and departs the stop, the stop must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the right-hand side.
  left side of vehicle	When the vehicle approaches and departs the stop, the stop must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles like busses that must arrive with the bus stop on the left-hand side.
  No U-Turn	When the vehicle approaches the stop, the stop can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived in. A U-turn is prohibited.

  The CurbApproach property 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 stop 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 from the right or left side. For example, if you want to arrive at a stop and not have a lane of traffic between the vehicle and the stop, you would choose Right side of vehicle in the United States but Left side of vehicle in the United Kingdom.

• Attr_TravelTime: Specify the amount of time for cars, in minutes, that will be spent at the stop when the route visits it. This attribute can be used to model the time required to provide some kind of service while you are at the stop. It can also be used to specify some additional time required to reach the actual location on the street from where the route starts or time required to reach the actual destination location from the location on the street where the route ends. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the stop requires no service time.

  For example, suppose you are finding the best route through three stops. Suppose it requires 2 minutes to walk to the street location from where the route starts, you need to spend 10 minutes at Stop 2, and it takes 5 minutes to walk from the street location to the destination. The Attr_TravelTime attribute should be given values of 2, 10, and 5 for Stop 1, Stop 2, and Stop 3, respectively. If it takes 10 minutes to travel from Stop 1 to Stop 2 and 10 minutes to travel from Stop 2 to Stop 3, the total travel time to reach Stop 3 is displayed as 37 minutes (2 + 10 + 10 + 10 + 5), even though there is only 20 minutes of traveling to reach Stop 3.

• Attr_TruckTravelTime: Specify the amount of time for trucks, in minutes, that will be added to the total travel time of the route at the stop. The attribute value can be used to model the time spent at the stop.

  The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

• Attr_WalkTime: Specify the amount of time for pedestrians, in minutes, that will be added to the total travel time of the route at the stop. The attribute value can be used to model the time spent at the incident. The value for this attribute is included in the total travel time for the route and is also displayed in driving directions as service time. A zero or null value indicates that the incident requires no service time. The default value is 0.

• Attr_Miles: Specify the distance in miles that will be added when calculating total distance of the route. Generally the locations of the stops are not exactly on the streets but are set back somewhat from the road. The Attr_Miles attribute can be used to model the distance between the actual stop location and its location on the street if it is important to include that distance in the total travel distance.

• Attr_Kilometers: Specify the distance in kilometers that will be added when calculating total distance of the route. Generally the locations of the stops are not exactly on the streets but are set back somewhat from the road. The Attr_Kilometers attribute can be used to model the distance between the actual stop location and its location on the street if it is important to include that distance in the total travel distance.

• LocationType: The stop type.

  Setting	Coded value	Description
  Stop	0	A location that the route should visit. This is the default.
  Waypoint	1	A location that the route should travel through without making a stop. Waypoints can be used to force the route to take a specific path (to go through the waypoint) without being considered an actual stop. Waypoints do not appear in driving directions.
  Break	2	A location where the route stops for the driver to take a break.

• Bearing: Specify the direction the vehicle or person is moving in. Bearing is measured clockwise from true north and must be in degrees. Typically, values are between 0 and 360; however, negative values are interpreted by subtracting them from 360 degrees.

• BearingTol: Short for bearing tolerance, this field specifies the maximum acceptable difference between the heading of a vehicle and a tangent line from the point on a street where Network Analyst attempts to locate the vehicle. The bearing tolerance is used to determine whether the direction in which a vehicle is moving generally aligns with the underlying road. If they align within the given tolerance, the vehicle is located on that edge; if not, the next nearest eligible edge is evaluated.

analysis_region

Optional string. Specify the region in which to perform the analysis. If a value is not specified for this parameter, the tool will automatically calculate the region name based on the location of the input points. Setting the name of the region is required only if the auto-detection of the region name is not accurate for your inputs. To specify a region, use one of the following values: Europe,Japan,Korea,MiddleEast, and Africa. NorthAmerica, SouthAmerica, SouthAsia,Thailand; The following region names are no longer supported and will be removed in future releases. If you specify one of the deprecated region names, the tool automatically assigns a supported region name for your region. Greece redirects to Europe. India redirects to South Asia. Oceania redirects to South Asia. South East Asia redirects to South Asia. Taiwan redirects to South Asia.

Choice list:[‘Europe’, ‘Japan’, ‘Korea’, ‘MiddleEastAndAfrica’, ‘NorthAmerica’, ‘SouthAmerica’, ‘SouthAsia’, ‘Thailand’]

preserve_terminal_stops

Optional string. When Reorder Stops to Find Optimal Routes is checked (or True), you have options to preserve the starting or ending stops and the tool can reorder the rest. The first and last stops are determined by their Sequence attribute values or, if the Sequence values are null, by their Object ID values.

Preserve First - The tool won’t reorder the first stop. Choose this option if you are starting from a known location, such as your home, headquarters, or current location.Preserve Last-The tool won’t reorder the last stop. The output routes may start from any stop feature but must end at the predetermined last stop. Preserve First and Last-The tool won’t reorder the first and last stops.

Preserve None - The tool may reorder any stop, including the first and last stops. The route may start or end at any of the stop features.Preserve Terminal Stops is ignored when Reorder Stops to Find Optimal Routes is unchecked (or False).

Choice list: [‘Preserve First’, ‘Preserve Last’, ‘Preserve First and Last’, ‘Preserve None’]

use_time_windows

Optional boolean. Check this option (or set it to True) if any input stops have time windows that specify when the route should reach the stop. You can add time windows to input stops by entering time values in the TimeWindowStart and TimeWindowEnd attributes.

Checked (True) - The input stops have time windows and you want the tool to try to honor them.

Unchecked (False) - The input stops don’t have time windows, or if they do, you don’t want the tool to try to honor them. This is the default value.The tool will take slightly longer to run when Use Time Windows is checked (or True), even when none of the input stops have time windows, so it is recommended to uncheck this option (set to False) if possible.

time_zone_for_time_of_day

Optional string. Specifies the time zone of the Time of Day parameter.Geographically Local-The Time of Day parameter refers to the time zone in which the first stop of a route is located. If you are generating many routes that start in multiple times zones, the start times are staggered in Coordinated Universal Time (UTC). For example, a Time of Day value of 10:00 a.m., 2 January, would mean a start time of 10:00 a.m. Eastern Standard Time (UTC-3:00) for routes beginning in the Eastern Time Zone and 10:00 a.m. Central Standard Time (UTC-4:00) for routes beginning in the Central Time Zone. The start times are offset by one hour in UTC. The arrive and depart times and dates recorded in the output Stops feature class will refer to the local time zone of the first stop for each route.UTC-The Time of Day parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to generate a route for a specific time, such as now, but aren’t certain in which time zone the first stop will be located. If you are generating many routes spanning multiple times zones, the start times in UTC are simultaneous. For example, a Time of Day value of 10:00 a.m., 2 January, would mean a start time of 5:00 a.m. Eastern Standard Time (UTC-5:00) for routes beginning in the Eastern Time Zone and 4:00 a.m. Central Standard Time (UTC-6:00) for routes beginning in the Central Time Zone. Both routes would start at 10:00 a.m. UTC. The arrive and depart times and dates recorded in the output Stops feature class will refer to UTC.

Choice list: [‘Geographically Local’, ‘UTC’]

point_barriers

Optional FeatureSet . Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or time delay spent at a railroad crossing.

The tool imposes a limit of 250 points that can be added as barriers. When specifying the point barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The point barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses): * 0 (Restriction) - Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction. * 2 (Added Cost) - Traveling through the barrier increases the travel time or distance by the amount specified in the Additional_Time or Additional_Distance field. This barrier type is referred to as an added-cost point barrier.

• Additional_Time: Indicates how much travel time is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the measurement units are time based. This field value must be greater than or equal to zero, and its units are the same as those specified in the Measurement Units parameter.

• Additional_Distance: Indicates how much distance is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the measurement units are distance based. The field value must be greater than or equal to zero, and its units are the same as those specified in the Measurement Units parameter.

• Additional_Cost: Indicates how much cost is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the travel mode used for the analysis uses an impedance attribute that is neither time-based or distance-based.

• FullEdge: Specify 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): Permits travel on the edge up to the barrier, but not through it. This is the default value.

  • 1 (True): Restricts travel anywhere on the associated edge.

• CurbApproach: Specifies 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): The barrier affects travel over the edge in both directions.

  • 1 (Right side of vehicle): Vehicles 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): Vehicles 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.

  Since junctions are points and don’t have a side, barriers on junctions affect all vehicles regardless of the curb approach.

  The CurbApproach property was designed to work with both kinds 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, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the facility, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.

• Bearing: The 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.

• BearingTol: The 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 ArcGIS Network Analyst extension 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.

• NavLatency: This 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 time 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 time units of NavLatency are the same as the units specified by the timeUnits property of the analysis object.

polygon_barriers

Optional FeatureSet . Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

The service imposes a limit on the number of streets you can restrict using the Polygon Barriers parameter. While there is no limit on the number of polygons you can specify as the polygon barriers, the combined number of streets intersected by all the polygons should not exceed 2,000. When specifying the polygon barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The polygon barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the barrier restricts travel completely or scales the time or distance for traveling through it. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Restriction) - Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

  • 1 (Scaled Cost)-Scales the time or distance required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor fields. If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor 0.25 would mean that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 would mean it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It might be used to model storms that reduce travel speeds in specific regions.

• ScaledTimeFactor: This is the factor by which the travel time of the streets intersected by the barrier is multiplied. This field is applicable only for scaled-cost barriers and only if the measurement units are time based. The field value must be greater than zero.

• ScaledDistanceFactor: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers and only if the measurement units are distance based. The attribute value must be greater than zero.

• ScaledCostFactor: This is the factor by which the cost of the streets intersected by the barrier is multiplied. The field value must be greater than zero.

  This field is applicable only for scaled-cost barriers and only if the travel mode used for the analysis uses an impedance attribute that is neither time based nor distance based.

restrictions

Optional string. Specify which restrictions should be honored by the tool when finding the best routes. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. A restriction represents a driving preference or requirement. In most cases, restrictions cause roads to be prohibited. For instance, using an Avoid Toll Roads restriction will result in a route that will include roads only when it is absolutely required to travel on toll roads in order 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 as illegal to do so.

Below is a list of available restrictions and a short description. Some restrictions require an additional value to be specified for their desired use. This value needs to be associated with the restriction name and a specific parameter intended to work with the restriction. You can identify such restrictions if their names appear under the AttributeName column in the Attribute Parameter Values parameter. The ParameterValue field should be specified in the Attribute Parameter Values parameter for the restriction 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 check whether the restriction is available in a particular country by looking at the table in the Country List section of the Data coverage for network analysis services web page. 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 whose Restriction Usage parameter value is between 0 and 1 (see the Attribute Parameter Value parameter). It prohibits all restrictions whose Restriction Usage parameter value is greater than 0.

Choice list:[‘Any Hazmat Prohibited’, ‘Avoid Carpool Roads’, ‘Avoid Express Lanes’, ‘Avoid Ferries’, ‘Avoid Gates’, ‘Avoid Limited Access Roads’, ‘Avoid Private Roads’, ‘Avoid Roads Unsuitable for Pedestrians’, ‘Avoid Stairways’, ‘Avoid Toll Roads’, ‘Avoid Toll Roads for Trucks’, ‘Avoid Truck Restricted Roads’, ‘Avoid Unpaved Roads’, ‘Axle Count Restriction’, ‘Driving a Bus’, ‘Driving a Delivery Vehicle’, ‘Driving a Taxi’, ‘Driving a Truck’, ‘Driving an Automobile’, ‘Driving an Emergency Vehicle’, ‘Height Restriction’, ‘Kingpin to Rear Axle Length Restriction’, ‘Length Restriction’, ‘Preferred for Pedestrians’, ‘Riding a Motorcycle’, ‘Roads Under Construction Prohibited’, ‘Semi or Tractor with One or More Trailers Prohibited’, ‘Single Axle Vehicles Prohibited’, ‘Tandem Axle Vehicles Prohibited’, ‘Through Traffic Prohibited’, ‘Truck with Trailers Restriction’, ‘Use Preferred Hazmat Routes’, ‘Use Preferred Truck Routes’, ‘Walking’, ‘Weight Restriction’, ‘Weight per Axle Restriction’, ‘Width Restriction’]

The service supports the restriction names listed in the following table:

attribute_parameter_values

Optional FeatureSet . Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly prefer them. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. If you specify the Attribute Parameter Values parameter from a feature class, the field names on the feature class must match the fields as described below:

• AttributeName: Lists the name of the restriction.

• ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.

• ParameterValue: The value for ParameterName used by the tool when evaluating the restriction.

  Attribute Parameter Values is dependent on the Restrictions parameter. The ParameterValue field is applicable only if the restriction name is specified as the value for the Restrictions parameter.

  In Attribute Parameter Values, each restriction (listed as AttributeName) has a ParameterName field value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1) - Travel on the roads using the restriction is completely prohibited.

  • AVOID_HIGH (5) - It is highly unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_MEDIUM (2) - It is unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_LOW (1.3) - It is somewhat unlikely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_LOW (0.8) - It is somewhat likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_MEDIUM (0.5) - It is likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_HIGH (0.2) - It is highly likely for the tool to include in the route the roads that are associated with the restriction.

  In most cases, you can use the default value, PROHIBITED, for the Restriction Usage if the restriction is dependent on a vehicle-characteristic such as vehicle height. However, in some cases, the value for Restriction Usage depends on your routing preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the tool will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the tool will go out of its way to travel on the roads associated with the restriction.

route_line_simplif ication_tolerance

Optional LinearUnit. Specify by how much you want to simplify the geometry of the output lines for routes and directions. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. The tool also ignores this parameter if the populate_route_lines parameter is unchecked (False). Simplification maintains critical points on a route, such as turns at intersections, to define the essential shape of the route and removes other points. The simplification distance you specify is the maximum allowable offset that the simplified line can deviate from the original line. Simplifying a line reduces the number of vertices that are part of the route geometry. This improves the tool execution time.

populate_directions

Optional boolean. Specify whether the tool should generate driving directions for each route. Checked (True): Indicates that the directions will be generated and configured based on the values for the Directions Language, Directions Style Name, and Directions Distance Units parameters. Unchecked (False): Directions are not generated, and the tool returns an empty Directions layer.

directions_distance_units

Optional string. Specify the units for displaying travel distance in the driving directions. This parameter is used only when the Populate Directions parameter is checked, or set to True.

Choice list: [‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘NauticalMiles’]

travel_mode

Optional string. Specify 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 better reflect your organization’s workflows. You need to specify the name of a travel mode supported by your organization.

To get a list of supported travel mode names, run the GetTravelModes tool from the Utilities toolbox available under the same GIS Server connection you used to access the tool. The GetTravelModes 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 Travel Mode Settings field as input. This speeds up the tool execution as the tool does not have to lookup 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 travelling by car. You may want to 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 may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization’s administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

time_zone_usage_for _time_windows

Optional string. 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.

Choice list:[‘UTC’, ‘GEO_LOCAL’]

GEO_LOCAL: The 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: The date-time values associated with the orders or depots are in the 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 the eastern standard time is obeying the 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 when 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.

overrides

Optional string. Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems. The value for this parameter needs to 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 a string. The default value for this parameter is no value, which indicates not to override any solver settings. Overrides are advanced settings that should be used only after careful analysis of the results obtained before and after applying the settings. A list of supported override settings for each solver and their acceptable values can be obtained by contacting Esri Technical Support.

time_impedance

Optional string. Specify the time-based impedance, which 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 value for time_impedance and impedance parameters should be identical. Otherwise the service will return an error.

Choice list:[‘Minutes’, ‘TravelTime’, ‘TimeAt1KPH’, ‘WalkTime’, ‘TruckMinutes’, ‘TruckTravelTime’]

output_format

Optional. Specify the format in which the output features are created.

Choose from the following formats:

• Feature Set - The output features are returned as feature classes and tables. This is the default.

• JSON File - The output features are 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 - The output features are 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.

future

Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

ignore_network_location_fields

Optional bool. Specifies whether the newtork location fields will be considered when locating inputs such as stops or facilities on the network. * True - Network location fields will not be considered when locating inputs on the network. Instead, the inputs will always be located by performing a spatial search. * False - Network location fields will be considered when locating inputs on the network. This is the default.

locate_settings

Optional dictionary containing additional input location settings. Use this parameter to specify settings that affect how inputs are located, such as the maximum search distance to use when locating the inputs on the network or the network sources being used for locating. To restrict locating on a portion of the source, you can specify a where clause for a source.

The dictionary of parameters can be assigned to the ‘default’, or to the ‘overrides’ key which holds the dictionary of parameters for each override, types of override are ‘stops’, ‘point_barriers’, ‘line_barriers’, ‘polygon_barriers’. Use the LocateSettings class to create the dictionary for each override or for the default.

from arcgis.network import LocateSettings
locate_settings = LocateSettings(tolerance=5000, tolerance_units=ToleranceUnits.meters, allow_auto_relocate=True, sources=[{"name": "Routing_Streets"}])
result = route_layer.solve(stops=stops, locate_settings={"default": locate_settings.to_dict()})

facilities

Required FeatureSet . The facilities around which service areas are generated. You can load up to 1,000 facilities. The facilities feature set has an associated attribute table. The fields in the attribute table are listed and described below:

• ObjectID: The system-managed ID field.

• Name: The name of the facility. If the name is not specified, a name is automatically generated at solve time.

All fields from the input facilities are included in the output polygons when the Polygons for Multiple Facilities parameter is set to Overlapping or Not Overlapping. The ObjectID field on the input facilities is transferred to the FacilityOID field on the output polygons.

break_units

Required string. The unit for the Break Values parameter. The units you choose for this parameter determine whether the tool will create service areas by measuring driving distance or driving time. Choose a time unit to measure driving time. To measure driving distance, choose a distance unit. Your choice also determines in which units the tool will report total driving time or distance in the results. The choices are: Meters Kilometers Feet Yards Miles Nautical Miles Seconds Minutes Hours Days

Choice list: [‘Meters’, ‘Kilometers’, ‘Feet’, ‘Yards’, ‘Miles’, ‘Nautical Miles’, ‘Seconds’, ‘Minutes’, ‘Hours’, ‘Days’]

travel_direction

Optional string. Specifies whether the direction of travel used to generate the service area polygons is toward or away from the facilities.

• Away From Facility - The service area is generated in the direction away from the facilities.

• Towards Facility - The service area is created in the direction towards the facilities.

The direction of travel may change the shape of the polygons because impedances on opposite sides of streets may differ or one-way restrictions may exist, such as one-way streets. The direction you should choose depends on the nature of your service area analysis. The service area for a pizza delivery store, for example, should be created away from the facility, whereas the service area of a hospital should be created toward the facility.

Choice list: [‘Away From Facility’, ‘Towards Facility’]

use_hierarchy

Optional boolean. Specify whether hierarchy should be used when finding the best route between the facility and the incident.

Checked (True) - Use the hierarchy attribute for the analysis. Using a hierarchy results in the solver preferring higher-order edges to lower-order edges. Hierarchical solves are faster, and they can be used to simulate the preference of a driver who chooses to travel on freeways over local roads when possible-even if that means a longer trip.

Unchecked (False) - Do not use the hierarchy attribute for the analysis. Not using a hierarchy yields an accurate service area measured along all edges of the network dataset regardless of hierarchy level.

Regardless of whether the Use Hierarchy parameter is checked (True), hierarchy is always used when the largest break value exceeds 240 minutes or 240 miles (386.24 kilometers).

polygon_overlap_type

Optional string. Specifies the option to create concentric service area polygons as disks or rings. This option is applicable only when multiple break values are specified for the facilities.

• Rings - The polygons representing larger breaks exclude the polygons of smaller breaks. This creates polygons going between consecutive breaks. Use this option if you want to find the area from one break to another. For instance, if you create 5- and 10-minute service areas, then the 10-minute service area polygon will exclude the area under the 5-minute service area polygon. This is the default value.

• Disks - Creates polygons going from the facility to the break. For instance, if you create 5- and 10-minute service areas, then the 10-minute service area polygon will include the area under the 5-minute service area polygon.

Choice list: [‘Rings’, ‘Disks’]

polygon_trim_distance

Optional LinearUnit. Specifies the distance within which the service area polygons are trimmed. This is useful when finding service areas in places that have a sparse street network and you don’t want the service area to cover large areas where there are no street features.

The default value is 100 meters. No value or a value of 0 for this parameter specifies that the service area polygons should not be trimmed. This parameter value is ignored when using hierarchy.

point_barriers

Optional FeatureSet . Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets. For example, a point barrier can be used to represent a fallen tree along a street or time delay spent at a railroad crossing.

The tool imposes a limit of 250 points that can be added as barriers. When specifying the point barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The point barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the point barrier restricts travel completely or adds time or distance when it is crossed. The value for this attribute is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Restriction) - Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

  • 2 (Added Cost) - Traveling through the barrier increases the travel time or distance by the amount specified in the Additional_Time or Additional_Distance field. This barrier type is referred to as an added-cost point barrier.

• Additional_Time: Indicates how much travel time is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the Break Units value is time based. This field value must be greater than or equal to zero, and its units are the same as those specified in the Break Units parameter.

• Additional_Distance: Indicates how much distance is added when the barrier is traversed. This field is applicable only for added-cost barriers and only if the Break Units value is distance based. The field value must be greater than or equal to zero, and its units are the same as those specified in the Break Units parameter.

polygon_barriers

Optional FeatureSet . Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. The service imposes a limit on the number of streets you can restrict using the Polygon Barriers parameter. While there is no limit on the number of polygons you can specify as the polygon barriers, the combined number of streets intersected by all the polygons should not exceed 2,000. When specifying the polygon barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The polygon barriers can be specified with the following attributes:

• Name: The name of the barrier.

• BarrierType: Specifies whether the barrier restricts travel completely or scales the time or distance for traveling through it. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):

  • 0 (Restriction) - Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

  • 1 (Scaled Cost) - Scales the time or distance required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor fields. If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor 0.25 would mean that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 would mean it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It might be used to model storms that reduce travel speeds in specific regions.

  • ScaledTimeFactor: This is the factor by which the travel time of the streets intersected by the barrier is multiplied. This field is applicable only for scaled-cost barriers and only if the measurement units are time based. The field value must be greater than zero.

  • ScaledDistanceFactor: This is the factor by which the distance of the streets intersected by the barrier is multiplied. This attribute is applicable only for scaled-cost barriers and only if the measurement units are distance based. The attribute value must be greater than zero.

attribute_parameter_values

Optional FeatureSet . Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly 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 feature class, the field names on the feature class must match the fields as described below:

• AttributeName: Lists the name of the restriction.

• ParameterName: Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.

• ParameterValue: The value for ParameterName used by the tool when evaluating the restriction.

  Attribute Parameter Values is dependent on the Restrictions parameter. The ParameterValue field is applicable only if the restriction name is specified as the value for the Restrictions parameter.

  In Attribute Parameter Values, each restriction (listed as AttributeName) has a ParameterName field value, Restriction Usage, that specifies whether the restriction prohibits, avoids, or prefers travel on the roads associated with the restriction and the degree to which the roads are avoided or preferred. The Restriction Usage ParameterName can be assigned any of the following string values or their equivalent numeric values listed within the parentheses:

  • PROHIBITED (-1) - Travel on the roads using the restriction is completely prohibited.

  • AVOID_HIGH (5) - It is highly unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_MEDIUM (2) - It is unlikely for the tool to include in the route the roads that are associated with the restriction.

  • AVOID_LOW (1.3) - It is somewhat unlikely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_LOW (0.8) - It is somewhat likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_MEDIUM (0.5) - It is likely for the tool to include in the route the roads that are associated with the restriction.

  • PREFER_HIGH (0.2) - It is highly likely for the tool to include in the route the roads that are associated with the restriction.

  In most cases, you can use the default value, PROHIBITED, for the Restriction Usage if the restriction is dependent on a vehicle-characteristic such as vehicle height. However, in some cases, the value for Restriction Usage depends on your routing preferences. For example, the Avoid Toll Roads restriction has the default value of AVOID_MEDIUM for the Restriction Usage parameter. This means that when the restriction is used, the tool will try to route around toll roads when it can. AVOID_MEDIUM also indicates how important it is to avoid toll roads when finding the best route; it has a medium priority. Choosing AVOID_LOW would put lower importance on avoiding tolls; choosing AVOID_HIGH instead would give it a higher importance and thus make it more acceptable for the service to generate longer routes to avoid tolls. Choosing PROHIBITED would entirely disallow travel on toll roads, making it impossible for a route to travel on any portion of a toll road. Keep in mind that avoiding or prohibiting toll roads, and thus avoiding toll payments, is the objective for some; in contrast, others prefer to drive on toll roads because avoiding traffic is more valuable to them than the money spent on tolls. In the latter case, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as the value for Restriction Usage. The higher the preference, the farther the tool will go out of its way to travel on the roads associated with the restriction.

travel_mode

Optional string. Specify 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 better reflect your organization’s workflows. You need to specify the name of a travel mode supported by your organization.

To get a list of supported travel mode names, run the GetTravelModes tool from the Utilities toolbox available under the same GIS Server connection you used to access the tool. The GetTravelModes 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 Travel Mode Settings field as input. This speeds up the tool execution as the tool does not have to lookup 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 travelling by car. You may want to 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 may choose to do this to try out different settings to get desired analysis results. Once you have identified the analysis settings, you should work with your organization’s administrator and save these settings as part of new or existing travel mode so that everyone in your organization can rerun the analysis with the same settings.

save_output_network_analysis_layer

Optional boolean. Specify if the tool should save the analysis settings as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application like ArcMap. It is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool. True: Save the network analysis layer file. 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. False: Do not save the network analysis layer file. This is the default.

time_impedance

Optional string. Specify the time-based impedance.

polygon_detail

Optional string. Specify the detail of the polygon you want to create.

Choice list: [“Generalized”, “Standard”, “High”]

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

accumulate_attributes

Optional list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis.

ignore_invalid_locations

Optional boolean. Specifies whether the tool will ignore invalid locations. The default is True.

exclude_sources_from_polygon_generation

Optional list of strings. You can exclude certain network dataset edge sources when generating service area polygons. Polygons will not be generated around the excluded sources, even though they are traversed in the analysis. Excluding a network source from service area polygons does not prevent those sources from being traversed. Excluding sources from service area polygons only influences the shape of the service area polygons. To prevent traversal of a given network source, you must create an appropriate restriction when defining your network dataset.This is useful if you have some network sources that you don’t want included in the polygon generation because they create less accurate polygons or are inconsequential for the service area analysis. For example, when creating a walk-time service area in a multimodal network that includes streets and metro lines, you should choose to exclude the metro lines from polygon generation. Although travelers can use the metro lines, they cannot stop partway along a metro line and enter a nearby building. Instead, they must travel the full length of the metro line, exit the metro system at a station, and use the streets to walk to the building. Generating a polygon feature around a metro line will be inaccurate.

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.

service_name

Required string. Specify the service name containing the tool. The parameter value should be specified using one of the following keywords that reference a particular geoprocessing service. The default value is asyncRoute.

• asyncClosestFacility - The asynchronous geoprocessing service used to perform the closest facility analysis

• asyncLocationAllocation - The asynchronous geoprocessing service used to perform the location-allocation analysis

• asyncRoute - The asynchronous geoprocessing service used to perform the route analysis

• asyncServiceArea - The asynchronous geoprocessing service used to perform the service area analysis

• asyncVRP - The asynchronous geoprocessing service used to perform the vehicle routing problem analysis

• syncVRP - The synchronous geoprocessing service used to perform the vehicle routing problem analysis.

• asyncODCostMatrix

gis

Optional, the GIS on which this tool runs. If not specified, the active GIS is used.