AF TagDefinition

By using the AF TagDefinition activity, you can retrieve tag definitions from the PI Data Archive server, modify tag definitions, and create new tags into the PI Data Archive 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 Data Archive server, and select what type of operation you want to perform.

The following table lists the fields on the General tab of the AF TagDefinition 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 a PI Data Archive 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 Data Archive server as server type.
Operation No The type of operation you want to perform:
  • getTagDefinitions: retrieves tag definitions.
  • upsertTags: creates or modifies tag definitions.

Description

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

Input

On the Input tab, you can specify the tag that you want to retrieve, modify, or create for the AF TagDefinition activity.

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

Operation Refer To
getTagDefinitions getTagDefinitions: Input Items
upsertTags upsertTags: Input Items

Output

On the Output tab of the AF TagDefinition 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.

The following table lists the output items for the getTagDefinitions and upsertTags operations:

If you select the getTagDefinitions operation, the following output items are available:
Output Item Data Type Description
responseHeader Complex The response message header.
tagDefinitionList Complex The list of tag definitions that match the provided filtering expression returned by the PI Data Archive server.

For descriptions of all the attributes in this item, see Attributes in tagDefinitionList.

If you select the upsertTags operation, the following output items are available:
Output Item Data Type Description
responseHeader Complex The response message header.
failureList Complex A list of tags that are operated in the wrong way.
pointsCreated Integer The number of tags that are successfully created.
pointsModified Integer The number of tags that are successfully modified.

Fault

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

The following table lists the error schema elements on the Fault tab:
Element Name Data Type Description
msg String Displays the error message.
msgCode String Displays the error code.