Sentinel User Guide Helix 11.1
Sentinel User Guide Helix 11.1
1
Introduction
Confidentiality, Copyright Notice & Disclaimer
Due to a policy of continuous product development and refinement, TEOCO Corporation or a
TEOCO affiliate company (“TEOCO”) reserves the right to alter the specifications,
representation, descriptions and all other matters outlined in this publication without prior
notice. No part of this document, taken as a whole or separately, shall be deemed to be part
of any contract for a product or commitment of any kind. Furthermore, this document is
provided “As Is” and without any warranty.
This document is the property of TEOCO, which owns the sole and full rights including
copyright. TEOCO retains the sole property rights to all information contained in this
document, and without the written consent of TEOCO given by contract or otherwise in
writing, the document must not be copied, reprinted or reproduced in any manner or form, nor
transmitted in any form or by any means: electronic, mechanical, magnetic or otherwise,
either wholly or in part.
The information herein is designated highly confidential and is subject to all restrictions in any
law regarding such matters and the relevant confidentiality and non-disclosure clauses or
agreements issued with TEOCO prior to or after the disclosure. All the information in this
document is to be safeguarded and all steps must be taken to prevent it from being disclosed
to any person or entity other than the direct entity that received it directly from TEOCO.
TEOCO and Helix are trademarks of TEOCO.
All other company, brand or product names are trademarks or service marks of their
respective holders.
This is a legal notice and may not be removed or altered in any way.
COPYRIGHT © 2020 TEOCO Corporation or a TEOCO affiliate company.
All rights reserved.
Your feedback is important to us: The TEOCO Documentation team takes many measures
in order to ensure that our work is of the highest quality.
If you found errors or feel that information is missing, please send your Documentation-
related feedback to [email protected]
Thank you,
2
Introduction
Table of Contents
Introduction..................................................................................................................... 1
About Sentinel ............................................................................................................................ 1
Glossary ..................................................................................................................................... 2
The Sentinel GUI ............................................................................................................. 3
About the Sentinel GUI .............................................................................................................. 3
Using Helix Launcher ................................................................................................................. 5
Using the Options Cogwheel ..................................................................................................... 8
About Using the Cogwheel.................................................................................................... 8
Managing Your Time Zone and Language Settings ............................................................. 8
Changing Your Password ..................................................................................................... 9
Setting the Environment .............................................................................................. 11
About Setting the Environment ................................................................................................11
Managing Workspaces.............................................................................................................11
About Managing Workspaces ..................................................................................................11
Adding New Folders ............................................................................................................13
Adding New Workspaces ....................................................................................................15
Defining Home and Favorites Workspaces.........................................................................17
Adding New Report Links....................................................................................................19
Report Link Additional Parameters .....................................................................................20
Saving Workspaces ............................................................................................................21
Loading Predefined Workspaces ........................................................................................23
Editing Workspaces ............................................................................................................24
Deleting Folders/Workspaces .............................................................................................25
Setting the Time Criteria ..........................................................................................................26
Selecting the Instances ............................................................................................................28
Working with KPIs ....................................................................................................................32
About Working with KPIs .....................................................................................................32
Selecting PM KPIs ..............................................................................................................32
Defining FM KPIs ................................................................................................................34
Editing FM KPIs ..................................................................................................................36
Working with Widgets .................................................................................................. 38
About Working with Widgets ....................................................................................................38
Widget Types ...........................................................................................................................38
Working with Analytics Widgets ...............................................................................................46
About Working with Analytics Widgets ................................................................................46
Displaying MLRCA Graph Widgets .....................................................................................47
Displaying MLRCA Investigation Widgets ...........................................................................50
Using MLRCA Graph and Investigation Widgets ................................................................50
The MLRCA Graph Widget .................................................................................................52
The MLRCA Investigation Widget .......................................................................................55
Cluster KPIs ........................................................................................................................56
Deleting ML-RCA Graph and Investigation Widgets ...........................................................57
Working with Global Table Widgets .........................................................................................57
About Working with Global Table Widgets ..........................................................................57
Displaying Global Table Widgets ........................................................................................58
Using Global Table Widgets................................................................................................62
Drilling from Global Table Widgets .....................................................................................64
Deleting Global Table Widgets............................................................................................66
Working with PM Widgets ........................................................................................................66
About Working with PM Widgets .........................................................................................66
Displaying PM Bar Widgets.................................................................................................67
Displaying PM Line/Time Table Widgets ............................................................................72
iii
Sentinel User Guide
Displaying Configuration Changes Details Widgets ...........................................................82
About the Forecast Algorithms ............................................................................................83
Using PM Widgets ...............................................................................................................84
Drilling from PM Widgets.....................................................................................................87
Deleting PM Widgets ...........................................................................................................90
Working with FM Widgets ........................................................................................................90
About Working with FM Widgets .........................................................................................90
Displaying FM Bar/Pie/Table Widgets ................................................................................90
Displaying FM Alarms Table Widgets .................................................................................95
Using FM Widgets ...............................................................................................................98
Deleting FM Widgets .........................................................................................................101
Working with Map Widgets.....................................................................................................102
About Working with Map Widgets .....................................................................................102
Displaying Map Widgets....................................................................................................102
Displaying Performance Data on the Map ........................................................................105
Displaying Fault Data on the Map .....................................................................................107
Defining Coloring Rules ....................................................................................................108
Using Map Widgets ...........................................................................................................116
Searching for Map Objects................................................................................................118
Viewing Map Object Information .......................................................................................120
Drilling from Map Widget Objects .....................................................................................122
Deleting Map Widgets .......................................................................................................125
(Optional) Working with Custom SQL Widgets ......................................................................125
About working with Custom SQL Widgets ........................................................................125
Displaying Custom SQL Widgets ......................................................................................125
Using Custom SQL Widgets .............................................................................................132
Deleting Custom SQL Widgets .........................................................................................134
Working with Ticket Widgets ..................................................................................................134
About Working with Ticket Widgets ..................................................................................134
Displaying Ticket Bar/Pie/Table Widgets ..........................................................................135
Displaying Tickets Table Widgets .....................................................................................140
Using Ticket Widgets ........................................................................................................143
Deleting Ticket Widgets ....................................................................................................146
Working with Configuration Widgets ......................................................................................147
The Configuration Workspace...........................................................................................147
About Working with Configuration Widgets .......................................................................148
Drilling to Configuration Workspaces/Widgets ..................................................................150
Setting Configuration Widgets...........................................................................................151
Using Configuration Widgets.............................................................................................152
Deleting Configuration Widgets ........................................................................................154
Executing General Widget Activities ......................................................................................155
Saving Widget Information ................................................................................................155
Managing a Widget Table .................................................................................................157
Coupling and Decoupling Widgets .........................................................................................166
iv
Introduction
Introduction
About Sentinel
Sentinel serves as the Helix main and centralized User Experience tool for accessing all
modules, views, and user actions. As a next-generation user interface, Sentinel provides
NOC and SOC teams advanced visual analytical tools to investigate and drill-down into
potential problems by efficiently using and cross-correlating all the available data.
It uses performance, fault, and configuration information across multiple domains, service
models, networks and topologies. It efficiently visualizes the aggregated data, underlying
detailed data collected from the network as well as ML-driven insights produced automatically
by the various components of the Helix suite.
Built as an intuitive centralized process-driven interface, Sentinel makes it easy for various
types of service assurance information consumers to become more efficient, informed, and
collaborative and helps them deliver high quality of service and customer care. Service-
centered organizations can leverage the tool to monitor service status, underlying resources,
sites, and customers to ensure that the customers get their adequate service levels. Network-
centered organizations can take advantage of Sentinel capabilities to investigate and
troubleshoot network issues that affect services and customers.
Sentinel provides multiple working areas called “Workspaces”, in which users can create and
use a variety of rich components called “widgets”, to present PM, FM and CM data, collected
in the Helix system, in various charts, tables and graphs. Each Widget is highly configurable
to enable presenting the required data in the way the user needs, allowing flexibility and
efficiency in the user work.
1
Sentinel User Guide
Glossary
Term Description
Configuration A special Workspace that is used for displaying configuration information from
Workspace the Helix Base Configuration repository
CFG Table A configuration table for unmanaged entities, providing a list of Network
Elements and their relationships
Counter Set A group of counters that represent a specific logic, often referred to as
Measurement Object or Counter Group
DB Database
PM Performance Management
PM Metadata A set of tables in the PM configuration database that list the defined entities,
their respective configuration tables, their counter set, their keys, and so on
RC N2 record class
RD Raw data
Widget A visualization component that can be added into a Workspace and presents
PM, FM and CM data in various forms, such as charts, tables, maps and
graphs
Workspace A work layout/area that is utilized to present different widgets (such as charts,
maps, and tables) with different types of information.
2
The Sentinel GUI
Helix Launcher button—located on the top left of the window, displays icons of the
applications available to you and enables you to launch the required applications,
according to the purchased license and the permissions granted to you by the
administrator.
Time Criteria bar—located on the top of the window, displays the time and resolution
settings and enables you to change them.
Selected Instances button—located on the top of the window, displays the number of
selected instances in the current workplace and enables you to add/remove instances.
3
Sentinel User Guide
Selected KPIs button—located on the top of the window, displays the number of
selected PM KPIs in the current workplace and enables you to select PM KPIs and
manage the FM KPIs.
Add Widget button— located on the right of the window, enables you to create and
add the required widgets into a Workspace.
Save icon—located on the upper right of the window, enables you to Save/Save as
your workspace.
Widgets area—most of the main window area is used for displaying the widgets.
Cogwheel icon—located on the upper right of the window, enables you to run general
application operations.
4
The Sentinel GUI
1. In Helix Launcher, click on the top left to display the favorite application
icons.
2. To display all the available application icons, click More at the bottom of the favorite
applications area.
5
Sentinel User Guide
The other (not favorite) applications are displayed under the favorite applications area.
6
The Sentinel GUI
3. (Optional) If not defined as favorite, you can drag the application icon to the favorite
applications area for faster access in the future.
Note: If you do not see the application icon, use the scroll bar.
7
Sentinel User Guide
The cogwheel icon provides a menu with the following general options:
User Settings—the General tab, enables you to manage your time zone and
language settings. The Resources tab, enables you to download relevant applications
Change Password—enables you to change your password
Documentation—displays the Helix Documentation CD
Log—enables you to select the required application log level (All or Errors Only)
About—displays version and license information
Logout—logs out of all Helix applications
8
The Sentinel GUI
2. Click User Settings.
The User Settings window appears.
Note: The time zones list can be configured by the system administrator.
4. To disable/enable time zone checks when logging in, toggle Check my local Time
Zone settings when I login.
5. (Optional) Select the required User Language.
6. Click Save.
Note: The time zone and language settings will take affect only after you close and reopen all
your clients.
9
Sentinel User Guide
2. Click Change Password.
The Change Password window appears.
10
Setting the Environment
Managing Workspaces
11
Sentinel User Guide
The folder types are indicated by their icons as follows:
Expanded User Available only for the user that created the folder, the
level folder included workspaces are displayed
Collapsed User Available only for the user that created the folder, the
level folder included workspaces are not displayed
Expanded System Available for all the users, the included workspaces are
level folder displayed
Collapsed System Available for all the users, the included workspaces are not
level folder displayed
User level Available only for the user that created the workspace
workspace
When hovering over a workspace, it is highlighted and 3 icons appear on its left:
—enables you to set the workspace as your Home workspace. Every time a user
logs into the system, the “home” workspace is loaded.
12
Setting the Environment
When hovering over a workspace, it is highlighted and an icon appears on its left:
13
Sentinel User Guide
2. Click and in the menu that appears click Add New Folder.
The Add New Folder window appears.
Note: System administration roles can save at all levels, Power user roles can save
at Group and Private levels, and regular users can save only at Private level.
4. If you have selected the Group level, select the required group under Share
Workspace with group(s).
5. Select Add Folder to create the new folder.
14
Setting the Environment
15
Sentinel User Guide
Note: System administration roles can save at all levels, Power user roles can save
at Group and Private levels, and regular users can save only at Private level.
5. If you have selected the Group level, select the required group under Share
Workspace with group(s).
6. In the In Folder area, select where to store your workspace in the folders below.
Note: To create a new folder, type its name. The new folder will be created at
the workspace level.
16
Setting the Environment
2. Click on the right of the required workspace and confirm the operation.
The name of the workspace will appear in parentheses in the Home workspace field
and will be loaded on every login.
17
Sentinel User Guide
To set a Favorites Workspace:
The icon is colored , and appears in the My Favorites panel enabling an easier
access to required workspaces.
18
Setting the Environment
19
Sentinel User Guide
5. In the In Folder drop-down box, select where to store your report in the folders below
(should be available under any system folder).
6. Click Create New to create the new report link.
The new report is added under the selected In Folder with a on its left.
20
Setting the Environment
Saving Workspaces
The Workspace feature enables saving the display design details such as the map, charts,
criteria size, positions, and filtering. It is saved when you close the client and can also be
saved explicitly with a specific name to be loaded later. Named workspaces can be saved at
Private, Group, and System levels.
The Save option is available according to the user’s permissions. Therefore, a user without
permissions to modify a workspace will only be able to Save As the workspace. This enables
a regular user to save System workspaces as Private.
To save a workspace:
2. Click Save.
A message appears, displaying the save operation results.
21
Sentinel User Guide
2. Select Save As.
The Save As window appears.
Note: If the Workspace Name already exists, you will be prompted to select another
name.
22
Setting the Environment
2. (Optional) In the Search field at the top, type a partial string of the (or the entire)
required folder/workspace.
The matching workspaces are displayed.
3. (Optional) In the field on the right of the Search field at the top, select the required
workspace level (All, Private, Group, or System).
The matching workspace are displayed.
23
Sentinel User Guide
Editing Workspaces
To edit a workspace:
2. Select from the display, the workspace that you want to edit.
24
Setting the Environment
5. (Optional) In the In Folder field, select the folder in which to save the edited
workspace.
6. Click Save, to save the edited workspace.
Deleting Folders/Workspaces
To delete a folder/workspace:
25
Sentinel User Guide
1. Click .
The time criteria window appears.
2. In the Time Criteria field, select Relative.
The Relative time criteria display appears.
3. Change the Resolution (One Minute, Five Minutes, Quarter Hourly, Hourly, Daily,
Weekly, or Monthly).
4. Enter the required Periods number.
5. Select the required period Units (Minutes, Hours, Days, Weeks, or Months).
6. Click Apply.
The time criteria window disappears and the selected time range and resolution are
displayed at the top.
1. Click .
The time criteria window appears.
2. In the Time Criteria field, select Absolute.
The Absolute time criteria display appears.
26
Setting the Environment
8. To change the minute, make sure the minute is selected at the top and move the
clock's hand to the required minute.
27
Sentinel User Guide
9. Select AM/PM on the top right.
10. Click OK.
11. (Optional) Manually edit the From field.
Note: You can also manually change the date and time in the From and To fields.
To add instances:
1. Click .
The Instances window appears with Search Instances selected.
28
Setting the Environment
2. In the Select Instance Level area:
a. (Optional) In the Search field, type a partial string included in the required entity
and click enter.
The matching entities are highlighted and displayed below.
button.
29
Sentinel User Guide
To select dynamic instances:
1. Click .
The Instances window appears with Search Instances selected.
Note: It is not possible to save both dynamic and specific instances on the same entity.
30
Setting the Environment
1. Click .
The Instances window appears with Search Instances selected.
2. Click Selected Instances.
The selected instances are displayed.
9. Click .
The selected instances are removed from the instances list.
10. Repeat steps 4-9 to complete the instances deletion.
button.
31
Sentinel User Guide
Selecting PM KPIs
To add PM KPIs:
1. Click .
The KPIs window appears with Search Performance KPIs selected.
32
Setting the Environment
2. In the middle area (1):
a. (Optional) Select the required Entity.
b. (Optional) Type a partial string of the (or the entire) Counter Set Name.
c. (Optional) Type a partial string of the (or the entire) KPI Name.
d. (Optional) Select the required Category.
e. Click Search.
The matching PM KPIs are displayed in the right (2) area.
3. In the right (2) area:
a. To select all the KPIs, at any time, select the header line check box.
b. To clear all the KPIs, at any time, clear the header line check box.
c. To select a group of KPIs and remove the rest, use click and Shift+click.
d. To select/clear a single KPI, toggle its check box.
e. Repeat steps a-d to complete the KPIs selection.
4. Click Add Selected.
5. Repeat steps 2-4 as required to complete adding the required KPIs.
button.
To delete PM KPIs:
1. Click .
The KPIs window appears with Performance KPIs selected.
2. Click Selected Performance KPIs.
The selected Performance KPIs are displayed.
33
Sentinel User Guide
3. To select all the KPIs, at any time, select the header line check box.
4. To clear all the KPIs, at any time, clear the header line check box.
5. To select a group of KPIs and remove the rest, use click and Shift+click.
6. To select a group of KPIs and keep the rest, use click and Ctrl+Shift+click.
7. To select/clear a single KPIs, toggle its check box.
8. Click .
The selected KPIs are removed from the Performance KPIs list.
9. Repeat steps 4-10 to complete the KPIs deletion.
button.
Defining FM KPIs
FM KPIs can be defined and used under the following restrictions:
Private FM KPIs can be viewed/used/edited/deleted only by the user who created
them.
An administrator can change a Private KPI to System KPI. A System KPI cannot be
changed to user KPI.
When saving a Private workspace as a System/Group workspace:
o Widgets with Private KPIs will present NO data retrieved in the System/Group
workspace.
o Widgets with System KPIs created by a user will work correctly.
1. Click .
The KPIs window appears.
34
Setting the Environment
2. Click the Fault KPIs tab.
The available Fault KPIs are displayed.
3. (Optional) To search a KPI in the list, type a partial string of its (or the entire) name in
the Search by KPI name field.
4. To select a KPI, click its check box.
The KPI Details are displayed on the right.
5. (Optional) Edit the required KPIs.
6. To create a new KPI:
a. Click New Fault KPI.
A new empty KPI is added to the KPIs list.
b. Set the new KPI Details.
c. Click Save.
7. To create a new KPI based on an existing one:
a. Select the required source KPI in the left pane.
b. Click .
A new KPI is added to the list, with the name Copy of <source KPI name> and
with the source KPI Details.
c. Edit the new KPI Details.
8. To delete KPIs:
a. Select the required KPIs in the left pane.
b. Click .
35
Sentinel User Guide
c. Approve the operation in the confirmation window that appears.
Editing FM KPIs
To edit an FM KPI:
1. Click .
The KPIs window appears.
36
Setting the Environment
2. Click the Fault KPIs tab.
The available Fault KPIs are displayed.
37
Sentinel User Guide
Widget Types
The available PM widget types are:
Bar
Line
38
Working with Widgets
Time Table
39
Sentinel User Guide
Pie
Table
Alarms Table
40
Working with Widgets
The available Ticket widget types are:
Bar
Pie
Table
41
Sentinel User Guide
Tickets Table
Map widget:
42
Working with Widgets
MLRCA Investigation
43
Sentinel User Guide
The available Custom SQL widget types are:
Line
Table
44
Working with Widgets
The Configuration widgets can be displayed in separate workspaces.
Table
45
Sentinel User Guide
Tree
Note: The Sentinel MLRCA role is required to work with Analytics widgets.
46
Working with Widgets
2. Move the cursor to the Analytics option and from the sub menu that appears, select
MLRCA Graph.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
47
Sentinel User Guide
A new MLRCA Graph widget is displayed and the Widget Settings window appears
on the right.
48
Working with Widgets
The button in the widget changes to enabling you to open the report.
d. Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
e. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
49
Sentinel User Guide
The button changes to and the relevant Widget Settings window appears. To edit
the widget settings see Displaying MLRCA Graph Widgets from step 3 or Displaying
MLRCA Investigation Widgets from step 2.
50
Working with Widgets
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
51
Sentinel User Guide
9. To remove the widget, click and approve the operation in the confirmation
window that appears.
10. (In an MLRCA Graph widget) To drill to an MLRCA Investigation widget, click the
required cluster in the widget and in the menu that appears click Drill to Investigation.
An Investigation widget appears, coupled with the MLRCA Graph widget.
52
Working with Widgets
Summary Data
The summary data area at the top displays the following information:
Total Alarms—the total number of history alarms (all alarm instances) scanned by the
offline RCA algorithm.
Number of Clusters—the number of offline clusters created by the RCA algorithm.
Total Alarms in Cluster—the number of alarms scanned by the offline RCA algorithm
that have been assigned to an offline cluster.
Coverage %—the percentage of history alarms that are part of cluster.
Reduction %—the percentage of alarm reduction of in history.
Last Run—the date and time when the last offline algorithm run ended.
Range—the date range used by the offline RCA algorithm.
—<number of displayed clusters>/<total number of clusters>
Cluster Graph
The cluster graph is displayed on the left. Each bubble represent one offline cluster, with the
following information:
Bubble size—the value of the selected KPI (in the Bubble Size Represents field of
the Visual tab of the Widget Settings window). The default is Number of Alarms in
Cluster.
Number in the bubble—the Cluster ID (if the bubble is big enough.
Bubble color—the Average Cluster Repetitions KPI range as follows:
53
Sentinel User Guide
To display additional bubble information:
Hover over the bubble.
A tooltip appears, displaying the following cluster details:
o Cluster ID
o Parent Logic ID (for more than one parent Multiple is displayed)
o Parent Alarm Name (for more than one parent Multiple is displayed)
o A list of the selected cluster KPIs (as selected the KPIs tab of the Widget
Settings window).
Sliders Area
The sliders area, on the right, enables you to filter the display by setting the required ranges
of the selected KPIs. Highlighted values with a red underscore indicate that
the number is out of the KPI range.
3. To display only the clusters with the top 5 values for the KPI, click on its left.
The clusters display changes accordingly.
4. Repeat steps 1-3 to set the required filter.
54
Working with Widgets
Logic ID Unique alarm identifier, the variable part is project and vendor specific.
RCA Score The calculated root-cause score, as defined by the ML-RCA algorithm.
Alarmed Object The full entity path of the alarmed object (excluding the reporting
Name element).
From Site The site containing the alarmed object. This value is taken from the
configuration tables.
55
Sentinel User Guide
Area The geographical area of the origin of the alarm (lowest in the
hierarchy).
District The geographical district of the origin of the alarm (one level above the
lowest in the hierarchy).
Cluster KPIs
The available cluster KPIs are:
Average Cluster Duration (sec.) — the sum of the durations of all the history alarms
related to the cluster divided by the total number of alarms in history for the
cluster. Uncleared alarms are not included in the calculation.
Average Cluster Repetitions — the total number of alarms in history for the cluster
divided by the number of distinct Logic IDs.
Cluster Quality — the quality of the MLRCA cluster.
Max RCA score — the RCA score of the parent alarm.
Min RCA score — the minimum RCA score in the cluster.
Number of Alarm Names — the number of distinct alarm names in the cluster.
Number of Alarmed Object Names — the number of distinct alarmed object names in
the cluster.
Number of Alarms in Cluster — the number of distinct logic ids in the offline cluster.
Number of Alarms in History — the total number of alarm instances in the history
related to the cluster.
Number of Areas — the number of distinct areas in the cluster.
Number of Districts — the number of distinct districts in the cluster.
Number of Domains — the number of distinct domains in the cluster.
Number of Equipment Types — the number of distinct Eqp types in the cluster.
Number of Network Elements — the number of distinct Eqp names in the cluster.
Number of Parents — the number of distinct highest scores of the alarms in the offline
cluster.
Number of Sites — the number of distinct from sites in the cluster.
56
Working with Widgets
By default, the selected KPIs are:
Number of Alarms in Cluster
Average Cluster Repetitions
Average Cluster Duration (sec.)
Number of Network Elements
Number of Alarms in History
Number of Parents
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
57
Sentinel User Guide
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
58
Working with Widgets
A new Global Table widget is displayed and the Widget Settings window appears on
the right.
59
Sentinel User Guide
3. In the Instances pane of the Instances tab:
a. Select from the Source drop-down box the entity that the required counters and
KPIs belong to.
The relevant counters/KPIs become available for selection in the KPIs tab.
b. (Optional) Select from the Target drop-down box an entity, configuration field, or
Custom (to aggregate by Additional Keys) if you want to change the default value
which is the selected Source entity.
Note: The Custom option is relevant if Additional Keys are defined. In this case,
the widget displays the selected Additional Keys aggregation. If no Additional
Keys are selected, they are all taken into account.
The list of relevant instances for the selected Target is displayed below.
c. (Optional) In the Search field, type a partial string (or the entire name) of the
required instance.
The matching instances are displayed below.
d. Select the required instances/nodes.
e. (Optional) Select Show Selected.
Only the selected instances are displayed below (with their parents).
4. (Optional) In the Keys section of the Instances tab, If Ignore Additional Keys is off
(No), the relevant list of additional keys is displayed, enabling you to select the required
additional keys.
Note: To enable this option, only counters and KPIs from the same Counter Set and
with additional keys should be selected in the KPIs tab.
Note: This pane displays the available Performance KPIs and is based on the
Source entity selected in the Instances pane in step 3. If no entity was selected, this
pane will NOT display any KPIs.
60
Working with Widgets
6. In the Fault KPIs pane of the KPIs tab:
Note: Only aggregated KPIs can be selected in the Global Table. If no results are
returned for a specific KPI/Instance combination, the widget will display 0.
a. (Optional) In the Search field, type a partial string (or the entire name) of the
required KPI pane.
The matching KPIs are displayed below.
b. Select the required KPIs/nodes.
7. The Configuration Fields pane of the KPIs tab enables you to add configuration
columns.
By selecting the required fields, the selected configuration columns will be displayed in
the widget.
Note: When aggregating results in the Target to a configuration field or Custom, the
widget cannot include configuration fields nor fault KPIs.
8. In the Top/Bottom pane of the KPIs tab, select the required type (Top or Bottom), the
value and the KPI.
By selecting from the KPI drop-down box, the widget will display the top/bottom
instances based on the values of a selected KPI.
9. In the Visual tab:
a. (Optional) Edit the Widget Name.
b. (Optional) To enable opening a BOE report for a widget using the time range and
resolution from the workspace criteria, in the Report Link field, enter the path and
name and additional parameters (if required).
To override the workspace time criteria of the widget, deselect Use
Workspace/Widget date-time criteria and enter the required date-time in the
Report Link field.
c. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
10. Click Apply.
61
Sentinel User Guide
The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying Global Table Widgets from step 3.
62
Working with Widgets
2. To override the workspace date/time criteria and resolution:
b. Click .
The Time Criteria window is displayed.
d. To return to the workspace date/time criteria and resolution and remove the
button, click .
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
63
Sentinel User Guide
10. To remove the widget, click and approve the operation in the confirmation
window that appears.
11. You can manage the table display.
12. (Optional) Use the available Coupling and Decoupling Widgets option as required.
13. (Optional) Use the required Global Table drill options.
Notes:
The right-click menu enables you to drill form the Global Table widget.
64
Working with Widgets
3. To drill to schematic views, right-click the required element in the widget Drill to
Schematic Views and from the sub menu, select a view.
The Schematic Views client appears, with the alarms of the relevant view.
4. (Optional) Drill to a Configuration Workspace/widget.
5. To drill to another widget:
a. Right-click the required element in the widget for which you want to generate the
widget.
A menu appears, displaying the available drill options.
d. In the additional sub-menu that appears, move to the required (and available) drill
type.
Note: If Same Target is selected, the same Source, Target, and Keys from the
Master widget are set for the Details widget.
65
Sentinel User Guide
e. In the third sub-menu that appears, click the required drill entity/field. .
The new widget for the selected entity/field appears, coupled with the Global
Table widget.
Note: Drilling and coupling are also available between widgets with the same Target
configuration field.
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
66
Working with Widgets
To display a PM widget:
1. Click Add Widget on the upper right of the main window.
2. Move the cursor to the Performance option and from the sub menu that appears,
select Bar.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
67
Sentinel User Guide
The Bar widget is displayed and the Widget Settings window appears on the right.
68
Working with Widgets
3. In the Instances pane of the Instances tab:
a. Select from the Source drop-down box the entity that the required counters and
KPIs belong to.
The relevant counters/KPIs become available for selection in the KPIs tab.
b. (Optional) Select from the Target drop-down box an entity, configuration field, or
Custom (to aggregate by Additional Keys) if you want to change the default value
which is the selected Source entity.
Note: The Custom option is relevant if Additional Keys are defined. In this case,
the widget displays the selected Additional Keys aggregation. If no Additional
Keys are selected, they are all taken into account.
The list of relevant instances for the selected Target is displayed below.
c. (Optional) In the Search field, type a partial string (or the entire name) of the
required instance.
The matching instances are displayed below.
Note: If no instances are selected, all the instances in the Workspace are
considered as selected.
4. (Optional) In the Keys section of the Instances tab, If Ignore Additional Keys is off
(No), the relevant list of additional keys is displayed, enabling you to select the required
additional keys.
Note: To enable this option, only counters and KPIs from the same Counter Set and
with additional keys should be selected in the KPIs tab.
5. In the Target Filter pane of the Instances tab, set the required filter as follows:
Note: The filter affects the presented instances, only instances matching the filter
conditions will be presented, even if more instances were selected in the instance
selection.
69
Sentinel User Guide
6. In the KPI pane of the KPIs tab:
Note: This pane displays the available KPIs based on the selected instances and the
Entity selected in the Instances pane in step 3. If no entity was selected, this pane
will NOT display KPIs.
70
Working with Widgets
c. To display/hide the tooltips on the widget, toggle Show Tooltips.
d. To present a threshold line within the widget, select the Threshold title and enter
its value.
Note: the threshold value should be within the displayed values range of the bars.
e. (Optional) To enable opening a BOE report for a widget using the time range and
resolution from the workspace criteria, in the Report Link field, enter the path and
name and additional parameters (if required).
To override the workspace time criteria of the widget, deselect Use
Workspace/Widget date-time criteria and enter the required date-time in the
Report Link field.
f. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
9. Click Apply.
71
Sentinel User Guide
2. Move the cursor to the Performance option and from the sub menu that appears,
select the widget type (Line or Time Table).
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
72
Working with Widgets
The selected widget is displayed and the Widget Settings window appears on the
right.
73
Sentinel User Guide
Note: The Custom option is relevant if Additional Keys are defined. In this case,
the widget displays the selected Additional Keys aggregation. If no Additional
Keys are selected, they are all taken into account.
The list of relevant instances for the selected Target is displayed below.
Note: These panes display the available KPIs based on the selected selected Source
entity. If no entity was selected, they do NOT display any KPIs.
Note: By selecting both Left Y Axis and Right Y Axis, you can compare KPIs
with different ranges in the same chart, for example, total attempts vs. drop rate.
74
Working with Widgets
5. (Optional) The Trendline pane of the KPIs tab enables you to display the trend of
values in the Line widget. It will be displayed as a dotted line in the widget and the type
of the trend will appear in the legend, tooltip and includes the formula used.
75
Sentinel User Guide
Note: To use the forecasting functionality and receive accurate results, you must
have sufficient period of history data stored in the system.
7. (In a Time Table widget) In the Configuration Fields pane of the KPIs tab, you can
select configuration attributes to be added to the widget table.
8. (In a Time Table widget) In the OIs Fields pane of the KPIs tab, you can select string
value attributes to be added to the widget table.
Note: When aggregating results in the Target to a configuration field or Custom, the
widget cannot include configuration fields nor OI fields.
9. (Optional) In the Keys section of the Instances tab, If Ignore Additional Keys is off
(No), the relevant list of additional keys is displayed, enabling you to select the required
additional keys.
Note: To enable this option, only counters and KPIs from the same Counter Set and
with additional keys should be selected in the KPIs tab.
76
Working with Widgets
10. In the Target Filter pane of the Instances tab, set the required filter as follows:
Note: The filter affects the presented instances, only instances matching the filter
conditions will be presented, even if more instances were selected in the instance
selection.
77
Sentinel User Guide
d. (In a Line widget) To display/hide the axis titles on the widget, toggle Show Axis
Titles.
e. (In a Line widget) To display/hide the tooltips on the widget, toggle Show
Tooltips.
78
Working with Widgets
f. (In a Line widget) To display/hide the markers on the widget, toggle Show
Markers.
g. (In a Line widget) To display/hide the configuration changes on the widget, toggle
Show Configuration Changes.
For the Daily Resolution, the icons are displayed on the chart.
79
Sentinel User Guide
For other time resolutions, the icon is displayed on the legend beside the name
of the instance.
To drill to the configuration table, click on the icon and select Drill to/Update
Configuration Table.
You can use the icons to drill to drill to Configuration Table widgets.
Note: You can only drill to Configuration Changes, if the selected Target is an
entity.
h. (In a Line widget) To display/hide the active alarms colored by their severities on
the widget, toggle Show Active Alarms.
80
Working with Widgets
This enables you to drill to an FM Alarms Table widget filtered by a selected
instance, by clicking the relevant bell icon .
Note: You can only drill to Active Alarms if the selected Target is an entity.
k. (Optional) To enable opening a BOE report for a widget using the time range and
resolution from the workspace criteria, in the Report Link field, enter the path and
name and additional parameters (if required).
To override the workspace time criteria of the widget, deselect Use
Workspace/Widget date-time criteria and enter the required date-time in the
Report Link field.
l. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
12. In the Visual tab of Time Table widgets:
a. (Optional) Change the Widget Type to Line. The change is done after clicking
Apply.
b. (Optional) Edit the Widget Name.
c. (Optional) To enable opening a report for a widget, in the Report Link field, enter
the path and name and additional parameters (if required).
To override the workspace time criteria of the widget, deselect Use
Workspace/Widget date-time criteria and enter the required date-time in the
Report Link field.
d. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
13. Click Apply.
81
Sentinel User Guide
1. Click on the required icon in the PM Line widget and from the menu that appears
click Drill to/Update Configuration Table.
Note: The Show Configuration Changes option must be selected in the Visual tab of
the Widget Settings pane.
The Configuration Changes Details widget is displayed and the Widget Settings
window appears on the right.
82
Working with Widgets
If you choose the SARIMA algorithm, the historical data will be analyzed and the
appropriate (p, d, q, P, D, Q, S) parameters will be selected automatically to provide the
best prediction model.
Simple Linear Regression
a and b are computed from input data as follows:
83
Sentinel User Guide
Using PM Widgets
The function buttons, at the top left, enable you to perform relevant operations on the widget.
To use a PM widget:
1. The PM widget default settings are determined by its type, the selected instances and
The button changes to and the Widget Settings window appears. To edit the
widget settings see Displaying a PM Bar Widget or Displaying a PM Line/Time Table
Widget from step 3.
84
Working with Widgets
b. Click .
The Time Criteria window is displayed.
Note: To return to the workspace date/time criteria and resolution and remove the
button, click .
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
85
Sentinel User Guide
10. To remove the widget, click and approve the operation in the confirmation
window that appears.
11. (In a Bar/Line widget) To display fewer values in the widget, click the unrequired ones
on the legend. The selected values in the legend become brighter and are removed
from the display. This option is useful, for example, for focusing on specific
instances and/or KPIs.
12. (In a Time Table widget) You can manage the table display
13. (Optional) Use the available Coupling and Decoupling Widgets option as required.
Note: To set a PM widget as Details of a Map widget, you have first to select the
Entity and KPIs in the PM widget.
86
Working with Widgets
Notes:
87
Sentinel User Guide
b. Click the Drill to Widget.
c. In the sub-menu that appears, move to the required widget type.
d. In the additional sub-menu that appears, move to the required (and available) drill
type.
Note: If Same Target is selected, the same Source, Target, and Keys from the
Master widget are set for the Details widget.
e. In the third sub-menu that appears, click the required drill entity/field.
The new widget for the selected entity/field appears, coupled with the PM widget.
3. To drill to Cruiser, click the required element in the widget and in the menu that
appears click Drill to Cruiser.
The Cruiser client appears, with the alarms of the selected instance and the defined
time period.
4. To drill to schematic views, click the required element in the widget > Drill to
Schematic Views and from the sub menu, select a view.
The Schematic Views client appears, with the alarms of the relevant view.
5. (In a Line widget) To drill to an FM Alarms Table widget filtered by a selected
instance, make sure that Show Active Alarms is selected in the Visual tab of the
Widget Settings window and click the relevant bell icon .
The Alarms Table widget appears, coupled with the Line widget.
88
Working with Widgets
6. (Optional) Drill to a Configuration Workspace/widget.
7. (In a Line widget) To display the configuration changes of the widget:
a. Make sure the Show Configuration Changes is selected.
For the Daily Resolution, the icons are displayed on the chart.
For other time resolutions, the icon is displayed on the legend beside the name
of the instance.
b. To drill to the configuration table, click on the required icon and select Drill
to/Update Configuration Table.
A new/existing Configuration Changes Details widget appears, showing the
configuration changes filtered by the time resolution, coupled with the Line widget.
Note: Drilling and coupling are also available between widgets with the same Target
configuration field.
89
Sentinel User Guide
Deleting PM Widgets
To delete a PM widget:
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
90
Working with Widgets
2. Move the cursor to the Fault option and from the sub menu that appears, select the
widget type (Bar, Pie, or Table).
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
A new FM widget is displayed and the Widget Settings window appears on the right.
91
Sentinel User Guide
Note: In System workspaces, only System KPIs can be used and not user KPIs.
a. (Optional) In the Search field, type a partial string included in the required KPI.
The matching KPIs are displayed below.
b. Select the required KPI to display in the widget.
4. In the Categories pane of the KPIs tab:
a. (Optional) In the Search field, type a partial string included in the required
category.
The matching categories are displayed below.
b. Select the required category for the widget.
5. In the Top/Bottom pane of the KPIs tab select the type (top or bottom) and the count
value.
6. The Filter pane of the Instances tab enables you to filter the instances by alarm fields.
Set the required filter as follows:
92
Working with Widgets
f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
7. The Instances pane of the Instances tab displays the selected instances in this
workspace (by entity). To select the required instances for the widget:
a. Select the Entity for which you want to display the instances.
The matching instances are displayed below.
93
Sentinel User Guide
d. To display/hide the axis titles on the widget, toggle Show Axis Titles (in Bar
widgets).
e. To display/hide the tooltips on the widget, toggle Show Tooltips (in Bar and Pie
widgets).
94
Working with Widgets
f. To set a predefined report, enter an existing Report Link and additional
parameters (if required).
The button in the widget changes to enabling you to open the report.
g. Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
h. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
95
Sentinel User Guide
2. Move the cursor to the Fault option and from the sub menu that appears, select Alarms
Table.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
A new FM Alarms Table widget is displayed and the Widget Settings window appears
on the right.
96
Working with Widgets
3. The Instances tab enables you to filter the instances by alarm fields. Set the required
filter as follows:
The button in the widget changes to enabling you to open the report.
e. Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
f. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
97
Sentinel User Guide
Using FM Widgets
The function buttons, at the top left, enable you to perform relevant operations on the widget.
To use an FM widget:
The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying FM Widgets from step 3.
b. Click .
The Time Criteria window is displayed.
Note: To return to the workspace date/time criteria and resolution and remove the
button, click .
98
Working with Widgets
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
10. To remove the widget, click and approve the operation in the
confirmation window that appears.
11. (In a Table/Alarms Table widget) You can manage the table display.
99
Sentinel User Guide
12. (In a Bar/Pie widget) To display fewer values in the widget, click the unrequired ones
on the legend. The selected values in the legend become brighter and are removed
from the display. This option is useful, for example, for focusing on specific severities.
13. (In a Bar/Pie widget/Alarms Table) To drill to Cruiser, right-click the required element in
the widget and in the menu that appears, click Drill to Cruiser.
The Cruiser client appears with the alarms of the selected instance and the defined
time period.
14. (In an Alarms Table widget) To drill to Schematic Views, right-click the required
element in the widget, in the menu that appears move the cursor to Drill to Schematic
Views, and from the sub menu that appears, select the required view.
100
Working with Widgets
15. (In an Alarms Table widget) To view the attributes of a specific alarm, right-click it in
the widget, and in the menu that appears click Alarm Additional Information.
The widget displays the attributes of the selected alarm.
Note: To return to the original display, click Alarms List on the upper left.
16. (In an Alarms Table widget) You can drill to a Configuration Workspace/widget.
17. Use the available Coupling and Decoupling Widgets option as required.
Deleting FM Widgets
To delete an FM widget:
Click on the top right of the required widget and approve the operation in
the confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
101
Sentinel User Guide
Note: Layers, layer folders, and min/max zoom levels (for which each layer is visible on the
map) are configurable and can be changed by the administrator.
102
Working with Widgets
A Map Widget is displayed and the Widget Settings window appears on the right.
The button in the widget changes to enabling you to open the report.
Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
103
Sentinel User Guide
c. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
Note: Geographical layers (such as Country, State, City, and Site) cannot be
cleared.
c. Move the cursor to any required layer to display a tooltip with the zoom levels the
layer is displayed on.
d. (Optional) Set the required layer filters.
Note: Layers that are not displayed in the current zoom level are colored gray.
Note: This option is available only when opening a map widget by drill down from
another widget. In this case, by default, the selected instances from the opening
widget are marked. The selected instances list is displayed below, enabling you to
focus on selected one.
a. To color all the instances/only the instances selected in the widget from which you
have drilled-down, clear/select Display data on selected instances only.
104
Working with Widgets
The object is marked with a blue frame around it and two blue circles are displayed
on the selected instance for some seconds.
6. Use the KPIs tab to display the required Performance/Fault data on the map.
7. Click Apply.
105
Sentinel User Guide
To display Performance data on the map:
1. Make sure the Performance sub tab of the KPIs tab is displayed.
2. To activate this option, select , the icon on the right side of the
Note: The list of KPIs displays only KPIs selected in the workspace.
Note: KPIs with coloring rules have the icons on their right. KPIs without
coloring rules have the icon on their right.
6. Select/clear the KPIs with coloring rules you want to display/hide on the map objects.
Up to 5 KPIs can be selected per entity.
7. (Optional) Select Show Selected.
Only the selected KPIs are displayed below (with their parents).
8. Click Apply.
The map objects are colored on the view based on the selected KPI coloring rules.
The Performance KPIs are colored as follows:
o Cellular antennas—up to 5 KPI colors on the arcs representing them.
106
Working with Widgets
o Nodes—up to 5 KPI colors on a badge over the node.
107
Sentinel User Guide
5. Click Apply.
The map objects are colored on the view based on the coloring rules.
The Fault KPIs are colored as follows:
o Cellular antennas—a colored bell icon on the arcs.
108
Working with Widgets
Defining Performance Coloring Rules
1. In the Performance tab of the KPIs tab, click on the right of the required KPI.
A Coloring Rules window appears, with the selected KPI name, Counter Set name,
and entity name at the top.
5. (Optional) in the last (Other) row, change the color in the field.
6. (Optional) to define a rule (range of KPI values) that will have no color indication on the
109
Sentinel User Guide
8. (Optional) to save the current coloring rules for the KPI as your default (for the user),
click .
9. (Optional) to save the current coloring rules for the KPI as the default for all users
(system), click .
Note: The elements on the map are colored accordingly after clicking Apply in the
Widget Settings window. The rule is saved when saving the workspace.
Note: The object will be colored by the color of the first matching rule. If the first rule matches,
the object will be colored by the first rule color, if not, then if the second rule matches, the
object will be colored by the second rule color, and so on.
1. In the Performance tab of the KPIs tab, click on the right of the required KPI.
A Coloring Rules window appears, with the selected KPI name, Counter Set name,
and entity name at the top.
2. Edit the Performance coloring rule as descried in Defining Performance Coloring Rules
from step 2.
110
Working with Widgets
Defining Fault Coloring Rules
The default coloring rules for Fault alarms are based on the highest alarm severity:
Critical alarms - red
Major alarms - orange
Minor alarms - yellow
Warning alarms - blue
1. In the Fault tab of the KPIs tab, click on the right of the required layer.
The default Coloring Rules window appears.
3. To add a new condition group, click on the right of the level you want to add it to.
5. To add a new condition, click on the right of the level you want to add it to.
6. To edit a condition:
a. Select the KPI in the left field.
Two fields are added to the atomic condition.
b. Select the condition operator.
c. If required (based on the selected operator), select the condition value (or two
values for between).
111
Sentinel User Guide
10. (Optional) in the last (Other) row, change the color in the field.
11. (Optional) to define a rule (range of KPI values) that will have no color indication on the
12. To move a rule up/down in the rules list click / on the located on its upper left.
13. Repeat steps 2-12 to complete setting the map coloring rules.
14. (Optional) to save the current coloring rules for the layer as your default (for the user)
(system), click .
Note: The elements on the map are colored accordingly after clicking Apply in the
Widget Settings window. The rule is saved when saving the workspace.
Note: The objects will be colored by the color of the first matching rule. If the first rule
matches, the object will be colored by the first rule color, if not, then if the second rule
matches, the object will be colored by the second rule color, and so on.
112
Working with Widgets
Editing Fault Coloring Rules
1. In the Fault tab of the KPIs tab, click on the right of the required layer.
A Fault KPIs window appears, with the selected layer name at the top.
2. Edit the Fault coloring rule as descried in Defining Fault Coloring Rules from step 2.
1. In the Fault/Performance tab of the KPIs tab, click on the right of the required
KPI/layer.
2. Click Yes in the Reset confirmation message that appears.
The selected KPI/layer coloring rule definition is reset, and the widget will display the
default coloring rule if exists.
113
Sentinel User Guide
Setting Layer Filters
Note: The layer filter changes take effect on the map only after clicking Apply.
2. To add a filter:
a. Click .
An empty Filter for <selected layer name> window appears.
114
Working with Widgets
3. To see a filter settings, move the cursor to the filter's row.
A tooltip appears, displaying the filter settings.
4. To edit a filter:
a. Move the cursor to the filter's row.
115
Sentinel User Guide
The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying a Map Widget from step 3.
116
Working with Widgets
Note: The Map Widget KPIs are determined by the selected workspace KPIs. The
default layers are determined by the administrator. On drill-down, the default settings
depend on the opening widget.
b. Click .
The Time Criteria window is displayed.
Note: To return to the workspace date/time criteria and resolution and remove the
button, click .
Note: The report is defined in the Report Link field of the Visual tab of the Widget
117
Sentinel User Guide
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
Note: To set a PM widget as Details of a Map widget, you have first to select the
Entity and KPIs in the PM widget.
118
Working with Widgets
119
Sentinel User Guide
3. Select an object from the list displayed.
The map will zoom in and focus on the required location and two blue circles are
displayed on the selected instance for a few seconds.
If there are multiple objects on the clicked point, the window displays a list of the
objects and you can select any object from the list and see its details.
The KPI statuses are also displayed by the colored bell and lines on the table.
120
Working with Widgets
2. If there are multiple objects on the clicked point, you have to select the required object.
3. To view configuration information about the selected object, click the Config tab.
The main configuration attributes of the object are displayed.
4. To view fault information about the selected object, click the FM KPIs tab.
The relevant Fault KPIs with their values are displayed.
5. To view performance information about the selected object, click the PM KPIs tab.
The selected Performance KPIs with their values and colors are displayed.
6. (Optional) You can use the available map widget objects drill options.
121
Sentinel User Guide
2. If there are multiple objects on the clicked point, the window displays a list of the
objects. In this case, you have to select the required object.
122
Working with Widgets
4. To drill to Cruiser, in the menu that appears click Drill to Cruiser.
The Cruiser client appears, with the alarms of the selected instance and the defined
time period.
5. To drill to Schematic Views, in the menu that appears click Drill to Schematic Views
and from the sub menu, select a view.
The Schematic Views client appears, with the selected view displayed.
6. To drill to PM Line Chart, in the menu that appears click Drill to PM Line Chart.
The PM Line Chart appears, displaying a line for the selected instance and KPI
presenting each data point for the selected period based on the map widget criteria.
123
Sentinel User Guide
7. To drill to PM Table, in the menu that appears click Drill to PM Table.
The PM Table appears, displaying a table for the selected instance and KPI presenting
the data for the selected period based on the map widget criteria.
8. To drill to Alarms Table, in the menu that appears click Drill to Alarms Table.
The Alarms Table appears, displaying a table of alarms for the selected instance map
widget for the selected period based on the map widget criteria.
124
Working with Widgets
Click on the top right of the required widget and approve the operation in
the confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
Note: The Visual tab, Instances tab, and KPIs tab become available after the SQL tab is
filled.
Important: A Sentinel Custom SQL role is required to be able to create or edit a Custom
SQL widget.
125
Sentinel User Guide
To display a Custom SQL widget:
1. Click Add Widget on the upper right of the main window.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
126
Working with Widgets
A Custom SQL widget is displayed and the Widget Settings window appears on the
right.
127
Sentinel User Guide
a. If required, select the SQL type, Oracle or Hadoop, depending on the
environment specification.
b. Enter the SQL Statement.
Notes:
For the date/time criteria to be applied, the where clause of the SQL
statement should include %DATE. For the selected instances to be used in
the filter, the where clause of the SQL statement should include %FILTER.
For example, Where %DATE ... %FILTER ...
Configuration fields can be included in the SQL statement to be displayed in a
Table widget
128
Working with Widgets
9. In the Visual tab:
a. You can change the Widget Type (to Table or Line). The change is done after
clicking Apply.
b. (Optional) Edit the Widget Name.
c. (In a Line widget) To display/hide the legend on the widget, toggle Show Legend.
d. (In a Line widget) To display/hide the axis titles on the widget (if defined), toggle
Show Axis Titles.
e. (In a Line widget) To display/hide the tooltips on the widget, toggle Show
Tooltips.
129
Sentinel User Guide
f. (In a Line widget) To display/hide the markers on the widget, toggle Show
Markers.
130
Working with Widgets
h. (In a Line widget) To present a Left/Right Y Axis Threshold line within the
widget, type its name and threshold value.
i. (Optional) To enable opening a BOE report for a widget using the time range and
resolution from the workspace criteria, in the Report Link field, enter a path or
Report name if unique and additional parameters (if required).
To override the workspace time criteria of the widget, deselect Use
Workspace/Widget date-time criteria and enter the required date-time in the
Report Link field.
j. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
10. In the Left Y Axis KPI pane of the KPIs tab:
a. To collapse/expand a node, click / .
b. (Optional) In the Search field, type a partial string (or the entire name) of the
required KPI pane.
The matching KPIs are displayed below.
c. Select the required KPIs.
d. (Optional) Select Show Selected.
Only the selected KPIs are displayed below.
11. (In a Line widget) Repeat step 12 for the Right Y Axis KPI pane of the KPIs tab.
12. Click Apply.
131
Sentinel User Guide
The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying Custom SQL Widgets from step 3.
b. Click .
The Time Criteria window is displayed.
132
Working with Widgets
c. Set the Time Criteria (from step 2) as required.
Note: To return to the workspace date/time criteria and resolution and remove the
button, click .
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
10. To remove the widget, click and approve the operation in the confirmation
window that appears.
11. (In a Line widget) To view the details of a selected point on the graph, move the cursor
to this point.
133
Sentinel User Guide
A toolbar appears, displaying the relevant information.
12. (In a Line widget) To display fewer values in the widget, click the required ones on the
legend. The selected values in the legend become brighter and are removed from the
display.
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
134
Working with Widgets
2. Move the cursor to the Ticket option and from the sub menu that appears, select the
widget type (Bar, Pie, or Table).
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
135
Sentinel User Guide
A new Ticket widget is displayed and the Widget Settings window appears on the
right.
136
Working with Widgets
3. In the KPI pane of the KPIs tab:
a. (Optional) In the Search field, type a partial string included in the required KPI.
The matching KPIs are displayed below.
b. Select the required KPI to display in the widget.
Note: In a Table widget, you can select more than one KPI to display in the widget.
137
Sentinel User Guide
8. In the Visual tab:
a. You can change the Widget Type (to Bar, Pie, or Table). The change is done
after clicking Apply.
b. (Optional) Edit the Widget Name.
c. To display/hide the legend on the widget, toggle Show Legend (in Bar and Pie
widgets).
d. To display/hide the axis titles on the widget, toggle Show Axis Titles (in Bar
widgets).
138
Working with Widgets
e. To display/hide the tooltips on the widget, toggle Show Tooltips (in Bar and Pie
widgets).
The button in the widget changes to enabling you to open the report.
g. Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
h. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
139
Sentinel User Guide
2. Move the cursor to the Ticket option and from the sub menu that appears, select
Tickets Table.
Note: If a settings apply message for the previous widget appears, click Yes or No to
continue.
140
Working with Widgets
A new Tickets table widget is displayed and the Widget Settings window appears on
the right.
141
Sentinel User Guide
3. The Instances tab enables you to filter the instances by ticket fields. Set the required
filter as follows:
The button in the widget changes to enabling you to open the report.
e. Clear/select Use Workspace/Widget Date-time criteria to send the report the
date time as defined in the workspace/widget.
f. To enable drilling into another predefined workspace, select the Workspace
Name to drill to.
142
Working with Widgets
The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying Ticket Bar/Pie/Table Widgets / Displaying Table of
Tickets Widgets from step 3.
b. Click .
The Time Criteria window is displayed.
143
Sentinel User Guide
c. Set the Time Criteria (from step 2) as required.
Note: To return to the workspace date/time criteria and resolution and remove the
button, click .
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
10. To remove the widget, click and approve the operation in the confirmation
window that appears.
11. (In a Table/Tickets Table widget) You can manage the table display
144
Working with Widgets
12. (In a Bar/Pie widget) To display fewer values in the widget, click the unrequired ones
on the legend. The selected values in the legend become brighter and are removed
from the display. This option is useful, for example, for focusing on specific severities.
145
Sentinel User Guide
13. (In a Tickets Table widget) To view the details of a specific ticket, click its row and click
the Ticket Additional Information option that appears.
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
146
Working with Widgets
Configuration Workspaces can be opened from other widget types and form external
applications, such as SV and FM Cruiser.
The Configuration Workspaces looks and provide different options from the other (standard)
Workspaces:
The Recent Objects drop-down box provides access to all the Configuration Workspaces
that were opened during the current session.
Note: Configuration Workspaces can also be accessed from the {Ad Hoc
Workspaces} folder at the bottom of the left pane.
Configuration Workspaces do not include the standard options bar at the top. These
options are not relevant here.
147
Sentinel User Guide
Configuration widgets are not available from the Add Widget button on the upper right
of the display.
The Configuration Workspaces and the {Ad Hoc Workspaces} folder are created
dynamically. They are temporary and not kept in the system. Any changes done in the
Configuration Workspaces are not saved
148
Working with Widgets
Table widget—a tabular display, describing a set of configuration data related to the
object, such as Interfaces and Applications.
Tree Table widget—a tree table display, describing a hierarchical set of configuration
data related to the object, such as Cards and Services.
Note: The column in the Table and Tree widgets indicate absent instances.
149
Sentinel User Guide
a. To open the details in an existing Configuration workspace (if exists), click Drill to
Configuration workspace.
b. To open the details in a new workspace, click Drill to Configuration in new
workspace.
The Configuration Workspace appears, called [Conf] <Object Type> - <Object
Full Name>, displaying all the relevant widgets for the selected object based on its
type.
150
Working with Widgets
To drill to a specific Configuration widget:
1. Right-click the required object instance and from the menu that appears, move the
cursor to Drill to Configuration Details.
The lower part of the sub-menu that appears, displays all the widgets that are relevant
for the selected object based on its type.
The button changes to and the Widget Settings window appears, displaying
the Visual tab.
151
Sentinel User Guide
4. (In a standard Workspace) To enable drilling to another workspace, select the
workspace from the Workspace Name.
5. (In a Tabular/Tree widget) To set the Filter:
a. Select the Instances tab.
The button changes to and the Widget Settings window appears. To edit the
widget settings see Setting Configuration Widgets.
152
Working with Widgets
Note: The report is defined in the Report Link field of the Visual tab of the Widget
Note: The report is defined in the Workspace Name field of the Visual tab of the
Widget Settings window. If the button is Gray , the workspace is not defined.
7. To remove the widget, click and approve the operation in the confirmation
window that appears.
8. (In a Table/Tree widget ) You can manage the table display.
9. Widget fields that represent other Configuration objects are marked as URLs and
provide drill options.
153
Sentinel User Guide
To drill to a Configuration object:
a. Right-click the required URL field.
An appropriate menu appears.
b. To open the details in an existing Configuration Workspace (if exists), click Drill to
<current object type> Configuration Details.
Or
To open the details in a new workspace, click Drill to <current object type>
Configuration Details in new workspace.
The Configuration Workspace appears, called [Conf] <Object Type> - <Object Full
Name>, displaying all the relevant widgets for the selected object based on its
type.
Click on the top right of the required widget and approve the operation in the
confirmation window that appears.
Note: You can also click , click at the bottom right of the
Widget Settings window that appears, and click Yes in the confirmation message that
appears.
154
Working with Widgets
1. Click (Save as PNG) in the function buttons toolbar, at the top left.
A menu with the .file name (consists of the Widget Type, Widget Name, and a .png
extension) appears at the bottom left.
Note: if you have already selected Always Open files of this type, the .png file is
opened immediately and the menu is not displayed.
2. You can open the menu and select the following options:
Note: To cancel the Always Open files of this type activity, you can open the menu
at any time and clear this option.
155
Sentinel User Guide
Saving a Widget as a CSV File
1. Click (Save as CSV) in the function buttons toolbar, at the top left.
A menu with the file name (consists of the Widget Type, Widget Name, and a .csv
extension) appears at the bottom left.
Note: if you have already selected Always Open files of this type, the .csv file is
opened immediately and the menu is not displayed.
2. You can open the menu and select the following options:
Note: To cancel the Always Open files of this type activity, you can open the menu
at any time and clear this option.
156
Working with Widgets
2. Click the .
A menu appears.
The table is sorted accordingly and a appears on the right of the column header.
2. Click the .
A menu appears.
The table is sorted accordingly and a appears on the right of the column header.
157
Sentinel User Guide
2. Click the .
A menu appears.
158
Working with Widgets
7. (Optional) in the last (Other) row, you can only change the color in the field.
8. Repeat steps 5-7 to complete setting the coloring rules.
9. Click Apply.
2. Click the .
A menu appears.
159
Sentinel User Guide
4. Click the Edit Coloring Rules option.
The Coloring Rules window appears, with the selected coloring rules.
7. (Optional) in the last (Other) row, change the color in the field.
8. Repeat steps 5-7 to complete editing the coloring rules.
9. Click Apply.
160
Working with Widgets
(Optional) To hide coloring rules:
1. Move the cursor to the required table columns header.
2. Click the .
A menu appears.
161
Sentinel User Guide
To delete coloring rules:
1. Move the cursor to the required table columns header.
2. Click the .
A menu appears.
162
Working with Widgets
To select a table widget columns:
1. Move the cursor to one of the table columns header.
2. Click the .
A menu appears.
163
Sentinel User Guide
To filter a table widget:
1. Move the cursor to one of the table columns header.
2. Click the .
A menu appears.
164
Working with Widgets
To remove a filter from a table widget:
1. Move the cursor to one of the table columns header.
2. Click the .
A menu appears.
Note: The filter definition is not lost. You can reactivate it later by selecting the
Filters menu check box.
165
Sentinel User Guide
Two icons on the upper left of the widgets indicate their coupling status:
A gray icon indicates that the widget is not a Details widget (not coupled).
A colored icon indicates that the widget is not a Details widget (coupled).
A gray icon indicates that the widget is not a Master widget (not coupled).
A colored icon indicates that the widget is a Master widget (coupled).
Each Master widget has a different icon color, which is the same color of all its Details
widgets icons.
Note: If both icons of a widget are colored, they get the same color.
166
Working with Widgets
To couple widgets manually:
1. Click the icon (can also be colored) on the upper left of the widget to be defined
as Details.
A list appears, displaying all the relevant widget options and None.
If the selected widget is not already a Master widget, its icon is colored with a
color that is not used yet in this workspace, for example, or .
The icon of the Details widget gets the same color. If the icon of the
Details widget is colored with another color, it gets the Master color and its Details
widgets are changed accordingly.
Note: This operation might affect the colored and icons of all the related
widgets, in case of multiple levels of widgets coupling (widgets chaining).
Notes:
167
Sentinel User Guide
To couple widgets by drilling:
1. Right-click the instance for which you want to generate the Details widget.
A menu appears, displaying the available drill options.
4. (Optional) In the additional sub-menu that appears, move to the required drill type.
For example,
168
Working with Widgets
5. (Optional) In the third sub-menu that appears, click the required drill entity/field.
For example,
The selected widget appears, according to the menu selection, based on the source
widget Settings.
If the original widget is not a Master widget, its icon is colored with a color that is
not used yet in this workspace, for example, or .
Notes:
This operation might affect the colored and icons of all the related
widgets in case of multiple levels of widgets coupling (widgets chaining).
Some widgets, such as Configuration Changes and Configuration Details, cannot
exist on their own without being coupled to a Master widget.
169
Sentinel User Guide
To cancel all coupled widgets:
1. Click the colored icon on the upper left of the Master widget.
A confirmation message appears.
2. Click Yes.
The icon of the Master widget becomes gray . The icons of all its
Details widget becomes gray .
Note: This operation might affect the colored and icons of all the related
widgets in case of multiple levels of widgets coupling (widgets chaining).
170