Add Level Variables (Territory Design)

Available with Business Analyst license.

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

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

Statistic Field—The field that will be used for the statistical calculation.

Statistic—The 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—The valid name of the field on the level where the calculated data will be stored.

Field Alias Name—The readable and understandable name of the calculated field.

Value Table

Derived Output

LabelExplanationData Type
Updated Territory Solution

The updated territory solution.

Group Layer

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

  • statistic_field—The field that will be used for statistical calculation.
  • statistic—The 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—The valid name of the field on the level where the calculated data will be stored.
  • field_alias_name—The readable and understandable name of the calculated field.
Value Table

Derived Output

NameExplanationData 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

Licensing information

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

Related topics