Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI DataLink

Properties function

  • Last UpdatedNov 21, 2022
  • 2 minute read

The Properties function returns the property value of a specified data item.

Input

Description

Root path

The common path to specified data items. Valid entries include:

  • PI Data Archive server name if the data item is a PI point.

  • PI AF server and database if the data item is a PI AF attribute.

  • Blank if the data item is a PI point on the default PI Data Archive server.

    See Data items.

Data item(s)

One or more PI point names or PI AF attribute names, for which the function returns property values.

Reference a range of cells that contain PI point names or PI AF attribute names to display values for each. By default, PI DataLink writes values in rows for a column of referenced data items, and in columns for a row of referenced data items.

Property

The property for which the function returns values. The listed properties depend on the entered data item:

  • Single PI point. The list contains the point attributes from the point class of the entered point.

    Note: This list substitutes uom for EngUnits. Select uom if you want to see the value of the EngUnits point attribute.

  • Single PI AF attribute. The list contains four PI AF attribute properties: categories, description, uom, and pipoint.

  • Reference to multiple cells. The list depends on the type of data item in the first referenced cell:

    • PI point. The list contains the point attributes from the PointClass of that point.

    • PI AF attribute. The list contains four PI AF attribute properties: categories, description, uom, and pipoint.

      If the list is blank, PI DataLink could not find the data item.

      Select the desired property or specify a cell reference to a cell that contains the property.

Output cell

The worksheet cell where the function writes the resulting function array. If you select a cell before you open the function task pane, PI DataLink inserts the selected cell into the Output cell field.

Specify the top-left corner of the function array. PI DataLink expands the range downward and to the right of the output cell, as necessary to return specified data. PI DataLink might overwrite adjacent cells.

If you specify a multi-cell array in the Output cell field and the specified array is larger than the resulting function array, PI DataLink pastes the function formula in the unneeded cells of the specified array.

See also

PITagAtt()

Related Links
TitleResults for “How to create a CRG?”Also Available in