FRAMES | NO FRAMES
SummaryReportParameters Type

Parameters of tasks implementing summary reports.

Availability: Business Analyst Server, Business Analyst Online.

class SummaryReportParameters : AnalysisParameters

Property Description
DataHierarchy (optional) Name of a hierarchy of data layers used for summarization. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
ReportOptions Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Available with Business Analyst Online and Business Analyst Server 9.3.1.
ActiveDatasetID ID of the active dataset. Type String. Available with Business Analyst Server. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Available with Business Analyst Server. 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.
token User authentication token received from Authentication Web Service. Type String. Available with Business Analyst Online. Inherited from AnalysisParameters.

Remarks

Properties of this class specify options for generation summary reports in trade area creation tasks. The ReportOptions array specifies summary reports that will be generated using trade/service areas as boundary areas for analysis and the DataHierarchy property specified the data hierarchy to be used for summarization.

NOTE: Since Business Analyst Server 10.0, the SummaryDataLayerID property is replaced with an optional DataHierarchy property.