Events overview
When you add an event-based rule in the Manage Rule wizard, you can select between a number of different event types. In order for you to get a good overview, events you can select are listed in groups according to whether they are:
Hardware:
Some hardware can create events themselves, for example to detect motion. You can use these as events but you must configure them on the hardware before you can use them in the system. You may only be able to use the events listed on some hardware as not all types of cameras can detect tampering or temperature changes.
Hardware - Configurable events:
Configurable events from hardware are automatically imported from device drivers. This means that they vary from hardware to hardware and are not documented here. Configurable events are not triggered until you have added them to the system and configured them on the Event tab for hardware. Some of the configurable events also require that you configure the camera (hardware) itself.
Hardware - Predefined events:
|
Event |
Description |
|---|---|
| Communication Error (Hardware) |
Occurs when a connection to the hardware is lost. |
| Communication Started (Hardware) |
Occurs when communication with the hardware is successfully established. |
| Communication Stopped (Hardware) |
Occurs when communication with the hardware is successfully stopped. |
Devices - Configurable events:
Configurable events from devices are automatically imported from device drivers. This means that they vary from device to device and are not documented here. Configurable events are not triggered until you have added them to the system and configured them on the Event tab on a device.
Devices - Predefined events:
|
Event |
Description |
|---|---|
| Bookmark Reference Requested |
Occurs when a bookmark is made in live mode in the clients. Also, a requirement for using the Default record on bookmark rule. |
| Communication Error (Device) |
Occurs when a connection to a device is lost, or when an attempt is made to communicate with a device, and the attempt is unsuccessful. |
| Communication Started (Device) |
Occurs when communication with a device is successfully established. |
| Communication Stopped (Device) |
Occurs when communication with a device is successfully stopped. |
| Evidence Lock Changed |
Occurs when an evidence lock is changed for devices by a client user |
| Evidence Locked |
Occurs when an evidence lock is created for devices by a client user |
| Evidence Unlocked |
Occurs when an evidence lock is removed for devices by a client user |
| Feed Overflow Started |
Feed overflow (media overflow) occurs when a recording server cannot process received data as quickly as specified in the configuration and therefore is forced to discard some recordings. If the server is healthy, feed overflow usually happens because of slow disk writes. You can resolve this either by reducing the amount of data written, or by improving the storage system's performance. Reduce the amount of written data by reducing frame rates, resolution or image quality on your cameras, but this may degrade recording quality. If you are not interested in that, instead improve your storage system's performance by installing extra drives to share the load or by installing faster disks or controllers. You can use this event to trigger actions that helps you avoid the problem, for example, to lower the recording frame rate. |
| Feed Overflow Stopped |
Occurs when feed overflow (see Feed Overflow Started) ends. |
| Live Client Feed Requested |
Occurs when client users request a live stream from a device. The event occurs upon the request even if the client user's request later turns out to be unsuccessful, for example because the client user does not have the permissions required for viewing the requested live feed or because the feed is for some reason stopped. |
| Live Client Feed Terminated |
Occurs when client users no longer request a live stream from a device. |
| Manual Recording Started |
Occurs when a client user starts a recording session for a camera. The event is triggered even if the device is already recording via rule actions. |
| Manual Recording Stopped |
Occurs when a client user stops a recording session for a camera. If the rule system also has started a recording session it continues recording even after the manual recording is stopped. |
| Marked Data Reference Requested |
Occurs when an evidence lock is made in playback mode in the clients An event is created that you can use in your rules. |
| Motion Started |
Occurs when the system detects motion in video received from cameras. This type of event requires that the system's motion detection is enabled for the cameras to which the event is linked. In addition to the system's motion detection, some cameras can detect motion themselves and trigger the Motion Started (HW) event, but it depends on the configuration of the camera hardware and in the system. See also Hardware - Configurable events:. |
| Motion Stopped |
Occurs when motion is no longer detected in received video. See also Motion Started. This type of event requires that the system's motion detection is enabled for the cameras to which the event is linked. In addition to the system's motion detection, some cameras can detect motion themselves and trigger the Motion Stopped (HW) event, but it depends on the configuration of the camera hardware and in the system. See also Hardware - Configurable events:. |
| Output Activated |
Occurs when an external output port on a device is activated. This type of event requires that at least one device on your system supports output ports. |
| Output Changed |
Occurs when the state of an external output port on a device is changed. This type of event requires that at least one device on your system supports output ports. |
| Output Deactivated |
Occurs when an external output port on a device is deactivated. This type of event requires that at least one device on your system supports output ports. |
| PTZ Manual Session Started |
Occurs when a manually operated PTZ session (as opposed to a PTZ session based on scheduled patrolling or automatically triggered by an event) is started on a camera. This type of event requires that the cameras to which the event is linked are PTZ cameras. |
| PTZ Manual Session Stopped |
Occurs when a manually operated PTZ session (as opposed to a PTZ session based on scheduled patrolling or automatically triggered by an event) is stopped on a camera. This type of event requires that the cameras to which the event is linked are PTZ cameras. |
| Recording Started |
Occurs whenever recording is started. There is a separate event for manual recording started. |
| Recording Stopped |
Occurs whenever recording is stopped. There is a separate event for manual recording stopped. |
| Settings Changed |
Occurs when settings on a device are successfully changed. |
| Settings Changed Error |
Occurs when an attempt is made to change settings on a device, and the attempt is unsuccessful. |
External events - Predefined events:
|
Event |
Description |
|---|---|
| Request Play Audio Message |
Activated when play audio messages are requested via the MIP SDK. Through the MIP SDK a third-party vendor can develop custom plug-ins (for example, integration to external access control systems or similar) for your system. |
| Request Start Recording |
Activated when start recordings are requested via the MIP SDK. Through the MIP SDK a third-party vendor can develop custom plug-ins (for example, integration to external access control systems or similar) for your system. |
| Request Stop Recording |
Activated when stop recordings are requested via the MIP SDK. Through the MIP SDK a third party vendor can develop custom plug-ins (for example, integration to external access control systems or similar) for your system. |
External events - Generic events:
Generic events allow you to trigger actions in the system by sending simple strings via the IP network to the system. The purpose of generic events is to allow as many external sources as possible to interact with the system.
External events - User-defined events:
A number of events custom made to suit your system may also be selectable. You can use such user-defined events for:
- Making it possible for client users to manually trigger events while viewing live video in the clients
- Countless other purposes. For example, you may create user-defined events which occur if a particular type of data is received from a device
See also User-defined events (explained).
Recording servers:
|
Event |
Description |
|---|---|
| Archive Available |
Occurs when an archive for a recording server becomes available after having been unavailable. See also Archive Unavailable. |
| Archive Unavailable |
Occurs when an archive for a recording server becomes unavailable, for example if the connection to an archive located on a network drive is lost. In such cases, you cannot archive recordings. You can use the event to, for example, trigger an alarm or a notification profile so that an email notification is automatically sent to relevant people in your organization. |
| Archive Not Finished |
Occurs when an archive for a recording server is not finished with the last archiving round when the next is scheduled to start. |
| Database Deleting Recordings Before Set Retention Size |
Occurs when the retention time limit is reached before the database size limit. |
| Database Deleting Recordings Before Set Retention Time |
Occurs when database size limit is reached before the retention time limit. |
| Database Disk Full - Auto Archiving |
Occurs when a database disk is full. A database disk is full when there is less than 5GB of space is left on the disk: The oldest data in a database is always auto-archived (or deleted if no next archive is defined) when less than 5GB of space is free. |
| Database Disk Full - Deleting |
Occurs when a database disk is full and less than 1GB space is free. Data is deleted even if a next archive is defined. A database always requires 250MB of free space. If this limit is reached (if data is not deleted fast enough), no more data is written to the database until enough space has been freed. The actual maximum size of your database is the number of gigabytes you specify, minus 5GB. |
| Database Full - Auto Archiving |
Occurs when an archive for a recording server is full and needs to auto-archive to an archive in the storage. |
| Database Repair |
Occurs if a database becomes corrupted, in which case the system automatically attempts two different database repair methods: a fast repair and a thorough repair. |
| Database Storage Available |
Occurs when a storage for a recording server becomes available after having been unavailable. See also Database Storage Unavailable. You can, for example, use the event to start recording if it has been stopped by a Database Storage Unavailable event. |
| Database Storage Unavailable |
Occurs when a storage for a recording server becomes unavailable, for example if the connection to a storage located on a network drive is lost. In such cases, you cannot archive recordings. You can use the event to, for example, stop recording, trigger an alarm or a notification profile so an e-mail notification is automatically sent to relevant people in your organization. |
| Failover encrypted communication error | Occurs when there is an SSL communication error between the failover server and monitored recording servers. |
| Failover Started |
Occurs when a failover recording server takes over from a recording server. See also Failover servers (node). |
| Failover Stopped |
Occurs when a recording server becomes available again and can take over from a failover recording server. |
System monitor events
System monitor events are triggered by exceeded thresholds values configured in the System Monitor Thresholds node. See also View the current state of your hardware and troubleshoot if needed.
This functionality requires that the Data Collector service is running.
System Monitor - Server:
|
Event |
Description |
|---|---|
| CPU usage critical |
Occurs when the CPU usage exceeds the critical CPU threshold. |
| CPU usage normal |
Occurs when the CPU usage falls back below the warning CPU threshold. |
| CPU usage warning |
Occurs when the CPU usage exceeds the warning CPU threshold or falls back below the critical CPU threshold. |
| Memory usage critical |
Occurs when the memory usage exceeds the critical memory threshold. |
| Memory usage normal |
Occurs when the memory usage falls back below the warning memory threshold. |
| Memory usage warning |
Occurs when the memory usage exceeds the warning memory threshold or falls back below the critical memory usage threshold. |
| NVIDIA decoding critical |
Occurs when the NVIDIA decoding usage exceeds the critical NVIDIA decoding threshold. |
| NVIDIA decoding normal |
Occurs when the NVIDIA decoding usage falls back below the warning NVIDIA decoding threshold. |
| NVIDIA decoding warning |
Occurs when the NVIDIA decoding usage exceeds the warning NVIDIA decoding threshold or falls back below the critical NVIDIA decoding threshold. |
| NVIDIA memory critical |
Occurs when the NVIDIA memory usage exceeds the critical NVIDIA memory threshold. |
| NVIDIA memory normal |
Occurs when the NVIDIA memory usage falls back below the warning NVIDIA memory threshold. |
| NVIDIA memory warning |
Occurs when the NVIDIA memory usage exceeds the warning NVIDIA memory threshold or falls back below the critical NVIDIA memory threshold. |
| NVIDIA rendering critical |
Occurs when the NVIDIA rendering usage exceeds the critical NVIDIA rendering threshold. |
| NVIDIA rendering normal |
Occurs when the NVIDIA rendering usage falls back below the warning NVIDIA rendering threshold. |
| NVIDIA rendering warning |
Occurs when the NVIDIA rendering usage exceeds the warning NVIDIA rendering threshold or falls back below the critical NVIDIA rendering threshold. |
| Service available critical |
Occurs when a server service stops running. There are no threshold values for this event. |
| Service available normal |
Occurs when a server service status changes to running. There are no threshold values for this event. |
System Monitor - Camera:
|
Event |
Description |
|---|---|
| Live FPS critical |
Occurs when the live FPS rate falls below the critical live FPS threshold. |
| Live FPS normal |
Occurs when the live FPS rate exceeds the warning live FPS threshold. |
| Live FPS warning |
Occurs when the live FPS rate falls below the warning live FPS threshold or exceeds the critical live FPS threshold. |
| Recording FPS critical |
Occurs when the recording FPS rate falls below the critical recording FPS threshold. |
| Recording FPS normal |
Occurs when the recording FPS rate exceeds the warning recording FPS threshold. |
| Recording FPS warning |
Occurs when the recording FPS rate falls below the warning recording FPS threshold or exceeds the critical recording FPS threshold. |
| Used space critical |
Occurs when the storage used for recordings by a specific camera exceeds the critical used space threshold. |
| Used space normal |
Occurs when the storage used for recordings by a specific camera falls back below the warning used space threshold. |
| Used space warning |
Occurs when the storage used for recordings by a specific camera exceeds the warning used space threshold or falls back below the critical used space threshold. |
System Monitor - Disk:
|
Event |
Description |
|---|---|
| Free space critical |
Occurs when the disk space usage exceeds the critical free space threshold. |
| Free space normal |
Occurs when the disk space usage falls below the warning free space threshold. |
| Free space warning |
Occurs when the disk space usage exceeds the warning free space threshold or falls back below the critical free space threshold. |
System Monitor - Storage:
|
Event |
Description |
|---|---|
| Retention time critical |
Occurs when the system predicts that the storage will be filled up faster than the critical retention time threshold value. For example, when data from video streams is filling up the storage faster than expected. |
| Retention time normal |
Occurs when the system predicts that the storage will be filled up slower than the warning retention time threshold value. For example, when data from video streams is filling up the storage at the expected rate. |
| Retention time warning |
Occurs when the system predicts that the storage will be filled up faster than the warning retention time threshold value or slower than the critical retention time threshold value. For example, when data from video streams is filling up the storage faster than expected due to more motion detected by the cameras configured to record on motion. |
Other:
Events from XProtect extensions and integrations:
Events from XProtect extensions and integrations can be used in the rule system, for example:
- Analytics events can also be used in the rule system