FRAMES | NO FRAMES
BenchmarkReportParameters Type

Parameters of BenchmarkReport task.

Availability: Business Analyst Server, Business Analyst Online.

class BenchmarkReportParameters : StandardReportParameters

Property Description
BenchmarkAreaOID OID of area from the BenchmarkLayer layer to be used as a benchmark area. Type Int32.
BenchmarkLayer Data layer used for calculation the benchmark area. Type DataLayer.
BenchmarkOptions Benchmark area calculation method. Type esriBABenchmarkOptions.
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.
FieldSortType (optional) Report fields sorting options. Type esriBABenchmarkSortOptions.
SortFieldName Name of summarization field the sorting will be based on. Type String.
Summarizations Fields of the geography data layer to be summarized for trade areas and compared with the benchmark. Type String[].
TAinRows (optional) Report layout options. The "trade areas in rows" layout is used by default. Type Boolean.
TALayersFields Fields of trade area layers that will appear in the report. Type String[].
TradeAreas Array containing one or more trade area layers to produce the benchmark report. Type DataLayer[].
StandardReportOptions Report parameters. The TemplateName parameter is ignored. Type ReportOptions. Inherited from StandardReportParameters.
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

The BenchmarkOptions property specifies how to create the benchmark area:


The TAinRows option determines the orientation of the summarization fields in the report:


The FieldSortType option specifies the sorting rules based on the SortFieldName field:

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

See Also