ArcMap

Create Detailed Territory Report

Available with Business Analyst license.

Summary

Creates a detailed summary report.

A detailed report can show a whole level or individual territories within a territory level. This is essential to show a quick snapshot of selected territories and their levels.

Usage

  • The Territory must be in the following format: Territory_Name[Territory_OID]

  • The Territory Level must be in the following format: Level_Name[Level_Index]

  • Each statistics field variable must be in the following format: ‘Variable' Calc, where Calc is one of the Territory Design calculators specified from the ATDConfig.xml file.

  • Each data field variable must be in the following format: ‘Variable'

  • By default, the Report Folder Location is under the "Reports" folder in the current BA project.

Syntax

arcpy.td.CreateDetailedTerritoryReport_td(in_territory_solution_layer, in_level, in_territories, {in_stat_fields}, {in_data_fields}, {in_report_location}, {in_report_name}, {in_report_title})
ParameterExplanationData Type
in_territory_solution_layer

The Territory Solution layer to be used in the Report.

GP TD Layer
in_level

The Input Territory level.

String
in_territories
[in_territories,...]

The list of territory names that will be included to the report.

String
in_stat_fields
[in_stat_fields,...]
(Optional)

The variables to be included inside the Statistics section of the report.

GP Value Table
in_data_fields
[in_data_fields,...]
(Optional)

The variables to be included inside the Data section of the report.

GP Value Table
in_report_location
(Optional)

The location of the Report Folder.

Folder
in_report_name
(Optional)

The name of the Report file.

String
in_report_title
(Optional)

The title of the Report.

String

Code sample

The following Python window script demonstrates how to use Business Analyst geoprocessing tool in immediate mode.

import arcgisscripting
gp = arcgisscripting.create()
gp.CreateDetailedTerritoryReport_TD("new layer", "Territories[1]", "Territory 1[1];Territory 2[2]", "'Count';'AREA_SUM' SUM;'AREA_SUM' MIN;'TOTPOP_CY_SUM' MAX", "'Count';'AREA_SUM';'TOTPOP_CY_SUM'", "C:/BA Output/Project/Default Project/Reports/", "New Report" , "The Detailed Territory Report of New Territory Solution")

The following stand-alone script demonstrates how to use the tool.

# Import system modules
import arcgisscripting
gp = arcgisscripting.create()

# Set local variables
solution = "new layer"
level = "Territories[1]"
territories = "Territory 1[1];Territory 2[2]"
statistics = "'Count';'AREA_SUM' SUM;'AREA_SUM' MIN;'TOTPOP_CY_SUM' MAX"
data = "'Count';'AREA_SUM';'TOTPOP_CY_SUM'"
folder = "C:/BA Output/Project/Default Project/Reports/"
name = "New Report"
title = "The Detailed Territory Report of New Territory Solution"

# Execute tool
gp.CreateDetailedTerritoryReport_TD(solution, level, territories, statistics, data, folder, name, title)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics