Add Territory Seed Points (Territory Design)

Available with Business Analyst license.

Summary

Creates a point feature that is used to determine the starting point for creating territories.

Usage

  • Seed points can be point locations from franchise addresses, sales offices, or distribution centers and are a common method for creating territories.

  • Seed points are used as the starting point for creating territories but do not necessarily represent the center of the territories.

    Seed points and territory centers
    Pins represents seed points. Squares represents territory centers.

Parameters

LabelExplanationData Type
Input Territory Solution

The Territory Design solution dataset.

Group Layer; Feature Dataset; String
Level

The target territory level for which the seed points feature will be created.

String
Input Seed Point Features

The points feature layer that represents seed points for territories.

Feature Layer
Field Map
(Optional)

Specifies the attributes and fields that will be used for the seed point properties.

  • Name—The name for a seed point feature
  • ID—The ID for a seed point feature
  • Type—The seed point type

The field value associated with the Type attribute can only be Required or Candidate.

Value Table
Append to Existing Seed Points
(Optional)

Specifies whether the data will be appended or replaced.

  • Checked—The data will be appended.
  • Unchecked—The data will be replaced. This is the default.
Boolean

Derived Output

LabelExplanationData Type
Updated Territory Solution

The updated territory solution.

Group Layer

arcpy.td.AddTerritorySeedPoints(in_territory_solution, level, in_seed_points, {field_map}, {append_data})
NameExplanationData Type
in_territory_solution

The Territory Design solution dataset.

Group Layer; Feature Dataset; String
level

The target territory level for which the seed points feature will be created.

String
in_seed_points

The points feature layer that represents seed points for territories.

Feature Layer
field_map
[[name, id, type],...]
(Optional)

Specifies the attributes and fields that will be used for the seed point properties.

  • Name—The name for a seed point feature
  • ID—The ID for a seed point feature
  • Type—The seed point type

The field value associated with the Type attribute can only be Required or Candidate.

Value Table
append_data
(Optional)

Specifies whether the data will be appended or replaced.

  • APPENDThe data will be appended.
  • REPLACEThe data will be replaced. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

AddTerritorySeedPoints example (Python window)

The following Python window script demonstrates how to use the AddTerritorySeedPoints function.

import arcpy
arcpy.td.AddTerritorySeedPoints("TerritorySolution", "Territories[1]", r"atl_centers\shoppingctrs", None, "REPLACE")

Environments

Licensing information

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

Related topics