ArcMap

Balance Territories

Available with Business Analyst license.

Summary

Balances existing territories.

Usage

  • The Territory Level format must be as follows: Level_Name[Level_Index].

    The Balancing variables should be specified, via UI or the Setup Level Balancing Variables tool.

    The Distance constraints (see Maximum Distance, Minimum Distance and Minimum Distance Between Centers parameters) or Capacity constraints can be specified via UI or the appropriate GP tool.

Syntax

arcpy.td.BalanceTerritories(in_territory_solution_layer, in_level, {in_balancing_method}, {in_autofill_extent}, {in_keep_invalid_territories})
ParameterExplanationData Type
in_territory_solution_layer

The Territory Solution layer to be balanced.

GP TD Layer
in_level

The Territory Level to modify.

String
in_balancing_method
(Optional)

This parameter ensures that all available features will be used while modifying territories.

  • EXTEND_COVERAGE_AREA — all available features will be used during balancing
  • WORK_CURRENT_COVERAGE_AREA — only features assigned to territories at the start will be used during balancing
Boolean
in_autofill_extent
(Optional)

This parameter ensures that all unassigned features will be added to their closest territories regardless of the constraint parameters. This option may affect the assigned parameters in order to include all territories in the solution.

  • AUTO_FILL_EXTENT — adds all unassigned features to their closest territories
  • DO_NOT_AUTO_FILL_EXTENT — unassigned features will not change their state
Boolean
in_keep_invalid_territories
(Optional)

This parameter ensures that all modified territories, exceeding constraints, will not be automatically emptied. This is useful for finding the reasons why there are a number of empty territories (for example, if constraints are opposite each other).

  • OVERRIDE_CONSTRAINTS — does not automatically un-assign all features from territories that violate specified constraints
  • DO_NOT_OVERRIDE_CONSTRAINTS — automatically un-assigns all features from territories that violate specified constraints (a warning message will appear)
Boolean

Code sample

The following Python window script demonstrates how to use the Business Analyst geoprocessing tool in immediate mode.

import arcgisscripting
gp = arcgisscripting.create()
gp.BalanceTerritories_TD("new layer", "Territories[1]", "EXTEND_COVERAGE_AREA", "DO_NOT_AUTO_FILL_EXTENT", "DO_NOT_OVERRIDE_CONSTRAINTS")

The following stand-alone script demonstrates how to use the tool.

# Import system modules
import arcgisscripting
gp = arcgisscripting.create()

# Set local variables
solution = "new layer"
level = "Territories[1]"
balanceMethod = "EXTEND_COVERAGE_AREA"
autoFillExtent = "DO_NOT_AUTO_FILL_EXTENT"
overrideConstraints = "DO_NOT_OVERRIDE_CONSTRAINTS"

# Execute tool
gp.BalanceTerritories_TD(solution, level, balanceMethod, autoFillExtent, overrideConstraints)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics