Value requests (analyticValue:)

Value requests generate BStatusValues.

The scheme is similar to the query string of a URL, where properties follow a colon, name and values are joined with an equal sign, and pairs are separated with the ampersand. For example:

slot:/Drivers/foo|analyticValue:data=n:realPower&aggregation=sum

Properties

ORD scheme parameter Syntax Description
aggregation check box (if optional, and) drop-down list (property, defaults to First) or ORD parameter (aggregation=option) 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.

dataFilter optional NEQL query (property) or ORD parameter (dataFilter=query) 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).
data algorithm (or tag) name; data=algorithm or tag 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:.

useCache optional ORD parameter true or false; useCache=option Turns on and off the use of cache memory.

true causes the framework to request cache memory for value, trend and rollup requests that take longer than 200ms to process.

false uses no cache. This property is not related to the data availability cache.

unit unit=option (unit of measure) Selects the unit name and display symbol to associate with a data source.