Aggregate Transformation¶
Overview¶
The Aggregate transformation object provides the functionality to create aggregations of your dataset, using aggregate functions such as Sum, Count, First, Last, Min, Max, Average, Var or Standard Deviation. The dataset can be split into groups so that the aggregate value(s) can be generated for the group instead of the whole dataset. For example, calculate product count by month of year, or get average sales price by region and year.
Aggregate Transformation can be applied to unsorted data or data sorted on group by values. When applied to an input stream that is sorted on group by fields, Aggregate Transformation performs substantially better and consumes very little memory. Alternatively, when applied to unsorted datasets, Aggregate Transformation may consume substantial memory resources for large data sets and may slow down the performance of the server.
Use Case¶
In this scenario, we have products data stored in a csv file. The source file contains information such as ProductID, Supplier ID, UnitPrice of the various products, QuantityPerUnit of products available etc. We want to derive the following information from our source data:
1. Number of products per category
2. Total price of all the products per category
3. Minimum price per category
4. Maximum price per category
We will use the Aggregate Transformation object to derive the required information.
How to Work with Aggregate Transformation¶
1. From the sources section in the Toolbox, drag-and-drop a Delimited File Source object to the dataflow designer.
2. To work with the Aggregate Transformation, drag-and-drop the Aggregate Transformation object from Toolbox > Transformations > Aggregate.
3. Right-click on the transformation object and select Properties. The Layout builder window will now open.
4. Here, you can write names of fields that you want to map to the transformation object in the Name column, and specify the relevant Aggregate Functions for them.
For this case:
CategoryID: We will select the Group-By option from the Aggregate Function drop-down list for this field as we want to group the records based on the available product categories.
ProductID: For this field we will select the Aggregate Function Count, in order to calculate the number of products per category.
UnitPrice: We will map this field thrice.
- To calculate TotalPricePerCategory, select the function Sum function.
- To calculate MaxPricePerCategory, select the Max function.
- To calculate MinPricePerCategory, select the Min function.
5. Click on Next. The Aggregate Transformation Properties window will now open.
There are three sorting options in Aggregate transformation:
- Incoming data is pre-sorted on group by fields: This option Aggregate requires data to be sorted by the specified Group-By field.
- Sort Incoming data before building aggregate: This option will first sort the incoming data, then build its aggregate.
- Build aggregate using unsorted data: This option will build aggregate using the incoming data whether it is sorted or not.
6. Click on Next. The Config Parameters window will now open, where you can further configure and define parameters for the Aggregate transformation.
7. Click Next. This is the General Options window. Click OK.
General Options Window:
This window shares options common to most objects in the dataflow.
Clear Incoming Record Messages
When this option is checked, any messages coming in from objects preceding the current object will be cleared. This is useful when you need to capture record messages in the log generated by the current object and filter out any record messages generated earlier in the dataflow.
Do Not Process Records with Errors
When this option is checked, records with errors will not be output by the object. When this option is off, records with errors will be output by the object, and a record message will be attached to the record. This record message can then be fed into downstream objects in the dataflow, for example a destination file that will capture record messages, or a log that will capture messages and collect statistics as well.
The Comments input allows you to enter comments associated with this object.
8. After you have configured the properties, click OK.
9. You will see the fields in the object that were added in the Layout Builder window.
10. Map the data fields from the source object to the transformation object. You can auto-map the entire dataset from the source to the transformation object, or only map selected fields that you want to work with. In this case, we will map CategoryID, ProductID and UnitPrice as those are the fields we want to find aggregations for*.*
(Note: UnitPrice field has been mapped three times as these will determine TotalPricePerCategory, MaximumPricePerCategory and *MinimumPriceperCategory.)
11. Right-click on the Aggregate transformation object and click Preview Output.
12. You will see that the specified Aggregate Functions have been applied.