Rule Actions
Introduction
Actions are the final segment of rule configuration. These enable responses to be made when rules are broken, such as creating a notification message, or triggering a camera to follow a target.
Contents
- 1 Actions
- 1.1 Alarm
- 1.2 Area State
- 1.3 Breach Line State
- 1.4 Camera
- 1.5 Camera Home Position
- 1.6 Camera Mode
- 1.7 Change Classification
- 1.8 Change Profile
- 1.9 Colour Change
- 1.10 External Trigger
- 1.11 Folder Action
- 1.12 Hide Entity Action
- 1.13 Layer Action
- 1.14 Message
- 1.15 Permission Action
- 1.16 Rule State
- 1.17 Track HideĀ
- 1.18 Track Status
- 2 Related Information
Actions
Alarm
Generates an alarm.
Priority:Ā Allows you to optionally apply a āweightingā to any rule breaks that invoke an alarm using comparative values.
Severity:Ā Defines how a target should be marked when it breaks a rule and actions an alarm. Such markings allow a target to be easily differentiated.
Add Properties: This section defines how the description will read when an alarm notification pops up. When a rule is broken the text that has been placed into the Description field of the rule is displayed on the operatorās console and is also recorded within the alarm log. This text can be completely static (causing it to give the same message regardless of where, or by what means, the rule was broken). Alternatively, it can also include place-markers that will be replaced by contextual references (when the rule is broken) that may help to pinpoint the nature of the alarm. Select a Check node and then one of its settings/properties to add detail to the description.
Node: Select from the nodes of checks used in the rule.Ā
Property: Select a property from that node you would like to include in the description, then select the add buttonĀ .Ā
Configured Properties: A list of the Node Properties already added. Each is given a code, an 'Arg'. This table functions as a Key for what the 'Args' represent.Ā
Description:Ā Determines the text that will be presented to the operator (and entered in the activity log) when the alarm sounds.Ā Ā Right Click to add an Arg to represent a Node Property. In the example below, Arg0 represents a specific Area, and Arg1 represents the Approach Area Check Node's Distance Property i.e. an approaching person is within 15m of the Area.
User Notification: Determines which users will receive the alarm notifications.
Area State
Enable or disable the selected area.
Enabled: State to set the area to.
Area: Specify the Area from a list of existing Areas.
Action: Input will track the input state and set the output. Latched will set the state once until the input state resets.
Breach Line State
Enable or disable the selected breach line.
Enabled: State to set the area to.
Breach Line: Specify the Breach Line from a list of existing Breach Lines.
Action: Input will track the input state and set the output. Latched will set the state once until the input state resets.
Camera
Creates a camera target.
Camera: Specify the camera you wish to use from a list of existing cameras.
Priority: Allows you to optionally apply a āweightingā to any rule breaks that invoke a camera target using comparative values.
Keep Following: Keep following after the condition clears.
Position Override: Optionally override the camera position to point at a specific entity.
Camera Home Position
Modify a camera home position.
Camera: Specify the camera you wish to use from a list of existing cameras.
Active Home Position: When the input state is active, this sets the home position of the camera.
Inactive Home Position: When the input status is inactive, this sets the home position of the camera.
Camera Mode
Modifies the cameras mode.
Camera: Specify the camera you wish to use from a list of existing cameras.
Operating Mode: Mode to set on the camera.
Automatic: The camera will be controlled automatically by Witness based on the camera and camera group configuration.
Manual: The camera can only be controlled and moved by the operator.
Inactive: The camera will be inactive. This mode will typically be applied to non-thermal cameras at night.
All operating modes are Latched. So, in order to switch to a different mode, there will have to be another action configured to do so within the rule. This would typically be used to switch the modes of daylight cameras between daytime and night.
Change Classification
Changes the classification of a track to the specified classification and sets the probability at 100%.
Classification: The classification the track will be changed to, e.g. Person.
Persists: Select to ensure the track classification does not change in the future.Ā
Change Profile
Apply the selected system profile.
Action: Input will track the input state and set the output, latched will set the state once until the input state resets.
Active Profile: The profile to set the change to.
Colour Change
Change the colour of the selected entity.
Entity: Select the required entity from the drop down list.
Colour: This can be configured to any RGBA colour.
External Trigger
Creates a trigger for an external action.
Output Id: The output of the external object.
Event State: State to set the trigger to.
Action: Input will track the input state and set the output. Latched will set the state once until the input state resets.
Folder Action
Apply an action to the selected folder.
Folder: Specify the folder from a list of existing Folders.
Enabled: State to set the folder to.
Hide Children: Select toĀ render entities within that folder invisible on the PPI.
Action: Input will track the input state and set the output. Latched will set the state once until the input state resets.
Hide Entity Action
Hide a selected item.
Entity: Select the entity to be hidden from the drop down list.
Hide: The check box is not selected by default.
Action: Input will track the input state and set the output, latched will set the state once until the input state resets.
Layer Action
Add or remove a layer from the users listed.
Hide: Select to hide, or remove, the specified layer from the specified users.
Layer: Select the layer to add or remove from those available to the specified users.Ā
Action: Input will track the input state and set the output. Latched will set the state once until the input state resets.
User Names: Specify the user(s) that the layer will be made available to or removed from.Ā
Message
Create a notification message.
Title: The header text of a notification.
Message: The main body of text.
Severity:Ā Defines how a message should be marked.
Icon Image: Icon to use in message notification.
Permission Action
Select to change the roles permissions. Individually select from the options below to determine which permissions will be enabled or leave unchecked to disable.
Role: Specify the role whose permissions are being changed.
Rule State
Enabled or disable the selected rule.
Enabled: Select to enable a disabled rule. Leave unchecked to disable an enabled rule.
Action: Input will track the input state and set the enabled state. Latched will set the enabled state once until the input state resets.
Rule: Specify which rule to enable/disable.
Track HideĀ
Hide a track from the UI.
Track Status
Alter the severity of a track.
Severity:Ā Set how a track should be marked. Such markings allow a track to be easily differentiated.
Related Information
-
Rule Nodes (Witness 4.0)
-
Rule Schedules (Witness 4.0)
-
Scheduled Layer Rule (Witness 4.0)
-
Proximity Rule (Witness 4.0)
-
Rule Examples (Witness 4.0)
-
Multiple Areas Rule (Witness 4.0)
-
Area Movement Rule (Witness 4.0)
-
Area Transition Rule (Witness 4.0)
-
Crowd Rule (Witness 4.0)
-
Enable/Disable Rule (Witness 4.0)