Add Level Variables (Territory Design Tools)
Summary
Adds a new field at the specified level.
Usage
Added fields will be based on a numeric field from the level below the territory level and will be calculated based on the type of statistic specified.
The variable is added to any level above the base or alignment level (0).
All numeric fields are supported.
Parameters
Label
Explanation
Data type
Input Territory Solution
The input territory solution.
Group Layer; Feature Dataset; String
Level
The level to which the calculated field will be added.
String
Base Level
The level below the territory level to which the attribute value will be added.
String
Variables
The variables that will be added to the level.
Value table columns:
Statistic Field —The field that will be used for the statistical calculation.
Statistic —Type of statistical calculation.
Count —The number of values included in the calculation will be identified.
Sum —The values for the specified field will be added together.
Maximum —The largest value for the specified field will be identified.
Minimum —The smallest value for the specified field will be identified.
Average —The average of the values for the specified field will be calculated.
Median —The median of the values for the specified field will be calculated.
Standard Deviation —The standard deviation of values for the specified field will be calculated.
Percent of Total —The percentage of each value for the specified field will be calculated from the total sum of the values for the field.
Field Name —Valid name of the field on the level where the calculated data will be stored.
Field Alias Name —Readable and understandable name of the calculated field.
Value Table
Derived output
Label
Explanation
Data type
Updated Territory Solution
The updated territory solution.
Group Layer
arcpy.td.AddLevelVariables(in_territory_solution, level, base_level, variables)
Name
Explanation
Data type
in_territory_solution
The input territory solution.
Group Layer; Feature Dataset; String
level
The level to which the calculated field will be added.
String
base_level
The level below the territory level to which the attribute value will be added.
String
variables
[[statistic, statistic_field, field_name, field_alias_name],...]
The variables that will be added to the level.
Value table columns:
Statistic Field —The field that will be used for the statistical calculation.
Statistic —Type of statistical calculation.
COUNT —The number of values included in the calculation will be identified.
SUM —The values for the specified field will be added together.
MAXIMUM —The largest value for the specified field will be identified.
MINIMUM —The smallest value for the specified field will be identified.
AVERAGE —The average of the values for the specified field will be calculated.
MEDIAN —The median of the values for the specified field will be calculated.
STANDARD_DEVIATION —The standard deviation of values for the specified field will be calculated.
PERCENT_OF_TOTAL —The percentage of each value for the specified field will be calculated from the total sum of the values for the field.
Field Name —Valid name of the field on the level where the calculated data will be stored.
Field Alias Name —Readable and understandable name of the calculated field.
Value Table
Derived output
Name
Explanation
Data type
out_territory_solution
The updated territory solution.
Group Layer
Code sample
AddLevelVariables example (Python window)
The following Python window script demonstrates how to use the AddLevelVariables function.
import arcpy
arcpy.td.AddLevelVariables("TD", "Territory[1]", "BaseLevel[0]", "populationtotals_totpop_cy SUM TotalPopulation 'Total Pop'")
Environments
Current Workspace
Licensing information
Basic: Requires Business Analyst
Standard: Requires Business Analyst
Advanced: Requires Business Analyst