FRAMES | NO FRAMES
SummaryReports Method

Generates summary reports for trade areas.

Availability: Business Analyst Server, Business Analyst Online.

TaskResultOutput SummaryReports ( 
    SummaryReportsParameters  Parameters, 
    esriReportFormat          ReportFormat, 
    TaskOutputType[]          OutputTypes, 
    esriFolderItem            OutputReportItem 
);

Parameter Description
Parameters Configuration options for analysis including report type options. Type SummaryReportsParameters.
ReportFormat This parameter should be null. This parameter is deprecated. Available with Business Analyst Server.
OutputTypes Array of task output options. Options for this method include creating a report (GetReport). Type TaskOutputType[].
OutputReportItem (Optional parameter — can be null).
Configuration options for storing the output report in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem. Available with Business Analyst Server.

Returns

Variable of type TaskResultOutput

Usage Tips

Examples

The example below generates a Summary Report on a ring-based trade area. See GetReportTemplates method for a list of available Summary Report types.

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
 
// You can specify below a domain of your local Business Analyst Server.
//baServerHelper.BAServerDomain = "esri.com";
 
// If a domain name is specified, a local server name in output URLs is replaced with the
// fully-addressable server name so people and machines outside the domain of your local
// Business Analyst Server instance can access these URLs.
 
RenderingParameters imageOptions;
TaskOutputType[] outputOptions;
esriFolderItem outputLayer;
esriFolderItem outputReport;
 
// ========= STEP 1: Create a boundary layer with 3 simple rings around a store
 
PointRecord[] storePoints = new PointRecord[1];
 
storePoints[0] = new PointRecord();
storePoints[0].Name = "store_study_site";
storePoints[0].Description = "Store Study Site";
storePoints[0].StoreID = "1";
storePoints[0].Latitude = 37.787;
storePoints[0].Longitude = -122.45;
 
// Create a store feature layer based on an array of point records.
PointLayer storeLayer = new PointLayer();
storeLayer.Points = storePoints;
 
SimpleRingsParameters simpleRingsParameters = new SimpleRingsParameters();
 
// Set specific analysis parameters
simpleRingsParameters.DistanceUnits = esriUnits.esriMiles;
simpleRingsParameters.Radii = new double[] { 1, 2, 3 };
simpleRingsParameters.SingleStoreID = "1";
simpleRingsParameters.Stores = storeLayer;
 
// StoreIDField is useless for stores specified with array of PointRecord
//simpleRingsParameters.StoreIDField = "STORE_ID";
 
// Set other parameters
imageOptions = null;
outputOptions = new TaskOutputType[] { TaskOutputType.GetFeatureClass };
outputLayer = null;
outputReport = null;
 
TaskResultOutput simpleRingsResult =
    baServerHelper.SimpleRings(simpleRingsParameters, imageOptions, outputOptions, outputLayer, outputReport);
 
DataLayer boundaryLayer = new DataLayer();
boundaryLayer.RecordSet = simpleRingsResult.RecordSet;
 
// ========= STEP 2: Execute the analysis
 
SummaryReportsParameters parameters = new SummaryReportsParameters();
 
// Set specific analysis parameters
parameters.AreaIDField = "AREA_ID";
parameters.Boundaries = boundaryLayer;
parameters.RingIDField = "RING";
parameters.StoreIDField = "STORE_ID";
 
// Set summary report parameters
ReportOptions ageSexReport = new ReportOptions();
ageSexReport.ReportFormat = "HTML";
ageSexReport.TemplateName = "Age by Sex Profile";
 
ReportOptions marketReport = new ReportOptions();
marketReport.ReportFormat = "PDF";
marketReport.TemplateName = "Market Profile";
 
ReportOptions demoReport = new ReportOptions();
demoReport.ReportFormat = "PDF";
demoReport.TemplateName = "Demographic and Income Report";
parameters.ReportOptions = new ReportOptions[] { ageSexReport, marketReport, demoReport };
 
// Set other parameters
outputReport = null;
 
TaskResultOutput result = baServerHelper.SummaryReports(parameters, outputReport);
 
ReportInfo[] reports = result.Reports;

See Also