Available with Business Analyst license.
Summary
Creates a summary report of a territory solution or a comparison report of two solutions.
Usage
The Territory Solution should contain at least one level variable.
A report can be created for an individual level or all levels.
Syntax
arcpy.td.GenerateTerritoryReport(in_territory_solution, level, {report_type}, {report_folder}, {report_title}, {report_format}, {comparison_territory_solution}, {comparison_level})
Parameter | Explanation | Data Type |
in_territory_solution | The input territory solution for the report. | Group Layer; Feature Dataset; String |
level | The territory level to create the report. | String |
report_type (Optional) | Specifies the type of report that will be generated.
| String |
report_folder (Optional) | The output location where the report will be saved. | Folder |
report_title (Optional) | The title of the report. | String |
report_format [report_format,...] (Optional) | The report output format. The default value is PDF. Additional available formats: XLSX, HTML, CSV, PAGX. | String |
comparison_territory_solution (Optional) | The territory solution for the comparison report. | Group Layer; Feature Dataset; String |
comparison_level (Optional) | The territory level to be used for the comparison or realignment report. | String |
Derived Output
Name | Explanation | Data Type |
output_report | The output report file. | File |
Code sample
The following Python window script demonstrates how to return a summary report when using the GenerateTerritoryReport function.
import arcpy
arcpy.td.GenerateTerritoryReport("TerritorySolution", "Territories[1]", "TERRITORY_SUMMARY", r"C:\MyOutput", "Territory Solution Summary", "PDF", '', '')
The following Python window script demonstrates how to return a comparison report when using the GenerateTerritoryReport function.
import arcpy
arcpy.td.GenerateTerritoryReport("TerritorySolution", "Territories[1]", "COMPARE_TERRITORIES", r"C:\MyOutput", "Compare Territory Solutions", "PDF", "TerritorySolution2", "Territories[1]")
Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst