| Package | com.esri.baserver.tasks.analyses |
| Class | public class CustomerProfilingParameters |
| Inheritance | CustomerProfilingParameters  BAUtilityParameters BABaseParameters Object |
The dataLayerID parameter specifies the ID of a standard layer used for
profiling customers. The summarizations parameter specifies demographic variables
to be profiled.
The analysis can be restricted to an analysis extent if the analysisExtent
parameter is specified.
The profileType parameter specifies what bounds of ranges of demography
variables will be profiled for your customers: floor bounds, ceiling bounds, or both bounds.
The variance specifies how wide the range will be. The floor and ceiling values
for a demographic variable are calculated as follows:
floor = average*(1–variance/100), ceiling = average*(1+variance/100).
Here average is an average value of a demographic variable calculated.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | CustomerProfilingParameters | ||
| customers : PointLayer
The customer layer used to get Customer Profile for. | CustomerProfilingParameters | ||
| dataLayerID : String
ID of a standard data layer to profile customers by. | CustomerProfilingParameters | ||
| profileType : CustomerProfilingFillingType
Type of profiling the bounds of demography variables. | CustomerProfilingParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| summarizations : Array
Array of demography variables to profile customers by. | CustomerProfilingParameters | ||
| taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| variance : Number
A variance value in percent. | CustomerProfilingParameters | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the CustomerProfilingParameters class. | CustomerProfilingParameters | ||
| analysisExtent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesanalysisExtent:GeometrySpatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| customers | property |
customers:PointLayerThe customer layer used to get Customer Profile for.
public function get customers():PointLayer public function set customers(value:PointLayer):void| dataLayerID | property |
dataLayerID:StringID of a standard data layer to profile customers by.
public function get dataLayerID():String public function set dataLayerID(value:String):void| profileType | property |
profileType:CustomerProfilingFillingTypeType of profiling the bounds of demography variables.
The default value is CustomerProfilingFillingType.FLOOR_AND_CEILING_VALUES.
public function get profileType():CustomerProfilingFillingType public function set profileType(value:CustomerProfilingFillingType):void| summarizations | property |
summarizations:ArrayArray of demography variables to profile customers by. This array should contain items of the String type. Available summarization fields can be retrieved with the Get Summarizations task.
public function get summarizations():Array public function set summarizations(value:Array):voidSee also
| variance | property |
variance:NumberA variance value in percent.
The default value is 0.
public function get variance():Number public function set variance(value:Number):void| CustomerProfilingParameters | () | Constructor |
public function CustomerProfilingParameters()Creates a new instance of the CustomerProfilingParameters class.
var parameters : CustomerProfilingParameters = new CustomerProfilingParameters();
// The PointLayer type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
// or an array of com.esri.bacore.PointRecord items, e.g.
//var points:Array = [new PointRecord("Customer 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)];
// Set customers as an array of PointRecord items.
parameters.customers = new PointLayer(points);
// Set demographic variables to profile customers for.
parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
// Set ID of a geography layer to get demography from.
parameters.dataLayerID = "US.BlockGroups";
// Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
//parameters.analysisExtent = myExtent;
customerProfilingTask.execute(parameters, new Responder(resultHandler, faultHandler));