| FRAMES | NO FRAMES |
Parameters of SummaryReports task.
Availability: Business Analyst Server, Business Analyst Online.
class SummaryReportsParameters : SummaryReportParameters
| Property | Description |
|---|---|
| AnalysisExtent (optional) | Data extent to restrict the summarization. Type ExtentData. Available with Business Analyst Server. |
| AreaIDField (optional) | The attribute field name in the input Boundaries layer which is associated with unique area IDs. If this property is null, the area ID field is recognized as follows: if the Boundaries layer is a standard layer, the "ID" field is used; otherwise, the "AREA_ID" field is used. Type String. |
| Boundaries | The boundary layer that used to generate reports. This boundary layer is usually a Business Analyst trade area layer. Type DataLayer. |
| ReportSummarizationOptions (optional) | Features summarization method. Type esriBAReportSummarizationOptions. Available with Business Analyst Server 9.3 SP1 or greater. |
| RingIDField (optional) | The attribute field name in the input Boundaries layer which is associated with ring IDs (typically this field name is "RING"). Type String. |
| SingleAreaID (optional) | ID of a single area in the Boundaries layer to generate summary reports. Type String. Available with Business Analyst Server. |
| StoreIDField (optional) | The attribute field name in the input Boundaries layer which is associated with unique store/business IDs (typically store numbers for retail establishments with multiple locations). Type String. |
| DataHierarchy (optional) | Name of a hierarchy of data layers used for generating summary reports. 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. Inherited from SummaryReportParameters. |
| 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. |
Report items are sorted by area ID field having the form "storeID_ringID". If the area ID field has a value non-confirming to this template, the RingIDField and StoreIDField properties can be specified to provide the proper sorting.
The summarization can be restricted to an analysis extent if the AnalysisExtent property is specified. Optional SingleAreaID property restricts the summarization to a single area of the boundary layer. Since version 9.3 SP1, the summarization can be applied to individual features, to all features, and to both individual and all features. This behavior is controlled with the ReportSummarizationOptions property. If this property is null, the summarization by individual features is used.
NOTE: Since Business Analyst Server 10.0, the SummaryDataLayerID property is replaced with an optional DataHierarchy property.