General

Node

This optional parameter is the name of the computer (node name) where the OPC Alarms and Events Server runs. Enter the node name in the text box or use the triple dot button to browse to and select the OPC AE node. When no node is specified, it is presumed by the interface that the OPC AE server is on the interface node. The command-line parameter equivalent is (/NODE=nodename).

Server

This required parameter is the name of the OPC AE Server as registered on the OPC AE server node. The command line parameter equivalent is (/SERVER=servername).

Status tag

This optional parameter is the name of a PI digital tag to receive the status of the OPC AE server. Enter the name of the OPC status tag in the textbox or use the adjacent triple dot button to browse to the status tag. (/ST=tagname).

Area index

This optional parameter is used to specify the index into the vendor specific array that holds the Area name. Some OPC AE servers (e.g. DeltaV) specify the area separate from the source name in the event data. In those cases the element index is needed for event processing.

(/AI=#). If the area index is specified then the area should be part of the source specified in the instrumenttag. The index is the slot position specified by the /evc for vendor specific attributes (i.e. /evc6=6,1,2,3,4,12,13  /ai=4, because 4 specifies the Area and it is in the 4th slot position for specifying vendor specific attributes).

Because some systems have a different number of attributes for each event category the area index should be specified in the same position for each event category (/evc).

Unit index

This optional parameter is used to specify the index into the vendor specific array that holds the Unit name. Some OPC AE servers (e.g. DeltaV) specify the unit separate from the source name in the event data. In those cases the element index is needed for event processing. (/UI=#). If the unit index is specified then the area and unit should be part of the source specified in the instrumenttag. The index is the slot position specified by the /evc for vendor specific attributes (i.e. /evc6=6,1,2,3,4,12,13  /ui=6, because 13 specifies the Unit and it is in the 6th slot position for specifying vendor specific attributes).

Because some systems have a different number of attributes for each event category the unit index should be specified in the same position for each event category (/evc).

Use wildcards

This optional parameter is used to specify whether the wildcard character (“*”) is used in any of the tags configured for use by the interface (/WC).

ByPass Snapshot

This optional parameter is used to specify that the data is to bypass the snapshot and be written directly to the archive. (/ARC)

Refresh Conditional Information from server

This optional parameter is used to request Refresh from the OPC AE server for any conditional data it has in its queue when the interface connects. (/RF)

Communication

Buffer time

This optional parameter is in milliseconds and tells the server how often to send event notifications. The default value of 0 for buffer time means that the server should send event notifications as soon as it gets them. (/BTM=#)

Maximum number of events

This optional parameter is the maximum number of events that will be sent in a single notification. A value of 0 means that there is no limit to the number of events that will be sent in a single callback. (/MXE=#)

Timestamps

Use subseconds

Check this option to use the subsecond portion of the time stamps being passed to PI. By default, the interface will not use subseconds and send only whole integer seconds. This means that PI will require less space, and possibly less CPU time, to store the same amount of data. The fractional part of the second is simply truncated. (Specify /UST to use subseconds, leave blank to discard subseconds)

Timestamp Source

Some OPC AE servers are able to provide the time stamp at which they read data from the device, while others are not. If the server is able to provide valid time stamps, select the ‘OPC AE server provides timestamps’ /TS=Y option in the Timestamps section of the OPCAE tab. Otherwise, the interface will time stamp the data when it receives it. (/TS=x, where x is Y, A, or N)

The preferred setting is /TS=Y. This setting causes the OPC AE server to provide time stamps, and does not adjust them only to localize them to the PI Data Archive. The default setting is ‘Interface provides timestamp’ /TS=N. Use this setting when the OPC server cannot provide time stamps. The Interface time stamps each value as it receives it with the time stamp of the PI Data Archive. Using ‘Adjust to PI Data Archive time’

/TS=A causes the interface to adjust the timestamps to match the time on the PI Data Archive.

Additional Parameters

This text box is included so that any additional parameters not currently support by the ICU Control can be added to the interface. Parameters should be entered into the additional parameters textbox in command-line format with each parameter starting with a “/”character.

Event categories

The Event Categories tab shown below can be used to specify which event categories and event attributes are to be supported. Each row in the list specifies a different event category and its requested attributes.

To add an event category to the list, click the button. Enter the number of the event category in the box provided in the Event category column and hit Enter. Then enter the required attributes separated by commas (for example 1,3,5,7) in the box provided in the Event attribute column. There is a limit of 32 attributes per event category.

To edit an existing event category or attribute click once in the Event category or Event attribute cell to select the entry and click again to activate the text box to edit the entry.

To delete an event category and the associated attributes from the list, select the row by clicking on the number adjacent to the event category row and then click the button. Use the buttons to change the order of the selected event category in the list. (/EVCx=#,#,#,… where x is the event category and # are the event attributes)

For more information on event category configuration see Event Categories.