Set Target Site (Business Analyst)

Available with Business Analyst license.

Summary

Adds a target site to a Suitability Analysis group layer.

A target site is typically a trade area around a high-performing location, such as a store or clinic. Criteria values in the target site are used to score candidate sites that are closest in value to the target site.

Usage

  • The suitability analysis scoring influence defaults to target when a target site is set.

  • The target influence sets the target site's value as the highest score for each criterion.

  • The candidate site with criteria values closest to the target site will receive the highest score.

  • When a target site is set, a candidate site's value for each criterion is compared to the corresponding Target Site Layer parameter value.

  • You can replace the target site by rerunning this tool with a different Target Site Feature ID parameter value.

  • The target influence can only be enabled by setting a target site.

  • Selected records in the Target Site layer define the Target Site Feature ID parameter options.

  • Selecting a record in the Target Site Layer parameter value will set it as the Target Site Feature ID parameter value by default.

Parameters

LabelExplanationData Type
Input Suitability Analysis Layer

The Suitability Analysis layer that will be used in the analysis.

Group Layer; Feature Dataset
Target Site Layer
(Optional)

The layer that contains the target site.

Feature Layer
Target Site Feature ID
(Optional)

The feature from the target site layer that will be added to the group layer as the target site.

String

Derived Output

LabelExplanationData Type
Output Suitability Analysis Layer

The name of the Suitability Analysis layer that will be added to the analysis.

Group Layer

arcpy.ba.SetTargetSite(in_analysis_layer, {target_site_layer}, {target_site_feature_id})
NameExplanationData Type
in_analysis_layer

The Suitability Analysis layer that will be used in the analysis.

Group Layer; Feature Dataset
target_site_layer
(Optional)

The layer that contains the target site.

Feature Layer
target_site_feature_id
(Optional)

The feature from the target site layer that will be added to the group layer as the target site.

String

Derived Output

NameExplanationData Type
out_analysis_layer

The name of the Suitability Analysis layer that will be added to the analysis.

Group Layer

Code sample

SetTargetSite example (Python window)

The following Python window script demonstrates how to use the SetTargetSite function:

import arcpy
arcpy.ba.SetTargetSite("Suitability Analysis", r"Existing_Sites", "4")

Environments

Licensing information

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

Related topics