| 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 value 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.
| Boolean |
Match Business or Facility Name Only
(Optional) | Specifies whether the search will be limited to the business name only.
| Boolean |
Filters
(Optional) | The filters that will be applied to the Search Terms parameter.
| Value Table |
Maximum Number of Points to Return
(Optional) | The limit for the number of returned features. The default value is 1,000,000 for local data and 5,000 for online data hosted by ArcGIS Online. The record limit when using on-premises hosted data is set by your administrator. | Long |
Business Dataset
(Optional) | The dataset that will be used in the business search. | String |
Find related POI
| Specifies whether semantic search will be used to find related items to the search terms.
| Boolean |
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 hosted by ArcGIS Online. For data that is hosted on-premises, the limit is set by the host's administrator.
To enable the Business Dataset parameter options, set the Data Source environment to ONLINE.
Use a wildcard (*) with a search term or filter value to refine or increase search results. The following are examples:
- Search Terms parameter—Auto* or *Pizza
- Filters parameter
- FilterName—NAICS
- FilterValue—*71119
- Filters parameter
- FilterName—SIC
- FilterValue—5411*
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 column 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
arcpy.ba.GeneratePointsFromBusinessListings(out_feature_class, {in_search_features}, {search_terms}, {exact_match}, {match_name_only}, {filters}, {max_count}, {business_dataset}, find_related_poi)| 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 value will be returned. | String |
exact_match (Optional) | Specifies whether only the text provided for the search_terms parameter will be returned from the search.
| Boolean |
match_name_only (Optional) | Specifies whether the search will be limited to the business name only.
| Boolean |
filters [[filter_name, filter_value, include],...] (Optional) | The filters that will be applied to the search_terms parameter.
| Value Table |
max_count (Optional) | The limit for the number of returned features. The default value is 1,000,000 for local data and 5,000 for online data hosted by ArcGIS Online. The record limit when using on-premises hosted data is set by your administrator. | Long |
business_dataset (Optional) | The dataset that will be used in the business search. | String |
find_related_poi | Specifies whether semantic search will be used to find related items to the search terms.
| Boolean |
Code sample
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", False)Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst