Set Territory Distance Parameters (Territory Design)

Available with Business Analyst license.

Summary

Defines the type of distance calculation or distance constraints to use when creating territories.

Usage

• Maximum Territory Radius specifies the maximum size of the territory. Adjacent territories can be smaller than the radius specified if the boundaries between territories overlap. Territories will expand until the radius value is reached.

  

• Territory Buffer Distance specifies the buffer size around each territory that cannot be encroached. Territories will be constrained by the adjacent territory buffer.

  

• When setting Minimum Distance Between Centers, the distance between centers can be greater than the minimum distance.

  

• If a network distance is specified, a Territory Network Index (TNI) will be created during the Solve tool execution.

• If Network Parameters are set, a summary of network settings will be written, as messages at the bottom of the Geoprocessing pane, during the execution of the Solve tool.

• Network Data Source must be set to a local network dataset. Online network solvers are not supported.

Syntax

SetTerritoryDistanceParameters(in_territory_solution, level, {distance_type}, {units}, {max_radius}, {buffer_distance}, {min_distance}, {network_datasource}, {build_index}, {travel_direction}, {time_of_day}, {time_zone}, {search_tolerance})

Parameter	Explanation	Data Type
in_territory_solution	The Territory Design solution layer that will be used in the analysis.	Group Layer; Feature Dataset; String
level	The level to which the distance parameters will be applied.	String
distance_type (Optional)	Specifies how distance is calculated based on method of travel. STRAIGHT_LINE —Straight-line, or Euclidean distance, is used as the distance measure. This is the default. Additional distance types (travel modes—for example, Driving Time, Driving Distance) will be dependent on the available network dataset.	String
units (Optional)	Specifies the type of measuring units that will be used. METERS —The distance unit is meters. MILES —The distance unit is miles. NAUTICAL_MILES —The distance unit is nautical miles. KILOMETERS —The distance unit is kilometers. YARDS —The distance unit is yards. FEET —The distance unit is feet. INCHES —The distance unit is inches. DECIMETERS —The distance unit is decimeters. CENTIMETERS —The distance unit is centimeters. MILLIMETERS —The distance unit is millimeters. DECIMAL_DEGREES —The distance unit is decimal degrees. MINUTES —The time unit is minutes. HOURS —The time unit is hours. DAYS —The time unit is days. SECONDS —The time unit is seconds.	String
max_radius (Optional)	The maximum radius of the territory.	Double
buffer_distance (Optional)	The radius of the territory buffer.	Double
min_distance (Optional)	The minimum distance between territory centers.	Double
network_datasource (Optional)	The network dataset on which the network distance calculation will be performed.	Network Dataset Layer
build_index (Optional)	Specifies whether or not to build an index. A network index will improve performance when solving the Territory Solution. BUILD_INDEX —Create a network index. This is the default. DO_NOT_BUILD_INDEX —Do not create a network index.	Boolean
travel_direction (Optional)	Specifies the direction of travel between stores and customers. TOWARD_STORES —Direction of travel is from customers to stores. This is the default. AWAY_FROM_STORES —Direction of travel is from stores to customers.	String
time_of_day (Optional)	Specifies the time and date when calculating distance.	Date
time_zone (Optional)	Specifies the time zone of the Time of Day parameter. TIME_ZONE_AT_LOCATION —The time zone in which the territories are located. This is the default. UTC — Refers to coordinated universal time (UTC).	String
search_tolerance (Optional)	The search tolerance for locating territories on the network. Territories that are outside the search tolerance are left unlocated. The parameter requires a distance value and units for the tolerance. The default value is 5000 Meters.	Linear Unit

Derived Output

Name	Explanation	Data Type
out_territory_solution	The updated territory solution.	Group Layer

Code sample

SetTerritoryDistanceParameters example (Python window)

The following Python window script demonstrates how to use the SetTerritoryDistanceParameters tool.

import arcpy
arcpy.td.SetTerritoryDistanceParameters("TerritorySolution", "Territories[1]", "STRAIGHT_LINE", "MILES", 5, 1, 3, "\Data\Streets Data\NorthAmerica.gdb\Routing\Routing_ND", "BUILD_INDEX", None, "5:30:00 PM", "TIME_ZONE_AT_LOCATION", "5000 Meters")

Environments

Current Workspace

Licensing information

• Basic: Requires Business Analyst
• Standard: Requires Business Analyst
• Advanced: Requires Business Analyst