100% found this document useful (2 votes)
249 views

Sentinel User Guide Helix 11.1

Uploaded by

Yasir Khan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
100% found this document useful (2 votes)
249 views

Sentinel User Guide Helix 11.1

Uploaded by

Yasir Khan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 174

Introduction

Sentinel User Guide


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,

The TEOCO Documentation team

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

Managed Element An element that provides PM data

Library The created Performance definitions, which includes a combination of both


Mediation and Performance Inspector definitions

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

RCA Root Cause Analysis

RD Raw data

Reported Element An element that has PM data reported for it

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

The Sentinel GUI

About the Sentinel GUI


The Sentinel main display includes the following main areas and entities:

 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.

 Workspaces management collapsible pane—located on the left of the window,


enables you to add, load, edit and delete workspaces.

 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

Using Helix Launcher


Within Helix Launcher, application links are displayed as icons. The icons and applications
available to you, differ depending on the purchased license as well as permissions granted to
you by the administrator.

To run a Helix application:

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.

Note: You can also use the mouse scroll wheel.

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.

4. Click the application icon.

Note: If you do not see the application icon, use the scroll bar.

7
Sentinel User Guide

Using the Options Cogwheel

About Using the Cogwheel

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

Managing Your Time Zone and Language Settings


To change your time zone and language settings:

1. Click at the top right of the Sentinel window.


The cogwheel menu appears.

8
The Sentinel GUI
2. Click User Settings.
The User Settings window appears.

3. In the General tab, select the required Time Zone.

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.

Changing Your Password


To change your password from Sentinel:

1. Click at the top right of the Sentinel window.


The cogwheel menu appears.

9
Sentinel User Guide
2. Click Change Password.
The Change Password window appears.

3. Enter your Current Password.


4. Enter your New Password.
5. Enter your New Password value in Confirm New Password.
6. Click Change Password.
A message appears upon successfully changing your password.

Otherwise, you will receive a relevant error message.

10
Setting the Environment

Setting the Environment

About Setting the Environment


Setting the environment includes the following activities:
 Managing Workspaces
 Setting the Time Criteria
 Selecting the Instances
 Working with KPIs

Managing Workspaces

About Managing Workspaces


A Workspace is the work layout/area that you can utilize to present different widgets (charts,
maps, tables) with different types of information (such as Performance Data, Fault
Management Data, and Configuration Information). It includes selected instances, selected
KPIs, date and time settings, and a set of customized widgets, each one with the specific
settings required to provide its expected information.
The workspaces are organized under folders and can be defined as a Home workspace and
saved as My Favorites.
The Workspaces window displays the existing folders and the workspaces under each folder.

11
Sentinel User Guide
The folder types are indicated by their icons as follows:

Icon Type Description

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 Group Available for users belonging to selected groups, the


level folder included workspaces are displayed

Collapsed Group Available for users belonging to selected groups, 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

The workspace types are indicated by their icons as follows:

Icon Type Description

User level Available only for the user that created the workspace
workspace

Group level Available for users belonging to selected groups


workspace

System level Available for all the users


workspace

When hovering over a workspace, it is highlighted and 3 icons appear on its left:

 —enables you to open and load the workspace.

 —enables you to set the workspace as your Home workspace. Every time a user
logs into the system, the “home” workspace is loaded.

 —enables you to delete the workspace.

 —copies the workspace link (URL) to the clipboard.

12
Setting the Environment
When hovering over a workspace, it is highlighted and an icon appears on its left:

 —enables you to delete the workspace.

You can collapse/expand the Workspaces window by clicking / .


The Workspaces window enables you to:
 Add new folders
 Add new Workspaces
 Define Home and Favorites Workspaces
 Add a report link
 Save Workspaces
 Load Predefined Workspaces
 Edit Workspaces
 Delete Folders/Workspaces

Adding New Folders


To add a new folder:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

13
Sentinel User Guide

2. Click and in the menu that appears click Add New Folder.
The Add New Folder window appears.

3. Type the required Folder Name.


In the Level field, select the workspace level. Folders can be saved at Private,
Group, and System levels.

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

Adding New Workspaces


To add a new workspace:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

15
Sentinel User Guide

2. Click to create a new workspace or folder.


The Add New Workspace window appears.

3. In the Workspace Name, write the name of your workspace.


4. In the Level field, select the workspace level. Folders can be saved at Private, Group,
and System levels.

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.

7. Click Create New to create the new workspace.

16
Setting the Environment

Defining Home and Favorites Workspaces


To define a Home Workspace:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

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:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

2. Click on the left of the required workspace.

The icon is colored , and appears in the My Favorites panel enabling an easier
access to required workspaces.

3. To remove a workspace from the My Favorites panel, click .


The workspace is removed from the panel.

4. To view the workspaces in the My Favorites panel, click / to expand/collapse


the panel.

18
Setting the Environment

Adding New Report Links


To add a new report link:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

19
Sentinel User Guide

2. Click to create a new report link.


The Add New Report Link window appears.

3. In the Link Name, write the name of your report link.


4. Enter the Report Path and Name (from the Performance Reporter) and additional
parameters (if required).

Note: Only links to existing reports can be created.

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.

Report Link Additional Parameters


Relevant parameters can be added after the Report Link/Report Path and Name,
with a & delimiter before each one.
For example, ES_Alarms&lsSEG=ALL&lsSMA=HBO&lsSMAAlias=HBO
In this case, ES_Alarms is the report name and the parameter values are:
 lsSEG=ALL
 lsSMA=HBO
 lsSMAAlias=HBO

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:

1. Click on the upper right.


The Save menu appears.

2. Click Save.
A message appears, displaying the save operation results.

To save a workspace with a different name:

1. Click on the upper right.


The Save menu appears.

21
Sentinel User Guide
2. Select Save As.
The Save As window appears.

3. Type the Workspace Name.


4. Select the Workspace Level (Private, Group, or System).
5. If you have selected the Group Workspace Level, select the required groups in the
table that appears.
6. Click Save and approve the operation in the message window that appears.

Note: If the Workspace Name already exists, you will be prompted to select another
name.

A message appears, displaying the save operation results.

22
Setting the Environment

Loading Predefined Workspaces


To use a predefined workspace:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded, displaying the available workspaces.

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.

4. Select the required workspace from the list and click .


Or

When hovering over a workspace, click .

Note: You can also double-click the required workspace.

The required workspace is displayed.

23
Sentinel User Guide

Editing Workspaces
To edit a workspace:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

2. Select from the display, the workspace that you want to edit.

3. Click to edit the workspace.


The Edit workspace window appears.

4. (Optional) In the Workspace Name field, rename the workspace.

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:

1. If the Workspaces panel is collapsed, click on its top to expand it.


The Workspaces panel is expanded.

2. Select the folder/workspace that you want to delete.

The icon is enabled, enabling you to delete a folder/workspace.


Or

When hovering over a folder/workspace, click .


3. Approve the operation in the message that appears.

Note: An open workspace cannot be deleted.

25
Sentinel User Guide

Setting the Time Criteria


To set a relative time criteria:

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.

To set an absolute time criteria:

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

3. In the From field, click .


The calendar display appears.

4. To move to the previous/next month, click / .

5. To move to the previous/next year, click / .


6. Select the required date.
7. To change the hour, make sure the hour is selected at the top and move the clock's
hand to the required hour.

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.

12. Repeat steps 3-11 for the To field.


13. Set the Resolution (One Minute, 5 Minutes, Quarter Hourly, Hourly, Daily, Weekly
or Monthly).
14. Click Apply.
The time criteria window disappears and the selected time range and resolution are
displayed at the top.

Note: You can also manually change the date and time in the From and To fields.

Selecting the Instances


You can select the required instances by adding groups of instances and then removing the
unrequired ones. You can repeat this procedure at any time to update the selected instances.

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.

b. Click / to select and mark the next/previous entity.


c. Click / to expand/collapse the required entity levels.
d. Select the required entity. .

3. In the Criteria area:

a. To add a condition to a group, click on its left.


b. To remove a condition, click on its left.
c. To edit a condition, select its field, condition type, and value (if required).
d. To add a condition group, click the relevant .

e. To change a group condition type, click its .


f. To remove a group condition, click on its left.
g. Repeat steps a-f to complete the filter definition.
h. Click Search.
The matching instances are displayed in the Add to Selected Instances area.
i. If required, repeat steps a-i until the instances in the Add to Selected Instances
area match your expectations.
4. In the Add to Selected Instances area:
a. To select all the instances, at any time, select the header line check box.
b. To clear all the instances, at any time, clear the header line check box.
c. To select a group of instances and remove the rest, use click and Shift+click.
d. To select a group of instances and keep the rest, use click and Ctrl+Shift+click.
e. To select/clear a single instance, toggle its check box.
f. Repeat steps a-d to complete the instances selection.
5. Click Add Selected.
The Instances window disappears and the instances number is updated in the

button.

29
Sentinel User Guide
To select dynamic instances:

1. Click .
The Instances window appears with Search Instances selected.

2. In the Select Instance Level area:


a. Click / to expand/collapse the required entity levels.
b. Select the required entity.
3. In the Criteria area:

a. To add a condition to a group, click on its left.


b. To remove a condition, click on its left.
c. To edit a condition, select its field, condition type, and value (if required).
d. To add a condition group, click the relevant .

e. To change a group condition type, click its .


f. To remove a group condition, click on its left.
g. Repeat steps a-f to complete the filter definition.
h. Click Save Criteria.
The matching instances are displayed in the Save Criteria area.
4. Click Add Criteria.
A message appears, indicating that the criteria was added successfully.

Note: It is not possible to save both dynamic and specific instances on the same entity.

30
Setting the Environment

To remove selected instances:

1. Click .
The Instances window appears with Search Instances selected.
2. Click Selected Instances.
The selected instances are displayed.

3. (Optional) Select the required Instance Level.


4. To select all the instances, at any time, select the header line check box.
5. To clear all the instances, at any time, clear the header line check box.
6. To select a group of instances and remove the rest, use click and Shift+click.
7. To select a group of instances and keep the rest, use click and Ctrl+click.
8. To select/clear a single instance, toggle its check box.

9. Click .
The selected instances are removed from the instances list.
10. Repeat steps 4-9 to complete the instances deletion.

11. Click to close the Instances window.


The Instances window disappears and the instances number is updated in the

button.

31
Sentinel User Guide

Working with KPIs

About Working with KPIs


The KPIs window enables the following activities:
 Selecting PM KPIs
 Defining FM KPIs

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.

6. Click to close the KPIs window.


The KPIs window disappears and the instances number is updated in the

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.

10. Click to close the KPIs window.


The KPIs window disappears and the instances KPIs is updated in the

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.

To define the FM KPIs:

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.

Note: Make sure you edit the Display Name.

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.

9. Click Save and close the KPIs window.


The KPIs window disappears and your changes are saved.

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.

3. Select the required KPI in the left pane.


4. Edit the Display Name.
5. Select the KPI Function.
The available options are:
o Count—the number of alarms
o Duration—the max alarm duration
o Avg/Max/Min/Sum—of a selected integer field
6. If you have selected Avg/Max/Min/Sum in the previous step, select the required field
for the function in the <selected KPI Function> Alarm Field field that appears.
7. Type the KPI Description.
8. Define the Filter as follows:

a. To add a condition to a group, click on its right.


b. To remove a condition, click on its right.
c. To edit a condition, select its field, condition type, and value (if required).
d. To add a condition group, click the relevant .

e. To change a condition group type. Click its .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
9. Click Save.

37
Sentinel User Guide

Working with Widgets

About Working with Widgets


Working with widgets includes the following activities:
 Working with Analytics Widgets
 Working with Global Table Widgets
 Working with PM Widgets
 Working with FM Widgets
 Working with Map Widgets
 Working with Custom SQL Widgets
 Working with Ticket Widgets
 Saving Widget Information

Widget Types
The available PM widget types are:
 Bar

 Line

38
Working with Widgets
 Time Table

Configuration Changes Details widget:

The available FM widget types are:


 Bar

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:

The available Analytics widget types are:


 MLRCA Graph

42
Working with Widgets
 MLRCA Investigation

Global Table widget:

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.

The available Configuration widget types are:


 Form

 Table

45
Sentinel User Guide
 Tree

Working with Analytics Widgets

About Working with Analytics Widgets

Note: The Sentinel MLRCA role is required to work with Analytics widgets.

Working with Analytics widgets includes the following activities:


 Displaying MLRCA Widgets
 Displaying MLRCA Investigation Widgets
 Using MLRCA Widgets
 Deleting MLRCA Widgets

46
Working with Widgets

Displaying MLRCA Graph Widgets


The MLRCA Graph widget is used to present offline clusters in graph visualization mode.

To display an MLRCA Graph widget:


1. Click Add Widget on the upper right of the display.

The Add Widget menu appears.

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

3. In 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 KPIs to be displayed in the widget.

Note: Up to 6 KPIs can be presented.

c. (Optional) Select Show Selected.


Only the selected KPIs are displayed below.
4. The Filter pane of the Instances tab enables you to filter the instances by several
alarm fields and RCA cluster KPIs.
5. Set the required filter as follows:

a. To add a condition, click the relevant .


b. To edit a condition, select its field, condition type, and value (if required).
c. To remove a condition, click on its right.
d. To add a condition group, click the relevant .

e. To change a condition group type, click .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
6. In the Visual tab:
a. (Optional) Edit the Widget Name.
b. In the Bubble Size Represents, you can replace the default measurement.
c. 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.
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.

The button in the widget changes to enabling you to drill to another


workspace.
7. (Optional) To enable drilling to another workspace, select the workspace from the
Workspace Name.
8. Click Apply.

49
Sentinel User Guide

Displaying MLRCA Investigation Widgets


Drilling to this widget is available from the ML-RCA Graph widgets where the user can
investigate the offline cluster. The widget is composed of two sections, the upper pane - Grid
of the Alarm and the lower pane - Graph.

To display an Investigation widget:


1. Click on the required Cluster ID on the Graph widget and from the menu that appears
click Drill to Investigation.
An Investigation widget is displayed and the Widget Settings window appears on the
right.
2. In the Visual tab in the Widget Settings pane:
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.
3. You can manage the table display.

Using MLRCA Graph and Investigation Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a ML-RCA Graph widget:

1. To display the widget settings, click .

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

2. To disable/enable Auto Refresh, click / .

3. To refresh once, click .

4. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

5. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

6. To drill to a predefined workspace, click .

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

7. To save the widget as an image, click .

8. To save the widget as a CSV file, click .


Two csv files are generated. One for the table and one for the graph.

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.

The MLRCA Graph Widget


The MLRCA Graph widget presents clusters in a graphic visualization with several cluster
KPIs on the same widget. You can adjust and tune the clusters display. Each KPI and data is
dynamically updated to present the clusters which are aligned to the defined KPIs. The
number of presented clusters is limited (by default to 1000). The Filter pane of the Instances
tab in the Widget Settings window enables you to reduce the matching clusters number
based on your preferences so that all of them are included.

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:

To display the bubble colors ranges:


Note: The Bubble color represents the Average Cluster Repetitions KPI range.
 Click at the bottom left.
The Legend window appears, displaying the bubble colors ranges.

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.

To set the KPIs ranges:


1. To change the minimal\maximal KPI value, you can:
o Drag the left/right border of the KPI as required.
o Edit the required border value.
The clusters display changes accordingly.
2. To use the actual KPI border, delete the required value and click Enter.
The clusters display changes accordingly.

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

The MLRCA Investigation Widget


The MLRCA Investigation widget displays additional information about one object in the
investigated cluster.

The Table Display


The upper part displays a table with the relevant alarm fields of this investigated cluster.
The displayed fields are:

Field name Description

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.

Eqp Name The specific equipment that generated the alarm.

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

Field name Description

Alarmed Object The type of the alarmed object entity.


Type

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).

You can manage the table display.

The Graph Display


The lower part displays a graph of the distribution of up to 50 Logic IDs during time.

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.

Note: You can select up to 6 KPIs.

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

Deleting ML-RCA Graph and Investigation Widgets


To delete a ML-RCA 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.

Working with Global Table Widgets

About Working with Global Table Widgets


Working with Global Table Widgets includes the following activities:
 Displaying Global Table Widgets
 Using Global Table Widgets
 Deleting Global Table Widgets

57
Sentinel User Guide

Displaying Global Table Widgets


To display a Global Table widget:
1. Click Add Widget on the upper right of the display.

The Add Widget menu appears.

2. Select the Global Table option.

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.

5. In the Performance KPI pane of 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.

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.

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

Using Global Table Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a Global Table widget:

1. To display the widget settings, click .

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:

a. Click (if required).

The button changes to , the button is added to its left.

b. Click .
The Time Criteria window is displayed.

c. Set the Time Criteria (from step 2) as required.

d. To return to the workspace date/time criteria and resolution and remove the

button, click .

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

7. To drill to a predefined workspace, click .

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

8. To save the widget as an image, click .

9. To save the widget as a CSV file, click .

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.

Drilling from Global Table Widgets

Notes:

 If the selected Target is not an entity, only Drill to Widget is available.


 If Ignore Additional Keys is not selected, only Same Target under Drill to Widget
(both PM line and Global Table) with the same parameters, including the Target and
exactly the same Additional Keys is available.

The right-click menu enables you to drill form the Global Table widget.

To drill from a Global Table widget:


1. 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.
2. To drill to a Map widget, right-click the required row in the widget and in the menu that
appears click Drill to Map.
A Map widget appears, coupled with 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.

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.

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.

Deleting Global Table Widgets


To delete a Global Table 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.

Working with PM Widgets

About Working with PM Widgets


Working with PM widgets includes the following activities:
 Displaying PM Bar Widgets
 Displaying PM Line/Time Table Widgets
 Using PM Widgets
 Deleting PM Widgets

66
Working with Widgets

Displaying PM Bar Widgets


The Performance widgets are only enabled after selecting the instances and KPIs KPIs for
the Workspace.

To display a PM widget:
1. Click Add Widget on the upper right of the main window.

The Add Widget menu appears.

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.

d. To collapse/expand a node, click / .


e. Select the required instances/nodes.

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:

a. To add a condition to a group, click on its right.


b. To remove a condition, click on its right.
c. To edit a condition, select its parameter, condition type, and OI/KPI/configuration
field (if required).
d. To add a condition group, click the relevant .

e. To change a condition group type, click its .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.

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.

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/nodes.
d. (Optional) Select Show Selected.
Only the selected KPIs are displayed below.
7. 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.
8. In the Visual tab:
a. (Optional) Edit the Widget Name.
b. To display/hide the legend on the widget, toggle Show Legend.

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

Displaying PM Line/Time Table Widgets


The Performance widgets are enabled only after selecting the required instances and KPIs.

To display a PM Line/Time Table widget:


1. Click the Add Widget on the upper right of the main window.

The Add Widget menu appears.

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

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 will 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. To collapse/expand a node, click / .


d. (Optional) In the Search field, type a partial string (or the entire name) of the
required instance and press enter.
The matching instances are displayed below.
e. Select the required instances/nodes.
f. (Optional) Select Show Selected.
Only the selected instances are displayed below (with their parents).
4. In the Left Y Axis KPIs and/or Right Y Axis KPIs panes of the KPIs tab:

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.

a. To collapse/expand a node, click / .


b. (Optional) In the Search field, type a partial string (or the entire name) of the KPI
name.
The matching KPIs are displayed below.
c. Select the required KPIs.
d. (Optional) Select Show Selected.
Only the selected KPIs are displayed (with their parents).

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.

To use this option:


a. Select Active.
b. Select the Type.
c. Select the KPI for Trendline.
6. (Optional) The Forecast pane of the KPIs tab enables you to display the expected
behavior in the future in the Line or Table widget.

75
Sentinel User Guide

To use this option:


a. Select Active.
b. Select the Algorithm Type.
c. If you have selected SARIMA in the previous step, select the Analysis Depth.
d. Select the KPI for Forecasting and the Forecasting Periods.

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.

a. To add a condition to a group, click on its right.


b. To remove a condition, click on its right.
c. To edit a condition, select its field, condition type, and value (if required).
d. To add a condition group, click the relevant .

e. To change a condition group type, click its .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
Only the selected instances are displayed below (with their parents).
11. In the Visual tab of Line widgets:
a. (Optional) Change the Widget Type to Time Table. 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.

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.

i. (Optional) Type the Left/Right Y Axis Title.


j. To present a Left/Right Axis Threshold line within the widget, type its title and
value.

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

Displaying Configuration Changes Details Widgets


Drilling to this widget is available from the PM Line widgets where you can see the
configuration changes filtered by the selected instance and time resolution. This widget shows
the configuration changes, filtered for the specific date & time and instance (for Daily
resolutions) or for the entire period (for other resolutions).

To display a Configuration Changes Details widget:

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.

2. In the Visual tab in the Widget Settings pane:


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, select 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 drop-down list.
3. You can manage the table display.

82
Working with Widgets

About the Forecast Algorithms


If you want to display forecast data for modules, you can choose from a number of methods.
In forecasting, the forecasted values of a series f(x) at a time x is considered to be dependent
on past values of f(x).
The different algorithms are as follows:
 SARIMA
Seasonal auto regressive integrated moving average of a time series:

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 KPIs. To display the widget settings, click .

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.

2. To override the workspace date/time criteria and resolution:

a. Click (if required).

The button changes to and the button is added to its left.

84
Working with Widgets

b. Click .
The Time Criteria window is displayed.

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 .

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

7. To drill to a predefined workspace, click .

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.

8. To save the widget as an image, click .

9. To save the widget as a CSV file, click .

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.

14. (Optional) Use the required PM drill options.

86
Working with Widgets

Drilling from PM Widgets

Notes:

 If the selected Target is not an entity, only Drill to Widget is available.


 If Ignore Additional Keys is not selected, only Same Target under Drill to Widget
(both PM line and Global Table) with the same parameters, including the Target
and exactly the same Additional Keys is available.

To drill from a PM widget:


1. To drill to a Map widget:
a. Right-click the required element in the widget.
A menu appears, displaying the available drill options.

b. Click Drill to Map.


c. A sub-menu that appears:

d. Select the option to Display selected object on Map coupled.


Or
Select the option to Display all objects on Map not coupled.
The select Map widget is displayed.
2. 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.

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.

Note: Drilling by configuration is not available from a widget that is aggregated by


a configuration field, unless it is for the same configuration field.

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.

Working with FM Widgets

About Working with FM Widgets


Working with FM widgets includes the following activities:
 Displaying FM Widgets
 Displaying FM Alarms Table Widgets
 Using FM Widgets
 Deleting FM Widgets

Displaying FM Bar/Pie/Table Widgets


To display an FM Bar/Pie/Table widget:
1. Click Add Widget on the upper right of the display.

The Add Widget menu 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

3. In the KPI pane of the KPIs tab:

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:

a. To add a condition, click the relevant .


b. To edit a condition, select its field, condition type, and value (if required).
c. To remove a condition, click on its right.
d. To add a condition group, click the relevant .

e. To change a condition group type, click .

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.

b. To collapse/expand a node, click / .


c. (Optional) In the Search field, type a partial string included in the required
instance.
The matching instances are displayed below.
d. Select the required KPIs/nodes.
e. (Optional) Select Show Selected.
Only the selected instances are displayed below (with their parents).
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. Edit the Widget Name.
c. To display/hide the legend on the widget, toggle Show Legend (in Bar and Pie
widgets).

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.

The button in the widget changes to enabling you to drill to another


workspace.
9. Click Apply.

Displaying FM Alarms Table Widgets


To display an FM Alarms Table widget:
1. Click Add Widget on the upper right of the display.

The Add Widget menu appears.

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:

a. To add a condition, click the relevant .


b. To edit a condition, select its field, condition type, and value (if required).
c. To remove a condition, click on its right.
d. To add a condition group, click the relevant .

e. To change a condition group type, click .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
4. In the Visual tab:
a. Edit the Widget Name.
b. (Optional) In the Additional Fields Search field, type a partial string (or the entire
name) of the required additional alarm fields and press enter.
The matching fields are displayed.
c. In the Additional Fields list, select the required alarm fields.
d. 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.
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.

The button in the widget changes to enabling you to drill to another


workspace.
5. Click Apply.

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:

1. To display the widget settings, click .

The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying FM Widgets from step 3.

2. To override the workspace date/time criteria and resolution:

a. Click (if required).

The button changes to and the button is added to its left.

b. Click .
The Time Criteria window is displayed.

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 .

98
Working with Widgets

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

7. To drill to a predefined workspace, click .

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.

8. (In a Bar/Pie/Table widget) To save the widget as an image, click .

9. (In a Bar/Pie/Table widget) To save the widget as a CSV file, click .

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.

The Schematic Views client appears, with the relevant display.

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

Working with Map Widgets

About Working with Map Widgets

Note: A GEO Maps license is required for using this option.

Working with Map widgets includes the following activities:


 Displaying Map Widgets
 Displaying Performance Data on the Map
 Displaying Fault Data on the Map
 Defining Coloring Rules
 Setting Layer Filters
 Using Map Widgets
 Searching for Map Objects
 Viewing Map Object Information
 Deleting Map Widgets

Displaying Map Widgets

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.

To display a Map widget:


1. Click the Add Widget on the upper right of the display.

2. In the Add Widget menu that appears click Map.

102
Working with Widgets

A Map Widget is displayed and the Widget Settings window appears on the right.

3. In the Visual tab:


a. (Optional) Edit the Widget Name.
b. 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.
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.

The button in the widget changes to enabling you to drill to another


workspace.
4. In the Map Layers tab of the Instances tab, set the required layers and elements as
follows:

a. To collapse/expand a node, click / .


b. Select/clear the required/unrequired layers/nodes.

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.

5. In the Selected Instances tab of the Instances tab:

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.

b. To spot a specific instance on the map, click on its right.

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.

Displaying Performance Data on the Map


The Performance sub tab of the KPIs tab enables you to color objects on the map according
to their Performance KPIs ranges to get a clear glance of their statuses.

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

Performance sub tab is colored red , indicating that the Performance


KPIs is active.

Note: The list of KPIs displays only KPIs selected in the workspace.

3. To collapse/expand a node, click / .


4. (Optional) In the Search field, type a partial string included in the required KPI.
The matching KPI are displayed below.
5. Define the Performance coloring rules for the required KPIs.

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.

9. To view information about a layer object, click the required object.

Displaying Fault Data on the Map


The Fault sub tab of the KPIs tab enables you to color objects on the map according to their
alarms to get a clear glance of their statuses.

To display Fault data on the map:


1. Make sure the Fault sub tab of the KPIs tab is displayed.

2. To activate this option, select .


3. Define the Fault coloring rules for the required layers.
4. Select/clear the layers you want to display/hide alarm indication on.

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.

o Nodes—a colored bell icon on a badge over the node.

6. To view information about a layer object, click the required object.

Defining Coloring Rules

About Defining Coloring Rules


The coloring rules enable you to color objects on the map according to their Performance and
Fault KPIs to get a clear glance of their statuses. Fault alarms have a default coloring rule
fixed by the administrator.
Defining coloring rules includes the following activities:
 Defining Performance Coloring Rules
 Editing Performance Coloring Rules
 Defining Fault Coloring Rules
 Editing Fault Coloring Rules
 Deleting Coloring Rules

108
Working with Widgets
Defining Performance Coloring Rules

To define a Map coloring rules for a Performance KPI:

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. To add a new coloring rule, click on the top right.


An empty coloring rule is added to the display.
3. To edit a coloring rule:

a. Select the color in the field.


b. Select the condition operator.
c. If required (based on the selected operator) select the condition value (or two
values for between).

4. To delete a coloring rule, click on its right.

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

map, select Do not show indication , in the field.


7. Repeat steps 2-6 to complete setting the map coloring rules.

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: This option is displayed only for the administrator.

10. Click Apply.

The changes to , and a is added on its right.

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.

Editing Performance Coloring Rules

To edit a Map coloring rules for a Performance KPI:

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

To define a Fault coloring rules for a Map layer:

1. In the Fault tab of the KPIs tab, click on the right of the required layer.
The default Coloring Rules window appears.

2. To add a new coloring rule, click on the top right.


An empty coloring rule is added to the display.

Note: You can select another color in the field.

3. To add a new condition group, click on the right of the level you want to add it to.

4. To change the type of a condition group, click / on its upper left.

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

7. To delete a coloring rule, click on its upper right.

8. To delete a condition, click on its right.

9. To delete a condition group, click on its upper right.

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

map, select Do not show indication , in the field.

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)

for the layer, click .


15. (Optional) to save the current coloring rules for the layer as the default for all users

(system), click .

Note: This option is displayed only for the administrator.

16. Click Apply.

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

To edit a Fault coloring rules for a Map layer:

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.

Resetting Coloring Rules

To reset a Map coloring rule:

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.

To set a layer filters:


1. Click / on the right of the required layer.
The Filters window appears.

2. To add a filter:

a. Click .
An empty Filter for <selected layer name> window appears.

b. Type the Filter Name.

c. To add a condition, click the relevant .


d. To edit a condition, select its field, condition type, and value (if required).
e. To remove a condition, click on its right.
f. To add a condition group, click the relevant .

g. To change a condition group type. click .

h. To remove a condition group, click on its right.


i. Repeat steps c-h to complete the filter definition.
j. Click Save. .
The new filter is added to the list of layer's filters.

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.

b. Click the that appears on the right.


The Filter for <selected layer name> window appears.

c. To add a condition, click the relevant .


d. To edit a condition, select its field, condition type, and value (if required).
e. To remove a condition, click on its right.
f. To add a condition group, click the relevant .

g. To change a condition group type. click .

h. To remove a condition group, click on its right.


i. Repeat steps c-h to complete the filter definition.
j. Click Save. .
5. To delete a filter:
a. Move the cursor to the filter's row.

115
Sentinel User Guide

b. Click the that appears on the right.


c. Click Yes in the Delete Filter confirmation window that appears.

6. To deactivate/activate the filters click / .


7. Select the filter you want to activate and click OK.

Using Map Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a Map widget:

1. To display the widget settings, click .

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.

2. To override the workspace date/time criteria and resolution:

a. Click (if required).

The button changes to and the button is added to its left.

b. Click .
The Time Criteria window is displayed.

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 .

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the map widget, click .


The map widget covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

117
Sentinel User Guide

7. To drill to a predefined workspace, click .

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.

8. To remove the widget, click and approve the operation in the


confirmation window that appears.

9. To zoom in, click / as required or use the mouse scroll wheel.

10. To search for objects on the map, click .


11. You can view Configuration, Fault, and Performance information about the map
objects.
12. 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.

13. You can drill to a Configuration Workspace/widget.

Searching for Map Objects


To search for objects on the map:

1. On the map, click .


The Search for Object on Map icon is expanded.
2. Type a partial string included in the object name.
The matching objects are displayed below.

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.

Viewing Map Object Information


To view map object information:
1. Click the required object.
An information window appears, displaying Config, FM KPIs, and PM KPIs information
about the selected object in 3 tabs.

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

Drilling from Map Widget Objects


To drill to other applications:
1. Click the required object.
An information window appears, displaying Config, FM KPIs, and PM KPIs information
about the selected object in 3 tabs.

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.

3. In the information window, click .


A menu appears, enabling you to select the following options.

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.

9. (Optional) Drill to a Configuration Workspace/widget.

124
Working with Widgets

Deleting Map Widgets


To delete a Map 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.

(Optional) Working with Custom SQL Widgets

About working with Custom SQL Widgets


Working with Custom SQL widgets includes the following activities:
 Displaying Custom SQL Widgets
 Using Custom SQL Widgets
 Deleting Custom SQL Widgets

Displaying Custom SQL Widgets

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.

The Add Widget menu appears.

2. Click Custom SQL.

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.

3. In the SQL Statement step (1) of the SQL tab:

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

c. Click Run SQL.


The SQL statement is validated. If the syntax is not correct, the following message
appears in the SQL Data Set pane: ‘Wrong SQL statement please check’. In this
case, you have to repeat step 3 to fix it.
When fixed, the SQL results are displayed in the SQL Data Set table, including the
column names and types.
4. If the %DATE is used in the where clause, in the Date & Time Filter Expression step
(2), type the Date & Time expression for the SQL query and click Apply Date & Time
Expression. Otherwise, this action is optional.
5. In the Hierarchy and List of Values step (3) of the SQL tab:
a. Enter the Number of Hierarchy Levels that matches the SQL Statement.
b. Click Apply Number of Hierarchy Levels.
c. Select the required Column Type for each Level in the table below.
d. Click Apply Hierarchy Levels.
6. In the List of Values (LOV) SQL step (4) of the SQL tab, enter the SQL statement for
the List of Values query and click Run LOV SQL.
7. If Hadoop was selected in step 3, in the Hadoop Specific Details (5) pane, use one of
the following options:
o Select No Hadoop Partition.
o Select Helix Hadoop Partition and select the corresponding details.
o Select Other Hadoop Partition and enter the partition syntax.
8. In the Instances pane of the Instances 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 instance.
The matching instances are displayed below.
c. Select the required instances/nodes.
d. (Optional) Select Show Selected.
Only the selected instances are displayed below (with their parents).

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.

g. (In a Line widget) To define a Left/Right Y Axis Title, type it.

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

Using Custom SQL Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a Custom SQL widget:

1. To display the widget settings, click .

The button changes to and the Widget Settings window appears. To change the
widget settings see Displaying Custom SQL Widgets from step 3.

2. To override the workspace date/time criteria and resolution:

a. Click (if required).

The button changes to , the button is added to its left.

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 .

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

7. To drill to a predefined workspace, click .

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.

8. To save the widget as an image, click .

9. To save the widget as a CSV file, click .

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.

Deleting Custom SQL Widgets


To delete a Custom SQL 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.

Working with Ticket Widgets

About Working with Ticket Widgets


Working with Ticket widgets includes the following activities:
 Displaying Ticket Bar/Pie/Table Widgets
 Displaying Tickets Table Widgets
 Using Ticket Widgets
 Deleting Ticket Widgets

134
Working with Widgets

Displaying Ticket Bar/Pie/Table Widgets


To display a Bar/Pie/Table widget:
1. Click Add Widget on the upper right of the display.

The Add Widget menu appears.

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.

4. Clear/select Time Resolution Affected to determine that the widget will be


categorized by time per the workspace/widget definition.
5. (Optional) 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.
6. In the Top/Bottom pane of the KPIs tab select the type (top or bottom) and the count
value.
7. The Instances tab enables you to filter the instances by ticket fields. Set the required
filter as follows:

a. To add a condition, click the relevant .


b. To edit a condition, select its field, condition type, and value (if required).
c. To remove a condition, click on its right.
d. To add a condition group, click the relevant .

e. To change a condition group type, click .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.

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).

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.

The button in the widget changes to enabling you to drill to another


workspace.
9. Click Apply.

139
Sentinel User Guide

Displaying Tickets Table Widgets


To display a Tickets Table widget:
1. Click Add Widget on the upper right of the display.

The Add Widget menu appears.

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:

a. To add a condition, click the relevant .


b. To edit a condition, select its field, condition type, and value (if required).
c. To remove a condition, click on its right.
d. To add a condition group, click the relevant .

e. To change a condition group type, click .


f. To remove a condition group, click on its right.
g. Repeat steps a-f to complete the filter definition.
4. In the Visual tab:
a. (Optional) Edit the Widget Name.
b. (Optional) In the Search field, type a partial string included in the required Fields.
The matching Fields are displayed below.
c. Select the Fields to be presented in the widget.
d. 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.
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.

The button in the widget changes to enabling you to drill to another


workspace.
5. Click Apply.

142
Working with Widgets

Using Ticket Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a Ticket widget:

1. To display the widget settings, click .

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.

2. To override the workspace date/time criteria and resolution:

a. Click (if required).

The button changes to and the button is added to its left.

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 .

3. To disable/enable Auto Refresh, click / .

4. To refresh once, click .

5. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

6. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

7. To drill to a predefined workspace, click .

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.

8. To save the widget as an image, click .

9. To save the widget as a CSV file, click .

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.

Note: To return, click Tickets List on the upper left.

Deleting Ticket Widgets


To delete a Ticket 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.

146
Working with Widgets

Working with Configuration Widgets

The Configuration Workspace


The Configuration Workspace is used for displaying configuration information for a specific
managed object. The information is displayed in widgets, based on the type of the object.
Each widget displays a specific set of configuration data related to the selected object (for
example, general details, interfaces, and services).

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

About Working with Configuration Widgets


The Configuration widgets display configuration data from the Base Configuration module.
Each Configuration widget displays a specific set of configuration data related to a selected
object (for example, general details, interfaces, or services).
The Configuration widgets are special widgets that look and behave differently from the other
widget types.
Configuration widgets are not available from the Add Widget button on the upper right of the
display.

The Configuration widgets can be opened:


 As part of Configuration Workspace
 As single widgets within standard Workspace, by drill down from a selected object in
another widget.
Configuration widgets are available from: Global Table widget, PM widgets, FM Alarm Table
widgets, Map widgets, and URL fields in Configuration widgets.
Fields in Configuration widgets that are marked as URLs, represent other Configuration
objects and enable drilling to their Configuration Workspace.
The available Configuration widget types are:
 Form widget—a form shaped display, describing the selected object details. The
available form widgets are Details and Additional Details.

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.

Working with Configuration widgets includes the following activities:


 Drilling to Configuration Workspaces/Widgets
 Setting Configuration Widgets
 Using Configuration Widgets
 Deleting Configuration Widgets

149
Sentinel User Guide

Drilling to Configuration Workspaces/Widgets


Configuration widgets are available from: Global Table widget, PM widgets, FM Alarm Table
widgets, Map widgets, and URL fields in Configuration widgets.

To drill to a Configuration Workspace:


1. Right-click the required object instance and from the menu that appears, move the
cursor to Drill to Configuration Details.
2. From the sub-menu that appears:

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.

2. From the sub-menu, click Drill to <widget name> Widget.


The new widget appears in the current workspace, coupled with the original widget.

Setting Configuration Widgets


To change a Configuration Widget settings:

1. Click on the top right of the required widget.

The button changes to and the Widget Settings window appears, displaying
the Visual tab.

2. (Optional) Edit the Widget Name.


3. (In a standard Workspace) 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.

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.

b. To add a condition, click the relevant .


c. To edit a condition, select its field, condition type, and value (if required).
d. To remove a condition, click on its right.
e. To add a condition group, click the relevant .

f. To change a condition group type, click .


g. To remove a condition group, click on its right.
h. Repeat steps a-g to complete the filter definition.
6. Click Apply.

Using Configuration Widgets


The function buttons, at the top left, enable you to perform relevant operations on the widget.

To use a Configuration widget:


1. The Configuration widget default settings are determined by its type. To display the

widget settings, click .

The button changes to and the Widget Settings window appears. To edit the
widget settings see Setting Configuration Widgets.

152
Working with Widgets

2. To enlarge the chart, click .


The chart covers the entire work area.

Note: To return to the original display, click .

3. To open a predefined report, click .

Note: The report is defined in the Report Link field of the Visual tab of the Widget

Settings window. If the button is Gray , the report is not defined.

4. To drill to a predefined workspace, click .

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.

5. To save the widget as an image, click .

6. To save the widget as a CSV file, click .

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.

Deleting Configuration Widgets


To delete a Configuration 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.

154
Working with Widgets

Executing General Widget Activities

Saving Widget Information

About Saving Widget Information


Widget information can be saved as:
 an Image
 a CSV File

Saving a Widget as an Image

To save a widget as an image:

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:

o Open—opens the .png file


o Always Open files of this type—causes future exported files to open
automatically after being generated.
o Show in folder—displays the folder in which the generated .png file is stored

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

To save 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:

o Open—opens the .csv file


o Always Open files of this type—causes future exported files to open
automatically after being generated.
o Show in folder—displays the folder in which the generated .csv file is stored

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

Managing a Widget Table


To sort the table in ascending order:
1. Move the cursor to the required table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Sort Ascending menu option.

The table is sorted accordingly and a appears on the right of the column header.

Note: You can also click the column header.

To sort the table in descending order:


1. Move the cursor to the required table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Sort descending menu option.

The table is sorted accordingly and a appears on the right of the column header.

Note: You can also click the column header twice.

157
Sentinel User Guide

(Optional) To display the table with coloring rules:


1. Move the cursor to the required table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Coloring Rules menu option.


A sub menu appears, displaying the following option.

4. Click the Add Coloring Rules option.


A Coloring Rules window appears, with the selected KPI name and Entity name at the
top.

158
Working with Widgets

5. To add a new coloring rule, click on the top right.


A new row appears above the last Other column with a new color selected.
To edit a coloring rule:

a. Select another color in the field. I indicates no color.


b. Select the condition operator.
c. If required (based on the selected operator) select the condition value (or two
values for between).

6. To delete a coloring rule, click on its right.

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.

To edit coloring rules:


1. Move the cursor to the required table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Coloring Rules menu option.


A sub menu appears, displaying the following options.

159
Sentinel User Guide
4. Click the Edit Coloring Rules option.
The Coloring Rules window appears, with the selected coloring rules.

5. To edit a coloring rule.

a. Select the color in the field.


b. Select the condition operator.
c. If required (based on the selected operator) select the condition value (or two
values for between).

6. To delete a coloring rule, click on its right.

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.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Coloring Rules menu option.


A sub menu appears, displaying the following options.

4. Click the Hide Coloring Rules option.


The colors are hidden, and in the sub menu, the Hide Coloring Rules option is
disabled.

161
Sentinel User Guide
To delete coloring rules:
1. Move the cursor to the required table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Coloring Rules menu option.


A sub menu appears, displaying the following options.

4. Click the Delete Coloring Rules option.


A warning message appears, confirming your required action.

5. Click Yes or No.


The coloring rules are removed from the widget.

162
Working with Widgets
To select a table widget columns:
1. Move the cursor to one of the table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Click the Columns menu option.


A sub menu appears, displaying the available columns.

4. Clear/select the columns as required.


The cleared columns are removed from the table widget.

To resize a table column:


 Move the cursor to the left border of the column and drag it as required.

163
Sentinel User Guide
To filter a table widget:
1. Move the cursor to one of the table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Select the Filters menu check box.


A sub menu appears, enabling you to define a filter that matches the column type.

4. Set the required filter condition.


Only the matching rows are displayed in the table widget, a check mark appears in the
Filters menu option , the column header changes to italics, and a appears on
the column left as follows: .
5. Repeat steps 1-4 as required to set all the required filters.

164
Working with Widgets
To remove a filter from a table widget:
1. Move the cursor to one of the table columns header.

A appears on the right of the column header.

2. Click the .
A menu appears.

3. Clear the Filters menu check box.


All the rows are displayed in the table widget, the column header returns to normal, and
the disappears.

Note: The filter definition is not lost. You can reactivate it later by selecting the
Filters menu check box.

165
Sentinel User Guide

Coupling and Decoupling Widgets


The option enables you to determine that the selected instance of one widget are used as the
input selection of one or more other widgets. The source widget is defined as a Master widget
and the other widgets are defined as Details widgets. This means that any change in the
Master widget selection will also change the displayed instances of its Details (coupled)
widgets.
Coupling widgets can be performed in the following ways:
 Manually on existing widgets.
 When drilling from an existing widget to another (new) widget.

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.

The available coupling options are:


 The Performance, Global Table, and Map widgets can be both Master and Details
widgets.
 Fault and Configuration Details widgets can only be Details widgets.
 MLRCA Investigation widgets can only be Details widgets of MLRCA Graph widgets.
 Configuration Changes widgets can only be Details widgets of Performance Line
widgets.
 All the other widget types cannot be neither Master nor Details widgets.

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.

2. Click the required widget option.

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:

 Coupling between PM Widgets is available if they have the same selection in


Source, Target, and Additional Keys (if any).
 Coupling between PM widgets with Additional Keys is available if:
 The selected Source of the Master widget and the Details widget are in the
same hierarchy
 The Master widget Ignore Additional Keys is on
 The selected Target of the Details widget is entity (lower/same/higher hierarchy)
or configuration field

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.

2. Click the required drill option from the menu.


3. (Optional) In the sub-menu that appears, move to/click the required widget type.
For example,

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 .

The icon of the Details widget gets the same color.

To remove a Details widget from coupling (Decouple):


1. Click the colored icon on the upper left of the Details widget.
A list appears, displaying all the relevant widget options and None.

2. Click the None option.

The icon of the Details widget becomes gray . Configuration Details


widgets are removed.

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

You might also like