Generate Standard Geography Trade Areas (Business Analyst)

Available with Business Analyst license.

Summary

Creates trade areas based on predefined named statistical areas. This tool does not consume credits.

Illustration

Generate Standard Geography Trade Areas tool illustration

Usage

  • Standard geographies are trade areas based on standardized administrative boundaries. In the United States, this includes layers such as states, counties, ZIP Codes, block groups, census tracts, core-based statistical areas (CBSA), designated market areas (DMA), or places. Each country dataset offers administrative boundaries that can vary. Individual trade areas are created for each unique geography—for example, each state or each ZIP Code that you select.

  • One layer can contain several trade areas—for example, one whole layer containing a collection of counties.

  • The list of IDs must be in a table or list format.

  • The table can be in any format supported by ArcGIS Pro—for example, a comma- or tab-delimited text (.txt) file or Excel file.

  • In the list format, the ID items must be separated by commas.

  • The geography ID for the entire country trade area is 01.

  • When the Input Type parameter is set to Table, the associated Geography Key Field parameter value must be a text field.

Parameters

LabelExplanationData Type
Geography Level

The geography level that will be used to define the trade area.

String
Output Feature Class

The output feature containing the trade area.

Feature Class
Input Type
(Optional)

Specifies whether the geography IDs will be from a table or a list.

  • TableThe input IDs will be from a table.
  • ListThe input IDs will be from a list. This is the default.
String
Geography IDs Table
(Optional)

The input table with IDs that will be used to select geographies that will define the trade area.

Table View
Geography Key Field
(Optional)

A field in Geography IDs Table that identifies the records that will be included in the output.

Field
Geography IDs List
(Optional)

The input list of comma-separated geography IDs.

String
Summarize Duplicate IDs
(Optional)

Specifies whether duplicate fields in the table containing matching geography IDs will be summarized.

  • Checked—The numeric fields for all duplicate records will be summarized.
  • Unchecked—The data of the first record will be appended. Other records will be ignored. This is the default.
Boolean
Group Field
(Optional)

The field that will be used to perform a group by operation.

Field
Dissolve Output Features
(Optional)

Specifies whether the output will be dissolved based on the Group Field parameter value.

  • Checked—The output will be dissolved.
  • Unchecked—The output will not be dissolved. This is the default.
Boolean

arcpy.ba.StandardGeographyTA(geography_level, out_feature_class, {input_type}, {in_ids_table}, {geography_key_field}, {ids_list}, {summarize_duplicates}, {group_field}, {dissolve_output})
NameExplanationData Type
geography_level

The geography level that will be used to define the trade area.

String
out_feature_class

The output feature containing the trade area.

Feature Class
input_type
(Optional)

Specifies whether the geography IDs will be from a table or a list.

  • TABLEThe input IDs will be from a table.
  • LISTThe input IDs will be from a list. This is the default.
String
in_ids_table
(Optional)

The input table with IDs that will be used to select geographies that will define the trade area.

Table View
geography_key_field
(Optional)

A field with in_ids_table that identifies the records that will be included in the output.

Field
ids_list
(Optional)

The input list of comma-separated geography IDs.

String
summarize_duplicates
(Optional)

Specifies whether duplicate fields in the table containing matching geography IDs will be summarized.

  • SUMMARIZE_DUPLICATESThe numeric fields for all duplicate records will be summarized.
  • USE_FIRSTThe data of the first record will be appended. Other records will be ignored. This is the default.
Boolean
group_field
(Optional)

The field that will be used to perform a group by operation.

Field
dissolve_output
(Optional)

Specifies whether the output will be dissolved based on the group_field parameter value.

  • DISSOLVEThe output will be dissolved.
  • DONT_DISSOLVEThe output will not be dissolved. This is the default.
Boolean

Code sample

StandardGeographyTA example (Python window)

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

import arcpy
arcpy.ba.StandardGeographyTA("US.ZIP5", r"C:\Temp\Output.gdb\StdGeogTradeAreas",
                             None, None, "92111,92117,92122", "USE_FIRST", None,
                             "DISSOLVE")

Licensing information

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

Related topics