CustomerDerivedAreasParameters Type

Parameters of CustomerDerivedAreas task.

Availability: Business Analyst Server.

class CustomerDerivedAreasParameters : SummaryReportParameters

Property Description

AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.

CustomerLinkField The attribute field in the input Customers layer which links every customer with associated store/business ID. Type String.

Customers A point layer containing point features which represent the locations of customers. Type PointLayer.

CustomerWeightField (optional) The Customers layer field to calculate weighted percentage. Type String.

CutOffDistance (optional) Cut off threshold distance in the units specified in the CutOffDistance property. Type Double.

CutOffUnits (optional) The distance units of the CutOffDistance property which is used to calculate the cut off distance. Type esriUnits.

Donut (optional) An option specifying creation of donut-style trade/service areas instead of areas that all originate from the store/business point origins. Type Boolean.

HullType (optional) An option specifying the type of hull to be created around store points. Type esriHullType.

Percentages Array of percentages of customers in ascending size. Type Double[].

SingleStoreID (optional) ID of a single store to generate trade area. Type String.

StoreIDField The attribute field name in the input Stores layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type String.

Stores A point layer containing point features such as businesses, hospitals, schools, etc. Type PointLayer.

UseCustomersCentroid (optional) An option specifying the use of the centroid of customers associated with a store instead of the store location point. Type Boolean.

DataHierarchy (optional) Name of a hierarchy of data layers used for generating summary reports. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.

ReportOptions Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Inherited from SummaryReportParameters.

ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.

IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.

OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.

ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Property	Description
AnalysisExtent (optional)	Data extent to restrict the analysis. Type ExtentData.
CustomerLinkField	The attribute field in the input Customers layer which links every customer with associated store/business ID. Type String.
Customers	A point layer containing point features which represent the locations of customers. Type PointLayer.
CustomerWeightField (optional)	The Customers layer field to calculate weighted percentage. Type String.
CutOffDistance (optional)	Cut off threshold distance in the units specified in the CutOffDistance property. Type Double.
CutOffUnits (optional)	The distance units of the CutOffDistance property which is used to calculate the cut off distance. Type esriUnits.
Donut (optional)	An option specifying creation of donut-style trade/service areas instead of areas that all originate from the store/business point origins. Type Boolean.
HullType (optional)	An option specifying the type of hull to be created around store points. Type esriHullType.
Percentages	Array of percentages of customers in ascending size. Type Double[].
SingleStoreID (optional)	ID of a single store to generate trade area. Type String.
StoreIDField	The attribute field name in the input Stores layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type String.
Stores	A point layer containing point features such as businesses, hospitals, schools, etc. Type PointLayer.
UseCustomersCentroid (optional)	An option specifying the use of the centroid of customers associated with a store instead of the store location point. Type Boolean.
DataHierarchy (optional)	Name of a hierarchy of data layers used for generating summary reports. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
ReportOptions	Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Inherited from SummaryReportParameters.
ActiveDatasetID	ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage	Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference	An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry	An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters. Default: true.

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. Optional SingleStoreID property restricts the analysis to a single store of the store layer.

Tuning parameters

The HullType property specifies a type of hull to be created around every store location. The simple hull is created by default.
If the CustomerWeightField property is specified, the percentages of customers are calculated using values of this field as the weight.
If the CutOffDistance property is specified, the customers outside of this distance from associated stores are excluded from the analysis. The CutOffUnits property should be specified in this case.
If the UseCustomersCentroid property is true, the customers’ centroids are used instead of stores as centers of trade areas.
If the Donut property is true, the donut trade areas created.

NOTE: Since Business Analyst Server 10.0, the SummaryDataLayerID property is replaced with an optional DataHierarchy property.

Remarks

See Also