These are aggregate functions as available on stream views and pipes. Aggregate functions serve the purpose of aggregating data and giving it more eaningfull meaning. They are usually a common feature in any data based environment. In database management, for instance aggregate functions are used where multiple rows are grouped together to form a singe value or to find out more significant meaning, represented by a single value on a set of values.
Aggregate functions are also available on pipes and views in PhixFlow. The following composes a set of available functions:
| Function | Description |
|---|
| average | This function returns the arithmetic average of the set of numbers. It takes one argument (a name of a field) of numeric type: Long, Float or Integer. It is only available if field on which it is applied, is of such type. |
| maximum | This function returns the maximum numeric value out of the set of numeric values. It takes one argument (a name of a field) of type, either: Long, Float, or Integer and it can be applied only on field of such type and only then it is available. |
| minimum | This function returns the minimum numeric value out of the set of numeric values. It takes one argument (a name of a field) of type, either: Long, Float, or Integer and it can be applied only on field of such type and only then it is available. |
| sum | This function returns the sum calculated by suming all the values in a given set of values. It is applicable only (and only then it is available) if the name of the field passed to this function represents numeric field of type: Long, Float or Integer. |
| percent | This function expects a name of numeric field to calculate percentage of sum of numerical values of each group in relation to a whole set of grouped values. It is therefore necessary to use this function in conjunction with grouping attribute, as otherwise only default grouping would be applied and this would present no meaningful result, as it would always default to 100% (each record would have been in its own group). If however we assume having a file with 2 records, like so: | Number | Label |
|---|
| 12 | A | | 14 | B | | 13 | C | | 10 | A | | 5 | A | | 2 | B |
and we also assume grouping by "Label", our percent function would return (if applied o "Number" attribute), the following result in a view (assuming we also selected Label attribute to be shown in our view): |
| distinct | |
| count | |
...
| Insert excerpt |
|---|
| _Banners |
|---|
| _Banners |
|---|
| name | analysis |
|---|
| nopanel | true |
|---|
|
Overview
Aggregate functions, often grouped by other attributes, give totals, max, min, average values etc. for each key value they are provided. For example, you can sum the amount of all the lines on an invoice based on an invoice number.
Aggregate functions are available to use on Views and Pipes.
Aggregating with a Pipe
To configure a pipe for aggregation
- Click on a pipe to open its properties.
- In the Aggregate Attributes section, click the plus button to add a new attribute.
- Complete the details:
- A Function: select the function you wish to perform e.g. sum. A complete list is provided in the function section at the end of this page.
- Attribute: select the attribute you wish to perform the function on.
- Name: name your new attribute.
- Aggregation on a pipe takes place across all groups of data. Therefore you can define which attribute(s) you wish to group on by adding these to sort/group, or if no grouping is provided aggregation takes place across all records.
- Click
| Insert excerpt |
|---|
| _finish |
|---|
| _finish |
|---|
| nopanel | true |
|---|
|
to save your changes. - The table connected to the end of the pipe can now access your attribute using its name.
| Note |
|---|
You cannot refer to any attributes in the source table for which there is no grouping or aggregate attribute. |
Aggregating with a Table
- Click on the pipe connecting to an Aggregate Table to open its properties.
- Aggregation takes place across all groups of data. Therefore you can define which attribute(s) you wish to group on by adding these to Sort/Group, or if no grouping is provided aggregation takes place across all records.
- Click
| Insert excerpt |
|---|
| _finish |
|---|
| _finish |
|---|
| nopanel | true |
|---|
|
to save your changes. - The Aggregate Table has access to all attributes on the incoming pipe.
- In the Attribute expressions,
- Use functions to aggregate values e.g. sum(in.Amount) will sum up all amounts within a group.
- Where multiple values exist for a group they will be treated as an array.
Use a full stop suffix after the attribute name followed by a number to obtain the record from a group in that position.
For example in.Name.1 will take the first name in a group.
Alternatively, use the Functions built into PhixFlow to select the required value.
Aggregate Examples
See Using an Aggregate Table.
Aggregate Functions
For the aggregate functions, Cumulative Sum and Cumulative Percent, see View Attribute.
| Insert excerpt |
|---|
| Aggregating Data |
|---|
| Aggregating Data |
|---|
| nopanel | true |
|---|
|