{ "name": "FindClosestFacilities", "displayName": "FindClosestFacilities", "description": "Finds one or more facilities that are closest from an incident based on travel time or travel distance and outputs the best routes, driving directions between the incidents and the chosen facilities, and a copy of the chosen facilities. You can use the tool, for example, to find the closest hospital to an accident, the closest police cars to a crime scene, or the closest store to a customer's address., When finding closest facilities, you can specify how many to find and whether the direction of travel is toward or away from them. You can also specify the time of day to account for travel times based on live or predictive traffic conditions for that time and date. For instance, you can use the tool to search for hospitals within a 15-minute drive time of the site of an accident at a given time of day. Any hospitals that take longer than 15 minutes to reach based on the traffic conditions will not be included in the results.", "category": "", "helpUrl": "https://sampleserver6.arcgisonline.com/arcgis/rest/directories/arcgisoutput/NetworkAnalysis/SanDiego_GPServer/NetworkAnalysis_SanDiego/FindClosestFacilities.htm", "executionType": "esriExecutionTypeAsynchronous", "parameters": [ { "name": "Incidents", "dataType": "GPFeatureRecordSetLayer", "displayName": "Incidents", "description": "Specify one or more incidents (up to 1,000). These are the locations from which the tool searches\nfor the nearby locations. When specifying the incidents, you can set properties for each one, such as its name or service time, by using attributes. The incidents can be specified with the following attributes: Name\u2014The name of the incident. The name is used in the driving\ndirections. If the name is not specified, a unique name prefixed\nwith Location is automatically generated in the output routes and\ndirections. ID\u2014A unique identifier for the incident. The identifier is included in the output routes (as the IncidentID field) and can help join additional information from the output routes, such as the total travel time or total distance, to attributes from your incidents or vice versa. If the ID isn't specified, the service autogenerates a unique identifier for each incident. AdditionalTime\u2014The amount of time spent at the incident, which is added to the total time of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are time based. The default value is 0. If you are finding the closest fire stations from fire incidents to estimate response times, the AdditionalTime attribute can store the amount of time it takes firefighters to hook up their equipment at the location of the incident before they can begin fighting the fire. AdditionalDistance\u2014The extra distance traveled at the incident, which is added to the total distance of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are distance based. The default value is 0. Generally, the location of an incident, such as a home, isn't exactly on the streets; it is set back somewhat from the road. This attribute value can be used to model the distance between the actual incident location and its location on the street, if it is important to include that distance in the total travel distance. CurbApproach\u2014Specifies the direction a vehicle may arrive at and depart\nfrom the incident. The field value is specified as one of the\nfollowing integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle)\u2014The vehicle can approach and depart the incident in either direction, so a U-turn is allowed at the incident. This setting can be chosen if it is possible and practical for your vehicle to turn around at the incident. This decision may depend on the width of the road and the amount of traffic or whether the incident has a parking lot where vehicles can pull in and turn around. 1 ( Right side of vehicle)\u2014When the vehicle approaches and departs the incident, the incident must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)\u2014When the vehicle approaches and departs\nthe incident, the curb must be on the left side of the vehicle. A\nU-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left-hand side. 3 (No U-Turn)\u2014When\nthe vehicle approaches the incident, the curb can be on either side\nof the vehicle; however, the vehicle must depart without turning\naround. The CurbApproach property is designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an incident on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an incident from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an incident and not have a lane of traffic between the vehicle and the incident, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.", "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": "ID", "type": "esriFieldTypeString", "alias": "ID", "length": 128 }, { "name": "AdditionalTime", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "AdditionalDistance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "Facilities", "dataType": "GPFeatureRecordSetLayer", "displayName": "Facilities", "description": "Specify one or more facilities (up to 1,000). These are the locations that are searched for when\nfinding the closest location. When specifying the facilities, you can set properties for each one, such as its name or service time, by using attributes. The facilities can be specified with the following attributes: Name\u2014The name of the facility. The name is used in the driving\ndirections. If the name is not specified, a unique name prefixed\nwith Location is automatically generated in the output routes and\ndirections. ID\u2014A unique identifier for the facility. The identifier is included in the output routes (as the FacilityID field) and the output closest facilities as FacilityID fields. The FacilityID field can be used to join additional information from the output routes, such as the total travel time or total distance, to attributes from your facilities. If the ID isn't specified, the service autogenerates a unique identifier for each facility. AdditionalTime\u2014The amount of time spent at the facility, which is added to the total time of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are time based. The default value is 0. If you are finding the closest fire stations to fire incidents, AdditionalTime can store the\ntime it tends to takes a crew to don the appropriate protective equipment\nand exit the fire station. AdditionalDistance\u2014The extra distance traveled at the facility, which is added to the total distance of the route. The units for this attribute value are specified by the Measurement Units parameter. The attribute value is included in the analysis only when the measurement units are distance based. The default value is 0. Generally the location of a facility, such as a fire station, isn't exactly on a street; it is set back somewhat from the road. AdditionalDistance can model the distance between the actual facility location and its location on the street, if it is important to include that distance in the total travel distance. CurbApproach: Specifies the direction a vehicle may arrive at and depart\nfrom the facility. The field value is specified as one of the\nfollowing integers (use the numeric code, not the name in parentheses): 0 (Either side of vehicle)\u2014The vehicle can approach and depart the facility in either direction, so a U-turn is allowed at the facility. This setting can be chosen if it is possible and practical for your vehicle to turn around at the facility. This decision may depend on the width of the road and the amount of traffic or whether the facility has a parking lot where vehicles can pull in and turn around. 1 (Right side of vehicle)\u2014When the vehicle approaches and departs the facility, the facility must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right-hand side. 2 (Left side of vehicle)\u2014When the vehicle approaches and departs\nthe facility, the curb must be on the left side of the vehicle. A\nU-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left-hand side. 3 (No U-Turn)\u2014When\nthe vehicle approaches the facility, the curb can be on either side\nof the vehicle; however, the vehicle must depart without turning\naround. The CurbApproach property was designed to work with both kinds of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a facility on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a facility from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at a facility and not have a lane of traffic between the vehicle and the facility, you would choose Right side of vehicle (1) in the United States but Left side of vehicle (2) in the United Kingdom.", "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": "ID", "type": "esriFieldTypeString", "alias": "ID", "length": 128 }, { "name": "AdditionalTime", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "AdditionalDistance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "Curb Approach" } ], "features": [], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeRequired", "category": "" }, { "name": "Measurement_Units", "dataType": "GPString", "displayName": "Measurement Units", "description": "Specify the units that should be used to measure and report the total travel time or travel distance for the output routes. The tool finds the closest facility by measuring the travel time or the travel distance along streets. The units you choose for this parameter determine whether the tool will measure driving distance or driving time to find what is closest. Choose a time unit to measure driving time. To measure driving distance, choose a distance unit. Your choice also determines in which units the tool will report total driving time or distance in the results. The choices include the following: Meters Kilometers Feet Yards Miles NauticalMiles 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": "Number_of_Facilities_to_Find", "dataType": "GPLong", "displayName": "Number of Facilities to Find", "description": "Specify the number of\nclosest facilities to find per incident. This is useful in\nsituations, such as a fire, where multiple fire engines may be\nrequired from different fire stations. You can specify, for\nexample, to find the three nearest fire stations to a fire. The tool can find up to 100 facilities from each incident.", "direction": "esriGPParameterDirectionInput", "defaultValue": 1, "parameterType": "esriGPParameterTypeOptional", "category": "" }, { "name": "Cutoff", "dataType": "GPDouble", "displayName": "Cutoff", "description": "Specify the travel time or travel distance value at which\nto stop searching for facilities for a given incident. For\ninstance, while finding the closest hospitals from the site of an\naccident, a cutoff value of 15 minutes would mean that the tool\nwould search for the closest hospital within 15 minutes from the\nincident. If the closest hospital is 17 minutes away, no routes\nwill be returned in the output routes. A cutoff value is especially\nuseful when searching for multiple facilities. The units for this parameter is specified by the\nMeasurement Units parameter.", "direction": "esriGPParameterDirectionInput", "defaultValue": null, "parameterType": "esriGPParameterTypeOptional", "category": "" }, { "name": "Travel_Direction", "dataType": "GPString", "displayName": "Travel Direction", "description": "Specify whether you want to search for the closest\nfacility as measured from the incident to the facility or from the\nfacility to the incident. Facility to Incident\u2014Direction of travel is from\nfacilities to incidents. Incident to Facility\u2014Direction of travel is from\nincidents to facilities. Using one of the parameter values can find different\nfacilities as the travel time along some streets may vary based on\nthe travel direction and one-way restrictions. For instance, a\nfacility may be a 10-minute drive from the incident while traveling\nfrom the incident to the facility, but while traveling from the\nfacility to the incident, it may be a 15-minute journey because of\ndifferent travel time in that direction. If you are setting a value for Time of Day, traffic may also cause the Facility to Incident and Incident to Facility options to return different results. Fire departments commonly use the Facility to Incident\nvalue for the parameter since they are concerned with the time it\ntakes to travel from the fire station (facility) to the location of\nthe emergency (incident). A retail store (facility) is more\nconcerned with the time it takes the shoppers (incidents) to reach\nthe store; therefore, stores commonly choose Incident to Facility.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Incident to Facility", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Incident to Facility", "Facility to Incident" ] }, { "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. Checked (True)\u2014Use hierarchy when finding routes. When\nhierarchy is used, the tool prefers higher-order streets (such as\nfreeways) to lower-order streets (such as local roads), and can be used\nto simulate the driver preference of traveling on freeways instead\nof local roads even if that means a longer trip. This is especially\ntrue when finding routes to faraway facilities, because drivers on long-distance trips tend to prefer traveling on freeways where stops, intersections, and turns can be avoided. Using hierarchy is computationally faster,\nespecially for long-distance routes, as the tool has to select the\nbest route from a relatively smaller subset of streets. Unchecked (False)\u2014Do not use hierarchy when finding routes. If\nhierarchy is not used, the tool considers all the streets and doesn't\nprefer higher-order streets when finding the route. This is often\nused when finding short-distance routes within a city. The tool automatically reverts to using hierarchy if the\nstraight-line distance between facilities and incidents is\ngreater than 50 miles, even if you have set this parameter to not use hierarchy.", "direction": "esriGPParameterDirectionInput", "defaultValue": true, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "Time_of_Day", "dataType": "GPDate", "displayName": "Time of Day", "description": "Specifies the time and date at which the routes should\nbegin or end. The value is used as the start time or end time for\nthe route depending on the value for the Time of Day Usage\nparameter. If you specify the current date and time as the value\nfor this parameter, the tool will use live traffic conditions to\nfind the closest facilities and the total travel time will be based\non traffic conditions. Specifying a time of day results in more accurate\nestimation of travel time between the incident and facility because the\ntravel times account for the traffic conditions that are applicable\nfor that date and time. The Time Zone for Time of Day parameter specifies whether this time and date refer to UTC or the time zone in which the facility or incident is located.", "direction": "esriGPParameterDirectionInput", "defaultValue": null, "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis" }, { "name": "Time_of_Day_Usage", "dataType": "GPString", "displayName": "Time of Day Usage", "description": "Indicates whether the Time of Day parameter value\nrepresents the arrival or departure time for the routes. Start Time\u2014When this option is chosen, the tool finds\nthe best route considering the Time of Day parameter value as the\ndeparture time from the facility or incident. End Time\u2014When this option is chosen, the tool considers\nthe Time of Day parameter value as the arrival time at the facility\nor incident. This option is useful if you want to know what time to\ndepart from a location so you arrive at the destination at the\ntime specified in Time of Day.", "direction": "esriGPParameterDirectionInput", "defaultValue": "Start Time", "parameterType": "esriGPParameterTypeOptional", "category": "Advanced Analysis", "choiceList": [ "Start Time", "End Time" ] }, { "name": "UTurn_at_Junctions", "dataType": "GPString", "displayName": "UTurn at Junctions", "description": "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.\n\n Given that junctions represent street intersections and dead ends, different vehicles may be able to turn around at some junctions but not at others\u2014it 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. \n Allowed\u2014U-turns are permitted at junctions with any number of connected edges. This is the default value. Not Allowed\u2014U-turns are prohibited at all junctions, regardless of junction valency. Note, however, that U-turns are still permitted at network locations even when this setting is chosen; however, you can set the individual network locations' CurbApproach property to prohibit U-turns there as well. Allowed only at Dead Ends\u2014U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end). Allowed only at Intersections and Dead Ends\u2014U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge). Oftentimes, networks have extraneous junctions in the middle of road segments. This option prevents vehicles from making U-turns at these locations.", "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": "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 measurement units are time based. This field\nvalue must be greater than or equal to zero, and its units are the same as those specified in the\nMeasurement 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 measurement units are distance based. The field value\nmust be greater than or equal to zero, and its units are the same as those specified in the\nMeasurement 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": "Barrier Type" }, { "name": "Additional_Time", "type": "esriFieldTypeDouble", "alias": "Additional Time" }, { "name": "Additional_Distance", "type": "esriFieldTypeDouble", "alias": "Additional Distance" }, { "name": "CurbApproach", "type": "esriFieldTypeSmallInteger", "alias": "CurbApproach" } ], "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 measurement units are time\nbased. The field value must be greater than zero. 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 measurement\nunits are 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": "Barrier Type" }, { "name": "ScaledTimeFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Time Factor" }, { "name": "ScaledDistanceFactor", "type": "esriFieldTypeDouble", "alias": "Scaled Distance Factor" }, { "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 restrictions should be honored by the tool when finding the best routes between incidents and facilities. A restriction represents a driving preference or requirement. In most cases, restrictions cause roads to be prohibited, but they can also cause them to be avoided or preferred. For instance, using an Avoid Toll Roads restriction will result in a route that will include toll roads only when it is absolutely required to travel on toll roads in order to visit an incident or a facility. Height Restriction makes it possible to route around any clearances that are lower than the height of your vehicle. If you are carrying corrosive materials on your vehicle, using the Any Hazmat Prohibited restriction prevents hauling the materials along roads where it is marked as illegal to do so. Below is a list of available restrictions and a short description. Some restrictions require an additional value to be\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": 28, "AttributeName": "Any Hazmat Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 29, "AttributeName": "Avoid Carpool Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 30, "AttributeName": "Avoid Express Lanes", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 31, "AttributeName": "Avoid Ferries", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 32, "AttributeName": "Avoid Gates", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 33, "AttributeName": "Avoid Limited Access Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 34, "AttributeName": "Avoid Private Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 35, "AttributeName": "Avoid Toll Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 36, "AttributeName": "Avoid Truck Restricted Roads", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 37, "AttributeName": "Avoid Unpaved Roads", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_MEDIUM" } }, { "attributes": { "OBJECTID": 38, "AttributeName": "Driving a Bus", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 39, "AttributeName": "Driving a Delivery Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 40, "AttributeName": "Driving a Taxi", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 41, "AttributeName": "Driving a Truck", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 42, "AttributeName": "Driving an Automobile", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 43, "AttributeName": "Driving an Emergency Vehicle", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 44, "AttributeName": "Height Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 45, "AttributeName": "Height Restriction", "ParameterName": "Vehicle Height (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 46, "AttributeName": "Length Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 47, "AttributeName": "Length Restriction", "ParameterName": "Vehicle Length (meters)", "ParameterValue": "0" } }, { "attributes": { "OBJECTID": 48, "AttributeName": "Through Traffic Prohibited", "ParameterName": "Restriction Usage", "ParameterValue": "AVOID_HIGH" } }, { "attributes": { "OBJECTID": 49, "AttributeName": "Use Preferred Hazmat Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 50, "AttributeName": "Use Preferred Truck Routes", "ParameterName": "Restriction Usage", "ParameterValue": "PREFER_MEDIUM" } }, { "attributes": { "OBJECTID": 51, "AttributeName": "WalkTime", "ParameterName": "Walking Speed (km/h)", "ParameterValue": "5" } }, { "attributes": { "OBJECTID": 52, "AttributeName": "Walking", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 53, "AttributeName": "Weight Restriction", "ParameterName": "Restriction Usage", "ParameterValue": "PROHIBITED" } }, { "attributes": { "OBJECTID": 54, "AttributeName": "Weight Restriction", "ParameterName": "Vehicle Weight (kilograms)", "ParameterValue": "0" } } ], "exceededTransferLimit": false }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "Route_Shape", "dataType": "GPString", "displayName": "Route Shape", "description": "Specify the type of route features that are output by the\ntool. The parameter can be specified using one of the following\nvalues: True Shape: Return the exact shape of the resulting route\nthat is based on the underlying streets. True Shape with Measures: Return the exact shape of the resulting route that is based on the underlying streets. Additionally, construct measures so the shape may be used in linear referencing. The measurements increase from the first stop and record the cumulative travel time or travel distance in the units specified by the Measurement Units parameter. Straight Line: Return a straight line between two stops. None: Do not return any shapes for the routes. This value\ncan be useful, and return results quickly, in cases where you are only interested in determining\nthe total travel time or travel distance of a route. When the Route Shape parameter is set to True Shape or True Shape with Measures, the\ngeneralization of the route shape can be further controlled using\nthe appropriate value for the Route Line Simplification Tolerance\nparameter. No matter which value you choose for the Route Shape\nparameter, the best route is always determined by minimizing the\ntravel time or the travel distance, never using the straight-line\ndistance between stops. This means that only the route shapes are different,\nnot the underlying streets that are searched when finding the\nroute.", "direction": "esriGPParameterDirectionInput", "defaultValue": "True Shape", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "True Shape", "True Shape with Measures", "Straight Line", "None" ] }, { "name": "Route_Line_Simplification_Tolerance", "dataType": "GPLinearUnit", "displayName": "Route Line Simplification Tolerance", "description": "Specify by how much you want to simplify the geometry of the output lines for routes and directions. The tool ignores this parameter if the Route Shape parameter isn't set to True Shape. Simplification maintains critical\npoints on a route, such as turns at intersections, to define the\nessential shape of the route and removes other points. The\nsimplification distance you specify is the maximum allowable offset\nthat the simplified line can deviate from the original line.\nSimplifying a line reduces the number of vertices that are part of\nthe route geometry. This improves the tool execution\ntime.", "direction": "esriGPParameterDirectionInput", "defaultValue": { "distance": 10, "units": "esriMeters" }, "parameterType": "esriGPParameterTypeOptional", "category": "Custom Travel Mode" }, { "name": "Populate_Directions", "dataType": "GPBoolean", "displayName": "Populate Directions", "description": "Specify whether the tool should generate driving directions for\neach route. Checked (True): Indicates that the directions will be generated\nand configured based on the values for the Directions Language,\nDirections Style Name, and Directions Distance Units\nparameters. Unchecked (False): Directions are not generated, and the tool\nreturns an empty Directions layer.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Directions_Language", "dataType": "GPString", "displayName": "Directions Language", "description": "Specify the language that should be used when generating\ndriving directions. This parameter is used only when the Populate\nDirections parameter is checked, or set to True. The parameter value can be\nspecified using one of the following two- or five-character language codes: ar\u2014Arabiccs\u2014Czech de\u2014German el\u2014Greek en\u2014English es\u2014Spanishet\u2014Estonian fr\u2014French he\u2014Hebrew it\u2014Italian ja\u2014Japanese ko\u2014Korean lt\u2014Lithuanianlv\u2014Latvian nl\u2014Dutch pl\u2014Polish pt-BR\u2014Brazilian\nPortuguese pt-PT\u2014European\nPortuguese ru\u2014Russian sv\u2014Swedishtr\u2014Turkish zh-CN\u2014Simplified\nChinese If an unsupported language code is specified, the tool\nreturns the directions using the default language,\nEnglish.", "direction": "esriGPParameterDirectionInput", "defaultValue": "en", "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Directions_Distance_Units", "dataType": "GPString", "displayName": "Directions Distance Units", "description": "Specify the units for displaying travel distance in the\ndriving directions. This parameter is used only when the Populate\nDirections parameter is checked, or set to True. Miles Kilometers Meters Feet Yards NauticalMiles", "direction": "esriGPParameterDirectionInput", "defaultValue": "Miles", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "Miles", "Kilometers", "Meters", "Feet", "Yards", "NauticalMiles" ] }, { "name": "Directions_Style_Name", "dataType": "GPString", "displayName": "Directions Style Name", "description": "Specify the name of the formatting style for the\ndirections. This parameter is used only when the Populate\nDirections parameter is checked, or set to True. The parameter can be specified\nusing the following values: NA Desktop: Generates turn-by-turn directions suitable\nfor printing. NA Navigation: Generates turn-by-turn directions designed\nfor an in-vehicle navigation device.", "direction": "esriGPParameterDirectionInput", "defaultValue": "NA Desktop", "parameterType": "esriGPParameterTypeOptional", "category": "Output", "choiceList": [ "NA Desktop", "NA Navigation" ] }, { "name": "Time_Zone_for_Time_of_Day", "dataType": "GPString", "displayName": "Time Zone for Time of Day", "description": "Specifies the time zone of the Time of Day parameter. Geographically Local: The Time of Day parameter refers to the time zone in which the facilities or incidents are located. If Time of Day Usage is set to Start Time and Travel Direction is Facility to Incident, this is the time zone of the facilities. If Time of Day Usage is set to Start Time and Travel Direction is Incident to Facility, this is the time zone of the incidents. If Time of Day Usage is set to End Time and Travel Direction is Facility to Incident, this is the time zone of the incidents. If Time of Day Usage is set to End Time and Travel Direction is Incident to Facility, this is the time zone of the facilities. UTC: The Time of Day parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to find what's nearest for a specific time, such as now, but aren't certain in which time zone the facilities or incidents will be located. Irrespective of the Time Zone for Time of Day setting, if your facilities\nand incidents are in multiple time zones, the following rules are\nenforced by the tool: All incidents must be in the same time zone\nwhen: Specifying a start time and traveling from incident to\nfacility. Specifying an end time and traveling from facility to\nincident. All facilities must be in the same time zone\nwhen: Specifying a start time and traveling from facility to\nincident. Specifying an end time and traveling from incident to\nfacility.", "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": "Save_Route_Data", "dataType": "GPBoolean", "displayName": "Save Route Data", "description": "Choose whether the output includes a zip file\nthat contains a file geodatabase holding the inputs and outputs of\nthe analysis in a format that can be used to share route layers\nwith ArcGIS Online or Portal for ArcGIS. Checked (True)\u2014Save the route data as a zip 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 Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing history of your Project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing Results window. Unchecked (False)\u2014Do not save the route data. This is the default.", "direction": "esriGPParameterDirectionInput", "defaultValue": false, "parameterType": "esriGPParameterTypeOptional", "category": "Output" }, { "name": "Output_Routes", "dataType": "GPFeatureRecordSetLayer", "displayName": "Output Routes", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": {}, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Output_Directions", "dataType": "GPFeatureRecordSetLayer", "displayName": "Output Directions", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": {}, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Solve_Succeeded", "dataType": "GPBoolean", "displayName": "Solve Succeeded", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Output_Closest_Facilities", "dataType": "GPFeatureRecordSetLayer", "displayName": "Output Closest Facilities", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": {}, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Output_Network_Analysis_Layer", "dataType": "GPDataFile", "displayName": "Output Network Analysis Layer", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" }, { "name": "Output_Route_Data", "dataType": "GPDataFile", "displayName": "Output Route Data", "description": "", "direction": "esriGPParameterDirectionOutput", "defaultValue": null, "parameterType": "esriGPParameterTypeDerived", "category": "" } ] }