FRAMES | NO FRAMES
StandardLevelsOfGeographyParameters Type

Parameters of StandardLevelsOfGeography task.

Availability: Business Analyst Server.

class StandardLevelsOfGeographyParameters : SummaryReportParameters

Property Description
AppendFields (optional) An option to specify whether or not to append the DataTable fields to the output trade area layer. Type Boolean.
DataTable Data table containing IDs of the geography level to be exported to the output trade area layer.
GeographyFeaturesBehavior (optional) Method of aggregation of the DataTable table rows having identic geography IDs. Type esriStdGeographyType.
GeographyIDs Array of IDs of the geography level. Type String[].
GeographyLevelID ID of a geography level to get standard geographic units. Type String.
TableIDField The attribute field name in the input DataTable table which contains geography IDs. 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[]. Inherited from SummaryReportParameters.
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. 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.

Remarks

The GeographyLevelID property specifies the geography level with geographic units that are exported to the output trade area.

There are two ways for selection IDs of geographic units from the geography level—using array of IDs or using data table.

In the first case, the GeographyIDs property explicitly specifies the list of IDs of geographic units. In Business Analyst Server 9.3.1 SP1, an ability to join geography features into one combined feature is added. To do this, specify a comma-separated list of feature IDs in an item of the GeographyIDs array. The same feature ID can appear in a number of combined features simultaneously.

In the last case, the DataTable property specifies a data table and the TableIDField property specifies the column of the data table which contains geography IDs required. In Business Analyst Server 9.3.1 SP1, an ability to specify a combined feature is added. To do this, specify a comma-separated list of geography IDs as an ID of feature in the table.

The optional AppendFields property allows you to export all other columns of the data table to the output trade area layer. Since the data table can contain records with duplicate geography IDs, it is important to specify how the data in rows with a duplicated geographic ID are aggregated. The GeographyFeaturesBehavior property specifies the aggregation method—use data from the first matching row (default) or summarize data for all rows having identic geographic IDs.

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

See Also