Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
User Guide. Introduction
Software lifecycle policy
Information security of Axxon One
Description of Axxon One
- Basic principles of building a security system based on Axxon One
- Axxon One features: reference information
- Functions of the distributed security system
- Axxon One architecture
- Network Topologies of Axxon One
- Characteristics of Axxon One
- Implementation requirements for Axxon One
- Interface of Axxon One
- Ports used by Axxon One
- Requirements for Personnel Quantity and Qualifications
Installing Axxon One
Licensing of the software product
Starting and stopping Axxon One software
- Starting Axxon One
- Stopping Axxon One
- Quick user switching
- Quick connection to another server
- Automatic server restart
Configuration of Axxon One
- General information on system configuration
- Hardware configuration
- Configuring domains
- Searching, adding, configuring and removing IP devices
- Configuring system objects for devices
- The Server object
- Camera
- Configuring video stream settings
- Configuring a privacy mask
- Putting a text over the Surveillance window
- Bulk application of settings
- Configuring fisheye cameras
- Connecting and configuring cameras over standard protocols
- Configuring connection of video cameras with dynamic IP addresses
- Configuring virtual video cameras
- Restoring default camera settings
- The IP Server object
- The Microphone object
- The PTZ object
- The Channel object
- The Input object
- The Output object
- The Speaker object
- Email notifier
- Embedded storage
- Specifics of device configuration
- Configuring Tracking objects
- Receiving events from external systems
- Configuring video camera groups
- Automatic copying of data from local Servers to a centralized Server
- Аrchive
- General information about server archives
- Creating archives
- Creating a local archive
- Creating a remote archive
- Creating a cloud archive
- General information about a cloud archive
- Configuring an archive volume based on the Microsoft Azure solution
- Configuring an archive volume based on the Amazon solution
- Configuring an archive volume based on the Seagate Lyve Cloud solution
- Configuring an archive volume based on the Wasabi solution
- Configuring an archive volume based on the MinIO solution
- General information about the Round-robin algorithm
- Creating an archive based on existing archive volumes
- Editing archives
- Configuring archives
- Configuring recording to an archive
- Configuring the default archive
- Configuring a write limit on an archive volume
- Configuring access restrictions to an archive
- Configuring data replication
- Encrypting a volume of an object archive
- Extending the space of an archive volume
- Saving an archive when replacing a video signal device
- Protecting video recordings from FIFO overwriting
- Statuses of archive volumes
- Removing archive volumes
- Removing archives
- Detectors
- General information about detectors and their sub-detectors
- Processors used for detectors operation
- Hardware requirements for GPU-based video decoding
- Installing DetectorPack add-ons
- Configuring detectors and their sub-detectors
- Metadata database
- Neural analytics
- General settings of the detectors
- Selecting Nvidia GPU when configuring detectors
- Configuring the minimum and maximum size of detected objects
- Configuring a skip area
- Configuring a detection area
- Configuring perspective
- Configuring the scanning mode
- Displaying the number of detected objects
- Configuring the Input object
- Checking events of a detector
- Automatic rules
- Standard sub-detectors
- General information on the standard sub-detectors
- Video stream and scene requirements for the standard sub-detectors
- Image requirements for the standard sub-detectors
- Configuring Line crossing
- Configuring Loitering in area
- Configuring Stop in area
- Configuring the Track masking
- Configuring Motion in area
- Configuring Entrance in area
- Configuring Exit from area
- Configuring Multiple objects
- Configuring Move from area to area
- Category: Trackers
- Abandoned object detector VI
- Functions of the Abandoned object detector VI
- Video stream and scene requirements for the Abandoned object detector VI
- Image requirements for the Abandoned object detector VI
- Licensing of the software module for the Abandoned object detector VI in Windows OS
- Licensing of the software module for the Abandoned object detector VI in Linux OS
- Configuring the Abandoned object detector VI
- Abandoned object detector VI (Street)
- Functions of the Abandoned object detector VI (Street)
- Video stream and scene requirements for the Abandoned object detector VI (Street)
- Image requirements for the Abandoned object detector VI (Street)
- Licensing of the software module for the Abandoned object detector VI (Street) in Windows OS
- Licensing of the software module for the Abandoned object detector VI (Street) in Linux OS
- Configuring the Abandoned object detector VI (Street)
- Neural tracker
- Object tracker
- Human tracker VL
- Functions of the Human tracker VL
- Video stream and scene requirements for the Human tracker VL and its sub-detectors
- Image requirements for the Human tracker VL and its sub-detectors
- Activating the license for the Human tracker VL in Windows OS
- Activating the license for the Human tracker VL in Linux OS
- Configuring the Human tracker VL
- Stopped object detector
- Motion detector
- Privacy masking
- Motion in area detector VI
- Functions of the Motion in area detector VI
- Video stream and scene requirements for the Motion in area detector VI
- Image requirements for the Motion in area detector VI
- Licensing of the software module for the Motion in area detector VI in Windows OS
- Licensing of the software module for the Motion in area detector VI in Linux OS
- Configuring the Motion in area detector VI
- Movement in prohibited direction VI
- Functions of the Movement in prohibited direction VI detector
- Video stream and scene requirements for the Movement in prohibited direction VI detector
- Image requirements for the Movement in prohibited direction VI detector
- Licensing of the software module for the Movement in prohibited direction VI detector in Windows OS
- Licensing of the software module for the Movement in prohibited direction VI detector in Linux OS
- Configuring the Movement in prohibited direction VI detector
- Line crossing VI
- Functions of the Line crossing VI detector
- Video stream and scene requirements for the Line crossing VI detector
- Image requirements for the Line crossing VI detector
- Licensing of the software module for the Line crossing VI detector in Windows OS
- Licensing of the software module for the Line crossing VI detector in Linux OS
- Configuring the Line crossing VI detector
- Abandoned object detector VI
- Category: Face
- Face detector VL
- Functions of the Face detector VL
- Hardware requirements for the Face detector VL and its sub-detectors
- Video stream and scene requirements for the Face detector VL and its sub-detectors
- Image requirements for the Face detector VL and its sub-detectors
- Activating the license for the Face detector VL in Windows OS
- Activating the license for the Face detector VL in Linux OS
- Configuring the Face detector VL
- Mask detector VL
- Face detector VA
- Functions of the Face detector VA
- Manual for switching from the Face detector TV to Face detector VA
- Hardware requirements for the Face detector VA and its sub-detectors
- Video stream and scene requirements for the Face detector VA and its sub-detectors
- Image requirements for the Face detector VA and its sub-detectors
- Optimizing the operation of the Face detector VA on GPU in Windows OS
- Optimizing the operation of the Face detector VA on GPU in Linux OS
- Configuring the Face detector VA
- Mask detector VA
- Checking in lists of faces
- FaceCube+ external face recognition system
- Face detector TV
- Functions of the Face detector TV
- Hardware requirements for the Face detector TV and its sub-detectors
- Video stream and scene requirements for the Face detector TV and its sub-detectors
- Image requirements for the Face detector TV and its sub-detectors
- Optimizing the operation of the Face detector TV on GPU in Windows OS
- Optimizing the operation of the Face detector TV on GPU in Linux OS
- Configuring the Face detector TV
- Mask detector TV
- Face detector VL
- Category: Vehicle
- License plate recognition BRS
- License plate recognition IV
- Functions of the License plate recognition IV
- Hardware requirements for the License plate recognition IV
- Video stream and scene requirements for the License plate recognition IV and its sub-detectors
- Image requirements for the License plate recognition IV and its sub-detectors
- Activating the license for the License plate recognition IV in Windows OS
- Activating the license for the License plate recognition IV in Linux OS
- Configuring the License plate recognition IV
- License plate recognition RR and Vehicle recognition RR
- Functionality of License plate recognition RR and Vehicle recognition RR
- Hardware requirements for License plate recognition RR and Vehicle recognition RR
- Camera requirements for the License plate recognition RR, Vehicle recognition RR and their sub-detectors
- Optimizing the operation of License plate recognition RR and Vehicle recognition RR on GPU in Windows OS
- Optimizing the operation of License plate recognition RR and Vehicle recognition RR on GPU in Linux OS
- Configuring the License plate recognition RR
- Configuring the License plate recognition RR—Search in archive
- Configuring License plate recognition RR—Parking
- Configuring the Vehicle recognition RR
- Configuring calibration area and detection area
- License plate recognition VT
- Functions of the License plate recognition VT
- Hardware requirements for the License plate recognition VT
- Video stream and scene requirements for the License plate recognition VT and its sub-detectors
- Image requirements for the License plate recognition VT and its sub-detectors
- Optimizing the operation of the License plate recognition VT on GPU in Windows OS
- Optimizing the operation of the License plate recognition VT on GPU in Linux OS
- Licensing of the software module for the License plate recognition VT in Windows OS
- Licensing of the software module for the License plate recognition VT in Linux OS
- Configuring the License plate recognition VT
- Vehicle recognition XR
- Functions of the Vehicle recognition XR
- Hardware requirements for the Vehicle recognition XR
- Video stream and scene requirements for the Vehicle recognition XR
- Image requirements for the Vehicle recognition XR
- Licensing of the software module for the Vehicle recognition XR in Windows OS
- Configuring the Vehicle recognition XR
- Installing and configuring Vaxtor License Server using Docker for Vehicle recognition XR
- Checking in lists of LPs
- Category: Poses
- Human pose detector
- Functions of the Human pose detector and its sub-detectors
- Video stream and scene requirements for the Human pose detector and its sub-detectors
- Image requirements for the Human pose detector and its sub-detectors
- Configuring the Human pose detector
- Configuring the Human pose detector sub-detectors
- Configuring the Sitting person detector
- Configuring the Person down detector
- Configuring the Hands up detector
- Configuring the Handrail holding detector
- Configuring the People counter
- Configuring the Close-standing people detector
- Configuring the People masking
- Configuring the standard sub-detectors of the Human pose detector
- Person-based privacy masking
- Human pose detector
- Category: Production Safety
- Audio classification IV
- Neural classifier
- Fire detector
- Equipment detector
- Functions of the Equipment detector
- Video stream and scene requirements for the Equipment detector and its sub-detectors
- Image requirements for the Equipment detector and its sub-detectors
- Example of providing a list of valid equipment at the facility for the Equipment detector
- Configuring the Equipment detector
- Smoke detector
- Water level detector
- Glow detector
- Equipment detector VL
- Functions of the Equipment detector VL
- Video stream and scene requirements for the Equipment detector VL and its sub-detectors
- Image requirements for the Equipment detector VL and its sub-detectors
- Example of providing a list of valid equipment at the facility for the Equipment detector VL
- Activating the license for the Equipment detector VL in Windows OS
- Activating the license for the Equipment detector VL in Linux OS
- Configuring the Equipment detector VL
- Category: Retail
- Category: Service
- Audio loss detector
- Noise detector
- Signal detector
- Tampering detector
- Detector of atypical changes in the scene VI
- Functions of the Detector of atypical changes in the scene VI
- Video stream and scene requirements for the Detector of atypical changes in the scene VI
- Image requirements for the Detector of atypical changes in the scene VI
- Licensing of the software module for the Detector of atypical changes in the scene VI in Windows OS
- Licensing of the software module for the Detector of atypical changes in the scene VI in Linux OS
- Configuring the Detector of atypical changes in the scene VI
- Category: Other
- Category: Embedded
- General information about embedded detectors
- Embedded IVA analytics
- Embedded ONVIF analytics
- Adding the ONVIF Profile M embedded detection tools
- Embedded license plate recognition detectors
- Embedded vehicle speed measurement radar
- Embedded temperature detector
- Face detection and temperature control with Mobotix M16 TR cameras
- AxxonSoft Tracker in Axis devices
- Programming
- General information about macros
- Configuring macros
- Configuring start conditions
- Starting the Event rules macros based on statistical data
- Configuring macros when working with lists of faces
- Parameters that specify the conditions for starting a macro when recognizing a face
- Configuring macros when working with lists of license plates
- Parameters that specify the conditions for starting a macro when recognizing a vehicle
- Examples of macros
- Wait for events
- Control alarms
- Control archive
- Control devices and outputs
- Notifications
- Control camera
- Play audio
- Execute queries and actions
- Control layouts
- Text templates in the action settings
- Examples of Cycle rules macros
- Examples of macros used when working with lists of faces
- Examples of macros used when working with lists of license plates
- Examples of macros used for barcode detection
- Users
- Configuring layouts
- Creating and deleting layouts
- Rename Layouts
- Layouts grouping
- Reorder Layouts
- Layout copying
- Editing layouts
- Switching to layout editing mode
- Selecting a layout for editing
- Configuring layout cells
- Configuring Surveillance windows
- Selecting default functions for Surveillance windows
- Selecting the default video stream for all cameras on the layout
- Selecting the default video mode for a camera
- Moving input and output icons in the Surveillance window
- Configuring default digital zoom (the Fit screen function)
- Configuring pan/tilt angle for cameras with Immervision lenses in 180 degrees Panorama display format
- Configuring display of water level sensor
- Adding links to other cameras to the Surveillance window
- Configuring information boards
- Configuring Alarms Panel on a layout
- Exiting Layout Editing mode
- Share Layouts
- Configuring special layouts
- Configuring custom slideshows
- Setting the default layout
- Setting a layout ID
- Configuring Video wall
- Configuring the interactive map
- System preferences
- Server settings
- Configuring Search in archive
- Setting up privacy masking
- Configuring hardware video decoding for display on the Client
- Configuring automatic response when Axxon One integrity check fails
- Configuring storage of the system log and metadata
- Configuring Alarm processing
- Configuring PTZ control
- Configuring schedules
- Configuring the Server ports
- Configuring the Server logging level
- Configuring NTP synchronization
- Vector maps in Axxon One
- Connecting the Axxon One domain to AxxonNet
- Client settings
- Configuring the user interface
- Selecting the interface language
- Selecting the calendar type
- Configuring the slideshow parameters
- Hiding prompts
- Configuring smooth motion
- Configuring display of video statistics
- Configuring preview of alarm events
- Configuring map auto zoom
- Configuring the Client screen mode (full screen or window)
- Configuring the display of the surveillance window
- Configuring time display
- Configuring the display of the camera short name
- Optimizing video image on the layout
- Configuring video display on the layout
- Configuring camera sorting on Objects Panel
- Configuring the videowall mode
- Configuring cell maximization on double click
- Configuring how Axxon One starts
- Configuring export
- Configuring audio on the Client
- Configuring hot keys
- Configuring video capturing on operator monitor
- Configuring the Client logging level
- Configuring the user interface
- Server settings
- Configuring Failover VMS
- General information about a failover system
- Ports used by the failover system
- Supervisor Web-Interface
- Creating a cluster
- Failover Database
- Configure a Failover System Cluster
- Set up access to a supervisor
- Configuration backup and restore for failover VMS
- Transferring the configuration from a common security server to a failover system
- Monitoring the status of a cluster
- Connecting to a Node and Configuring of an Axxon domain
- Configuring automatic connection to nodes
- Updating Servers within a cluster
- Setting network interfaces for system nodes operation
- Changing ports in the nodes of the failover system
- Connecting the Client to the Failover Server behind NAT
- Changing logging levels for the Consul and Nomad processes in a failover system
- Self-diagnostics service
Working with Axxon One
- Main Elements of the User Interface
- Video surveillance
- Video surveillance modes
- Functions available in all video surveillance modes
- Scaling the Surveillance window
- Digital video zoom
- Video image processing
- Video image rotation
- Object tracking
- Displaying information from a detector (mask)
- Operator comments
- Viewing titles from POS terminals
- Partial decompression of video signal
- Switching to other camera via a link in the Surveillance window
- Live video surveillance
- Switching to Live mode
- Video surveillance functions available in Live mode
- Arming and disarming a camera
- Selecting video stream quality in a Surveillance window (GreenStream)
- Autozoom
- Controlling a PTZ сamera
- Functions for tracking moving objects
- Managing output
- Displaying the input status
- Automatic replacement of the camera on layouts
- Freeze frame
- Viewing events from the detection tools of the selected camera
- Removing a camera from a layout
- Video surveillance in the Alarm management mode
- Video surveillance in the Archive mode
- Switching to the Archive mode
- Video surveillance functions available in the Archive mode
- Selecting an archive
- Viewing a combined archive
- Synchronized playback of archives
- Compressed playback of archives (TimeCompressor)
- Viewing archive with operator comments
- Viewing external archive
- Deleting a part of archive
- Navigating in the archive
- Displaying the causes for the Scene analytics detection tools to generate an event
- Viewing the results of a saved search query
- Manual archive replication
- Tag&Track Lite in the Archive mode
- Video surveillance in the Archive Search mode
- Switching to the Archive Search mode
- Interface of the Archive Search mode
- Video surveillance functions available in the Archive Search mode
- Search in the archive of a single camera
- Simultaneous search in the archive of several cameras
- Working with fisheye cameras
- Vehicle license plate recognition and search
- Face recognition and search
- Temperature screening
- Working with information boards
- Layouts management
- Monitor management
- Audio Monitoring
- Working with the interactive map
- Exporting frames and video recordings
- Macros control
- Event control
- Working with Axxon One through the Web-Client
- Web-Сlient overview
- Hardware and software requirements for the Web-Client operation
- Starting and logging in to the Web-Сlient
- Web-Client GUI
- Web-Client configuration
- Searching for video cameras in the Web-Client
- Working with layouts in Web-Client
- Summary of how to work with layouts in Web-Client
- Selecting and searching for a layout
- Creating a new layout in the Web-Client
- Editing and deleting layouts in Web-Client
- Selecting the default layout in Web-Client
- Copying layouts in the Web-Client
- Sharing layouts in the Web-Client
- Creating a temporary layout in the Web-Client
- Real-time video surveillance in the Web-Client
- Controlling PTZ cameras through the Web-Client
- Viewing video archives through the Web-Client
- Archive position selection panel for the Web-Client
- Archive search in the Web-Client
- Viewing events from camera detection tools in the Web-Client
- Running macros in Web-Client
- Viewing and processing alarms in the Web-Client
- Listening to a camera's microphone via the Web-Client
- Digital video zoom in the Web-Client
- Export in the Web-Client
- Viewing Camera and Archive Statistics
- Working with bookmarks in the Web-Client
- Working with interactive map via the Web-Client
- Working with Axxon One Through the Mobile Clients
Axxon One utilities
- Tray Tool utility
- Network settings utility
- Watermark checker utility
- Backup and restore utility
- Gathering system information utility
- Log Management Utility
- POS terminal data collection utility
- Console utility for working with archives (vfs_format.exe)
Appendices
- Appendix 1. Glossary
- Appendix 2. Known issues in the Axxon One Software Package
- Appendix 3. Assigning of the domain takes place when the Axxon One server is installed
- Appendix 4. Using Axxon One with antivirus software
- Appendix 5. Using CH VM-Desktop USB multifunction controllers with Axxon One
- Appendix 6. Hotkeys in Axxon One
- Appendix 7. Automated configuration backup and restore
- Appendix 8. Using Axxon One with NAT
- Appendix 9. Creating system variable
Overview
Content Tools