04 - Glossary of Terms
General Terminology
Term Name | Category | Description | Example or Graphic |
---|---|---|---|
Streaming Protocol | Streaming Protocols - Header |
|
|
Real-Time Streaming Protocol (RTSP) | Streaming Protocols | Real-Time Streaming Protocol (RTSP) is a streaming protocol used to stream media content across a network. This protocol was designed to control video and audio streams without downloading media files, typically for fixed sites and CCTV security cameras. The benefit of RTSP is very low latency, however, it requires a very stable network connection. Commonly support video codes include h.264 and h.265. Common audio codes include AAC and mp3. The RTSP protocol supports low-latency streaming but is not compatible with most devices and browsers. It can deliver low-latency streaming to a select group of small audiences from a dedicated server, making it a standard for video surveillance and CCTV systems. Pros
Cons
Common stream url format; rtsp://ip-address:554/descriptor or rtsp://192.168.10.101:554/live. |
|
Real-Time Messaging Protocol (RTMP) | Streaming Protocols | Real-Time Messaging Protocol (RTMP). RTMP is a legacy protocol developed by Adobe to transfer audio and video files between a streaming server and the Adobe Flash Player. Due to its ability to stream over unreliable connections, such as cellular, it’s popular for streaming from users cell phones, action cams, or drones, directly to social media sites. Pros
Cons
|
|
HLS | Streaming Protocols | HTTP Live Streaming (HLS) |
|
MPEGTS or MPEG-TS | Streaming Protocols |
|
|
MPEG-DASH | Streaming Protocols |
|
|
WebRTC | Streaming Protocols | WebRTC is an open-source project that delivers video streams to viewers with real-time latency. Initially developed for text-based chat apps and VoIP usage, its popularity has grown among video chat and conference app developers after being purchased by Google. The WebRTC protocol is a low-latency streaming solution that relies on peer-to-peer streaming (P2P); it is utilized by some of the most used apps like Google Meet, Discord, Houseparty, WhatsApp, and Facebook Messenger. |
|
Codec | Codecs - Header | A codec is a hardware- or software-based process that compresses and decompresses data. Codecs are used in applications to play and create media files for users, as well as to send media files over a network. The term is a blend of the words coder and decoder, as well as compression and decompression. Codecs compress -- or shrink -- media files such as video, audio and still images in order to save device space and to efficiently send those files over a network. A codec takes data in one form, encodes it into another form and decodes it at the egress point in the communication session. Codecs are made up of an encoder and decoder. |
|
H.264 | Codecs - video |
|
|
H.265 | Codecs - video |
|
|
Advanced Audio Codec (AAC) | Codecs - audio |
|
|
Apple Lossless Audio Codec (ALAC) | Codecs - audio |
|
|
Waveform Audio File Format (WAV) | Codecs - audio |
|
|
Compression |
|
|
|
Onvif |
|
|
|
Onvif Profile |
|
|
|
VMS |
| Video Management System. A Video Management System (VMS) is a software-based platform that is generally used to manage and control video surveillance cameras, recording devices, and other security components. |
|
On-Premise |
| Aka On-Prem. |
|
Cloud |
|
|
|
Bandwidth |
|
|
|
Bitrate |
|
|
|
Time to Live (TTL) |
| TTL refers to a value set in the header of an Internet Protocol (IP) packet that tells network devices the maximum number of router hops the packet can make before it is discarded. |
|
Cluster |
|
|
|
Kubernetes (K8) |
|
|
|
Edge Computing |
|
|
|
VideoNext Terminology
Term | Description | Pic (if relevent) |
---|---|---|
Avatar | Edge device installed on customer location for processing and storing streams. A key component in videoNext architecture. |
|
Stream |
|
|
Software Button and Field Definitions
Action Name - An action is related to any buttons that will exist on a given page.
Field Name - A field is where you can enter custom inputs.
Option Name -
Column Name - This is used for names of columns in a table
Devices
Cameras
Action Name | Description |
---|---|
Add | Add a new camera. Or. Duplicate an existing camera. |
Discover | Search for RTSP cameras, streams, sources on the network. Must be on the same subnet (IE 192.168.100.xxx). |
Import | Bulk import multiple cameras at once by filling out the example .CSV file and uploading it. |
Configure | Edits the camera’s configured settings. |
Analytics | Edits the camera’s linked analytics settings. |
Delete | Removes the camera from the system. |
Device Properties Tab
Field Name | Description | |
---|---|---|
Destination |
| Destination for connecting camera. Options include Edge device or remote server for cloud direct (if not using an edge device). |
Avatar |
| Select the Avatar (edge device) the camera will be add to |
Name |
| Input a name for the camera. Special Characters are allowed. Spaces are allowed. Maximum 256 characters, however, we recommend limiting to 50 characters or less. We recommend using a naming convention for all cameras, to keep things consistent. |
State |
| Set the camera state, on or off. Camera state can be toggled on/off at anytime. |
Location |
| Enter the general location that the camera is physically set. (IE Office_Backroom) |
Zone |
| Creating a zone allows to group cameras together based on criteria, most likely their location. Each camera can only be assignIPed to one zone. Allows for credentialing and access management. |
Config Via |
| Choose the method to ingest the camera stream. |
Camera IP/Host |
| IP address of the camera/device. (IE 192.168.100.115). |
HTTP Port |
| HTTP port the camera or sensor is set to use (set on the camera side configuration). Port 80 is used by most manufactueres by default. |
RTSP Port |
| RTSP port the camera or sensor is set to use (set on the camera side configuration). Port 554 is used by most manufactures by default. |
Username |
| Enter the username associated with the camera. |
Password |
| Enter the password associated with the camera |
Media Tab
Option Name | Description |
---|---|
Force RTP over TCP | Generally do not select this option. The default of RTP over UDP is typically fine, unless you see issues like broken streams or dropped frames. Then, try TCP to see if it helps. This option changes the network protocol used for streaming media from RTP over UDP to RTP over TCP. By default, media streams use UDP as it allows for faster delivery of data. UDP is one way, fire-and-forget, across the network (network layer). This allows highest performance, but sometimes at the tradeoff of reliability. RTP over TCP ensures delivery and ordering of packets (network layer) at every hop in the network. This increases reliability of a media stream, however, comes at the cost of a slight delay/lag (typically 0-0.5 seconds, but can be up to 1 second delay). |
Follow RTP time | Selected by default. It’s recommended to have RTP sources (cameras) synced to an NTP source (IE pool.ntp.org) to maintain accurate timesync. Follow RTP time will then be able to accurately and smoothly stream video. If the RTP source (cameras) are unable to set accurate timesync, it's recommended to de-select Follow RTP time. Otherwise, video will be behave abnormal (objects will jump around in the scene erratically). |
Storage Tab
Option Name | Description |
---|---|
Storage Pool | Select your desired storage (archive) length for this device. |
PTZ Tab
Option Name | Description |
---|---|
Enable PTZ | If the camera supports PTZ (Pan-Tile-Zoom) function, it can be enabled here. PTZ must also be enabled on the camera-side. |
GIS
Field Name | Description |
---|---|
Lat (Latitude) | Input the latitude of the camera’s physical location. These coordinates will display on the maps widget. |
Lng (Longitude) | Input the longitude of the camera’s physical location. These cordinates will display on the maps widget. |
Sets
Action Name | Description |
---|---|
Assign Sets | This button gives the option to assign Sets to the individual camera |
Analytics Tab
Field Name | Description |
---|---|
Device Name | The field will populate with the cameras name |
Stream | The stream/onvif profile that is in effect |
Event Type | INFO - A passive event that is recorded. No actions necessary when triggered. Will be recorded in event log. |
Acknowledge Required | This toggle enables/disables whether an alert needs to be acknowledged when triggered |
Analytic Name | Description |
---|---|
Motion Detector | Analytic feature that monitors for any scene change or activity. Zones can be set (drawn on scene). |
Face Recognizer | A NIST certificated face recognition analytics feature. Ability to detect all faces in a scene, and create whitelisted/blacklisted matches by uploading photos of persons of interest. Additional features include; gender estimation, age estimation, and emotion estimator. Supports both CPU and GPU acceleration. |
Intrusion Detector | Full featured analytic library for detecting and classifying objects, custom tripwires and geofences, speed and direction filters, zones, counting, object left behind, and more. Hundreds of user-definable filters. |
Motion ALPR | Vehicle license plate recognition. Requires cameras properly positioned and calibrated to view vehicle license plates (from over 200 countries in respective languages). Additional features include identify vehicle make, model, color. Ability for Whitelisting/blacklisting vehicles of interest. (vehicle make, model, color first requires accurate license plate detection). |
Object Tracker AI | Object detection of over 80 everyday items including people, vehicles, backpacks, cellphones, animals, etc. Includes maritime ship (commercial vessel) detection, and weapons detection. |
QR Detector | An R&D project for scanning Quick Response (QR) codes using any camera source. QR Code can be linked to any URL of file of user’s choice. Possible use case for warehousing, logistics, pallet management, inventory management. |
TF Detection | Niche high end face recognition with the highest NIST rating on the market. |
VAX ALPR |
|
Statistic Tab
Column Name | Description |
---|---|
Name | Name of the analytic in use. |
Status | Whether the analytic is Online or Offline. |
Uptime | Uptime of the analytic feature. |
Restarts | How many times the analytic has restarted. |
Requested FPS | Frames Per Second (FPS) requested for the analytic model to analyze. Example, camera stream is viewing at 30 FPS, however, the analytic feature is set to analyze 10 FPS to conserve system sources. |
Avg Latency | need confirmation |
Events per sec | analyzed events per second? |
Metadata, bps |
|
Sensors
Action Name | Description |
---|---|
Add | Add a new sensor. Or. Duplicate an existing sensor. |
Configure | Edits the sensor’s configured settings. |
Delete | Removes the sensor from the system. |
Sensor Properties Tab
Field Name | Description |
---|---|
Destination | Destination for connecting sensor. Options include Edge device or remote server for cloud direct (if not using an edge device). |
Avatar | Select the Avatar (edge device) the sensor will be add to. |
Name | Input a name for the sensor. Special Characters are allowed. Spaces are allowed. Maximum 256 characters, however, we recommend limiting to 50 characters or less. We recommend using a naming convention for all sensors, to keep things consistent. Example Naming Convention:
|
State | Set the sensor state, on or off. Sensor state can be toggled on/off at anytime. |
Location | Enter the general location that the sensor is physically set. (IE Office_Backroom) |
Zone | Creating a zone allows to group sensors together based on criteria, most likely their location. Each sensor can only be assigned to one zone. Allows for credentialing and access management. |
Category | Select the type of sensor being added. |
Model | Select the model/make of the sensor |
Sensor IP/Host | IP address of the sensor. (IE 192.168.100.115). We recommend using an overall schema for setting sensor IP addresses. Use either static fixed on the sensor, or static DHCP leases set on our router. We HIGHLY discourage DHCP. |
HTTP Port | HTTP port the camera or sensor is set to use (set on the camera side configuration). Port 80 is used by most manufactueres by default. Check the device advanced network settings to verify. On more complex customer networks, the camera sits behind a firewall and uses custom port forwarding. |
Username | Enter the username associated with the sensor. |
Password | Enter the password associated with the sensor. |
Events Tab
Option Name | Description |
---|---|
Assign Events |
|
Witnesses Tab
Option Name | Description |
---|---|
Assign Cameras |
|
GIS Tab
Field Name | Description |
---|---|
Lat |
|
Lng |
|
Sets
Option Name | Description |
---|---|
Assign Sets |
|
Gateways
Action Name | Description |
---|---|
Add | Add a new gateway. Or. Duplicate an existing gateway. |
Configure | Edits the gateway’s configured settings. |
Delete | Removes the gateway from the system. |
Gateway Properties Tab
Field Name | Description |
---|---|
Avatar | Select the Avatar (edge device) the gateway will be add to. |
Name | Input a name for the gateway. Special Characters are allowed. Spaces are allowed. Maximum 256 characters, however, we recommend limiting to 50 characters or less. We recommend using a naming convention for all gateways, to keep things consistent. |
State | Set the gateway state, on or off. Gateway state can be toggled on/off at anytime. |
Location | Enter the general location that the sensor is physically set. (IE Warehouse_Garage) |
Gateway IP/Host | IP address of the gateway. (IE 192.168.100.115). We recommend using an overall schema for setting gateway IP addresses. Use either static fixed on the sensor, or static DHCP leases set on our router. We HIGHLY discourage DHCP. |
Port | Port the gateway device is using or set to. Often port 8080. |
HTTP Secured | HTTP (secured = no). HTTPS (secured = yes). |
Gateway type | Select the type of sensor being added. |
Gateway Authentication Tab
Field Name | Description |
---|---|
Gateway login | Enter the username associated with the gateway. |
Gateway pass | Enter the password associated with the gateway. |
OIDC token | Authentication token/key associated with gateway (if applicable). |
Directories |
|
Devices Tab
Field Name | Description |
---|---|
Id | Device ID |
Name | Device Name |
Assigned Cameras | The cameras assigned to be associated with the specific gateway device or sensor. |
Events Tab
Field Name | Description |
---|---|
Show Mapped Events Only |
|
Id | Event type ID number |
Name | The name of each type of gateway event is discribed with different states. |
Assigned Event Type | Choose whether the event type triggers an alert or is stored as info. |
Avatars
Action Name | Description |
---|---|
Configure | Edits the Avatar’s configured settings. |
Column Name | Description |
---|---|
Name | Name of each of the Avatars (Edge devices). |
Version | The Avatar software version currently on the device. |
Uptime | How long the Avatar has been in operation. |
Status | Whether the Avatar is Online or Offline. |
Connection Status | Whether the Avatar is connented to the network. |
IP Address | The IP address of the Avatar device. |
Devices | A count of how many devices are connected to the associated Avatar. |
Avatar 1/7 Properties Tab
General
Field Name | Description |
---|---|
Name | Input a name for the Avatar. Special Characters are allowed. Spaces are allowed. Maximum 256 characters, however, we recommend limiting to 50 characters or less. We recommend using a naming convention for all Avatars, to keep things consistent. |
Status Update Interval | The time interval that the system will check if the Avatar device’s status each time. |
Local Media Streaming | Enables/disables the ability to stream local feeds on the network. |
Video Wall Video Streaming Mode | Select whether the system will stream feeds to video walls locally or auto selects between local/cloud. |
Enable Video Analytics Auto Update | Enables analytics packages to be downloaded initially, and continue to pull regular updates. Packages are very large (2GB or more) each, so initial update will take some time, depending on connection speed. |
Status | Whether the Avatar is Online or Offline. |
Connection Status | Whether the Avatar has network connectivity to the cluster. |
DS Running State | DS (Display Server). If DS is currently on or off. |
DS Configured State | DS (Display Server). Enabling activates the current Avatar as a Display Server. This allows the video outputs (VGA, DisplayPort, HDMI, etc) to display video feeds, which can be managed remotely. |
Last Status Update | States when was the last time the system’s status was checked. |
Local IP Address | The Avatar device’s IP Address. |
Devices | Lists the devices presently linked to the Avatar and each of their status. |
Avatar Load | Avatar system resources in use (cpu and memory). Number of connected video streams, number of analytics, and software updates will impact the Avatar Load. We generally recommend a load % to be 80% of less during steady-state. |
Avatar Delivery Queue (Scheduled + Delivery Requests) | If connectivity to the cluster is lost, the Avatar will remain recording locally. When connection is regained, the delivery queue is the user selected priorities for re-syncing feeds to the cloud archive. |
Expected Time To Upload Delivery Queue | Estimate to upload/deliver entire upload queue. |
Software Version | Displays the current software version running on the Avatar device. |
VAE Updates | VAE (Video Analytics Engine) Updates. Displays the log and status of analytics packages downloaded to the Avatar. |
Object ID | Avatar Object ID. Each avatar has a unique ID when registering with the cluster. |
API key | API Key. Create. Generates an API Key to authenticate with the Avatar for custom API integrations. |
Storage
Field Name | Description |
---|---|
Local Storage Volume | The total available storage available on the Avatar’s storage disk(s). |
Free | How much storage is free on the Avatar’s storage disk(s). |
Required Volume | Amount of storage required to meet local storage requirements for all connected cameras/sources, based on user configured storage pools. |
Local Storage | Enabling and configuring the local hard drive(s) storage availability and location. |
Channel
Field Name | Description |
---|---|
Channel Turnaround Time | Round-trip turnaround time from the Avatar to the Cluster (host), Cluster to respond, and return to the Avatar. |
Packet Arrival Jitter Time | Jitter between Avatar and Cluster (host). Network jitter is a variance in latency, or the time delay between when a signal is transmitted and when it is received. This variance is measured in milliseconds (ms). |
Upload Bandwidth Cap (Mbps) | Set the maximum amount of bandwidth for the Avatar. If left blank, no cap will be used. |
Channel Benchmark | Speedtest between Avatar and the cluster (host). This will allow the Avatar to best prioritize upload bandwidth allocations. |
Maintenance
Field Name | Description |
---|---|
Platform | Displays the OS version, processor type, and core count of the Avatar device. |
Update History | The record of updates the Avatar device has recieved. |
Uptime | How long the Avatar device has been running. |
Support Terminal | For administrators or advanced users only. This will open a command line interface to the Avatar. |
Avatar 2/7 Camera Tab
Action Name | Description |
---|---|
Add | Add a new camera or duplicate an existing camera to the Avatar. Camera setup |
Discover | Search for RTSP cameras, streams, sources on the network. Must be on the same subnet (IE 192.168.100.xxx). |
Import | Bulk import multiple cameras at once by filling out the example .CSV file and uploading it. |
Column Name | Description |
---|---|
Actions | These are different actions that can be performed for each device entry. Configure: Edits the device’s preferences Analytics: Edits the device’s assigned analytic preferences Delete: Removes the device from the system/Avatar |
Name | The name assigned to each device. |
Zone | The Zone the device is assigned to. |
Location | Where the device is physically located. |
State | Whether the device’s operation is On or Off. |
Health Status | States if the camera is in working order or not. |
Bitrate, Mb/s | Bitrate is the amount of data transmitted in an audio/video stream, affecting quality and requiring a balance for optimal viewing without buffering. (Example: A medium quality stream will be aprox 2500 kb/s or 2.5 Mb/s). |
FPS | The average or set Frames Per Second the camera captures. Most video streams appearing smooth will range between 24-30 fps. |
GOP - (Group of Pictures) | Related to both video frames per second (fps) and compression. |
Codecs | The type(s) of compression codecs used for video streams. |
Picture Size | The resolution set for each camera’s stream. |
Avatar 3/7 Sensors Tab
Action Name | Description |
---|---|
Add | Add a new sensor or duplicate an existing sensor to the Avatar. Sensor setup |
Column Name | Description |
---|---|
Actions | These are different actions that can be performed for each sensor entry. Configure: Edits the sensor’s preferences Delete: Removes the sensor from the system/Avatar |
Name | The name assigned to each sensor. |
Model | The make/model of the sensor device. |
Zone | The Zone the sensor is assigned to. |
Location | Where the sensor is physically located. |
State | Whether the device’s operation is On or Off. |
Health Status | States if the camera is in working order or not. |
Avatar 4/7 Gateways Tab
Action Name | Description |
---|---|
Add | Add a new sensor or duplicate an existing sensor to the Avatar. Gateway setup |
Column Name | Description |
---|---|
Actions | These are different actions that can be performed for each gateway entry. Configure: Edits the gateway’s preferences Delete: Removes the gateway from the system/Avatar |
Name | The name assigned to each gateway. |
Model | The make/model of the gateway device. |
State | Whether the device’s operation is On or Off. |
Health Status | States if the camera is in working order or not. |
Avatar 5/7 Delivery Priority Tab
Column Name | Description |
---|---|
# | The order in delivery priority. Sets which device delivers data to the Avatar first. |
Name | The name of each device. |
Location | Where the sensor is physically located. |
Zone | The Zone the sensor is assigned to. |
State | Whether the device’s operation is On or Off. |
Cloud Archive | Whether the device has cloud archive enabled on it. |
Avatar 6/7 Audit Tab
Action Name | Description |
---|---|
Export CSV | Exports a .CSV file with all events that occured on the Avatar’s connected devices. |
Column Name | Description |
---|---|
Event | The type of event that occurred, represented by an icon |
Id | The event ID represents each event with its own a |
Info |
|
Message |
|
Event Details |
|
Avatar 7/7 Report Tab
Action Name | Description |
---|---|
Get Metrics | Creates metrics report based on time range. |
Avatar Activation
Field Name | Description |
---|---|
Enter Avatar GUID | After configuring an Avatar device you will be prompted with a GUID number. This number links the Avatar device to JetStream. |
Audit
Field Option | Description |
---|---|
Categories | Select the types of values to look up. (device events, health, management) |
Users | Select the users that are present on the Realm. |
Cameras | Select the cameras present on the Realm. |
Sensors | Select the sensors present on the Realm. |
Avatars | Select the Avatars present on the Realm. |
Start from | Set the start date/time the Audit should begin from. |
End to | Set the end date/time the Audit should end. |
Filter by text | Filter through results with key words. |
Hierarchy
Action Name | Description |
---|---|
Add Hierarchy | Adds a new hierarchy. This creates a root directory to which branches can be added. |
Add Branch | Creates a new branch that nests to the previously assigned branch/root. |
Configure Hierarchy | Edits the hierarchy name. |
Delete Heirarchy | Deletes the whole hierarchy. |
Labels
Action Name | Description |
---|---|
Filter by labels | Filter through labels with key words. |
Filter by name | Filter through devices with key words. |
Video Walls
Field Name | Description |
---|---|
Video Walls |
|
Monitors |
|
Access
Zones
Action Name | Description |
---|---|
Add | Add a new Zone. |
Filter by name | Filter Zones by entering a name. |
Column Name | Description |
---|---|
Name | Name of each Zone. |
Devices | Devices assigned to each Zone. |
Zones 1/2 Zone Properties Tab
Field Name | Description |
---|---|
Name | Enter a name for the Zone. |
Zones 2/2 Devices Tab
Action Name | Description |
---|---|
Assign Devices | Assigns devices to the Zone being configured. |
Sets
Action Name | Description |
---|---|
Add | Add a new Set. |
Filter by name | Filter Sets by entering a name. |
Column Name | Description |
---|---|
Name | Name of each Set. |
Devices | Devices assigned to each Set. |
Sets 1/2 Zone Properties Tab
Field Name | Description |
---|---|
Name | Enter a name for the Set. |
Sets 2/2 Devices Tab
Action Name | Description |
---|---|
Assign Devices | Assigns devices to the Set being configured. |
Authorization Policies
Action Name | Description |
---|---|
Add | Add a new Authorization Policy. |
Filter by name | Filter Authorization Policies by entering a name. |
Column Name | Description |
---|---|
Name | Name of each Authorization Policy. |
Statements | The statements assigned to each policy. |
Authorization Policy Setup 1/2 Policy Properties Tab
Field Name | Description |
---|---|
Name | Enter a name for the Policy. |
Action Name | Description |
---|---|
Create | Creates a new Policy. |
Authorization Policy Setup 2/2 Statements Tab
Action Name | Description |
---|---|
Create Statement | Create a new Policy Statement |
Authorization Policy Setup 2/2a Statements Tab > Statement Properties
Field Name | Description |
---|---|
Name | Enter a name for the Statement |
Effect |
|
Authorization Policy Setup 2/2a Statements Tab > Statement Properties > Actions
Option Name | Description |
---|---|
View | Allows viewer rights to the statement |
Control | Allows controller rights to the statement |
Manage | Allows manager rights to the statement |
Authorization Policy Setup 2/2a Statements Tab > Statement Properties > Actions > Resources
Action Name | Description |
---|---|
Assign Resources | Assign Zones, Sets, and/or Devices to the statement. |
Users
Action Name | Description |
---|---|
Add | Add a new User. |
Filter by name | Filter Users by entering a name. |
Column Name | Description |
---|---|
Name | Name of each User. |
Groups | The Groups assigned to each User. |
User Setup 1/3 User Properties Tab
Field Name | Description |
---|---|
Name | Enter a name for the User. |
Enter an email for the User |
Action Name | Description |
---|---|
Send Notification | Sends the user’s email a notification about any changes made to their account. |
Unblock | Filter Users by entering a name. |
User Setup 2/3 User Properties Tab > Password
Option Name | Description |
---|---|
Change Password | Set the password for the User. |
Set password (will be marked as expired) | Set a temporary password for User. This password will expire after the first login. The User will be prompted to set a new password. |
User Setup 3/3 User Properties Tab > Password > Groups
Action Name | Description |
---|---|
Assign Groups | Assigns groups to the User. |
Groups
Action Name | Description |
---|---|
Add | Add a new Group. |
Filter by name | Filter Groups by entering a name. |
Column Name | Description |
---|---|
Name | Name of each Group. |
Users | Users assigned to the Group. |
Policies | Policies assigned to the Group. |
Groups Setup 1/3 Group Properties Tab
Field Name | Description |
---|---|
Name | Enter a name for the Group. |
Groups Setup 1/3 Group Properties Tab > Users
Action Name | Description |
---|---|
Assign Users | Assigns users to the Group. |
Groups Setup 1/3 Group Properties Tab > Users > Policies
Action Name | Description |
---|---|
Assign Policies | Assign policies to the Group. |
Audit
Field Option | Description |
---|---|
Categories | Select the types of values to look up. (device events, health, management) |
Users | Select the users that are present on the Realm. |
Cameras | Select the cameras present on the Realm. |
Sensors | Select the sensors present on the Realm. |
Avatars | Select the Avatars present on the Realm. |
Start from | Set the start date/time the Audit should begin from. |
End to | Set the end date/time the Audit should end. |
Filter by text | Filter through results with key words. |
Settings
Notification Policies
Action Name | Description |
---|---|
Add | Add a new Notification Policy. |
Notification Policies > New Policy > General
Field Option | Description |
---|---|
Policy Name | Enter a name for the Notification Policy. |
Channel | Select how the notification should be sent. |
Timeout | Select the timeout of the notification. |
Message entity | Notification Counts Only |
Policy type | Select the type of policy. Audit Policy: Event Log Policy: |
Notification Policies > New Policy > User Security
Option Name | Description |
---|---|
Login | Notifies about any logins into the system. |
Login Failure | Notifies about any login failures into the system. |
User Account Add/Edit/Remove | Notifies about any account additions, edits, or removals on the system. |
Logout | Notifies about any logouts on the system. |
Account Blocked | Notifies if any accounts have been blocked on the system. |
Notification Policies > New Policy > User Actions
Option Name | Description |
---|---|
Export Media Clip | If any media clips are exported on the system a notification will be sent. |
Notification Policies > New Policy > Object Management
Option Name | Description |
---|---|
Device Configuration Management | If any changes are made to the configuration of a device a notification will be sent. |
Notification Policies > New Policy > Health Monitoring
Option Name | Description |
---|---|
Device Health Status (on/off/broken/..) | If the health status of a device changes a notification will be sent. |
Realm Settings
General
Field Option | Description |
---|---|
System name | Enter the name of the Realm. |
System Admin e-mail | Enter the email associated with the System Admin. |
Maximum Mandatory Delivery delay, minutes |
|
Audit events TTL |
|
Two-Factor Auth (2FA) | ON/OFF Two-Factor Authentification for all User logins on the Realm. |
Player idle timeout | If the user is inactive for the set amount of time the players will stop streaming feeds to save network bandwidth. |
Jitter buffer length, ms |
|
Max download file time length, minutes | Set the total file download length permitted. |
Notifications
Field Option | Description |
---|---|
SMTP server enabled | ON/OFF SMTP server. |
SMTP server host | Enter SMTP server host. |
SMTP server port | Enter server port. |
Use SMTP TLS security | ON/OFF SMTP TLS security. |
FROM field of mail |
|
SMTP authentication | Select whether the SMTP server has authentication. |
SMTP user name | Enter the username associated with the SMTP server. |
SMTP user password | Enter the password associated with the SMTP server. |
EMAIL validated | States whether the email is validated |
GIS
Action Name | Description |
---|---|
Import GIS data | Import GIS data from a external file. Supported file formats include xxx, yyyy, zzz. |
Manage Avatars
Migrate Avatar
Action Name | Description |
---|---|
Migrate Avatar | Migrating (transferring) existing camera enrollments and settings from one Avatar (old Avatar) to a new avatar. |
Old Avatar | The old Avatars listed are eligible to be migrated. The enrolled cameras from the old Avatar will be migrated to the new selected Avatar, so the old Avatar can be removed. O |
New Avatar | Migrating to a new Avatar will transfer all old Avatar contents to the new one. |
Delete Avatar
Action Name | Description |
---|---|
Delete Avatar | Select an Avatar to remove from the system. |
Watchlist: License Plate Recognition
Action Name | Description |
---|---|
Add | Add an LPR watch item. |
Column Name | Description |
---|---|
Name | Assign a name to the watch item. |
Description | Enter a description of the watch item. |
Action | Select whether to Alert, Event, Ignore the watch item when the system catches it.
|
Confidence | Select the minimum accuracy required to generate an alert/event. Often around .40 or .50 (40% or 50%) confidence. |
Default TTL (days) | Default Time to Live (TTL) |
Operations | Select whether to configure or delete a watch item. |
Watchlist: Facial
Column Name | Description |
---|---|
Name | Assign a name to the watch item. (Example: Bugs Bunny, Jimmy Hoffa, Bigfoot) |
Description | Enter a description of the watch item. |
Action | Select whether to Alert, Event, Ignore the watch item when the system catches it.
|
Threshold |
|
Default TTL (days) |
|
Operations | Select whether to configure or delete a watch item. |
Edit Map
Option Name | Description |
---|---|
Cameras | Select whether to see cameras on the map. |
All | Select whether to see all GIS Layers on the map. |
Action Name | Description |
---|---|
Import GIS file | Import GIS data from a external file. |
Reports
Analytics Dashboard
TBD
Application Settings
Action Name | Description |
---|---|
Open view list on start | Select whether to open the view list when logging into the system. |
Player default connection | Select whether the default player connection type is Auto, Local, or Cloud.
|
About
Subscription
Column Name | Description |
---|---|
Category | Types of subscription categories. |
Subscription Option | Lists the options of each subscription. |
Currently Used | How much is currently being used of each subscription. |
Subscription Limit | The limit of items or amount of each subscription. |