Set Territory Attribute Constraints (Territory Design)

Available with Business Analyst license.

Summary

Sets variables for adding constraints when solving the territory solution.

Usage

  • Only variables that have been added to the level will be available.

  • Territories are constrained by the Minimum, Maximum, and Ideal Value values.

  • Set the Constraints parameter's Weight option to 100 if there is only one variable that will be used for constraints.

  • The Constraints parameter's Weight option will be set automatically if there are multiple variables.

  • The Constraints parameter's Maximum and Minimum options are hard constraints. Territories will not exceed or be below the specified values.

  • The Constraints parameter's Ideal Value option is a soft constraint. Territories can exceed or be below the specified value.

Parameters

LabelExplanationData Type
Input 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 constraints will be applied.

String
Constraints
(Optional)

The variables that will be used for constraining the territory solution.

  • Variable—Numeric value to be used as the constraint.
  • Minimum—Numeric value that sets a hard limit for the territories' lower bound.
  • Maximum—Numeric value that sets a hard limit for the territories' upper bound.
  • Ideal Value—Numeric value that sets a soft limit for the ideal value for the territory solution.
  • Weight—The influence a constraint value has on the territory solution. The number must be greater than 0.
Value Table

Derived Output

LabelExplanationData Type
Updated Territory Solution

The updated territory solution.

Group Layer

arcpy.td.SetTerritoryAttributeConstraints(in_territory_solution, level, {constraints})
NameExplanationData 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 constraints will be applied.

String
constraints
[[variable, minimum, maximum, ideal_value, weight],...]
(Optional)

The variables that will be used for constraining the territory solution.

  • variable—Numeric value to be used as the constraint.
  • minimum—Numeric value that sets a hard limit for the territories' lower bound.
  • maximum—Numeric value that sets a hard limit for the territories' upper bound.
  • ideal_value—Numeric value that sets a soft limit for the ideal value for the territory solution.
  • weight—The influence a constraint value has on the territory solution. The number must be greater than 0.
Value Table

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

SetTerritoryAttributeConstraints example (Python window)

The following Python window script demonstrates how to use the SetTerritoryAttributeConstraints function.

import arcpy
arcpy.td.SetTerritoryAttributeConstraints("TerritorySolution", "Territories[1]", "populationtotals_totpop_cy 10000 100000 # 100")

Licensing information

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

Related topics