Analytic rollup binding

You can use this binding wherever a traditional value ORD binding can be used.

Figure 218. Analytic Rollup Binding properties

You access this view of the Analytic Rollup Binding properties when you double-click the web widget in the Px view.

Under the hood, this binding creates an analyticRollup: ord. However, since analytic values cannot be subscribed to like points, this binding automatically refreshes the value.

Property	Value	Description
degradeBehavior	`Disable` or `None`	Specifies the framework’s behavior when the binding analytic ORD cannot be resolved or used due to security permissions.
hyperlink	ORD	Provides a link to another object. When this property contains an ORD, the hyperlink is active in the browser or in the Px Viewer.
summary	text or BFormat	Formats the summary string that is displayed in the status bar on mouse over.
popupEnabled	`true` or `false` (default)	Turns the use of a second popup on and off. `true` allows a second popup (right-click menu) to open when a user clicks on this label from a browser or from the Px Viewer. `false` disables the popup action. You would use this setting to prevent actions from being executed at a control point from a specific Px graphic while allowing access to the action from a different Px graphic or Property Sheet.
data	tag or algorithm name	Specifies the an algorithm (or tag) used to retrieve data. The purpose of an alert is to detect a fault condition (Boolean value result). In most cases, you would pick an algorithm that has a Boolean result when configuring this property for an alert. Algorithms with a numeric or enum value greater than zero are considered true and less than zero are considered false. This is how output from one algorithm becomes the input data source to another algorithm. The prefix for algorithms is alg:.
node	ORD (defaults to a relative ORD slot, which is resolved against the config space to which the Px view is assigned)	Defines the ORD to the desired slot.
dataFilter	ORD parameter	Identifies data sources in the subtree of the request node. When a predicate accepts a node that contains the desired data, the system does not search the node’s subtree for additional values (including the root node).
timeRange	ORD parameter (defaults to `Today`)	Defines the time period used to query historical data.Defines the beginning and end of a period of time over which to count the number of occurrences or weight. If the alert depends on a certain number of occurrences or weight over time, this property is required, otherwise, it is optional.
interval	optional drop-down list (defaults to the optimal number of records on reports)	Determines if the associated interval should be used. to combine output data.
aggregation	value ( defaults to `First`)	Configures the default function to apply when the analytic request needs to combine values from multiple data sources into a single value. This applies to both value and trend requests. If aggregation is not enabled in the binding/settings window, the aggregation value defined 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. `Load Factor` returns the average value divided by peak value. `Std Dev` returns the standard deviation of the values in the combination.
rollup	value (when configured in the Data Definition, defaults to `First`, when configured elsewhere, defaults to the value as defined in the Data Definition)	Configures the default function to apply when the analytic request needs to rollup records from a single data source into less granular records. This typically only applies to trend request, but may also apply to value requests where the `Id` is an algorithm that contains a block like Runtime or Sliding Window, which processes a trend request. 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.
unit	unit of measure	Selects the unit name and display symbol to associate with a data source.
daysOfWeek	ORD scheme	Specifies the days of the week to include.
totalize	`true` or `false`	Turns on (`true`) and off (`false`) value accumulation. By default, the framework totalizes (accumulates) all consumption history values in charts, tables and reports. To prevent cumulative values, disable this property (set it to `false`).
missingDataStrategy	chooser	Configures how the framework handles missing data in a series when processing analytic requests and one or more records are missing for an interval. It applies when even a single record for an interval is missing. It does not apply to value requests.
refreshRate	hours minutes seconds (defaults to 5 minutes)	Determines how frequently the framework resolves the analytic request to provide updated data to the widget.

Analytic rollup binding

Figure 218. Analytic Rollup Binding properties

Related Links