Package | com.esri.baserver.tasks.segmentation |
Class | public class UnderstandingTargetCustomersParameters |
Inheritance | UnderstandingTargetCustomersParameters StandardReportParameters StandardReportParameters BATaskParameters Object |
Two tapestry segmentation profiles should be specified—the base profile
(baseProfile
parameter) is used for calculating the index and the target profile
(targetProfile
parameter) is used for calculating the percent composition for each
Tapestry segment.
The indexThreshold
and percentThreshold
parameters specify the
Index and Percent Composition thresholds used for selecting the Core and Developmental segments.
In most cases, the Index axis should be set to a value of at least 100. The Percent Composition
axis should be set so you have at least three segments in the Core category. Often there will
be a natural break in the percent composition values.
The mriGroups
parameter specifies MRI groups to create the report for.
Output options for this task include creating a report (outputTypes.getReport). You need not specify the output options for this task because the getReport output type is set by default.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
baseProfile : ProfileData
Base segmentation profile (required). | UnderstandingTargetCustomersParameters | ||
customerDescription : String
Description or alias for the term "customers". | UnderstandingTargetCustomersParameters | ||
indexThreshold : Number
Index threshold (required). | UnderstandingTargetCustomersParameters | ||
mriGroups : Array
Array of MRI groups to produce report by (required). | UnderstandingTargetCustomersParameters | ||
outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | StandardReportParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
percentThreshold : Number
Percent composition threshold (required). | UnderstandingTargetCustomersParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | ||
targetProfile : ProfileData
Target segmentation profile (required). | UnderstandingTargetCustomersParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the UnderstandingTargetCustomersParameters class. | UnderstandingTargetCustomersParameters |
baseProfile | property |
baseProfile:ProfileData
Base segmentation profile (required).
public function get baseProfile():ProfileData
public function set baseProfile(value:ProfileData):void
customerDescription | property |
customerDescription:String
Description or alias for the term "customers". For example, this could be "patients", "subscribers", "customers", and so forth.
public function get customerDescription():String
public function set customerDescription(value:String):void
indexThreshold | property |
indexThreshold:Number
Index threshold (required).
public function get indexThreshold():Number
public function set indexThreshold(value:Number):void
mriGroups | property |
mriGroups:Array
Array of MRI groups to produce report by (required). Use the GetMRIGroups lookup operation to query available MRI groups.
public function get mriGroups():Array
public function set mriGroups(value:Array):void
percentThreshold | property |
percentThreshold:Number
Percent composition threshold (required).
public function get percentThreshold():Number
public function set percentThreshold(value:Number):void
targetProfile | property |
targetProfile:ProfileData
Target segmentation profile (required).
public function get targetProfile():ProfileData
public function set targetProfile(value:ProfileData):void
UnderstandingTargetCustomersParameters | () | Constructor |
public function UnderstandingTargetCustomersParameters()
Creates a new instance of the UnderstandingTargetCustomersParameters class.
var parameters : UnderstandingTargetCustomersParameters = new UnderstandingTargetCustomersParameters(); // The ProfileData type could take either data as an XML string // or as com.esri.baserver.FolderItem type, e.g. //var baseProfile:FolderItem = new FolderItem(workspaceName, projectName, FolderType.SEGMENTATION_PROFILES, profileName); // Set a base segmentation profile. parameters.baseProfile = new ProfileData(baseProfile); // Set a target segmentation profile. parameters.targetProfile = new ProfileData(targetProfile); // Set an index threshold. parameters.indexThreshold = 110.0; // Set a percent composition threshold. parameters.percentThreshold = 4.0; // Set MRI groups to produce the report by. parameters.mriGroups = ["Apparel", "Books", "Appliances", "Attitudes"]; // Set report parameters. parameters.standardReportOptions = new ReportOptions("PDF"); understandingTargetCustomersTask.execute(parameters, new Responder(resultHandler, faultHandler));