Deprecation Notice
This PreBuilt has been deprecated as of 01152024 and will be end of life on 01152025. The capabilities of this PreBuilt have been replaced by the IAP  Data Manipulation
Aggregate Functions For Arrays
Table of Contents
 Overview
 Installation Prerequisites
 How to Install
 How to Run
 Attributes
 Examples
 Additional Information
Overview
This JST allows IAP users to pass in an array of numbers and run a set of mathematical aggregate functions on the items. Users can also use this JST on the aggregated arrays returned by the GroupBy Property prebuilt. The aggregate functions supported are:
No.  Function 

1  Sum 
2  Product 
3  Maximum 
4  Minimum 
5  Range 
6  Count 
7  Arithmetic Mean 
8  Geometric Mean 
9  Harmonic Mean 
10  Median 
11  Mode 
12  Standard Deviation 
13  Variance 
The JST expects all the items in the array to be either numbers or parsable number strings (which will be converted to numbers); however, if there is a nonnumber/nonparsable string item, the item will simply be ignored from all calculations and returned as part of the valuesIgnored
array. Values which are used in calculations will be returned in the valuesUsed
array in their original forms (as strings/numbers) and in the valuesUsedconverted
array in their converted forms (all numbers).
Installation Prerequisites
Users must satisfy the following prerequisites:
 Itential Automation Platform:
^2021.2.x
How to Install
To install the prebuilt:
 Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Prerequisites section.
 The prebuilt can be installed from within
AppAdmin_Essential
. Simply search for the name of your desired prebuilt and click the install button.
How to Run
Use the following to run the prebuilt:

Once the JST is installed as outlined in the How to Install section above, navigate to the section in your workflow where you would like to perform aggregations on an array and add a
JSON Transformation
task. 
Inside the
Transformation
task, search for and selectaggregateFunctions
(the name of the internal JST). 
After selecting the task, the transformation dialog will display. The inputs to the JST would be the array on which the aggregate functions have to be executed.

The output of the JST can be used in any task in the workflow builder that comes after the
JSON Transformation
task. 
Save your input and outputs and the task is ready to run inside of IAP.
Attributes
Attributes for the prebuilt are outlined in the following tables.
Input
Attribute  Description  Type 

groupedArray 
An array of items for mathematical aggregation.  array 
Output
Attribute  Description  Type 

sum 
Summation of the items in the array.  number 
product 
Product of the items in the array.  number 
maximum 
The highest value in the array.  number 
minumum 
The lowest value in the array.  number 
range 
Difference between the lowest and highest values.  number 
count 
Number of items used for the calculations.  number 
arithmeticMean 
Summation of all items divided by number of items in the array.  number 
geometricMean 
The n^{th} root of the product of the items, where n is the number of items in the array.  number 
harmonicMean 
The reciprocal of the arithmetic mean of the reciprocals of the items in the array.  number 
median 
Middle value of the items in the array.  number 
mode 
The set of values that appear most often in the array.  array[numbers] 
modeFrequency 
The number of times each item in the mode array occured in the input array. 
number 
standardDeviation 
Measure of the amount of variation or dispersion of the items in the array.  number 
variance 
Measure of how far the array items are spread out from the arithmetic mean.  number 
valuesIgnored 
Items of the array that were either not a number or a parsable string and were ignored from all calculations.  array 
valuesUsed 
Items of the array that were either a number or a parsable string and were used for all calculations.  array[numbers/strings] 
valuesUsedconverted 
The parsed form of all items in valuesUsed . 
array[numbers] 
Examples
Below are examples describing how the prebuilt will work for different inputs.
Example 1
Input
[
1,
"2",
"3.3",
4.7,
5
]
Output
{
"valuesIgnored": [],
"valuesUsed": [
1,
"2",
"3.3",
4.7,
5
],
"valuesUsedconverted": [
1,
2,
3.3,
4.7,
5
],
"count": 5,
"mode": [
1,
2,
5,
3.3,
4.7
],
"modeFrequency": 1,
"median": 3.3,
"geometricMean": 2.7423467009186018,
"product": 155.1,
"harmonicMean": 2.256525154945151,
"sum": 16,
"maximum": 5,
"minimum": 1,
"arithmeticMean": 3.2,
"standardDeviation": 1.5349267083479916,
"variance": 2.3560000000000003,
"range": 4
}
Example 2
Input
[
10,
"20.",
"30b",
null,
20,
".40",
false,
[23],
10,
50
]
Output
{
"valuesIgnored": [
"30b",
null,
false,
[23]
],
"valuesUsed": [
10,
"20.",
20,
".40",
10,
50
],
"valuesUsedconverted": [
10,
20,
20,
0.4,
10,
50
],
"count": 6,
"mode": [
10,
20
],
"modeFrequency": 2,
"median": 15,
"geometricMean": 9.63492483998996,
"product": 800000,
"harmonicMean": 2.127659574468085,
"sum": 110.4,
"maximum": 50,
"minimum": 0.4,
"arithmeticMean": 18.400000000000002,
"standardDeviation": 15.646085772486357,
"variance": 244.79999999999998,
"range": 49.6
}
Additional Information
Please use your Itential Customer Success account if you need support when using this PreBuilt Transformation.