Display Name: GenerateOriginDestinationCostMatrix

Description: Creates an origin-destination (OD) cost matrix from multiple origins to multiple destinations. An OD cost matrix is a table that contains the travel time and travel distance from each origin to each destination. Additionally, it ranks the destinations that each origin connects to in ascending order based on the minimum time or distance required to travel from that origin to each destination. The best path on the street network is discovered for each OD pair, and the travel times and travel distances are stored as attributes of the output lines. Even though the lines are straight for performance reasons, they always store the travel time and travel distance along the street network, not straight-line distance.

Category:

Help URL: https://datat.stategrowth.tas.gov.au/ags/rest/directories/arcgisoutput/Routing/NetworkAnalysis_GPServer/Routing_NetworkAnalysis/GenerateOriginDestinationCostMatrix.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: Origins

Data Type: GPFeatureRecordSetLayer
Display Name Origins
Description: Specify locations that function as starting points in generating the paths to destinations. You can add up to 1000 origins.When specifying the origins, you can set properties for each one, such as its name or the number of destinations to find from the origin, by using attributes. The origins can be specified with the following attributesName The name of the origin. The name can be a unique identifier for the origin. The name is included in the output lines (as the OriginName field) and in the output origins (as the Name field) and can be used to join additional information from the tool outputs to the attributes of your origins.If the name is not specified, a unique name prefixed with Location is automatically generated in the output origins. An automatically generated origin name is not included in the output lines. TargetDestinationCountThe maximum number of destinations that must be found for the origin. If a value is not specified, the value from the Number of Destinations to Find parameter is used.This field allows you to specify a different number of destinations to find for each origin. For example, using this field you can find three closest destinations from one origin and two closest destinations from another origin. CutoffThe impedance value at which to stop searching for destinations from a given origin. This attribute allows you to specify a different cutoff value for each destination. For example, using this attribute you can specify to search for destinations within five minutes of travel time from one origin and to search for destinations within eight minutes of travel time from another origin.The value needs to be in the units specified by the Time Units parameter if the impedance attribute in your travel mode is time based or in the units specified by the Distance Units parameter if the impedance attribute in your travel mode is distance based. If a value is not specified, the value from the Cutoff parameter is used. CurbApproachSpecify the direction a vehicle may depart from the origin. The field value is specified as one of the following integers (use the numeric code, not the name in parentheses):0 (Either side of vehicle)—The vehicle can depart the origin in either direction, so a U-turn is allowed at the origin. This setting can be chosen if it is possible and practical for a vehicle to turn around at the origin. This decision may depend on the width of the road and the amount of traffic or whether the origin has a parking lot where vehicles can enter and turn around.1 (Right side of vehicle)—When the vehicle departs the origin, the origin must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must depart from the bus stop on the right-hand side. 2 (Left side of vehicle)—When the vehicle departs the origin, the curb must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must depart from the bus stop on the left-hand side.3 (No U-Turn)—For this tool, the No U-turn (3) value functions the same as Either side of vehicle. The CurbApproach property is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an origin on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to depart the origin from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to depart from an origin and not have a lane of traffic between the vehicle and the origin, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.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. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 ArcGIS Network Analyst extension attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 time is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The time units of NavLatency are the same as the units specified by the timeUnits property of the analysis object.
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 )
• TargetDestinationCount ( type: esriFieldTypeInteger, alias: Target Destination Count )
• Cutoff ( type: esriFieldTypeDouble, alias: Cutoff )
• CurbApproach ( type: esriFieldTypeSmallInteger, alias: Curb Approach )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: Destinations

Data Type: GPFeatureRecordSetLayer
Display Name Destinations
Description: Specify locations that function as ending points in generating the paths from origins. You can add up to 1000 destinations.When specifying the destinations, you can set properties for each one, such as its name, by using attributes. The destinations can be specified with the following attributes: Name The name of the destination. The name can be a unique identifier for the destination. The name is included in the output lines (as the DestinationName field) and in the output destinations (as the Name field) and can be used to join additional information from the tool outputs to the attributes of your destinations. If the name is not specified, a unique name prefixed with Location is automatically generated in the output destinations. An automatically generated destination name is not included in the output lines. CurbApproachSpecify the direction a vehicle may arrive at a destination. 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 arrive at the destination in either direction, so a U-turn is allowed at the origin. This setting can be chosen if it is possible and practical for your vehicle to turn around at the destination. This decision may depend on the width of the road and the amount of traffic or whether the destination has a parking lot where vehicles can enter and turn around.1 ( Right side of vehicle)—When the vehicle arrive at the destination, the destination must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must depart from the bus stop on the right-hand side. 2 (Left side of vehicle)—When the vehicle arrives at the destination, the curb must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must depart from the bus stop on the left-hand side.3 (No U-Turn)—For this tool, the No U-turn (3) value functions the same as Either side of vehicle. The CurbApproach property is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an origin on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to depart the origin from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to depart from an origin and not have a lane of traffic between the vehicle and the origin, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.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. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 ArcGIS Network Analyst extension attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 time is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The time units of NavLatency are the same as the units specified by the timeUnits property of the analysis object.
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 )
• CurbApproach ( type: esriFieldTypeSmallInteger, alias: Curb Approach )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


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 a table, Supported Travel Modes, to the application. Any value in the Travel Mode Name field from the Supported Travel Modes table can be specified as input. You can also specify the value from the Travel Mode Settings field as input. This 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 may want to choose Custom and set the custom travel mode parameters listed above to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You 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: Time_Units

Data Type: GPString
Display Name Time Units
Description: Specify the units that should be used to measure and report the total travel time between each origin-destination pair.The choices include the following:SecondsMinutesHoursDays
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Minutes
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Seconds, Minutes, Hours, Days ]


Parameter: Distance_Units

Data Type: GPString
Display Name Distance Units
Description: Specify the units that should be used to measure and report the total travel distance between each origin-destination pair.The choices include the following:MetersKilometersFeetYardsMilesNauticalMiles
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Kilometers
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, NauticalMiles ]


Parameter: Analysis_Region

Data Type: GPString
Display Name Analysis Region
Description: The region in which to perform the analysis. If a value is not specified for this parameter, the tool will automatically calculate the region name based on the location of the input points. Setting the name of the region is required only if the automatic detection of the region name is not accurate for your inputs.To specify a region, use one of the following values: Europe JapanKorea MiddleEastAndAfrica NorthAmerica SouthAmerica SouthAsiaThailand The following region names are no longer supported and will be removed in future releases. If you specify one of the deprecated region names, the tool automatically assigns a supported region name for your region.Greece redirects to EuropeIndia redirects to SouthAsiaOceania redirects to SouthAsiaSouthEastAsia redirects to SouthAsiaTaiwan redirects to SouthAsia
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ FDS_Net ]


Parameter: Number_of_Destinations_to_Find

Data Type: GPLong
Display Name Number of Destinations to Find
Description: Specify the maximum number of destinations to find per origin. If a value for this parameter is not specified, the output matrix includes travel costs from each origin to every destination. Individual origins can have their own values (specified as the TargetDestinationCount field) that override the Number of Destinations to Find parameter value.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis


Parameter: Cutoff

Data Type: GPDouble
Display Name Cutoff
Description: Specify the travel time or travel distance value at which to stop searching for destinations from a given origin. Any destination beyond the cutoff value will not be considered. Individual origins can have their own values (specified as the Cutoff field) that override the Cutoff parameter value.The value needs to be in the units specified by the Time Units parameter if the impedance attribute of your travel mode is time based or in the units specified by the Distance Units parameter if the impedance attribute of your travel mode is distance based. If a value is not specified, the tool will not enforce any travel time or travel distance limit when searching for destinations.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis


Parameter: Time_of_Day

Data Type: GPDate
Display Name Time of Day
Description: The time and date the routes will begin. If you are modeling the driving travel mode and specify the current date and time as the value for this parameter, the tool will use live traffic conditions to find the best routes, and the total travel time will be based on traffic conditions. Specifying a time of day results in more accurate routes and estimations of travel times because the travel times account for the traffic conditions that are applicable for that date and time.The Time Zone for Time of Day parameter specifies whether this time and date refer to UTC or the time zone in which the stop is located.The tool ignores this parameter when Measurement Units isn't set to a time-based unit.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis


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 first stop of a route is located. If you are generating many routes that start in multiple times zones, the start times are staggered in coordinated universal time (UTC). For example, a Time of Day value of 10:00 a.m., 2 January, means a start time of 10:00 a.m. Eastern Standard Time (UTC-3:00) for routes beginning in the Eastern Time Zone and 10:00 a.m. Central Standard Time (UTC-4:00) for routes beginning in the Central Time Zone. The start times are offset by one hour in UTC. The arrive and depart times and dates recorded in the output Stops feature class will refer to the local time zone of the first stop for each route.UTC—The Time of Day parameter refers to UTC. Choose this option if you want to generate a route for a specific time, such as now, but aren't certain in which time zone the first stop will be located. If you are generating many routes spanning multiple times zones, the start times in UTC are simultaneous. For example, a Time of Day value of 10:00 a.m., 2 January, means a start time of 5:00 a.m. Eastern Standard Time (UTC-5:00) for routes beginning in the Eastern Time Zone and 4:00 a.m. Central Standard Time (UTC-6:00) for routes beginning in the Central Time Zone. Both routes start at 10:00 a.m. UTC. The arrive and depart times and dates recorded in the output Stops feature class will refer to UTC.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Geographically Local
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis
Choice List: [ Geographically Local, UTC ]


Parameter: Point_Barriers

Data Type: GPFeatureRecordSetLayer
Display Name Point Barriers
Description: 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 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 only if the travel mode used for the analysis uses an impedance attribute that 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 only if the travel mode used for the analysis uses an impedance attribute that 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 and only if the travel mode used for the analysis uses an impedance attribute that 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 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, you would 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. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 ArcGIS Network Analyst extension attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge. For more information, see Bearing and BearingTol in the ArcGIS help system. 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 time is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device. The time units of NavLatency are the same as the units specified by the timeUnits property of the analysis object.
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: 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: The 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 only if the travel mode used for the analysis uses an impedance attribute that 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 only if the travel mode used for the analysis uses an impedance attribute that 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 and only if the travel mode used for the analysis uses an impedance attribute that 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: 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, the U-turn policy parameter is implicitly specified by how many edges connect to the junction, which is known as junction valency. The acceptable values for this parameter are listed below; each is followed by a description of its meaning in terms of junction valency. Allowed—U-turns are permitted at junctions with any number of connected edges. This is the default value.Not Allowed—U-turns are prohibited at all junctions, regardless of junction valency. Note, however, that U-turns are still permitted at network locations even when this 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 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: Use_Hierarchy

Data Type: GPBoolean
Display Name Use Hierarchy
Description: Specifies whether hierarchy will be used when finding the shortest paths between stops. 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 locations, because drivers on long-distance trips tend to prefer traveling on freeways, where stops, intersections, and turns can be avoided. Using hierarchy is computationally faster, especially for long-distance routes, 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 when finding short routes within a city. The tool automatically reverts to using hierarchy if the straight-line distance between facilities and demand points is greater than 50 miles (80.46 kilometers), even if this parameter is unchecked (set to False in Python).This parameter is ignored unless Travel Mode is set to Custom. When modeling a custom walking mode, it is recommended that you turn off hierarchy since hierarchy is designed for motorized vehicles.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode


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 Data coverage for network analysis services web page. If a country has a value of Yes in the Logistics Attribute column, the restriction with select availability in the region is supported in that country. If you specify restriction names that are not available in the country where your incidents are located, the service ignores the invalid restrictions. The service also ignores restrictions 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 Delivery Vehicle—The results will not include roads where delivery vehicles 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 the 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode


Parameter: Attribute_Parameter_Values

Data Type: GPRecordSet
Display Name Attribute Parameter Values
Description: Specifies additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers travel on roads that use the restriction. If the restriction is meant to avoid or prefer roads, you can further specify the degree to which they are avoided or preferred using this parameter. For example, you can choose to never use toll roads, avoid them as much as possible, or even highly prefer them.The values you provide for this parameter are ignored unless Travel Mode is set to Custom. If you specify the Attribute Parameter Values parameter from a feature class, the field names on the feature class must match the fields as follows:AttributeName—Lists the name of the restriction.ParameterName—Lists the name of the parameter associated with the restriction. A restriction can have one or more ParameterName field values based on its intended use.ParameterValue—The value for ParameterName used by the tool when evaluating the restriction. 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, for the Restriction Usage 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: None.



Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode


Parameter: Impedance

Data Type: GPString
Display Name Impedance
Description: Specifies the impedance, which is a value that represents the effort or cost of traveling along road segments or on other parts of the transportation network. Travel time is an impedance; a car may take 1 minute to travel a mile along an empty road. Travel times can vary by travel mode—a pedestrian may take more than 20 minutes to walk the same mile, so it is important to choose the right impedance for the travel mode you are modeling. Travel distance can also be an impedance; the length of a road in kilometers can be thought of as impedance. Travel distance in this sense is the same for all modes—a kilometer for a pedestrian is also a kilometer for a car. (What may change is the pathways on which the different modes are allowed to travel, which affects distance between points, and this is modeled by travel mode settings.)The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value.Choose from the following impedance values:TravelTime—Historical and live traffic data are used. This option is good for modeling the time it takes automobiles to travel along roads at a specific time of the 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 are 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.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 or 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, Forestry_All_Roads, Forestry_All_Roads_Rail, Rail_Only, Road_and_Rail, Road_Only, Length ]


Parameter: Origin_Destination_Line_Shape

Data Type: GPString
Display Name Origin Destination Line Shape
Description: The resulting lines of an OD cost matrix can be represented with either straight-line geometry or no geometry at all. In both cases, the route is always computed along the street network by minimizing the travel time or the travel distance, never using the straight-line distance between origins and destinations. Straight Line—Straight lines connect origins and destinations. None—Do not return any shapes for the lines that connect origins and destinations. This is useful when you have a large number of origins and destinations and are interested only in the OD cost matrix table (and not the output line shapes).
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: None
Parameter Type: esriGPParameterTypeOptional
Category: Output
Choice List: [ None, Straight Line ]


Parameter: Save_Output_Network_Analysis_Layer

Data Type: GPBoolean
Display Name Save Output Network Analysis Layer
Description: Specifies whether the tool will save the analysis settings as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application 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 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Analysis


Parameter: Time_Impedance

Data Type: GPString
Display Name Time Impedance
Description: The time-based impedance, which is a value that represents the travel time along road segments or on other parts of the transportation network.If the impedance for the travel mode, as specified using the Impedance parameter, is time based, the value for Time Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Road_Only
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Forestry_All_Roads, Forestry_All_Roads_Rail, Rail_Only, Road_and_Rail, Road_Only ]


Parameter: Distance_Impedance

Data Type: GPString
Display Name Distance Impedance
Description: The distance-based impedance, which 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 value for Distance Impedance and Impedance parameters must be identical. Otherwise, the service will return an error.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Length
Parameter Type: esriGPParameterTypeOptional
Category: Custom Travel Mode
Choice List: [ Length ]


Parameter: Output_Format

Data Type: GPString
Display Name Output Format
Description: Specifies the format in which the output features will be created. Choose from the following formats: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.CSV File: The output features are returned as a compressed file containing a comma separate value (CSV) representation of the outputs. When this option is specified, the output is a single file (with a .zip extension) that contains one or more CSV files (with a .csv 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, CSV File, 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 Dataset
Choice List: [ Forestry_All_Roads, Forestry_All_Roads_Rail, Rail_Only, Road_and_Rail, Road_Only, Length ]


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: Solve_Succeeded

Data Type: GPBoolean
Display Name Solve Succeeded
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: Output_Origin_Destination_Lines

Data Type: GPFeatureRecordSetLayer
Display Name Output Origin Destination Lines
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• DestinationRank ( type: esriFieldTypeInteger, alias: DestinationRank )
• Total_Time ( type: esriFieldTypeDouble, alias: Total_Time )
• Total_Distance ( type: esriFieldTypeDouble, alias: Total_Distance )
• OriginOID ( type: esriFieldTypeInteger, alias: OriginOID )
• OriginName ( type: esriFieldTypeString, alias: OriginName, length: 500 )
• DestinationOID ( type: esriFieldTypeInteger, alias: DestinationOID )
• DestinationName ( type: esriFieldTypeString, alias: DestinationName, length: 500 )
• Shape_Length ( type: esriFieldTypeDouble, alias: Shape_Length )
Features: None.



Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: Output_Origins

Data Type: GPFeatureRecordSetLayer
Display Name Output Origins
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)
Fields:
• ObjectID ( type: esriFieldTypeOID, alias: ObjectID )
• Name ( type: esriFieldTypeString, alias: Name, length: 500 )
• TargetDestinationCount ( type: esriFieldTypeInteger, alias: TargetDestinationCount )
• 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 )
• Cutoff ( type: esriFieldTypeDouble, alias: Cutoff )
• OriginOID ( type: esriFieldTypeInteger, alias: OriginOID )
• DestinationCount ( type: esriFieldTypeInteger, alias: DestinationCount )
• Bearing ( type: esriFieldTypeDouble, alias: Bearing )
• BearingTol ( type: esriFieldTypeDouble, alias: BearingTol )
• NavLatency ( type: esriFieldTypeDouble, alias: NavLatency )
Features: None.



Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: Output_Destinations

Data Type: GPFeatureRecordSetLayer
Display Name Output Destinations
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: false
HasM: false
Spatial Reference: 102100  (3857)
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 )
• DestinationOID ( type: esriFieldTypeInteger, alias: DestinationOID )
• OriginCount ( type: esriFieldTypeInteger, alias: OriginCount )
• 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_Result_File

Data Type: GPDataFile
Display Name Output Result File
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata