Internal Event Stream

The Internal Event Stream object is used in conjunction with the Alarm Generator object to catch, display and historize events generated upon the value change of a boolean data type I/O item located on an OPC server. They can be created beneath OPC Classic and UA Datasources objects and can be added to the Event View display. The object can be configured to filter by event type and severity.

Quick Configuration

Before configuring the Internal Event Stream object you need to add a Connector object below the Core and have a OPC Classic or UA server installed on the same host machine as the Connector service (for testing or training purposes, you can install a simulation OPC server).

Then, follow the instructions on how to configure an Alarm Generator object.

  1. Right click on the OPC Classic or UA Datasource object and select Admin  New  Event  Internal Event Stream from the context menu to open the Create Object wizard.

    OPC Classic Servers are automatically discovered by the Connector so if one is installed it should be visible below the Connector object in the I/O Model. You will need to enable the Datasource object by selecting it and pressing F9. If using an OPC UA server, follow the instructions on how to connect to an OPC UA Datasource
  2. Give the object a unique name and enter a description if necessary. Select the Event Historization checkbox to ensure that all events are archived.

  3. The Archive Selector property allows you to select the data store which the events are archived. Users can select the System Event (A&E) Data Store or All Event Stores (this means the data will be stored in any custom event stores that exist in the tree above the object AND the System Event (A&E) Data Store). Any other event data stores or Generic Event Buffer objects that have been configured in the Core Data Store Sets table property will also be available for selection here.

  4. Click Create to create the object in the I/O Model.

  5. Select the newly created Internal Event Stream in the I/O Model and go to the Object Properties panel and open the OPC A&E Filter Options property compound. These options allow you to enable server side filtering on Event Type and Severity. To enable server side filtering, first check the User Server Side Filters checkbox and then choose one or more of the Event Type filters. Click Apply to confirm the changes.

    The Event Type filters are options to filter out those chosen event types, meaning they will not be caught by the Event Stream object. For example, if the Filter Simple Events checkbox is selected then Simple event types will not caught, displayed or historized in the event stream object.
  6. You can also filter out events based on Severity by selecting a Severity range using the Severity filter from and Severity filter to properties. Click Apply to apply the filter.

    The Severity filter will filter out any severities that are are not within the configured range. Therefore, if a range of "500" to "1000" is selected, all LOW severity events will be filtered out and not caught, displayed or historized by the Event Stream object.
  7. Incoming events from the Alarm Generator (excluding any filtered events) are displayed in the A&E Faceplate of the Object Properties panel.

  8. To open an Event View display, click on an event in the A&E Faceplate to automatically open add that Event Stream object in a display. Alternatively, an Event View display can be opened (shortcut Ctrl+E)and the Internal Event Stream object can be added via drag and drop.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Event Historization

This setting defines whether a certain Event Stream shall historize raw events.

Archive Selection

Select default archive of the master core or a custom set of data stores.

A&E Routing Information

A&E Routing Information.

Attachments

File attachments stored in MongoDB file store.

OPC A&E Filter Options

This property group holds all settings to be used for server-side filtering.

Use Server-Side Filters

When switched on, this option allows you to collect only a subset of the A&E data from the server to which the event stream object is connected. Please be aware that the support for server-side filtering varies heavily from vendor to vendor and system to system.

A&E Filter Event Type

A&E event type filters as defined by the OPC standard.

  • Filter Simple Events: If switched on, simple events (OPC_SIMPLE_EVENTS) will be filtered by the server and not acquired by the EventStream object.

  • Filter Condition Events: If switched on, condition events (OPC_CONDITION_EVENTS) will be filtered by the server and not acquired by the EventStream object.

  • Filter Tracking Events: If switched on, tracking events (OPC_TRACKING_EVENTS) will be filtered by the server and not acquired by the EventStream object.

Severity Filter From

This is the lower bound of A&E severities which shall be acquired by the stream object. According to the OPC specification values between 1 and 1000 are valid event severities. The given value is inclusive.

Severity Filter To

This is the upper bound of A&E severities which shall be acquired by the stream object. According to the OPC specification values between 1 and 1000 are valid event severities. The given value is inclusive.

Auxiliary State Management

Configurable settings for auxiliary state management.

Strategy

Specifies how auxiliary state changes are handled.

  • Inherit: Inherit the setting from the parent object. In case of no parent object, the "Persist" mode is used.

  • Persist: All object auxiliary states are indicated and persisted to the archive.

  • Volatile: Auxiliary state changes are volatile and not persisted.

  • Inhibit: Inhibit all auxiliary state changes.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.