AF AttributeEventListener

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

Note: If an active app node fails when the application is running in fault-tolerance mode, another passive app node 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 app node

Note: AF AttributeEventListener Activity does not support load balancing.

General

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

The following table lists the fields on the General tab of the AF AttributeEventListener 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 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.
Polling Interval (milliseconds)	Yes	Yes	The polling interval of publishing, which specifies how often in milliseconds the AFAttributes are checked for value updates.
Enable Bulk Registration	No	Yes	Selecting this check box enables registering multiple AFAttributes all at once by using wildcards. The Bulk Registration section on the Advanced tab is enabled only when this check box is selected.
Enable Attribute Registration From File	No	Yes	Selecting this checkbox enables use of data from a file to enable register multiple AFAttributes all at once. The Attribute Registration File section on the Advanced tab is enabled only when this check box is selected.
Attribute List	No	No	The list of AFAttribute that you listen on: Add: inserts a new row at the bottom of the list, in which you can type the name of the AFAttribute 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 AFAttributes to the list at a time by loading a .txt or .csv file encoded in ASCII with one tag name per row. If the AFAttributes you listen on do not exist on the PI AF 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 AttributeEventListener 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 AttributeEventListener 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 AFAttributes. The Bulk Registration field contains the following: Registration Wildcard : Input the regular expression to register AFAttributes matching the expression. For example, SINU*. Registration Attributes to File: Input file's fully qualified path. Only the .txt file type is supported. All registered AFAttributes are listed in this file.
Attribute Registration From File	Yes	No	It contains the Attributes Registration File field. This field enables use of data from a file to enable register multiple AFAttributes all at once. Here, provide the fully qualified path with the file name. Note: Supported file extension is .csv.

Conversations

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 Attribute values.

Note: All the timestamps are in the 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 AFAttribute.
AttributeList	Complex	The AFAttribute value that is changed.

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

Did you find this helpful?

Yes No

Subtopics