FRAMES | NO FRAMES
ProfileByAreaSummation Method

Creates a new Tapestry segmentation profile on the given polygon layer.

Availability: Business Analyst Server.

string ProfileByAreaSummation ( 
    ProfileByAreaSummationParameters  Parameters, 
    TaskOutputType[]                  OutputTypes, 
    esriFolderItem                    OutputItem, 
    esriFolderItem                    OutputReportItem 
);

Parameter Description
Parameters Configuration options for analysis. Type ProfileByAreaSummationParameters.
OutputTypes This parameter is ignored. This parameter is deprecated.
OutputItem (Optional parameter — can be null).
Configuration options for storing the output profile in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem.
OutputReportItem This parameter should be null. This parameter is deprecated.

Returns

Variable of type String containing XML serialized segmentation profile

Remarks

Use the ProfileByAreaSummation method when you want to create a profile based on a polygon layer. Segmentation profiles can be created for any polygon feature layer, such as trade areas, study areas, and standard geography units in Business Analyst.

For example, suppose you want to create a Customer Tapestry Profile Report for a set of customers around a given store location. In Business Analyst, you can create a customer derived trade area using the locations of each customer in relation to the store location. For example, you could create a trade area that represents the closest 80 percent of the customers around the store location. This type of trade area is often referred to as the store's primary trade area. Once the trade area is created, you can use the ProfileByAreaSummation method to create a segmentation profile of the primary market area. When you create the Customer Tapestry Profile Report, you can compare the profile of the customer locations to the primary market area.

Examples

The example below creates a study area consisting of San Francisco County. It then analyzes the area and generates a market segmentation profile of the study area.

C#
// Instantiate the BAServerHelper class to access analysis methods
BAServerHelper baServerHelper = new BAServerHelper();
baServerHelper.ActiveDatasetID = "USA_ESRI"; // Optional parameter
baServerHelper.IsFullErrorMessage = true;    // Default is false
 
// ========= STEP 1: Create a boundary layer from standard geographies
 
// The San Francisco County study area is selected as the boundary.
StandardLevelsOfGeographyParameters geographyParameters = new StandardLevelsOfGeographyParameters();
 
// Set specific analysis parameters
geographyParameters.GeographyFeaturesBehavior = esriStdGeographyType.esriStdGeographyTypeFirst;
geographyParameters.GeographyIDs = new string[] { "06075" }; // FIPS ID code for San Francisco County
geographyParameters.GeographyLevelID = "US.Counties";
 
// Set other parameters
RenderingParameters imageOptions = null;
TaskOutputType[] outputOptions = new TaskOutputType[] { TaskOutputType.GetFeatureClass };
esriFolderItem outputLayer = null;
esriFolderItem outputReport = null;
 
TaskResultOutput geographyResult =
    baServerHelper.StandardLevelsOfGeography(geographyParameters, imageOptions, outputOptions, outputLayer, outputReport);
 
DataLayer boundaryLayer = new DataLayer();
boundaryLayer.RecordSet = geographyResult.RecordSet;
 
// ========= STEP 2: Create a segmentation profile by the boundary layer
 
ProfileByAreaSummationParameters parameters = new ProfileByAreaSummationParameters();
 
// Set specific analysis parameters
parameters.AreaIDField = "AREA_ID";
parameters.Boundaries = boundaryLayer;
parameters.SegmentationBase = "Total Households";
 
// Set other parameters
esriFolderItem outputItem = null;
 
string result = baServerHelper.ProfileByAreaSummation(parameters, outputItem);
 
ProfileData segProfile = new ProfileData();
segProfile.Description = result;

See Also