Introduction
The Rule Nodes are the building blocks for all rules. They control the logic and actions for each rule. The combination of nodes and associated logic enables you to build powerful rules that can intelligently analyse activity on your site and alert the operator only when required.
All nodes can be configured. Basic nodes, such inputs, only require a name and Id, however others, such as the checks, require more detailed configuration to ensure they are optimised to perform as required. Each node is covered here, including their configuration options.
Contents
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Inputs
Inputs are the first stage in the rule workflow. They provide the initial trigger and the data to be processed by the checks. The three options are:
External Input
A trigger from an external system or digital input.
Time Input
A time based trigger which fires based on a configured interval. This is used to drive scheduled based actions.
Track Sighting Input
A trigger from a track sighting. Each new track sighting creates its own trigger.
Checks
Approach Check
Checks if the track sighting is approaching an Area.
Area: specify the Area from a list of existing Areas.
Check: specify whether the rule is broken when it is greater than or less than the value
Max Distance: a target is not allowed within the specified distance of the Area.
Max Time: atarget is not allowed within the specified time of the Area base on the targets approach speed.
Area Check
Checks if the track sighting has entered an Area.
Check Time: at what time the check is performed.
Now: the current track being evaluated is in the area at this moment in time.
Anytime: the check will evaluate to true if the track has been in that area at any time. This enables us to look historically where a track has been. For example, if you wanted a rule break when a track has moved through area A into area B, then area A would be an anytime check and area B would be a now check. You would use a Boolean Link specified AND to link these Area Check nodes together in the rule logic.
Area: specify the Area from a list of existing Areas.
Area Exclusion Check
Checks if a track has not entered one or more alarm areas.
Selected/Name: select the alarm areas that will not be checked for track sightings.
ATI Check
Checks if the track sighting has originated from an area.
Area: specify the Area from a list of existing Areas.
Breach Line Check
Checks if a Track Sighting has crossed a defined line.
Breach Line: select from a list of existing Breach Lines.
Min Seen: minimum number of track sightings required to confirm that the line is breached.
Reset Time: length of time (s) allowed between track sightings before Seen value is reset.
Breach Line Proximity Check
Checks if an unknown Track Sighting is within a defined distance of an IFF track and a specified classification and is within a certain defined distance of a selected breach line it would be marked as a friend.
Breach Line: select from a list of existing Breach Lines.
Classification for IFF Track: select the desired object from the drop down list.
Classification Check
Checks if the Track Sighting has been classified against a particular model.
Classification: select the desired classification model.
Probability: the probability above which the track sighting has to be
Count Check
Checks if the required number of Track Sightings have occurred within a given time period.
Area: specify the Area from a list of existing Areas.
Count: the minimum number of track sightings required within the time period.
Time Frame: specify the length of the given time period in seconds.
Density Check
Checks if an Area has the required density of Track Sightings within a given time period.
Area: specify the Area from a list of existing Areas.
Density: the minimum and maximum number of tracks in the Area, in the Time Frame, required to satisfy the Density Check.
Time Frame: specify the given time period in seconds.
External Trigger
Checks an external sensor input with debounce.
Debounce Period: ensures that only one digital signal can be registered within this given time.
Filtered Property Check
Check if a property of a Track Sighting meets the defined criteria after previous rule checks have passed.
Property Name: name of property to check on a track sighting
Property Test: select the type of test to perform on the property
Property Check
Check if a property of a Track Sighting meets the defined criteria.
Property Name: name of property to check on a track sighting
Property Test: select the type of test to perform on the property
Proximity Check
Check if the Track Sight is within the given proximity of other sightings.
Use Time: select between Time or Distance:
Proximity Time: specify the number of seconds between tracks.
Proximity Distance: specify the maximum distance (m) between tracks that satisfies the Proximity Check and triggers an action i.e. the ≤ distance between tracks at which they are considered in proximity to one another.
Area: specify the Area from a list of existing Areas.
Radar Check
Check if the Track Sighting was generated by the specified radar.
Rule Broken Check
Checks if the Track has broken any of the selected rules.
Selected/Name: select the rule(s) that will checked to see if a track sighting has broken them.
Rule Disarm Check
Checks an external trigger to disarm the rule.
Trigger Id: the Id of the external trigger's input.
Disarm Timeout (s): the time period, without an external trigger, after a rule has been disarmed before the rule is armed again.
Debounce Period (s): ensures that only one digital signal can be registered within this given time.
Schedule Check
Checks if the track sighting recorded time or time input occurred within the given schedule.
Schedule: one or more schedules to check.
Static Sensor
Checks if the track sighting was generated by the specified sensor.
Debounce Period (s): ensures that only one digital signal can be registered within this given time.
Static Sensor: specify the sensor from a list of existing static sensors.
Allow Notifications: when ticked will cause static sensor to animate in UI when triggered
System Mode
Checks the current system mode.
System Mode: select the desired mode.
Track Tag Property Check
Will return true if any track’s tag is equal to any added tag target name.
Tag Name: add a Tag Name to the Tag Target Names list.
Links
Boolean Link
Checks multiple inputs using the specified logic type. In most computer programming languages, a Boolean data type is a data type with only two possible values: true or false. The values we use are Both, Either or None.
And/Or: a boolean AND or boolean OR operation
Not: a boolean NOT operator
Break Count Check
Checks if the total break count for inputs has exceeded an amount.
Gate Link
Delays input and check passing through to an action for a specified time period.
Time Frame (s): the length of the delay in seconds.
Time Link
Creates a window of time in which checks must be satisfied. Solo checks with an internal Time Frame will render a Time Link null, but multiple checks with an internal Time Frame can feed into a Time Link. A Time Link compares inputs from other checks to ensure that it got a “true” from all the linked checks with the specified time, regardless of Time Frames determining their "true" or "false" outcomes.
Time Frame (s): specify the time frame in which the check must be satisfied.
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 placemarkers 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 set the home position of the camera.
Inactive Home Position: then the input statis inactive set the home position of the camea.
Camera Mode
Modifies the cameras mode.
Camera: specify the camera you wish to use from a list of existing cameras.
Automatic: mode to set on the camera
Action: input will track the input state and set the mode, latched will set the mode once until the input state resets.
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 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: 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 layers 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: role to change the permissions of.
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
| Filter by label (Content by label) | ||||
|---|---|---|---|---|
|