Professional Documents
Culture Documents
SecurOS System Dashboard User Guide
SecurOS System Dashboard User Guide
User Guide
SecurOS System Dashboard User Guide (UG - EN, build 117 on 7/13/2023).
SecurOS® ("SecurOS") and all respective logos are trademarks of ISS Corp, in the U.S. and/or other countries.
Intelligent Security Systems reserves the right to make changes to both this Manual and to the products it describes. System
specifications are subject to change without notice. Nothing contained within this Manual is intended as any offer, warranty, promise
or contractual condition, and must not be taken as such.
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system or translated into any human or
computer language in any form by any means without the express written permission of the copyright holder. Unauthorized copying
of this publication may not only infringe copyright but also reduce the ability of Intelligent Security Systems to provide accurate and
up-to-date information to both users and operators.
SecurOS System Dashboard 3 User Guide
Contents
Contents
1 Preface 4
1.1 Scope
........................................................................... 4
1.2 Target
. . . Audience
........................................................................ 4
1.3 Using
. . .This
. . . .Manual
.................................................................... 4
1.4 Getting
. . . .Technical
. . . . . . . . .Support
.............................................................. 4
1.5 Design
. . . .Convention
....................................................................... 5
1.6 Design
. . . .Elements
....................................................................... 6
2 General Description 7
3 Module Installation 8
4 Module Configuration 9
4.1 Image
. . .Processor
........................................................................ 9
4.2 REST
. . .API
........................................................................ 9
4.3 Database
........................................................................... 9
4.4 Diagnostics
. . . . . . . . .Server
.................................................................. 10
4.5 User
. . .Account
........................................................................ 11
4.6 User
. . .Rights
........................................................................ 11
5 Module Operation 13
5.1 Starting
. . . . . .Web
. . . .Application
................................................................. 13
5.2 Main
. . .Tab
........................................................................ 14
5.2.1 Navigation
. . . . .Bar
................................................................................ 15
5.2.2 Camera . .Status
. . . . . .Bar
............................................................................. 16
5.2.3 Filters .and
. . . Search
. . . . . . .Bars
.......................................................................... 16
5.2.4 Camera . .List
................................................................................... 17
5.2.4.1 Camera Information .......................................................................... 19
5.2.5 Camera . .Parameters
. . . . . . . . . .Window
......................................................................... 20
5.2.5.1 Filling and Editing . . . Camera
. . . . . . .Passport
................................................................ 21
5.2.5.2 Turning Monitoring . . . .Control
. . . . . .On
. . .and
. . . Off
.......................................................... 22
5.3 Reports
. . . . . .Tab
..................................................................... 24
5.3.1 Creating. . .Report
.................................................................................. 24
5.3.2 Working . . .with
. . . .Report
. . . . . .Data
........................................................................ 26
5.3.2.1 Time Spent by .the . . .Cameras
. . . . . . . in
. . "Performs
. . . . . . . . .properly"
. . . . . . .Status
............................................. 27
5.3.2.1.1 Graph Scaling .......................................................................... 27
5.3.2.1.2 Cameras .Statistics . . . . . . . Detailing
.................................................................. 28
5.3.2.2 Time Spent by .the . . .Cameras
. . . . . . . in
. . "Performs
. . . . . . . . .properly"
. . . . . . .Status
. . . . . .as
. .a. Percentage
. . . . . . . . . .of. .the
. . .Required
. . . . . . . Time
.............. 30
5.3.2.3 Time Spent by .the . . .Cameras
. . . . . . . in
. . "Fault"
. . . . . .Status
....................................................... 31
5.3.2.4 Total Duration of . . the
. . . Recorded
. . . . . . . . Video
. . . . . Archive
........................................................ 31
5.3.3 Exporting
. . . .Report
................................................................................. 32
www.issivs.com
SecurOS System Dashboard 4 User Guide
Preface
1 Preface
This section contains general information about this document, the means of its design and use, as well
as how to get additional technical support for the product.
1.1 Scope
This guide gives a general overview of the SecurOS System Dashboard application, describes the
process of installing and configuring the SecurOS System Dashboard's application server, talks about
the operator interface.
The guide is intended for the SecurOS system administrators and users who have basic skills in
working with web browsers and are familiar with the SecurOS user interface.
To get online help (Microsoft HTML Help) just press the F1 key when running SecurOS. In
administration mode You can get context help for a given object/utility by pressing the F1 key when its
settings window/utility window is open. In operator mode, use the F1 key to open a description of the
active window of the current operator interface or utility.
If you have any questions after reading this manual, please address them to your system administrator
or supervisor.
For any further information you can contact the Intelligent Security Systems Technical Support Team:
Note. For all technical support requests, please open a ticket from the ISS Partner Portal:
https://support.issivs.com. You will need to create an account if you don’t already have one.
www.issivs.com
SecurOS System Dashboard 5 User Guide
Preface
· in USA:
Phone: +1 732 855 1111
· in Canada:
Phone: +1 778 929 8565
· in Mexico:
Phone: +52 55 9001 5252
· in Colombia:
Phone: +57 320 303 2849
· in Brazil:
Phone: +55 85 9668 2530
· in Central America and Caribbean:
Phone: +502 5517 8395
· in Argentina/ Paraguay/ Uruguay:
Phone: +54 911 5039 6440
· in Peru/ Bolivia/ Chile:
Phone: +56 9 3261 9893
· in Ecuador:
Phone: +57 312 255 2932
· in Venezuela:
Phone: +57 321 722 0425
· in Europe:
Phone: +380 44 299 0810
· in Dubai:
Phone: +971 4 874 7100
· in Qatar:
Phone: +974 6 677 8309
· in Saudi Arabia:
Phone: +966 54 109 9699
To solve problems faster, we recommend preparing the service information described in the Technical
Support Information Section before addressing the Technical Support Team.
Font Description
www.issivs.com
SecurOS System Dashboard 6 User Guide
Preface
Font Description
bold italic type Used to mark out the elements of homogeneous lists.
Used to mark out macro text and programming code, file names and
monospace their paths. Also it is used to specify the necessary options, to mark
out values specified by the user from the keyboard (manually).
Additional Information
Used to display additional information. These type of elements contain, for example, the description of options for
executing a task or reference to additional literature.
www.issivs.com
SecurOS System Dashboard 7 User Guide
General Description
2 General Description
For Windows OS the functionality is available in the following editions: SecurOS Monitoring & Control Center,
SecurOS Datacenter, SecurOS Enterprise, SecurOS Premium, SecurOS Prof essional.
SecurOS System Dashboard Module is designed to control the performance of video cameras, monitor
the technical parameters of video transmission and collect the relevant statistics. The Module also
provides visualization of video cameras performance and generation of various reports.
Notes:
1. SecurOS System Dashboard version 11.3 or higher must be installed in the Remote system to collect
statistics of this Remote system cameras by the Monitoring center.
2. The statistics of the same camera in the Monitoring Center and the Remote system can be different,
because the SecurOS System Dashboard modules can have different technical specifications (camera
passport data) for this camera in the separate configurations.
3. If the time of Monitoring Center and Remote system is not synchronized and the difference is more
than one minute (time zone difference is ignored), the status information of the Remote system
cameras displayed in the Monitoring Center web application may not correspond to reality. However,
in this case, the collected statistics will be correct.
www.issivs.com
SecurOS System Dashboard 8 User Guide
Module Installation
3 Module Installation
The SecurOS System Dashboard must be installed on the computer with Video Server role, where the
Diagnostics Server object will be created.
1. Stop the Video Management System Server service with Server Control Agent utility
(see SecurOS Administration Guide). Its icon can be found in system tray.
Note. Video Management System Server service can also be stopped with Windows tools: Computer →
Manage → Services and Applications → Services.
2. Launch the product setup file. Select the setup language in opened dialog window and click OK.
3. Follow the instructions of the SecurOS System Dashboard Installation wizard.
4. Start the Video Management System Server service with Server Control Agent utility. Its icon
can be found in system tray.
Note. Video Management System Server service can also be started with Windows tools: Computer →
Manage → Services and Applications → Services.
www.issivs.com
SecurOS System Dashboard 9 User Guide
Module Configuration
4 Module Configuration
Warning! Open the TCP port 945 and the REST API, Database and Diagnostics Server object ports in the
firewall settings for proper module operation.
4.3 Database
The object is used to record and store statistical data (see SecurOS Administration Guide).
Note: If the Diagnostics Server is operating in the Cluster, it is recommended to provide database accessibility
for all Hosts in one of the following ways:
· Use database established on a dedicated server.
· Use database established on the iSCSI drive (see SecurOS Administration Guide). This is the most
reliable way.
www.issivs.com
SecurOS System Dashboard 10 User Guide
Module Configuration
Warning! The module requires PostgreSQL 12 DBMS. However, SecurOS supports older versions of
PostgreSQL. If a complete upgrade is undesirable, it is recommended to additionally install PostgreSQL 12
and configure the module's Database to work with this version.
· Host — DNS name or IP address of the server where DB will be created. If the DB should be
created on the local computer that is used to configure the system, use the default value;
· Port — port number to connect the DB. Default value is 5432;
· Database name — name of DB;
· User — user name;
· Password — user password;
5. Click the Create DB and User button;
6. Click the OK button to save changes.
Notes:
1. The data retention period is determined by the Erase records older than ... days parameter. If the
value of this parameter is 0, the data is retained indefinitely.
2. The time of deleting old DB records is determined by the start time of the Module and every 24
hours from that moment.
www.issivs.com
SecurOS System Dashboard 11 User Guide
Module Configuration
www.issivs.com
SecurOS System Dashboard 12 User Guide
Module Configuration
· Inherited rights — Diagnostics Server object rights are inherited from its parent object rights
(set by default when creating a new object).
www.issivs.com
SecurOS System Dashboard 13 User Guide
Module Operation
5 Module Operation
This section describes the operation of web application of the SecurOS System Dashboard Module:
· Starting Web Application;
· Main Tab;
· Reports Tab.
For example:
http://172.16.1.203:81
www.issivs.com
SecurOS System Dashboard 14 User Guide
Module Operation
3. Use credentials of the SecurOS or Active Directory user to authorize (see User Account).
Warning!
1. Authorization as SecurOS superuser (root) is not possible.
2. Login and Password fields are case sensitive.
3. The date format depends on the regional settings of the browser, but not on the language of the web
application. If English (United States) is the main browser language, the dates are
displayed in MM/DD/YYYY format. In all other cases, the dates are displayed in DD.MM.YYYY
format.
4. The 24-hour format is used to display the time. The time format does not depend on any settings.
www.issivs.com
SecurOS System Dashboard 15 User Guide
Module Operation
The Navigation bar is located in the upper area of the web application window (see Figure 4).
Note. The default language depends on the language setting of the browser.
www.issivs.com
SecurOS System Dashboard 16 User Guide
Module Operation
· — icon that indicates a number of Cameras with filled passports and ready for monitoring. If
there are none, it is hidden. Click the icon to open a notification (see Figure 5). Click the Go to
cameras button to automatically filter the Camera list by the Not activated passport status;
Camera status bar displays a total number of Cameras and number of Cameras with each status at the
moment (see Figure 6). The data is additionally presented as a pie chart. When clicking on the chart
sector or counter, the corresponding Camera status filter is applied to the Camera list (see Camera
Information). Clicking the Total cameras button will reset all applied filters and the search field. These
changes are also applied to the Camera list automatically.
Filters and search bars allow to filter Camera list by specified parameters and search the Cameras by
name (see Figure 7).
· Filters Bar;
· Search Bar.
www.issivs.com
SecurOS System Dashboard 17 User Guide
Module Operation
Filters Bar
The following filters are available on the filters bar:
· Camera status — to display all Cameras with selected status (see Camera status);
· IP address range — to display all Cameras with IP addresses within the entered range (see Camera
IP address). The address range can be specified in both IPv4 and IPv6 formats;
· Server IP address — to display all Cameras of the Video Server with specific IP address (see Server IP
address);
· Camera Passport Status — to display all Cameras depending on passport status (see Camera
Passport Status).
The following items are located on the right side of the filter bar:
· Apply button — press to apply all specified filters. Filters will be applied to the Camera list, taking
into account the search field;
· (Clear filters) button — press to clear all filter fields. These changes are applied to the Camera
list automatically.
Search Bar
Search bar allows to search Cameras by name (see Figure 7). Fill the search field and click the button.
The search will be performed in the Camera list, taking into account the specified filters.
Camera list is presented as a table (see Figure 8), that contains the Cameras and their parameters
(see Camera Information):
· Camera name;
· Camera status;
· Camera Passport Status;
· Camera IP address;
· Server IP address.
www.issivs.com
SecurOS System Dashboard 18 User Guide
Module Operation
Warning! The information is updated automatically only when logging in to the web application or refreshing
the browser page. When Cameras are changed in the SecurOS configuration or Cameras statuses are changed
while working with the web application, the information must be updated manually using the Refresh list
button or refreshing the browser page.
· Buttons to work with group of selected Cameras (including the ones hidden as a result of using
filters and searches):
– Create report — click to go to report creating for selected Cameras (see Creating Report). The
button is enabled if at least one Camera is selected in the list. Enabled button displays a number
of the Cameras for report creating;
– Fill camera passports — click to fill or edit passports of selected Cameras (see Filling and
editing the passport for cameras group). The button is enabled if at least one Camera is selected
in the list. Enabled button displays a number of the Cameras for passport editing;
– Monitoring Control On — click to start recording selected Camera operation statistics
(see Starting recording statistics for group of cameras). The button is enabled if at least one
Camera, that is ready for monitoring, is selected in the list. The button displays a number of
selected Cameras that are ready for monitoring control and total number of selected Cameras.
· Sort and navigation buttons:
– / (Ascending/Descending) — click to sort the list in ascending or descending order of
selected parameter value;
– / (Forward/Backward) — click to jump to the next or previous page of the Camera list. One
can jump to an arbitrary page by clicking on the page number.
www.issivs.com
SecurOS System Dashboard 19 User Guide
Module Operation
Parameter Description
Notes:
1. Parameters whose reference value is not specified in the Camera
passport (see Filling and Editing the Camera Passport) are
ignored when determining the status of that Camera.
2. Camera is indicated as faulty if at least one of the following
deviations is continuously detected for 5 minutes:
- FPS of the main stream is lower than specified in the
passport;
- Resolution of the main stream doesn't match the one
specified in the passport;
- Bitrate of the main stream is lower than specified in the
passport.
Camera Passport Status The Camera Passport status can be one of the following:
Camera IP address IP address specified in the Camera parent Video Capture Device
settings in the SecurOS Object Tree.
www.issivs.com
SecurOS System Dashboard 20 User Guide
Module Operation
Parameter Description
Server IP address IP address of the Camera parent Video Server specified in the
Computer settings in the SecurOS Object Tree.
Click the Camera in the Camera list on the Main page to open the Camera parameters window.
Viewing and editing the Camera information are available in the opened window (see Figure 9).
www.issivs.com
SecurOS System Dashboard 21 User Guide
Module Operation
· Shapshot — image from the Camera received in the moment of last update;
Warning! Snapshot is displayed if the Image Processor and REST API objects are configured in the SecurOS
(see Module Configuration).
· Create report button —allows to create a report of selected Camera operation (see Reports Tab);
· Camera information block — presents information about the Camera (see Camera Information);
· Camera passport block — presents specified values of Camera video stream properties, according to
which the operability is determined (see Filling and Editing the Camera Passport);
· Monitoring Control On/ Off — allows to start or stop Camera operability statistics recording
(see Monitoring Control On and Off). This button is displayed when Camera passport has
corresponding status (see Filling and Editing the Camera Passport).
Note. Passports of the same Camera created in the Monitoring Center and the Remote system are used
independently of each other — the Monitoring Center ignores the passport created on the Remote system side
and vice versa.
Warning!
1. Editing of the completed passport is available only for the administrator (see User Rights).
2. Editing of the completed passport will cause a loss of all recorded statistical data about the Camera
operation.
www.issivs.com
SecurOS System Dashboard 22 User Guide
Module Operation
4. The interface of web application will be blocked while changes are applying to the Cameras
passports. After the changes are applied, a summary of the updated Cameras passports will be
presented.
Notes:
1. Monitoring Center and Remote system collect statistical data separately from each other.
2. The operations on starting and stopping the recording of statistics are regulated by the User Rights.
www.issivs.com
SecurOS System Dashboard 23 User Guide
Module Operation
To start recording statistics for camera, open the Camera parameters window and click the
Monitoring Control On button (see Figure 12).
To stop recording statistics for camera, open the Camera parameters window and click the
Monitoring Control Off (see Figure 13).
Warning!
1. Turning monitoring control off will cause a loss of recorded statistical data about the Camera
operation.
2. Turning monitoring control off will cause an erasing of passport data (FPS, Resolution, Bitrate).
www.issivs.com
SecurOS System Dashboard 24 User Guide
Module Operation
Note. If there are no Cameras selected, by default the report will be generated for all Camera.
www.issivs.com
SecurOS System Dashboard 25 User Guide
Module Operation
3. In the Select interval drop-down list set the time interval required for report: last day, last week, last
month or last year. Select the Select interval option for more precise interval definition
(see Figure 16). The minimum time interval for report is 1 hour.
4. Click the Create report button to generate a report according to the specified parameters.
www.issivs.com
SecurOS System Dashboard 26 User Guide
Module Operation
www.issivs.com
SecurOS System Dashboard 27 User Guide
Module Operation
Scaling the graph numerically reduces the time interval of the entire graph to a time interval of an
arbitrary interval. Each such interval is represented as separate graph column (see Figure 19). Scaling is
applied to the graph when clicking on its column.
Notes:
1. The scaling applies only to the selected graph and does not affect the report data, including when
exporting (see Exporting Report).
2. If the time interval of the graph is less than 24 hours, the graph can not be scaled.
3. The function of graph scaling is not provided for the graph Time Spent by the Cameras in
"Performs properly" Status as a Percentage of the Required Time.
www.issivs.com
SecurOS System Dashboard 28 User Guide
Module Operation
Figure 19. Selecting a column in the graph "Time spent by the cameras in "Performs properly" status"
The result of scaling applied to the graph above (see Figure 19) is shown in Figure 20.
Figure 20. Scaled graph "Time spent by the cameras in "Performs properly" status"
The graph can be scaled several times — until the maximum level of scaling is reached, depending on
the value of the report time interval. If scaling to the next level is not possible, clicking on the column
will display the corresponding tooltip. To return the graph to the previous scale level, click the
button in the upper left corner of the graph area.
Notes:
1. Detailed statistics are presented taking into account the Graph Scaling.
2. Detailed statistics do not affect the report data, also when exporting (see Exporting Report).
3. The feature of Cameras statistics detailing is not provided for the graph Time Spent by the Cameras
in "Performs properly" Status as a Percentage of the Required Time.
www.issivs.com
SecurOS System Dashboard 29 User Guide
Module Operation
The corresponding data will be presented as a table in a separate window (see Figure 22).
To find specific Camera, type its name in the Search camera field. The list will be automatically filtered
to match the search field content. Click the button on the right to clear the field. Clicking on the
headers of the Camera name and Hours columns allows ordering the list items in ascending or
descending order of the corresponding values.
This table also allows visualizing the statistics for any Camera it contains in the form of a graph. Click on
the table row to open the graph of the corresponding Camera in a separate window (see Figure 23).
www.issivs.com
SecurOS System Dashboard 30 User Guide
Module Operation
5.3.2.2 Time Spent by the Cameras in "Performs properly" Status as a Percentage of the
Required Time
This graph presents the time spent by selected Cameras in Performs properly status as a percentage of
the required time (see figure 24). Similar to other graphs, the X-axis of this graph is divided into time
intervals, each of which corresponds to a separate column. The maximum value for each column is
100%, and the minimum value is 0%. The value for each of the columns represents the percentage ratio
of the factual operating time of the Cameras with the status of Performs properly to the required, and
only the data corresponding to the columns time intervals are considered.
The total percentage for the specified time interval is given in the upper right corner of the graph area.
Hover the cursor over the column to display the exact value (percentage).
Figure 24. Time spent by the cameras in "Performs properly" status as a percentage of the required time
Notes:
1. The graph data are not correlated with the data of Time Spent by the Cameras in "Performs
properly" Status graph, because they represent only the percentages, not the absolute values.
2. The Graph Scaling and Cameras Statistics Detailing features are not available for this graph.
www.issivs.com
SecurOS System Dashboard 31 User Guide
Module Operation
www.issivs.com
SecurOS System Dashboard 32 User Guide
Module Operation
Report can be saved in Microsoft Excel or HTML format. To export the report, do the following:
1. Click the Export report button (see Figure 27);
2. Turn the Additionally export reports for each camera toggle switch on to additionally create a
separate report for each selected Camera;
3. Select Excel or html format to export. The file (archive) will be downloaded in the directory
specified in the browser's settings.
www.issivs.com
SecurOS System Dashboard 33 User Guide
Technical Support Information
Note. Collected data have to be send to the Intelligent Security Systems Technical Support Team (see Getting
Technical Support).
Note. Equipment Dallas code can be found by the Hardware Report Utility (see SecurOS Administration
Guide for detailed information about utility).
· (*) name and version of the installed Intelligent Security Systems company software.
· total number of video servers and monitoring (operator) workstations in the system;
· operating system (name and service pack version).
9. Another useful information, if possible. For example:
· computer equipment configuration.
· central processors load.
· main and virtual memory used volumes.
· network load.
www.issivs.com
SecurOS System Dashboard 34 User Guide
Technical Support Information
www.issivs.com