C6602M | 11/17
USER GUIDE
VxToolbox
User Guide
Contents
Initial VideoXpert Server Configuration Using VxToolbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
LDAP Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
VxToolbox Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Changing Your VxToolbox Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Licensing Your System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Automatically Activating Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Adding and Updating Entitlements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Installing Entitlements After Restoring Your System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Camera Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Discovering Cameras . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Finding Cameras (Quick Discovery) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Finding Cameras (Advanced Discovery) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Finding and Adding Cameras (Quick Discovery and Add) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Adding Cameras to VxToolbox Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Camera Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Devices and Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Camera Settings and Thumbnail Previews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Finding and Filtering Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
System Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Adding Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Adding Devices to a System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Recorders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Internal and Restricted User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Adding Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Assigning Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Resetting Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Deleting Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Renaming Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Managing Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Event Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Downloading Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Event Types and Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
3
Initial VideoXpert Server Configuration Using VxToolbox
VideoXpert comes with a 60-day trial license. During this 60-day trial, you have access to all VideoXpert features, and you can ignore
the Licensing tab within VideoXpert.
To use VideoXpert beyond the 60-day trial, you must apply a license to the server. Licensing requires either an internet connection on
the VideoXpert server itself, or access to a separate computer with internet access.
1. After installing VideoXpert, click Configure or run VxToolbox for the first time on your system.
2. Set the password for the admin user on your system.
NOTE: The default user name is admin. Setting a password is optional, but strongly recommended.
3. Provide a Company Name; this the name by which Pelco’s licensing portal will recognize your VX server and it cannot be changed.
4. Go to the System tab and provide a friendly name for the system. This is the name by which VxOpsCenter workstations and VxUl-
timate aggregation servers will recognize your VX server. Click Save Settings.
4
5. Go to the Camera tab and click to discover cameras.
6. Select the cameras you want to add to VX, and then click to formally add the cameras to the system and begin recording. Your
system is now recording cameras and ready for access from VxOpsCenter workstations.
LDAP Authentication
You can configure VideoXpert to validate user credentials from an LDAP server; VideoXpert supports LDAP for Microsoft Active Directory.
While the system can validate credentials over LDAP, you must create corresponding users within VideoXpert to validate credentials
against. You must also assign roles and permissions through VideoXpert; there are no analogs for VideoXpert permissions in Active
Directory or LDAP.
NOTE:
• After changing a password in an environment using LDAP authentication, a user’s old password may still work for a short period of
time (less than one hour). This is a Windows NTLM authentication behavior, designed to allow accounts logged in to multiple
computers or network services to access the network while the password change propagates.
• LDAP Authentication does not affect restricted system users. When LDAP is enabled, you can still change passwords for admin,
aggregator, and rule_engine_user accounts through the Admin Portal; these accounts are authenticated by VideoXpert no matter
how you authenticate other users.
While VideoXpert may support other LDAP authentication schemes, this guide focuses on -- and the product has been tested against --
two common methods for LDAP authentication: simple (single bind) and two-stage bind with a service account:
• Simple (single-bind) authentication, which associates a user name and password with a distinguished name (DN) to validate user
credentials.
• Two-stage bind authentication: which uses a service DN and a service DN password to establish the initial bind with the LDAP
server. Upon a successful initial bind, a search is performed using the base DN, the first key from the Search Attributes box, and
the user name. If the user’s information is found, the second bind is performed using the DN to authenticate user credentials.
Configuring LDAP Authentication
1. Go to the System tab and click LDAP.
2. Select LDAP.
3. Enter the host name or IP address of the LDAP server.
4. (Optional) Click the SSL/TLS box if your LDAP server requires SSL/TLS authentication.
5. (Optional) Edit the Server port if the LDAP server is not on the default port (389).
6. Configure Search Settings for your LDAP server. See Configuring Simple Search Authentication or Configuring Two-Stage Bind
Authentication later in this guide for more information.
5
7. Click Test Connection to verify that your LDAP connection and search settings are correct.
8. Click Save.
Configuring Simple Search Authentication
Configuring search settings for simple LDAP authentication only requires the Base DN and the Search Attributes. Leave other fields
blank. When inputting multiple entries in a box, separate entries with commas.
1. Type a distinguished name (DN) that will be combined with a user attribute key and value pair in the Base DN box.
2. Type an attribute key name that is combined with the User Name attribute in the Search Attributes box.
Configuring Two-Stage Bind Authentication
Configuring search settings for two-stage LDAP authentication requires that all fields be populated. When typing multiple entries in a
box, separate entries with commas.
1. Type the distinguished name (DN) that acts as the basis for user searches by User Name in the Base DN box.
2. Type a fully qualified DN associated with a service account that will bind with the LDAP server and perform user searches in
the
Service DN box.
3.
Type the password that allows the service DN to bind with the LDAP server in the Service DN Password box.
4. Type the two attribute keys that are combined with the User Name attribute; separate the two keys with a comma.
• The first key identifies the attribute containing the user name.
• The second key identifies the fully qualified DN used for the second bind and credential validation.
6
VxToolbox Credentials
When starting VxToolbox, the application requests credentials. These credentials are local to the workstation and your VxToolbox instal-
lation; they do not log you in to any system or camera. Rather, your VxToolbox credentials protect your settings and the credentials for
the individual cameras and systems you want to access from other users on the same workstation.
After logging in to VxToolbox, you can add systems with independent credentials, and pass credentials to cameras requiring them (closed
authentication or third-party cameras).
Because your local VxToolbox environment may connect you to multiple systems and cameras, it is recommended that you protect your
credentials and log out when you have finished using the application.
Changing Your VxToolbox Password
1. Click and select Account Settings
2. Provide a new password, and click Ok.
7
Licensing Your System
VideoXpert is licensed by channel, the video or audio streams you record. It comes with 4 licenses to start, but you must license addi-
tional channels to view or record additional streams.
You can license the system automatically or manually. Automatic licensing requires your VideoXpert system to be connected to the
Internet (with access to the Pelco licensing server). Manual licensing allows you to license a system that does not have an Internet
connection.
For manual licensing, you must have your activation ID and a separate computer with access to the licensing server at
http://licensing.pelco.com. During the manual licensing process, you will need to transfer your Licensing Request File to a computer with
Internet access during the activation process. If you received multiple activation IDs for VideoXpert products, you must complete the
process below for each individual activation ID.
As a part of the manual licensing process, you will download an Entitlement Request File and a Entitlement File; both files are specific
to the product for which they were requested. It is recommended that you rename both files to reflect the system for which they are
intended to prevent confusion during the licensing process.
1. Open VxToolbox and go to the Licensing page.
2. Click to add a li cense. If your system has an active Internet connection with access to http://licensing.pelco.com, you can select
the option to activate the license online and skip the remaining steps in the licensing process.
3. Enter your activation ID in the Activation ID box, and then click Enter. A Entitlement Request File, named request.bin, will be down-
loaded to your computer.
4. Open a new browser window or tab and go to the Pelco licensing server at http://licensing.pelco.com.
5. Log in to the Pelco licensing server. You can use your user name and password or your Activation ID.
6. Click Generate License.
7. Click Choose File, select your Entitlement Request File, and then click OK.
8. Click Generate License. The Entitlement File, named response.bin, will be downloaded to your computer.
9. Return to the Licensing page within VxToolbox.
10. Click Choose file under Upload Entitlement File.
11. Select your Entitlement File, and then click OK.
12. Click Upload.
13. Click Save.
R
ESULT:
When the process is complete, VxToolbox will display the installed license, and, if applicable, its expiration date.
Automatically Activating Licenses
If your system has an active Internet connection with access to http://licensing.pelco.com, you can automatically activate licenses for
your system.
Adding and Updating Entitlements
The Licensing page contains options to update or add entitlements to VideoXpert. The page shows your current entitlements and the
licenses used on the system.
8
VxToolbox allows you to apply licenses to various systems. However, you cannot use both Enterprise and Ultimate licenses in against
the same system. If you intend to upgrade from VideoXpert Enterprise to VideoXpert Ultimate, contact Pelco Product Support at
1-800-289-9100 (USA and Canada) or+1-559-292-1981 (international) for assistance.
• Click Add to add a new license. Follow the on-screen instructions to add a license.
• Place your cursor over an existing entitlement to reveal additional options; you may delete entitlements that have not yet been fully
applied.
Installing Entitlements After Restoring Your System
It is highly recommended that you back up your system and save the response file used to apply your initial entitlement.
If restoring your system after uninstalling VideoXpert, you can re-apply your initial entitlement or license. If you re-image your system,
you cannot apply your previous entitlement. If you have re-imaged your system, contact Pelco Product Support at 1-800-289-9100 (USA
and Canada) or+1-559-292-1981 (international) for assistance.
9
Camera Management
VxToolbox can search the local network or the network belonging to any particular VideoXpert system for cameras. Or you can add
cameras manually to the VxToolbox list. Through VxToolbox, you can manage camera settings for all the devices on the network, without
having to go to individual camera interfaces.
Discovering Cameras
VxToolbox searches for cameras from the system you have selected.
•If VxSystem is set to None, VxToolbox will search for cameras from the VxToolbox workstation.
•If VxSystem is set to any other system, VxToolbox will initiate the search for cameras from the system’s VxCore server(s).
Finding Cameras (Quick Discovery)
Click to perform a quick search for cameras. Remember, camera discovery is relative to the system you have selected. This option
only discovers cameras; however, you must add cameras manually or use the Quick Discovery and Add option.
VxToolbox can discover Pelco cameras or third-party cameras supporting ONVIF. You can also add cameras manually.
Finding Cameras (Advanced Discovery)
Click and then select Advanced Search to find cameras using specific drivers.
Finding and Adding Cameras (Quick Discovery and Add)
Click and then select Quick Discovery and Add to find and add cameras to the system.
Adding Cameras to VxToolbox Manually
You can add individual cameras by IP address. You may want to add cameras that don’t support ONVIF or Pelco discovery methods manu-
ally.
1. Click and select Advanced Search.
2. Click Add Manually.
3. Provide the IP addresses of cameras you want to add manually.
4. Click Discover.
10
Camera Credentials
Some cameras require credentials for you to access their video or change their settings. You can only credential cameras when you have
not selected a site.
Credentialing a Camera
To pass credentials to a camera:
1. Select the camera requiring credentials.
2. Pass credentials into the appropriate fields, and click Submit.
Devices and Data Sources
Use the View option to determine whether you want to view devices or data sources. If a device and its data sources are distinguishable,
you can click next to it to see its individual data sources.
The audio and video sources produced by cameras are referred to as data sources. These data sources are not necessarily one per
device. For example, a multi-channel encoder may have multiple cameras connected to it, each with its own data source; a camera may
have a microphone, producing audio and video data sources.
You can select a camera to view its video data source. However, if you select a device with multiple video-data sources, you can select
k to view all the data sources available to it; you can then select any individual data source to view its video.
Camera Settings and Thumbnail Previews
When you select a camera, VxToolbox will show you a preview thumbnail in the right-most part of the window. From here you can edit
camera settings and preview what your camera is seeing.
You can update settings for up to 150 cameras at a time.
Table A: Camera Credential Icons
Device requires authentication
Device does not require authentication
VxToolbox has authenticated to this device
This camera is authenticated in VxToolbox, but not on the system with which it is associated. Click the icon to
attempt to authenticate the camera with the system.
This camera is authenticated on a particular system with which it is associated, but not in VxToolbox. You must
first authenticate to view and/or edit the device.
11
Editing Camera Settings
You can select and update camera settings for up to 150 cameras at a time. When editing the settings for multiple cameras, you will
only be presented with options that are shared between all of the cameras selected.
Changing some settings may require the camera to restart, causing gaps in video recording. Do not change settings that would require
camera restarts unless you have scheduled maintenance.
1. Select the camera(s) you want to edit.
2. Click next to the group of settings you want to change for a camera.
3. Make your changes.
4. Click Save when done to save your settings.
Editing Friendly Names
The friendly name and tags for cameras can make them easier to find in VideoXpert systems or within VxToolbox.
Backing Up and Restoring Cameras
You can backup and restore camera settings directly through VxToolbox.
The backup and restore features utilize ONVIF. If you camera does not support the appropriate backup and restore features via ONVIF,
you will be unable to backup or restore the camera via VxToolbox.
Finding and Filtering Sources
Filters appear in the left-most panel of the Cameras tab and may appear in other tabs. Click to reveal the Filters panel. Use filtering
options to show the devices and data sources relevant to you within the system or environment you have selected.
You can filter by name, ID, model, IP address, vendor, or software version. Click More Options to reveal additional options.
Available Fields
Click Visibility Options to determine the fields you want to expose to the list. Check a field to show it; uncheck a field to hide it.
12
System Management
While you must still perform certain administrative actions from the VideoXpert Admin Portal, VxToolbox provides a single interface from
which to manage and configure both cameras and your VideoXpert Systems. From VxToolbox, you can manage any system you can
access by IP address.
Selecting a system (by name) from the VxSystem menu allows you to configure that system; the settings you see are relevant to the
system, and any discovery operations you perform are issued directly from that system.
Use the VxSystem menu to switch between various VideoXpert systems.
Adding Systems
VxToolbox allows you to administer systems remotely. To add a system to VxToolbox, you must have network access to the system and
your user account must be assigned the administrative role.
1. Click , and click Manage System Connections.
2. Click .
3. Provide the IP address, Port (if different from the default), and credentials to access the system.
4. If an SSL/TLS certificate has been uploaded and configured through Admin Portal, select Check SSL/TLS Certificate... to validate
the certificate.
5. Click Add.
Editing or Removing Systems
Editing or removing a system, only affects your settings within your local VxToolbox installation. You may need to edit a system if your
credentials for a particular system expire or are changed by an administrator.
1. Click , and click Manage VX System Connections.
2. Select the system you want to edit or remove.
• Click to edit system settings.
• Click to remove the system.
NOTE: If an SSL/TLS certificate has been uploaded and configured through Admin Portal, select Check SSL/TLS Certificate... to
validate the certificate.
3. Click Save when complete.
13
Adding Devices to a System
You must add a device to VideoXpert to make it visible within the system (through the Admin Portal or VxOpsCenter) and manipulate its
settings. You must commission a device to view its video or to use its video or resources within VideoXpert. In many cases, commis-
sioning a device requires a license; the type of license required is dependent on the type of device you are commissioning. In most cases,
adding and commissioning devices is a single, simplified operation.
Add or Commission operations are available from the Cameras tab for the selected system. Commissioning information is shown in the
column; you can expose this column by selecing Added/Commissioned from Visibility Options in the filtering pane.
NOTE: Licensing information is currently available through the Admin Portal; you cannot determine the number or types of licenses
through VxToolbox.
Adding and Commissioning Devices
VxToolbox will only provide commissioning options applicable to the camera(s) you have selected. Add or Commission operations are
relevant to the system you have selected from the VxSystem menu.
1. Select the devices you want to add or commission within the Cameras tab.
2. Click and select an add and/or commission operation.
Recorders
The Recorders tab allows you to assign data sources (video and audio) to recorders within the VxSystem you have selected.
At present, you can assign devices to recorders, but you cannot create recording schedules through VxToolbox; assigning data sources
to a recorder without creating a schedule will cause the data sources to record all the time. You must create schedules through the Admin
Portal, and you can perform advanced VxStorage configuration by connecting to the recorder using its IP address on port 9090.
Assigning Cameras to Recorders
The recorders and cameras you see in the Recording tab are relevant to the VxSystem you have selected and are commissioned.
1. Go to the Recorders tab.
2. Select the recorder to which you want to add or remove data sources. Use filters to find the sources you want to add to the recorder.
3. Check boxes next to the devices you want to add to the recorder; uncheck boxes next to devices you want to remove from the
recorder.
Table A: Are my devices added or commissioned?
Icon Added Commissioned
No No
Yes No
Yes Yes
14
User Management
The Users page provides an interface to manage user accounts and assign roles to users. Each user must be assigned at least one role
login and use VideoXpert.
From the Users tab, you can add users to or remove users from VideoXpert.
Users within VideoXpert can be assigned one of four roles:
• Administrator has full rights to the system.
• Manager has all Supervisor rights and the ability to configure recorders and devices within the system, including tags, recorder
assignment, etc. Managers can also assign roles to users.
• Supervisor has advanced access to live and recorded video including investigations, PTZ control, and plugins. Supervisors can use
plugins, configure events, and access workspaces configured by other users.
• User has basic rights to view live and recorded video.
Internal and Restricted User Accounts
VideoXpert contains some hard-coded user accounts that are integral to the system. You cannot edit, disable, or delete these accounts,
nor can you change roles or permissions for these users. You can, however, change the password for these accounts; in the case of the
admin and aggregator accounts, it is recommended that you change the password from the default.
Adding Users
When adding users to the system, you give them a temporary password. Upon logging in for the first time, the system will require users
to change their passwords.
You can also provide additional user information, like name, phone number, and ID, to easier associate user names with personnel;
Name fields appear anywhere the system provides a user name.
1. Go to the Users tab.
2. Click .
3. Enter a user name and password.
4. Assign a role to the user.
5. Provide additional user information (First Name, Last Name, etc).
6. Click Save.
User Description
admin The basic administrative user for VideoXpert. This user account possesses the “administrator” role is
granted all available permissions within the system.
aggregator Used internally by VideoXpert’s aggregation feature to communicate accross sites.
rule_engine Supports the rules engine.
15
Assigning Roles
VideoXpert contains 4 pre-defined roles that you can assign to users. You cannot change these roles; each user must be assigned a role
to use VideoXpert. Any locking features or competing actions performed by users are prioritized by user level.
• Admin provides a user full access to all system settings and features.
• Manager enables the user full access to system features and the ability to configure recording.
• Supervisor provides full access to system features, including managing and locking PTZ cameras, and launching views on monitor
walls or on another user’s workstation.
• User is the basic user account that allows access to most system features. However, base users cannot store global settings or
make any changes that might affect other users.
To assign roles:
1. Go to the Users page.
2. Select the user for whom you want to assign or remove roles, and click .
3. Assign the user a role.
4. Click Save.
Resetting Passwords
By default, users must change their passwords every 60 days. Users with appropriate permissions can either reset users’ passwords or
force users to change their passwords early.
Resetting a user’s password will allow you to grant the user a temporary password. Upon logging in, the system will require the user to
change his or her password. You may want to reset a user’s password if a user does not remember his or her password, or the user is
locked out of the system because he or she is locked out of the system due to failed login attempts or let the password change timer
lapse.
1. Go to the Users page.
2. Select the user whose password you want to reset, and click .
3. Click Change Password, and provide a new password.
4. Click Save.
Deleting Users
1. Go to the Users page.
2. Select the user you want to remove.
3. Click .
4. Confirm your selection.
16
Renaming Users
1. Go to the Users page.
2. Select the user you want to rename and click .
3. Enter a new user name.
4. Click Save.
Managing Roles
A role is a group of permissions defining abilities and responsibilities within a system. A user must be assigned at least one role to
perform actions within the system.
Creating a Role
1. Go to the Users tab and click Roles.
2. Click .
3. Provide a name for the new Role
4. Click Save.
Editing a Role
Renaming a role does not affect the users to whom the role is assigned.
1. Go to the Users tab and click Roles.
2. Click and change the role name and/or permissions as needed.
3. Click Save.
Duplicating a Role
By default, a duplicate role retains the permissions of the original role.
1. Go to the Users tab and click Roles.
2. Click .
3. Provide a name for the duplicated role and edit permissions as needed.
4. Click Save.
Deleting a Role
1. Go to the Users tab and click Roles.
2. Click .
17
Assigning Permissions to Roles
By default, a new role contains no permissions. When assigning permissions to a role, you can determine resource restrictions, if any,
for the permission.
Permissions assigned to a user display the resource restrictions associated with the permission.
1. Go to the Users tab and click Roles.
2. Select the role for which you want edit permissions.
3. Select the permission you want to assign or edit.
4. Select the Resources the user can access.
• Any Camera indicates that the permission is not restricted for the role; the permission applies to all cameras.
• Selected Resources, Selected Cameras, etc allows you to select the resources/devices available for that permission; this
feature functions as a whitelist.
• All Resources Except, All Data Sources except, etc allows you to select the resources/devices that are not available for
the permission; this feature functions as a blacklist.
Restricting Resource Access for a Permission
Changing a permission’s Resource Access setting to Selected Data Sources disables all cameras for the permission. You must then
assign cameras to the permission, making them available to users possessing that permission.
Changing a permission’s Resource Access setting to All Data Sources Except enables all cameras for the permission. You must then
restrict resources available to the permission.
Use the Search Cameras field to quickly determine whether or not the permission allows access to a camera.
1. When the permission you wish to change is selected, click in the Allow Resources column.
2. If Allowed Resources is set to either Allow Selected Resources or Allow All Resources Except Selected, use the search fields
to locate the cameras you want to assign or unassign. Assigned cameras are available to users possessing the permission; unas-
signed cameras are not. When Allow All Resources Except Selected is chosen, unassigned cameras are available to users
possessing the permission; assigned cameras are not.
3. Click OK, and then click Save when you have finished assigning resources and configuring your permissions.
18
Event Management
From the Events tab, you can configure event details and notifications to ensure that the right users are notified when the system records
a particular action or alarm.
Configuring Event Details
1. Go to the Events page and select the event you want to modify.
2. Click .
3. Change event settings as necessary.
• The Display Name is how VideoXpert will represent the event.
• Un-check the Active box to prevent VideoXpert from reporting the event.
• Change the Severity as necessary. The severity may help users determine whether or not they need to act on an event.
4. Click Save Changes.
Configuring Event Notifications
1. Go to the Events page and select the event you want to modify.
2. Click .
3. Indicate whether or not the event will cause banner alerts
within VxOpsCenter. If you enable a banner, you can also set the
following details.
a.
Determine whether or not to play a sound accompanying the event notification banner. You can upload a custom audio file for
the alert, and set the number of times to play the sound.
b. If you selected the Banner Requiring Acknowledgment option, determine whether or not to allow users to
snooze the
event.
c.
If you selected the Banner option, determine whether or not to automatically acknowledge the event after some period
of
time. By default, bann
ers persist until manually acknowledged.
d. Determine whether or not to hide Cell Alerts. Events associated with individual video sources provide alerts within Ops Cente
r
cells
; these alerts hide after 3 seconds. Select this option to prevent the alert from hiding.
4. If you enabled a banner, determine the user roles who will receive event notifications.
5. Click Save Changes.
19
Downloading Reports
From the Reports page, you can download reports from the system. Reports are exported in CSV format contained within a ZIP archive.
Reports using the require a start-date and time; other reports provide current data.
Generating reports containing a large number of events may take some time. You can navigate away from the Reports page while the
system generates your report. If your report parameters are too large, the request may time-out and the system may ask you to narrow
your search.
NOTE: In all reports, cameras and other devices connected through Digital Sentry servers display the IP address of the DS server through
which they are connected rather than their direct IP address.
1. Select the reports you want to download.
2. Set start and end dates for the report you want to download. Reports based on events logged by the system must be captured wi
thin
the event-retention time period;
by default, the system stores events for 30 days.
3. Click Export Reports.
Event Types and Reporting
You can pull reports (in CSV format) containing events and configuration information to audit your system and VideoXpert users. Reports
requiring a start date and time include an event history; reports that do not require a start date and time provide current configuration
information only. Depending on the date and time range you set, some reports may take several minutes for the system to process.
Event types typically refer to who or what is the cause of an event, and do not necessarily determine the report in which an event will
appear:
• Admin events typically occur at the administrative level.
• Analytic events are the result of software analytics.
• Client events that are reported by the client.
• External events, which are injected into the system by a third party.
• Hardware events resulting from physical hardware issues and sensor readings.
• System events are typically the result of normal operator actions.
The system holds events for 30 days. You cannot obtain reports past the 30 day threshold.
Camera Configuration Report
The Camera Configuration report provides the address, name, and number (if set) for cameras in the system (appearing on the Devices
page in the Admin Portal), and the recorders to which each camera is assigned.
Online/Offline Report
The Online/Offline report provides a list of all device_online and device_offline events happening in the time frame you specify with
relevant details for devices associated with each event.
Recorder Camera Assignment Report
The Recorder Camera Assignment report contains the complete list of recorders and the video sources assigned to each recorder. It
contains similar information to the Camera Configuration report, but is sorted by recorder.
20
Recorder Diagnostics Report
The Recorder Diagnostic report provides the current status and health of your VideoXpert recorders, including hard drive status.
User Actions Report
The User Actions report lists the events in the system for which users are directly responsible within VideoXpert. For example, the report
would not show a device_offline event, but would show a device_decommissioned event, listing the user responsible for decom-
missioning the device. The complete list of events in the User Actions report is available in the table above.
Event History Report
The Event History report provides a complete list of all events that occurred within the time frame you specify, including the source of
the event (device, user, etc) and the state of the event (acknowledged, in progress, etc.).
VX Cluster Configuration Report
The Cluster Configuration report provides a list of the Core and Media Gateway servers in your VideoXpert system and their online or
offline status.
Analytic and Other Video-Related Events
Analytic events generated by cameras are associated with video in VideoXpert. Within the Ops Center, you can use the Event Viewer
and video-associated events to drive to relevant video.
Page is loading ...
/