The Summarize attributes tool aggregates records and calculates statistics. You can aggregate all records, or you can aggregate based on matching values from one or more fields.
Examples
The Summarize attributes tool can be used in scenarios such as the following:
- Aggregate all sales records to calculate total profit.
- Aggregate sales records based on item type to calculate profit per item.
Parameters
The following table outlines the parameters used in the Summarize attributes tool:
| Parameter | Description |
|---|---|
Input dataset | The dataset containing the records to summarize. |
Fields to match | One or more fields that will be used to aggregate records based on matching values. This parameter is optional. By default, all records will be summarized. |
Summary fields | The fields from the input dataset that will be summarized, and the statistics that will be calculated for each field. This parameter is optional. By default, the COUNT statistic will be returned. |
Usage notes
Use the Input dataset parameter to identify the dataset that contains the records to summarize.
Use the Fields to match parameter to specify one or more fields containing the values to group the input records by. When you summarize by fields, statistics are calculated for each unique combination of attribute values. If no fields are specified, statistics are calculated using all records.
Use the Summary fields parameter to specify which fields from the input dataset to summarize. The following summary statistics are available:
- Sum—The sum of numeric values in a field. The sum of [null, 1, 3] is 4.
- Min—The minimum value of a numeric or date field. The minimum of [0, 2, null] is 0.
- Max—The maximum value of a numeric or date field. The maximum of [0, 2, null] is 2.
- Mean—The mean of numeric values. The mean of [0, 2, null] is 1.
- Standard deviation—The standard deviation of a numeric field. The standard deviation of [null, 1, 1, 1] is 0.
- Count—The number of nonnull values. It can be used on a field of any type. The count of [null, "hello", "world"] is 2.
- Any—A sample value from a field of any type.
Outputs
The tool output is a table with calculated statistics. In addition to any fields specified using the Fields to match parameter, the following fields will be available in the output result:
| Field name | Description |
|---|---|
COUNT | The count of records that have been summarized into the new record. This is always included in the output. |
STATISTIC_fieldname | Specified statistics will each create an attribute field, named in the following format: STATISTIC_fieldname. For example, the mean of the measurement field is MEAN_measurement. |
Limitations
The following are known limitations of the Summarize attributes tool:
- Records with empty, null, or invalid geometries will be excluded from processing and their values will not be used in summary statistic calculations.
- Summarize attributes does not summarize based on spatial relationships. To calculate statistics for polygons or polylines that intersect or share common attributes, use the Dissolve tool. To calculate statistics for tables or geometries based on attribute, spatial or temporal relationships, use the Join tool.
Licensing requirements
The following licensing and configurations are required:
- Creator or Professional user type
- Publisher, Facilitator, or Administrator role, or an equivalent custom role
To learn more about Data Pipelines requirements, see Requirements.