Professional Documents
Culture Documents
VH 6.0-Administrator - User Guide
VH 6.0-Administrator - User Guide
Administrator Application
User Guide
April 2021
Version 6.0
Rev. 00
Copyright 2021 Qognify. All rights reserved.
All information contained herein is confidential, proprietary and the exclusive property of Qognify
Ltd and its affiliates (“Qognify”). This document and any parts thereof must not be reproduced,
copied, disclosed or distributed without Qognify's written approval and any content or information
hereof shall not be used for any unauthorized purpose. The software described herein and any
other feature or tools are provided "AS IS" and without any warranty or guarantee of any kind.
Contents
Take a few minutes to review the material in this guide and familiarize yourself with the Qognify Administrator
Application Setup program before you attempt to install it.
By default, the VisionHub installation includes some predefined content already built-in to simplify its configuration. This
predefined content also serves as sample use cases to enhance system deployment by making proven content available.
You can either customize the included content definitions to your needs, or use them as examples in creating your own
custom content.
Roles – Administrator, Supervisor, Operator with relevant authorization permissions. Refer to Understanding
Default Roles on page 23.
Incident generation content – Fully functional incident content that includes predefined Incident Types, rules for
triggering an incident, automatic actions, procedures and Quick Launch buttons. For more information, refer to
Understanding Built-In Content for Incident Handling on page 258.
If no external login provider is implemented, The Administrator Application log in window opens.
Username: admin
Password: admin
NOTE: You can authenticate users through an external login provider such as Azure Active
Directory or Active Directory SSO. In VisionHub, To implement use, define the Active
Directory within User Roles. Refer to Defining and Managing User Security Roles on
page 18
NOTE: After logging in to the application for the first time, you can change your password
from the default password (admin). It is recommended to change the password periodically
to prevent unauthorized entries.
a. Read through the statement and select the I have read and accept the privacy statement check box.
b. Click Save. The statement acknowledgment is saved in the system and will not appear next time you log
into the system, unless the statement changes.
If you click Close, the privacy statement acknowledgment is not saved and will appear every time you log
into the application.
To review and acknowledge the statement after closing it - from the Help menu select Privacy
Statement.
NOTE: A successful login credential is made up of a valid user name and password and must satisfy
several additional password policy restrictions, such as: password length, special characters, number of
failures to log in before access is denied, etc. Refer to Defining User Login and Password Authentication
on page 62 for more information.
Button Description
Disconnected You are disconnected from the web server. Contact your IT person.
This section provides a reference for the Administrator Application windows and toolbars.
Item Description
Item Description
Administration view A navigation tree that enables accessing the various administration modules in order to
Modules pane configure and manage:
Administration view The workspace provides configuration and management tools for each administration
modules workspace module.
Item Description
View menu Menu from which you can refresh the application or navigate to one of the views.
Item Description
Connected Users Enables authorized users to view and manage all users currently connected to the
button Control application. Refer to Defining VisionHub Users on page 80.
Status button Icon toggles from connected to disconnected if connection to server is lost.
(Connected
/Disconnected)
Logged In User Displays the currently connected user name with option to log out. Refer to Logging
into/out of Administrator Application on page 10.
VisionHub is a multi-user environment, offering strong and flexible support for user authentication and permissions.
Highly customizable, VisionHub enables organizations to configure security settings to the organization’s specific needs.
NOTE: Only users with "manage" privileges can manage user authorizations and authentication.
User security role for defining a user's access to various VisionHub functionalities and resources
User authentication for managing policies for user login sessions through password restrictions, the number of
login failure attempts permissible, and terminal login restrictions
As an administrative user, you configure security roles and authentication policies for all users in the organization. Once
these are defined, you can apply them to users.
Users and user passwords can also be stored in an authentication provider outside of the VisionHub Server (such as
Microsoft Active Directory). This enables users to automatically authenticate via Single Sign-On (SSO) to VisionHub
using their Windows login credentials without having to manually enter their credentials.
For information about Defining the User Identity Provider on page 66ו
For information about enabling SSO for VisionHub, refer to Defining External Login Authentication (SSO) on page 73.
VisionHub provides hierarchical, role-based authorization policies. Each VisionHub user is assigned a security role, or
"role", which determines that user’s access to various VisionHub functions, and an authentication policy, which
determines that user's login permissions. Examples of roles include: operators, building managers and patrol officers.
NOTE: You can add up to 200 parent roles in a large site and up to 30 roles in a small site. For more
information, refer to Site(s) Capacity in the VisionHub System Requirements Guide.
VisionHub's highly flexible inherited permissions mechanism enables administrators to define authorization permissions
on a highly granular level. An administrative user with "manage role" privileges can create a role with defined
authorization permissions and then assign it to multiple users, thus saving the need to repeatedly define the same
authorization settings for each user. The user can then create a child role, which inherits the permissions of the parent
role, and modify the permissions rather than start from scratch. Likewise, the user can link a parent role to another
parent role so the child linked to both parents inherits both parents' permissions. For more information about
authorization permissions and inheritance, refer to Managing Role Authorization Permissions on page 31.
Organizations can build their role hierarchy trees using a number of different logical approaches for maximum efficiency.
Before creating your tree, think about the most effective structure for your organization. The design of your tree should
support its purpose.
For example, when building the tree for a site, the administrator might take a "top-down" approach by first creating a
grandparent ("super administrator") role with all permissions and then adding parents and children. Using this approach,
the administrator reduces the scope of permissions, generation by generation. By denying permissions to the parents,
the permissions are also denied to the children. The administrator can then further limit the permissions of the children
without affecting the parents and grandparent.
Alternatively, the administrator might take a "bottom-up" approach by first creating the children with a reduced set of
permissions, then creating the parents, who inherit the permissions in the children plus more permissions, and finally,
creating the grandparent - who inherits the permissions in both the parents and children - and allowing all permissions.
If an authorization permission is denied in a child role, it is not automatically denied in the parent role. However, if it is
denied in the parent role, it is automatically denied in the child role and cannot be allowed as long as the roles are linked.
A parent role linked to child roles cannot be deleted until the children are deleted.
A parent role can be associated to another parent role and then both parent roles linked to child roles. The children of
these linked parents inherit the permissions from both parents, as shown in the images above.
Roles can also be copied. The duplicated role inherits the permissions of the original role. However, duplicate roles are
not linked, thus they are not both affected when one is denied or allowed authorization permissions.
The hierarchical, role-based authorization policy environment enables administration delegation, allowing an
organization to manage multi-tenancy needs. For example, a cloud VMS solution might require the super administrator
to allocate a subset of the permissions\cameras to the administrator of each of the cloud tenants. Thus, each cloud
tenant administrator can create a role and users which contain a subset of the permissions\cameras allocated to the
tenant.
Or, for example, a security manager might want to delegate the security management of a particular department to the
department manager. By creating a "department" role and assigning that role to the department manager, the
department manager can define department-specific authorizations for both users and managing or operating sensors in
that department.
Roles enable the easy modification of the authorization and authentication policies of a user by simply moving the user
to a role associated with different policies. It is also possible to define policies that are inactive at a specific moment, but
that can become active upon the changing security needs within the organization.
The Roles workspace provides a white board that enables users to get an immediate and visual understanding of the
organization's role hierarchy. The roles are clearly color coded and show icons according to their status. In addition,
arrows show the relationship between linked roles, such as a parent and its children or two associated parents and their
children.
Dark The role either has no children or is the first generation in a grandparent-parent-
blue child hierarchy
Light The role is the middle generation between two generations in a grandparent-
blue parent-child hierarchy
Role hierarchy trees can be viewed in a number of layouts, including tree up, tree down, tree right, tree left, as a radial
tree, or as a tip-over tree.
Using the zoom - and zoom + buttons or by dragging the zoom slider left or right, you can easily zoom in/zoom out on
roles on the white board. Selecting a role immediately zooms in on the role and grays out surrounding roles, bringing the
selected role into focus on the white board.
The Roles options pane enables authorized users to manage role authorization permissions, add users to roles, associate
parents, and manage domain groups. The Roles options pane can be easily expanded and collapsed as needed.
By default, the system has three built-in roles which contain preset general authorization permissions. For more
information, refer to Understanding Default Roles on page 23.
Administrator - has full authorization to manage all user and role privileges. If you defined Azure AD as the
identity provider, the Administrator becomes a Super Role user. You must re-associate it to the domain group.
Supervisor - has limited permissions to manage operators and system entities (such as incidents, maps, pages,
and video).
Operator - has limited permissions to operate video and incidents.
For more information about role authorization permissions, refer to Managing Role Authorization Permissions on
page 31.
To select a layout:
In the lower right corner of the white board, in the Layout drop-down list, select a layout option as desired to view the
role tree structure:
Using the Zoom In/Zoom Out buttons, at the bottom of the white board:
Administrator - has full authorization to manage all user and role privileges. If you defined Azure AD as the
identity provider, the Administrator becomes a Super Role user. You must re-associate it to the domain group.
Supervisor - has limited permissions to manage operators and system entities (such as incidents, maps, pages,
and video).
Operator - has limited permissions to operate video and incidents.
The permissions automatically included in each default role are provided in the following table. For more information
about authorization permissions, refer to Managing Role Authorization Permissions (see page 38).
Y = Yes
Login to Control Y Y Y
Login to Planner Y
Login to Administrator Y Y
Manage Services Y
Add User Y
Manage Assignments Y Y
Add Role Y
Manage Gateway Y
Add Sensors Y
Add Tour Y
Configure LOS Y
Manage Decoders Y
Manage Triggers Y
Operate Markers Y Y Y
Publish Pages Y Y
Sensors Y
For more information about role authorization permissions and assigning users to a role, refer to Managing Role
Authorization Permissions on page 31.
NOTE: When deleting roles, you cannot delete a parent role without first deleting its children or removing
its associated parent roles.
When you create a role, it is automatically given a name by the system. You must edit it to change the name. Refer to
Editing Roles on page 29.
3. In the Roles workspace toolbar, click the Add New Role button. The Add New Role dialog box opens.
4. In the Role Configuration tab, define the role name and description.
5. Click Save.
To delete a role:
1. In the Roles workspace, right-click the role you want to delete and then click Delete Role. A confirmation
message appears.
2. To delete, click Yes. To cancel the deletion, click No.
To find a role:
1. In the navigation bar, click Administration.
2. In the Modules pane, click Roles. The Roles workspace opens.
3. In the Roles workspace toolbar, in the Search for roles search bar, start typing the desired role. Roles matching
your keystrokes are highlighted in the list.
4. Click the relevant role in the list. The application zooms in on the selected role and grays out surrounding roles,
bringing the selected role into focus.
NOTE: When you create a role, it is automatically given a name by the system. You must edit it to change
the name.
To edit a role:
1. In the navigation bar, click Administration.
2. In the Modules pane, click Roles.The Roles workspace opens.
3. Right-click a role and click Edit Role. The Edit Role dialog box opens.
To copy a role:
1. In the navigation bar, click Administration.
2. In the Modules pane, click Roles.The Roles workspace opens.
3. Right-click a role and click Copy Role.The role is now copied and the word "Copy" is added to its name to
indicate that it is a copy.
Overview
VisionHub provides a highly flexible and customizable hierarchy, role-based authorization policy environment, which
enables you to define parent and children roles as well as associate parent roles. Parent and children roles are linked,
which means the children roles inherit the authorization settings of the parent role. Children linked to a parent
associated with a second parent inherit authorization settings from both parents.
Changes made to authorization permissions in the parent role are automatically changed in its children.
However, changes made to the children are not automatically changed in the parent.
A denied authorization setting always takes precedence over an allowed authorization setting:
If an authorization permission is denied in a parent role, you cannot allow it for the child.
When two parents are associated and both are linked to the same child, if an authorization setting is
allowed to one parent but denied to the second parent, it will be denied to the child as well. However, if the
authorization setting is allowed to both parents, it will also be allowed to the child.
A parent role linked to child roles cannot be deleted until the children are deleted.
3. Right-click a role and click Manage Role. The Edit Role dialog box opens (General tab).
When enabling/disabling authorizations, you will be selecting or clearing Allow and Deny check boxes in the Manage Role
pane authorization tabs.
NOTE: Only a user with 'Manage Roles ' permission allowed in his role can access the Manage Role pane.
NOTE: The Role management pane can be undocked and moved as needed.
When an authorization setting is inherited, it is grayed out in the Manage Role authorization tabs, as described in the
table below.
Table Legend:
NOTE: An authorization setting in bold text indicates that a change was made to the setting.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
No authorization is set. X X
Authorizations setting are provided on a highly granular level, giving you to the ability to fully customize authorization
policies for individual entities and groups of entities.
General
Quick Launch
Monitors
Maps
Users
Roles
Sensors
Groups
The following sections describe how to set permissions in each of these tabs.
Login
Login to Mobile Viewer Log in to the VisionHub Mobile Viewer application. Mobile Viewer
Login to Video Log in to the VisionHub Video Configurator application. Video Configurator
Configurator
Administrative
Manage External Users View Users Discovery module in the Administration view. Administrator
Send badge status change to the gateway and update the
badge.
Add User Discover users from the gateway and add/delete/update users. Administrator
View assignments
Set, update, activate, insert and/or delete new and/or
recurring shift plans and/or shift plan assignments.
Activate/delete shift plan by ID.
Assign button in the Assignments module.
View Connected Users View and manage all users currently connected to the Control Administrator
web application.
Administrative Associate each user to a job title without taking into Administrator, Planner
Operations and consideration the “Manage Users” permission.
Security Management
Configure Mobile Configure server parameters and data within the Mobile Viewer Mobile Viewer
Viewer application.
Manage Automatic Add/delete/update automatic actions wherever they appear in Administrator, Planner
Actions the system.
Sensors
Manage Gateway View and manage the Gateways tab in Administration pane. Administrator
Video/Audio
Manage Video Define Video Restrictions. User must also have permissions Control, Administrator,
Restriction Manage User and Manage Security Role. Refer to Control User Video Configurator
Guide, Managing Video Restrictions.
Configure Client Define the bandwidth of video stream between the client and the Control
Streaming Setup recorder in order to ensure the stream will not pass the defined
bandwidth.
Configure Level of Configure LOS, which defines the TCP/UDP/Multicast protocol Control
Service (LOS) of video stream between the client and the recorder.
Password Protected Add password in the Export wizard while exporting video. Control
Export
Manage Video Walls Add, delete and/or update display video wall layouts. Administrator
SVR - shutdown, Shutdown, perform manual fail over and reset Smart Video Video Configurator
manual fail over, reset Recorders and Daylight Savings Recorders.
Manage Digital Preset Create and edit presets for digital cameras (non-PTZ) Control and
Administrator
Configure export and Without this permission the Export path is restricted to the Control
snapshot path value set in the Administrator. The permission enables user to
change the Export path in Settings > Investigation experience
and in the Export window. This path is used for snapshots as well
as exported videos. The permission is affected by the User
Settings permission, as follows:
Incidents
Find All Closed Access and use the Closed Incidents filter. Control
Incidents
Export multiple Export incidents report in Excel format according to incident Control
incidents report filter.
Maps
Set Default Map View Set a map view as the default view. Administrator
Pages
Scheduler
View Scheduled Tasks Run Scheduled Tasks by status, task ID, or entity type. Administrator
Results
Reports
Generate Audit Report View the Audit Events module, filter events and export events. Administrator
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
The Quick Launch tab provides authorization permissions for viewing, adding and managing Quick Launch procedures.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. In the Quick Launch pane, click the Quick Launch procedure you want to set permissions for. You can use the
search bar to locate a particular item in the Quick Launch pane.
NOTE: Only Quick Launch procedures created in Planner are listed in this section. Refer to the
VisionHubPlanner User Guide for more information.
7. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. In the Monitors pane, click the Monitor you want to set permissions for. You can use the search bar to locate a
particular item in the Monitors pane.
7. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
Layers
General
GIS
Favorites
General
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
The sections of the tab can be expanded/collapsed by clicking the arrow next to the section header.
6. In the Map Views pane, click the map view you want to set permissions for.
NOTE: Only Map Views added in the Maps view > Map Views pane are listed.
7. In the Items pane, select the map layer or map Favorite you want to set permissions for. The permissions in the
Permissions pane change according to the selected item.
You can filter to show the items you want to set permissions for as follows: Show Layers, Show Favorites,
Show All.You can also use the search bar to locate a particular item in the Items pane.
8. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
The Manage Roles workspace opens (the General tab opens by default).
6. In the Users pane, click the user you want to set permissions for. You can use the search bar to locate a particular
item in the Users pane.
NOTE: Users added in the Users Administration pane are listed in this pane. Refer to Defining
VisionHub Users on page 80 for more information.
7. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
Manage Security Role Add/delete/edit roles and add authorization permissions Administrator
to role.
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. In the Roles pane, click the role you want to set permissions for. You can use the search bar to locate a particular
item in the Roles pane.
7. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
If a permission is set for all entities in a group and then a different permission is set for one of the entities in the group,
the entity level permission takes precedence.
NOTE: "Managing" privileges depend on "Viewing". Therefore, when you select a "Managing" check box,
the "View" check box is automatically checked with a grayed-out check.
In some cases, all permissions are dependent upon "Managing" privileges. Selecting a "Managing" check
box automatically selects all dependent permissions with a grayed-out check.
SensorsTab Permissions:
General
Audio/Video
VA operations Perform Video Analytic operations for all supported sensors in the group. Control
PTZ Operations Perform PTZ operations for all PTZ cameras in the group. Control
Manage Digital Preset § Create and edit presets for digital cameras (non-PTZ) Control and
Administrator
Playback Play pre-incident playback, Playback, and Playback for add camera to Control
matrix.
Sensors
Emulate Sensor Emulate alarm and/or reset failures or tampers for testing purposes on Control and
any sensor in the group. Administrator
Operate sensor admin Perform administrative operations, such as move, show location Control and
history, etc., for all sensors in the group. Administrator
Arm/Disarm, Bypass or Reset sensors.
Access Control
Open Door Open an Access Control door in the group. Control and
Administrator
Lock/Unlock/Normal Perform Access Control operations for any Access Control sensor in the Control and
door group. Administrator
Grace ACS Badge Configure the grace period (time past the badge expiration time) that the Control and
Access Control badge is still active before it is disabled for all Access Administrator
Control sensors in the group.
General
Ungrouped Sensors:
General
Audio/Video
PTZ Operations Perform PTZ operations for selected PTZ camera. Control
Sensors
Emulate Sensor Emulate alarms, failures, or tampers for testing purposes on a Control and
specified sensor. Administrator
Operate Sensor Admin Perform administrative operations, such as move, show location Control and
history, etc., for a specified sensor. Administrator
General
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. In the Groups pane, click the logical group you want to set permissions for.
Only groups created in the Sensors view > Groups pane are listed.
7. In the Items pane, select the item you want to set permissions for. The permissions in the Permissions section
change according to the item selected.
You can filter to show the items you want to set permissions for as follows: Show Sensors, Show Pages,
Show Virtual Tours, Show All.
You can also use the search bar to locate a particular item in the Items pane
8. For each of the permissions listed, select Allow or Deny, as necessary. For information about role authorization
inheritance, refer to Managing Role Authorization Permissions on page 31.
NOTE: After setting permissions, a red mark displays next to the tab name, indicating that
changes have been made and have not been saved.
However, if a sensor is associated with another group that is not denied visibility, then that group will not be hidden and
the sensor will display in that group.
NOTE: Hiding the visibility of a group applies to all siblings in the group.
To create a new role, refer to Adding/Deleting Roles and Children Roles on page 26.
To edit a role, refer to Editing Roles on page 29.
4. Do one of the following:
The Manage Roles workspace opens (the General tab opens by default).
6. In the Groups pane, click the Logical Group you want to set permissions for.
NOTE: Only logical groups created in the Sensors view > Groups pane are listed.
7. In the Permissions pane, next to the View Group Name permission, select or clear the Deny check box as
necessary. To understand role authorization inheritance, refer to Managing Role Authorization Permissions on
page 31.
IMPORTANT: To select Deny for a group and also to its sub-groups, start from the bottom of the
hierarchy - first sselect the sub\child groups and then the parent group.
After setting permissions, a red mark displays next to the tab name, indicating that changes have been made and
have not been saved.
In the Roles option pane, you can add users to a role, associate parents and view domain group associations. The
pane also provides easy access of the Roles authorization permissions. You can access this pane and use its
management options if you have "manage role" privileges.
Users can be added to a role from the Roles option pane or from a user's Properties dialog box. To add a role to a
user, refer to Defining VisionHub Users on page 80.
4. In the Roles workspace, click a role and then, in the Roles options pane, click the Users tab.
5. In the Users tab, click the + button. The Find Users dialog box opens.
In the search bar, start typing the desired user or job title. Names or job titles matching your keystrokes
are highlighted in the list. Double-click the relevant name in the list. It populates the Selected Users field.
In the Selected Users field, start typing the desired user. A drop-down list opens with names matching
your keystrokes. Double-click the relevant name in the list. It populates the Selected Users field.
a. In the Job Titles and Groups drop-down list, select a group of job titles or select All Job Titles.
The Job Titles list populates according to your selection.
b. In the Job Titles list, double-click the relevant job titles group. The users matching that job title
populate the users list. Click the relevant user and then click the Select button or double-click the
relevant user. The selected user populates the Selected Users field.
Using the Selected Users field: In the Selected Users field, start typing the desired user. A drop-down
list opens with names matching your keystrokes. Double-click the relevant name in the list. It populates
the Selected Users field.
9. Repeat step 7 or step 8 until all the relevant users are added.
10. To remove a user, do one of the following:
Associating Roles
Once roles have been created, you can associate a role to another role. When adding children to an associated role, the
children inherit the settings of both parents. You can associate roles you have "manage role" privileges for.
To associate roles:
1. In the navigation bar, click Administration.
2. In the Modules pane, click Roles.The Roles workspace opens.
3. If the Roles options pane is collapsed, expand the pane.
4. In the Roles workspace, click a role and then in the Roles options pane, click the Parents tab.
5. In the Parents tab, click the + button. The Associate Parents dialog box opens.
6. In the Role Parents field, start typing the desired role. Roles matching your keystrokes are highlighted in the
list. Double-click the relevant role in the list. It populates the Selected Users field.
7. Repeat step 6 until all the relevant roles are added.
8. To remove a role, click the X next to the role's name.
9. After making all your selections, click OK.
When managing roles, you can view domain group associations for roles you have "manage role" privileges for.
4. In the Roles workspace, click a role and then in the Roles options pane, click the Domain Group Associations
tab.
The tab populates with all domain groups the role is associated with.
To edit the associations, refer to Associating a Role with Domain Groups on page 78.
A successful login credential is made up of a valid username and password and must satisfy several additional password
policy restrictions, such as: password length, special characters, number of failed attempts to log in before access is
denied, etc.
Users with "manage user" privileges can block next login, halt all active sessions for specific users, and enforce new
password entry on user's next login. They can also define a suspension time which would disconnect the user from the
current session when the time is reached. Refer to Getting Started on page 10 for more information.
Password must be made up of at least 1 upper case letter and 1 lower case letter
3. In the Authentication workspace toolbar, click Add Policy.The Add New Security Policy dialog box opens.
4. In the Name and Description fields, type the name and description of your policy.
5. (Optional) Do one of the following:
To start from an existing policy, select the Use Template check box, and then from the drop-down list,
click an existing policy.
To add an existing policy with a different name, select the Use Template check box, and then from the
drop-down list, click an existing policy. In the Description field, type a description, and then click OK.
To add predefined parameters to an existing policy, select the Use Template check box, and then from
the drop-down list, click an existing policy.
NOTE: If you selected the predefined User Policy, the two predefined parameters automatically
appear in the Parameters dialog box.
8. In the Category and Name fields, from the drop-down lists, select the parameters, and then click OK.
Login
Once the password expires, the user will not be able to log into the system.
Password Policy
a. Make sure that your website has its own dedicated IP address, and that you have a valid certificate.
b. Activate the certificate.
c. Install the your SSL certificate on your website's hosting account.
d. Update your site to use HTTPS. Make sure that any website links are changed from http to https so they
are not broken.
3. Add Redirect URLs:
a. In Azure AD go to Authentication.
b. Click Add URL .
c. Add the site address using lowercase letters. For example: https://<hostname/ip>/visionhub/
3. In Login Authentication Method click the None radio button. A prompt to restart all Middle Tier services and IIS
appears.
4. Confirm the message and then restart all AMS services from the tray, ans IIS services.
5. Click Save. Now your system has canceled the authentication method, and is handled as a new site with no
authentication defined.
6. Perform all the steps as in To prepare for Azure AD configuration in a new site: on page 67.
2. In the Modules pane, under Security select Identity Provider. The Identity Provider workspace opens.
a. Make sure you have set the prerequisites for working with Azure AD as described in To prepare for Azure
AD configuration in a new site: on page 67and To prepare for Azure AD configuration in a site defined with
SSO login: on page 68, depending on your site status.
b. Copy the following from the Azure AD portal (https://portal.azure.com/) and paste into the Identity Provider
window (see below):
Application (client) ID, from App Registration
Directory (tenant) ID, from Directory Information
Click Save. The system connects to Azure and verifies that the information is valid.
2. In the Modules pane, under Security, click Privacy Statement. The Privacy Statement empty workspace
opens.
3. Click Add, browse to select the new html file and click Open. The file is added to the workspace.
4. To enable/disable the statement for the Control or Administrator users, select/clear the Enable Privacy
Statement check box.
5. Click Save.
2. In the Modules pane, under Security, click Privacy Statement. The Privacy Statement workspace opens.
3. To replace the privacy statement file with a new one, click Replace, browse to select the new html file and click
Open.
To remove the current file click Delete.
4. To enable/disable the statement for the Control users, select/clear the Enable Privacy Statement check box.
5. Click Save.
5.1 Overview 73
5.1 Overview
User credentials can be stored in an authentication provider outside of the VisionHub Server (such as Microsoft Active
Directory). External login authentication, or Single Sign-On (SSO), enables privileged users to access all VisionHub
applications without the need to reenter their credentials, as these are taken from the Windows login.
NOTE: All VisionHub applications need to be in the domain of the organization. Domain groups can be
discovered from the Active Directory Server or imported as Excel file (*csv format).
Windows authentication is automatically enabled for the Administrator, Planner and Video Configurator applications. It is
enabled for the VisionHub Control application during the installation of the Web Server by marking the Windows
Authentication check box. Refer to the VisionHub Installation Guide for more information.
SSO is supported for all VisionHub users who are part of a supported domain group, provided that the domain group is
associated with a role. If a non-VisionHub user is part of a supported domain group and that domain group is associated
with a role, the user will be automatically added as a VisionHub user in Administrator upon first login. Once SSO is
enabled for a particular user, authentication for that user is automatically verified against the SSO provider and the user
no longer sees a login screen when logging in to VisionHub. If a user is inactive for a year, the user is automatically
deleted from the system.
1. Add role (see Adding/Deleting Roles and Children Roles on page 26)
2. Add domain groups using one of the following methods:
Discover domain groups from Active Directory (see Discovering Domain Groups on page 76) (if not
automatically discovered)
Add domain groups manually (see Adding Domain Groups below)
Import relevant domain groups (see Importing/Exporting Domain Groups on page 77)
3. Associate the necessary domain groups with the role (see Associating a Role with Domain Groups on page 78).
Any user defined in the VisionHub database can log in and/or log off in the default way (without SSO login). Once you
are logged in and try to log out, you are redirected to the login page, where you need to enter user name and password,
as any user in the VisionHub system without SSO enabled.
NOTE: It is preferable to discover domain groups from the Active Directory server rather than manually
adding or importing domain groups. Refer to Discovering Domain Groups on page 76.
3. Right-click a role and click Edit Role.The Edit Role dialog box opens.
4. In the Domain Group Associations tab, click Search. The Find Domain Group dialog opens.
Local Domain
Other domain – This option requires entering the domain address, user name and password.
6. Type a group name, or part of it to search.
7. If AzureAD authentication is implemented on your system, provide your credentials to enable the search. For
more information, refer to Defining the User Identity Provider on page 66.
8. Click OK. A list of applicable domain groups appears. You can click the View link next to each entry to check the
group details.
9. Select the group(s) you want to add for association with the role and click Save. The added domain groups
populate the Role Configuration tab. To associate domain groups with the role, refer to Associating a Role
with Domain Groups on page 78.
NOTE: It is preferable to discover domain groups from the Active Directory server rather than manually
adding or importing domain groups.
If Azure AD is defined as the identity provider, the Azure credentials window opens. Provide your
credentials and confirm. The discovered domain groups populate the Role Configuration tab.
For SSO - In the Domain credentials dialog box change the domain address, username and password as
necessary. Click OK. The discovered domain groups populate the Role Configuration tab.
6. To associate domain groups with the role, refer to Associating a Role with Domain Groups on the next page.
7. Click Save.
NOTE: It is preferable to discover domain groups from the Active Directory server rather than manually
adding or importing domain groups. Refer to Discovering Domain Groups on page 76. However, if you
cannot access the Active Directory server, you can import the domain groups in an Excel file (*csv
format).
5. In the Open dialog box, locate the relevant csv file and then click Open.The imported domain groups populate
the Role Configuration tab.
To associate domain groups with the role, refer to Associating a Role with Domain Groups below.
6. Click Save.
IMPORTANT: If you defined Azure AD as the identity provider, the Administrator becomes a Super
Role user. You must re-associate it to the domain group.
NOTE: It is preferable to discover domain groups from the Active Directory server. Refer to Discovering
Domain Groups on page 76.
4. In the Domain group associations tab, select the check box(es) of the domain group(s) you would like to
associate with the role. There may be groups that contain Azure AD and groups of SSO users. Make sure to
associate the role to the correct group.
NOTE: You can use the Search bar to locate a particular domain group. To view the credentials of
a selected domain group, click the View link.
5. After making your associations, click Save. The associated groups are added to the role information pane on the
right.
VisionHub Users are individuals who belong to the security operation and take part in it by receiving tasks or
notifications. Users can be operators in a control room, administrators of the Administrator application, security
personnel, or patrol officers who needs to view live video from a particular camera on a mobile device.
3. In the Users workspace toolbar, click Add. The New User dialog box opens.
4. In the Username field, type the username, and in the Name field, type the name of the person.
5. From the Role drop-down list, select the role(s) to be assigned to the user.
6. (Optional) To specify the user's default role, in the Default role drop-down list, select a role. If you do not select
a default role, the first role in the Roles field will be assigned as the default role.
7. In the Job Titles field, type a job title. As you type, Administrator Application presents job titles that were
predefined in the Planner application.
NOTE: The password must meet the defined Minimum Password Length security parameter.
11. Make any optional changes required, as outlined in the table below, and then click OK.
Additional Operations:
To Do This
Change the icon representing the user Click Change and click the desired icon.
In the Contact Info tab, you can add the user’s email
address, work phone number, home phone number, cell
phone numbers, fax number, and pager number
In the Security tab, you can assign a user Security
credentials such as security role(s), default role and
authentication policy. You can also make the user
inactive, unlock the user, or release the user from
being in a suspended state.
In the General tab, you can change the user name, display name, job title, icon and picture.
In the Contact Info tab, you can change contact information such as email address, cell phone number,
etc.
In the Security tab, you can change the user's role, assign the user a default role, change the user's
authentication policy and view when the user's password was last changed.
NOTE: You can also make the authentication policy inactive, unlock the user, reset a suspended
policy and enforce the user's password expiration on next login attempt.
To add assignments:
1. In the navigation bar, click Administration. The Administration view opens.
NOTE: The list of assignments is generated automatically from Planner and cannot be changed
from Administrator.
3. In the Assignments workspace, select the job title to which you want to assign a user.
4. In the Assignments workspace toolbar, click the Manage button. The Manage dialog box opens.
Type the first letter(s) of the user name to display a list of users and then select the required users.
Type the name of relevant user.
6. Click OK. The new user names appear in the list next to the job title.
NOTE: If a user has no job title assigned and you assign a user to a job title, it becomes their job
title and will display in the Job Titles field of the User Properties dialog box for the user.
NOTE: Users can only change roles for users they are authorized to manage.
You can filter the entities that appear in the Connected Users dialog box by one or more of the column headers . You can
also filter by column header for the following columns: Name, Role and Connected At.
Administrative users can also suspend users by configuring a time when the user's current session will end. When that
time is reached, the user's current session ends in all VisionHub applications the user is logged into.
2. To reorder the list, click a column header. The system reorders the entities ascending/descending according to
that heading (not the same as filtering).
3. To filter the display of connected users, see To filter the display of the Connected Users dialog box: on the facing
page.
To select all filtering options, select the Select All check box.
To define specific filter criteria, select the relevant check box and under Show rows with value that, select
the options that will give you the filter query you want.
3. Click Filter.
To clear a filter:
1. Click the Filter button for the filter you want to clear.
2. In the Filter dialog box, click Clear Filter.
When supported by the third-party’s vendor’s API, administrators can use the Discovery feature to view Access Control
System (ACS) badge holders and their associated photos (if available) from an external ACS in Administrator
Application, import the relevant users, and link external ACS users to Administrator Application users.
2. In the Modules pane, click Discovery.The External Users Discovery module opens.
3. In the Discovery type drop-down field, select if to discover users with or without photo.
None to deselect all the listed gateways and then select the gateways on which you want to run
Discovery.
All to check all the listed gateways
5. Click OK.
6. Click Run Discovery. The grid populates with all external users discovered by Administrator.
2. To view more data in the grid, click the Collapse button in the upper right corner of the screen, to hide the
Configuration section.
3. Click the Expand button to show the Configuration section.
2. In the Badges section, click the Ellipsis button. The Update Badge Status dialog box opens.
3. In the Status and Expiration Date drop-down fields, enter the updated status and a badge expiration date,
and then click OK.
2. In the External Users workspace, right-click a user and select Import User.The New User dialog box opens.
3. In the Username field, type the username, and in the Name field, type the name of the person.
4. From the Role drop-down list, select the role(s) to be assigned to the user.
5. (Optional) To specify the user's default role, in the Default role drop-down list, select a role. If you do not select
a default role, the first role in the Roles field will be assigned as the default role.
6. In the Job Titles field, type a job title. As you type, Administrator Application presents job titles that were
predefined in the Planner application.
2. In the External Users workspace, right-click a user and select Link to User.The Select User dialog box opens.
3. Select the VisionHub user you want to link to the external user and then click OK.The external user’s badge ID
opens with the Security tab of the linked VisionHub user.
4. Click OK to close.
Scheduled tasks are time-triggered sets of actions generally used for automating routine, maintenance, and training-
related tasks. For example, you can schedule night and day modes for access control, sensor activation, and
deactivation in selected locations. The system has a built-in scheduler that enables authorized users to set different
schedules for activating the many available actions.
2. In the Modules pane, click Scheduled Tasks. The Scheduled Tasks workspace opens.
The tasks are organized by group for easy viewing. The ungrouped tasks are displayed at the top of the window.
3. To view scheduled tasks within a group, click the side triangle icon next to the group name. To collapse, click the
down triangle icon.
4. (Optional) Organize the data in the Scheduled Tasks workspace in alphanumeric ascending or descending order
by clicking the column headers: Task, Description, Schedule
When scheduling the tasks, it is recommended that you configure all scheduled tasks for all regions in one location, for
example, in a specific country. You must then take into consideration the gap (in hours) between your time zone and the
relevant client time zone where you want to trigger the action.
For example, create two scheduled tasks in Administrator Application in the Middle-East as follows:
A scheduled task in the Middle-East (UTC+02:00), that creates an incident every day at 15:00 Israel time. This
is saved in the database as 13:00.
A scheduled task for Bangkok (UTC+07:00), that creates an incident every day at 17:00 Bangkok time.
Configure this as 12:00PM. This is saved in DB the database as 10:00.
All Administrator Application clients can see all scheduled tasks, but the time displayed in the Next Run Time field is
calculated according to the UTC time that the scheduled task was saved in plus/minus the offset of your client clock.
For example, if at 9:30 local time you configure a task in Israel that runs every day at 15:00 (the scheduled task
saved in DB at 13:00). This is saved in the database as 13:00. The Next Run Time field appears as 15:00.
If an administrator in Bangkok (UTC+7:00), logs on at the same time, it will be 14:30 (an offset of 5 hours from
Israel), the Next Run Time field appears as 20:00.
3. In the Scheduled Tasks toolbar, click Add Task . The Scheduled Task Wizard dialog box opens.
To add a parameter, click Add Parameter and select a parameter from the drop-down list.
8. Click Next.
9. Select the time frequency of the scheduled task. To enable the missed task to run upon the restarting of the
external service instead of its missed schedule time, select the Run Task upon Restart of Services check
box.
10. Click Next.
11. Enter start time, date, and frequency for the scheduled task
12. Upun completion of defining the task, click Finish.
In the Scheduled Tasks workspace, the tasks are categorized by the following:
- enabled task
- disabled task
- task failure
4. In the Scheduled Tasks toolbar, click Move to Group, and then select the group to which you want to move the
scheduled task from the drop-down list.
3. Right-click the task you want to view, and select View Occurrences. The Occurrences dialog box opens.
4. Select the number of days for which you want to view occurrences that took place, and click OK. The results of
the requested occurrence time scope appear in the workspace.
These audited events, derived straight from the database, can be exported to a spreadsheet or viewed directly in the
Audit Events module. The auditor can filter audits by time scope, operator, type of event, incident severity, and computer
IP.
2. In the Modules pane, select Audit Events.The Audit Events workspace opens.
3. In the From and To fields, define the time scope of the desired audit. Clicking in the field opens a calendar, in
which you can select the appropriate date. Clicking the adjacent Hour button enables selecting the appropriate
hour from a drop-down list.
4. Filter the audit according to the following options, as needed:
To filter by Do this
Event severity level Click the Level drop-down list and select the desired level
User Click the User drop-down list and select the desired user
Event type Click the Type drop-down list and select the desired event type. For a complete list
of event types refer to Defining Audit Event Retrieval on the facing page.
Computer IP Click the Computer IP drop-down button and select the desired computer IP.
To refresh any of the Filter drop-down lists, click the Refresh button next to that field
5. Click Retrieve Events. The events display in the Audit Events log.
6. To see more events on the screen at a time, hide the filter options by clicking the Filter button. Unhide the filter
options by clicking Filter again.
7. (Optional) Organize the data in the log in alphanumeric ascending or descending order by clicking the column
headers.
8. Click on an event in the Audit Events log to display details (Keywords, Parameters, Results) of that event in the
Details section.
To export an audit:
1. Click Export to save the events in the Audit Events log for external use. The audit report is saved as CSV file. A
notification popup displays when the audit has been completed.
2. Click Open Export Folder to view the file.
Role Deleted
Role Updated
TIP: The list of events included in an audit can be changed with the Audit Event types Editor. To add or
remove events included in audits, contact your technical service representative.
By means of the app.config section in the Administrator configuration file, an administrator can customize some elements
of the graphic user interface of the Audit Event screen, such as changing the paging amount. To update the configuration
file, contact your Qognify customer support.
To define sounds:
1. In the navigation bar, click Administration.
3. Click the Ellipsis [ ] button next to the event you want to configure a sound for or double-click the event. The
Sound Source dialog box opens.
4. In the Sound source section, click one of the following radio buttons:
You can click the Play button at any time to play your sound.
VisionHub Rules is a built-in powerful rule engine for defining activation rules that need to be executed when events take
place. The rule engine includes a flexible and easy-to-use rule editor. If conditions defined in the rules are met, alarms
are triggered, activating adaptive response plans automatically or recommendations sent to operators to activate plans
on-demand. Examples of actions that are activated automatically upon alarm trigger include opening new incidents and
relevant cameras, commanding sensors, and playing a specific page.
To add rules:
1. In the navigation toolbar, click Administration
3. In the Rules toolbar, click Add. The Add Rule dialog box opens.
4. In the Name field, type a name and then click Add. The rule is added to the Rules pane.
5. Add conditions to your rule. Refer to Managing Rule Conditions below.
6. Add actions to the conditions. Refer to Managing Automatic Actions on page 119.
7. (Optional) Perform any of the additional rule operations:
To Do This
In the Rename dialog box, type a new name and click Save.
Activate / Deactivate a rule Right-click a rule, and select Activate Rules/Deactivate Rules.
When managing conditions, you can also add related entity conditions and group/ungroup conditions.
3. In the Rules pane, select a rule and then in the Conditions pane, click Edit Condition. The Condition Editor dialog
box opens.
4. Under Step 1: Add condition(s), expand the section containing the conditions you want to add and then
double-click the condition to select it. The condition opens under Step 2: Edit the condition description.
NOTE: Refer to the Sentence Condition Tables on page 112 for information about conditions.
5. Click the blue underlined sections of text to open the Edit Parameter dialog box and select the desired
parameters.
NOTE: The Date/Time related sentences must be combined with event-related sentences, as
opposed to state-related sentences. For example, the first sentence in the Date/Time related
sentence can be combined with "Sensor status was changed," indicating that a change in state
(event) took place, but cannot be combined with "At least one sensor under any sensor group(s) of
any type(s) is in a specified mode," where no state change is detected.
To group conditions:
1. In the Condition Editor dialog box, under Step 2: Edit the condition description, select the conditions you want to
group (use the Shift or Ctrl keys to multi-select). You can drag sentences to relocate them on the list.
To ungroup conditions:
In the Condition Editor dialog box, under Step 2: Edit the condition description, click inside the group shaded box and click
Ungroup .
To delete a condition
In the Condition Editor dialog box, under Step 2: Edit the condition description, click the condition you want to delete and
then click Remove.
1 Sentence: At least the specified number of incidents unassigned or assigned to the same assignee of
any type(s) and of any level(s) of severity.
Type: State
Use to: Evaluate if a minimum specified number of incidents occurred of a specified type and severity
level and that they were assigned to the same owner.
Listener
Condition: "At least 3 incidents assigned…"
Condition: Uniqueness constraint "User" (represents the workflow incident’s owner)
actions
Listener
Condition: "At most 2 incidents assigned…" (The selected values of type and severity
parameters should be identical to those of the first condition)
2 Sentence: Number of incidents of any type(s) and of any level(s) of severity is higher, equal or less
than the specified value.
Type: State
Use to: Evaluate if the number of incidents of a specified type and severity level that occurred is higher
than, equal to, or less than a specified number.
3 Sentence: Number of incidents of any type(s) and of any level(s) of severity of any sensor group(s) is
higher, equal or less than the specified value.
Type: State
Use to: Evaluate if the number of incidents of a specified type and severity level (related to a specified
sensor group- within a parent group or any of its children) that occurred is higher than, equal to,
or less than a specified number.
Type: Event
1 Sentence: At least one sensor under any sensor group(s) of any type(s) is in a specified mode.
Type: State
Use to: Evaluate whether one or more sensors in the specified sensor groups ( within a parent group or
any of its children) and of the specified types are in the specified mode.
2 Sentence: At least one sensor under any sensor group(s) of any type(s) is in a specified state.
Type: State
Use to: Evaluate whether one or more sensors in the specified groups ( within the parent group or any
of its children) and of specified types is/are in the specified state.
3 Sentence: More than/Less than/Exactly a specified number of sensors in specified group are in
specified state.
Type: State
Use to: Evaluate if more than, less than, or an exact number of sensors within a parent group or any of
its children are in a certain state.
4 Sentence: More than/Less than/Exactly a specified number of sensors in specified group (not
including sub-groups) are in specified state.
Type: State
Use to: Evaluate if more than, less than, or an exact number of sensors within a group are in a certain
state. This applies only to the sensors in the parent group but not to the ones in the sub-groups.
Type: Event
Use to: Evaluate if there are changes to the sensor state, mode, or parameter within a parent group or
any of its children.
Type: Event
Type: Event
Type: Event
Use to: Evaluate if user selected a custom action from the Video menu.
Type: Event
Use to: Evaluate if sensor within a parent group or any of its children has changed status.
10 Sentence: Specified mode sensor status under specified group was changed.
Type: Event
Use to: Evaluate if there are changes to the sensor state or mode within a parent group or any of its
children, only for sensors in the specified mode.
1 Sentence: Specified parameter sensor parameter (under the specified group) value has changed. The
new value is related to the specified value.
Type: State
Use to: Evaluate if a sensor parameter (number value) of a sensor belonging to a specified parent or
children group has changed and if the value falls between a specific minimum and maximum
number range.
2 Sentence: Specified sensor parameter (under the specified group) value has changed.
Type: Event
Use to: Evaluate if a sensor parameter (either name or value) of a sensor belonging to a specified parent
or children group has changed.
Type: Event
Type: Event
The event time is only relevant for sensors. Refer to Setting Sensor Event Time Intervals on page 173 for more
information.
You can choose between the Server Time (the AMS date and time) and the Sensor Event Time (this is the actual sensor
time and not the event time).
1 Sentence: The specified time is between start time and end time.
Type: State
Use to: Evaluate if an event occurred between two defined time intervals (a starting time and an ending
time) in a specified time zone (server time zone or sensor time zone where the event took place).
NOTE: Event time zone can only be different from the server time zone when
combined with sentences that state a sensor as one of their related entities.
For example, this sentence can be combined with "Sensor status was changed." When the
condition is met, defined automatic actions are triggered such as "Open new incident," "Send
messages to all control room operators," etc.
Type: State
Use to: Evaluate if an event occurred during a specified time mode (day or night) and is combined with
sentences that state a sensor as one of their related entities.
Type: State
Use to: Evaluate if an event occurred on any of the selected weekdays in a specified time zone (server
time zone or time zone where the event took place)
NOTE: Event time zone can only be different from the server time zone when
combined with sentences that state a sensor as one of their related entities.
1 Sentence: The specified gateway status was changed to the specified status.
Type: Event
Use to: Evaluate if the status (connected or disconnected) of a specified gateway changed to the
specified status.
11.3.1 Overview
VisionHub enables the automation of various actions, such as: cameras display and PTZ control, sensors control,
incidents launch, procedures deployment, and more. Automatic actions can be activated from procedure tasks,
activation rules, predefined schedules, Quick Launch buttons or predefined triggers.
Variables in actions are used to represent data. When the action is executed, the variables are replaced with real data.
For example, by selecting the variable "%IncidentLocation%" you can define that when an incident with an Incident type
of "Suspicious Person" is opened, the Incident location is automatically added to the description of the Incident.
Automatic actions, their parameters, additional parameters and variables are provided in this section.
Additional parameters by clicking Add Parameter and selecting from the drop-down list. The Additional
Parameters available change with each action selected. For example, for the action "Open new incident,"
you can add additional parameters such as "Incident group." In this example, when a rule with this action is
triggered, it opens a new incident for the assigned incident group and assigns the incident to a designated
user.
Variables to the parameters by clicking the Insert Variable button and selecting variables. Variables are
used to represent data. When the action is executed, the variables are replaced with real data. For
example, by selecting the variable "%IncidentLocation%" you can define that when an incident with an
incident type of "Suspicious Person" is opened, the incident location is automatically added to the
description of the incident.
You can delete parameter fields by selecting a field and clicking the Delete icon .
NOTE: You can define certain actions to only activate certain actions within an incident owner’s
terminal. Refer to Activating an Action in the Incident Owner’s Terminal on page 123.
NOTE: Adding the parameter "Execute in a loop over a collection of type" only has meaning when
adding actions to a rule. It does not have meaning in all other places in VisionHub that automatic
actions can be added, such as Planner or scheduled tasks.
These actions are opened according to the order defined in the rule (see examples below).
For instructions on merge and sharing options available in Open New Incident action, refer to Collaboration Data
Settings in Actions on page 124.
The start-time defined for the Playback automatic action refers to the start-time of the incident creation. If you use
setPlayback condition as part of an event started with incident Acknowledgment, the start time refers to the Ack time,
not the incident creation time.
In case of related sensors – first, the 4 slots of the main (original) sensor (Live, PB, Map, Sensor properties) are
displayed, and then, all the actions of the related sensor. The layout will change from the default 2x2 to a layout that can
display all the necessary slots.
If the actions are configured before the "Open Incident", then the action are opened outside the Incident default page.
Examples:
All automatic actions can be displayed in child windows, defined by the Control application users.
The following is an example of adding a parameter to activate the action in a specific terminal:
Create Incident: Collaboration Data specified in this action is merged with locally specified Collaboration Data
according to the specified merge option.
Update Incident: Collaboration Data original incident is merged with that specified in Update Incident
according to the selected merge option.
Share Incident: Change the local Collaboration Data with no merge changes.
This section describes the behavior and function of the collaboration and merge settings that are available in these
actions.
NOTE: If you want to specify share data, you must specify an incident type.
2. In the Edit Action dialog box, click the Share ellipsis button. The Sharing Settings dialog box opens. Initially, no
assignee or stakeholder is specified.
3. (Optional) Enter the Sharing Settings . For an explanation of assignees and stakeholders, refer to the VisionHub
Control User Guide, Assigning and Sharing Incidents and Tasks.
4. Click the Merge Option field and select a merge option (the default is none).
Group: Applicable when the action is conditional on a sensor being triggered. The collaboration data will
be taken from the local settings AND the related sensor group in which the triggered sensor is assigned.
When defining a sensor group, collaboration data is included, so when any sensor in the group is triggered,
that collaboration data is applied if this merge option is selected.
Incident Type: The collaboration data is taken from the incident type, specified in the Edit Action dialog
box (above), for the Open New Incident action.
Merge: Merge all collaboration data – from incident type, sensor group, and local.
None: Only local collaboration data is used – only that data manually entered in the Sharing With dialog
box. Replace: Specified collaboration data replaces the existing data.
Incidents:
Action Parameters and
Actions Variables
Additional Parameters
Urgent BadgeStatus
Procedure CurrentDate
Location CurrentTime
Description ExternalUserID
Incident SensorAdditionalInfo
Type SensorDescription
Merge SensorHardwareID
None SensorID
Share: SensorLocation
Assignee SensorLocationAccuracy
Stakeholders SensorMode
SensorName
SensorRelatedVideo
SensorState
SensorStateDescription
OwnerCellPhone
OwnerCellPhone2
OwnerContactNumber
OwnerDefaultPhone
OwnerEmail
OwnerHomePhone
OwnerID
OwnerName
OwnerUserName
OwnerWorkPhone
RelatedVideoFavorite
SensorDP-Recording
SensorDP-UnknownStateEvent
SensorRoleUsers
Additional
Parameters:
Add Comment
Sensors:
Action Parameters and
Actions Variables
Additional Parameters
Task
Incident
User
Sensor
Sensors Logical Group
Quick Launch
Close Sensor Related Incidents Sensor (select sensor from drop- Complete List
down list)
Comment
Additional Parameters
Reset Related Sensors
Additional Parameters
Duration (minutes)
Comment
Sensor Type
Pages:
Additional
Actions Action Parameters Variables
Parameters
Monitor SensorAdditionalInfo
SensorDescription
SensorGroupLocation
SensorGroupName
SensorLocation
SensorRelatedVideo
Video:
Action Para- Additional
Actions Variables
meters Parameters
Camera:
SensorAdditionalInfo
SensorDescription
SensorGroupLocation
SensorGroupName
SensorID
SensorLocation
SensorRelatedVideo
Title:
Complete List
Preset Position:
SensorAdditionalInfo
SensorDescription
SensorGroupLocation
SensorGroupName
SensorLocation
SensorRelatedVideo
Camera:
SensorAdditionalInfo
SensorDescription
SensorGroupLocation
SensorGroupName
SensorID
SensorLocation
SensorRelatedVideo
Title, Video Wall:
Complete List
Camera:
SensorAdditionalInfo
SensorDescription
SensorGroupLocation
SensorGroupName
SensorID
SensorLocation
SensorRelatedVideo
Bottom
Right
Virtual Tour
-
Sound:
Actions Action Parameters Variables
Third Party
GIS:
Action Parameters and
Actions Variables
Additional Parameters
12.1 Overview
The Sensors view is a unified management module for all the organization's logical entities, including:
Integrated third-party systems and devices - such as Access Control Systems, CCTV, video analytics
("Smart Cameras"), VMD, DVR panic buttons, API triggers, audio sensors and video walls.
NOTE: Physical entities are defined and configured in Video Configurator and logical entities are
defined and configured in Administrator.
Tours - A tour is an automatic sequence of camera inputs that is displayed in a single slot according to their dwell
time and presets. Dwell time is the amount of time video is displayed before it is replaced by another video
segment. The default dwell time is 10 seconds, but it is configurable in the system settings.
Pages - A page is defined in VisionHub Control application and can be managed in Administrator. It contains a
layout made up of several slots and can hold various types of content, such as maps, channels, tours and sensors.
This enables monitoring all necessary entities together, both in live and playback modes. For example, all entities
of a certain floor in a certain building.
You can view a variety of read-only properties, such as: the entities contained in a page, the physical name of a sensor in
the third-party system, a sensor's hardware ID and type, the group the entity is part of, etc.
You can view an entity's permission as well as modify an entity's properties. For example, you can change an entity's
name, description, shortcut key, change a sensor's security credentials, modify relationships, add a tour segment to a
tour, view an open camera's live video, etc.
The Sensors view workspace toolbar provides tools for moving the entities to groups, associating entities, deleting
entities, changing sensor states and modes.
NOTE: Only changes made in Administrator can be deleted in Administrator. Changes made in the third-
party system must be deleted in the third-party system.
For easy management and filtering, entities in the Sensors view are categorized into:
Views - Sensors, pages, tours. Under Sensors, sensors/cameras are categorized by their type, mode (armed or
disarmed), state (alarm or failure), site association (only relevant for video/audio sensors) and capabilities. In
addition, entities can be viewed by their relationship.
Groups - Entities can be organized into customizable groups. Entire sensors/cameras groups can be easily
armed, disarmed, bypassed, acknowledged, reset, reordered via the context menu in the Groups pane. You can
also edit group properties, reorder entities within the group, and hide/show all entities in the group via the
context menu.
Views and Groups enable you to filter the workspace display to entities of interest. For example, by selecting the view
"All sensor states>Normal" and a particular Sensors group, the workspace populates with all sensors in the selected
group with a state of Normal.
NOTE: A system group called "Ungrouped Entities" is created upon installation and cannot be deleted.
Any entities that are not grouped will display in the "Ungrouped Entities" group.
The Views, Groups and Properties panes can be undocked, moved, and resized.
Item Description
Views pane Choose what entities to display in the workspace - sensors, cameras, pages, and
more.
Specify according to sensor type, state or mode (click the expand arrow for a
category to view the options).
Groups pane Displays the various groups in which the entities are organized. Specify what groups you
want to include in the workspace display.
Workspace Provides operations on one or more sensors selected in the sensor display:
toolbar
Move selected entities to another group
Associate the selected entities to another group
Change selected sensor(s) state
Change selected sensor(s) mode
Item Description
Information Display the properties, history, and roles of the selected entity. Some of the panes provide
panes editing options via the Edit tab.
Video pane Select/clear the Display Video check box to enable/disable video display from the camera
selected in the workspace.
For sensor groups, if one member of the group has changed state, this state will show as the group icon for the whole
group in the group tree. For example, if one sensor in the group is in Failure state, the group icon will show the Failure
icon. As a general rule, the State icon displays the most severe state out of all the group member states.
Using the provided state actions, operators can acknowledge or reset the sensors that are in Alarm, Failure or Tamper
state from Control.
When an ACS1 is integrated, operators can send commands to doors directly from Control.
A description of sensor states, state actions, door commands and modes are provided in the table below.
Graphical
Description
Icon
State
Alarm Indicates that the sensor state has changed, triggered by a sensor, a rule, or
manually.
Tamper Indicates that the sensor has been tampered with or compromised.
State Actions
Acknowledge Provides a time-stamp for when a user acknowledges the change in sensor state , ,
(from Normal to Alarm, Failure, or Tamper). Acknowledging the state change stops
the sensors/cameras from blinking on a map.
Door Commands
Graphical
Description
Icon
Lock/Unlock Locks/unlocks the door remotely in Control and physically and card swipes are ,
Door (ACS) recorded to the ACS history log.
Inhibit Door Locks the door remotely from Control and cannot be opened via ACS card swipes.
(ACS)
Mode
Arm Processes alarms and failure alarms for selected sensors/cameras or all
,
sensors/cameras in a group.
Disarm Disables any rules or automatic actions for selected sensors/cameras or all
sensors/cameras in the group but still processes alarms and failure alarms.
Bypass Ignores all activity (sensor/camera is still armed but does not go into alarm or trigger
actions upon activity).
12.4.1 Overview
Having entities in customizable groups enables the Channels and Sensors tabs in the Control application to be easily
organized and managed.
In Administrator Application, entities can be organized by customizable groups in the Groups tree hierarchy. For
example, sensors/tours may be grouped according to their physical location or any other logical association (an "ACS
sensors" group for example).
You can place entities in a group, and relate them to other groups as well. The sensors are members of the group they
are added to and related to groups they are associated with.
For example, you might have a group of all sensors located on Floor 3 of a building, and another group of all sensors
located in that same building. The sensors in group "Floor 3" are members of group "Floor 3". However, they can also be
related or associated to group "Building 1". When you associate the sensors in group "Floor 3" to group "Building 1", the
sensors on Floor 3 will also display in the group "Building 1". However, you will only be able to edit the properties of
those sensors from group "Floor 3".
NOTE: Sensors added by discovery are automatically added to the "Ungrouped Sensors" group. While
you can organize sensors and tours into customizable groups, pages can only be created and grouped in
Control. Once created, all published public pages and private pages created by the logged-in
administrator display in Administrator in the same group hierarchy tree as in Control. Refer to the
VisionHub Control User Guide for more information on creating pages.
The video sensor groups you create will be automatically added to the Control Channels and Sensors tabs and should
therefore be labeled wisely. For example, when creating a sensor tree for a facility named Generation Plant-134, you
can create a group for VMD cameras and two "children" groups for external and internal cameras, respectively. For such
an example, your tree in the Channels tab will look like the image below.
The groups you create should mirror your map tree hierarchy.
Various relevant actions can be triggered for all entities within a group. You can expand the part of the entity group tree
by right-clicking a parent group in the tree and then clicking Expand All.
Only authorized users can group and manage entities. In case one or more sensors have viewing permission only, and
the user tries to perform any action that has no privilage, the following notification appears selecting the action to
execute: "The operation will be performed only on sensors that have the permission".
All cameras and sensors in a group must be in the same time zone.
2. In the Groups pane, right-click the relevant entity group, and then click Add Group.
If there is at least one sensor in alarm or in failure, the "parent group" will indicate so. A group is created and by
default given the name "New Group".
3. To edit the group name and other attributes, refer to Editing Entity Groups on the next page.
To delete a group:
1. In the Groups pane, right-click the relevant entity group, and then click Delete. The system asks if you want to
delete the group and all subgroups and sensors contained in the group(s).
2. Click Yes.
If you want to specify Night Mode for the group, enter beginning and ending times.
Select the time zone from the list. All the sensors in the group must be in the same time zone.
4. (Optional) Associate a page with this group: In the Associated page drop-down list, select a page.
5. (Optional) In the Sharing section, specify job titles for stakeholders. Do one of the following:
Type the first letter(s) of a job title and select from the displayed options.
Click Stakeholders to open the Find Job Titles dialog box, in which you can search by job title and add
selected job titles. Do not use the By Name tab. This tab is not functional here.
NOTE: For an explanation of stakeholder functions, refer to the VisionHub Control User Guide,
Assigning and Sharing Incidents and Tasks.
Collaboration data specified for a sensor group will be merged with locally specified collaboration data according
to the merge option settings for the triggered action. Refer to Collaboration Data Settings in Actions on
page 124.
6. Click OK.
Click and drag the entities in the dialog box to create the new order.
Use the Move Down and Move Up buttons.
5. After reordering the entities in the group. click Close.
View All to display all the entities in the group and all of its subgroups.
Hide All to hide the display of all the entities in the group and all of its subgroups.
2. In the Comments dialog box, type the reason for changing the mode, or select a predefined comment from the
drop-down list, and click OK.
The mode and graphical icon change for all entities in the group, as indicated by the Mode column in the Sensors
workspace, and the graphical icon displays next to the group name in the Groups pane.
12.5.1 Overview
Third-party cameras and sensors can be discovered automatically or manually by an authorized user and imported into
the Sensors view. Each sensor is identified by its type, gateway, and additional applicable attributes. These attributes
determine the generic logic that applies to that sensor. Discovered cameras and sensors are automatically imported
into the "Ungrouped Sensors" group and can be moved to existing or new groups. Refer to Building and Managing the
Entity Group Tree on page 152.
In the Views pane, under All sensors and cameras, sensors/cameras are categorized into the following views:
Populates
Sensor View Sub-views
Workspace with
All Sensor Types Sensor/camera types Access Control, API Trigger, Audio-Sensor, Drycontact-Sensor, Smoke
Detector Sensor
All Sensor States Sensor/camera states Normal, Alarm, Failure, Tamper, Gateway Disconnected,
Disconnected, Unknown
Defined sensors can be managed and controlled by the provided operations via the map icons representing the sensors.
Using the Rule engine, you can define activation rules that need to be executed when entity-related events take place.
The rule engine includes a flexible and easy-to-use rule editor. If conditions defined in the rules are met, alarms are
triggered, activating response plans automatically, or recommendations are sent to operators and collaborators to
activate plans on-demand. For example, a rule "Door Forced" can be easily created in the Rule engine to dictate that
when the state of access control system sensors in Building 1 change, actions such as "move camera," "play defined
sound," "send messages," and "send a command to other sensors" are automatically triggered. For more information
about defining rules, refer to Defining and Managing Rules on page 107.
NOTE: It is important to enter all relevant sensor information appropriately because it can be used as
variables when defining rules and actions.
Auto-discovery - (set by default for all gateways) is queried every 20 seconds, or by a user-configurable time
interval, and changes are automatically updated in Administrator Application.
Manual discovery - manually running a discovery initiates the process of collecting sensors information from your
network. You can view the collected information by first filtering the results by area to define your query and
then update the list to show the results in the grid.
NOTE: Discovered sensors and updated sensors are added to the Ungrouped Sensors group.
To disable auto-discovery:
1. In the navigation toolbar, click Administration and then in the Modules pane under Sensors, click Gateways.
The Gateways Management window opens.
2. In the Gateways list, click to highlight the gateway you want to edit and then select the Parameters tab.
3. In the Name column, select autoDiscovery and then in the Gateways Management toolbar, click Edit. The Edit
Parameter dialog box opens.
4. In the Value drop-down field, select False and click OK.
5. Restart the gateway.
NOTE: Any changes made in the third-party system need to be synchronized in Administrator
manually if auto discovery is disabled. Refer to Running Sensors Discovery below.
2. In the Modules pane under Sensors, click Discovery. The Sensors Discovery module opens.
You can hide or show the filtering fields by clicking the Configuration button in the top right corner of the
Sensors Discovery main screen.
3. In the Filter By section, fill in the relevant fields to define your search as described below.
In all the drop-down lists, you can click Select All to select all sensors meeting the filter. query criteria or Select
None to deselect all.
All the free text fields support the following wild card search options:
If you are searching for an item that actually has a "?" or a "*" in it, you need to use a special character – "\" before
the "?" or "*". This is called an escape character.
For example, if you are looking for a sensor located on floor*1, in Location field type "floor\*1".
Gateway: From the drop-down list, select the sensor gateways and click OK.
Name: Type the gateway name.
Group: Type the gateway group, if applicable.
Type: From the drop-down list, select a sensor type and click OK. Supported sensor types include: alarm
panel, decoder, smoke detector, access control, perimeter, drycontact-output, drycontact, API trigger,
audio, video and fence.
Hardware ID: Type the Hardware ID. Hardware IDs begin with the gateway name. If you do not know
the Hardware ID, you can search for it by typing the gateway name followed by a wild card. See above
info for wild card search.
Description: Type a description.
Status: From the drop-down list, select an available status: None (default), New or Modified. Click OK.
Visibility: From the drop-down list, select a visibility preference as follows:
Visible Only: Only selects the sensors marked Unhide in the sensors grid
Hidden Only: Only selects the sensors marked Hide in the sensors grid
All: Selects all sensors in the sensor’s grid, regardless of visibility status
NOTE: In the Sensor grid, you can use the Hide/Unhide buttons to determine a sensor’s
visibility in the grid after clicking Update Results.
5. Click Run Discovery and then click Update Results to view the query results in the sensor’s table grid.
NOTE: After initially clicking Run Discovery once, you do not need to click it before each time
that you click Update Results. You can click it again from time to time to make sure that the
information is the most updated.
In the Results pane, the icons in the Status column define the sensor status as follows:
The window shows the related entities for the discovered sensor, grouped by type. For example, a camera sensor
related entity will show the properties of the camera, such as it being a PTZ camera or an External Monitor type
for a Video Matrix. In case the entities themselves have related entities, selecting an entity in the list shows the
related entity in another list. An example of a second level related entity would be Slots for External Monitors.
7. (Optional) Use the following options available on the Sensors Discovery toolbar:
Hide/ Unhide Designates which gateway sensors to hide from showing in the sensor’s grid or
unhide upon clicking Update Results.
NOTE: You can click a column header and drag it to the Group section
to group by that column when clicking Update Results.
8. After you have selected the gateways you want to import into VisionHub, click Import from the toolbar.
9. Select a group you want the added sensors to be a part of, and click OK.
10. (Optional) To organize the columns of the Discovery table grid, right-click a column header and use the table
below for guidelines:
Sort by Ascending/sort by Descending Sorts the data in the selected column by ascending or descending
Group by this Column Groups the Group by Box section results by this column
(The filter can be set by clicking on the triangles under each column.)
Best Fit (all columns) Clears all results in the sensor’s grid
To edit sensors:
1. In the navigation toolbar, click Sensors.
2. In the Groups pane, click the sensor group which contains the sensor you want to edit.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click to highlight a sensor. The sensor's properties display in the Information pane on
the right.
4. Click Edit and edit the sensor's properties as required. The properties you can edit are as follows:
Sensor name, Description, Location, Shortcut Key, feature template association, authentication
credentials (name and password).
NOTE: The Sensor name is the sensor's logical name and is the name that will display in
the Sensors List in VisionHub Control. The Physical Name is the name of the sensor in the
third-party system and can only be edited in the third-party system.
Relating a sensor to a camera. See To relate a sensor to a camera: on the facing page.
NOTE: SD card failure alarms can be triggered on the sensor and not on the camera. However, the
camera and sensor must be related for this feature to work.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click to highlight a sensor. The sensor's properties display in the Infoemation pane.
4. Click Edit.
5. Scroll down, and under Video, click the Plus (+) sign in the Related Camera field. The Select Entities dialog box
opens.
6. Under Groups, select the check box of the group that contains the camera you want to relate to your sensor. You
can use the Search bar to find a particular camera. The cameras in the group populates the Entities section of
the dialog box.
Summary - provides all pertinent gateway information, such as name, current status, and whether the gateway
is enabled (loaded) or not. From the Summary tab, you can also perform management operations such as
starting, stopping, restarting, and cloning gateways.
Parameters - enables viewing, adding, editing and deleting parameters from the SensorGatewayParams
database table. By default, all gateways are set to auto-discovery. To disable this feature and add
sensors/cameras manually, you need to set the autoDiscovery parameter to "false".
To manage gateways:
1. In the navigation toolbar, click Administration
2. In the Modules pane under Sensors, click Gateways. The Gateways Management module opens.
3. In the Gateways tree, select a gateway and perform one of the following operations:
To Do This
button .
To Do This
button .
Refresh Gateways
In the Gateways Management toolbar, click the Refresh button .
Workspace
Delete a Gateway from the In the Gateways Management toolbar, click the Delete Gateway button
database .
Enable/Disable Gateway In the Summary tab, click the Enable Gateway/Disable Gateway blue
hyperlink. This automatically changes the value in the Active column to TRUE
and starts the gateway in the SensorGateway table.
Clone Gateway In the Summary tab, click the Clone Gateway blue hyperlink. This
instantly creates a new gateway entry in the database with the same
parameters and settings as an existing gateway.
To Do This
Add a a database parameter to a. In the Parameters tab toolbar, click the Add Parameter button. The
the SensorGateway table Add Parameter dialog box opens.
a. In the Name and Value fields, enter a name and value.
b. In the Type drop-down list, select a type: String, Integer, Double,
Boolean, XML.
c. If you want the value to be encrypted, select the Encrypt this value
check box.
d. Click OK.
To Do This
Edit the gateway parameters in a. In the Parameters tab, select a parameter and then, in the
the SensorGateway table Parameters tab toolbar, click Edit. The Edit Parameter dialog box
opens.
b. Change the parameters as needed and click OK.
Delete a gateway parameter in a. In the Parameters tab, select a parameter and then, in the
the SensorGateway table. Parameters tab toolbar, click Delete. A confirmation message
appears.
b. Click Yes.
3. After making any changes to the SensorGateway database table, restart the gateway for changes to take effect.
Do one of the following:
When all is configured, authorized operators can select the content to display on each video wall and manage the video
wall layout.
Decoders and external monitors must be added to the site and configured using the Video Configurator application.
Video walls, display layouts, and associated user authorizations must be configured using the Administrator application.
1. In Video Configurator, add decoders (video switches -NVD) to the site: Refer to the Video Configurator User Guide,
Managing Decoders chapter. Each decoder supports up to four monitors.
2. In Administrator, define user authorizations: Define the related user-role authorizations and assign to users.
Refer to Defining and Managing User Security Roles on page 18.
3. In Administrator, run Sensors Discovery and define video wall layouts: Refer to Defining Video Wall Display
Layout below.
4. In Administrator, add video wall layouts: Refer to Adding Video Walls on page 177.
5. In Control, switch to the VMX mode and view video on video wall while operating it from your local workstation,
where Control is running.
NOTE: To manage and view external monitors, you must have authorization and the appropriate
permission for the video switch (decoder) sensors. Refer to Defining and Managing User Security Roles on
page 18.
NOTE: If you create a video wall and no display (monitor) is added to a video wall, the video wall will not
be listed in Control.
In the Groups pane, select the Sensors group and the relevant sub-group. The Sensors workspace
populates with all imported video switch sensors.
NOTE: If the relevant video switch sensors are not imported into Administrator Application, make
sure the relevant gateway has the autoDiscovery parameter set to True. Refer to Adding
Sensors with the Discovery Feature on page 161.
2. In the Administration view, under Video Walls Management, select Monitors. The Monitors workspace opens,
with the external monitors that were defined and enabled during sensors discovery.
Unlike external monitors that can be enabled/disabled in Administrator, video switches (decoders) can only be
enabled or disabled in the Video Configurator application. If a video switch (decoder) is disabled in Video
Configurator, it will not be discovered in Administrator and the monitors connected to this video switch (decoder)
will not be shown in Control in the VMX view.
NOTE: External Monitors can be edited manually by clicking the Edit button and filling out the
fields in the Monitor Details window. However, they will not be reflected in the sensor discovery
properties.
2. In the Video Walls toolbar, click Add . The Video Wall Definition dialog box opens.
2. Click Settings to set the monitor placement and/or customize the background of the video wall image. The
Monitor Placement window opens.
3. Select a monitor from the Monitors pane and then drag and drop it onto the background.
4. Select an image by clicking Browse or a color from the Color drop-down list to customize the background of the
video wall.
5. Do one of the folllowing:
Use the Zoom slider at the bottom-left of the window to zoom in or out.
Click on the monitor and drag its corners to adjust the size of the monitor slots.
Adjust the placement of the monitor slots by clicking on the monitor and dragging it with the mouse.
To delete the selected monitor, right-click on the monitor and select Delete.
6. Click OK in the Monitor Placement dialog box and OK in the Video Wall Definition dialog box.
7. (Optional) To preview a video wall, click a video wall in the Video Wall Name list. A preview opens in the Preview
pane.
Only authorized users can view and operate tours in Control. Only those tours an authorized user is allowed to view and
operate are displayed in the Tour tree. When a user plays a tour, the channels that this user is not authorized to see are
skipped.
View info includes: Tour Name, shortcut, description, list of channels with their duration in the tour.
On-screen Display (OSD) shows the date and time of the currently played segment. The camera displayed as part of the
tour has an OSD indicator identifying that a tour is currently activated. While playing a tour, its name and shortcut
appear as part of an OSD view. Each of the monitors displaying tour entities displays a description of the entity loaded
on the monitor.
Tours are displayed in Control in the order they were assigned in Administrator.
To create a tour:
1. In the navigation toolbar, click Sensors.
2. In the Groups pane, right-click the sensor group you want the tour to be added to and select Add > Add Tour.
The tour is created and the Properties pane opens in edit mode.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
8. Select the camera/channel you want to add to the tour and click OK.
9. If the selected camera is a digital camera with a preset, select the preset from the list.
10. To add other camera(s)/channel(s) to the tour, do the following:
To add a second camera/channel from another group, click Add Segments and then repeat steps 7-8.
Repeat until all the relevant entities have been added.
To multi-select consecutive entities in the same group, click the first entity you want to add, press the
Shift key and then click the last entity you want to add.
To multi-select non-consecutive entities in the same group, click an entity you want to add, press the Ctrl
key and then click the other entities you want to add.
11. To change the order of the segment, click a segment and then use the Up/Down arrows.
12. After making your selections, click OK.
NOTE: The camera name is the physical name of the camera in the third-party system and
cannot be edited in Administrator Application.
In the Play Time field, edit the time you want the segment to play for before the segment is replaced
with the next segment. The dwell times is configured in seconds.
2. Click OK.
1. Click the segment you want to delete, and click the Delete button .
2. Click OK.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click the camera whose video you want to view. In the Information pane, the camera's
live video starts playing (including the sensor date and time).
12.9.1 Overview
A Control Web application page is a window comprised of content specified by Control users and/or automatically.
NOTE: Pages can only be created, by authorized users, in the Control application. Once published, they
can be managed in Administrator. For more information about creating and working with pages, refer to
the VisionHub Control User Guide.
A page might contain content for monitoring a specific location. For example, videos for areas of interest and a map with
camera icons that open additional video on demand. The video content can be live or playback.
The page may be incident-related, meaning it has content relevant to an incident. For example, a map showing a
building location and having a marker that enables you to “drill-down” to the floor in the building where a smoke
detector has been alarmed, as well as access videos from cameras in the relevant areas.
Control users can create as many different pages as needed, each with the unique content and/or layout that the user
defines:
Page Content: A page can have a combination of different types of content in the slots, such as:
Maps
Video with audio
Mixed video and audio clips
Tours
PTZ cameras
Sensors
Access Control Systems (ACS)
Page Layout: Each page can be of any type of layout. You can choose out of available layouts or customize and
build your own. You can build as many pages as you want.
The properties that can be edited are: page name, description and shortcut key.
2. In the Groups pane, click the Published Pages group to view all published pages.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click to highlight a page. The page's properties display in the Properties pane.
4. Click Edit and edit the page's properties as required. The properties you can edit are: Page name, description
and keyboard shortcut key.
5. After making your edits, click OK.
2. In the Groups pane, click the Published Pages group to view all published pages.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click to highlight a page. The page's properties display in the Properties pane.
4. Expand the Roles tab. The list of assigned roles opens.
5. To edit the roles, click Edit, select/clear the check boxes of the roles you want to assign/unassign to this page,
and click OK.
6. To view the authorizations set for the roles, click the View link next to the role. The Roles workspace for that
role opens. To modify role authorizations, refer toDefining and Managing User Security Roles on page 18.
Maps
Video with audio
Mixed video and audio clips
Tours
PTZ cameras
Sensors
Access Control Systems (ACS)
In the Page Properties pane, you can view the content of each page slot as well as slot position in the page.
2. In the Groups pane, click the Published Pages group to view all published pages.
NOTE: To view entities in a particular group, make sure the appropriate view is also selected in
the Views pane.
3. In the Sensors workspace, click to highlight a page. The page's properties display in the Properties pane.
4. Expand the Page Entities tab. You can now view the published page content as it is seen in Control, including
the content name and type and the slot it populates.
12.10.1 Overview
The Sensors view workspace enables you to view and manage an entity's group and group membership association,
entity type, name, mode state, hardware ID, description, location, order in the group and capabilities. You can
select/deselect all entities displayed in the workspace and resize columns.
The Sensors view workspace toolbar provides tools for moving the entities to groups, associating entities, deleting
entities, changing sensor states, and modes.
NOTE: A system group called "Ungrouped Sensors" is created upon installation and cannot be deleted.
Any entities that are not grouped display in the "Ungrouped Sensors" group.
The workspace populates with the selected view criteria and the selected groups.
3. (Optional) Further filter the entities that display in the workspace by one or more of the column headers by
clicking the filter icon in the header and selecting filter criteria. If you click the header itself, the system
simply arranges the entities in ascending/descending order, according to that heading (not the same as filtering).
You can filter by column header for the following columns: Name, Description and Order.
1. Click the filter icon in the column header by which you want to filter. For example, next to Name to filter the
display according to entity name. The Filter dialog opens.
To select all filtering options, select the Select All check box.
To define specific filter criteria, select the relevant check box and under Show rows with value that, select
the options for filtering.
3. Click Filter.
To clear a filter:
1. Click the filter icon for the filter you want to clear.
2. In the Filter dialog box, click Clear Filter.
The entities in the workspace are now displayed in a multilevel hierarchy. Each group can be expanded and collapsed for
easy viewing and management. For example, by dragging columns "Group" and "Membership" to the Grouped by row,
only entities that have been assigned a membership for the selected group display in the workspace.
You can reorder the display of the groups in the hierarchy by clicking the ascending/descending arrow in the column
header box.
Selected Groups to only search entities in the groups that are selected in the Groups pane
All Groups to search entities in all groups.
2. In the search bar, type the name of the name of the entity you want to search for. As you type, the instances
matching your search entry appear in the workspace.
The sensors are members of the group they are added to and related to groups they are associated with. For example,
you might have a group of all sensors located on Floor 3 of a building and another group of all sensors located in that
same building. The sensors in group "Floor 3" are members of group "Floor 3". However, they can also be related (or
associated) with the group "Building 1". When you associate the sensors in group "Floor 3" to group "Building 1", the
sensors on Floor 3 will also display in group "Building 1". However, you will only be able to edit the properties of those
sensors from group "Floor 3".
This feature also enables you to create automatic actions for entities associated even when they are not part of the
same group.
NOTE: You can filter the Sensors workspace to view only those entities that are members of a group or
associated with other groups. Refer to Filtering the Display of Entities in the Workspace on page 188.
To relate entities:
1. Filter to display the relevant entities in the Sensors workspace. Refer to Filtering the Display of Entities in the
Workspace on page 188.
2. In the Sensors workspace, click the entity/entities you want to relate to a group. To multi-select, press the Ctrl
key and click the relevant entities.
3. In the Sensors workspace toolbar, click Associate to. The Select group to associate to dialog box opens.
4. Click the group you want the entity/entities to be related to and click OK. When you open the group, the
associated entitiy icon has a small arrow in its icon ( ).
Entities can be organized by customizable groups in the Groups tree hierarchy. For example, sensors/tours may be
grouped according to their physical location or any other logical association (an "ACS sensors" group for example).
NOTE: Sensors added by discovery are automatically added to the Ungrouped Sensors group. While you
can organize sensors and tours into customizable groups, pages can only be created and grouped in
Control. Once created, all published public pages and private pages created by the logged-in
administrator appear in Administrator in the same group hierarchy tree as in Control.
Entities can be moved between groups. You can move multiple sensors together from one group to another. While
moving, the sensors’ group membership or association moves or stays depending on the relationship, as follows:
Associated to other groups (not target Move to target group Remain in origin
group)
One of the selected entities is already Move to the target group, the Ignored
a member of the target group existing member remains
Members and associated sensors (of Move to target group Remain or move (depending on origin)
different groups and sensors)
Members and associated sensors (of Move to the target group Remain in origin
same sensors)
All selected entities are member(s) of N/A – the target group is Remain
the target group grayed-out and does not allow
movement
Member and its associated sensors (of Move to the target group N/A – the target group is grayed-out and
same sensor) + member of the same does not allow movement (system
group limitation)
To move entities:
1. Filter to display the relevant entities in the Sensors workspace. Refer to Filtering the Display of Entities in the
Workspace on page 188.
2. In the Sensors workspace, click the entity/entities you want to move to a group. To multi-select, press the Ctrl
key and click the relevant entities.
3. In the Sensors workspace toolbar, click Move to. The Select group to move to dialog box opens.
4. Click the group you want the entity/entities to move to and click OK.
Only changes made in Administrator Application can be deleted in Administrator Application. Changes made in the
third-party system must be deleted in the third-party system.
When deleting a sensor that is associated with a page or with an entity icon marking its location on a map, the page is
updated and the icon is removed from the map.
To delete entities:
1. Filter to display the relevant entities in the Sensors workspace. Refer to Filtering the Display of Entities in the
Workspace on page 188.
2. In the Sensors workspace, click the entity/entities you want to delete. To multi-select, press the Ctrl key and
click the relevant entities.
3. In the Sensors workspace toolbar, click Delete. confirmation message appears.
4. 4. Click Yes.
Using the provided state actions, operators can acknowledge or reset the sensors that are in Alarm, Failure or Tamper
state from the Control application.
When an ACS is integrated, operators can send commands to doors directly from Control.
A description of sensor states, state actions, door commands and modes are provided in Understanding Sensor Modes,
States and Door Commands on page 150.
To change a sensor state, click the Change Sensor State drop-down list button and then select the
relevant state: Alarm, Failure, or Tamper.
To change a sensor mode, click the Change Sensor Mode drop-down list button and then select the
relevant mode: Arm, Disarm, Bypass.
4. In the Comments dialog box, type the reason for changing the state/mode, or select a predefined comment from
the drop-down list and click OK.
The state/mode and its graphical icon changes, as indicated in the State and Mode columns in the Sensors
workspace.
For sensor groups, if one member of the group has changed state and the user has permission to manage that
sensor, the new state will show as the group icon for the whole group in the group tree. For example, if one sensor
in the group is in Failure state, the group icon will show the Failure icon.
13.1 Overview
Maps are used to provide a physical representation of the security operation scene. By monitoring maps, operators get
a geographic representation of the security situation, including sensors and systems status, incident location, and so on.
Directly from maps, operators can also control sensors and cameras as well as manage other map entities. In addition,
maps provide operators with the decision support mechanisms via the display of meaningful tool tips, x and y coordinate
location information, and more.
TIP: Plan your map hierarchy prior to entering the actual views in Administrator Application.
Item Description
Selected map (main) toolbar View map details, resize and zoom maps, search maps, edit maps, and more.
Map Views pane toolbar Add, edit, and delete map views, add favorite views, arrange the views list.
By default, in a new project, Administrator Application provides a place holding image in place of a map and labels the
image General.
3. From the Views toolbar, click either Add map view as a sibling icon or Add map view as a child
icon. The Map View Properties dialog box opens.
By default, in a new project, Administrator Application provides a place holding image in place of a
map and labels the image General. See To replace the default image: below.
4. In the Name and Description fields, enter an appropriate name and description. The description will be used for
a tool tip.
5. If your map is georeferenced, select the Map View is Georeferenced check box.
6. Click OK.
2. From the toolbar, click the Edit icon. The General Properties dialog box opens.
3. In the Name and Description fields, enter an appropriate name and description.
4. If your map is georeferenced, select the Map View is Georeferenced check box.
5. Click OK.
6. In the Layers pane, click to select the Image layer.
7. Click the Edit the Selected Layer icon. The Layer Properties dialog box opens.
8. In the LayerType drop-down list, select Image. The word "Image" populates the Name field.
9. In the Description field, type a description.
10. In the File Name field, click the Ellipsis [...] button and browse to the location of the image, click the file, and
then click Open.
NOTE: The default maximum size for image files you add as maps is 5 megabytes.
Select the map view to be edited, and, in the Map Views pane toolbar, click the Edit icon.
2. In the Name and Description fields, make the required edits. The description will be used for a tool tip.
3. If your map is georeferenced, select the Map View is Georeferenced check box.
4. Click OK.The description appears when you hover over the map name in the tree.
All maps in your map tree must have an "Image" or "Map" layer containing an image or CAD file added before you can
add additional layers. The supported image types include JPEG, PNG, GIF, TIFF, and BMP files. The images can be non-
georeferenced or georeferenced. The default maximum size for image files you add as maps is 5 megabytes.
When you add a map image, an Image layer is automatically created in the Layers pane. Layers enable you to show and
hide entities.
For example, if you want to hide the map in order to view other map entities more clearly, you can temporarily hide the
map image by clearing the Image layer check box.
For more information about layers, refer to Adding and Managing Layers below.
1. In the Layers pane toolbar, click Add Layer as Sibling icon. The Layer Properties dialog box opens.
2. From the Layer Type list, click Image. The word "Image" populates the Name field.
3. In the Description field, enter a description.
4. In the File Name field, click the Ellipsis button, browse to the location of the image or CAD file, click the file,
and then click Open.
5. Customize your layer type’s settings as required, and then click OK. The layer appears in the Layers pane and the
image displays in the central view.
You can create a Group layer with sub-layers that you can easily manage together. However, you must create the
group layer first. For example, you might want create a Cameras group with sub-layers containing cameras on different
floors of a building. Therefore, if you want to hide all cameras on a map, you would simply click the Group layer to hide all
sub layers. However, if you wanted to show cameras only on a particular floor, you would only show the sub-layer
containing that floor’s cameras.
1. In the Layers pane toolbar, click the Add layer as Sibling icon. The Layer Properties dialog box opens
2. In the Name and Description fields, enter the name of your layer and a description.
Sensor Group
Marker
Sensor
5. (Optional) Click Select Entities to place predefined icons of the selected entity type. For example, when adding
a new Sensors layer, a list of all VisionHub sensors is available.
2. In the Layers pane toolbar, click the Add layer as Child icon. The Layer Properties dialog box opens.
3. Follow steps 2-3 in the section To add sub-layers (children) to map layers: above.
To Do This
Show/hide layers Select/clear the check boxes of the layers you want to show/hide.
NOTE: If you use the map search to find an entity on the map, the system
will automatically select the check box making that type of entity visible,
even if you had previously cleared the check box.
Edit a layer 1. In the Layers pane, select the layer you want to edit.
Delete a layer 1. In the Layers pane, select the layer you want to delete.
Move a layer up/down in 1. In the Layers pane, select the layer you want to move up.
the Layers pane tree
hierarchy 2. In the Layer pane toolbar, click the Move Up/Move Down icons.
3. Repeat step 1 until the layer is where you want it in the tree hierarchy.
Control room operators can manipulate sensors through the sensor icons and navigate to linked locations through the
marker icons.
Entities that are placed on maps can be managed and manipulated directly from the map in the Control web application.
The dynamic map toolbox provides users with the most frequently used map operations for video and access to control
sensors in a single click. Toolbox buttons change according to the map icon clicked, giving users only the operations
needed for that entity type. For example, open/close camera icons will be available for cameras and lock/unlock door
will be available for ACS icons. The toolbox can be undocked and moved for easy management and access to all the
tools. In addition, all toolbox buttons are configurable and buttons can be added or removed.
Icon operations not contained in the toolbox are accessible through drop-down menus. Upon right-clicking a map object
icon, the options appear according to the entity type.
You can only place entities on a map that has a map layer for that object. For example, you can only place a sensor icon
on a map that has a sensor map layer defined.
If you place an entity on a map that has more than one relevant map layer, you will choose the layer to which you want
the entity to belong.
In addition, cameras/sensors can be manipulated through the sensor icons. For example, doors can be opened or
unlocked and cameras can be opened or rotated.
2. From the Maps view toolbar, click the Place Entity button. The Select Entity dialog box opens.
3. (Optional) Click the table headers to organize the information they contain in ascending or descending order.
Click and drag the columns to resize them.
4. (Optional) Use the Search field to find specific entities.
5. Do one of the following:
b. From the Entity type drop-down list, select one of the following:
6. Click on the map location where you want to place the icon representing your camera/sensor.
If there is no layer defined for the object (in this case a Sensor layer), a Sensor’s layer is automatically
created.
If there is more than one of the same layer types (in this case more than one Sensor layers), you are
prompted with a list of Sensor layers to choose from. Click the layer to which you want the object to
belong.
IMPORTANT: After placing a camera on the map, you can define its FOV, as described in Defining a
Camera’s Field of Vision (FOV) on page 210. If you do not define the FOV, the Default FOV is used, and
some features are not available and, if it is a PTZ camera, automatic tracking will be degraded for that
camera.
2. In the Map view toolbar, click the Place marker button. The Select Marker dialog box opens.
If there is no layer defined for the object (in this case a Marker layer), a marker layer is automatically
created and the marker icon displays on the map.
If there is more than one of the same layer types (in this case more than one Marker layers), you are
prompted with a list of marker layers to choose from. Select a layer and click OK. The icon is then placed
on the map.
2. Select the Activate Link check box. The maps are now available for selection.
3. Select the map view you want your marker to be linked to.
4. Click OK.
5. (Optional) add automatic actions to markers that can be triggered straight from the map icon. For example, you
can add a marker that sends a predefined message when clicked on the map. See To add automatic actions to
markers: on the next page.
2. Select the actions . For a list of available automatic actions, refer to Action Options on page 126.
3. Click OK.
2. Right-click the camera icon, select FOV Operations, and then select Draw Field Of View.
The cursor changes to a crosshair icon (+), and a colored range and a box showing the degrees and distance of the
FOV appear.
3. Move the cursor to the desired range and distance using the numbers in the box to guide you.
4. Click to save your definition. The FOV range is now filled with solid color.
5. To change the range, repeat the above steps.
6. (Optional) Use additional operations available from the FOV Operations menu:
Rotate the camera icon (for PTZ cameras). Refer to Rotating a PTZ Camera's Icon on a Map on page 240
Show/hide the FOV presentation on the map. Refer to Showing/Hiding a Camera's Field of Vision (FOV)
on page 230.
Delete the FOV (see below)
2. Right-click the camera icon, select FOV Operations, and then select Delete FOV. The FOV is removed.
Geo-maps - FOV is deleted from all Geo maps in which this sensor is located
Non-Geo maps - FOV is deleted from the specific map in which this sensor is located.
14.8 Measuring the Distance and Area between Objects on a 2D Map 223
14.10 Showing/Hiding the Field of View (FOV) of all Cameras on a Map 226
You can drill down on maps that are configured with drill-down markers. For example, a map that includes an airport
might have a child map of a control tower building which also has a child map showing the building layout.
2. In the Map Views pane, you can perform the following operations:
To Do This
Drill down on maps In the map view of interest, click the desired marker. The child
map linked to the marker opens.
To Do This
Click
Add a map view as a child to the selected map Do one of the following:
Click
To Do This
Locate a map in the Map Views pane Use the Search bar. You can search for maps and favorites.
Favorites display in the Map Views pane marked with stars and you can instantly open them. Favorites save the zoom,
map extent, and the layers settings. A favorite may be set as the default view for when the map is opened. It can be
accessed when you go to the Default Position.
4. Enter the new name of your view, which will appear in the tree.
5. Click OK. The new favorite is added to the tree under the map view name with a yellow star icon, for instant
access.
To Do this
To Do this
Set a favorite Right-click the favorite that you want as the default view, and select Set as default
as the default favorite for map view. This view will open when you click the Go to map view's default
map view
position button in the main toolbar.
2. In the Maps view toolbar, click the Add Label button. Your cursor changes to a cross-hair icon (+).
3. Click on an area where you want to add your label. The Label Properties dialog box opens.
NOTE: If a Label layer is not defined in the Layers pane, a Label layer is automatically added.
To Do this
Change the color and font Click the Ellipsis button next to the Color and Font fields and select a color and
font.
Change the label angle Type the angle in degrees you want the label to turn. For example, if you type 90,
the label displays vertically and is read from top to bottom. If you type -90, the
label displays vertically and is read from bottom to top.
To Do this
Change reading direction Select the Right to left reading order check box.
(for labels in right-to-left
supported languages)
NOTE: In order for right-to-left supported languages to display
properly on maps, settings for the desired language must be
selected in the Windows Control Panel Regional and Languages
dialog box.
NOTE: You can view all your changes in the Preview box at the bottom of the dialog box.
Additional operations:
To Do this
Edit a label’s properties 1. Right-click the label on the map, and select Properties. The Label Properties dialog
box opens.
2. Make your chnges and click OK.
Move a label on the 1. Rright-click the label on the map, and select Move. Your cursor changes to a
map crosshair (+).
2. Click on the map to move the label to the cursor location.
Delet a lable Right-click the label on the map, and select Delete.
To draw lines:
1. In the navigation toolbar, click Maps to open the Maps view pane.
2. Select the map on which you want to draw lines.
3. From the Maps view toolbar, click the Draw Line icon. Your cursor changes to a crosshair(+).
4. Click on an area where your line will begin, move the mouse pointer over to the area where you want your line to
end, and double-click.
To draw multiple joined lines, at the end of a line click once and move the mouse pointer to the next point. Repeat
until you have completed your drawing. To end, double-click.
NOTE: You can only add an object to a map that has a map layer for that object. For example,
adding a line to a map that has a "Line" map layer defined. If you have more than one Lines layer,
the Layers dialog box opens, enabling you to select the layer you want the line to be a part of.
5. Do the following:
6. After making your selections, click OK. The line is now drawn on the map.
Additional Operations
To Do This
Redraw the line 1. Right-click on your line and then select Redraw Line. The mouse pointer changes to a plus
(+) sign.
2. Click on an area where your line will begin, move the mouse pointer over to the area where
you want your line to end and double-click.
To Do This
Edit the line Right-click on your line and then select Properties. The Line Properties
properties dialog box opens
Edit your line's name, description, width, and color.
Click OK.
Delete the line Right-click on your line and select Delete. The line is deleted.
NOTE: When zooming in/out on maps, the size of the map entities changes according to how they are
defined by an administrator.
2. From the Maps view toolbar, click the Zoom In button. "Zoom In" appears in the map label bar and the
cursor changes to a magnifying glass with a plus mark.
3. Hold down the left mouse button and draw a box, defining the specific area you want to zoom in on. The smaller
the box, the greater the amount of enlargement.
4. Release the mouse button. The view magnifies the defined area to become the new map extent.
1. From the Maps view toolbar, click the Zoom Out button. "Zoom Out" appears in the map label bar and the
cursor changes to a magnifying glass with a minus (-) mark.
2. Click to zoom out a fixed increment. Repeat to zoom out more.
To pan a map:
1. In the navigation toolbar, click Maps to open the Maps view.
2. From the Map Views pane on the left, select the map you want to pan.
3. In the Maps view toolbar, select the Panning icon , Your cursor changes to a hand symbol.
4. Click and hold the mouse button. Drag the mouse away from the current area. Release the mouse button. The
map is redrawn.
NOTE: If a map is zoomed to a very large size and you want to navigate to an area far from your
current location, you might have to pan repeatedly until the area of interest is visible.
5. To return the map to its original view: In the Maps view toolbar, click the Go to the map view's default
position button.
3. From the Maps view toolbar, click the Map Snapshot button and then select Copy map to clipboard.
The map is copied and a confirmation message appears: "Copy map to clipboard succeeded".
Measure Enables you to measure the distance between two map objects.
Line
Measure Enables you to measure an area between two map objects. If the function is grayed-out, then it
Area is not available in this configuration.
3. From the Maps toolbar, click Measure Distance icon. A Measure window opens and your cursor changes
to a cross-hair (+).
5. Click and drag the cursor from one point to another. The distance is displayed in the measure window. To stop
the measurement and continue from that point to another, click and drag the line again. To end, double-click.
Entity Properties
Marker name and which other map views the marker links to
Hover your mouse over the map entity icon. A tooltip appears with the entity's properties.
Right-click a map entity icon on a map and then select Properties. The Entity Properties dialog box
opens.
TIP: You can edit entity properties: Click Edit, make your changes and click OK.
3. In the Maps view toolbar, click Toggle FOV display for all cameras . The FOV for all the
cameras on the map appears.
To hide the FOV for all cameras, click the Toggle FOV display for all cameras button again.
You can access commonly used operations for cameras and sensors with a single click and control them via their map
icons, using:
The Map Toolbox - Toolbox buttons change according to the map icon, providing only the operations available for
that icon type.
The icon right-click menu - The menu options change according to the map icon, providing only the operations
available for that icon type.
By default, the map toolbox appears above the Map Views pane when you click an icon. You can undock and move it to
any location on the map.
You can test this functionality in Administrator to make sure it will work correctly in real-time.
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer to To
undock/dock and move the toolbox: on the previous page.
3. Click Acknowledge. The alarm is now acknowledged and the applicable sensor/camera icon stops flashing.
Right-click the camera icon and select FOV Operations > Show FOV/ Hide FOV.
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
b. Click Show FOV. The camera's FOV shows and the Show FOV button toggles to the Hide FOV
button.
See Also:
Showing/Hiding the Field of View (FOV) of all Cameras on a Map on page 226.
Rotating a PTZ Camera's Icon on a Map on page 240
3. Right-click the camera icon and select Administration Operations > Change FOV Data. The Camera View
Properties dialog box opens.
4. Click OK.
When you perform one of these actions, an arm, disarm, or bypass command is automatically sent to the
sensor/camera. For more information, refer toUnderstanding Sensor Modes, States and Door Commands on page 150.
Right-click on the icon and select Arm or Disarm from the menu.
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
4. In the comment box, type a short comment that describes why you performed the operation, and then click OK.
The chosen operation is applied.
To bypass a sensor/camera:
1. Right-click on the specific sensor/camera icon that you want to bypass and then click Bypass.
2. In the comment box, type a short comment that describes why you performed the operation, and then click OK.
The chosen operation is applied.
When you perform one of these actions, a corresponding command is automatically sent to the sensor.
Right-click on the icon and select Emulate Operations > Alarm/ Failure/ Tamper from the menu. A
frame appears around the selected icon and the state is changed.
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
b. Click Emulate, and then from the drop down menu select Alarm, Failure or Tamper, as
applicable. A frame appears around the selected icon and the state is changed.
NOTE: If the sensor/camera failure is not resolved, the sensor/camera map object will revert back to a
state of failure.
To reset a sensor/camera:
1. In the navigation toolbar, click Maps to open the Maps view.
2. Select the map that displays the sensor/camera icon you want to reset .
3. Do one of the following:
a. Right-click on the icon and select Reset from the menu. The Comment dialog box opens.
b. Type a short comment that describes why you performed the operation, or select one of the
Predefined comments.
c. Click OK. The frame around the selected icon disappears and the state is changed.
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
c. Type a short comment that describes why you performed the operation, or select one of the
Predefined comments.
d. Click OK. The sensor/camera or failed sensor/camera is now reset and the applicable
sensor/camera icon displays the change. The frame around the selected icon disappears and the
state is changed.
Right-click on the icon and select Access Control Operations and select one of the menu options:
Open Door
Lock Door
Unlock Door
Normalize Door (to cancel inhibit door mode)
Inhibit Door (to lock a door without recording card swipes)
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
Open Door
Lock Door
Unlock Door
Normalize Door (to cancel inhibit door mode)
Inhibit Door (to lock a door without recording card swipes)
4. A command is sent to the sensor and the applicable operation is applied to the door.
Right-click on the icon and select Administration Operations > Move from the menu. Your cursor
changes to a cross-hair (+).
NOTE: The toolbox can be undocked and moved to any location on the screen. Refer
to To undock/dock and move the toolbox: on page 229.
3. Right-click the map icon, select Administration Operations > Change Location. The GIS Location dialog box
opens.
4. From the Coordinate System drop-down list, click the desired coordinate system to be used when setting the
location of your marker on a map.
5. 5. In the Latitude and Longitude fields, type the coordinates where you want to move your entity to (in
Decimal or Degree format) or use the up and down arrows.
6. Select one of the Altitude options from the drop-down list and set the altitude using the slider, the upand down
arrows or type in a value.
7. After making your selections, click Move.
3. Right-click the map icon, select Add Scheduled Task. The Scheduled Task Wizard dialog box opens.
4. Continue defining the task as described in Adding Scheduled Tasks on page 95.
3. Right-click the camera icon that you want to rotate and from the drop-down list select FOV Operations >
Rotate. The cursor changes to a cross-hair (+).
4. Move your mouse until the camera faces the required direction, and then click. While you are rotating the
camera icon, a box showing the camera's degrees appears over the icon and a dashed line projects from the lens
of the camera icon.
NOTE: On a geo-referenced map, the x and y coordinates appear in the upper right corner of the
screen, directly above the map. If you know the x and y coordinates of the direction you want the
camera to face, you can rotate the camera until the x and y coordinates meet your required
coordinates.
To Do this
Move a marker on the map a. Select Administration Operations > Move. Your cursor changes to a
cross-hair (+).
b. Click the area to where you want the marker to move. The marker now
relocates to that area.
Change the marker location Refer to Changing an Entity’s Location on a Map on page 237.
Edit a marker's link a. Select Administration Operations > Edit Link... The Edit Link dialog
box opens.
b. Select the Activate Link check box
c. Click the map view you want your marker to be linked to, and click OK.
Edit a marker's quick launch a. Select Execute Action. The Quick Launch Actions dialog box opens.
actions
b. Select the desired actions and click OK.
c. For a list of available automatic actions, refer to Action Options on
page 126.
Change a marker's icon a. Select Change Icon...The Select Marker dialog box opens.
b. Click the icon you would like to represent the marker, and click OK.
To Do this
Delete the marker Select Delete. The marker is now removed from the map and deleted from
the database.
This also deletes the marker's links and assigned quick launch
actions.
16.1 Overview
VisionHub provides a multi-site feature which enables the connection of a central site to remote sites and the easy
management of video in the connected sites. In distributed environments, such as mass transportation with several
stations, the multi-site feature enables the Chief Security Officer, for example, to view and manage video in all
connected sites from his location in the organization’s headquarters.
A multi-site architecture is made up of a “central” site and remote sites. In the example of a mass transportation multi-
site environment, each station would be considered a remote site.
The following image is an example of a multi-site architecture with a central site and two remote sites.
In VisionHub terminology, a site refers to a VisionHub deployment that mainly includes the middle-tier, which is a
combination of the OPAS (Operational Application Server), video gateway(s) and a VDAS (Video Application Server). In
the central site, a remote site is represented by a video gateway. In the remote site, the remote VDAS (Video
Application Server) acts as the central point of management between the different physical system entities.
The central site acts as your template when creating a remote site. By default, a new site comes with a VisionHub
Gateway Host and a local video gateway already installed which enables video. When the central site connects to the
remote site, a video gateway is added to the central site Gateway Host. However, in the event that a site loses network
connection to the VDAS, cameras, recorders and video walls can still stream video in VisionHub Control as the player
connects to the recorder directly.
Each site holds its physical configuration (cameras, recorders, decoders, video/audio channels and triggers) on the
VDAS. However, the site’s logical entities (groups, pages, tours, sensors, maps etc.) and identity management (security
roles, users, etc.) are defined in Administrator and held in the VisionHub OPAS. All logical entities are relevant per site
and there is no sharing/discovery of logical entities between sites.
2. In the Modules pane, click Remote Sites Management. The Remote Sites workspace opens.
3. In the Remote Sites workspace toolbar, click Add Site. The Add New Role dialog box opens.
NOTE: The mandatory fields are indicated by a red rectangle surrounding the field box.
4. In the Site Name field, type a name for the remote site. The name must be unique. Spaces entered before or
after the site name will be automatically removed.
5. In the Site IP/Host Name field, type the remote site IP or host name of the remote site. The IP address/Host
Name must be unique.
6. In the Site Host drop-down list, select the relevant Gateway Host. The Gateway Hosts that display in the drop-
down list are the Gateway Hosts that were added in the Monitored Services module. Refer to Managing
Monitored Services on page 251.
NOTE: The first Gateway Host that displays in the drop-down list is the default.
7. In the Certificate drop-down list, select the relevant certificate. The video gateway connects to the VDAS
using a server-to-server certificate authentication. In this drop-down list, the certificate path will be updated
according to the selected Gateway Host.
8. To enable auto-discovery of sensors from the Central site, select the Enable Auto Discovery check box.
NOTE: In the Remote Sites workspace you can manually synchronize auto-discovery for a site that
has auto-discovery enabled by right-clicking the site and then selecting Sync Auto Discovery.
9. To test the connection, click Test Connection. If the connection fails, an explanation for the failure appears. For
example, if the Application server is down the test connection will fail.
NOTE: Even if Test Connection fails, the site will be created when you save.
10. After defining your new site, click Save. To cancel adding the site, click Cancel.
To delete a site:
1. In the Remote Sites workspace, click to highlight the site you want to delete.
2. Do one of the following:
3. To delete, click Yes. The site is removed with all related sensors (the Central site is not deleted).
4. In the Remote Sites workspace toolbar, click Edit. The Edit Site dialog box opens.
5. Make the required changes and click Save, or, to discard changes, click Cancel.
NOTE: All parameters are cloned other than Site IP/ Host and Enable Auto Discovery. You must enter a
unique Site IP and enable auto-discovery manually.
4. In the Remote Sites workspace toolbar, click Clone. The Clone Site dialog box opens.
NOTE: All parameters are cloned except for the Site IP/Host Name which must be unique.
5. In the Site IP/Host Name field, type the remote site IP or host name of the new remote site.
6. To save your changes, click Save. To discard your changes, click Cancel.
NOTE: The red "disconnected" icon indicates a disconnection from the VDAS or gateway due to a
failure. When a connection is reestablished, the icon changes back to Normal state.
In Administrator Application, the Monitored Services module enables administrators to view, add Web API or Gateway
Host services, edit host names or delete services. monitored by the monitoring service.
2. In the Modules pane, select Monitored Services.The Monitored Services workspace opens.
3. In the Monitored Services toolbar, click Add. The Configure Monitoring Service dialog box opens.
4. In the Monitor Type drop-down field, select the relevant service type.
NOTE: When a new Web API or Gateway Host is installed, a new row is automatically added in
the database and the monitoring service needs to be restarted.
2. In the various sections, set your options for the workstation as required:
Option Description
General
Measurement System Select the measurement system you want to use in VisionHub to determine
distances on a map. Options include: U.S. or metric.
Option Description
External Users Per Page Select the number of users to display per page
Sensors
Popup Settings Dialog before When integrated with specific gateways, select this option to enable
Sensor Group Commands date/time and priority settings before issuing a sensor group command.
OSD1 - defines the default setting of whether the logged-in user's name is displayed in the OSD and exported
video (see below). Initially the option is disabled so the default is to not display the username. If the option is
enabled:
The username will appear in the upper-left corner of the Control OSD. In the Player, as well as in the NVF
file, the username will display under the channel name.
Control application users having User Settings permission can still select/clear the Display User Name
check box for their client in both Settings > Viewing experience and Settings > Investigation
experience. The default for these check boxes is taken from the setting in Administrator > Site
Configuration > OSD.
Export - enables setting the default export and snapshot path for all Control clients. Only authorized users (those
having permission Configure export and snapshot path) can override the default setting and change the path in
either the Investigation experience tab or in the Export window. When clicking Reset in
Settings>Investigation experience, the export path is restored to the default value set here in Tools > Site
Configuration. When clicking Reset in the Export window, and the user has User Settings permission, the
default path will be that specified in Settings, otherwise the path will be that specified here.
1Onscreen Display
2. In the OSD tab, select or clear the Display username on OSD check box.
2. Select Export. The current default path is displayed (hover the mouse over it to see the entire path).
3. Click Browse, navigate to the required location, and click OK in the Browse dialog box.
4. Click Save to save the new path setting, or Cancel.
20.4 Field Work Monitoring and External Visitor Incident Types and Procedures 268
2. In the left pane, under Samples, select one of the predefined procedures: Alarming Intrusion Sensor,
Alarming Fire Sensor, Forced Door, Injury, Crime, Field Work Monitored, External Visitor, or
Pandemic Alert. These predefined procedures are described in the next sections.
3. To edit a procedure, refer to the Planner User Guide.
The use case flow for the Alarming Intrusion Sensor and Alarming Fire Sensor is illustrated in the following diagrams.
To use the Alarming Intrusion or Fire Sensors, you must activate the incident type upon first login to the application.
Refer to Defining and Managing Rules on page 107.
The default Alarming Intrusion/ Fire Sensor definitions include a rule for triggering that incident type, as well as a
predefined procedure for the operator. You can modify these definitions or refer to them as templates for creating a new
rule and procedure.
To access the default Alarming Intrusion/ Fire Sensor rule (from Administrator):
In the Administrator application, Administration view, Rules module, select the name of the rule.
The condition for triggering the alarm is Sensor state was changed, with the resulting action defined in the lower
pane.
Configure Access Control System (ACS) sensor and associated camera. Position sensors on a map.
Apply a rule to all ACS sensors to trigger a Forced Door incident upon a forced door alarm.
The default Forced Door definitions include a rule for triggering that incident type, as well as a predefined procedure for
the operator. You can modify these definitions or refer to them as templates for creating a new rule and procedure.
The condition for triggering the alarm is Door was forced, with the resulting action defined in the lower pane.
An Injury procedure might include locating and placing the incident on a map, sending assistance, and, if required, calling
an ambulance etc. After the emergency is handled it is important to try to find the cause.
A Crime procedure might include sending security personnel to evaluate the risk and stop the potential criminal, and, if
required, to call the police. It is also important that the operator finds any available evidence, such as video clips and
images, for later investigation.
Required configuration includes creating a Quick Launch procedure that creates a new Injury/ Crime incident in
Planner.
The use case flow for each Injury and Crime incident types is illustrated in the following diagrams.
20.4 Field Work Monitoring and External Visitor Incident Types and
Procedures
Field Work Monitored and External Visitor are default incident types. Field work, such as "maintenance",
sometimes requires operator involvement to inspect safety. When an external visitor requests access to an
organization’s facilities, safety procedures are required. The operator manually creates a Field Work or External Visitor
incident, in the Control application using a Quick Launch button, and follows the predefined procedure.
A Field Work procedure might include, monitoring the work on video, documenting the work, and ensuring there are no
resultant safety hazards.
An External Visitor procedure might include having the visitor sign-in, checking their identification, providing a visitor
badge, and calling the visited employee to accompany them.
Required configuration includescreating a Quick Launch that creates a new incident, as described in Planner.
The use case flow for each Monitored Field Work and External Visitor incident types is illustrated in the following
diagrams.
Configure additional Access Control System (ACS) sensor and associated camera. Position sensors on a map.
Apply a rule to all ACS sensors to trigger a Pandemic incident upon a Pandemic alert.
Automatic Actions Actions that are triggered automatically by predefined activation rules when handling
an incident.
For example, when a sensor goes into alarm, the action "Open new incident" might be
triggered.
Active slot The selected slot/video viewer is the one with a turquoise border around.
Administrative user A VisionHub user with the authorization to customize Control including the following:
Arm Processes alarms and failure alarms for selected sensors or all sensors in a group.
Bypass Ignores all activity (sensor is still armed but does not go into alarm or trigger actions
upon activity).
Camera Also referred to as video or/and audio channel that streams media from the field of view
where it is installed to the recording device or to workstations.
Collaboration Data The assignee and set of stakeholders are referred to as the Collaboration Data for the
incident. See Assignee and Stakeholder.
Collaborator Users and job titles that can perform tasks that are especially assigned to them but are
not responsible for handling the incident. The receive notifications relevant to the
incident so they are kept abreast of related developments and disposition.
Control room The physical control room where operators work with desktop computers (each running
the Control application) and external video monitors that display video.
Decoder (also referred A device that is connected to the network. A decoder receives digital video streams and
to as video switch) converts them back to an uncompressed analog signal. This signal can be displayed on a
standalone monitor or on a video wall (VMX). The monitor can be HDMI, DVI, VGA or a
composite analog monitor.
Direct PTZ Direct PTZ devices allow PTZ operations to be sent directly from the application/player
to the camera/recorder.
Disarm Disables any rules or automatic actions for selected sensors or all sensors in the group
but still processes alarms and failure alarms.
Entity A physical or a logical entity in the system, including video channel, audio channel, mixed
channel, map, sensor, and tour. All entities together are called system content.
Event Events are triggered by sensors. An event notifies that something happened to a
sensor. Events are written to a log and can be investigated at any time.
External User Access Control System (ACS) user from an external ACS.
Gateway A software component that interacts with a third-party external device and interfaces
between the functionalities provided by the external device and Situator core
components. The third-party devices are represented in VisionHub as sensors. The
Gateways are vendor agnostic, supporting any third-party system using APIs.
Incident An event that requires an operator response in Control such as a fire, accident, or
security threat. Whether automatically triggered by sensors or manually created,
incidents display in the incidents Pane list.
Incident Type Refers to the category assigned to the incident such as Fire, Leak, Evacuation, and
Perimeter Intrusion.
Job Title Job titles of individuals who take an active part in the organization’s routine and
emergency operations.
Keywords User-defined terms related to incident types that are used in runtime to recommend
incident procedures to an operator. When a new incident is opened, the defined
keywords appear as a tooltip recommending relevant procedures.
Layout The layout defines the number, size, and position of the content "slots" in the window.
You can select from predefined layouts and define a custom layout.
Marker A map icon that marks a location on a map and can be linked to other maps, used to
quick launch an action or linked to sensors to indicate when the sensor is in a state of
alarm.
Map Entity Icons placed on maps to represent and manage items such as camera/sensors, vehicles,
assets, and users.
Monitoring activity A process of viewing live video and analyzing it, watching playbacks from specific time,
and performing various other operations using Player.
Page A Control page is defined by its content and layout. Layout defines the number and
position of slots. Content includes such as the maps, channels, tours and sensors
populating the layout. You may open any number of pages, and each page remembers
its specific content and layout.
Pan Move a camera or map vertically or horizontally. Panning a camera would be to move it
left, right, up or down. To pan a map (or pan across a map) would be to move the area of
view up, down, left or right.
Pop-up Notification A box that pops up on the screen when an incident is opened, incident severity level is
raised, an incident is escalated, or a system error is reported.
Quick Launch button A single-click button that triggers an incident with predefined actions when responding
to emergency situations.
Rule A rule-based engine for defining activation rules that need to be executed when events
take place.
Security Role Each VisionHub user is assigned a security role, or "role", which determines that user’s
access to various VisionHub functionalities, and an authentication policy, which
determines that user's login permissions. Examples of roles include: operators, building
managers and patrol officers.
Sensor An entity type in VisionHub that represents a third-party edge device such as ACS
reader, camera, decoder, panic button, etc.
Skills Skill set necessary for users assigned to specific job titles.
Slot Video slot -a single viewing pane in the content layout, in which can be displayed a map,
video, tour, or sensor. You can configure the number and layout of the slots as well.
Stakeholder A user or job title that shares the same authorities to work on an incident as the
assignee. However, the assignee is responsible for the incident while the stakeholder
participates in incident handling.
Streaming Stream refers to on-demand video or audio transmission over a data network. In the
Video Configurator, the monitoring and playback stream types are configured.
Depending on the specific network type, you may want to change the preconfigured
streaming settings. In the Control application, you can override the default monitoring
stream that was configured in Video Configurator.
Tooltip A pop-up window containing additional options or information that appears when the
mouse is positioned over a link.
Tour (virtual tour) An automatic sequence of camera inputs that is displayed in a single slot according to
their dwell time and presets. Dwell time is the amount of time video is displayed before
it is replaced by another video segment.
Video wall (VMX) A wall with external monitors that display video; A logical entity for easy visual
representation in Video Configurator application of an actual video wall/Control Room.
VisionHub User An individual who belongs to the security operation and participates in incident handling,
receiving incident tasks or notifications.
The acronyms and abbreviations used in the VisionHub documents are listed below.
Term Description
AD Active Directory
AS Application Server
CR Control Room
DB Database
HA High Availability
IP Internet Protocol
Term Description
MIB The Management Information Base is a text file that defines the interface between the
agents and the NMS
NMS Network Monitoring System (NMS) is the monitoring service which monitors VisionHub
components via SNMP. The SNMP trap events are logged in its database and enables
ticketing and notification policies.
NTP Network Time Protocol - a protocol for distributing time information between computers on
a network
OS Operating System
PRTG Qognify is able to integrate with PRTG, Paessler's network monitoring software.
Term Description
SNMP Simple Network Management Protocol. A network protocol used for managing and
reporting device status and events
SMTP Simple Mail Transfer Protocol is an Internet standard for electronic mail (e-mail)
transmission across IP networks