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 must total 100 percent.

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

  • Set the Balance Variables parameter weight value to zero if you want to disable the variable when balancing.

Parameters

LabelExplanationData Type
Input 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
Balance Variables

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

LabelExplanationData Type
Updated Territory Solution

The updated territory solution.

Group Layer

arcpy.td.SetBalanceVariables(in_territory_solution, level, variables)
NameExplanationData 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],...]

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 function.

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