Package	com.esri.baserver.tasks.segmentation
Class	public class GamePlanMapParameters
Inheritance	GamePlanMapParameters AnalysisAndReportParameters StandardReportParameters BATaskParameters Object

The GamePlanMapParameters class provides input parameters for the Game Plan Map task.

The analysisExtent parameter specifies the market area to thematically shade locations in. The segmentationBase parameter specifies the base for assignment segments to geography sites. The segmentationLevel parameter specifies the ID of a segmentation level.

There are two ways for dividing the Tapestry segments into categories—explicit specification of Core, Developmental, Niche, and Other segments, and categorizing segments on the base of a Game Plan Chart.

In the case of explicit specification, the defineSegmentsExplicitly parameter should have the true value and the optional coreSegments, developmentalSegments, and nicheSegments parameters can specify the categorization of segments by explicit enumerating the IDs of segments belonging to their categories. If a Tapestry segment is missing in all these categories, it is considered to belong to the category of other segments. At least one category should be nonempty. For example, you can specify the core segments only and do not have to specify other categories.

In the case of using the Game Plan Chart, the defineSegmentsExplicitly parameter should have the false value and 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 positions of Index and Percent Composition axes on the Game Plan Chart. 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.

Output options for this task include rendering an output image (outputTypes.getMapImage), creating a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or creating a report (outputTypes.getReport). If no output options are specified, the required output options are specified as follows. If the renderingParameters parameter is specified, the image output is requested. If the standardReportOptions parameter is specified, the report is requested. If the outputAnalysisItem parameter is specified, the output analysis feature class will be stored in the repository. If renderingParameters, standardReportOptions, and outputAnalysisItem parameters are missing, the feature class output is requested.

View the examples

See also

---

                     
     var parameters : GamePlanMapParameters = new GamePlanMapParameters();
     
     // Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type.
     parameters.analysisExtent = myExtent;
     
     // Set a segmentation base.
     parameters.segmentationBase = "Total Households";
     
     // Set a segmentation level ID.
     parameters.segmentationLevel = "US.ZIP5";
     
     // Define segments with the use of Game Plan Chart.
     parameters.defineSegmentsExplicitly = false;
     
     // 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 report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     gamePlanMapTask.execute(parameters, new Responder(resultHandler, faultHandler));