Proxy extension (BAnalyticProxyExt)

This component resolves the configured analytic request and stores the result using its parent control point. On writable points, the proxy extension writes to priority level 16.

There are read-only and writable control points (Numeric, Boolean, Enum and String) with Analytic Proxy Extensions located in the Points folder of the analytics palette. The Property Sheets for configuring the Analytic Proxy Extensions associated with framework points are what set framework points apart from standard numeric, Boolean, enum and string points. When you drag these points to any location in a station, the Analytic Proxy Extension comes along with the point.

Figure 74.   Example of an Analytic Proxy extension
Image

In addition to the standard properties (Enabled, Status, and Fault Cause), this component provides these properties.

Properties Value Description
Node ORD (defaults to a relative ORD slot:../.. that refers to the parent of the control point) Defines the ORD to the desired slot.
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:.

Data Filter optional NEQL predicate 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).
Time Range (optional) drop-down list Defines the beginning and end of a period of time during which the analytic request processes historical data.
Interval optional drop-down list (defaults to the optimal number of records on reports) Refers to the BInterval component, which the framework uses to identify the time between values in a trend (time series). When specified, a rollup is required, which causes the system to combine all values that fall into a single interval.

Options range from None to a Year.

Above the drop-down list, the Use This Value check box turns on and off the check box next to Interval in the Settings window (you access this window by clicking the Edit button (Image), followed by clicking the Settings button (Image) on the chart). The availability of this check box provides an easy way for a user to enable and disable the use of intervals in chart calculations.

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.

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.

Aggregation value ( defaults to First) Configures the default function to apply when the analytic request combines 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.

Poller name Identifies which poller manages execution of the proxy extension.
Last Poll read-only Indicates the date and time that the system polled this point successfully.
Missing Data Strategy additional properties 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.