Load Territory Records (Territory Design)

Available with Business Analyst license.

Summary

Adds records (features) or updates existing records for the specified level.

Usage

  • Specifies an existing territory solution.

  • Specifies the level where records are to be added.

  • A point layer will add records to the Territories Centers layer.

  • A polygon layer will add records to the Territories Boundary layer.

  • The tool requires a feature layer or table for input.

Syntax

arcpy.td.LoadTerritoryRecords(in_territory_solution, level, in_data, {id_field}, {name_field}, {field_map}, {append_data})
ParameterExplanationData Type
in_territory_solution

The input territory solution.

Group Layer; Feature Dataset; String
level

The level where the data will be loaded.

String
in_data

The layer or records to be loaded.

Table View
id_field
(Optional)

The field containing ID values to be loaded into the level.

Field
name_field
(Optional)

The field containing name values to be loaded into the level.

Field
field_map
[[attribute, field],...]
(Optional)

Sets the values for the territory properties.

  • PARENT_TERRITORY_ID—The ID of the parent territory.
  • LOCKED_STATE—Territory can't be modified.
  • CENTER_LOCKED—Center points can't be modified and will remain in their fixed locations.

Value Table
append_data
(Optional)

Specifies where to append or replace the records being loaded.

  • APPENDAppends records to the specified level.
  • REPLACEReplaces records to the specified level. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_territory_solution

The updated territory solution.

Group Layer

Code sample

LoadTerritoryRecords example (Python window)

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

import arcpy
arcpy.td.LoadTerritoryRecords("Territory Solution", "Level[1]", r"C:\Temp \sampledata.gdb\StoreLocations", "ID", "Name", None, "REPLACE")

Environments

Licensing information

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

Related topics