Event configuration

Once the event types with their accompanying event properties are set up, event types can be linked to assets to start configuring the event detection. First select an asset from the asset tree and click Configure event:

Next, the detection mode can be chosen to be either Historian, Schedule, Manual, or External Database. The different detection modes are elaborated belowbelow .

Optionally, a parent event configuration can be given. It is recommended that the parent event configuration is of the same event type as the parent event type configured on the selected event type.

Once created, the event detection of this event configuration can be started or paused (except event configurations with Manual detection mode).

Once the event detection has started for this event configuration, the detected events of this event configuration and their event properties can be found in the Events tab, or in the Events overviewEvents overview. In a similar fashion the logs pertaining to this event configuration can be found in the Logs tab.

A trigger measurement can be used by opting for Historian as the detection mode or a recurring schedule can be used by opting for Schedule as the detection mode.

The historian detection mode works by observing the values of a trigger measurement for a change. Whenever the value of the trigger measurement changes, that timestamp is used to start a new event, along with closing the previously open event on the same timestamp. Take into account, if the new value of the measurement is considered a zero value (depending on the datatype), the previous event will be stopped but a new event will not be created.

Zero values

The values considered as zero values with respect to event detection for each datatype are listed below.

Refresh interval

To prevent the creation of an event with an incorrect start time the event detection will only start creating new events after the first change in value is detected. The refresh interval at which the detection is evaluated can be adjusted by using the refresh interval.

Grace period

To ignore value changes and consequently triggering a new event, a grace period can be configured. If a value changes and subsequently the value changes back to the former value within the grace period, the current event will not be closed and no new event will be started. Thus, the grace period is the time period for which value changes are ignored or can be seen as the minimum time between value changes.

Example historian event detection

An example of the historian detection mode by observing the values of the trigger measurement “BATCH_LABEL”:

This results in the creation of 3 new events:

The schedule detection mode allows for generating events based on a recurring schedule. By means of an RRULE, this event detection can be configured. An RRULE is a recurrence rule which defines a pattern to generate a set of timestamps to setup new events. Their syntax is defined by the rfc5545 standard.

To set up a schedule event detection, add a recurrence rule for generating a set of start timestamps and optionally add another recurrence rule to close the corresponding events. Multiple recurrence rules can be combined for either the start timestamps and/or the stop timestamps. One recurrence rule for the start timestamps is required.

Example schedule event detection

An example of the schedule detection mode to generate a set of start and stop timestamps for new events:

Start rules

Stop rules

This results in the creation of 2 new events per weekday:

For further information on RRULE including a useful GUI to build a recurrence rule, visit RRULE ui .

The manual event detection mode allows for events to be manually started/stopped inside manual entry forms. No further configuration is needed for this detection mode.

The external database detection mode works by querying a database for start and stop times to generate events. External databasesExternal databases can be configured by going to Configuration > External Databases.

The query must return a table with exactly one or two columns, and every column value must be a timestamp. A third column, or a column of any other type, makes the whole detection run fail. The first column should contain the start times of the events, the second column (if it is present) should contain the stop times of the events. If only start times are available in the dataset, the stop time for an event will be based on the start time of the following event. This detection mode has a required refresh interval, given as a duration literal of at least 1s, which determines how often the query runs.

You can use query parameters to narrow down your data selection, which includes the asset metadata. The supported parameter values are CurrentTime, LastEvaluationTime, AssetName and asset metadata keys. For example, given the following database table event_times:

We can create this query to generate events for a specific asset type:

We can create more dynamic queries, based on asset metadata:

If no stop times are available we can omit that column:

By selection an asset in the asset tree and clicking the re-evaluate button in the top right corner, all events underneath that asset can be re-evaluated for the indicated time period. In this way, events can be detected on already existing historian time series data.

Note that this will not overwrite events which have been edited by hand (flagged manual), nor will interfering existing events be deleted unless the option ‘delete previously generated events’ is selected in the re-evaluation popup.

To re-evaluate only one event, see re-evaluate a single eventre-evaluate a single event.

Event configurations can be paused to stop the detection of any future events. This can be done by clicking the "Pause" button in the top right corner of the asset details page. This button will then change to a "Start" button, which can be used to resume the event configuration and start detecting new events.