Available with Business Analyst license.
Summary
Creates a comparison report.
Comparison reports are used to show the key differences or similarities between two Territory Solutions.
Usage
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 and chart 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.CompareTerritorySolutions(in_territory_solution_layer1, in_territory_solution_layer2, {in_stat_fields}, {in_data_fields}, {in_chart_fields}, {in_report_location}, {in_report_name}, {in_report_title})| Parameter | Explanation | Data Type |
in_territory_solution_layer1 | The first Territory Solution layer to be used in the Report. | GP TD Layer |
in_territory_solution_layer2 | The second Territory Solution layer to be used in the Report. | GP TD Layer |
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_chart_fields [in_chart_fields,...] (Optional) | The variables to be included inside the Chart 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.CompareTerritorySolutions_TD("new layer1", "new layer2", "'Count';'AREA_SUM' SUM;'AREA_SUM' MIN;'TOTPOP_CY_SUM' MAX", "'Count';'AREA_SUM';'TOTPOP_CY_SUM'", "'Count';'AREA_SUM';'TOTPOP_CY_SUM'", "C:/BA Output/Project/Default Project/Reports/", "New Report" , "The Comparison of New Territory Solution1 and New Territory Solution2")
The following stand-alone script demonstrates how to use the tool.
# Import system modules
import arcgisscripting
gp = arcgisscripting.create()
# Set local variables
Solution1 = "new layer1"
Solution2 = "new layer2"
statistics = "'Count';'AREA_SUM' SUM;'AREA_SUM' MIN;'TOTPOP_CY_SUM' MAX"
data = "'Count';'AREA_SUM';'TOTPOP_CY_SUM'"
chart = "'Count';'AREA_SUM';'TOTPOP_CY_SUM'"
folder = "C:/BA Output/Project/Default Project/Reports/"
name = "New Report"
title = "The Comparison of New Territory Solution1 and New Territory Solution2 Brought to you by Territory Design"
# Execute tool
gp.CompareTerritorySolutions_TD(solution1, solution2, statistics, data, chart, 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