Parameter | Description |
filter | String that indicates that you want to perform calculations on only those key/value pairs for which the input filter field matches this field. An empty string as the value of either the filter parameter or the input filter field indicates that there is no filtering. If the value of the filter is "not equal to" parameter is true, and you specify a value for the filter parameter, the Filtered Summary block operates on key/value pairs for which the input filter field does NOT match the value of the filter parameter. |
keyToDelete | String that indicates a key for which you want to delete data from the Filtered Summary block’s internal store of data. Invoke the deleteKey operation to delete the data associated with this key. |
filter is "not equal to" | Boolean that indicates whether you want to match or not match the value of the filter parameter. When the filter is "not equal to" parameter is true, the Filtered Summary block operates on key/value pairs for which the input filter field does NOT match the value of the filter parameter. |
Operation | Description |
reset | The Filtered Summary block stores data about the number of unique keys it has observed and their most recent associated values. This operation flushes that data; it is no longer accessible to the Filtered Summary block. |
deleteKey | Deletes the key defined by the keyToDelete parameter. This operation deletes data from the Filtered Summary block’s internal store of data. If the value of the keyToDelete parameter is an empty string, this operation does nothing. |
Feed | Fields | Description |
input | key | String that contains the key under which you want the Filtered Summary block to store data in its internal data store. Typically, the key is the instance ID of a sub-scenario. The Filtered Summary block ignores blank keys, that is, a key that is an empty string |
value | A float value that you want to operate on. Typically, this is the value of a sub-scenario variable. | |
filter | String that contains a filter for determining the key/value pairs you are interested in. |
Feed | Fields | Description |
data | numberOfKeys | Integer that specifies the number of unique keys for which the Filtered Summary block currently stores data. |
totalValue | Floating point value that is the sum of the values that the Filtered Summary block currently stores. | |
averageValue | Floating point value that is the average of the values that the Filtered Summary block currently stores. |