Adding Equipment Properties

For each level of Assets within the tree control of the AssetWorX provider in the Workbench, you can add Equipment Properties. These allow you to connect the associated asset to real-time (utilizing multiple data source options) or historical data sources

 

To Add an Equipment Property to an Existing Equipment Asset in AssetWorX

  1. First, you must have already created an asset. You could assign an equipment property to the top-level 'Assets' node if you wish, but in our example, we are connecting to a sub-branch in the tree, an equipment asset we've named 'Test Asset'.

    You can add the property by either right-clicking on the equipment in the asset tree and selecting 'Add Equipment property' OR you can click on the item and then, once the contextual ribbon changes to the items relevant to your item selection), click on the 'Add Equipment property' button in the Edit section of the Home ribbon at the top of the screen.

'Add Equipment property' in the Assets Node in the Workbench

  1. This will open a new Equipment property properties window in the right-side window of the Workbench, as well as a placeholder in the top right items list. This items list shows any sub-items connected to an asset, as well as any of its connected properties. Enter an Equipment property name in the text entry field.

Equipment Property Settings in the Workbench

General Tab

General Tab

Runtime Parameters

Runtime Parameters are very similar to parameters in the Unified Data Manager. All parameters used by the property need to be explicitly defined. This requirement is applicable to all text fields in the Equipment Properties, excluding Name, Parameter Name and Parameter Description. In addition, there is a mechanism that checks the parameter list against the parameters that are actually used and reports the differences along with a message/button to fix the issue (e.g., The property uses these undefined parameters. [Add parameters] or The property does not use these parameters [Remove parameters]).

Runtime Parameter - Point Name Syntax

Relative References

Relative references are special placeholders that refer to the current Equipment. They get replaced through Runtime by their full point names or by the values of those points. Relative references could include:

 

@@self

@@parent

@@ancestor[n] - @@ancestor[0] equals to @@self

 

An example could be an Equipment Property that sums together the values of two sibling properties (named a and b).

 

Relative references are applicable to all text fields (except for Name, Custom Identifier and where Runtime Parameters do not apply on Equipment Properties). All placeholder replacement is static and happens only when the configuration is loaded or changed. @@self (and other placeholders) are replaced by the name of the current equipment; not prefixed by node name. This makes them usable whenever a point name is expected (e.g., in expressions). When further enclosed by << and >>, the Asset Catalog will replace them with their static value. << and >> can get the value of a static Equipment Property or the value of attributes of both Equipment and Properties.

 

.CustomID

.DatabaseID

.Description

.DisplayName

.Name

.Path

.History Point Name

.RealtimePointName

 

A new browser for Relative References has been integrated into the Data Browser (where applicable). Relative References can also be used in many command fields but not all commands. Relative References work on command text fields which do not show the new browser (except for the command name).

 

Click HERE for examples on how to achieve specific goals.

Dynamic Point Names

Prior to the inclusion of Dynamic Point Names, the data tag of an Equipment Property needed to be fully specified in the AssetWorX configuration.

 

Example:

hh\Configuration\DataTypes:Float64

 

Runtime Parameters and Relative References have added more flexibility.

 

Example:

hh:\Configuation\DataTypes<<P1>>

 

Dynamic Point Names add yet more flexibility. The Point Name is the result of a dynamically changing expression.

 

Example:

x="hh:\Configuration\DataTypes:" + tostring({{sim64:String.Static("dnph").Value}})

 

This is different from an "Expression" Property, where the client receives the value of the expression directly. It is applicable to Real Time data tags, Historical data tags, Data Set tags and Alarm sources. It can be combined with Runtime Parameters and Relative References and can also be combined with an Expression Property.

Real Time Data Tab

Real Time Data - Source Type: None

 

In this instance, you won't require a connection to any Real Time data. You can still decide to use any existing data cached in the database by clicking on the 'Use Database Cache' checkbox.

Real Time Data - Source Type: Static Value

 

In this instance, once you select 'Static Value' from the pulldown menu, you'll see options to select a 'Data Type' and, depending on that type, be able to enter a Value (in the following text entry field). You can also decide to use any existing data cached in the database by clicking on the 'Use Database Cache' checkbox.

 

Data Types include:

Real Time Data - Source Type: Dynamic Tag

 

In this instance, once you select 'Dynamic Tag' from the pulldown menu, you'll be able to enter a Real time data tag. If you don't know the exact location, you can click on the button to bring up the Data Browser, where you will be able to select from all connected data sources. In the example above, we are using a simulated data value source. You can also decide to use any existing data cached in the database by clicking on the 'Use Database Cache' checkbox.

Real Time Data - Source Type: Polled Dynamic Tag

 

In this instance, once you select 'Polled Dynamic Tag' from the pulldown menu, you'll be able to enter a Real time data tag. In the example above, we are using a simulated data value source.

In comparison to the regular 'Dynamic Tag' option explained above, the Polled Dynamic Tag allows you to set times/recurrences for data retrieval, using a Polling Group. If you don't know the exact location, you can click on the button to bring up the Data Browser, where you will be able to select from all connected data sources.

 

The Polling Group pulldown allows you to either <inherit> the polling settings from the higher branches of the asset tree in which this particular equipment asset has been placed OR you can select a Polling Group that has been created through the Polling Groups feature of the AssetWorX provider's System properties.

 

You can also decide to use any existing data cached in the database by clicking on the Use Database Cache checkbox.

Real Time Data - Source Type: Expression

 

In this instance, once you select 'Expression' from the pulldown menu, you'll see options to select a Data Type. You can also decide to use any existing data cached in the database by clicking on the 'Use Database Cache' checkbox.

 

Data Types include:

Next, you'll be able to either enter a Read Expression directly into the text entry field or click on the button to open the Expression Editor.

 

Once you have entered a Read Expression, you have the option of also creating a Write Expression.

 

Click on the Write expression enabled checkbox in order to allow the remaining text entry fields to become active.

 

You'll be able to enter a Real time data tag. If you don't know the exact location, you can click on the button to bring up the Data Browser, where you will be able to select from all connected data sources. In the example above, we are using a simulated data value source.

 

Next, you'll be able to either enter a Write Expression directly into the text entry field or click on the [X=] button to open the Expression Editor.

 

Filtering by quality - Use the pulldown menu to select from either Any quality or Only good.

 

Use database cache - If enabling this option, be sure that the cache data store connection in Other settings is not empty or the database cache will not work.

 

Always on scan - Note that this option will only work on properties, which are requested with default values for their runtime parameters.

 

Scan rate - If you have enabled Always on scan, you can enter a scan rate into the text entry field.

Historical Data Tab

Historical Data Tab in the Equipment Property Settings in AssetWorX

 

First, if you decide to utilize historical data with your equipment property, click on the checkbox for Historical data enabled.

 

If you have not already changed settings in the Real Time Data tab, the Historical tag different from real time tag checkbox will be inactive. If you did make changes to the Real Time Data tab, click the checkbox if you wish to use a different data tag. You'll then be able to enter a Historical data tag. If you don't know the exact location, you can click on the button to bring up the Data Browser, where you will be able to select from all connected data sources.

AssetWorX Integration with Hyper Historian

AssetWorX can be integrated with ICONICS Hyper Historian rapid data historian solution. This allows for configuration of Hyper Historian tags directly from within AssetWorX inside the Workbench. For more info and steps on how to ensure Hyper Historian integration with Assets, click HERE. Once this integration has been configured, additional 'Source type' options are available within the Historical Data tab in Equipment Property Settings in Assets in the Workbench, including Hyper Historian Tag, Hyper Historian Calculated Tag, Hyper Historian Calculated Simple Events, and Hyper Historian Calculated Condition.

Historical Data - Source Type: Hyper Historian Tag

 

General Tab

 

Historical Data - Source Type: Hyper Historian Tag - General Tab

 

Properties

Filtering

Logging Options Tab

 

Historical Data - Source Type: Hyper Historian Tag - Logging Options Tab

 

Log to Disk

Aggregates Tab

 

Historical Data - Source Type: Hyper Historian Tag - Aggregates Tab

 

Aggregates Configuration

Source Type: Hyper Historian Calculated Tag

 

Historical Data - Source Type: Hyper Historian Calculated Tag

 

General Tab

 

Historical Data - Source Type: Hyper Historian Calculated Tag - General Tab

 

Properties

Triggers

Expression Tab

 

Historical Data - Source Type: Hyper Historian Calculated Tag - Expression Tab

 

Expression

 

This tab allows you to create an expression for the calculation. This expression should include the following:

Click the Syntax button at the bottom of the window to check the logical syntax of the expression. Make any necessary corrections.

 

Source Type: Hyper Historian Calculated Simple Events

 

Historical Data - Source Type: Hyper Historian Calculated Simple Events

 

General Tab

 

Historical Data - Source Type: Hyper Historian Calculated Simple Events - General Tab

 

Properties

Triggers

Expression Tab

 

Historical Data - Source Type: Hyper Historian Calculated Simple Event - Expression Tab

 

Expression

 

This tab allows you to create an expression for the calculation. This expression should include the following:

Click the Syntax button at the bottom of the window to check the logical syntax of the expression. Make any necessary corrections.

 

Source Type: Hyper Historian Calculated Condition

 

Historical Data - Source Type: Hyper Historian Calculated Condition

 

General Tab

 

Historical Data - Source Type: Hyper Historian Calculated Condition - General Tab

 

Properties

Triggers

Expression Tab

 

Historical Data - Source Type: Hyper Historian Calculated Condition - Expression Tab

 

Expression

 

This tab allows you to create an expression for the calculation. This expression should include the following:

Click the Syntax button at the bottom of the window to check the logical syntax of the expression. Make any necessary corrections.

Dataset Tab

Dataset Tab in the Equipment Property Settings in AssetWorX

 

Along with Real Time and Historical data, AssetWorX properties can be used to transport Data Sets.

See Also:

Adding Equipment to the Asset Tree