Skip to main content

Find Nearby Locations (Business Analyst Tools)

Summary

Identifies locations closest to the input features based on a selected distance type. The number of points in the output is defined by limiting the count or percentage of location points to return or by limiting the distance from the input points.

Usage

  • The Input Features parameter value must be a point feature class. The input features are the sites you are analyzing, such as stores or facilities.

  • The Location Points parameter value contains the origin points, such as store locations.

  • The Location Points parameter value must be a point feature class. The location points are all nearby locations that will be used in the tool calculations.

  • The Output Feature Class parameter will contain all attributes from the Input Features and Location Points parameters, as well as calculated fields containing distance and direction values.

  • The Interpret a Find Nearby Locations report is a PDF document you can use to understand the various sections and elements of the Find Nearby Locations report.

Parameters

Label Explanation Data type

Input Features

The layer containing points to be measured in relation to the Location Points layer. This layer contains the origin points, such as store locations.

Feature Layer

ID Field

A field containing unique identifiers for each input feature.

Field

Location Points

The layer containing points to be measured for distance and direction in relation to the Input Features parameter value. This layer contains the nearby points, such as customer locations.

Feature Layer

Output Feature Class

The output location point features.

Feature Class

Distance Type

(Optional)

The calculated distance based on the method of travel. Straight Line is the default value.

String

Distance Units

(Optional)

The measurement units, in distance or time, that will be used when calculating nearby locations.

String

Distance Limit

(Optional)

The analysis extent measured in distance or time.

Double

Number of Locations Limit

The numeric limit of the Location Points value.

Long

Percentage of Locations Limit

The closest points, as a percentage of the points of the Location Points value.

Double

Create Report

(Optional)

Specifies whether an output report will be created.

  • Checked—A report will be created.

  • Unchecked—A report will not be created. This is the default.

Boolean

Report Title

(Optional)

The title of the output report.

String

Output Report Folder

(Optional)

The directory that will contain the output report.

Folder

Report Output Formats

(Optional)

The output report formats. The default value is PDF. Additional available formats are XLSX, S.XLSX, HTML, S.XML, ZIP, CVS, and PAGX.

String

Report Fields

(Optional)

The additional fields that will be added to the report.

Field

Travel Direction

(Optional)

Specifies whether travel times or distances will be measured from location points to input features or from input features to location points.

  • Toward Input Features—The direction of travel will be from location points to input features. This is the default.

  • Away from Input Features—The direction of travel will be from input features to location points.

String

Time of Day

(Optional)

The time at which travel will begin.

Date

Time Zone

(Optional)

Specifies the time zone that will be used for the Time of Day parameter.

  • UTC—Coordinated universal time (UTC) will be used. Choose this option if you want the best location for a specific time, such as now, but aren't certain of the time zone in which the Location Points value will be located.

  • Local time at locations—The time zone in which the Location Points value is located will be used. This is the default.

String

Search Tolerance

(Optional)

The maximum distance that input points can be from the network. Points located beyond the search tolerance will be excluded from processing.

Linear Unit

Location Name

(Optional)

A field from the input Location Points parameter. This field contains the name or ID for each input point used in the Find Nearby Locations report.

Field

Derived output

Label Explanation Data type

Output Report

The output report file.

File

Environments

Current Workspace, Data Source, Network Source

Licensing information

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