Add Territory Level (Territory Design)

Available with Business Analyst license.

Summary

Creates a new empty feature class to represent a level.

Usage

  • Specify an existing territory solution.

  • A new level is created above the base level. Base features are aggregated to the new level.

  • The %Number% variable determines where the integer number is placed, either after or before the territory name—for example, Territory %Number% produces Territory 1, Territory 2, and so forth, whereas %Number% Territory produces 1 Territory, 2 Territory, and so forth.

  • The default primary feature class for a base level with polygon features is Base Boundaries.

  • The default primary feature class for a base level with point features is Base Centers.

Parameters

LabelExplanationData Type
Input Territory Solution

The input territory solution.

Group Layer; Feature Dataset; String
Level Name

The name of the new territory level.

String
Default Territory Name
(Optional)

The name to be used as a prefix for new territories that will be created.

String
Primary Feature Class
(Optional)

Specifies the class level that will be used for storing level attributes.

  • Territory Boundaries —Polygon features that represent the territory boundaries.
  • Territory Centers — Point features that represent the territory centers.
  • Base Boundaries —Polygon features that represent the base-level feature boundaries.
  • Base Centers —Point features that represent the base-level feature centers.
String

Derived Output

LabelExplanationData Type
Updated Territory Solution

The updated territory solution.

Group Layer

arcpy.td.AddTerritoryLevel(in_territory_solution, level_name, {default_territory_name}, {primary_feature_class})
NameExplanationData Type
in_territory_solution

The input territory solution.

Group Layer; Feature Dataset; String
level_name

The name of the new territory level.

String
default_territory_name
(Optional)

The name to be used as a prefix for new territories that will be created.

String
primary_feature_class
(Optional)

Specifies the class level that will be used for storing level attributes.

  • TERRITORY_BOUNDARIESPolygon features that represent the territory boundaries.
  • TERRITORY_CENTERS Point features that represent the territory centers.
  • BASE_BOUNDARIESPolygon features that represent the base-level feature boundaries.
  • BASE_CENTERSPoint features that represent the base-level feature centers.
String

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

AddTerritoryLevel example (Python window)

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

import arcpy
arcpy.td.AddTerritoryLevel("Territory Solution", "Level1", "Territory", "BASE_BOUNDARIES")

Environments

Licensing information

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

Related topics