Skip to content

Event Rules#

🔒 Administration.EventRules

🔒 EventRule.Show

Overview#

Event Rules provides a set of standard Alarm Management Notifications for different events taking into account the Entity Type and its related Operation. It provides you with the ability to configure standard notifications using only configuration and out-of-the-box features.

An Event Rule represents an asynchronous alarm that automatically triggers actions of type Notification or Rule.

If the Action Type is Notification the Event Rule has a user defined severity and it can target a specific Employee, Everyone or Role. It is also possible to configure the type of tracking and clearance, which can be of three types:

  1. Automatic - the system will clear the notification automatically once the Valid To date is reached.
  2. Manual Every User - every Employee must clear the notification. In this case, a Valid To date must be set.
  3. Manual Single User - the first Employee that clears the notification will close it.

Additionally, the GUI will display the number of notifications in a notification icon in the status bar. The different severities, colors and display behaviors are configured in the Generic Table NotificationSeverity.

If the Action Type is Rule, the Scope must be defined as Event Rule. Moreover, the system will automatically call and execute the Rule when the event and condition is detected.

Info

The Event Rules Entity is part of Alarm Management, which is a Critical Manufacturing optional module.

Info

You must have an Employee object associated to be able to use Event Rules.

Data Model#

graph TD
    Main[Event Rule] --- A1[Event Rule Action]

classDef mermaid_title color:#000, fill:#fafafa, stroke:#fafafa, stroke-width:0x, font-size:100%, font-weight:200;
classDef mermaid_start color:#000, fill:#fafafa, stroke:#fafafa, color:#fafafa, stroke-width:0x, font-size:100%, visibility: hidden;
classDef mermaid_businessdata color:#000, fill:#65CDE8, stroke:#65CDE8, stroke-width:0px, font-size:100%;
classDef mermaid_nonbusinessdata color:#000, fill:#B7DEE8, stroke:#B7DEE8, stroke-width:0px, font-size:100%;
classDef mermaid_entity color:#000, fill:#FB9F53, stroke:#FB9F53, stroke-width:0px, font-size:100%;
classDef mermaid_entitylinked color:#000, fill:#FCD5B5, stroke:#FCD5B5, stroke-width:0px, font-size:100%;
classDef mermaid_context color:#000, fill:#B9CDE5, stroke:#B9CDE5, stroke-width:0px, font-size:100%;
classDef mermaid_optional color:#000, fill:#B7DEE8, stroke:#65CDE8, stroke-width:1px, font-size:100%, stroke-dasharray: 5 5;
class Main mermaid_entity
class A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12 mermaid_businessdata
class L1,L2,L3,L4,L5,L6 mermaid_entitylinked
class C1,C2,C3,C4,C5,C6 mermaid_context
class N1,N2,N3,N4,N5,N6 mermaid_nonbusinessdata

Image: Event Rules Data Model

Sequence Of Steps#

The necessary steps for correctly configuring and using an Event Rule is the following:

  1. Create the different notification types and severities in the Lookup Tables NotificationType and NotificationSeverity.
  2. Configure the different severities in the Generic Table NotificationSeverity.
  3. Create the different rules with the Scope defined as Event Rule (configured in the RuleScope Lookup Table). For more information, see Create Rule.
  4. Create the Event Rule.

Available Pages#

Dive into the pages below to explore more about Event Rules:

Main Page#

Generic Operations#

Specific Operations#