VideoXpert Professional
v 3.3 Operations Manual
Document number:C6601M-F
Publication date:04/19
VideoXpert Professional v 3.3 Operations Manual
Table of Contents
Using VideoXpert Toolbox 7
Performing Initial VideoXpert Server Configuration Using VxToolbox 7
Logging Out 9
Changing the VxToolbox Password 10
Licensing Your System 11
Viewing the License Summary 11
Adding and Renewing Licenses 12
Manually Activating Licenses 12
Automatically Activating Licenses 13
Installing Entitlements After Restoring Your System 13
Managing the System 14
Adding Systems 14
Editing the System Validation 14
Removing a System 15
Discovering Devices 16
Finding Devices (Quick Discovery) 16
Finding and Adding Devices (Quick Discovery and Add) 16
Finding Devices (Advanced Discovery) 16
Adding an RTSP Device 17
Recognizing Device Credentials 17
Adding Credentials to a Device 18
Managing Devices on a System 18
Viewing Devices, Data Sources, or Alarms & Relays 20
Configuring the Rules Engine 22
Managing Rules 22
Managing Triggers 23
Managing Schedules 25
Managing Responses 27
Configuring Recording 30
Configuring a Recorder 30
Assigning Cameras to a Recorder 30
Adding a Recording Group to a Recorder 31
Creating a Recording Schedule for a Recording Group 31
Creating a Bump on Alarm Recording Schedule 32
Editing a Recording Group 33
Editing a Recording Schedule 33
Deleting a Recording Group 34
Deleting a Recording Schedule 34
Deleting a Recording Behavior (Trigger) 35
Managing Users and Roles 36
Understanding Internal and Restricted User Accounts 36
Creating a Role 36
Editing a Role 37
Duplicating a Role 38
Deleting a Role 38
Viewing Details of a Role 38
Adding Users 38
Searching for Users 39
Assigning Roles 39
Resetting Passwords 39
Deleting Users 40
Configuring VX System Settings 41
Aggregating Systems (VX Enterprise only) 41
C6601M-F | 04/19 2
VideoXpert Professional v 3.3 Operations Manual
Configuring General Settings 42
Configuring Authentication 42
Configuring System Backups 46
Restoring Databases on VideoXpert Enterprise Systems (VideoXpert Enterprise only) 47
Backing Up and Restoring the Database on VideoXpert Professional Systems (VideoXpert
Professional only) 48
Configuring the SMTP Server 49
Using Monitor Walls 51
Creating a Monitor Wall 51
Editing a Monitor Wall 52
Deleting a Monitor Wall 52
Using Reports 54
Creating a Report Template 54
Editing a Report Template 55
Deleting a Report Template 55
Generating a Report Manually 56
Exporting a Generated Report 56
Deleting a Generated Report 56
Managing Events 57
Setting Event Log Retention Periods 57
Finding and Filtering Events 57
Viewing and Configuring Event Details 57
Viewing and Configuring Event Notifications 58
Using VideoXpert Maps Import Utility 60
Preparing Your System 60
Creating a New Map 60
Viewing an Existing Map 61
Editing an Existing Map 62
Removing an Existing Map 62
Managing Permissions for Maps 62
Using VxPortal 63
Accessing VxPortal 63
Changing the System Password in VxPortal 63
Managing Exports 64
Configuring the Server 64
Viewing Keyboard Shortcuts 65
Logging Out 65
Configuring Advanced Storage Using VideoXpert Storage Portal 66
Accessing the VideoXpert Storage Portal 66
Checking VideoXpert Storage Status 66
Generating and Downloading Storage Logs 66
Configuring the Server in VideoXpertStoragePortal 66
Using Volume Groups and Volumes 67
Using External NAS Storage (Archive Volume Group) 67
Creating a New Volume Group 67
Editing a Volume Group 68
Deleting a Volume Group 68
Creating a New Volume 69
Editing a Volume 69
Deleting a Volume 69
Associating Devices With a Volume 69
Viewing Storage Assignments 70
C6601M-F | 04/19 3
VideoXpert Professional v 3.3 Operations Manual
Changing the Password 70
Logging Out 71
Using VideoXpert OpsCenter 72
Installing and Configuring VxOpsCenter 72
Installing VxOpsCenter (VideoXpert Enterprise only) 72
Running the Application for the First Time 72
Setting Up Your Workstation 73
Reconfiguring Your Workstation 74
Configuring Monitors for VideoXpert Workstations (VideoXpert Enterprise Only) 75
Configuring VX System Connections 76
Configuring Shared Display Mode 80
Configuring VxOpsCenter Kiosk Mode (Optional) 82
Logging In 83
Understanding User Account Types 83
Setting Your Display Language 83
Changing Your Workstation Account Password 84
Using the VxOpsCenter Interface 85
Adding Quick Access Icons to Mission Control 86
Using Context Menus 86
Using Tooltips 87
Using Watched By 88
Setting User Preferences 88
Using Tabs and Workspaces 91
Using Tab View Options and Modes 91
Configuring Tab View Options 91
Changing Tab Modes 92
Creating a New Tab 92
Opening a Saved Tab 93
Updating an Existing Tab 93
Changing Tab Layouts 93
Editing the Metadata of an Existing Tab 94
Creating a New Workspace 94
Opening a Saved Workspace 94
Updating a Saved Workspace 95
Edit the Metadata of an Existing Workspace 95
Deleting a Saved Tab from the System 95
Deleting a Workspace from the System 96
Viewing a Monitor Wall 97
Sending Views to Workstations or Shared Displays 98
Using View Launcher to Send Views to Workstations or Shared Displays 98
Using Quick Launch to Send Cells to Workstations or Shared Displays 99
Watching Video 100
Understanding Cell Borders 100
Responding to an Alarm in a Cell 100
Rotating the Camera 101
Viewing Analytics Overlays 101
Enabling and Disabling Audio 102
Expanding a Cell to Full-Screen 102
Watching Recorded Video With VideoXpert 102
Watching Recorded Video with Edge Storage 103
Using Pixel Search (VideoXpert Professional Only) 103
Creating Bookmarks 104
Finding and Recalling Bookmarks 104
Editing, Unlocking, and Deleting Bookmarks 104
C6601M-F | 04/19 4
VideoXpert Professional v 3.3 Operations Manual
Synchronizing Video Playback 105
Creating a Live Sequence Mode 105
Creating an Alarm Sequence Mode 106
Editing Sequences 107
Pausing and Resuming Sequences 107
Setting up Snapshots 108
Taking Snapshots 108
Displaying Statistics 108
Viewing and Filtering Sources 108
Managing Tags 109
Viewing Tags in the Selected Camera(s) Panel 109
Creating and Assigning Tags in the Selected Camera(s) Panel 109
Deleting Tags in the System Panel 110
Creating Folders in the Folders Panel 110
Renaming a Folder in the Folders Panel 111
Deleting a Folder in the Folders Panel 111
Playback Controls 111
Controlling Cameras (PTZ) 112
Using Investigation Mode 116
Entering Investigation Mode 116
Using Investigation to View Video Stored on a Camera's Local Storage 117
Using Auto-backfill Recording Gaps 118
Creating Clips 118
Creating a Playlist 119
Previewing and Editing Playlists 119
Exporting a Playlist 119
Encrypting Export Files 120
Using the Export Archive 121
Downloading Exports 121
Editing an Export Name 121
Deleting One or More Exports 122
Working with Plugins 123
Installing Plugins 123
Adding a Plugin to Your Workstation 123
Using the Event Viewer Plugin 123
Using the Image Viewer Plugin 124
Using the VxMaps Plugin 125
Using the Mapping Plugin 127
Using the Web Browser Plugin 130
Using the Access Control System Viewer Plugin (Optional) 130
Using the VideoXpert Plates ALPRPlugin 133
Closing a Plugin 138
Responding to Events 139
Using the Event Viewer 139
Using the Event Notifications Dialog Box 139
Logging Out 141
Closing the Application 142
Appendix A:Working With Permissions 143
Understanding Permission Resource Restrictions 143
Using Plugin Permissions 143
Using Supervision and Reports Permissions 144
Using Device Management Permissions 144
Using User Management Permissions 144
Using Event Management Permissions 145
C6601M-F | 04/19 5
VideoXpert Professional v 3.3 Operations Manual
Using System Management Permissions 145
Using Surveillance Permissions 145
Using Investigation Permissions 146
Using Special Case Permissions 147
Appendix B:Understanding Event Types and Reporting 148
C6601M-F | 04/19 6
VideoXpert Professional v 3.3 Operations Manual
Using VideoXpert Toolbox
Performing Initial VideoXpert Server Configuration Using VxToolbox
VideoXpert Enterprise and VideoXpert Professional each come with a time-limited trial license. During this
trial, you have access to all VideoXpert features, and you can ignore the Licensing tab within VideoXpert.
To use VideoXpert beyond the 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. For VideoXpert Professional systems, in the VideoXpert Basic System Setup dialog box, type
values in the Company Name and Name Your System fields, and then click Save.
3. For VideoXpert Professional system only, perform steps in the section titled Configuring General
Settings.
4. Perform the steps in the section titled Adding Systems.
5. For VideoXpert Professional systems, set the VxToolbox password:
a.
Click the menu icon ( ), and then click Set VxToolbox Password.
b. Type a value in the Password and Reset Password fields.
c. Click Save.
6. For VideoXpert Enterprise systems:
a. Set the password for the admin user on your system.
Note:The default user name is
admin
. You must set a new password.
b. (Optional) Click to select the checkbox to ensure that the system checks the SSL/TLS
Certificate when connecting to the server.
C6601M-F | 04/19 7
VideoXpert Professional v 3.3 Operations Manual
Enable this feature if your organization uses signed HTTPS certificates and the certificate has
already been loaded using VxToolBox.
c. Click Add.
d. In the VxToolbox Password Confirmation Window, click Set Password (recommended) or No
Thanks.
e. If you clicked Set Password, in the Set VxToolbox Password dialog box, enter a password in
the Password and Retype Password fields, and then click Save.
f. In the Configure VxToolbox dialog box, click OK.
g. If you enabled SSL/TLS Certificate checking, you might be required to interact with more
dialog boxes. If so, follow the prompts.
h. In the Configuration Required dialog box, enter a Company Name. This is the name by which
the Pelco licensing portal will recognize your VX server. The name cannot be changed later.
i. Click Save & Continue.
The VxToolbox application opens.
C6601M-F | 04/19 8
VideoXpert Professional v 3.3 Operations Manual
Logging Out
1.
Click the menu icon ( ), and then click Exit.
2. In the Exit confirmation dialog box, click Exit.
C6601M-F | 04/19 9
VideoXpert Professional v 3.3 Operations Manual
Changing the VxToolbox Password
When starting VxToolbox, the application requests credentials. These credentials are local to the
workstation and your VxToolbox installation; 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.
To change your VxToolbox password:
1.
Click the menu icon ( ), and then select Change VxToolbox Password.
2. In the Account Settings dialog box, enter a new password, and then click Save Changes.
C6601M-F | 04/19 10
VideoXpert Professional v 3.3 Operations Manual
Licensing Your System
VideoXpert is licensed for the system, for upgrades, and by channel--the video streams you view and
record. It comes with one (1) license to start. A Lite license (VideoXpert Professional only) has four (4)
channels, and a Demo license has unlimited channels. These are active only the first time you install the
software, or if the software was pre-installed, the first time you start up the system. You must license
additional channels to view or record additional streams.
You can license the system automatically or manually.
l Manual licensing allows you to license a system that does not have an Internet connection. See the
section titled Manually Activating Licenses
l Automatic licensing requires your VideoXpert system to be connected to the Internet and have
access to the Pelco licensing server. See the section titled Automatically Activating Licenses.
If one or more licenses associated with the VideoXpert system are nearing or past the expiration date and
require renewal, a warning dialog box will open. The dialog box lists the affected license(s) and the
expiration date.
NOTE:You can also view your current licenses at any time. See section titled
Summary
.
Viewing the License
For assistance, contact Pelco Product Support at 1-800-289-9100 (USA and Canada) or+1-559-292-1981
(international).
Viewing the License Summary
Entitlements are associated with licenses. A license might be a consolidation of several entitlements. To
view licenses:
1. Open VxToolbox and click the Licensing tab.
2. In the License Summary table (bottom panel), view the list of licenses. For each license:
l The license Name is listed. Unactivated Entitlements are listed as one license with the name
Pending. The names in the License Summary table correspond to the names in the
Entitlements table.
l The Total column lists how many licenses and channels (sources) are included.
l The In Use column identifies how many of the licenses and channels are in use.
l The Remaining column identifies how many of the licenses and channels are not currently in
use.
If one or more licenses are nearing expiration, three warning icons appear in the Licensing Summary area of
the Licensing page:
l On the right of the Licensing tab, itself
l In the left panel, to the left of the license Name
l In the top of the Details (right) panel
Hover over any of these warning icons to display (the same) relevant information.
Click Details to instruct the system to use existing information to build an estimated price quote. If the
necessary system variables cannot be retrieved, a default message is displayed instead of a quote.
For assistance, contact Pelco Product Support at 1-800-289-9100 (USA and Canada) or +1-559-292-1981
(international).
C6601M-F | 04/19 11
VideoXpert Professional v 3.3 Operations Manual
Adding and Renewing Licenses
When you are notified that one or more licenses are expiring or have expired, when you see the warnings in
the License Summary area of the Licensing page, purchase a Software Update Plan (SUP).
l SUPs are purchased in units of "channel-years".
l One channel-year represents the use of one (1)licensed channel for one (1) year.
l Channel-years are usually purchased in such a way as to allow each channel on the system to be
licensed for a period of several years.
For example:a system with 40 channels will need to purchase 80 channel-years to extend the SUP
by two (2) years.
l Adding channels to or removing channels from the system adjusts the expiration date of the
licenses to reflect how long it will take the connected channels to use the remaining channel-years.
l If your licenses expired before you renew them, part of your SUP is used to backfill the period of
time when the previous SUP/licenses had lapsed.
When licenses expire, all associated features are disabled until new licenses are installed or until the
existing licenses are renewed. If the SUPhas expired, you cannot upgrade the system until the SUP is
purchased or renewed.
For assistance, contact Pelco Product Support at 1-800-289-9100 (USA and Canada) or +1-559-292-1981
(international).
Manually Activating Licenses
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 this 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 click the Licensing tab.
2.
At the lower right corner of the Entitlements table (top panel), click the Add License icon ( ).
3. Enter your activation ID in the Activation ID box.
4. If necessary, click to deselect the checkbox to Automatically activate online.
5. You will be prompted to save an activation request .bin file. Select a folder (optional) type in a file
name, and then click Save.
An Entitlement Request File (named either what you typed in or the same name as the Activation
ID) with a .bin extension is downloaded to your computer.
6. Click Enter.
l The Entitlement Pending status message appears at the top of the Entitlements table.
l An entitlement named Pending will be listed in the table. At the far right of the Pending
entitlement row will be two icons: Download a new request (.bin) file ( ) and Remove this
activation ID ( ).
7. On a system connected to the Internet, open a new browser window or tab and go to the Pelco
licensing server at http://licensing.pelco.com.
C6601M-F | 04/19 12
VideoXpert Professional v 3.3 Operations Manual
8. Under Login, click to select logging in With User Name, With Entitlement ID, or With Activation
ID. You can also register as a New User.
9. Enter your credentials, and then click Login to access the Pelco licensing server.
10. Click the Manage Devices tab, and then click Generate License The Entitlement File, named
response.bin, will be downloaded to your computer. Copy the file and save it to the system on which
you are hosting VxToolbox.
11. Return to the Licensing page within VxToolbox.
12. Click Choose file under the Entitlements section.
13. Select your Entitlement File (response.bin), and then click Open.
14. Click Import License File.
When the process is complete, VxToolbox will display the installed license(s) in the Entitlements table.
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.
1. Open VxToolbox and click the Licensing tab.
2.
At the lower right corner of the Entitlements table (top panel), click the Add License icon ( ).
3. Enter your activation ID in the Activation ID box.
4. If necessary, click to select the checkbox to Automatically activate online.
5. Click Enter.
The system logs in to the Pelco licensing server and performs several tasks. Do not navigate away
from this page until you see the Add License dialog box.
6. Click OK.
VxToolbox will display the installed license(s) in the Entitlements table.
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.
l If restoring your system after uninstalling VideoXpert, you can re-apply your initial entitlement or
license.
l 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.
C6601M-F | 04/19 13
VideoXpert Professional v 3.3 Operations Manual
Managing the System
For VideoXpert Enterprise, you must perform certain administrative actions from VxPortal; but for
VideoXpert Professional, you can perform all administrative actions from VxToolbox. For all VideoXpert
Systems, VxToolbox provides a single interface from which to manage and configure both cameras and
your VideoXpert Systems. From VxToolbox, you can manage any system that you can access by IP
address.
Selecting a system (by name) from the VX System 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 VX System 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. Access the Add a new VX system dialog box by one of these methods:
l
Click the menu icon ( ) at the upper right corner of the window, click Manage VX System
Connections, and then click the Add a new VX System icon ( ).
l At the upper left corner of the window, use the VX System drop-down menu to select Add a VX
system.
2. Enter an IP address in the Server Address field.
3. Enter a value in the Server Port field, or use the default port.
4. Enter the Admin Username and Password for the system you are adding.
5. If an SSL/TLS certificate has been uploaded and configured, click to select the checkbox for Check
SSL/TLS Certificate... to validate the certificate.
6. Click Add.
7.
Click the at the top left of the Manage VX System Connections window to close it.
Editing the System Validation
You can change whether the SSL/TLS certificate is validated when connecting to a system from
VxToolbox. Editing a system only affects your settings within your local VxToolbox installation.
1.
Click the menu icon ( ) at the upper right corner of the window, and then click Manage Vx System
Connections.
2. Select the system you want to edit.
3. In the right panel of the Manage Vx System Connections window, view the system connection
information.
4.
Click the Edit VX System icon ( ) to edit system settings.
a. Enter the Admin Username.
b. Enter the Password.
C6601M-F | 04/19 14
VideoXpert Professional v 3.3 Operations Manual
c. Click to select or deselect the checkbox for Check SSL/TLS Certificate...
5. Click Save.
6. In the Update dialog box, click OK.
7.
Click the at the top left of the Manage VX System Connections window to close it.
Removing a System
You can remove a system from VxToolbox. It can be re-added at any time.
1.
Click the menu icon ( ) at the upper right corner of the window, and then click Manage Vx System
Connections.
2. Select the system you want to remove.
3.
Click the Delete icon ( ) to remove the system.
4. In the Delete System dialog box, click OK to confirm the deletion.
5.
Click the at the top left of the Manage VX System Connections window to close it.
C6601M-F | 04/19 15
VideoXpert Professional v 3.3 Operations Manual
Discovering Devices
VxToolbox can search the local network or the network belonging to any particular VideoXpert system for
devices, or you can add devices manually to the VxToolbox list. Through VxToolbox, you can manage
device settings for all the devices on the network, without having to go to individual device interfaces.
VxToolbox can discover Pelco cameras or third-party cameras supporting ONVIF.
Note:You must be connected to a VideoXpert system to add devices to the system.
Finding Devices (Quick Discovery)
Use Quick Discovery to discover devices, but not add them. If you use Quick Discovery, you must add
devices manually. Alternatively, use the Quick Discovery and Add option described in the section titled
Finding and Adding Devices (Quick Discovery and Add). To use Quick Discovery, click Devices, and then
do one of the following:
l
Click the Quick Discovery icon ( ) to perform a quick search for devices.
l
Click the Advanced Discovery Options icon ( ) to the right of the Quick Discovery icon, and then
click Quick Discovery.
Finding and Adding Devices (Quick Discovery and Add)
1.
Click Devices, and then click the Advanced Discovery Options icon ( ) to the right of the Quick
Discovery icon.
2. Click Quick Discovery and Add.
All Devices and Data Sources that are discovered by VxToolbox are added to the VX System to
which you are connected.
3. If the Recorder Assignment dialog box opens, assign the third-party devices to a recorder.
a. Select an option from the Select Recorder drop-down menu.
b. Click Add.
c. If the devices cannot be added to the VX System, the Operation Failure dialog box opens.
Make a note of the information in the box, click OK, and then try to add the devices to a
different recorder. If necessary, contact Pelco Customer Support.
Finding Devices (Advanced Discovery)
Using Advanced Discovery, you can search for devices by protocol type or you can add individual devices
by IP address. You may want to add devices that do not support ONVIF or Pelco discovery methods using
the IP address.
1.
Click Devices, and then click the Advanced Discovery Options icon ( ) to the right of the Quick
Discovery icon.
2. Click Advanced Discovery.
3. To use Quick Discovery, but specify using either SSDP (Simple Service Discovery Protocol) or
WS-Discovery (Web Services Dynamic Discovery):
C6601M-F | 04/19 16
VideoXpert Professional v 3.3 Operations Manual
a. From the Discovery Method drop-down menu, select Quick Discovery.
b. Click to select or deselect the checkbox for SSDP.
c. Click to select or deselect the checkbox for WS-Discovery.
d. (Optional) Click to select the checkbox for Add discovered devices to the VX system.
4. If you want to discover devices by IP address or hostname:
a. From the Discovery Method drop-down menu, select Discover by IP or Hostname.
b. Enter a value in the Host field.
c. (Optional) Enter a value in the Port field.
d. (Optional) Type values in the Username and Password fields.
e. (Optional) Click Add Host Address, and repeat the previous three steps.
f. (Optional) Click to select the checkbox for Add discovered devices to the VX system.
5. Click Discover.
Note:While this feature adds devices to the system, it does not commission them. To commission
the devices, add them, then select them, right-click a device that is selected, and then click
Commission
.
Adding an RTSP Device
To add a device that uses RTSP:
1.
Click Devices, and then click the Advanced Discovery Options icon ( ) to the right of the Quick
Discovery icon.
2. Click Add RTSP Device.
3. Type a value in the Device Name field.
4. (Optional) Click to select the checkbox for Set Credentials, and then enter values in the Username
and Password fields.
5. Enter a value in the URI field.
6. (Optional) Click Add Another URI to this Device, and then enter a value in the URI field.
7. When you have added all URIs, click Create.
Recognizing Device Credentials
Some devices require credentials for you to access their video or change their settings. The Authentication
status column provides the status of each device, using the following icons:
Icon Description
Device requires authentication.
Device does not require authentication.
VxToolbox has authenticated to this device.
This device is authenticated in VxToolbox, but not on the system with which it is associated.
Click the icon to attempt to authenticate the device with the system.
This device 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.
C6601M-F | 04/19 17
VideoXpert Professional v 3.3 Operations Manual
Adding Credentials to a Device
To add credentials to a device:
Click Devices.
1. Select the device requiring credentials.
2. Enter credentials in the appropriate fields, and then click Submit.
Managing Devices on a System
You must add a device to VideoXpert to make it visible within the system and to manipulate device
settings. VxToolbox enables you to add a device or change device settings.
You must commission a device to view its video or to use its video or resources within VideoXpert.
VideoXpert typically commissions devices automatically when you add them to the system. In many
cases, commissioning a device requires a license; the type of license required depends on the type of
device you are commissioning.
Add or commission operations are available from the Devices tab for the selected system. Commissioning
information is shown in the Added/Commissioned ( ) column; you can expose this column by selecting
Added/Commissioned from Show Data Columns in the filtering panel.
Symbols in the Added/Commissioned column are:
Icon Status
Not added; not commissioned
Added; not commissioned
Added; commissioned
Adding and Commissioning Devices
VxToolbox will only provide adding and commissioning options applicable to the camera(s) you have
selected. Add and Commission operations are relevant to the system you have selected from the VX
System menu.
1. In the center panel of the Devices tab, select the devices you want to add and commission.
2. Perform one of the following steps:
l Right-click the device, and then select Add and Commission to [VX System name].
l Click to select the device, and then click the Add, Commission, and Assign Cameras to a
recorder icon ( ) at the lower right of the center panel.
l
Click to select the device, click the Addition, Commission and Assignment options icon ( ),
and then click Add and Commission to [VX System name].
3. If the Authentication Notice dialog box opens, follow the instructions in the dialog box.
4. If the Recorder Assignment dialog box opens, select a recorder from the drop-down menu, and then
click Add.
The icon for the device changes from Not added; not commissioned ( ) to Added; commissioned (
).
C6601M-F | 04/19 18
VideoXpert Professional v 3.3 Operations Manual
Adding Devices Without Commissioning
The Add operation is relevant to the system you have selected from the VX System menu.
1. In the center panel of the Devices tab, select the devices you want to add.
2. Perform one of the following steps:
l Right-click the devices, and then select Add to [VX System name].
l
Click the Addition, Commission and Assignment options icon ( ), and then click Add to [VX
System name].
3. If the Recorder Assignment dialog box opens, select a recorder from the drop-down menu, and then
click Add.
The icons for the devices change from Not added; not commissioned ( ) to Added; not
commissioned ( ).
Commissioning Devices that were Added Previously
VxToolbox will only provide commissioning options applicable to the camera(s) you have selected, and
which were already added. Commission operations are relevant to the system you have selected from the
VX System menu.
1. In the center panel of the Devices tab, select the devices you want to commission.
2. Perform one of the following steps:
l Right-click the devices, and then select Commission.
l
Click the Addition, Commission and Assignment options icon ( ), and then click
Commission.
The icons for the devices change from Added; not commissioned ( ) to Added; commissioned (
).
Decommissioning Devices
VxToolbox can decommission the camera(s) you have selected, on system you have selected from the VX
System menu.
1. In the center panel of the Devices tab, select the devices you want to decommission.
2. Perform one of the following steps:
l Right-click the devices, and then select Decommission.
l
Click the Addition, Commission and Assignment options icon ( ), and then click
Decommission.
The icons for the devices change from Added; commissioned ( ) to Added; not commissioned (
).
Removing Devices
After a device is discovered, it will persist in the system’s device registry until it is removed, even if the
device no longer exists on the network.
C6601M-F | 04/19 19
VideoXpert Professional v 3.3 Operations Manual
Removing a device will prevent you from retrieving any associated recordings through VideoXpert Storage.
To preserve access to recordings on VideoXpert Storage devices, decommission the devices until video
for the device has expired or you are sure you will no longer need to access recordings for the device, then
remove the device.
From VxToolbox, you can remove the device(s) you have selected, on the system you selected from the
VX System menu.
1. In the center panel of the Devices tab, select the devices you want to remove.
2. Perform one of the following steps:
l Right-click the devices, and then select Remove.
l Right-click the devices, and then click the Remove cameras from the list and/or VX System
icon ( ) at the bottom right of the center panel.
l
Right-click the devices, click the Addition, Commission and Assignment options icon ( ), and
then click Remove.
3. In the Remove Device(s) confirmation dialog box, click OK.
The devices are removed from the list. They can be discovered again at any time.
Viewing Devices, Data Sources, or Alarms & Relays
The audio and video sources produced by a device (for example, a camera) are referred to as data
sources.
A device can have more than one data source. 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.
A device can have one or more alarms and relays, depending on the device. For example: an encoder
typically has one alarm and one relay per device channel; a camera might have only one alarm and one
relay for the device. Alarms are configured and relays are enabled on the Devices page.
l To view all devices on the system, in the View field drop-down menu, at the top of the center panel,
select Devices.
l If a device and its data sources are distinguishable, you can see the individual data sources, alarms,
and relays. To see the data sources, alarms, and relays that are associated with a specific device:
a. In the View field drop-down menu, select Devices.
b. Click to select a device (camera).
c.
Click the expand icon ( ) to the left of the device.
Data sources, alarms (if any) and relays, (if enabled) are listed directly below the device.
l To view all data sources on the system, in the View field drop-down menu, at the top of the center
panel, select Data sources.
l To view the list of alarms and relays on the system, in the View field drop-down menu, at the top of
the center panel, select Alarms & Relays.
C6601M-F | 04/19 20
VideoXpert Professional v 3.3 Operations Manual
You can determine the status of an alarm or relay by the icons in the State column.
Icon State
Alarm is active
Alarm is inactive
Relay is active
Relay is inactive
You can determine whether an alarm or relay is enabled or disabled by the icons in the Enabled column.
Icon Enabled
Yes
No
Finding and Filtering Existing Sources
Use filtering options to show the devices and data sources relevant to you within the system or
environment you have selected. Filters appear in the left-most panel of the Devices tab and in some other
tabs.
l Click to expand, and then enter values in, the Filters Devices field to filter by criteria including the
device name, ID, model, IP address, serial number, vendor, or software version.
l Click to expand, and then click to select and deselect checkboxes in, the Filter by Type area.
l Click to expand, and then click to select and deselect checkboxes in, the Filter by Status area.
l Click in the Filter by Tags field, and type in or select a tag for which to filter. Tags are set in
VxOpsCenter. Refer to the VxOpsCenter User Guide for more information.
l Click Reset Filters to clear the filters.
Controlling the Columns Displayed in the Devices Window
On the Devices page, in the left panel, below the filter areas, click to select and deselect checkboxes in the
Show Data Columns area.
Viewing the License Summary
On the Devices page, in the left panel, below Show Data Columns, click to expand License Summary.
View the system license information.
C6601M-F | 04/19 21
VideoXpert Professional v 3.3 Operations Manual
Configuring the Rules Engine
The Rules tab allows you to configure events generated by a source to trigger a response. Rules can have
one or more triggers, zero or more schedules, and one or more responses. There can be multiple rules on
the system.
Managing Rules
Use VxToolbox to create, duplicate, edit, or delete rules in the rules engine.
Creating a Rule
1. Click the Rules tab.
2.
In the left panel, click the Create a new Rule icon ( ). The Edit Mode (right) panel is activated.
3. Enter a value in the Name of Rule field.
4. Click to select the radio button for Active or Inactive.
5. Add one or more triggers for the rule. See the section titled Adding a Trigger.
6. (Optional) Add one or more schedules to the rule. See the section titled Adding a Schedule.
7. Add one or more responses to the rule. See the section titled Adding a Response.
8. When you have finished configuring triggers, schedules, and responses, click Save.
Duplicating a Rule
To use an existing rule as a starting point to create a new rule:
1. Click the Rules tab.
2. (Optional) In the left panel, enter a value in the Search Rules field to filter the rules.
3. Click to select the rule to duplicate.
4.
Click the Duplicate the selected Rule icon ( ). The Edit Mode (right) panel is activated.
5. Enter a value in the Name of Rule field.
6. Click to select the radio button for Active or Inactive.
7. (Optional) Add, duplicate, edit, or delete one or more triggers for the rule. See the sections titled
Adding a Trigger, Duplicating a Trigger, Editing a Trigger, and Deleting a Trigger.
8. (Optional) Add, create a copy of, edit, or delete one or more schedules for the rule. See the sections
titled Adding a Schedule, Creating a Copy of a Schedule, Editing a Schedule, and Deleting a
Schedule.
9. (Optional) Add, duplicate, edit, or delete one or more responses for the rule. See the sections titled
Adding a Response, Duplicating a Response, Editing a Response, or Deleting a Response.
10. When you have finished configuring triggers, schedules, and responses, click Save.
Editing an Existing Rule
1. Click the Rules tab.
2. (Optional) In the left panel, enter a value in the Search Rules field to filter the rules.
3. Click to select the rule to edit.
4.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
C6601M-F | 04/19 22
VideoXpert Professional v 3.3 Operations Manual
5. Click to select the radio button for Active or Inactive.
6. (Optional) Add, duplicate, edit, or delete one or more triggers for the rule. See the sections titled
Adding a Trigger, Duplicating a Trigger, Editing an Existing Trigger, and Deleting a Trigger.
7. (Optional) Add, create a copy of, edit, or delete one or more schedules for the rule. See the sections
titled Adding a Schedule, Creating a Copy of an Existing Schedule, Editing an Existing Schedule,
and Deleting a Schedule.
8. (Optional) Add, duplicate, edit, or delete one or more responses for the rule. See the sections titled
Adding a Response, Duplicating an Existing Response, Editing an Existing Response, or Deleting a
Response.
9. When you have finished editing triggers, schedules, and responses, click Save.
Deleting a Rule
1. Click the Rules tab.
2. In the left panel (list of rules), click the rule to delete.
3.
Click the Delete the selected Rule icon ( ).
4. In the confirmation dialog box, click Delete.
Managing Triggers
Add, duplicate, edit, or delete triggers from a rule to control the type of events that will trigger one or more
responses.
Adding a Trigger
To add an entirely new trigger to a rule:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
In the Triggers panel, click the Add New Rule Trigger icon ( ).
5. (Optional) In the Select an Event to trigger this Rule dialog box, narrow the list of events. To do so,
you can select a category from the Show drop-down menu; you can also type a value in the Search
field.
6. In the Select an Event to trigger this Rule dialog box, click to select an event.
7. In the Select Event Sources to limit this Trigger for Rule dialog box, click to select the appropriate
radio button. The options vary depending on the trigger you have chosen. If you are prompted to do
so, make any other necessary selections, and then click Save.
8. When you have finished configuring the rule, click Save.
Duplicating a Trigger
To use an existing trigger as a starting point to create a new trigger:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4. In the Triggers panel, click to select a trigger to duplicate.
C6601M-F | 04/19 23
VideoXpert Professional v 3.3 Operations Manual
5.
Click the Duplicate Rule Trigger icon ( ).
6. (Optional) Edit the When this event settings, associated with the duplicate trigger:
a.
In the When this event column, click the edit icon ( ) in the appropriate trigger.
b. (Optional) In the Select an Event to trigger this Rule dialog box, narrow the list of events. To do
so, you can select a category from the Show drop-down menu; you can also type a value in the
Search field.
c. Click to select the event.
d. Click Save.
7. (Optional) Edit the is generated by settings, associated with the duplicate trigger:
a.
In the is generated by column, click the edit icon ( ) in the appropriate trigger.
b. In the Select Event Sources to limit this Trigger for Rule dialog box, click to select the
appropriate radio button. The options vary depending on the trigger you have chosen. If you are
prompted to do so, make any other necessary selections, and then click Save.
8. When you have finished configuring the rule, click Save.
Editing a Trigger
To use an existing trigger as a starting point to create a new trigger:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4. In the Triggers panel, click the trigger to edit.
5. (Optional) Edit the When this event settings, associated with the duplicate trigger:
a.
In the When this event column, click the edit icon ( ) in the appropriate trigger.
b. (Optional) In the Select an Event to trigger this Rule dialog box, narrow the list of events. To do
so, you can select a category from the Show drop-down menu; you can also type a value in the
Search field.
c. Click to select the event.
d. Click Save.
6. (Optional) Edit the is generated by settings, associated with the duplicate trigger:
a.
In the is generated by column, click the edit icon ( ) in the appropriate trigger.
b. In the Select Event Sources to limit this Trigger for Rule dialog box, click to select the
appropriate radio button. The options vary depending on the trigger you have chosen. If you are
prompted to do so, make any other necessary selections, and then click Save.
7. When you have finished configuring the rule, click Save.
C6601M-F | 04/19 24
VideoXpert Professional v 3.3 Operations Manual
Deleting a Trigger
If a trigger is no longer needed, delete it.
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4. In the Edit Mode panel, click to select the trigger to delete.
5. Do one of the following:
l
Click the at the left of the trigger entry.
l
Click the delete icon ( ).
6. When you have finished configuring the rule, click Save.
Managing Schedules
You can set one or more schedules to limit the times during which an event triggers a response; or you can
leave the Schedules panel unpopulated to allow the trigger/response combination at all times.
Adding a Schedule
To create an entirely new schedule:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
At the bottom of the Schedules panel, click the Edit Rule Schedules icon ( ).
5.
Click to select the Add a new schedule icon ( ).
6. In the Create Schedule dialog box, enter a value in the Display Name field.
7. Click to select the radio button for the increments.
8. (Optional) Click to select the checkbox for 24-Hr.Time.
9. Click and drag in the calendar to select the times.
10. (Optional) Click to select the checkbox for Within limited date range, if you selected Within limited
date range, you must also select the Start on and End after values.
11. Click Add.
12. In the Select Schedules for Rule dialog box, click to select the checkbox for the schedule to apply to
the rule.
13. When you have finished configuring schedules, click Save Changes.
14. When you have finished configuring the rule, click Save.
15. (Optional) To quickly view the scheduled times, click to select the schedule, and then click the View
selected Rule Schedule icon ( ). Click outside the calendar to close it.
C6601M-F | 04/19 25
VideoXpert Professional v 3.3 Operations Manual
Creating a Copy of a Schedule
To use an existing schedule as a starting point to create a new schedule:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
Click the Edit the selected Schedule icon ( ).
5. Click to select (highlight) the schedule to copy.
6.
Click the Create a copy of the selected Schedule icon ( ).
7. In the Duplicate Schedule dialog box, enter a new value in the Display Name field. If you do not
enter a new value, the schedule will be saved as [Original name] - Copy.
8. Click to select the radio button for the increments.
9. Click to select or deselect the checkbox for 24-Hour Time.
10. Click and drag in the calendar to select the times.
11. Click to select or deselect the checkbox for Within limited date range, if you select Within limited
date range, you must also select the Start on and End after values.
12. Click Add.
13. When you have finished configuring schedules, click Save Changes.
14. When you have finished configuring the rule, click Save.
15. (Optional) To quickly view the scheduled times, click to select the schedule, and then click the View
selected Rule Schedule icon ( ). Click outside the calendar to close it.
Editing a Schedule
To edit an existing schedule:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4. Click to select (highlight) the schedule to edit.
5.
Click the Edit Rule Schedules icon ( ).
6. In the Select Schedules for Rule window, click to highlight the schedule to edit.
7.
Click the Edit the selected Schedule icon ( ).
8. (Optional) In the Edit the Schedule dialog box, enter a new value in the Display Name field. If you do
not enter a new value, the schedule will be saved with the original name.
9. Click to select the radio button for the increments.
10. Click to select or deselect the checkbox for 24-Hour Time.
11. Click or click and drag in the calendar to select the times.
12. Click to select or deselect the checkbox for Within limited date range, if you select Within limited
date range, you must also select the Start on and End after values.
13. Click Save.
14. When you have finished configuring schedules, click Save Changes.
C6601M-F | 04/19 26
VideoXpert Professional v 3.3 Operations Manual
15. When you have finished configuring the rule, click Save.
16. (Optional) To quickly view the scheduled times, click to select the schedule, and then click the View
selected Rule Schedule icon ( ). Click outside the calendar to close it.
Deleting a Schedule
1. Click to select the Rules tab.
2. Click to select the rule to delete.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
Click the Edit the selected Schedule icon ( ).
5. In the Edit the Schedule dialog box, click to select the schedule to delete.
6.
Click the Delete Schedule icon ( ).
7. In the Delete Schedule confirmation dialog box, click Delete Schedule.
8. When you have finished configuring schedules, click Save Changes.
9. When you have finished configuring the rule, click Save.
10. (Optional) To quickly view the scheduled times, click to select the schedule, and then click the View
selected Rule Schedule icon ( ). Click outside the calendar to close it.
Managing Responses
Set one or more responses to the events in the rule.
Adding a Response
To add an entirely new response for a trigger:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
In the Responses panel, click the edit icon ( ) to the right of then this will happen. The Edit the
Responses triggered by Rule dialog box opens.
5.
Click the Add a new Response icon ( ).
6. Click to select an option from the Response Category drop-down menu.
7. Select the appropriate options requested in the dialog box. These will vary depending on the
Response Category that you chose in the previous step.
8. (Optional) If you selected a response type that is not Custom Script, you can change it to a custom
script. To do so, click Convert to Custom Script, and then click Convert in the confirmation dialog
box. The name of the response is changed to Custom Script, and the code is displayed.
9. When you have finished configuring responses, click Save.
10. When you have finished configuring the rule, click Save.
C6601M-F | 04/19 27
VideoXpert Professional v 3.3 Operations Manual
Duplicating an Existing Response
To use an existing response as a starting point to create a new response:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
In the Responses panel, click the edit icon ( ) to the right of then this will happen. The Edit the
Responses triggered by Rule dialog box opens.
5. Click to select the response to duplicate.
6.
Click the Duplicate the selected Response icon ( ).
7. With the duplicate highlighted, select the appropriate options requested in the dialog box. These will
vary depending on the Response Category of the response you duplicated.
8. (Optional) If you selected a response type that is not Custom Script, you can change it to a custom
script. To do so, click Convert to Custom Script, and then click Convert in the confirmation dialog
box. The name of the response is changed to Custom Script, and the code is displayed.
9. When you have finished configuring responses, click Save.
10. When you have finished configuring the rule, click Save.
Editing a Response
To edit an existing response:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
In the Responses panel, click the edit icon ( ) to the right of then this will happen. The Edit the
Responses triggered by Rule dialog box opens.
5. Click to select the response to edit.
6. Select the appropriate options requested in the dialog box. These will vary depending on the
Response Category.
7. (Optional) If you selected a response type that is not Custom Script, you can change it to a custom
script. To do so, click Convert to Custom Script, and then click Convert in the confirmation dialog
box. The name of the response is changed to Custom Script, and the code is displayed.
8. When you have finished configuring responses, click Save.
9. When you have finished configuring the rule, click Save.
Deleting a Response
To delete a response:
1. Click to select the Rules tab.
2. Click to select the rule to edit.
3.
Click the Edit the selected Rule icon ( ). The Edit Mode (right) panel is activated.
4.
In the Responses panel, click the edit icon ( ) to the right of then this will happen. The Edit the
Responses triggered by Rule dialog box opens.
C6601M-F | 04/19 28
VideoXpert Professional v 3.3 Operations Manual
5. Click to select the response to delete.
6.
Click the Delete the selected Response icon ( ).
7. In the confirmation dialog box, click Delete.
8. When you have finished configuring responses, click Save.
9. When you have finished configuring the rule, click Save.
C6601M-F | 04/19 29
VideoXpert Professional v 3.3 Operations Manual
Configuring Recording
The Recording tab allows you to assign data sources (video and audio) to recorders within the VX System
you have selected.
You can assign devices to recorders and create recording schedules through VxToolbox and VxStorage
Portal; assigning data sources to a recorder without creating a schedule will prevent data sources from
recording. You can perform advanced VxStorage configuration by connecting to the recorder using its IP
address on port 9091.
Configuring a Recorder
1. Click the Recording tab.
2. At the top of the left panel, click Recorders.
3. Click to select the recorder to configure.
4.
If available at the bottom of the left panel, click the Edit selected recorder's configuration icon ( ).
Not every recorder has configurable settings. Update recorder configuration settings, depending on
which are available for the recorder type.
a. (Optional) To change the recorder name, enter a new value in the Name field.
b. (Optional) If available, under Maximum Retention Period, enter a number in the Discard Video
after [#] Days field, either by typing in a value or selecting a value using the up and down
arrows.
c. If available, click to select the radio button for the Transmission Method field: Multicast or
Unicast.
d. If available, click to select the radio button for the Stream to Record field: Primary, Secondary,
or Primary+Secondary.
e. (Optional)If available, for cameras that have local recordings, click to select the checkbox for
Auto-backfill recording gaps using on-camera storage.
When selected, if there is a gap in recording of a camera (an edge device), the recorder will
query the camera for recordings, and automatically download video and audio (if present) to fill
the gap.
If you select this checkbox, you must also:
l Type or select a number from the drop-down menu in the Download data from up to [#]
cameras at a time field.
Downloading from more cameras uses more bandwidth, which will slow the data
transmission rate.
l Select a time-interval from the drop-down menu in the Attempt to download every field.
If edge devices (cameras) and the recorder lose communication, the VXSystem will
attempt to connect to the edge device again at the time-interval specified in this field.
l Type or select a value in the Stop trying to download after [#] failed attempts field.
f. Click Save Changes.
Assigning Cameras to a Recorder
The recorders and cameras you see in the Recording tab are relevant to the VX System you have selected.
1. Click the Recording tab.
2. At the top of the left panel, click Recorders.
C6601M-F | 04/19 30
Loading...