Events
Overview
The event allows executing actions
based on the combined status of multiple triggers.
An event can be created
without triggers or actions.
This allows monitoring the status of multiple triggers without executing actions,
or enables manual execution of multiple actions.
Base Parameters
Each event has the following base parameters:
| Parameter | Description |
|---|---|
| Name | Name to identify this model |
| Enabled | Indicates if the model is enabled |
| Boolean Operator | Define how the individual Triggers are connected to each other |
| Category | The associated category |
| Description | Additional description |
| Initial Status | Status which is used after initialization |
| Force Actions | If enabled, the associated Actions are executed even if the Trigger value is the same as before |
| Logging | If enabled, this item will create log entries |
| Troubleshooter | If enabled, the troubleshooter is active |
| Last Off Time | The date and time when this Event last had the status Off |
| Last On Time | The date and time when this Event last had the status On |
| Occurrences | Number of times this item has occurred |
| Paused state | If set, prevents the execution of the associated Actions until the pause until time is reached |
| Sequence Number | The unique sequence ID of this item. Used for the Ember+ provider OID. |
| Severity | The associated Severity |
| Status Code | The current status code |
| Status Message | The current status message |
| Status | The current status |
The boolean operator affects the event logic.
If you choose AND, all triggers linked with this event need to be active
for the event to switch to On,
whereas only one of the triggers needs to be active when you select OR.
Triggers
You can add as many triggers to one event as you like. They are logically combined by the boolean operator set in the event.
When adding a trigger to an event, you can configure the following parameters:
The option negate negates the trigger (logical XOR):
| Trigger Status | Negated | Status in Event |
|---|---|---|
| 0 | 0 | 0 |
| 0 | 1 | 1 |
| 1 | 0 | 1 |
| 1 | 1 | 0 |
Some examples of trigger states are:
| Trigger Status | Description |
|---|---|
| Unknown | Trigger status is unknown |
| Off | Trigger is off (condition not matched) |
| On | Trigger is on (condition matched) |
| Failed | Trigger has failed (e.g. lost connection, internal error) |
| Initialized | Trigger has been initialized by Broadcast Suite Core, but no data has been received so far |
| Initialization failed | Trigger initialization has failed (e.g. due to missing parameters, invalid configuration) |
| Disabled | Trigger has been disabled by user |
See a full list of all possible trigger states in the Status section of the Data Types page.
Actions
When an action is added to an event, the following parameters can be defined:
| Parameter | Description |
|---|---|
| Sort Index | Indicates in which order the actions should be executed. Actions will be executed sequentially in the ascending order of this index. The top-most action will be executed first. |
| Event Transition | Indicates after which transition the action should be executed |
| Suppress Action on First Falling Edge | Prevents the action from being executed when the event transitions to the Off state for the first time after the event has been initialized.This setting is useful to suppress actions when the Off state is the expected default. |
| Wait time before executing the action | The time in milliseconds to wait before executing the action. If defined, it must be at least 20 ms. |
| Wait time after the action has been executed | The time in milliseconds to wait after an action has been executed. The event waits after the execution of the action regardless if the action was successful or not. Even when the action fails, the event will still wait the specified time. If defined, it must be at least 20 ms. |