Display Name: ChooseBestFacilities
Description: This tool chooses the best locations for facilities by allocating locations that have demand for these facilities in a way that satisfies a given goal.
Category:
Help URL: https://spatialags.vhb.com/arcgis/rest/directories/arcgisoutput/System/SpatialAnalysisTools_GPServer/System_SpatialAnalysisTools/ChooseBestFacilities.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: goal
Data Type: GPString
Display Name goal
Description: Specify the goal that must be satisfied when allocating demand locations to facilities.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Allocate
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ Allocate, MinimizeImpedance, MaximizeCoverage, MaximizeCapacitatedCoverage, PercentCoverage ]
Parameter: demandLocationsLayer
Data Type: GPFeatureRecordSetLayer
Display Name demandLocationsLayer
Description: A point layer specifying the locations that have demand for facilities
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeRequired
Category: Demand Locations
Parameter: demand
Data Type: GPDouble
Display Name demand
Description: The amount of demand available at every demand locations.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1
Parameter Type: esriGPParameterTypeOptional
Category: Demand Locations
Parameter: demandField
Data Type: GPString
Display Name demandField
Description: The field on the demandLocationsLayer representing the amount of demand available at each demand location.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Demand Locations
Parameter: maxTravelRange
Data Type: GPDouble
Display Name maxTravelRange
Description: Specify the maximum travel time or distance allowed between a demand location and the facility it is allocated to
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 2147483647
Parameter Type: esriGPParameterTypeOptional
Category: Demand Locations
Parameter: maxTravelRangeField
Data Type: GPString
Display Name maxTravelRangeField
Description: The field on the demandLocationsLayer specifying the maximum travel time or distance allowed between a demand location and the facility it is allocated to. This parameter takes precedence when maxTravelRange parameter is also specified
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Demand Locations
Parameter: maxTravelRangeUnits
Data Type: GPString
Display Name maxTravelRangeUnits
Description: The units for the maximum travel time or distance allowed between a demand location and the facility it is allocated to.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Minutes
Parameter Type: esriGPParameterTypeOptional
Category: Demand Locations
Choice List: [ Seconds, Minutes, Hours, Days, Meters, Kilometers, Feet, Yards, Miles ]
Parameter: travelMode
Data Type: GPString
Display Name travelMode
Description: Specify the mode of transportation for the analysis
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Measure
Parameter: timeOfDay
Data Type: GPDate
Display Name timeOfDay
Description: Specify whether travel times should consider traffic conditions
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Measure
Parameter: timeZoneForTimeOfDay
Data Type: GPString
Display Name timeZoneForTimeOfDay
Description: Specify the time zone or zones for the timeOfDay parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: GeoLocal
Parameter Type: esriGPParameterTypeOptional
Category: Measure
Choice List: [ GeoLocal, UTC ]
Parameter: travelDirection
Data Type: GPString
Display Name travelDirection
Description: Specify whether to measure travel times or distances from facilities to demand locations or from demand locations to facilities.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: FacilityToDemand
Parameter Type: esriGPParameterTypeOptional
Category: Measure
Choice List: [ FacilityToDemand, DemandToFacility ]
Parameter: requiredFacilitiesLayer
Data Type: GPFeatureRecordSetLayer
Display Name requiredFacilitiesLayer
Description: A point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are required to be part of the output solution and will be used before any facilities from the candidatesFacilitiesLayer when allocating demand locations.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: requiredFacilitiesCapacity
Data Type: GPDouble
Display Name requiredFacilitiesCapacity
Description: Specify how much demand every facility in the requiredFacilitiesLayer is capable of supplying.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 2147483647
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: requiredFacilitiesCapacityField
Data Type: GPString
Display Name requiredFacilitiesCapacityField
Description: A field on the requiredFacilitiesLayer representing how much demand each facility in the requiredFacilitiesLayer is capable of supplying. This parameter takes precedence when requiredFacilitiesCapacity parameter is also specified.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: candidateFacilitiesLayer
Data Type: GPFeatureRecordSetLayer
Display Name candidateFacilitiesLayer
Description: A point layer specifying one or more locations that act as facilities by providing some kind of service. Facilities specified by this parameter are not required to be part of the output solution and will be used only after all the facilities from the candidatesFacilitiesLayer have been used when allocating demand locations.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: candidateCount
Data Type: GPLong
Display Name candidateCount
Description: Specify the number of facilities to choose when allocating demand locations. If requiredFacilitiesLayer is specified, the number of facilities to choose should be equal to or greater than the count of locations in the requiredFacilitiesLayer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: candidateFacilitiesCapacity
Data Type: GPDouble
Display Name candidateFacilitiesCapacity
Description: Specify how much demand every facility in the candidateFacilitiesLayer is capable of supplying.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 2147483647
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: candidateFacilitiesCapacityField
Data Type: GPString
Display Name candidateFacilitiesCapacityField
Description: A field on the candidateFacilitiesLayer representing how much demand each facility in the candidatesFacilitiesLayer is capable of supplying. This parameter takes precedence when candidateFacilitiesCapacity parameter is also specified.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: percentDemandCoverage
Data Type: GPDouble
Display Name percentDemandCoverage
Description: Specify the percentage of the total demand that you want the chosen and required facilities to capture.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 100
Parameter Type: esriGPParameterTypeOptional
Category: Facilities
Parameter: outputName
Data Type: GPString
Display Name outputName
Description: If provided, the task will create a feature service of the results. You define the name of the service. If outputName is not supplied, the task will return a feature collection.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Result
Parameter: context
Data Type: GPString
Display Name context
Description: Context contains additional settings that affect task execution such as the extent of inputs.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Result
Parameter: pointBarrierLayer
Data Type: GPFeatureRecordSetLayer
Display Name pointBarrierLayer
Description: Specify one or more points to act as temporary restrictions or represent additional time or distance that may be required to travel on the underlying streets.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: lineBarrierLayer
Data Type: GPFeatureRecordSetLayer
Display Name lineBarrierLayer
Description: Specify one or more lines that prohibit travel anywhere the lines intersect the streets.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: polygonBarrierLayer
Data Type: GPFeatureRecordSetLayer
Display Name polygonBarrierLayer
Description: Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: allocatedDemandLocationsLayer
Data Type: GPString
Display Name allocatedDemandLocationsLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: allocationLinesLayer
Data Type: GPString
Display Name allocationLinesLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: assignedFacilitiesLayer
Data Type: GPString
Display Name assignedFacilitiesLayer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Supported Operations:
Submit Job
Child Resources:
Metadata