AF TagEventListener

The AF TagEventListener activity publishes notification messages each time values of the tags that you listen on are changed. Therefore, by using this activity, you can listen on tag updates and fetch the changed entries. Also you can perform registration of tags in bulk or registration from file or registration from AFAttributes. The following sections describe the tabs for this activity.

Note: If an active appnode fails when the application is running in fault-tolerance mode, another passive appnode becomes active. However, during the time required for this switch, some data loss might occur. The data loss might vary depending on the time taken to switch the appnode. To recover the data that was lost during the switch, the AF TagValues activity can be used.

General

On the General tab, you can specify the name of the activity in the process, establish a connection with the PI Data Archive server, select the tags to listen on, define how often the tag updates are to be checked, and perform bulk tag registration.

The following table lists the fields on the General tab of the AF TagEventListener activity:
Field Module Property? Visual Diff? Description
Name No Yes A unique name of the activity in a process.
Server Connection Yes 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 when Enable Tag Registration From AFAttribute is disabled.
  • If Enable Tag Registration From AFAttribute is enabled then PI Data Archive server and PI AF server is supported."
Polling Interval (milliseconds) Yes Yes The polling interval of publishing, which specifies how often in milliseconds the tags in the Tag List are checked for value updates.
Number of Event Count Yes Yes Number of activities that can be processed at the same time in a process.

Default value is 10.

Enable Bulk Registration No Yes Selecting this check box enables registering multiple tags all at once by using wild cards.

The Bulk Registration section on the Advanced tab is enabled only when this check box is selected.

Enable Tag Registration From File No Yes Selecting this checkbox enables use of data from a file to enable register multiple tags all at once.

The Tag Registration From File section on the Advanced tab is enabled only when this check box is selected.

Enable Tag Registration From AFAttribute No Yes Select this check box to fetch tags from AFAttributes.

The Tag Registration From AFAttribute section on the Advanced tab is enabled only when this check box is selected.

Tag List No No The list of tags that you listen on:
  • Add: inserts a new row at the bottom of the list, in which you can type the name of the tag to listen on.
  • Remove: deletes a selected row in the list. When the table is empty, this button is disabled.
  • Add Tags From File: quickly adds multiple tags to the list at a time by loading a .txt or .csv file encoded in ASCII with one tag name per row.

If the tags you listen on, do not exist on the PI Data Archive server, warning messages are displayed in the Console view at run time.

Description

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

Advanced

On the Advanced tab, you can specify the object class of the entry that you want to search for.

The following table lists the fields on the Advanced tab of the AF TagEventListener activity:
Field Module Property? Visual Diff? Description
Sequence Key No No This field contains an XPath expression that specifies the order in which the process runs. Process instances with sequencing keys that have the same value are run sequentially in the order in which the process instances were created.
Custom Job Id No No This field contains an XPath expression that specifies a custom job ID for the process instance. This ID is displayed in the TIBCO Administrator View Service dialog box, and it is also available in the $_processContext process variable.
Bulk Registration Yes No This field enables registration of multiple tags.
The Bulk Registration field contains the following:
  1. Registration Wildcard : Input the regular expression to register tags matching the expression. For example, SINU*.
  2. Registration Tags to File: Input file's fully qualified path. Only .txt file type is supported. All registered tags are listed in this file.
Tag Registration From File Yes No It contains the Tag Registration File field.

This field enables use of data from a file to enable register multiple tags all at once.

Here, provide the fully qualified path with the file name.
Note: Supported file extension is .csv.
Tag Registration From AFAttribute Yes No It contains the Tag Registration From AFAttribute File field.

This field fetches tags from AFAttributes.

Provide the fully qualified path with file name.
Note:
  • Supported file extension is .csv.
  • Client library AF-SDK 2017 R2 must be installed to use Tag Registration From AFAttribute

Conversations

Heart Beat Tag Maximum Attempts is equal to Maximum Number of Reconnect Attempts mentioned in shared resource.

A conversation represents two or more related message exchanges in the same process that are correlated by the BusinessWorks engine. On the Conversations tab, you can initiate a conversation by clicking the Add New Conversation icon .

For more information about how to use conversations, see TIBCO ActiveMatrix BusinessWorks Application Development.

Output

On the Output tab, you can find the published changes of the tag values.

Note: All the timestamps are in UTC time zone.
The changes of the tag values are displayed under the following output items:
Output Item Data Type Description
header Complex The response message header.
serverName String The name of the PI Data Archive server that stores the tag.
tagList Complex The tag value that is changed.

For descriptions of all the attributes in the previous three items, see Attributes in the Output Items.