.. _dr.events:

=============
Review Events
=============

Events are created when specific predefined conditions for tag values or quality are met. For more information about the functionality of events, see :ref:`events`.

Prerequisites
*************

To enable the system to create events when specific conditions are met, the required configurations must have been performed as described in :ref:`conf.evn.events`.

Active Events
*************

An active event is an event that meets the criteria below:

* If the condition that raised the event still currently exists, the event is considered 'active'. For example, if an event had a condition to check if a temperature was greater than 100°F, and the measured temperature remains above 100°F, the event will still be considered active. It will stay active until the measured temperature drops below 100°F.
* If an event requires user acknowledgement (requirement set up in event configuration), the event will be considered active if the user has not acknowledged it. Therefore, an event will be considered active until both the condition that raised the event is no longer active and the user has acknowledged it.

Review Active Events
--------------------

You can see the list of active events on the **Active Events** pane, which you can access in one of the following ways:

* Navigate to :menuselection:`Settings --> Events` from the Navigation sidebar.
* Click on the Events indicator at the top of the screen.

.. image:: images/dr.events.png

|

You can review event data in the following columns on the grid:

.. list-table:: 
   :widths: 1 5
   :header-rows: 1
   :class: tight-table

   * - Field
     - Description
   * - **Action**
     -  If the event requires acknowledgement and hasn't been acknowledged, you can use the **Acknowledge** button in this column to acknowledge the event. For more information, see :ref:`dr.events.acknowledge`.
   * - **Acknowledged**
     - Shows if the event has been acknowledged. If the checkbox is selected, it indicates that the event has been acknowledged; if not, the checkbox will be deselected.
   * - **Active**
     - Indicates if the event is still active based on its condition. If the checkbox is selected, it means the condition is still occurring. If the checkbox is deselected, the condition no longer exists. If the event requires acknowledgement and hasn't been acknowledged, it will still appear in the **Active Events** pane.
   * - **Message**
     - Shows the static message text configured to describe the event.
   * - **Conditional Tag**
     - Shows the tag used in the event's conditions.
   * - **Tag**
     - 
   * - **Start Time**
     - Shows the time the event was raised, marking the start time of the event.
   * - **Conditional Type**
     - Indicates the type of event, either *Limit* or *Stale*.
   * - **Last Time Checked**
     - Shows the last time the event was scanned by the Events service to check if the condition is still true.
   * - **Reason Code**
     - Provides the reason code entered during the acknowledgement process.
   * - **Comments**
     - During acknowledgement, you can enter comments about the event. This column displays those comments.
   * - **Edit Reason**
     - You can use the |edit| button in this column to update the reasons or comments if something changes about the event or acknowledgement process.


.. _dr.events.acknowledge:

Acknowledge Active Events
-------------------------

To acknowledge an event, follow the steps below:

1. On the **Active Events** pane, find the event that you want to acknowledge.
2. In the **Action** column of the relevant event, click the **Acknowledge** button.
3. In the **Acknowledge Event** dialog, select a Reason Code, an Action Code, and enter any comments as required.
4. Click **Acknowledge**.

   ..  admonition:: Result 
       
       The event disappears from the **Active Event** pane in case the condition is not true anymore and gets added to the **Event History** pane. The status of the event is changed to closed.


Update Reason, Action Code, Comments
------------------------------------

You can update the reason code, the action code and the comments for any existing events as follows:

1. On the **Active Events** pane, find the event that you want to update.
2. In the **Edit Reason/Comments** column of the relevant event, click the |edit| button.
3. In the dialog that pops up, update the Reason Code, Action Code or the comments as required.
4. Save your entries.

Historical Events
*****************

Once an event is no longer active, it will be placed into the historical events list on the **Event History** pane. You can find this pane by navigating to :menuselection:`Settings --> Events --> Event History` from the Navigation sidebar.

.. image:: images/dr.event.history.png

|

The **Event History** pane is similar to the **Active Events** pane, but with some key differences:

* This page only shows events that have been completed, meaning the condition is no longer true and the event has been acknowledged (if required).
* This page shows the end time and event duration since this information is available once the event condition is no longer true.
* The **Event Type** column shows the type of event as categorised by the user.


.. |edit| image:: images/icon.edit.png