This deprecated node performs a quick statistical analysis of numeric input data, using the sum, min, max, average, count, range and null count functions.
To configure the node:
- Set the status of the UseRegularExpression property. The UseRegularExpression property defines whether you enter a list of input fields or a Script expression in the FieldList property. By default, the UseRegularExpression property is set to false, which means that you enter one or more input fields in the FieldList property. If you want to enter a Script expression in the FieldList property, set the UseRegularExpression property to true.
- In the FieldList property, enter one or more input fields or a Script expression to point to the fields on which you want to run the analysis.
- If you want to group the records by specific fields to produce more granular results, enter a Script expression in the GroupByExpr property to point to these fields. For example, if there was a field called Product ID you would enter the following in the GroupByExpr property:
'Product ID'If the GroupByExpr property is left blank, the Quick Stats (Deprecated) node evaluates the data across all fields.
- Set the SortInput property to true if you want to sort the data based on the values specified in the GroupByExpr property.
- If you want to exclude any statistical functions from the evaluation, set the corresponding property to false. For example, to exclude the average function, set the IncludeAverage property to false. Note: all functions are set to run by default but can be individually turned off to optimize performance. In particular, when not in use, we recommend that you turn off sum and average to avoid any errors with large data sets.
- Specify how to handle non-numeric data in the NonNumericFieldBehavior property.
Properties
FieldList
Specify one or more input fields or a Script expression to point to the fields on which you want to run the analysis. If the UseRegularExpression property is set to false (default) then this will be a list of fields, otherwise this will be a Script expression defining the list of fields.
A value is required for this property.
UseRegularExpression
Optionally specify whether to use a Script expression in the FieldList property.
The default value is False; this means that you enter one or more input fields in the FieldList property.
GroupByExpr
Optionally specify an expression to group the records on. If left blank, all records are grouped.
SortInput
Optionally specify whether the input will be sorted based on the fields specified in the GroupBy property.
The default value is True.
IncludeAverage
Optionally specify whether to calculate the average of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
IncludeSum
Optionally specify whether to calculate the sum of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
IncludeMin
Optionally specify whether to calculate the minimum value of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
IncludeMax
Optionally specify whether to calculate the maximum value of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
IncludeRange
Optionally specify whether to calculate the range of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
IncludeCount
Optionally specify whether to calculate the number of records across the group defined by the GroupByExpr property.
The default value is True.
IncludeNullCount
Optionally specify whether to calculate the number of NULL values of each field defined in the FieldList property across the group defined by the GroupByExpr property.
The default value is True.
StableSort
Optionally specify whether, for any items that are already in order, their order is maintained.
The default value is False.
NonNumericFieldBehavior
Optionally specify an option to determines how the node behaves when it is given fields in the FieldList property that are non-numeric. Choose from:
- Error - The node fails if the fields are not int, long or double data types.
- Log - Non-numeric fields are logged and numeric fields are processed.
- Ignore - Non-numeric fields are ignored and numeric fields are processed.
The default value is Error.
Inputs and outputs
Inputs: Input records.
Outputs: Stats data.