Set Territory Level Options (Territory Design)

Available with Business Analyst license.

Summary

Sets options for how territory levels are created.

Usage

  • A Compactness parameter value of 100 is a circle where all parameters are satisfied.

  • A low value of Compactness means variables and preferences are satisfied, but shape is compromised.

  • The Fill Extent Automatically parameter assigns features to their closest territories regardless of the constraint parameters.

  • By default, a random number generator is used for the seed.

  • To generate consistent territories, use an integer value greater or equal to 0.

Syntax

SetTerritoryLevelOptions(in_territory_solution, level, {compactness}, {fill_extent}, {random_seed})
ParameterExplanationData 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 options will be applied.

String
compactness
(Optional)

A numeric value, between 0 and 100, that defines the shape of territories.

Long
fill_extent
(Optional)

Specifies whether features are automatically assigned to the nearest territory.

  • AUTO_FILL_EXTENTFeatures are automatically assigned to the nearest territory.
  • DO_NOT_AUTO_FILL_EXTENTFeatures are not automatically assigned to the nearest territory. This is the default.
Boolean
random_seed
(Optional)

An integer used for the seed value. The default is no value and uses a random generator.

  • Uses ACM-collected algorithm 599 to produce random territories.
  • If the seed value is greater or equal to 0, the same seed value will be used to produce consistent territories.

Long

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

SetTerritoryLevelOptions example (Python window)

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

import arcpy
arcpy.td.SetTerritoryLevelOptions("td", "Territories[1]", 75, "DO_NOT_AUTO_FILL_EXTENT", None)

Licensing information

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

Related topics