{ "name": "GenerateServiceAreas", "displayName": "GenerateServiceAreas", "description": "GenerateServiceAreas determines network service areas around facilities. A network service area is a region that encompasses all streets that can be accessed within a given distance or travel time from one or more facilities. For instance, the 10-minute service area for a facility includes all the streets that can be reached within 10 minutes from that facility. Service areas are commonly used to visualize and measure accessibility. For example, a three-minute drive-time polygon around a grocery store can determine which residents are able to reach the store within three minutes and are thus more likely to shop there.", "category": "", "helpUrl": "https://sampleserver6.arcgisonline.com/arcgis/rest/directories/arcgisoutput/NetworkAnalysis/SanDiego_GPServer/NetworkAnalysis_SanDiego/GenerateServiceAreas.htm", "executionType": "esriExecutionTypeAsynchronous", "parameters": [ { "name": "Facilities", "dataType": "GPFeatureRecordSetLayer", "displayName": "Facilities", "description": "The facilities around which service areas are\ngenerated. You can load up to 1,000 facilities. The facilities feature set has an associated attribute\ntable. The fields in the attribute table are listed below and\ndescribed. ObjectID: The system-managed ID field. Name: The name of the facility. If the name is not specified, a name\nis automatically generated at solve time. All fields from the input facilities are included in the output polygons when the Polygons for Multiple Facilities\nparameter is set to Overlapping or Not Overlapping. The ObjectID field on the input facilities is transferred to the FacilityOID field on the output polygons.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "Break_Values", "dataType": "GPString", "displayName": "Break Values", "description": "Specifies the size and number of service area polygons to\ngenerate for each facility. The units are determined by the Break\nUnits value. Multiple polygon breaks can be set to create concentric\nservice areas per facility. For instance, to find 2-, 3-, and 5-mile service areas for each facility, type 2 3 5, separating the\nvalues with a space, and set Break Units to Miles. There is no limit to the number of break values you specify. The size of the maximum break value can't exceed the equivalent of 300 minutes or 300 miles (482.80 kilometers). When generating detailed polygons, the maximum service-area size is limited to 15 minutes and 15 miles (24.14 kilometers).", "direction": "esriGPParameterDirectionInput", "defaultValue": "5 10 15", "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "Break_Units", "dataType": "GPString", "displayName": "Break Units", "description": "The unit for the Break Values parameter.\n The units you choose for this parameter determine whether the tool will create service areas by measuring driving distance or driving time. Choose a time unit to measure driving time. To measure driving distance, choose a distance unit. Your choice also determines in which units the tool will report total driving time or distance in the results. The choices are: Meters Kilometers Feet Yards Miles Nautical Miles Seconds Minutes Hours Days", "direction": "esriGPParameterDirectionInput", "defaultValue": "Minutes", "parameterType": "esriGPParameterTypeRequired", "category": "", "choiceList": [ "Meters", "Kilometers", "Feet", "Yards", "Miles", "Nautical Miles", "Seconds", "Minutes", "Hours", "Days" ] }, { "name": "Analysis_Region", "dataType": "GPString", "displayName": "Analysis Region", "description": "Specify the region in which to perform the analysis. If a value is not specified for this parameter, the tool\nwill automatically calculate the region name based on the location\nof the input points. Setting the name of the region is recommended to speed up the\ntool execution. To specify a region, use one of\nthe following values: EuropeGreece India JapanKorea MiddleEastAndAfrica NorthAmerica Oceania SouthAmerica SouthEastAsiaTaiwanThailand", "direction": "esriGPParameterDirectionInput", "defaultValue": "", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Streets_ND" ] }, { "name": "Travel_Direction", "dataType": "GPString", "displayName": "Travel Direction", "description": "Specifies whether the direction of travel used to\ngenerate the service area polygons is toward or away from the\nfacilities. Away From Facility\u2014The service area is generated in the\ndirection away from the facilities. Towards Facility\u2014The service area is created in the\ndirection towards the facilities. The direction of travel may change the shape of the\npolygons because impedances on opposite sides of streets may differ\nor one-way restrictions may exist, such as one-way streets. The\ndirection you should choose depends on the nature of your service\narea analysis. The service area for a pizza delivery store, for\nexample, should be created away from the facility, whereas the\nservice area of a hospital should be created toward the\nfacility.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Away From Facility", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Away From Facility", "Towards Facility" ] }, { "name": "Time_of_Day", "dataType": "GPDate", "displayName": "Time of Day", "description": "The time to depart from or arrive at the facilities. The\ninterpretation of this value depends on whether travel is toward or\naway from the facilities. It represents the departure time if Travel Direction is\nset to Away from Facility. It represents the arrival time if Travel Direction is set\nto Toward Facility. You can use the Time Zone for Time of Day parameter to specify whether this time and date refers to UTC or the time zone in which the facility is located. Repeatedly solving the same analysis, but using different\nTime of Day values, allows you to see how a facility's reach\nchanges over time. For instance, the five-minute service area\naround a fire station may start out large in the early morning,\ndiminish during the morning rush hour, grow in the late morning,\nand so on, throughout the day.", "direction": "esriGPParameterDirectionInput", "defaultValue": null, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "Use_Hierarchy", "dataType": "GPBoolean", "displayName": "Use Hierarchy", "description": "Specify whether hierarchy should be used when finding the best\nroute between the facility and the incident.\n Checked (True)\u2014Use the hierarchy attribute for the analysis. Using a hierarchy results in the solver preferring higher-order edges to lower-order edges. Hierarchical solves are faster, and they can be used to simulate the preference of a driver who chooses to travel on freeways over local roads when possible\u2014even if that means a longer trip. Unchecked (False)\u2014Do not use the hierarchy attribute for the analysis. Not using a hierarchy yields an accurate service area measured along all edges of the network dataset regardless of hierarchy level. Regardless of whether the Use Hierarchy parameter is checked (True), hierarchy is always used when the largest break value exceeds 240 minutes or 240 miles (386.24 kilometers).", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "UTurn_at_Junctions", "dataType": "GPString", "displayName": "UTurn at Junctions", "description": "Use this parameter to restrict or permit the service area to make U-turns at junctions. In order to understand the parameter values, consider for a moment the following terminology: a junction is a point where a street segment ends and potentially connects to one or more other segments; a pseudo-junction is a point where exactly two streets connect to one another; an intersection is a point where three or more streets connect; and a dead-end is where one street segment ends without connecting to another. Given this information, the parameter can have the following values: Allowed\u2014U-turns are permitted everywhere. Allowing\nU-turns implies that the vehicle can turn around at any junction and\ndouble back on the same street. This is the default value. Not Allowed\u2014U-turns are prohibited at all junctions: pseudo-junctions, intersections, and dead-ends. Allowed only at Dead Ends\u2014U-turns are prohibited at all\njunctions, except those that have only one connected street feature (a dead\nend). Allowed only at Intersections and Dead Ends\u2014U-turns are prohibited at\npseudo-junctions where exactly two adjacent streets meet, but U-turns are permitted\nat intersections and dead ends. This prevents turning around in the middle of the road where one length of road happened to be digitized as two street features.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Allowed Only at Intersections and Dead Ends", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Allowed", "Not Allowed", "Allowed Only at Dead Ends", "Allowed Only at Intersections and Dead Ends" ] }, { "name": "Polygons_for_Multiple_Facilities", "dataType": "GPString", "displayName": "Polygons for Multiple Facilities", "description": "Choose how service area polygons are generated when\nmultiple facilities are present in the analysis. Overlapping\u2014Creates individual polygons for each facility.\nThe polygons can overlap each other. This is the default value. Not Overlapping\u2014Creates individual polygons such that a\npolygon from one facility cannot overlap polygons from other\nfacilities; furthermore, any portion of the network can only be\ncovered by the service area of the nearest facility. Merge by Break Value\u2014Creates and joins the polygons of\ndifferent facilities that have the same break value. When using Overlapping or Not Overlapping, all fields from the input facilities are included in the output polygons, with the exception that values from the input ObjectID field are transferred to the FacilityOID field of the output polygons. The FacilityOID field is null when merging by break value, and the input fields are not included in the output.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Overlapping", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "Overlapping", "Not Overlapping", "Merge by Break Value" ] }, { "name": "Polygon_Overlap_Type", "dataType": "GPString", "displayName": "Polygon Overlap Type", "description": "Specifies the option to create concentric service area\npolygons as disks or rings. This option is applicable only when\nmultiple break values are specified for the facilities. Rings\u2014The polygons representing larger breaks exclude the polygons of smaller breaks.\nThis creates polygons going between consecutive breaks. Use this\noption if you want to find the area from one break to another. For\ninstance, if you create 5- and 10-minute service areas, then the\n10-minute service area polygon will exclude the area under the\n5-minute service area polygon. This is the default value. Disks\u2014Creates polygons going from the facility to the\nbreak. For instance, if you create 5- and 10-minute service areas,\nthen the 10-minute service area polygon will include the area under\nthe 5-minute service area polygon.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Rings", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "Rings", "Disks" ] }, { "name": "Detailed_Polygons", "dataType": "GPBoolean", "displayName": "Detailed Polygons", "description": "Specifies the option to create detailed or generalized\npolygons. Unchecked (False)\u2014Creates generalized polygons, which are\ngenerated quickly and are fairly accurate. This is the\ndefault. Checked (True)\u2014Creates detailed polygons, which\naccurately model the service area lines and may contain islands of\nunreached areas. This option is much slower than generating\ngeneralized polygons. This option isn't supported when using\nhierarchy. If your facilities are in an urban area with a grid-like street network, the difference between generalized and detailed service areas would be minimal. However, if your facilities are in a region containing mountain and rural roads, the detailed service areas may present significantly more accurate results than generalized service areas. The tool supports generating detailed polygons only if the largest\nvalue specified in the Break Values parameter is less than or equal to 15\nminutes or 15 miles (24.14 kilometers).", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Polygon_Trim_Distance", "dataType": "GPLinearUnit", "displayName": "Polygon Trim Distance", "description": "Specifies the distance within which the service area\npolygons are trimmed. This is useful when finding service areas in\nplaces that have a sparse street network and you don't want the\nservice area to cover large areas where there are no street\nfeatures. The default value is 100 meters. No value or a value of 0 for this parameter\nspecifies that the service area polygons should not be trimmed. This\nparameter value is ignored when using hierarchy.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "distance": 100, "units": "esriMeters" }, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Polygon_Simplification_Tolerance", "dataType": "GPLinearUnit", "displayName": "Polygon Simplification Tolerance", "description": "Specify by how much you want to simplify the polygon\ngeometry. Simplification maintains critical vertices of a\npolygon to define its essential shape and removes other vertices. The\nsimplification distance you specify is the maximum offset\nthe simplified polygon boundaries can deviate from the original polygon boundaries.\nSimplifying a polygon reduces the number of vertices and tends to\nreduce drawing times.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "distance": 10, "units": "esriMeters" }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "Point_Barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Point Barriers", "description": "Specify one or more points to act as temporary\nrestrictions or represent additional time or distance that may be\nrequired to travel on the underlying streets. For example, a point\nbarrier can be used to represent a fallen tree along a street or\ntime delay spent at a railroad crossing. The tool imposes a limit of 250 points that can be added\nas barriers. When specifying the point barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The point barriers can be specified with the following attributes: Name: The name of the barrier. BarrierType: Specifies whether the point barrier restricts travel\ncompletely or adds time or distance when it is crossed. The value\nfor this attribute is specified as one of the following\nintegers (use the numeric code, not the name in parentheses): 0 (Restriction)\u2014Prohibits travel through the barrier. The barrier\nis referred to as a restriction point barrier since it acts as a\nrestriction. 2 (Added Cost)\u2014Traveling through the barrier increases the travel\ntime or distance by the amount specified in the\nAdditional_Time or Additional_Distance field. This barrier type is\nreferred to as an added-cost point barrier. Additional_Time: Indicates how much travel time is added when the\nbarrier is traversed. This field is applicable only for added-cost\nbarriers and only if the Break Units value is time based. This field\nvalue must be greater than or equal to zero, and its units are the same as those specified in the\nBreak Units parameter. Additional_Distance: Indicates how much distance is added when the barrier is\ntraversed. This field is applicable only for added-cost barriers\nand only if the Break Units value is distance based. The field value\nmust be greater than or equal to zero, and its units are the same as those specified in the\nBreak Units parameter.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPoint", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "BarrierType" }, { "name": "AdditionalCost", "type": "esriFieldTypeDouble", "alias": "AdditionalCost" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "Line_Barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Line Barriers", "description": "Specify one or more lines that prohibit travel anywhere\nthe lines intersect the streets. For example, a parade or protest\nthat blocks traffic across several street segments can be modeled\nwith a line barrier. A line barrier can also quickly fence off\nseveral roads from being traversed, thereby channeling possible\nroutes away from undesirable parts of the street\nnetwork. The tool imposes a limit on the number of streets you can\nrestrict using the Line Barriers parameter. While there is no limit on\nthe number of lines you can specify as line barriers, the combined\nnumber of streets intersected by all the lines cannot exceed\n500. When specifying the line barriers, you can set a name property for each one by using the following attribute: Name: The name of the barrier.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPolyline", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "SHAPE_Length", "type": "esriFieldTypeDouble", "alias": "SHAPE_Length" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "Polygon_Barriers", "dataType": "GPFeatureRecordSetLayer", "displayName": "Polygon Barriers", "description": "Specify polygons that either completely restrict travel or\nproportionately scale the time or distance required to travel on\nthe streets intersected by the polygons. The service imposes a limit on the number of streets you\ncan restrict using the Polygon Barriers parameter. While there is\nno limit on the number of polygons you can specify as the polygon\nbarriers, the combined number of streets intersected by all the\npolygons should not exceed 2,000. When specifying the polygon barriers, you can set properties for each one, such as its name or barrier type, by using attributes. The polygon barriers can be specified with the following attributes: Name: The name of the barrier. BarrierType: Specifies whether the barrier restricts travel completely\nor scales the time or distance for traveling through it. The field\nvalue is specified as one of the following integers (use the numeric code, not the name in parentheses): 0 (Restriction)\u2014Prohibits traveling through any part of the barrier.\nThe barrier is referred to as a restriction polygon barrier since it\nprohibits traveling on streets intersected by the barrier. One use\nof this type of barrier is to model floods covering areas of the\nstreet that make traveling on those streets impossible. 1 (Scaled Cost)\u2014Scales the time or distance required to travel the\nunderlying streets by a factor specified using the ScaledTimeFactor\nor ScaledDistanceFactor field. If the streets are partially\ncovered by the barrier, the travel time or distance is apportioned\nand then scaled. For example, a factor 0.25 would mean that travel\non underlying streets is expected to be four times faster than\nnormal. A factor of 3.0 would mean it is expected to take three\ntimes longer than normal to travel on underlying streets. This\nbarrier type is referred to as a scaled-cost polygon barrier. It\nmight be used to model storms that reduce travel speeds in specific\nregions. ScaledTimeFactor: This is the factor by which the travel time of the streets\nintersected by the barrier is multiplied. This field is applicable\nonly for scaled-cost barriers and only if the Break Units value is time\nbased. The field value must be greater than zero and its units are the same as those specified in the\nBreak Units parameter. ScaledDistanceFactor: This is the factor by which the distance of the streets\nintersected by the barrier is multiplied. This attribute is\napplicable only for scaled-cost barriers and only if the Break Units value is distance based. The attribute value must be greater than\nzero.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "geometryType": "esriGeometryPolygon", "spatialReference": { "wkid": 4326, "latestWkid": 4326 }, "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "OBJECTID" }, { "name": "Name", "type": "esriFieldTypeString", "alias": "Name", "length": 500 }, { "name": "BarrierType", "type": "esriFieldTypeInteger", "alias": "BarrierType" }, { "name": "ScaledCostFactor", "type": "esriFieldTypeDouble", "alias": "ScaledCostFactor" }, { "name": "Shape_Length", "type": "esriFieldTypeDouble", "alias": "Shape_Length" }, { "name": "Shape_Area", "type": "esriFieldTypeDouble", "alias": "Shape_Area" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Barriers" }, { "name": "Restrictions", "dataType": "GPMultiValue:GPString", "displayName": "Restrictions", "description": "Specify which travel restrictions should be honored by the tool\nwhen determining the service areas. The values you provide for this parameter are ignored unless Travel Mode is set to Custom. A restriction represents a driving\npreference or requirement. In most cases, restrictions cause roads\nto be prohibited. For instance, using an Avoid Toll Roads restriction will result in a route that will include toll roads only when it is absolutely required to travel on toll roads in order to visit an incident or a facility. Height Restriction makes it possible to route around any clearances that are lower than the height of your vehicle. If you are carrying corrosive materials on your vehicle, using the Any Hazmat Prohibited restriction prevents hauling the materials along roads where it is marked as illegal to do so. When generating detailed polygons, prohibited roads that are not covered by service area polygons may result in polygons with untraversable holes; however, when generating general or hierarchical service areas, restricted roads that are completely surrounded by traversable roads will be covered by the simplified service area polygon. Below is a list of available restrictions and a short description. Some restrictions require an additional value to be\nspecified for their desired use. This value needs to be associated\nwith the restriction name and a specific parameter intended to work\nwith the restriction. You can identify such restrictions if their\nnames appear under the AttributeName column in the Attribute\nParameter Values parameter. The ParameterValue field should be\nspecified in the Attribute Parameter Values parameter for the\nrestriction to be correctly used when finding traversable roads. Some restrictions are supported only in certain countries; their availability is stated by region in the list below. Of the restrictions that have limited availability within a region, you can check whether the restriction is available in a particular country by looking at the table in the Country List section of the Data coverage for network analysis services web page. If a country has a value of Yes in the Logistics Attribute column, the restriction with select availability in the region is supported in that country. If you specify restriction names that are not available in the country where your incidents are located, the service ignores the invalid restrictions. The service also ignores restrictions whose Restriction Usage parameter value is between 0 and 1 (see the Attribute Parameter Value parameter). It prohibits all restrictions whose Restriction Usage parameter value is greater than 0. The tool supports the following restrictions:Any Hazmat Prohibited\u2014The results will not include roads\nwhere transporting any kind of hazardous material is\nprohibited. Availability: Select countries in North America and EuropeAvoid Carpool Roads\u2014The results will avoid roads that are\ndesignated exclusively for carpool (high-occupancy)\nvehicles. Availability: All countriesAvoid Express Lanes\u2014The results will avoid roads designated\nas express lanes. Availability: All countriesAvoid Ferries\u2014The results will avoid ferries. Availability: All countriesAvoid Gates\u2014The results will avoid roads where there are\ngates such as keyed access or guard-controlled\nentryways.Availability: All countriesAvoid Limited Access Roads\u2014The results will avoid roads\nthat are limited access highways.Availability: All countriesAvoid Private Roads\u2014The results will avoid roads that are\nnot publicly owned and maintained.Availability: All countriesAvoid Toll Roads\u2014The results will avoid toll\nroads.Availability: All countriesAvoid Truck Restricted Roads\u2014The results will avoid roads where trucks are not allowed, except when making deliveries.Availability: All countries Avoid Unpaved Roads\u2014The results will avoid roads that are\nnot paved (for example, dirt, gravel, and so on). Availability: All countriesAxle Count Restriction\u2014The results will not include roads\nwhere trucks with the specified number of axles are prohibited. The\nnumber of axles can be specified using the Number of Axles\nrestriction parameter.Availability: Select countries in North America and EuropeDriving a Bus\u2014The results will not include roads where\nbuses are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countriesDriving a Delivery Vehicle\u2014The results will not include\nroads where delivery vehicles are prohibited. Using this restriction\nwill also ensure that the results will honor one-way\nstreets. Availability: All countriesDriving a Taxi\u2014The results will not include roads where\ntaxis are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countriesDriving a Truck\u2014The results will not include roads where\ntrucks are prohibited. Using this restriction will also ensure that\nthe results will honor one-way streets. Availability: All countriesDriving an Automobile\u2014The results will not include roads\nwhere automobiles are prohibited. Using this restriction will also\nensure that the results will honor one-way streets. Availability: All countriesDriving an Emergency Vehicle\u2014The results will not include\nroads where emergency vehicles are prohibited. Using this\nrestriction will also ensure that the results will honor one-way\nstreets.Availability: All countriesHeight Restriction\u2014The results will not include roads\nwhere the vehicle height exceeds the maximum allowed height for the\nroad. The vehicle height can be specified using the Vehicle Height\n(meters) restriction parameter. Availability: Select countries in North America and EuropeKingpin to Rear Axle Length Restriction\u2014The results will\nnot include roads where the vehicle length exceeds the maximum\nallowed kingpin to rear axle for all trucks on the road. The length\nbetween the vehicle kingpin and the rear axle can be specified\nusing the Vehicle Kingpin to Rear Axle Length (meters) restriction\nparameter. Availability: Select countries in North America and EuropeLength Restriction\u2014The results will not include roads\nwhere the vehicle length exceeds the maximum allowed length for the\nroad. The vehicle length can be specified using the Vehicle Length\n(meters) restriction parameter. Availability: Select countries in North America and EuropeRiding a Motorcycle\u2014The results will not include roads\nwhere motorcycles are prohibited. Using this restriction will also\nensure that the results will honor one-way streets.Availability: All countriesRoads Under Construction Prohibited\u2014The results will not\ninclude roads that are under construction.Availability: All countriesSemi or Tractor with One or More Trailers Prohibited\u2014The\nresults will not include roads where semis or tractors with one or\nmore trailers are prohibited. Availability: Select countries in North America and EuropeSingle Axle Vehicles Prohibited\u2014The results will not\ninclude roads where vehicles with single axles are\nprohibited.Availability: Select countries in North America and EuropeTandem Axle Vehicles Prohibited\u2014The results will not\ninclude roads where vehicles with tandem axles are\nprohibited.Availability: Select countries in North America and EuropeThrough Traffic Prohibited\u2014The results will not include\nroads where through traffic (non local) is prohibited.Availability: All countriesTruck with Trailers Restriction\u2014The results will not\ninclude roads where trucks with the specified number of trailers on\nthe truck are prohibited. The number of trailers on the truck can\nbe specified using the Number of Trailers on Truck restriction\nparameter.Availability: Select countries in North America and EuropeUse Preferred Hazmat Routes\u2014The results will prefer roads\nthat are designated for transporting any kind of hazardous\nmaterials. Availability: Select countries in North America and EuropeUse Preferred Truck Routes\u2014The results will prefer roads\nthat are designated as truck routes, such as the roads that are\npart of the national network as specified by the National Surface\nTransportation Assistance Act in the United States, or roads that\nare designated as truck routes by the state or province, or roads\nthat are preferred by the trucks when driving in an\narea.Availability: Select countries in North America and EuropeWalking\u2014The results will not include roads where\npedestrians are prohibited.Availability: All countriesWeight Restriction\u2014The results will not include roads\nwhere the vehicle weight exceeds the maximum allowed weight for the\nroad. The vehicle weight can be specified using the Vehicle Weight\n(kilograms) restriction parameter.Availability: Select countries in North America and EuropeWeight per Axle Restriction\u2014The results will not include\nroads where the vehicle weight per axle exceeds the maximum allowed\nweight per axle for the road. The vehicle weight per axle can be\nspecified using the Vehicle Weight per Axle (kilograms) restriction\nparameter.Availability: Select countries in North America and EuropeWidth Restriction\u2014The results will not include roads where\nthe vehicle width exceeds the maximum allowed width for the road.\nThe vehicle width can be specified using the Vehicle Width (meters)\nrestriction parameter.Availability: Select countries in North America and EuropeThe Driving a Delivery Vehicle restriction attribute is deprecated and will be unavailable in future releases. To achieve similar results, use the Driving a Truck restriction attribute along with the Avoid Truck Restricted Roads restriction attribute.", "direction": "esriGPParameterDirectionInput", "defaultValue": [ "Driving an Automobile", "Through Traffic Prohibited", "Avoid Unpaved Roads", "Avoid Private Roads", "Avoid Gates", "Avoid Carpool Roads", "Avoid Express Lanes" ], "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Any Hazmat Prohibited", "Avoid Carpool Roads", "Avoid Express Lanes", "Avoid Ferries", "Avoid Gates", "Avoid Limited Access Roads", "Avoid Private Roads", "Avoid Toll Roads", "Avoid Truck Restricted Roads", "Avoid Unpaved Roads", "Driving a Bus", "Driving a Delivery Vehicle", "Driving a Taxi", "Driving a Truck", "Driving an Automobile", "Driving an Emergency Vehicle", "Height Restriction", "Length Restriction", "Through Traffic Prohibited", "Use Preferred Hazmat Routes", "Use Preferred Truck Routes", "Walking", "Weight Restriction" ] }, { "name": "Attribute_Parameter_Values", "dataType": "GPRecordSet", "displayName": "Attribute Parameter Values", "description": "Specify additional values required by some restrictions, such as the weight of a vehicle for Weight Restriction. You can also use the attribute parameter to specify whether any restriction prohibits, avoids, or prefers\ntravel on roads that use the restriction. If the restriction is\nmeant to avoid or prefer roads, you can further specify the degree\nto which they are avoided or preferred using this\nparameter. For example, you can choose to never use toll roads, avoid them as much as possible, or 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\nfeature class, the field names on the feature class must match the fields as described below: AttributeName: Lists the name of the restriction. ParameterName: Lists the name of the parameter associated with the\nrestriction. A restriction can have one or more ParameterName field\nvalues based on its intended use. ParameterValue: The value for ParameterName used by the tool\nwhen evaluating the restriction. Attribute Parameter Values is dependent on the\nRestrictions parameter. The ParameterValue field is applicable only\nif the restriction name is specified as the value for the\nRestrictions parameter. In Attribute Parameter Values, each\nrestriction (listed as AttributeName) has a ParameterName field\nvalue, Restriction Usage, that specifies whether the restriction\nprohibits, avoids, or prefers travel on the roads associated with\nthe restriction and the degree to which the roads are avoided or\npreferred. The Restriction Usage ParameterName can be assigned any of\nthe following string values or their equivalent numeric values\nlisted within the parentheses: PROHIBITED (-1)\u2014Travel on the roads using the restriction is completely\nprohibited. AVOID_HIGH (5)\u2014It\nis highly unlikely for the tool to include in the route the roads\nthat are associated with the restriction. AVOID_MEDIUM (2)\u2014It\nis unlikely for the tool to include in the route the roads that are\nassociated with the restriction. AVOID_LOW (1.3)\u2014It\nis somewhat unlikely for the tool to include in the route the roads\nthat are associated with the restriction. PREFER_LOW (0.8)\u2014It\nis somewhat likely for the tool to include in the route the roads\nthat are associated with the restriction. PREFER_MEDIUM (0.5)\u2014It is likely for the tool to include in the route the roads that\nare associated with the restriction. PREFER_HIGH (0.2)\u2014It is highly likely for the tool to include in the route the roads\nthat are associated with the restriction. In most cases, you can use the default value, PROHIBITED,\nfor the Restriction Usage if the restriction is dependent on a\nvehicle-characteristic such as vehicle height. However, in some\ncases, the value for Restriction Usage depends on your routing\npreferences. For example, the Avoid Toll Roads restriction has the\ndefault value of AVOID_MEDIUM for the Restriction Usage parameter.\nThis means that when the restriction is used, the tool will try to\nroute around toll roads when it can. AVOID_MEDIUM also indicates\nhow important it is to avoid toll roads when finding the best\nroute; it has a medium priority. Choosing AVOID_LOW would put lower\nimportance on avoiding tolls; choosing AVOID_HIGH instead would\ngive it a higher importance and thus make it more acceptable for\nthe service to generate longer routes to avoid tolls. Choosing\nPROHIBITED would entirely disallow travel on toll roads, making it\nimpossible for a route to travel on any portion of a toll road.\nKeep in mind that avoiding or prohibiting toll roads, and thus\navoiding toll payments, is the objective for some; in contrast,\nothers prefer to drive on toll roads because avoiding traffic is\nmore valuable to them than the money spent on tolls. In the latter\ncase, you would choose PREFER_LOW, PREFER_MEDIUM, or PREFER_HIGH as\nthe value for Restriction Usage. The higher the preference, the\nfarther the tool will go out of its way to travel on the roads\nassociated with the restriction.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "displayFieldName": "", "fields": [ { "name": "OBJECTID", "type": "esriFieldTypeOID", "alias": "ObjectID" }, { "name": "AttributeName", "type": "esriFieldTypeString", "alias": "AttributeName", "length": 255 }, { "name": "ParameterName", "type": "esriFieldTypeString", "alias": "ParameterName", "length": 255 }, { "name": "ParameterValue", "type": "esriFieldTypeString", "alias": "ParameterValue", "length": 25 } ], "features": [ { "attributes": { "OBJECTID": 55, "AttributeName": "Any Hazmat Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 56, "AttributeName": "Avoid Carpool Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 57, "AttributeName": "Avoid Express Lanes", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 58, "AttributeName": "Avoid Ferries", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 59, "AttributeName": "Avoid Gates", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 60, "AttributeName": "Avoid Limited Access Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 61, "AttributeName": "Avoid Private Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 62, "AttributeName": "Avoid Toll Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 63, "AttributeName": "Avoid Truck Restricted Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 64, "AttributeName": "Avoid Unpaved Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 65, "AttributeName": "Driving a Bus", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 66, "AttributeName": "Driving a Delivery Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 67, "AttributeName": "Driving a Taxi", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 68, "AttributeName": "Driving a Truck", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 69, "AttributeName": "Driving an Automobile", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 70, "AttributeName": "Driving an Emergency Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 71, "AttributeName": "Height Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 72, "AttributeName": "Height Restriction", "ParameterName": "Vehicle Height (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 73, "AttributeName": "Length Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 74, "AttributeName": "Length Restriction", "ParameterName": "Vehicle Length (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 75, "AttributeName": "Through Traffic Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" } }, { "attributes": { "OBJECTID": 76, "AttributeName": "Use Preferred Hazmat Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 77, "AttributeName": "Use Preferred Truck Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 78, "AttributeName": "WalkTime", "ParameterName": "Walking Speed (km/h)", "ParameterValue": "5" } }, { "attributes": { "OBJECTID": 79, "AttributeName": "Walking", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 80, "AttributeName": "Weight Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 81, "AttributeName": "Weight Restriction", "ParameterName": "Vehicle Weight (kilograms)", "ParameterValue": "0" } } ], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "Time_Zone_for_Time_of_Day", "dataType": "GPString", "displayName": "Time Zone for Time of Day", "description": "Specifies the time zone or zones of the Time of Day parameter.\n Geographically Local: The Time of Day parameter refers to the time zone or zones in which the facilities are located. Therefore, the start or end times of the service areas are staggered by time zone. Setting Time of Day to 9:00 a.m., choosing geographically local for Time Zone for Time of Day, and solving causes service areas to be generated for 9:00 a.m. Eastern Time for any facilities in the Eastern Time Zone, 9:00 a.m. Central Time for facilities in the Central Time Zone, 9:00 a.m. Mountain Time for facilities in the Mountain Time Zone, and so on, for facilities in different time zones. If stores in a chain that span the U.S. open at 9:00 a.m. local time, this parameter value could be chosen to find market territories at opening time for all stores in one solve. First, the stores in the Eastern Time Zone open and a polygon is generated, then an hour later stores open in Central Time, and so on. Nine o'clock is always in local time but staggered in real time. UTC: The Time of Day parameter refers to Coordinated Universal Time (UTC). Therefore, all facilities are reached or departed from simultaneously, regardless of the time zone each is in. Setting Time of Day to 2:00 p.m., choosing UTC, then solving causes service areas to be generated for 9:00 a.m. Eastern Standard Time for any facilities in the Eastern Time Zone, 8:00 a.m. Central Standard Time for facilities in the Central Time Zone, 7:00 a.m. Mountain Standard Time for facilities in the Mountain Time Zone, and so on, for facilities in different time zones. The scenario above assumes standard time. During daylight saving time, the Eastern, Central, and Mountain Times would each be one hour ahead (that is, 10:00, 9:00, and 8:00 a.m., respectively). One of the cases in which the UTC option is useful is to visualize emergency-response coverage for a jurisdiction that is split into two time zones. The emergency vehicles are loaded as facilities. Time of Day is set to now in UTC. (You need to determine what the current time and date are in terms of UTC to correctly use this option.) Other properties are set and the analysis is solved. Even though a time-zone boundary divides the vehicles, the results show areas that can be reached given current traffic conditions. This same process can be used for other times as well, not just for now. Irrespective of the Time Zone for Time of Day setting, all facilities must be in the same time zone\nwhen\nTime of Day has a nonnull value and Polygons for Multiple Facilities is set to create merged or nonoverlapping polygons.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Geographically Local", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Geographically Local", "UTC" ] }, { "name": "Travel_Mode", "dataType": "GPString", "displayName": "Travel Mode", "description": "Specify the mode of transportation to model in the analysis. Travel modes are managed in ArcGIS Online and can be configured by the administrator of your organization to better reflect your organization's workflows. You need to specify the name of a travel mode supported by your organization. To get a list of supported travel mode names, use the same GIS server connection you used to access this tool, and from the Utilities toolbox, run GetTravelModes. 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 speeds up the tool execution because the tool does not have to look up the settings based on the travel mode name. The default value, Custom, allows you to configure your own travel mode using the custom travel mode parameters (UTurn at Junctions, Use Hierarchy, Restrictions, Attribute Parameter Values, and Impedance). The default values of the custom travel mode parameters model traveling by car. You may want to choose Custom and set the custom travel mode parameters listed above to model a pedestrian with a fast walking speed or a truck with a given height, weight, and cargo of certain hazardous materials. You may choose to do this to try out different settings to get the analysis results you want. Once you have identified the analysis settings, you should 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 rerun the analysis with the same settings. By choosing Custom, the values you set for the custom travel mode parameters are included in the analysis. Specifying another travel mode, as defined by your organization, causes any values you set for the custom travel mode parameters to be ignored; the tool overrides them with values from your specified travel mode.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Custom", "parameterType": "esriGPParameterTypeOptional", "category": "" }, { "name": "Impedance", "dataType": "GPString", "displayName": "Impedance", "description": "Specify the \nimpedance, which is a value that represents the effort or cost of traveling along road segments or on other parts of the transportation network. Travel distance is 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\u2014a 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.) Travel time can also be an impedance; a car may take one minute to travel a mile along an empty road. Travel times can vary by travel mode\u2014a pedestrian may take more than 20 minutes to walk the same mile, so it is important to choose the right impedance for the travel mode you are modeling. Choose from the following impedance values: Drive Time\u2014Models travel times for a car. These travel times are dynamic and fluctuate according to traffic flows in areas where traffic data is available. This is the default value. Truck Time\u2014Models travel times for a truck. These travel times are static for each road and don't fluctuate with traffic. Walk Time\u2014Models travel times for a pedestrian. Travel Distance\u2014Stores length measurements along roads and paths. To model walk distance, choose this option and ensure Walking is set in the Restriction parameter. Similarly, to model drive or truck distance, choose Travel Distance here and set the appropriate restrictions so your vehicle travels only on roads where it is permitted to do so. The value you provide for this parameter is ignored unless Travel Mode is set to Custom, which is the default value. If you choose Drive Time, Truck Time, or Walk Time, the Measurement Units parameter must be set to a time-based value; if you choose Travel Distance for Impedance, Measurement Units must be distance-based.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Drive Time", "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode", "choiceList": [ "Drive Time", "Truck Time", "Walk Time", "Travel Distance" ] }, { "name": "Save_Output_Network_Analysis_Layer", "dataType": "GPBoolean", "displayName": "Save Output Network Analysis Layer", "description": "Specify if the tool should save the analysis settings as a network analysis layer file. You cannot directly work with this file even when you open the file in an ArcGIS Desktop application like ArcMap. It is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.\n Checked (True)\u2014Save the network analysis layer file. The file is downloaded in a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the value for the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing history of your Project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False)\u2014Do not save the network analysis layer file. This is the default.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Overrides", "dataType": "GPString", "displayName": "Overrides", "description": "Specify additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.\n The value for this parameter needs to be specified in JavaScript Object Notation (JSON). For example, a valid value is of the following form {\"overrideSetting1\" : \"value1\", \"overrideSetting2\" : \"value2\"}. The override setting name is always enclosed in double quotation marks. The values can be a number, Boolean, or a string. The default value for this parameter is no\nvalue, which indicates not to override any solver\nsettings. Overrides are advanced settings that should be\nused only after careful analysis of the results obtained before and\nafter applying the settings. A list of supported override settings\nfor each solver and their acceptable values can be obtained by\ncontacting Esri Technical Support.", "direction": "esriGPParameterDirectionInput", "defaultValue": "", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "Service_Areas", "dataType": "GPFeatureRecordSetLayer", "displayName": "Service Areas", "description": "Please ignore this parameter\u2014it is for internal use only.", "direction": "esriGPParameterDirectionOutput", "defaultValue": {}, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "Solve_Succeeded", "dataType": "GPBoolean", "displayName": "Solve Succeeded", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Output_Network_Analysis_Layer", "dataType": "GPDataFile", "displayName": "Output Network Analysis Layer", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" } ] }