Cluebase VMS User Manual - Revision history

Vcloudai at 14:31, 6 October 2026

2026-10-06T14:31:59Z

Vcloudai at 14:49, 31 August 2026

2026-08-31T14:49:08Z

← Older revision		Revision as of 15:49, 31 August 2026
Line 682:		Line 682:
	* Instant quality: at least 60%		* Instant quality: at least 60%
	* Detection confidence: at least 50%		* Detection confidence: at least 50%

	~~[[File:VCloud.ai face recognition balanced mode help.png\|alt=Balanced face capture mode limits\|none\|thumb\|700px\|The default Balanced capture mode and its acceptance limits.]]~~

	Select '''Custom''' to set the head turn, head tilt, head roll, instant quality, and detection confidence thresholds manually. Stricter settings generally produce cleaner face crops but may reject more detections.		Select '''Custom''' to set the head turn, head tilt, head roll, instant quality, and detection confidence thresholds manually. Stricter settings generally produce cleaner face crops but may reject more detections.
Line 690:		Line 688:

	'''Best-shot time, s''' controls how long a face is followed before the event is sent so that the engine can select a better image. Use a lower value for faster alerts or a higher value for better photographs. Leave the field empty to use the server default. The range is 0–10 seconds; <code>0</code> disables the limit.		'''Best-shot time, s''' controls how long a face is followed before the event is sent so that the engine can select a better image. Use a lower value for faster alerts or a higher value for better photographs. Leave the field empty to use the server default. The range is 0–10 seconds; <code>0</code> disables the limit.

	~~[[File:VCloud.ai face recognition best-shot time help.png\|alt=Best-shot time explanation\|none\|thumb\|700px\|Best-shot time balances alert speed against image quality.]]~~

	==== Verify detection and alarms ====		==== Verify detection and alarms ====
Line 698:		Line 694:

	[[File:VCloud.ai face recognition analytics stream.png\|alt=Annotated face-recognition stream with detected faces\|none\|thumb\|900px\|Annotated preview used to verify face detection.]]		[[File:VCloud.ai face recognition analytics stream.png\|alt=Annotated face-recognition stream with detected faces\|none\|thumb\|900px\|Annotated preview used to verify face detection.]]

	~~[[File:VCloud.ai face recognition analytics stream help.png\|alt=Show analytics stream help text\|none\|thumb\|700px\|The annotated stream affects only the settings preview.]]~~

	When '''Send to Alarm Panel''' is enabled, open the Alarm Panel from the bell icon in the layout. A matched event can display the camera, enrolled name, list, gender, estimated age, confidence, and comparison images. Events without a list match can still display the detected face and available attributes.		When '''Send to Alarm Panel''' is enabled, open the Alarm Panel from the bell icon in the layout. A matched event can display the camera, enrolled name, list, gender, estimated age, confidence, and comparison images. Events without a list match can still display the detected face and available attributes.

Vcloudai at 14:47, 31 August 2026

2026-08-31T14:47:39Z

← Older revision		Revision as of 15:47, 31 August 2026
Line 482:		Line 482:

	== User access management ==		== User access management ==
			'''Managing roles Go to Settings->Users->Add role'''[[File:Picture 12.png\|thumb\|none]]
	~~=====~~ Managing roles Go to Settings->Users->Add role ~~=====~~
	[[File:Picture 12.png\|thumb\|none]]


Line 490:		Line 488:
	Please note that all users with this role will then have access to the specified cameras and functions.<br>		Please note that all users with this role will then have access to the specified cameras and functions.<br>

	~~=====~~ Managing users Go to Settings->Users->Add new user ~~=====~~		'''Managing users Go to Settings->Users->Add new user'''[[File:Picture 13.png\|thumb\|none]]<br>
	[[File:Picture 13.png\|thumb\|none]]<br>

	Specify the new user credentials: Username, Password and the required Role. Access granted to the selected Role is be indicated below but is not available for editing. To edit the permissions you need to edit the Role by clicking the pencil button <br>		Specify the new user credentials: Username, Password and the required Role. Access granted to the selected Role is be indicated below but is not available for editing. To edit the permissions you need to edit the Role by clicking the pencil button <br>
	[[File:Picture 14.png\|thumb\|none]]		[[File:Picture 14.png\|thumb\|none]]'''Managing organisations'''

	~~===== Managing organisations =====~~
	By default all roles and users are added to the root organisation. If you need one extra user access layer for multi-tenancy then create more organisations and create roles and users under them.		By default all roles and users are added to the root organisation. If you need one extra user access layer for multi-tenancy then create more organisations and create roles and users under them.

Vcloudai: Add vCloud.ai Face Recognition System installation and operation manual

2026-08-31T14:44:43Z

Add vCloud.ai Face Recognition System installation and operation manual

@@ Line 620: / Line 620: @@
 When required, enable the View zone option in the detector settings to use the detection zone (mask).
 [[File:Zone.jpg|alt=zone|none|thumb]]
 === YOLO Custom Video Analytics ===
@@ Line 713: / Line 803: @@
 Once you’re satisfied with your settings, click '''“Save rule”''' to apply it. Once saved, your custom detector will appear in the [[File:Ai.png|frameless|25x25px]] menu list in Layout video window and can be configured and used in the same way as the Embedded analytics.
 === LPR lists (vehicle license plate recognition lists) ===

Vcloudai at 05:59, 8 July 2026

2026-07-08T05:59:45Z

← Older revision		Revision as of 06:59, 8 July 2026
Line 530:		Line 530:
	'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.		'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.

	~~===~~ Offline geographical maps ~~===~~
			'''Offline geographical maps'''

	Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.		Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.

Vcloudai: Add offline geographical maps section

2026-07-08T05:54:54Z

Add offline geographical maps section

← Older revision		Revision as of 06:54, 8 July 2026
Line 529:		Line 529:

	'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.		'''Floor 1 / Floor 2 -''' Navigate between multiple floors or levels of your facility. Each tab represents a separate floor plan layer where different devices can be placed.

			=== Offline geographical maps ===

			Cluebase VMS can use offline geographical maps for installations where the server or operator workstation has limited or no Internet access. Offline maps are created as a separate map type, and the required geographical regions must be downloaded before use.

			[[File:Cluebase VMS offline map create new map.png\|alt=Create new offline geographical map\|none\|thumb\|Create new offline geographical map]]

			To create an offline map:

			# Open '''Main menu -> Maps''' and click '''+''' to add a new map.
			# Enter the map title.
			# In the '''Map type''' field, select '''Global offline map'''.
			# Click '''Create'''.

			[[File:Cluebase VMS offline map regions window.png\|alt=Regions selection window\|none\|thumb\|Regions selection window]]

			After the offline map is created, open the regions download window using the regions/download button in the bottom-right corner of the map editor.

			[[File:Cluebase VMS offline map choose region.png\|alt=Choose the required regions\|none\|thumb\|Choose the required regions]]

			In the '''Regions''' window, expand the required continent, country, or area. The list shows the available regions and the approximate download size for each one.

			To download a region, click the download button next to its name. Repeat this action for every region that must be available offline.

			[[File:Cluebase VMS offline map downloaded region.jpg\|alt=Downloaded offline map region\|none\|thumb\|Downloaded offline map region]]

			Once the required regions have been downloaded, the offline map can be used in the same way as other maps. Operators can zoom and move around the downloaded area, draw polygons, and place cameras, sensors, or doors on the map.

	== Camera groups<br> ==		== Camera groups<br> ==

Vcloudai: /* Multi-server functionality */

2026-07-06T17:34:34Z

Multi-server functionality

← Older revision		Revision as of 18:34, 6 July 2026
Line 402:		Line 402:
	[[File:Bind.png\|alt=bind\|none\|thumb\|600x600px]]		[[File:Bind.png\|alt=bind\|none\|thumb\|600x600px]]
	Fill the server access fields and click bind.		Fill the server access fields and click bind.

			If connection to one of the linked servers is lost, a corresponding notification appears in the Alarm panel.

	== Storage settings ==		== Storage settings ==

Vcloudai: /* VCA video analytics */

2026-07-03T11:38:07Z

VCA video analytics

← Older revision		Revision as of 12:38, 3 July 2026
Line 683:		Line 683:

	Once you’re satisfied with your settings, click '''“Save rule”''' to apply it. Once saved, your custom detector will appear in the [[File:Ai.png\|frameless\|25x25px]] menu list in Layout video window and can be configured and used in the same way as the Embedded analytics.		Once you’re satisfied with your settings, click '''“Save rule”''' to apply it. Once saved, your custom detector will appear in the [[File:Ai.png\|frameless\|25x25px]] menu list in Layout video window and can be configured and used in the same way as the Embedded analytics.

	~~=== VCA video analytics ===~~
	~~Cluebase VMS can natively connect VCA video analytics platform that integrates a variety of 3rd party video analytics plugins.~~

	~~To connect a VCA server to Cluebase VMS go to: Main menu -> Settings -> Analytics -> VCA server settings.~~
	~~[[File:Vca settings.png\|alt=vca settings\|none\|thumb]]~~
	~~Add the required information to the fields, select 'Enable VCA settings' option and click save. VCA server is connected.~~

	~~Go to the [[File:Ai.png\|alt=ai button\|20x20px]] menu to use and configure the VCA-based video analytics detectors.~~

	~~If the VCA server is connected to the VMS then the VCA modules will function in the same way as the Embedded analytics.~~

	=== Face recognition lists ===		=== Face recognition lists ===

Vcloudai at 10:54, 3 July 2026

2026-07-03T10:54:27Z

← Older revision		Revision as of 11:54, 3 July 2026
Line 564:		Line 564:
	#*Camera Sabotage Detection		#*Camera Sabotage Detection
	#* Object Detection		#* Object Detection
	#* Face ID Lite		#*Human detection
	~~# '''Additional AI Modules''' These specialized detectors are available as add-ons:~~		#*Vehicle detection
	#* Smoke & Fire Detection		#*People counting
			#*Vehicle counting
			#* Face recognition Lite
			#*Smoke & Fire Detection
	#* PPE (Personal Protective Equipment) Detection		#* PPE (Personal Protective Equipment) Detection
	#* ~~Traffic Analytics~~		#* Illegal parking detection
			#*Waste detection
			#*other additional AI models supplied with the software
	# '''YOLO Custom Video Analytics''' Integrate your own custom-trained models using the YOLO (You Only Look Once) architecture for object detection tailored to specific use cases.		# '''YOLO Custom Video Analytics''' Integrate your own custom-trained models using the YOLO (You Only Look Once) architecture for object detection tailored to specific use cases.
	# '''Visual Assistant – LLM-based Analytics''' A cutting-edge module powered by large language models (LLM) for advanced, customizable video analytics workflows using natural language logic.		# '''Visual Assistant – LLM-based Analytics''' A cutting-edge module powered by large language models (LLM) for advanced, customizable video analytics workflows using natural language logic.
	~~# '''VCA Enhanced Video Analytics Pack''' An advanced plugin-based solution that expands analytics capabilities significantly. 👉 [[Video Analytics Manual\|View VCA Analytics Manual]]~~
	# '''3rd Party Video Analytics Modules''' The VMS can integrate with external analytics providers, allowing flexible support for various industry-specific solutions.<br />		# '''3rd Party Video Analytics Modules''' The VMS can integrate with external analytics providers, allowing flexible support for various industry-specific solutions.<br />
	=== ~~Embedded~~ AI video analytics ===		=== AI video analytics ===
	Cluebase VMS has got a wide variety of embedded video analytics.		Cluebase VMS has got a wide variety of embedded video analytics.

Line 581:		Line 585:

	In the [[File:Ai.png\|alt=ai button\|20x20px]] menu choose the desired video analytics detector, enable, configure it and click [[File:Apply.png\|alt=apply\|50x50px]] to apply the settings.		In the [[File:Ai.png\|alt=ai button\|20x20px]] menu choose the desired video analytics detector, enable, configure it and click [[File:Apply.png\|alt=apply\|50x50px]] to apply the settings.
	[[File:~~Ai settings~~.png\|alt=ai settings\|none\|thumb]]		[[File:Video analytics editor.png\|alt=ai settings\|none\|thumb]]


	When required, enable the View zone option in the detector settings to use the detection zone (mask).		When required, enable the View zone option in the detector settings to use the detection zone (mask).
	[[File:Zone.jpg\|alt=zone\|none\|thumb]]		[[File:Zone.jpg\|alt=zone\|none\|thumb]]

	~~=== Additional AI Modules ===~~
	~~Cluebase VMS supports advanced AI-powered detectors that go beyond the standard embedded analytics. These modules are available as optional components and include:~~

	* '''Smoke & Fire Detection'''
	* '''PPE (Personal Protective Equipment) Detection'''
	* '''Traffic Analytics'''
	~~⚠️ '''Important:''' These features require the installation of the dedicated '''ai container''' on your system.~~

	~~During the installation process, the system will prompt the user with the following message in the console:~~
	~~Cluebase VMS analytics module will take 6 GB of free space. Would you like to proceed? Press 'y' to install or any other button to skip.~~

	* If the user '''presses y''', the AI container will be installed, enabling the Additional AI Modules to function within the VMS.
	* If the user '''presses any other key''', the installation will skip the AI container, and these modules will not be available. In this case, attempts to use the Additional AI Modules in the VMS will result in the following error message: '''“Analytics server is unavailable.”'''
	~~To ensure these features are active and operational, make sure the AI container is installed during setup.~~

	~~If the ai container is installed the Additional AI Modules will function in the same way as the Embedded analytics.~~

	=== YOLO Custom Video Analytics ===		=== YOLO Custom Video Analytics ===

Vcloudai at 06:08, 3 July 2026

2026-07-03T06:08:30Z

← Older revision		Revision as of 07:08, 3 July 2026
Line 349:		Line 349:

	Example: 10 sec means the camera will stay at each preset for 10 seconds before moving to the next.		Example: 10 sec means the camera will stay at each preset for 10 seconds before moving to the next.


			== Physical Keyboard Commands ==
			Cluebase VMS supports physical keyboard commands for faster operation in live view, layouts, PTZ control, and archive mode. These shortcuts are useful for operators who need to navigate between cameras, control video windows, switch layouts, or work with archive playback without using the mouse.

			General keyboard navigation:

			'''Arrow keys''' - Move between cameras in the current layout. The selected camera is highlighted with a blue frame.

			'''Enter''' - Enlarge the selected video window. Press again or use the interface controls to return to the layout view.

			'''A''' - Switch the selected camera to archive mode.

			'''Shift + Left Arrow / Shift + Right Arrow''' - Switch to the previous or next layout.

			'''M''' - Open or close the main menu.

			'''E''' - Open or close the events panel.


			<u>PTZ keyboard control:</u>

			When the PTZ control window is open, the keyboard can be used to control the selected PTZ camera.

			'''Arrow keys''' Move the PTZ camera up, down, left, or right.

			'''+ / -''' Zoom in or zoom out.

			'''Number keys 1-9''' Move the camera to the corresponding PTZ preset position.


			<u>Archive mode keyboard control:</u>

			When the selected camera is opened in archive mode, the following keyboard commands are available.

			'''Left Arrow / Right Arrow''' Move backward or forward between archive segments.

			'''+ / -''' Increase or decrease playback speed.

			'''Shift & ' + ' / Shift +& ' - '''' Zoom in or zoom out on the archive timeline.

			'''T''' - Open the timestamp navigation panel. The cursor is automatically placed in the time input field, so the operator can enter the required time immediately. Press Enter to jump to the selected timestamp.

	== Multi-server functionality ==		== Multi-server functionality ==