AF AssetsHierarchy

The AF AssetsHierarchy activity helps you search AFElement objects, AFElement objects with their AFAttribute objects, and AFAttribute objects on the PI AF server. The following sections describe the tabs for this activity.

General

On the General tab, you can specify the name of the activity in the process, establish a connection to the PI AF server, and select the type of operation you want to perform.

The following table lists the fields on the General tab of the AF AssetsHierarchy activity:
Field Module Property? Description
Name No A unique name of the activity in a process.
Server Connection Yes The PI AF shared resource selected to connect to the PI AF Server.

Click the icon to select an OSIsoft PI System AF connection resource. If no matching OSIsoft PI System AF connection resource is found, click Create Shared Resource to create one.

Note: This activity supports only PI AF server as server type.
Operation Yes The type of operation you want to perform:
  • searchElements: search AFElement objects on the PI AF server.
  • searchElements [Get Attributes check box enabled]: search AFElement objects and their respective attributes for each element object in the result.
  • searchAttributes: search AFAttribute objects on the PI AF server.

Description

On the Description tab, you can type a short description for the AF AssetsHierarchy activity.

Input

On the Input tab, you can specify AFElement or AFAttribute name, AFAttribute category, AFAttribute value type, AFElement search root, AFElement category, AFElement template, AFElement type to search the appropriate AFElement, or AFAttribute for the AF AssetsHierarchy activity.

Input elements on this tab are different depending on the operation you select on the General tab:

Operation Refer To
searchElements searchElements: Input Items
searchElements (Get Attributes check box enabled) searchElements with Attributes: Input Items
searchAttributes searchAttributes: Input Items

Output

On the Output tab of the AF AssetsHierarchy activity, you can find the results corresponding to your inputs. The output elements on this tab are different depending on the operation name you select on the General tab.

Note: All the timestamps are in UTC time zone.

Output elements on this tab are different depending on the operation you select on the General tab:

Operation Refer To
searchElements searchElements: Output Items
searchElements (Get Attributes check box enabled) searchElements with Attributes: Output Items
searchAttributes searchAttributes: Output Items

Fault

On the Fault tab, you can find the error messages and error codes of the AF AssetsHierarchy activity. For more information about errors, see Error Codes.

The following table lists the error schema elements on the Fault tab:

Output Item Data Type Description
msg String Displays the error message.
msgCode String Displays the error code.