Additional Categories

Server toolset in Network Analyst toolbox

Additional Categories

Server toolset in Network Analyst toolbox

Additional Categories

1. Travel Direction (optional)

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.

TRAVEL_FROM—Direction of travel is from facilities to incidents. Fire departments commonly use the this setting, since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident).
TRAVEL_TO—Direction of travel is from incidents to facilities. Retail stores commonly use this setting, since they are concerned with the time it takes the shoppers (incidents) to reach the store (facility).

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.

2. Time of Day (optional)

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.

If your network dataset contains live or historical traffic data, 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.

Irrespective 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 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.

All facilities must be in the same time zone for the following:

Specifying a start time and traveling from facility to incident.
Specifying an end time and traveling from incident to facility.

3. Time of Day Usage (optional)

Indicates whether the Time of Day parameter value represents the arrival or departure time for the routes.

START_TIME— When this option is chosen, the tool finds the best route considering the Time of Day parameter value as the departure time from the facility or incident.

END_TIME— When this option is chosen, the tool considers the Time of Day parameter value as the arrival time at the facility or incident. This option is useful if you want to know what time to depart from a location so you arrive at the destination at the time specified in the Time of Day parameter.

NOT_USED—When this option is chosen, the tool does not use a Time of Day when calculating the closest facilities. Live and historical traffic data will not be used.

4. Time Zone for Time of Day (optional)

Specifies the time zone of the Time of Day parameter.

GEO_LOCAL—The Time of Day parameter refers to the time zone in which the facilities or incidents are located.

oIf Time of Day Usage is set to Start time and Travel Direction is Facilities to Incidents, this is the time zone of the facilities.

oIf Time of Day Usage is set to Start time and Travel Direction is Incidents to Facilities, this is the time zone of the incidents.

oIf Time of Day Usage is set to End time and Travel Direction is Facilities to Incidents, this is the time zone of the incidents.

oIf Time of Day Usage is set to End time and Travel Direction is Incidents to Facilities, 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.

Irrespective 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 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.

All facilities must be in the same time zone for the following:

Specifying a start time and traveling from facility to incident.
Specifying an end time and traveling from incident to facility.

5. Overrides (optional)

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 either 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.

6. Point Barriers (optional)

Specifies point barriers, which are split into two types: restriction and added cost point barriers. They temporarily restrict traversal across or add impedance to points on the network. The point barriers are defined by a feature set, and the attribute values you specify for the point features determine whether they are restriction or added cost barriers. The fields in the attribute table are listed and described below.

ObjectID:

The system-managed ID field.

Shape:

The geometry field indicating the geographic location of the network analysis object.

Name:

The name of the barrier.

BarrierType:

Specifies whether the barrier restricts travel completely or adds cost when traveling through it. There are two options:

Restriction (0)—Prohibits traversing through the barrier. This is the default value.
Added Cost (2)—Traversing through the barrier increases the network cost by the amount specified in the Additional_Time and Additional_Distance fields.

Use the value 0 for Restriction and 2 for Added Cost.

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.

7. Line Barriers (optional)

Specifies line barriers, which temporarily restrict traversal across them. The line barriers are defined by a feature set. The fields in the attribute table are listed and described below.

ObjectID:

The system-managed ID field.

Shape:

The geometry field indicating the geographic location of the network analysis object.

Name:

The name of the barrier.

8. Polygon Barriers (optional)

Specifies polygon barriers, which are split into two types: restriction and scaled cost polygon barriers. They temporarily restrict traversal or scale impedance on the parts of the network they cover. The polygon barriers are defined by a feature set, and the attribute values you specify for the polygon features determine whether they are restriction or scaled cost barriers. The fields in the attribute table are listed and described below.

ObjectID:

The system-managed ID field.

Shape:

The geometry field indicating the geographic location of the network analysis object.

Name:

The name of the barrier.

BarrierType:

Specifies whether the barrier restricts travel completely or scales the cost of traveling through it. There are two options:

Restriction (0)—Prohibits traversing through any part of the barrier. This is the default value.
Scaled Cost (1)—Scales the impedance of underlying edges by multiplying them by the value of the ScaledCostFactor property. If edges are partially covered by the barrier, the impedance is apportioned and multiplied.

Use the value 0 for Restriction and 1 for Scaled Cost.

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.

9. UTurn Policy (optional)

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.

ALLOW_UTURNS—U-turns are permitted at junctions with any number of connected edges. This is the default value.
NO_UTURNS—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.
ALLOW_DEAD_ENDS_ONLY—U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end).
ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY—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.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than custom.

If you need a more precisely defined U-turn policy, consider adding a global turn delay evaluator to a network cost attribute, or adjusting its settings if one exists, and pay particular attention to the configuration of reverse turns. Also, look at setting the CurbApproach property of your network locations.

10. Time Attribute (optional)

Defines the network cost attribute to use when the measurement units value is a time unit.

The tool performs the necessary time-unit conversion when the measurement units value differs from the units of the cost attribute defined here. In other words, the time units of the default cutoff and the network cost attribute don't need to be the same.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than Custom.

11. Time Attribute Units (optional)

The units of the network cost attribute specified by the Time Attribute parameter. This is merely an informational parameter that cannot be changed without directly editing the network dataset. It is also unnecessary to change since the unit conversions between measurement units and the cost attribute are handled for you.

The value of this parameter is overridden when Travel Mode is set to any value other than Custom.

12. Distance Attribute (optional)

Defines the network cost attribute to use when the measurement units value is a distance unit.

The tool performs the necessary distance-unit conversion when the measurement units value differs from the units of the cost attribute defined here. In other words, the measurement units and the distance units of the network cost attribute don't need to be the same.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than Custom.

13. Use Hierarchy in Analysis (optional)

Specify whether hierarchy should be used when finding the shortest routes between points.

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 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, because the tool has to select the best route from a relatively smaller subset of streets. This is the default value.
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-distance routes within a city.

The parameter is disabled if a hierarchy attribute is not defined on the network dataset used to perform the analysis.

You can use the Force Hierarchy Beyond Distance parameter to force the solver to use hierarchy even if Use Hierarchy in Analysis is set to false.

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.

14. Restrictions (optional)

Indicates which network restriction attributes are respected during solve time.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than custom.

15. Attribute Parameter Values (optional)

Specifies the parameter values for network attributes that have parameters. The record set has two columns that work together to uniquely identify parameters and another column that specifies the parameter value.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than custom.

The attribute parameter values record set has associated attributes. The fields in the attribute table are listed below and described.

ObjectID:

The system-managed ID field.

AttributeName:

The name of the network attribute whose attribute parameter is set by the table row.

ParameterName:

The name of the attribute parameter whose value is set by the table row. (Object type parameters cannot be updated using this tool.)

ParameterValue:

The value you want for the attribute parameter. If a value is not specified, the attribute parameter is set to null.

16. Route Line Simplification Tolerance (optional)

Specify by how much you want to simplify the route geometry.

The tool ignores this parameter if the Route Shape parameter isn't set to True lines with measures or True lines without measures.

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.

The value of this parameter is overridden when Travel Mode (Travel_Mode in Python) is set to any value other than custom.

17. Accumulate Attributes (optional)

List of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Time Attribute (Time_Attribute in Python) or Distance Attribute (Distance_Attribute in Python) parameter to calculate the shortest paths.

For each cost attribute that is accumulated, a Total_[attribute] field is added to the routes that are output by the solver.

18. Maximum Snap Tolerance (optional)

The maximum snap tolerance is the furthest distance that Network Analyst searches when locating or relocating a point onto the network. The search looks for suitable edges or junctions and snaps the point to the nearest one. If a suitable location isn't found within the maximum snap tolerance, the object is marked as unlocated.

19. Feature Locator WHERE Clause (optional)

An SQL expression used to select a subset of source features that limits on which network elements facilities can be located. The syntax for this parameter consists of two parts: the first is the source feature class name (followed by a space) and the second is the SQL expression. To write an SQL expression for two or more source feature classes, separate them with a semicolon.

To ensure facilities are not located on limited-access highways, for example, write an SQL expression like the following to exclude those source features: "Streets" "FUNC_CLASS not in('1', '2')".

Note that barriers ignore the feature locator WHERE clause when loading.

20. Route Shape (optional)

Specify the type of route features that are output by the tool. The parameter can be specified using one of the following values:

TRUE_LINES_WITH_MEASURES— Return the exact shape of the resulting route based on the underlying streets. Additionally, construct measures so the shape may be used in linear referencing.
TRUE_LINES_WITHOUT_MEASURES— Return the exact shape of the resulting route based on the underlying streets.
STRAIGHT_LINES— Return a straight line between the incident and the facility.
NO_LINES— Do not return any shapes for the routes. This value can be useful in cases where you are only interested in determining the total travel time or travel distance between the closest facility and the incident.

When the Route Shape parameter is set to True Shape, the generalization of the route shape can be further controlled using the appropriate values 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 incidents and facilities. This means that only the route shapes are different, not the underlying streets that are searched when finding the route.

21. Populate Directions (optional)

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.

22. Directions Language (optional)

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 directions languages that are available depend on what ArcGIS language packs you have installed on your computer. The values are entered in two- or five-character language codes, for example, en for English or zh-CN for simplified Chinese.

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

23. Directions Distance Units (optional)

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.

Miles
Kilometer
Meters
Feet
Yards
NauticalMiles

24. Directions Style Name (optional)

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.
NA Campus—Generates directions appropriate for pedestrian networks, including sidewalks and building interiors.

25. Save Output Network Analysis Layer (optional)

Choose whether the output includes a network analysis layer of the results. In either case, feature classes with routes and directions are returned. However, a server administrator may want to choose to output a network analysis layer as well so that the setup and results of the tool can be debugged using the Network Analyst controls in the ArcGIS Desktop environment. This can make the debugging process much easier.

In ArcGIS Desktop, the default output location for the network analysis layer is in the scratch folder. You can determine the location of the scratch folder by evaluating the value of arcpy.env.scratchFolder geoprocessing environment in the Python window. The output network analysis layer is stored as an LYR file whose name begins with _ags_gpna and is followed by an alphanumeric GUID.

26. Save Route Data (optional)

Choose whether the output includes a zip file that contains a file geodatabase holding 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.

In ArcGIS Desktop, the default output location for this output file is in the scratch folder. You can determine the location of the scratch folder by evaluating the value of the arcpy.env.scratchFolder geoprocessing environment.

Checked (True): The tool writes out a .zip archive containing a file geodatabase workspace that contains the inputs and outputs of the analysis.
Unchecked (False): Route data is not saved. This is the default.

27. Maximum Features Affected by Point Barriers (optional)

Limits how many features can be affected by point barriers.
This parameter helps you govern the amount of processing that occurs when solving. For example, you could assign a low value to this parameter for a free version of the service you are creating and use a higher value for a paid-subscription version of the service.
A null value indicates there is no limit.

28. Maximum Features Affected by Line Barriers (optional)

Limits how many features can be affected by line barriers.

This parameter helps you govern the amount of processing that occurs when solving. For example, you could assign a low value to this parameter for a free version of the service you are creating and use a higher value for a paid-subscription version of the service.