Page is loading ...
User manual
MOBOTIX HUB Desk Client 2023 R2
© 2023 MOBOTIX AG
Contents
Contents
Copyright 17
This documentation 18
What's new? 18
In MOBOTIX HUB Desk Client 2023 R3 18
This documentation 20
Licensing 21
MOBOTIX HUB Desk Client licensing 21
Licenses for your extensions 21
Requirements and considerations 22
Minimum system requirements 22
Surveillance system differences 22
Installation 23
Install MOBOTIX HUB Desk Client 23
Configuration 24
Setup mode (overview) 24
Settings in MOBOTIX HUB Desk Client 25
Application settings 25
Panes settings 28
Functions settings 28
Timeline settings 30
Export settings 30
Smart map settings 32
Search settings 32
Joystick settings 33
Keyboard settings 35
Access control settings 35
Alarm Manager settings 36
Advanced settings 36
Language settings 40
2 / 305
Contents
Change the language of MOBOTIX HUB Desk Client 40
Disable the help 41
Views (configuration) 41
Views and view groups (explained) 42
What can views contain? 43
Create view groups 45
Create views 45
Copy, rename, or delete views or groups 46
Add cameras and other elements to views 46
Assign shortcut numbers to views 47
Adding content to views (in detail) 47
Web page properties 51
Configuring the timelines 53
Configuration options for timelines 53
Configure what to show on the timeline tracks 53
Configure how to play back gaps between recordings 54
Optimize the display for viewing video by hiding the main timeline 54
Cameras (configuration) 55
Camera settings 55
Frame rate effect (explained) 60
Bounding boxes (explained) 60
Bounding box providers (explained) 61
Overlay buttons (explained) 61
Sound notifications (explained) 61
Audio (configuration) 62
Audio settings 62
Bookmarks (configuration) 63
Enable detailed bookmarks 63
Carousels (configuration) 64
Add carousels to views 64
Edit the carousel settings 65
3 / 305
Contents
Hotspots (configuration) 65
Add hotspots to views 65
Hotspot settings 66
PTZ presets (configuration) 66
Add PTZ presets 66
Edit PTZ presets 67
Delete PTZ presets 68
Patrolling profiles (configuration) 68
Add patrolling profile 68
Delete patrolling profile 69
Edit patrolling profile 69
Alarms and events (configuration) 70
Add alarms to views 70
Alarm list settings 71
Alarm preview settings 71
Smart map (configuration) 72
Differences between maps and smart maps (explained) 72
Add smart map to views 73
Change geographic backgrounds on smart maps 73
Geographic backgrounds (explained) 74
Types of geographic backgrounds (explained) 74
OpenStreetMap tile server (explained) 75
Change OpenStreetMap tile server 75
Showing or hiding layers on smart map 76
Layers on smart map (explained) 76
Order of layers (explained) 76
Show or hide layers on smart map 77
Specify default settings for smart map 77
Adding, deleting, or editing custom overlays 78
Custom overlays (explained) 78
Custom overlays and locations (explained) 78
4 / 305
Contents
Add custom overlay on smart map 79
Add locations to custom overlays (smart map) 80
Delete custom overlay on smart map 80
Make areas in shapefiles more visible (smart map) 80
Adjust position, size, or alignment of custom overlay 81
Adding, deleting, or editing devices on smart map 82
Add devices to smart map 83
Change field of view and direction of camera 83
Select or change device icon 84
Show or hide device information 84
Listen to audio from microphone on smart map 85
Remove devices from smart map 85
Adding, deleting, or editing links on smart map 87
Links on smart map (explained) 87
Add link to smart map location or map 87
Edit or delete link on smart map 88
Adding, deleting, or editing locations on smart map 88
Locations on smart map (explained) 88
Home locations for smart map (explained) 88
Add location to smart map 89
Edit or delete location on smart map 89
Linking between locations (explained) 90
Adding, deleting, or editing buildings on smart map 90
Buildings on smart map (explained) 90
Add buildings to smart map 90
Edit buildings on smart map 91
Delete buildings on smart map 92
Managing levels and devices in buildings (smart map) 92
Devices and levels in buildings (explained) 92
Floor plans and devices in buildings (explained) 93
Add or remove levels from buildings (smart map) 93
5 / 305
Contents
Change order of levels in buildings (smart map) 93
Set default level for buildings (smart map) 94
Add floor plans to levels (smart map) 94
Delete floor plans on levels (smart map) 95
Add devices to buildings (smart map) 96
Maps (configuration) 96
Add maps to views 96
Map settings 97
Map toolbox (explained) 98
Maps - the right-click menu (explained) 99
Change the background of a map 99
Remove the map 99
Add and remove elements from maps 99
Add a hot zone to a map 100
Change the appearance of map elements 101
Edit and rotate labels on a map 103
Add/edit text on a map 103
Matrix (configuration) 104
Add Matrix to views 104
Matrix settings 104
MOBOTIX HUB Access (configuration) 105
Add access monitors to views 105
Access monitor settings 105
Modify access monitor settings 106
Customize your view 107
Manage cardholder information 107
Turn access request notifications on or off 107
XProtect LPR (configuration) 108
Add LPR cameras to views 108
Adjust LPR view settings 108
Enable LPR server status on maps 108
6 / 305
Contents
Enable LPR-specific elements 109
XProtect Transact (configuration) 110
Getting started with XProtect Transact 110
XProtect Transact trial license 111
Set up views for transactions 111
Adjust settings for transaction view items 112
Scripting 113
Scripting for log in (explained) 113
Scripting for log in - parameters 114
Scripting HTML page for navigation 117
Optimization 121
Enabling hardware acceleration 121
Hardware acceleration (explained) 121
Check hardware acceleration settings 121
Verify your operating system 122
Check CPU Quick Sync support 122
Examine the Device Manager 123
Check NVIDIA hardware acceleration support 124
Enable the Intel display adapter in the BIOS 124
Update the video driver 124
Check memory modules configuration 125
Enabling adaptive streaming 126
Adaptive streaming (explained) 126
Check adaptive streaming settings 127
Check available live video streams 128
Monitor your system 129
Monitor client resources 129
System Monitor tab with MOBOTIX Federated Architecture (explained) 130
Operation 131
Logging in and out 131
Log in 131
7 / 305
Contents
Log out 132
Login authorization (explained) 132
Logging into access control systems (explained) 132
Change password in MOBOTIX HUB Desk Client 132
Allow connections that use an older security model (HTTP) 133
Clear setting that allows connections that use an older security model 134
Restore windows and tabs when logging in 134
Define to restore windows and tabs when logging in 134
Managing views 135
Searching for views and cameras (explained) 135
Change individual cameras temporarily 137
Swap cameras 137
Send video between open views 138
Open additional views tabs and close them again 138
View video in multiple views simultaneously 139
Synch the time in a detached window with the main window 139
Working with detached windows 139
Navigating your cameras and views 141
Hotspots (explained) 141
Use hotspots 142
Carousels (explained) 142
Use carousels 142
Digital zoom (explained) 143
Use digital zoom 143
Virtual joystick and PTZ overlay buttons (explained) 145
Views and shortcuts (explained) 145
Keyboard shortcuts (overview) 146
Viewing live video 147
Live video (explained) 147
Live mode (overview) 148
Camera toolbar (overview) 149
8 / 305
Contents
Hide camera toolbar 150
Camera indicators (explained) 151
Record video manually 152
Take single snapshots 152
Investigating incidents 153
Viewing recorded video (explained) 153
In playback mode 154
In live mode 155
On the Search tab 155
Playback mode (overview) 156
View recorded video independently of the main timeline 157
Investigate your search results 158
Creating video evidence 158
Export video, audio, and still images 159
Add video sequences to the Export list 159
Adjust export settings 160
Create the export 161
Add privacy masks to recordings during export 162
Storyboards (explained) 163
Export storyboards 163
Export locked video evidence 164
View exported video 164
Printing or creating surveillance reports 165
Print report from single cameras 165
Create reports from search results 166
Copy images to clipboard 167
Export settings 168
MOBOTIX HUB format settings 168
Media player format settings 170
Still images settings 171
Exports tab (overview) 172
9 / 305
Contents
Locking video evidence 172
Evidence locks (explained) 173
Create evidence locks 173
View evidence locks 176
Edit evidence locks 176
Play back video with evidence locks 176
Export locked video evidence 177
Delete evidence locks 177
Evidence lock settings 178
Evidence lock filters 179
Evidence lock status messages 179
Restricting access to videos 181
Video restrictions (explained) 181
Video restrictions and different sites 181
Playback restrictions created 182
Live restrictions created 182
Video restrictions and Evidence locks 182
Create restrictions on live or recorded video 183
Creating new restrictions on cameras that already contain restrictions 184
Live restrictions 184
Playback restrictions 184
View restricted video 185
View a restricted video from the Video restrictions list. 185
Edit video restrictions 185
Remove video restrictions 186
Removing playback restrictions 186
Removing a live restriction 186
Exporting restricted videos 187
The Video restrictions list 187
Hidden or undisplayed live restrictions 187
Searching and filtering the list 188
10 / 305
Contents
Search 188
Filter 188
Video restrictions list settings 189
Video restriction status messages 189
Searching for video data 190
Search for video 190
Search for motion (smart search) 195
Motion search threshold (explained) 197
Search for bookmarks 197
Search for alarms 199
Search for events 199
Search for people 199
Search for vehicles 200
Search for video at location 201
Search results, settings, and actions 201
The search timeline on the Search tab 201
Actions available from search results (overview) 202
Merged search results (explained) 203
Match any or all search criteria (explained) 204
Start search from cameras or views 204
Open search results in detached windows 205
Preview video from search results 205
Show or hide bounding boxes during search 207
Sorting options 207
Locate cameras while searching 208
Camera icons (explained) 211
Bookmark search results 212
Edit bookmarks from search results 213
Take snapshots from search results 214
Transfer the search time to the main timeline 215
Managing your searches 215
11 / 305
Contents
Save searches 216
Find and open saved searches 217
Edit or delete saved searches 219
Bookmarks (usage) 220
Bookmarks 220
Bookmark window 220
Add or edit bookmarks 223
Delete bookmarks 224
Find or export bookmarked video 224
Alarms and events (usage) 225
Alarms (explained) 225
Alarm list (explained) 225
Servers in alarm list (explained) 226
Alarm states (explained) 226
Filter alarms 226
Responding to alarms 227
Viewing and editing details of an alarm 227
Acknowledge alarms 228
Disable all new alarms on selected event types 228
Ignore alarms on maps 229
Close alarms 230
Print alarm reports 230
Get statistics on alarms 230
Alarms on maps (explained) 231
Alarms on smart maps (explained) 232
Events (explained) 232
Manually activate events 232
Privacy masking (usage) 233
Privacy masking (explained) 233
Lift and apply privacy masks 234
PTZ and fisheye lenses (usage) 238
12 / 305
Contents
Fisheye lens images (explained) 238
Define a favorite fisheye lens position 239
PTZ and fisheye lens images (explained) 239
PTZ images (explained) 239
Move cameras to PTZ preset positions 240
Locked PTZ presets (explained) 240
Starting, stopping, or pausing PTZ patrolling 241
Stop PTZ patrolling 241
Manual patrolling (explained) 241
Start and stop manual patrolling 242
Pause patrolling 243
Reserved PTZ sessions (explained) 244
Reserve PTZ sessions 245
Release PTZ sessions 245
Virtual joystick and PTZ overlay buttons (explained) 245
Audio (usage) 246
Audio (explained) 246
Talk to an audience 246
Smart map (usage) 247
Smart map (explained) 247
Smart map and alarms (explained) 247
Smart map and search (explained) 247
Grouping of devices (explained) 249
Get overview of grouped devices 251
Zoom in and out 252
Preview live video from one camera 253
Preview live video from multiple cameras 253
Use hotspot to view video from cameras on smart map 254
Go to smart map locations 255
Jump to device on smart map 255
Jump to custom overlays on smart map 256
13 / 305
Contents
Backtracking to previous locations (explained) 257
Maps (usage) 257
Maps (explained) 257
How elements interact with maps 258
Map overview window (explained) 261
Send cameras from a map to a floating window 261
View recorded video from cameras on a map 262
View status details 262
Zoom and auto maximize 262
Matrix (usage) 263
Matrix (explained) 263
Viewing Matrix content (explained) 263
Manually send video to Matrix recipients 264
Repair a database exported in MOBOTIX HUB format 264
Edge storage and MOBOTIX Interconnect 265
The main timeline and edge retrieval 265
Retrieve recordings manually 265
View all edge retrieval jobs 266
MOBOTIX HUB Access (usage) 266
Access control in live mode (explained) 266
Monitor doors via maps 266
Investigating access control events 267
Search and filter access control events 267
Events list (explained) 268
Export an access report 268
Switch to or from live update mode of the Events list 268
Monitor and control door states 269
Doors list (explained) 270
Investigate cardholders 270
Access request notifications (explained) 271
Managing access request notifications (explained) 271
14 / 305
Contents
Respond to access requests 271
XProtect LPR (usage) 272
LPR in live mode (explained) 272
LPR on the Search tab (explained) 272
LPR tab (explained) 272
LPR event list (explained) 273
License plate styles 273
Filtering LPR events (explained) 273
Edit match lists 274
Import or export match lists 275
Export LPR events as a report 275
LPR on the Alarm Manager tab 276
View LPR recognitions 276
XProtect Transact (usage) 277
XProtect Transact (overview) 277
Observe live transactions 278
Investigating transactions 279
Investigate transactions in a view 279
Investigate transactions using search and filters 281
Investigate transactions from a disabled source 282
Investigate transaction events 282
Investigate transaction alarms 283
Print transactions 284
Maintenance 285
Check the status of your server connection 285
Troubleshooting 286
Installation (troubleshooting) 286
Error messages and warnings 286
Logging in (troubleshooting) 286
Error messages and warnings 286
Audio (troubleshooting) 288
15 / 305
Contents
Exporting (troubleshooting) 288
Metadata (troubleshooting) 288
Error messages and warnings 288
Searching (troubleshooting) 289
Error messages and warnings 289
Smart map (troubleshooting) 289
Error messages and warnings 290
Web pages (troubleshooting) 290
XProtect Transact (troubleshooting) 291
Error messages and warnings 291
Upgrade 292
Upgrading MOBOTIX HUB Desk Client 292
FAQ 293
FAQ:alarms 293
FAQ: audio 293
FAQ: bookmarks 294
FAQ: cameras 294
FAQ: digital zoom 295
FAQ: displays and windows 295
FAQ: exporting 296
FAQ: maps 297
FAQ:notifications 297
FAQ: searching 298
FAQ: smart map 301
FAQ: views 303
16 / 305
Copyright
Copyright
MOBOTIX AG • Kaiserstrasse • D-67722 Langmeil • Tel.: +49 6302 9816 0 • sales@mobotix.com • www.mobotix.com
MOBOTIX is a trademark of MOBOTIX AG registered in the European Union, the U.S.A., and in other countries. Subject
to change without notice. MOBOTIX do not assume any liability for technical or editorial errors or omissions contained
herein. All rights reserved. © MOBOTIX AG 2023
17 / 305
This documentation
This documentation
What's new?
In MOBOTIX HUB Desk Client 2023 R3
Multiple views tabs:
lYou can create as many tabs with views as you want in MOBOTIX HUB Desk Client’s main window and in
detached windows. Tabs with views are named after the selected view.
Restore windows and tabs at login:
lImproved functionality and descriptions.
Adding, deleting, or editing devices on smart map:
lYou can add and enable output devices the same way as input devices.
Adding, deleting, or editing custom overlays on smart map:
lIn Shapefiles, you can add fill- and line colors to make your shapefiles look sharper.
In MOBOTIX HUB Desk Client 2023 R2
Redesign of the main timeline:
lDocumentation about the main timeline has been updated to reflect the redesign.
lTo optimize the display for viewing video, two new features for hiding the main timeline during inactivity have
been added.
lThe documentation for the different configuration options for the timelines has been updated.
Two new guides for specific audiences:
lA MOBOTIX HUB Desk Client getting started guide aimed at new users.
lA MOBOTIX HUB Desk Client – Player quick guide aimed at operators and authorities or other security
professionals outside your organization who receive exported video in the MOBOTIX HUB Desk Client – Player
format.
Privacy Masking:
lAdding and removing privacy masks now apply to all video sequences in exports from cameras you select in the
Export list.
In MOBOTIX HUB Desk Client 2023 R1
A new Views tab replaces the Live and Playback tabs:
18 / 305
This documentation
lOn the Views tab, you can select to view video in live or playback mode with a new toggle switch.
lWhen in playback mode, the same features and functionalities are available as they were on the Playback tab.
lWhen in live mode, the same features and functionalities are available as they were on the Live tab.
The buttons for respectively Export,Evidence lock, and Video restrictions have been moved from the lower-right
corner of the MOBOTIX HUB Desk Client to the workspace toolbar in the upper-right corner.
MOBOTIX HUB Incident Manager:
lTo comply with GDPR or other applicable laws concerning personal data, administrators of MOBOTIX HUB
Management Client can now define a retention time for incident projects.
In MOBOTIX HUB Desk Client 2022 R3
MOBOTIX HUB Incident Manager:
lThe MOBOTIX HUB Incident Manager extension is now also compatible with MOBOTIX HUB L4, MOBOTIX HUB
L3, and MOBOTIX HUB L2 version 2022 R3 or later.
lMOBOTIX HUB Incident Manager can now show more than 10,000 incident projects.
In MOBOTIX HUB Desk Client 2022 R2
MOBOTIX HUB Incident Manager:
lThe first release of this extension.
lThe MOBOTIX HUB Incident Manager extension is compatible with MOBOTIX HUB L5 version 2022 R2 and later
and with MOBOTIX HUB Desk Client version 2022 R2 and later.
XProtect LPR:
lOn the LPR tab, you can now see the license plate style associated with an LPR event. See License plate styles
on page 273
Bookmarks:
lWhen you enter a keyword to filter your search results for bookmarks, you can now decide where the system
should search for the keyword: in all bookmark fields, in the Headline only, or in the Description only. See
Search for bookmarks on page 197
In MOBOTIX HUB Desk Client 2022 R1
Export:
lEverything related to exporting video data now lives on a dedicated tab called Exports.
In MOBOTIX HUB Desk Client 2021 R2
Export:
lTo increase security, the MOBOTIX HUB format is the default export format. To enable other export formats,
please contact your system administrator
New camera icons:
lNew camera icons allow you to distinguish between fixed cameras and PTZ cameras
19 / 305
This documentation
Vertical scrolling of views and cameras:
lUse Shift in combination with the scroll-wheel to move the navigation area to the left or right
Removed features:
lCamera navigator
lSimplified mode. This feature has also been removed in MOBOTIX HUB Desk Client – Player which is used to
view video exports
In MOBOTIX HUB Desk Client 2021 R1
Searching:
lSort your search results by Relevance. See also Sorting options on page 207
lAdministrators can control the number of cameras that are allowed in one search
Smart map:
lGet an overview of grouped devices. When you are zoomed out, click a cluster1to see the types and number of
devices within a specific area. See also Get overview of grouped devices on page 251
lImproved zoom capability. Double-click a cluster to zoom in on grouped devices. See also Zoom in and out on
page 252
Security:
lBasic users can change their password, either on their own initiative or if an administrator enforces the need for
change. See also Change password in MOBOTIX HUB Desk Client on page 132
This documentation
This user manual is mainly for MOBOTIX HUB Desk Client operators2, but also for system administrators and
integrators responsible for configuring, maintaining, and troubleshooting MOBOTIX HUB Desk Client. Most of the
configuration, however, takes place in MOBOTIX HUB Management Client.
You can find other documents with explanations to how to solve operator, investigator, and supervisor tasks in
MOBOTIX HUB Desk Client.
If the manuals and guides for MOBOTIX HUB Desk Client do not provide the information you
need, contact your reseller.
1a grouping of devices or plug-in elements – or a combination - on the smart map displayed visually as a circular icon
with a number. Clusters appear on certain zoom levels indicating the number of devices or plug-in elements within a
particular geographical area.
2A professional user of an MOBOTIX HUB client application.
20 / 305
/
