| FRAMES | NO FRAMES |
Parameters of GamePlanMap task.
Availability: Business Analyst Server.
class GamePlanMapParameters : StandardReportParameters
| Property | Description |
|---|---|
| AnalysisExtent | Data extent for analysis. Type ExtentData. |
| BaseProfile | Base segmentation profile. Type ProfileData. |
| CoreSegments | Array of Core segment IDs. Type String[]. |
| DefineSegmentsExplicitly | Define segments. Type Boolean. |
| DevelopmentalSegments | Array of Developmental segment IDs. Type String[]. |
| IndexThreshold (optional) | Index threshold. Type Double. |
| NicheSegments | Array of Niche segment IDs. Type String[]. |
| PercentThreshold (optional) | Percent composition threshold. Type Double. |
| SegmentationBase | Segmentation base. Use the GetSegBases lookup operation to query available segmentation bases. Type String. |
| SegmentationLevel | Segmentation level ID. Use the GetSegmentationLevels lookup operation to query available segmentation level IDs and names. Type String. |
| TargetProfile | Target segmentation profile. Type ProfileData. |
| StandardReportOptions | Report parameters. The TemplateName parameter is ignored. Type ReportOptions. Available with Business Analyst Server 9.3.1. Inherited from StandardReportParameters. |
| 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. |
The AnalysisExtent property specifies the market area to thematically shade locations. The SegmentationBase property specifies the base for assignment segments to geography sites. The SegmentationLevel property specifies the ID of a segmentation level.
There are two ways for division 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 all these categories, it is considered to belong to category of other segments. At least one category should be a nonempty array.
In the case of using the Game Plan Chart, the DefineSegmentsExplicitly property should have the false value and two tapestry segmentation profiles should be specified—the base profile (BaseProfile property) is used for calculation the index and the target profile (TargetProfile property) is used for calculation the percent composition for each Tapestry segment. The optional IndexThreshold and PercentThreshold properties 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 to have at least three segments in the Core category. Often there will be a natural break in the percent composition values. By default, the index of 100 and the natural break in the percent composition values are used.