Import Territory Solution (Territory Design)

Available with Business Analyst license.

Summary

Creates a new territory solution and imports the territories hierarchy from a table or a layer.

Usage

  • The input data should have a hierarchical structure.

  • Specifying more than a single level will create a hierarchy.

Parameters

LabelExplanationData Type
Input Data

The layer or records to be imported.

Table View
Territory Solution Name

The name of the territory solution to be created.

String
Level Settings

The level settings for importing the territories hierarchy.

Level Name—The name of the level (required).

Default Territory Name—The prefix for the new territory that will, subsequently, be created at the level (optional).

ID Field—The field that contains IDs (unique IDs) for territories (required).

Name Field—The field that contains names for territories (optional).

Parent ID Field—The field that contains IDs of parent territories (optional).

Primary Feature Class—Specifies the class level that will be used for storing level attributes (optional).

  • Territory Boundaries—Level attributes will be stored using the boundaries of the territory solution.
  • Territory Centers—Level attributes will be stored using the boundary centers of the territory solution.
  • Base Boundaries—Level attributes will be stored using the boundaries of the base layer.
  • Base Centers—Level attributes will be stored using the boundary centers of the base layer.

Value Table

Derived Output

LabelExplanationData Type
Output Territory Solution

The updated territory solution.

Group Layer

arcpy.td.ImportTerritorySolution(in_data, solution_name, level_settings)
NameExplanationData Type
in_data

The layer or records to be imported.

Table View
solution_name

The name of the territory solution to be created.

String
level_settings
[[level_name, territory_name_template, id_field, name_field, parent_id_field, primary_feature_class],...]

The level settings for importing the territories hierarchy.

  • level_name—The name of the level (required).
  • default_territory_name—The prefix for the new territories that will, subsequently, be created at the level (optional).
  • id_field—The field that contains IDs (unique IDs) for territories (required).
  • name_field—The field that contains names for territories (optional).
  • parent_id_field—The field that contains IDs of parent territories (optional).
  • primary_feature_class—Specifies the class level that will be used for storing level attributes (optional).
    • TERRITORY_BOUNDARIES—Level attributes will be stored using the boundaries of the territory solution.
    • TERRITORY_CENTERS—Level attributes will be stored using the boundary centers of the territory solution.
    • BASE_BOUNDARIES—Level attributes will be stored using the boundaries of the base layer.
    • BASE_CENTERS—Level attributes will be stored using the boundary centers of the base layer.
Value Table

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

ImportTerritorySolution example (Python window)

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

import arcpy
arcpy.td.ImportTerritorySolution("zips", "Territory Solution", "Base BaseName ID NAME TerritoryID BASE_BOUNDARIES;Territories Territory TerritoryID # # TERRITORY_BOUNDARIES")

Environments

Licensing information

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

Related topics