Generate Points From Business Listings (Business Analyst)

Available with Business Analyst license.

Summary

Generates a point feature layer from a business point location search.

Usage

• The Output Feature Class value will exclude the Address field.

• The following countries contain data required for a Business Listing search: United States and Canada.

• The Maximum Number of Points to Return parameter has a 5,000 record limit when using online data.

• To enable the Business Dataset parameter options, set the Data Source environment to ONLINE.

• Using the Include Only Exact Matches parameter with the Search Terms parameter will return restrictive results. For example, providing Johnson`s Supermarket for the Search Terms parameter with the Include Only Exact Matches parameter checked, the following will not be returned:

  • Johnson`s Market
  • Johnson`s Supermarket & Pharmacy
  • Johnson and Sons Supermarket & Pharmacy

• The FilterValue option of the Filters parameter can be set by applying a minimum or maximum value only or by applying a range between the minimum and maximum values.

  • Min:Number—Filter businesses with variable values less than the number assigned, for example, min:100.
  • Max:Number—Filter businesses with variable values greater than the number assigned, for example, max:500.
  • Min:Number Max:Number—Filter businesses outside of the range of values assigned, for example, min:100 max:500.

Parameters

Dialog

Label	Explanation	Data Type
Output Feature Class	The output feature class that will contain the returned businesses.	Feature Class
Input Search Features (Optional)	The area that will be used to search for businesses. Selected features supersede the feature class and will be used as the search area.	Feature Layer
Search Terms (Optional)	The terms that will be used to search for businesses. You can use terms such as business name or business type keywords. If this parameter is not set, all businesses from the Input Search Features parameter will be returned.	String
Include Only Exact Matches (Optional)	Specifies whether only the text provided for the Search Terms parameter will be returned from the search. Checked—Only exact matches to the text provided for the Search Terms parameter will be returned. Unchecked—Partial matches to the text provided for the Search Terms parameter as well as exact matches will be returned. This is the default.	Boolean
Match Business or Facility Name Only (Optional)	Specifies whether the search will be limited to the business name only. Checked—Only exact matches to the business name provided for the Search Terms parameter will be returned. Unchecked—Partial matches to the business name provided for the Search Terms parameter as well as exact matches will be returned. This is the default.	Boolean
Filters (Optional)	The filters that will be applied to the Search Terms parameter. FilterName—Set filter by dataset field. FilterValue—Set filter by applying a value to the selected field. Include—Set filter by including or excluding field values.	Value Table
Maximum Number of Points to Return (Optional)	The limit for the number of returned features. The default value is 1000000. There is a 5000 record limit when using online data.	Long
Business Dataset (Optional)	The dataset that will be used in the business search.	String

Python

arcpy.ba.GeneratePointsFromBusinessListings(out_feature_class, {in_search_features}, {search_terms}, {exact_match}, {match_name_only}, {filters}, {max_count}, {business_dataset})

Name	Explanation	Data Type
out_feature_class	The output feature class that will contain the returned businesses.	Feature Class
in_search_features (Optional)	The area that will be used to search for businesses. Selected features supersede the feature class and will be used as the search area.	Feature Layer
search_terms (Optional)	The terms that will be used to search for businesses. You can use terms such as business name or business type keywords. If this parameter is not set, all businesses from the in_search_features parameter will be returned.	String
exact_match (Optional)	Specifies whether only the text provided for the search_terms parameter will be returned from the search. EXACT_MATCH—Only exact matches to the text provided for the search_terms parameter will be returned. PARTIAL_MATCH—Partial matches to the text provided for the search_terms parameter as well as exact matches will be returned. This is the default.	Boolean
match_name_only (Optional)	Specifies whether the search will be limited to the business name only. MATCH_NAME_ONLY—Only exact matches to the business name provided for the search_terms parameter will be returned. MATCH_ALL_FIELDS—Partial matches to the business name provided for the search_terms parameter as well as exact matches will be returned. This is the default.	Boolean
filters [[filter_name, filter_value, include],...] (Optional)	The filters that will be applied to the search_terms parameter. filter_name—Set filter by dataset field. filter_value—Set filter by applying a value to the selected field. include—Set filter by including or excluding field values.	Value Table
max_count (Optional)	The limit for the number of returned features. The default value is 1000000. There is a 5000 record limit when using online data.	Long
business_dataset (Optional)	The dataset that will be used in the business search.	String

Code sample

GeneratePointsFromBusinessListings example (Python window)

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

import arcpy
arcpy.ba.GeneratePointsFromBusinessListings("MyProject.gdb\output", "San Francisco Bay Area", "coffee", False, False, 100, "salesvol min:200 INCLUDE;empnum 'min:3 max:10' INCLUDE;city 'Mountain View' EXCLUDE")

Environments

Current Workspace, Data Source, Extent

Licensing information

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