ArcMap

Create Profile by Table Geocoding

Available with Business Analyst license.

Summary

Creates a profile from a table of address records.

Learn more about how Create Profile By Table Geocoding (Business Analyst) works

Usage

  • Input tables must be in a format that can be opened in ArcGIS.

  • Only matched address records will be included in the output segmentation profile.

Syntax

arcpy.ba.CreateSegProfileByTableGeocoding(Dataset, MatchFields, SegmentationBase, ProfileFolder, {InputVolumeInfoFieldName}, {InputProfileComments}, {CreateCustomerLayerForSegmentationProfile}, {GeocodedCustomerFeatureClass}, {UseZip4Locator})
ParameterExplanationData Type
Dataset

Table containing the address records.

Table
MatchFields

Input address fields for appending segmentation codes.

Field Info
SegmentationBase

Population or household base for the profile being created.

String
ProfileFolder

The output profile is created in this folder. The folder name corresponds to the name of the profile used in Business Analyst. For example, a profile created in the folder C:\My Output Data\Projects\Default Project\Segmentation\Profiles\NewProfile would be referred to as NewProfile in Business Analyst.

Folder
InputVolumeInfoFieldName
(Optional)

Field containing volume information with which the profile can optionally be created. For example, you can create a profile using sales for each customer.

Field
InputProfileComments
(Optional)

Optional comments for profile. These comments can include information such as author, source, date, and vintage.

String
CreateCustomerLayerForSegmentationProfile
(Optional)

Creates a profile for each separate polygon in your shapefile.

  • CREATE_WITH_ID —Will create a customer layer.
  • CREATE_NO_ID —Will only create a customer profile.
Boolean
GeocodedCustomerFeatureClass
(Optional)

Feature class containing geocoded customers.

Feature Class
UseZip4Locator
(Optional)

Use the ZIP+4 database to geocode.

  • Checked—Will use the ZIP+4 Locator.
  • Unchecked—Will not use the ZIP+4 Locator.
Boolean

Code sample

CreateProfileByTableGeocoding example (stand-alone script)

# Name: CreateProfileByTableGeocoding.py
# Description: Creates a segmentation profile by geocoding address fields from a table in the San Francisco area.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.8\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
try:
# Acquire extension license 
  arcpy.CheckOutExtension("Business") 
 
# Define input and output parameters for the Create Profile by Table Geocoding tool
  Dataset = "C:/ArcGIS/Business Analyst/US_2022/Datasets/Tutorial/sf_custs.dbf"
  MatchFields = "Addr ADDRESS VISIBLE;Addr2 <none> VISIBLE;City <none> VISIBLE;State <none> VISIBLE;ZIP ZIP VISIBLE;ZIPExt <none> VISIBLE;Firm NAME VISIBLE"
  SegmentationBase = "Total Adult Population"
  ProfileFolder = "C:/temp/NewProfile.xml"
 
# Create Profile by Table Geocoding
  arcpy.CreateProfileByTableGeocoding_ba(Dataset, MatchFields, SegmentationBase, ProfileFolder)
 
# Release extension license 
arcpy.CheckInExtension("Business")

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