Set Balance Variables (Territory Design)

Available with Business Analyst license.

Summary

Configures variables to be used in the balancing process.

Usage

  • The variables will be used according to relative weight, which is calculated based on a specified preference for each variable.

  • Preference refers to the relative weight of each variable.

  • Preferences from all of the variables should total 100 percent.

  • Use the Add Level Variable tool to add variables to be balanced.

  • Set the preference to zero if you do not want to disable the variable to be used for balancing.

Syntax

arcpy.td.SetBalanceVariables(in_territory_solution, level, variables)
ParameterExplanationData Type
in_territory_solution

The name of the input territory solution.

Group Layer; Feature Dataset; String
level

The name of the level to which the calculated field will be added.

String
variables
[[variable, weight],...]

Specifies the variables that will be used in the balance process.

  • variable—The defined input.
  • weight—The amount of influence a given variable has in the analysis.

Value Table

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

SetBalanceVariables example (Python window)

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

import arcpy
arcpy.td.SetBalanceVariables("TerritorySolution", "Territories[1]", "HouseHold 50;TotalPop 50")

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