FRAMES | NO FRAMES
CustomerProspectingParameters Type

Parameters of CustomerProspecting task.

Availability: Business Analyst Server.

class CustomerProspectingParameters : AnalysisParameters

Property Description
AnalysisExtent Data extent for analysis. Type ExtentData.
CustomerProfileDescription Customer profile string returned by CustomerProfiling method. Type String.
DataLayerID ID of a geography layer to get demography for analysis. Type String.
PCAEigenValue (optional) Eigenvalue boundary for Principal Component Analysis. Type Double.
PCARankSites (optional) Maximum number of sites to rank with Principal Component Analysis. Type Int32.
ProspectingQuery Prospecting query for manual analysis. Type String.
ProspectingType (optional) Customer prospecting type. Type esriCustomerProspectingAnalysisType.
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 AnalysisExtent property specifies the market area to prospect. The DataLayerID property specifies the geography layer for analysis.

Two types of prospecting analysis are supported—Conventional Analysis (default) and Principal Component Analysis.

For Conventional Analysis, either the ProspectingQuery property or the CustomerProfileDescription property should be specified. In the first case, the WHERE-clause SQL statement is manually specified. It queries for sites of the geography layer having given values of attributes. In the last case, the floor and ceiling values for variables of the customer profile are used for generation the SQL query for the WHERE clause. Conditions for every variable of the profile are joined using the logical AND operation.

For Principal Component Analysis, the CustomerProfileDescription property should be specified. It defines the customer profile whose average values for profiled variables are used as a benchmark. The geography sites are ranked by similarity with this benchmark. The PCARankSites property can specify the maximum number of sites to be ranked. If its value is -1 or null, all sites are ranked. The PCAEigenValue property specifies the eigenvalue boundary for Kaiser Criterion used in Principal Component Analysis. The default value is 1 as recommended.

See Also