Display Name: FindClosestFacilities
Description: Finds one or more facilities that are closest from an
incident based on travel time or travel distance and outputs the
best routes, driving directions between the incidents and the
chosen facilities, and a copy of the chosen facilities. You can use the tool, for example, to find the
closest hospital to an accident, the closest police cars to a crime
scene, or the closest store to a customer's address., When finding closest facilities, you can specify how many
to find and whether the direction of travel is toward or away from
them. You can also specify the time of day to account for travel
times based on live or predictive traffic conditions for that time
and date. For example, you can use the tool to search for
hospitals within a 15-minute drive time of the site of an accident
at a given time of day. Any hospitals that take longer than 15
minutes to reach based on the traffic conditions will not be
included in the results.
Category:
Help URL: https://sampleserver7.arcgisonline.com/server/rest/directories/arcgisoutput/NetworkAnalysis/SanDiego_GPServer/NetworkAnalysis_SanDiego/FindClosestFacilities.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: Incidents
Data Type: GPFeatureRecordSetLayer
Display Name Incidents
Description: The locations that will be used as starting or ending points in a closest facility analysis. You can specify one or more incidents (up to 5,000). These are the locations from which the tool searches
for the nearby locations.When specifying the incidents, you can set properties for each—such as its name or service time—using the following attributes: NameThe 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. IDA 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 automatically generates a unique identifier for each incident. AdditionalTimeThe amount of time spent at the incident, which is added to the total time of the route. The default value is 0.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. If you are finding the closest fire stations to fire incidents to estimate response times, for example, 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. AdditionalDistanceThe extra distance traveled at the incident, which is added to the total distance of the route. The default value is 0.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. Generally, the location of an incident, such as a home, isn't exactly on the street; it is set back somewhat from the road. This attribute value can be used to model the distance between the incident location and its location on the street if it is important to include that distance in the total travel distance.AdditionalCostThe extra cost spent at the incident, which is added to the total cost of the route. The default value is 0. This attribute value should be used when the travel mode for the analysis uses an impedance attribute that is neither time based nor distance based The units for the attribute values are interpreted to be in unknown units. TargetFacilityCountThe number of facilities that need to be found for the given incident. This field allows you to specify a different number of facilities to find for each incident. For example, using this field you can find the three closest facilities from one incident and the two closest facilities from another incident. CutoffThe impedance value at which to stop searching for facilities from a given incident. This attribute allows you to specify a different cutoff value for each incident. For example, using this attribute you can search for facilities within five minutes travel time from one incident and search for facilities within eight minutes travel time from another incident. CurbApproachSpecifies 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): 0 (Either side of vehicle)—The vehicle can approach and depart the incident in either direction, so a U-turn is allowed at the incident. This setting can be chosen if it is possible and practical for a vehicle to turn around at the incident. This decision may depend on the width of the road and the amount of traffic or whether the incident has a parking lot where vehicles can pull in and turn around. 1 (Right side of vehicle)—When the vehicle approaches and departs the incident, the curb must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)—When the vehicle approaches and departs
the incident, 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 arrive with the bus stop on the left-hand side. 3 (No U-Turn)—When
the vehicle approaches the incident, the curb can be on either side
of the vehicle; however, the vehicle must depart without turning
around. The CurbApproach attribute is designed to work with both types 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, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
ID
(
type: esriFieldTypeString, alias: ID, length: 128
)
-
AdditionalTime
(
type: esriFieldTypeDouble, alias: Additional Time
)
-
AdditionalDistance
(
type: esriFieldTypeDouble, alias: Additional Distance
)
-
CurbApproach
(
type: esriFieldTypeSmallInteger, alias: Curb Approach
)
-
AdditionalCost
(
type: esriFieldTypeDouble, alias: Additional Cost
)
-
Cutoff
(
type: esriFieldTypeDouble, alias: Cutoff
)
-
TargetFacilityCount
(
type: esriFieldTypeInteger, alias: Target Facility Count
)
Features: None.
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: Facilities
Data Type: GPFeatureRecordSetLayer
Display Name Facilities
Description: The locations that will be used as starting or ending points in a closest facility analysis.You can specify one or more facilities (up to 5,000). These are the locations that are searched for when
finding the closest location.When specifying the facilities, you can set properties for each—such as its name or service time—using the following attributes: NameThe 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. IDA unique identifier for the facility. The identifier is included in the output routes 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 automatically generates a unique identifier for each facility. AdditionalTimeThe amount of time spent at the facility, which is added to the total time of the route. The default value is 0. 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. If you are finding the closest fire stations to fire incidents, for example, AdditionalTime can store the
time it takes a crew to don the appropriate protective equipment
and exit the fire station. AdditionalDistanceThe extra distance traveled at the facility, which is added to the total distance of the route. The default value is 0.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. Generally, the location of a facility, such as a fire station, isn't exactly on the street; it is set back somewhat from the road. AdditionalDistance can model the distance between the facility location and its location on the street if it is important to include that distance in the total travel distance. AdditionalCostThe extra cost spent at the facility, which is added to the total cost of the route. The default value is 0. This attribute value should be used when the travel mode for the analysis uses an impedance attribute that is neither time based nor distance based The units for the attribute values are interpreted to be in unknown units. CutoffThe impedance value at which to stop searching for incidents from a given facility. This attribute allows you to specify a different cutoff value for each facility. For example, using this attribute you can search for incidents within five minutes of travel time from one facility and search for incidents within eight minutes of travel time from another facility. CurbApproachSpecifies the direction a vehicle may arrive at and depart
from the facility. 0 (Either side of vehicle)—The vehicle can approach and depart the facility in either direction, so a U-turn is allowed at the facility. This setting can be chosen if it is possible and practical for a vehicle to turn around at the facility. This decision may depend on the width of the road and the amount of traffic or whether the facility has a parking lot where vehicles can pull in and turn around. 1 (Right side of vehicle)—When the vehicle approaches and departs the facility, the facility must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)—When the vehicle approaches and departs
the facility, 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 arrive with the bus stop on the left-hand side. 3 (No U-Turn)—When
the vehicle approaches the facility, the curb can be on either side
of the vehicle; however, the vehicle must depart without turning
around. The CurbApproach attribute is designed to work with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a facility on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a facility from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the facility, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
ID
(
type: esriFieldTypeString, alias: ID, length: 128
)
-
AdditionalTime
(
type: esriFieldTypeDouble, alias: Additional Time
)
-
AdditionalDistance
(
type: esriFieldTypeDouble, alias: Additional Distance
)
-
CurbApproach
(
type: esriFieldTypeSmallInteger, alias: Curb Approach
)
-
AdditionalCost
(
type: esriFieldTypeDouble, alias: Additional Cost
)
-
Cutoff
(
type: esriFieldTypeDouble, alias: Cutoff
)
Features: None.
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: Measurement_Units
Data Type: GPString
Display Name Measurement Units
Description: Specifies the units that will 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 the streets. The units specified 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 the units in which the tool will report total driving time or distance in the results.The options are as follows:MetersKilometersFeetYardsMilesNauticalMilesSecondsMinutesHoursDays
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Minutes
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, NauticalMiles, Seconds, Minutes, Hours, Days, Other ]
Parameter: Analysis_Region
Data Type: GPString
Display Name Analysis Region
Description: This parameter is ignored by the service and specifying a value does not have any effect on the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ Streets_ND ]
Parameter: Number_of_Facilities_to_Find
Data Type: GPLong
Display Name Number of Facilities to Find
Description: The number of
closest facilities to find per incident. This is useful in
situations in which multiple fire engines may be
required from different fire stations, such as a fire. You can specify, for
example, to find the three nearest fire stations to a fire.The value set in this parameter can be overridden on a per-incident basis using the TargetFacilityCount field in the input incidents.The tool can find up to 100 facilities from each incident.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: Cutoff
Data Type: GPDouble
Display Name Cutoff
Description: The travel time or travel distance value at which
to stop searching for facilities for a given incident. For
example, while finding the closest hospitals from the site of an
accident, a cutoff value of 15 minutes means that the tool
will search for the closest hospital within 15 minutes from the
incident. If the closest hospital is 17 minutes away, no routes
will be returned in the output routes. A cutoff value is especially
useful when searching for multiple facilities.When the Travel Direction parameter is set to Facility to Incident, the cutoff can be overridden on a per-facility basis using the Cutoff field in the input facilities. When the Travel Direction parameter is set to Incident To Facility, the cutoff can be overridden on a per-incident basis using the Cutoff field in the input incidents. The units for this parameter are specified by the
Measurement Units parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: Travel_Direction
Data Type: GPString
Display Name Travel Direction
Description: Specifies how the travel direction for the closest
facility search will be measured. Facility to Incident—The direction of travel is from
facilities to incidents. Incident to Facility—The direction of travel is from
incidents to facilities. Each option may 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 drive because of
different travel time in that direction. If you are also setting a value for the Time of Day parameter, 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). Management at a retail store (facility) is more
concerned with the time it takes shoppers (incidents) to reach
the store (facility); therefore, store management commonly chooses Incident to Facility.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Incident to Facility
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ Incident to Facility, Facility to Incident ]
Parameter: Use_Hierarchy
Data Type: GPBoolean
Display Name Use Hierarchy
Description: Specifies whether hierarchy will be used when finding the best
route between the facility and the incident. Checked (True in Python)—Hierarchy will be used when finding routes. When
hierarchy is used, the tool identifies higher-order streets (such as
freeways) before 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
useful when finding routes to faraway facilities, 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, as the tool identifies the
best route from a relatively smaller subset of streets. Unchecked (False in Python)—Hierarchy will not be used when finding routes. If
hierarchy is not used, the tool considers all the streets and doesn't
necessarily identify higher-order streets when finding the route. This is often
used for finding short-distance routes within a city.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Parameter: Time_of_Day
Data Type: GPDate
Display Name Time of Day
Description: The time and date the route will
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 facility, and the total travel time will be based
on traffic conditions. Specifying a time of day results in a more accurate
estimation of travel time between the incident and facility because the
travel time accounts 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Parameter: Time_of_Day_Usage
Data Type: GPString
Display Name Time of Day Usage
Description: Specifies whether the Time of Day parameter value
represents the arrival or departure time for the route. Start Time—The tool considers the Time of Day parameter value as the
departure time from the facility or incident to find the best route. End Time—The tool considers
the Time of Day parameter value as the arrival time at the facility
or incident to find the best route. This option is useful if you want to know the time to
depart from a location so you arrive at the destination at the
time specified in Time of Day.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Start Time
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ Start Time, End Time ]
Parameter: UTurn_at_Junctions
Data Type: GPString
Display Name UTurn at Junctions
Description: Specifies 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 this, the U-turn policy parameter is implicitly specified by the number of edges that 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 option is chosen; however, you can set the individual network locations' CurbApproach attribute 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). Often, networks 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Allowed Only at Intersections and Dead Ends
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Allowed, Not Allowed, Allowed Only at Dead Ends, Allowed Only at Intersections and Dead Ends ]
Parameter: Point_Barriers
Data Type: GPFeatureRecordSetLayer
Display Name Point Barriers
Description: Use this parameter to specify one or more points that will 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
a time delay spent at a railroad crossing. The tool imposes a limit of 250 points that can be added
as barriers.When specifying point barriers, you can set properties for each, such as its name or barrier type, using 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, Additional_Distance, or Additional_Cost field. This barrier type is
referred to as an added cost point barrier. Additional_Time The added travel time when the
barrier is traversed. This field is applicable only for added-cost
barriers and when the Measurement Units parameter 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
Measurement Units parameter. Additional_DistanceThe added distance when the
barrier is traversed. This field is applicable only for added-cost
barriers and when the Measurement Units parameter 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
Measurement Units parameter.Additional_CostThe added cost when the
barrier is traversed. This field is applicable only for added-cost
barriers when the Measurement Units parameter is neither time-based nor distance-based. FullEdgeSpecifies how the restriction point barriers are applied to the edge elements during the analysis. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (False)—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. CurbApproachSpecifies the direction of traffic that is affected by the barrier. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle)—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. Because junctions are points and don't have a side, barriers on junctions affect all vehicles regardless of the curb approach. The CurbApproach attribute works with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a facility on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a facility from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, to arrive at a facility and not have a lane of traffic between the vehicle and the facility, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.BearingThe direction in which a point is moving. The units are degrees and are measured clockwise from true north. This field is used in conjunction with the BearingTol field. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this field tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the tool determine on which side of the street the point is. BearingTolThe bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing field. If the value from the Bearing field is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees, and the default value is 30. Values must be greater than 0 and less than 180. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. NavLatencyThis field is only used in the solve process if Bearing and BearingTol also have values; however, entering a NavLatency value is optional, even when values are present in Bearing and BearingTol. NavLatency indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The units of NavLatency are the same as the units of the impedance attribute.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
BarrierType
(
type: esriFieldTypeInteger, alias: Barrier Type
)
-
Additional_Time
(
type: esriFieldTypeDouble, alias: Additional Time
)
-
Additional_Distance
(
type: esriFieldTypeDouble, alias: Additional Distance
)
-
AdditionalCost
(
type: esriFieldTypeDouble, alias: Additional Cost
)
-
CurbApproach
(
type: esriFieldTypeSmallInteger, alias: Curb Approach
)
-
FullEdge
(
type: esriFieldTypeInteger, alias: Full Edge
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Barriers
Parameter: Line_Barriers
Data Type: GPFeatureRecordSetLayer
Display Name Line Barriers
Description: Use this parameter to 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 to
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 name and barrier type properties for each using the following attributes:
Name The name of the barrier.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
SHAPE_Length
(
type: esriFieldTypeDouble, alias: SHAPE_Length
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Barriers
Parameter: Polygon_Barriers
Data Type: GPFeatureRecordSetLayer
Display Name Polygon Barriers
Description: Use this parameter to 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 to the number of polygons you can specify as polygon
barriers, the combined number of streets intersected by all the
polygons cannot exceed 2,000.When specifying the polygon barriers, you can set properties for each, such as its name or barrier type, using the following attributes:
Name The name of the barrier. BarrierType Specifies whether the barrier restricts travel completely
or scales the cost (such as 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 cost (such as travel time or distance) required to travel the
underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor field. If the streets are partially
covered by the barrier, the travel time or distance is apportioned
and then scaled. For example, a factor of 0.25 means that travel
on underlying streets is expected to be four times faster than
normal. A factor of 3.0 means 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
can 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. The field value must be greater than zero. This field is applicable only for scaled-cost
barriers and when the Measurement Units parameter is time-based. ScaledDistanceFactor This is the factor by which the distance 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 when the Measurement Units parameter is distance-based. 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 when the Measurement Units parameter is neither time-based nor distance-based.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
BarrierType
(
type: esriFieldTypeInteger, alias: Barrier Type
)
-
ScaledTimeFactor
(
type: esriFieldTypeDouble, alias: Scaled Time Factor
)
-
ScaledDistanceFactor
(
type: esriFieldTypeDouble, alias: Scaled Distance Factor
)
-
ScaledCostFactor
(
type: esriFieldTypeDouble, alias: Scaled Cost Factor
)
-
SHAPE_Length
(
type: esriFieldTypeDouble, alias: SHAPE_Length
)
-
SHAPE_Area
(
type: esriFieldTypeDouble, alias: SHAPE_Area
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Barriers
Parameter: Restrictions
Data Type: GPMultiValue:GPString
Display Name Restrictions
Description: The restrictions that will be honored by the tool when finding the best routes.A restriction represents a driving
preference or requirement. In most cases, restrictions cause roads
to be prohibited. For instance, using the Avoid Toll Roads restriction will result in a route that will include toll roads only when it is required to travel on toll roads to visit an incident or a facility. Height Restriction makes it possible to route around any clearances that are lower than the height of your vehicle. If you are carrying corrosive materials on your vehicle, using the Any Hazmat Prohibited restriction prevents hauling the materials along roads where it is marked illegal to do so. The values you provide for this parameter are ignored unless Travel Mode is set to Custom.Some restrictions require an additional value to be
specified for their use. This value must 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 in 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 determine whether the restriction is available in a particular country by reviewing the table in the Country list section of Network analysis coverage. If a country has a value of Yes in the Logistics Attribute column, the restriction with select availability in the region is supported in that country. If you specify restriction names that are not available in the country where your incidents are located, the service ignores the invalid restrictions. The service also ignores restrictions when the Restriction Usage attribute parameter value is between 0 and 1 (see the Attribute Parameter Value parameter). It prohibits all restrictions when the Restriction Usage parameter value is greater than 0.The tool supports the following restrictions: Any Hazmat Prohibited—The results will not include roads
where transporting any kind of hazardous material is
prohibited. Availability: Select countries in North America and Europe Avoid Carpool Roads—The results will avoid roads that are
designated exclusively for car pool (high-occupancy)
vehicles. Availability: All countries Avoid Express Lanes—The results will avoid roads designated
as express lanes. Availability: All countries Avoid Ferries—The results will avoid ferries. Availability: All countries Avoid Gates—The results will avoid roads where there are
gates, such as keyed access or guard-controlled
entryways.Availability: All countries Avoid Limited Access Roads—The results will avoid roads
that are limited-access highways. Availability: All countries Avoid Private Roads—The results will avoid roads that are
not publicly owned and maintained. Availability: All countries Avoid Roads Unsuitable for Pedestrians—The results will avoid roads that are
unsuitable for pedestrians. Availability: All countries Avoid Stairways—The results will avoid all stairways on a pedestrian-suitable route. Availability: All countries Avoid Toll Roads—The results will avoid all toll
roads for automobiles.Availability: All countries Avoid Toll Roads for Trucks—The results will avoid all toll
roads for trucks.Availability: All countries Avoid Truck Restricted Roads—The results will avoid roads where trucks are not allowed, except when making deliveries.Availability: All countries Avoid Unpaved Roads—The results will avoid roads that are
not paved (for example, dirt, gravel, and so on). Availability: All countries Axle Count Restriction—The results will not include roads
where trucks with the specified number of axles are prohibited. The
number of axles can be specified using the Number of Axles
restriction parameter.Availability: Select countries in North America and Europe Driving a Bus—The results will not include roads where
buses are prohibited. Using this restriction will also ensure that
the results will honor one-way streets. Availability: All countries Driving a Taxi—The results will not include roads where
taxis are prohibited. Using this restriction will also ensure that
the results will honor one-way streets. Availability: All countries Driving a Truck—The results will not include roads where
trucks are prohibited. Using this restriction will also ensure that
the results will honor one-way streets. Availability: All countries Driving an Automobile—The results will not include roads
where automobiles are prohibited. Using this restriction will also
ensure that the results will honor one-way streets. Availability: All countries Driving an Emergency Vehicle—The results will not include
roads where emergency vehicles are prohibited. Using this
restriction will also ensure that the results will honor one-way
streets. Availability: All countries Height Restriction—The results will not include roads
where the vehicle height exceeds the maximum allowed height for the
road. The vehicle height can be specified using the Vehicle Height
(meters) restriction parameter. Availability: Select countries in North America and Europe Kingpin to Rear Axle Length Restriction—The results will
not include roads where the vehicle length exceeds the maximum
allowed kingpin to rear axle for all trucks on the road. The length
between the vehicle kingpin and the rear axle can be specified
using the Vehicle Kingpin to Rear Axle Length (meters) restriction
parameter. Availability: Select countries in North America and Europe Length Restriction—The results will not include roads
where the vehicle length exceeds the maximum allowed length for the
road. The vehicle length can be specified using the Vehicle Length
(meters) restriction parameter. Availability: Select countries in North America and Europe Preferred for Pedestrians—The results will use preferred routes suitable for pedestrian navigation. Availability: Select countries in North America and Europe Riding a Motorcycle—The results will not include roads
where motorcycles are prohibited. Using this restriction will also
ensure that the results will honor one-way streets. Availability: All countries Roads Under Construction Prohibited—The results will not
include roads that are under construction.Availability: All countries Semi or Tractor with One or More Trailers Prohibited—The
results will not include roads where semis or tractors with one or
more trailers are prohibited. Availability: Select countries in North America and Europe Single Axle Vehicles Prohibited—The results will not
include roads where vehicles with single axles are
prohibited.Availability: Select countries in North America and Europe Tandem Axle Vehicles Prohibited—The results will not
include roads where vehicles with tandem axles are
prohibited.Availability: Select countries in North America and Europe Through Traffic Prohibited—The results will not include
roads where through traffic (non-local) is prohibited.Availability: All countries Truck with Trailers Restriction—The results will not
include roads where trucks with the specified number of trailers on
the truck are prohibited. The number of trailers on the truck can
be specified using the Number of Trailers on Truck restriction
parameter.Availability: Select countries in North America and Europe Use Preferred Hazmat Routes—The results will prefer roads
that are designated for transporting any kind of hazardous
materials. Availability: Select countries in North America and Europe Use Preferred Truck Routes—The results will prefer roads
that are designated as truck routes, such as the roads that are
part of the national network as specified by the National Surface
Transportation Assistance Act in the United States, or roads that
are designated as truck routes by the state or province, or roads
that are preferred by truckers when driving in an
area.Availability: Select countries in North America and Europe Walking—The results will not include roads where
pedestrians are prohibited.Availability: All countries Weight Restriction—The results will not include roads
where the vehicle weight exceeds the maximum allowed weight for the
road. The vehicle weight can be specified using the Vehicle Weight
(kilograms) restriction parameter.Availability: Select countries in North America and Europe Weight per Axle Restriction—The results will not include
roads where the vehicle weight per axle exceeds the maximum allowed
weight per axle for the road. The vehicle weight per axle can be
specified using the Vehicle Weight per Axle (kilograms) restriction
parameter.Availability: Select countries in North America and Europe Width Restriction—The results will not include roads where
the vehicle width exceeds the maximum allowed width for the road.
The vehicle width can be specified using the Vehicle Width (meters)
restriction parameter.Availability: Select countries in North America and Europe The Driving a Delivery Vehicle restriction attribute is no longer available. The service will ignore this restriction since it is invalid. To achieve similar results, use the Driving a Truck restriction attribute along with the Avoid Truck Restricted Roads restriction attribute.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: [
Avoid Carpool Roads, Avoid Express Lanes, Avoid Gates, Avoid Private Roads, Avoid Unpaved Roads, Driving an Automobile, Through Traffic Prohibited
]
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Any Hazmat Prohibited, Avoid Carpool Roads, Avoid Express Lanes, Avoid Ferries, Avoid Gates, Avoid Limited Access Roads, Avoid Private Roads, Avoid Toll Roads, Avoid Truck Restricted Roads, Avoid Unpaved Roads, Driving a Bus, Driving a Delivery Vehicle, Driving a Taxi, Driving a Truck, Driving an Automobile, Driving an Emergency Vehicle, Height Restriction, Length Restriction, Through Traffic Prohibited, Use Preferred Hazmat Routes, Use Preferred Truck Routes, Walking, Weight Restriction ]
Parameter: Attribute_Parameter_Values
Data Type: GPRecordSet
Display Name Attribute Parameter Values
Description: Use this parameter to specify additional values required by an attribute or restriction, such as to specify whether the restriction prohibits, avoids, or prefers travel on restricted roads. If the restriction is
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 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 follows:AttributeName—The name of the restriction.ParameterName—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. The Attribute Parameter Values parameter 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 as well as 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 in the parentheses: PROHIBITED (-1)—Travel on the roads using the restriction is completely
prohibited. AVOID_HIGH (5)—It
is highly unlikely the tool will include in the route the roads
that are associated with the restriction. AVOID_MEDIUM (2)—It
is unlikely the tool will include in the route the roads that are
associated with the restriction. AVOID_LOW (1.3)—It
is somewhat unlikely the tool will include in the route the roads
that are associated with the restriction. PREFER_LOW (0.8)—It
is somewhat likely the tool will include in the route the roads
that are associated with the restriction. PREFER_MEDIUM (0.5)—It is likely the tool will include in the route the roads that
are associated with the restriction. PREFER_HIGH (0.2)—It is highly likely the tool will include in the route the roads
that are associated with the restriction. In most cases, you can use the default value, PROHIBITED,
as the Restriction Usage value if the restriction is dependent on a
vehicle characteristic such as vehicle height. However, in some
cases, the Restriction Usage value depends on your routing
preferences. For example, the Avoid Toll Roads restriction has the
default value of AVOID_MEDIUM for the Restriction Usage attribute.
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 puts lower
importance on avoiding tolls; choosing AVOID_HIGH instead gives it a higher importance and thus makes it more acceptable for
the service to generate longer routes to avoid tolls. Choosing
PROHIBITED entirely disallows 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, 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
AttributeName
(
type: esriFieldTypeString, alias: AttributeName, length: 255
)
-
ParameterName
(
type: esriFieldTypeString, alias: ParameterName, length: 255
)
-
ParameterValue
(
type: esriFieldTypeString, alias: ParameterValue, length: 25
)
Features: # records: 27
OBJECTID: 1
AttributeName: Any Hazmat Prohibited
ParameterName: Restriction Usage
ParameterValue: PROHIBITED
OBJECTID: 2
AttributeName: Avoid Carpool Roads
ParameterName: Restriction Usage
ParameterValue: PROHIBITED
OBJECTID: 3
AttributeName: Avoid Express Lanes
ParameterName: Restriction Usage
ParameterValue: PROHIBITED
more...
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Parameter: Route_Shape
Data Type: GPString
Display Name Route Shape
Description: Specifies the type of route features that are output by the
tool. True Shape—Return the exact shape of the resulting route
that is based on the underlying streets. True Shape with Measures—Return the exact shape of the resulting route that is based on the underlying streets. Additionally, construct measures so the shape can be used in linear referencing. The measurements increase from the first stop and record the cumulative travel time or travel distance in the units specified by the Measurement Units parameter. Straight Line—Return a straight line between two stops. None—Do not return any shapes for the routes. This value
can be useful, and return results quickly, in cases where you are only interested in determining
the total travel time or travel distance of a route. When the Route Shape parameter is set to True Shape or True Shape with Measures, the
generalization of the route shape can be further controlled using
the appropriate value for the Route Line Simplification Tolerance parameter. No matter which value you choose for the Route Shape parameter, the best route is always determined by minimizing the
travel time or the travel distance, never using the straight-line
distance between stops. This means that only the route shapes are different,
not the underlying streets that are searched when finding the
route.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: True Shape
Parameter Type: esriGPParameterTypeOptional
Category: Output
Choice List: [ True Shape, True Shape with Measures, Straight Line, None ]
Parameter: Route_Line_Simplification_Tolerance
Data Type: GPLinearUnit
Display Name Route Line Simplification Tolerance
Description: The distance that will be used to simplify the geometry of the output lines for routes and directions.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 10.0 (esriMeters)
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Parameter: Populate_Directions
Data Type: GPBoolean
Display Name Populate Directions
Description: Specifies whether the tool will generate driving directions for
each route. Checked (True in Python)—Directions will be generated
and configured based on the values of the Directions Language,
Directions Style Name, and Directions Distance Units parameters. Unchecked (False in Python)—Directions will not be generated, and the tool
will return an empty Directions layer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output
Parameter: Directions_Language
Data Type: GPString
Display Name Directions Language
Description: The language that will be used when generating
travel directions. This parameter is used only when the Populate
Directions parameter is checked (True in Python). The parameter value can be
specified using one of the following two- or five-character language codes: ar—Arabic bs—Bosnian ca—Catalancs—Czech da—Danish de—German el—Greek en—English es—Spanish et—Estonian fi—Finnish fr—French he—Hebrew hr—Croatian hu—Hungarian id—Indonesian it—Italian ja—Japanese ko—Korean lt—Lithuanian lv—Latvian nb—Norwegian nl—Dutch pl—Polish pt-BR—Brazilian
Portuguese pt-PT—European
Portuguese ro—Romanian ru—Russian sl—Slovenian sr—Serbian sv—Swedish th—Thaitr—Turkishuk—Ukrainian vi—Vietnamese zh-CN—Simplified
Chinese zh-HK—Traditional Chinese (Hong Kong)
zh-TW—Traditional Chinese (Taiwan)
The tool first searches for an exact match for the specified language including any language localization. If an exact match is not found, it tries to match the language family. If a match is still not found, the tool returns the directions using the default language, English. For example, if the directions language is specified as es-MX (Mexican Spanish), the tool will return the directions in Spanish, as it supports the es language code but not es-MX.If a language supports localization, such as Brazilian Portuguese (pt-BR) and European Portuguese (pt-PT), specify the language family and the localization. If you only specify the language family, the tool will not match the language family and instead return directions in the default language, English. For example, if the directions language specified is pt, the tool will return the directions in English since it cannot determine whether the directions should be returned in pt-BR or pt-PT.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: en
Parameter Type: esriGPParameterTypeOptional
Category: Output
Parameter: Directions_Distance_Units
Data Type: GPString
Display Name Directions Distance Units
Description: Specifies the units that will display travel distance in the
driving directions. This parameter is used only when the Populate
Directions parameter is checked (True in Python).MilesKilometersMetersFeetYardsNauticalMiles
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Miles
Parameter Type: esriGPParameterTypeOptional
Category: Output
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, NauticalMiles ]
Parameter: Directions_Style_Name
Data Type: GPString
Display Name Directions Style Name
Description: Specifies the name of the formatting style for the
directions. This parameter is used only when the Populate Directions parameter is checked (True in Python). NA Desktop—Turn-by-turn directions suitable
for printing. NA Navigation—Turn-by-turn directions designed
for an in-vehicle navigation device.NA Campus—Turn-by-turn walking directions designed
for pedestrian routes.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: NA Desktop
Parameter Type: esriGPParameterTypeOptional
Category: Output
Choice List: [ NA Desktop, NA Navigation, NA Campus ]
Parameter: Time_Zone_for_Time_of_Day
Data Type: GPString
Display Name Time Zone for Time of Day
Description: 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 facilities or incidents are located. If Time of Day Usage is set to Start Time and Travel Direction is Facility to Incident, this is the time zone of the facilities. If Time of Day Usage is set to Start Time and Travel Direction is Incident to Facility, this is the time zone of the incidents. If Time of Day Usage is set to End Time and Travel Direction is Facility to Incident, this is the time zone of the incidents. If Time of Day Usage is set to End Time and Travel Direction is Incident to Facility, this is the time zone of the facilities. UTC—The Time of Day parameter refers to coordinated universal time (UTC). Choose this option if you want to find what's nearest for a specific time, such as now, but aren't certain in which time zone the facilities or incidents will be located. Regardless of the Time Zone for Time of Day setting, if your facilities
and incidents are in multiple time zones, the following rules are
enforced by the tool. All incidents and facilities must be in the same time zone
for the following: Specifying a start time and traveling from incident to
facility Specifying an end time and traveling from facility to
incident Specifying a start time and traveling from facility to
incident Specifying an end time and traveling from incident to
facility
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Geographically Local
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ Geographically Local, UTC ]
Parameter: Travel_Mode
Data Type: GPString
Display Name Travel Mode
Description: The mode of transportation to model in the analysis. Travel modes are managed in ArcGIS Online and can be configured by the administrator of your organization to reflect your organization's workflows. You need to specify the name of a travel mode that is supported by your organization. To get a list of supported travel mode names, use the same GIS server connection you used to access this tool, and run the GetTravelModes tool in the Utilities toolbox. The GetTravelModes tool adds the Supported Travel Modes table to the application. Any value in the Travel Mode Name field from the Supported Travel Modes table can be specified as input. You can also specify the value from the Travel Mode Settings field as input. This reduces the tool execution time because the tool does not have to find the settings based on the travel mode name. The default value, Custom, allows you to configure your own travel mode using the custom travel mode parameters (UTurn at Junctions, Use Hierarchy, Restrictions, Attribute Parameter Values, and Impedance). The default values of the custom travel mode parameters model traveling by car. You can also choose Custom and set the custom travel mode parameters listed above to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You can try different settings to get the analysis results you want. Once you have identified the analysis settings, work with your organization's administrator and save these settings as part of a new or existing travel mode so that everyone in your organization can run the analysis with the same settings. When you choose Custom, the values you set for the custom travel mode parameters are included in the analysis. Specifying another travel mode, as defined by your organization, causes any values you set for the custom travel mode parameters to be ignored; the tool overrides them with values from your specified travel mode.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Custom
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: Impedance
Data Type: GPString
Display Name Impedance
Description: Specify the impedance.Impedance is a value that quantifies travel along the transportation network. Travel distance is an example of impedance; it quantifies the length of walkways and road segments. Similarly, drive time—the typical time it takes to drive a car along a road segment—is an example of impedance. Drive times may vary by type of vehicle—for instance, the time it takes for a truck to travel along a path tends to be longer than a car—so there can be many impedance values representing travel times for different vehicle types. Impedance values may also vary with time; live and typical traffic reference dynamic impedance values. Each walkway and road segment stores at least one impedance value. When performing a network analysis, the impedance values are used to calculate the best results, such as finding the shortest route—the route that minimizes impedance—between two points.The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.The impedanceAttributeName parameter can be specified using the following values:TravelTime—Historical and live traffic data is used. This option is good for modeling the time it takes automobiles to travel along roads at a specific time of day using live traffic speed data where available. When using TravelTime, you can optionally set the TravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the vehicle is capable of traveling.Minutes—Live traffic data is not used, but historical average speeds for automobiles data is used.TruckTravelTime—Historical and live traffic data is used, but the speed is capped at the posted truck speed limit. This is good for modeling the time it takes for the trucks to travel along roads at a specific time. When using TruckTravelTime, you can optionally set the TruckTravelTime::Vehicle Maximum Speed (km/h) attribute parameter to specify the physical limitation of the speed the truck is capable of traveling.TruckMinutes—Live traffic data is not used, but the smaller of the historical average speeds for automobiles and the posted speed limits for trucks are used.WalkTime—The default is a speed of 5 km/hr on all roads and paths, but this can be configured through the WalkTime::Walking Speed (km/h) attribute parameter.Miles—Length measurements along roads are stored in miles and can be used for performing analysis based on shortest distance.Kilometers—Length measurements along roads are stored in kilometers and can be used for performing analysis based on shortest distance.TimeAt1KPH—The default is a speed of 1 km/hr on all roads and paths. The speed cannot be changed using any attribute parameter.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.If you choose a time-based impedance, such as TravelTime, TruckTravelTime, Minutes, TruckMinutes, or WalkTime, the Measurement Units parameter must be set to a time-based value. If you choose a distance-based impedance, such as Miles or Kilometers, Measurement Units must be distance-based.Drive Time, Truck Time, Walk Time, and Travel Distance impedance values are no longer supported and will be removed in a future release. If you use one of these values, the tool uses the value of the Time Impedance parameter for time-based values and the Distance Impedance parameter for distance-based values.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Drive Time
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Drive Time, Truck Time, Walk Time, Travel Distance, Minutes, TravelTime, TruckTravelTime, TimeAt1KPH, WalkTime, Kilometers, Miles ]
Parameter: Save_Output_Network_Analysis_Layer
Data Type: GPBoolean
Display Name Save Output Network Analysis Layer
Description: Specifies whether the analysis settings will be saved as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application such as ArcMap. It is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.
Checked (True in Python)—The output will be saved as a network analysis layer file. The file will be downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False in Python)—The output will not be saved as a network analysis layer file. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output
Parameter: Overrides
Data Type: GPString
Display Name Overrides
Description: Additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.
The value for this parameter must be specified in JavaScript Object Notation (JSON). For example, a valid value is of the following form: {"overrideSetting1" : "value1", "overrideSetting2" : "value2"}. The override setting name is always enclosed in double quotation marks. The values can be a number, Boolean, or string. The default value for this parameter is no
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. For a list of supported override settings
for each solver and their acceptable values, contact Esri Technical Support.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Parameter: Save_Route_Data
Data Type: GPBoolean
Display Name Save Route Data
Description: Specifies whether the output will include a .zip file
that contains a file geodatabase with the inputs and outputs of
the analysis in a format that can be used to share route layers
with ArcGIS Online or Portal for ArcGIS.Checked (True in Python)—The route data will be saved as a .zip file. The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Route Data parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False in Python)—The route data will not be saved as a .zip file. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Output
Parameter: Time_Impedance
Data Type: GPString
Display Name Time Impedance
Description: The time-based impedance is a value that represents the travel time along road segments or on other parts of the transportation network.If the impedance for the travel mode, as specified using the Impedance parameter, is time based, the values for the Time Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: TravelTime
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Minutes, TravelTime, TruckTravelTime, TimeAt1KPH, WalkTime ]
Parameter: Distance_Impedance
Data Type: GPString
Display Name Distance Impedance
Description: The distance-based impedance is a value that represents the travel distance 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 distance based, the values for the Distance Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.These value are specific to the services published with the ArcGIS StreetMap Premium data. The values will be different if you are using your own data for the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Miles
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Kilometers, Miles ]
Parameter: Output_Format
Data Type: GPString
Display Name Output Format
Description: Specifies the format in which the output features will be created. Feature Set—The output features will be returned as feature classes and tables. This is the default. JSON File—The output features will be returned as a compressed file containing the JSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more JSON files (with a .json extension) for each of the outputs created by the service. GeoJSON File—The output features will be returned as a compressed file containing the GeoJSON representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more GeoJSON files (with a .geojson extension) for each of the outputs created by the service.When a file-based output format, such as JSON File or GeoJSON File, is specified, no outputs will be added to the display because the application, such as ArcMap or ArcGIS Pro, cannot draw the contents of the result file. Instead, the result file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Result File parameter in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Result File parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Feature Set
Parameter Type: esriGPParameterTypeOptional
Category: Output
Choice List: [ Feature Set, JSON File, GeoJSON File ]
Parameter: Accumulate_Attributes
Data Type: GPMultiValue:GPString
Display Name Accumulate Attributes
Description: A 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 your 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Network Datasets
Choice List: [ Minutes, TravelTime, TruckTravelTime, TimeAt1KPH, WalkTime, Kilometers, Miles ]
Parameter: Ignore_Network_Location_Fields
Data Type: GPBoolean
Display Name Ignore Network Location Fields
Description: Specifies whether the network location fields will be considered when locating inputs such as stops or facilities on the network.
Checked (True in Python)—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. This is the default value.Unchecked (False in Python)—Network location fields will be considered when locating the inputs on the network.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category: Network Locations
Parameter: Ignore_Invalid_Locations
Data Type: GPBoolean
Display Name Ignore Invalid Locations
Description: Specifies whether invalid input locations will be ignored.
Checked—The network locations that are unlocated will be skipped and the analysis will run using valid network locations only. The analysis will also continue if locations are on nontraversable elements or have other errors. This is useful if you know your network locations are not all correct, but you want to run the analysis with the network locations that are valid. This is the default. Unchecked—Do not run the analysis if there are invalid locations. You can then correct these and rerun the analysis.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Network Locations
Parameter: Output_Routes
Data Type: GPFeatureRecordSetLayer
Display Name Output Routes
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: true
Spatial Reference: 4326
(4326)
Fields:
-
ObjectID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
FacilityRank
(
type: esriFieldTypeInteger, alias: FacilityRank
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 1024
)
-
IncidentCurbApproach
(
type: esriFieldTypeInteger, alias: IncidentCurbApproach
)
-
FacilityCurbApproach
(
type: esriFieldTypeInteger, alias: FacilityCurbApproach
)
-
StartTime
(
type: esriFieldTypeDate, alias: StartTime, length: 16
)
-
EndTime
(
type: esriFieldTypeDate, alias: EndTime, length: 16
)
-
StartTimeUTC
(
type: esriFieldTypeDate, alias: StartTimeUTC, length: 16
)
-
EndTimeUTC
(
type: esriFieldTypeDate, alias: EndTimeUTC, length: 16
)
-
FacilityID
(
type: esriFieldTypeString, alias: FacilityID, length: 500
)
-
IncidentID
(
type: esriFieldTypeString, alias: IncidentID, length: 500
)
-
Total_Miles
(
type: esriFieldTypeDouble, alias: Total_Miles
)
-
Total_Kilometers
(
type: esriFieldTypeDouble, alias: Total_Kilometers
)
-
Total_Minutes
(
type: esriFieldTypeDouble, alias: Total_Minutes
)
-
FacilityOID
(
type: esriFieldTypeInteger, alias: FacilityOID
)
-
IncidentOID
(
type: esriFieldTypeInteger, alias: IncidentOID
)
-
Shape_Length
(
type: esriFieldTypeDouble, alias: Shape_Length
)
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Directions
Data Type: GPFeatureRecordSetLayer
Display Name Output Directions
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: true
Spatial Reference: 4326
(4326)
Fields:
-
ObjectID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
RouteName
(
type: esriFieldTypeString, alias: RouteName, length: 1024
)
-
ArriveTime
(
type: esriFieldTypeDate, alias: ArriveTime
)
-
SubItemType
(
type: esriFieldTypeSmallInteger, alias: SubItemType
)
-
Type
(
type: esriFieldTypeSmallInteger, alias: Type
)
-
Text
(
type: esriFieldTypeString, alias: Text, length: 1024
)
-
ElapsedTime
(
type: esriFieldTypeSingle, alias: ElapsedTime
)
-
DriveDistance
(
type: esriFieldTypeSingle, alias: DriveDistance
)
-
Shape_Length
(
type: esriFieldTypeDouble, alias: Shape_Length
)
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Solve_Succeeded
Data Type: GPBoolean
Display Name Solve Succeeded
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Closest_Facilities
Data Type: GPFeatureRecordSetLayer
Display Name Output Closest Facilities
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
ObjectID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
SourceID
(
type: esriFieldTypeInteger, alias: SourceID
)
-
SourceOID
(
type: esriFieldTypeInteger, alias: SourceOID
)
-
PosAlong
(
type: esriFieldTypeDouble, alias: PosAlong
)
-
SideOfEdge
(
type: esriFieldTypeInteger, alias: SideOfEdge
)
-
CurbApproach
(
type: esriFieldTypeInteger, alias: CurbApproach
)
-
Status
(
type: esriFieldTypeInteger, alias: Status
)
-
SnapX
(
type: esriFieldTypeDouble, alias: SnapX
)
-
SnapY
(
type: esriFieldTypeDouble, alias: SnapY
)
-
SnapZ
(
type: esriFieldTypeDouble, alias: SnapZ
)
-
DistanceToNetworkInMeters
(
type: esriFieldTypeDouble, alias: DistanceToNetworkInMeters
)
-
AdditionalDistance
(
type: esriFieldTypeDouble, alias: AdditionalDistance
)
-
AdditionalTime
(
type: esriFieldTypeDouble, alias: AdditionalTime
)
-
Cutoff
(
type: esriFieldTypeDouble, alias: Cutoff
)
-
ID
(
type: esriFieldTypeString, alias: ID, length: 500
)
-
ORIG_FID
(
type: esriFieldTypeInteger, alias: ORIG_FID
)
-
Bearing
(
type: esriFieldTypeDouble, alias: Bearing
)
-
BearingTol
(
type: esriFieldTypeDouble, alias: BearingTol
)
-
NavLatency
(
type: esriFieldTypeDouble, alias: NavLatency
)
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Network_Analysis_Layer
Data Type: GPDataFile
Display Name Output Network Analysis Layer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Route_Data
Data Type: GPDataFile
Display Name Output Route Data
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Incidents
Data Type: GPFeatureRecordSetLayer
Display Name Output Incidents
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
ObjectID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
TargetFacilityCount
(
type: esriFieldTypeInteger, alias: TargetFacilityCount
)
-
SourceID
(
type: esriFieldTypeInteger, alias: SourceID
)
-
SourceOID
(
type: esriFieldTypeInteger, alias: SourceOID
)
-
PosAlong
(
type: esriFieldTypeDouble, alias: PosAlong
)
-
SideOfEdge
(
type: esriFieldTypeInteger, alias: SideOfEdge
)
-
CurbApproach
(
type: esriFieldTypeInteger, alias: CurbApproach
)
-
Status
(
type: esriFieldTypeInteger, alias: Status
)
-
SnapX
(
type: esriFieldTypeDouble, alias: SnapX
)
-
SnapY
(
type: esriFieldTypeDouble, alias: SnapY
)
-
SnapZ
(
type: esriFieldTypeDouble, alias: SnapZ
)
-
DistanceToNetworkInMeters
(
type: esriFieldTypeDouble, alias: DistanceToNetworkInMeters
)
-
AdditionalDistance
(
type: esriFieldTypeDouble, alias: AdditionalDistance
)
-
AdditionalTime
(
type: esriFieldTypeDouble, alias: AdditionalTime
)
-
Cutoff
(
type: esriFieldTypeDouble, alias: Cutoff
)
-
IncidentOID
(
type: esriFieldTypeInteger, alias: IncidentOID
)
-
Bearing
(
type: esriFieldTypeDouble, alias: Bearing
)
-
BearingTol
(
type: esriFieldTypeDouble, alias: BearingTol
)
-
NavLatency
(
type: esriFieldTypeDouble, alias: NavLatency
)
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Facilities
Data Type: GPFeatureRecordSetLayer
Display Name Output Facilities
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 4326
(4326)
Fields:
-
ObjectID
(
type: esriFieldTypeOID, alias: ObjectID
)
-
Name
(
type: esriFieldTypeString, alias: Name, length: 500
)
-
SourceID
(
type: esriFieldTypeInteger, alias: SourceID
)
-
SourceOID
(
type: esriFieldTypeInteger, alias: SourceOID
)
-
PosAlong
(
type: esriFieldTypeDouble, alias: PosAlong
)
-
SideOfEdge
(
type: esriFieldTypeInteger, alias: SideOfEdge
)
-
CurbApproach
(
type: esriFieldTypeInteger, alias: CurbApproach
)
-
Status
(
type: esriFieldTypeInteger, alias: Status
)
-
SnapX
(
type: esriFieldTypeDouble, alias: SnapX
)
-
SnapY
(
type: esriFieldTypeDouble, alias: SnapY
)
-
SnapZ
(
type: esriFieldTypeDouble, alias: SnapZ
)
-
DistanceToNetworkInMeters
(
type: esriFieldTypeDouble, alias: DistanceToNetworkInMeters
)
-
AdditionalDistance
(
type: esriFieldTypeDouble, alias: AdditionalDistance
)
-
AdditionalTime
(
type: esriFieldTypeDouble, alias: AdditionalTime
)
-
Cutoff
(
type: esriFieldTypeDouble, alias: Cutoff
)
-
FacilityOID
(
type: esriFieldTypeInteger, alias: FacilityOID
)
-
Bearing
(
type: esriFieldTypeDouble, alias: Bearing
)
-
BearingTol
(
type: esriFieldTypeDouble, alias: BearingTol
)
-
NavLatency
(
type: esriFieldTypeDouble, alias: NavLatency
)
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Result_File
Data Type: GPDataFile
Display Name Output Result File
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Network_Analysis_Layer_Package
Data Type: GPDataFile
Display Name Output Network Analysis Layer Package
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Direction_Points
Data Type: GPFeatureRecordSetLayer
Display Name Output Direction Points
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: Output_Direction_Lines
Data Type: GPFeatureRecordSetLayer
Display Name Output Direction Lines
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeDerived
Category:
Supported Operations:
Submit Job
Child Resources:
Metadata