Rollup (BRollupBlock)

This block combines all values of a trend based on the configured Rollup function and Interval property from the request. It supports both trend and value requests.

For a value request the block's Time Range property is used to request trend data and returns a single value by applying the value request’s Rollup property if the block’s Use Request Rollup property is true, otherwise by applying the block’s Rollup property.

This block does not modify the Rollup property in the request, meaning that if the block’s Use Request Rollup is false it uses the function defined by the block’s Rollup property but other downstream linked blocks use the original Rollup property from the request.

Figure 143. Rollup properties

To view these properties, double-click the block on the Wire Sheet or the block name in the Nav tree.

Property	Value	Description
Out	read-only value slot	Outputs a rolled up value based on the configured `Rollup` function and `Interval` property from the request.
Trend In	required value slot	Links from the output of other logic blocks or data sources to supply trend data to the current logic block.
Rollup	check box (if optional, and) drop-down list or ORD parameter (when configured in the data definition, defaults to `First`, when configured elsewhere, defaults to the value as defined in the Data Definition); rollup=option	Configures the default `Rollup` function used by the block when the block’s `Use Request Rollup` property is set to `false`. If rollup is not enabled in the binding/settings window, the rollup value configured in the Data Definition applies to all chart bindings, reports and tables. `And` returns the logical “and” of Boolean values. `Avg` returns the statistical mean, which is determined by calculating the sum of all values and dividing by the number of values. `Count` returns the total number or quantity of values in a combination. If you request this value on a binding in a PX view, the system counts the number of values based on the properties defined by the data source block and the algorithm’s Property Sheet. `First` returns the first value in the combination. `Last` returns the last value in the combination. `Max` returns the highest value in the combination. `Median` returns the value in the middle of a sorted combination—the number that separates the higher half from the lower half. `Min` returns the lowest value in the combination. `Mode` returns the statistically most frequently occurring number in the combination. `Or` returns the logical “or” of Boolean values. `Range` returns the statistical difference between the largest and smallest values in the combination. `Sum` adds together all values in the combination resulting in a single value. `Std Dev` calculates the standard deviation of the values in the combination. `Load Factor` calculates the average divided by peak (Max) value.
Time Range	range of options	Defines the time period over which to combine the data in a rollup. This property is required for rollup requests (analyticRollup), trends (analyticTrend), and rollup bindings. It is optional elsewhere. It is not used if the block’s `Use Request Time Range` property is `true` and the request specifies a time range. Options range from `From` to `All`. `Time Range` defaults to Today, which causes the framework to return a point’s current value.
Use Request Rollup	`true` or `false` (default)	Determines the rollup function to use. The data definition associated with each tag defines the default function for rolling up data. `true` causes the framework to use the function defined by the incoming request. `false` causes the framework to use the function defined in the block’s `Rollup` property.
Use Request Time Range	`true` or `false` (default)	Determines the time range for rolling up data. `true` causes the framework to use the time range defined by the incoming request. `false` causes the framework to use the time range defined in the block’s `Time Range` property.

Processing with Use Request Rollup

When Use Request Rollup is false and Rollup is not configured, the block uses the rollup function defined in the applicable Data Definition. If there is no Data Definition, the block uses the default First function. When Use Request Rollup is false and Rollup property is configured, the block uses the Rollup property value. When Use Request Rollup is true, the block uses the rollup function defined in the request (Analytic Proxy Ext, Analytic Binding, etc.), unless the request does not specify the rollup function in which case the block uses the Algorithm’s Rollup property value.

The following table may help to determine when each value applies.

Data Definition Rollup	Data Source Block Use Request Rollup	Data Source Block Rollup	Request Rollup	Algorithm Rollup	Actual Rollup Function
Unconfigured	False	Unconfigured	Sum	Max	Defaults to First
Last	False	Unconfigured	Sum	Max	Last
Last	False	Avg	Sum	Max	Avg
Last	True	Avg	Sum	Max	Sum
Last	True	Avg	Unconfigured	Max	Max