Sunteți pe pagina 1din 159

hp Unified OSS Console

Unified OSS Console


V2.1

User Guide

Edition: 1.0

For the Linux (RHEL 6.5)

June 2015

Copyright 2015 Hewlett-Packard Development Company, L.P.

Legal Notices
Warranty
The information contained herein is subject to change without notice. The only
warranties for HP products and services are set forth in the express warranty
statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for
technical or editorial errors or omissions contained herein.
License Requirement and U.S. Government Legend
Confidential computer software. Valid license from HP required for possession, use
or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial
Items are licensed to the U.S. Government under vendor's standard commercial
license.
Copyright Notices
Copyright 2015 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe, Acrobat and PostScript are trademarks of Adobe Systems Incorporated.
Java is a trademark of Oracle and/or its affiliates.
Microsoft, Internet Explorer, Windows, Windows Server, and Windows NT are
either registered trademarks or trademarks of Microsoft Corporation in the United
States and/or other countries.
Firefox is a registered trademark of the Mozilla Foundation.
Google Chrome is a trademark of Google Inc.
Oracle is a registered U.S. trademark of Oracle Corporation, Redwood City,
California.
UNIX is a registered trademark of The Open Group.
X/Open is a registered trademark, and the X device is a trademark of X/Open
Company Ltd. in the UK and other countries.
Red Hat is a registered trademark of the Red Hat Company.
Linux is a registered trademark of Linus Torvalds in the U.S. and other countries.
Apache CouchDB, CouchDB, and the project logo are trademarks of The Apache
Software Foundation
Node.js project. Joyent and Joyents logo are registered trademarks of Joyent, Inc

Contents
Preface ........................................................................................................ 11
Chapter 1...................................................................................................... 13
Unified OSS Console Features ......................................................................... 13
1.1
Overview ..................................................................................................................... 13
1.2
Key features ................................................................................................................ 25
1.3
Architecture ................................................................................................................. 26
1.1
Modern Web Technology Stack................................................................................... 28
1.1.1
Server Side ............................................................................................................. 28
1.1.2
Client Side .............................................................................................................. 29
1.1.3
Document Database .............................................................................................. 29
1.2
Authentication............................................................................................................. 30
1.3
Secure Socket Layer (SSL) ........................................................................................... 31
1.4
Role Based Access Control (RBAC) .............................................................................. 32
1.4.1
Roles ...................................................................................................................... 32
1.4.2
Permissions ........................................................................................................... 34
1.5
Plugins ......................................................................................................................... 37
1.6
Value Pack (or package) .............................................................................................. 39
1.6.1
Structure ................................................................................................................ 40
1.6.2
Value Pack Management ....................................................................................... 40
1.7
Unified OSS Console Add-ons ..................................................................................... 43
1.8
Graphical Concepts ..................................................................................................... 45
1.8.1
Overview ................................................................................................................ 45
1.8.2
Workspaces ........................................................................................................... 47
1.8.3
Views...................................................................................................................... 49
1.8.4
Layouts .................................................................................................................. 50
1.8.5
Widgets .................................................................................................................. 51
1.8.6
Themes .................................................................................................................. 83
1.8.7
Menu Bar ................................................................................................................ 85
1.8.8
Menu Item .............................................................................................................. 86
1.8.9
Modules ................................................................................................................. 89
1.9
Notification Messages ................................................................................................. 89
1.10 Launches ..................................................................................................................... 90
1.10.1
Launch Definition .................................................................................................. 90
1.10.2
Launch Categories ................................................................................................. 91
1.10.3
Launch Modes ........................................................................................................ 92
1.10.4
Launch Tags ........................................................................................................... 93
1.10.5
Launch Keywords .................................................................................................. 94
1.11 Export Report .............................................................................................................. 95
1.11.1
Report as a Service API .......................................................................................... 95
1.11.2
Export Report from the workspace ....................................................................... 96
1.12 Mobility ........................................................................................................................ 97
1.13 Localization / Internationalization ............................................................................. 97
1.14 Themes ........................................................................................................................ 99
1.15 User Preferences ......................................................................................................... 99
1.16 Add-ons Workflow .................................................................................................... 101
1.17 Data Objects States ................................................................................................... 102
1.17.1
Workspaces ......................................................................................................... 102

1.17.2
Views.................................................................................................................... 102
1.17.3
Launches .............................................................................................................. 103
1.18 Security Audit ............................................................................................................ 103
1.19 Logging...................................................................................................................... 104

Chapter 2.................................................................................................... 105


How to leverage Unified OSS Console ............................................................ 105
2.1
2.2
2.3

Install & use Value Packs ....................................................................................... 105


Reuse and enrich ....................................................................................................... 106
Reuse and extend ...................................................................................................... 107

Chapter 3.................................................................................................... 108


Getting Started ........................................................................................... 108
3.1
3.1.1
3.1.2
3.2
3.2.1
3.2.2
3.3
3.4
3.5
3.5.1
3.5.2
3.5.3
3.5.4
3.5.5
3.5.6
3.5.7
3.5.8
3.6
3.6.1
3.6.2
3.6.3
3.7
3.7.1
3.7.2
3.7.3
3.7.4
3.8
3.8.1
3.8.2
3.8.3
3.8.4
3.9
3.9.1
3.9.2
3.9.3
3.9.4
3.10

Pre-requisite ............................................................................................................. 108


Web Browser........................................................................................................ 108
Mobile Device ....................................................................................................... 108
Start UOC ................................................................................................................... 108
Force a specific locale .......................................................................................... 109
Open a workspace by default .............................................................................. 109
Sign In ........................................................................................................................ 110
Main Menu ................................................................................................................. 111
Workspace Management .......................................................................................... 112
Overview .............................................................................................................. 112
Manage workspaces ............................................................................................ 114
Create a new workspace...................................................................................... 115
Clone a new workspace ....................................................................................... 119
Edit an existing workspace .................................................................................. 119
Delete an existing workspace ............................................................................. 120
Export an existing workspace ............................................................................. 121
Workspace Operations ........................................................................................ 122
Widgets Management ............................................................................................... 125
Widget Toolbar .................................................................................................... 125
Widget Configuration .......................................................................................... 126
Analysis tools ...................................................................................................... 128
User Management ..................................................................................................... 135
Users list .............................................................................................................. 135
Delete an existing user ........................................................................................ 135
Edit an existing user ............................................................................................ 136
Create a new user ................................................................................................ 137
Role Management ..................................................................................................... 138
Roles list .............................................................................................................. 138
Delete an existing role ........................................................................................ 138
Edit an existing role ............................................................................................. 139
Create a new role ................................................................................................. 140
Launch Management ................................................................................................. 141
Launch list ........................................................................................................... 141
Delete an existing launch .................................................................................... 141
Edit an existing launch ........................................................................................ 142
Create a new launch ............................................................................................ 144
Category Management .............................................................................................. 145

3.10.1
Category list ........................................................................................................ 145
3.10.2
Delete an existing category................................................................................. 146
3.10.3
Edit an existing category ..................................................................................... 146
3.10.4
Create a new category ......................................................................................... 147
3.11 Launch Category Management ................................................................................. 148
3.11.1
Launch Category list ............................................................................................ 148
3.11.2
Delete an existing launch category ..................................................................... 148
3.11.3
Edit an existing launch category ......................................................................... 149
3.11.4
Create a new launch category ............................................................................. 150
3.12 Add-ons Management ............................................................................................... 151
3.12.1
Layouts ................................................................................................................ 151
3.12.2
Widgets ................................................................................................................ 152
3.12.3
Themes ................................................................................................................ 152
3.12.4
Menu Bars ............................................................................................................ 153
3.12.5
Menu Items .......................................................................................................... 153
3.12.6
Plugins ................................................................................................................. 154
3.12.7
Launch Keywords ................................................................................................ 154
3.12.8
Modules ............................................................................................................... 155
3.13 Packages Management ............................................................................................. 155
3.14 Profile Management ................................................................................................. 158
3.14.1
User information ................................................................................................. 158
3.14.2
User password ..................................................................................................... 158
3.14.1
Edit preferences .................................................................................................. 159

Figures
Figure 1 Example Several representation available ........................................................................ 15
Figure 2 Example Support of customized layout ............................................................................. 15
Figure 3 Example Analysis dashboard ............................................................................................. 15
Figure 4 Example Display of several metrics over the time based on a time range........................ 16
Figure 5 Example Customer Care dashboard based on QOE scores ................................................ 16
Figure 6 Example Unified Correlation Analyzed Topology maps ..................................................... 17
Figure 7 Example Topology Maps .................................................................................................... 17
Figure 8 Example Geographical maps representation ..................................................................... 18
Figure 9 Example Aggregated information and detailed metrics over the time ............................. 19
Figure 10 Example QOE Score summary and detailed metrics over the time ................................. 19
Figure 11 Example Top 10 QOE Score information and detailed metrics over the time ................. 20
Figure 12 Example Customer Care Dashboard ................................................................................ 20
Figure 13 Example Daily Alarm Report (Fault Analytics Statistics) ................................................. 21
Figure 14 Example Incident Monitoring Dashboards ....................................................................... 22
Figure 15 Example Variation Alarm Report (Fault Analytics Statistics) .......................................... 23
Figure 16 Example NFV Catalog (NFV Director) ............................................................................... 24
Figure 17 Example Capacity per Data Center (NFV Analytics) ......................................................... 24
Figure 18 HP Unified OSS Console Architecture .................................................................................. 27
Figure 19 HP Unified OSS Console Technologies ................................................................................ 28
Figure 20 UOC Authentication modes (SAML / Local) ......................................................................... 30
Figure 21 Support Secure Socket Layer (SSL) ..................................................................................... 31
Figure 22 RBAC - ANSI INCITS 359-2004 ............................................................................................. 32
Figure 23 Example of operator level 1 dashboard ............................................................................. 34
Figure 24 Plugin Overview................................................................................................................... 37
Figure 25 Multiple servers configuration for OSSA Plugin ................................................................. 38
Figure 26 Value pack structure ........................................................................................................... 40
Figure 27 Value Pack Management ..................................................................................................... 41
Figure 28 Objects and operations support in the unified package format ......................................... 42
Figure 29 Add-ons Client and Server directories ................................................................................ 44
Figure 30 Graphical Concepts - Example of Dashboard ..................................................................... 45
Figure 31 Graphical Concepts - Overview ........................................................................................... 46
Figure 32 Workspace Navigation Mode (dashboard vs. Navigation) ................................................... 48
Figure 33 Workspace Header and footer ............................................................................................. 49
Figure 34 Example of add-ons layouts gallery ................................................................................... 50
Figure 35 Example of custom add-ons layout (including static images and text) ............................. 51
Figure 36 Example of add-ons widgets gallery .................................................................................. 52
Figure 37 Widget lifecycle ................................................................................................................... 54
Figure 38 Chart enhancement Single chart instance ....................................................................... 54
Figure 39 Chart enhancement Multiple chart instances .................................................................. 55
Figure 39 Chart enhancement Multiple data selection .................................................................... 56
Figure 40 Example of x-Axis decoration on line chart widget ............................................................ 56
Figure 40 Example of y-Axis decoration on line chart widget ............................................................ 56
Figure 41 Example of chart selector (hp-knob-gauge) ...................................................................... 57
Figure 42 Example of navigation in information using widget selection ........................................... 58
Figure 43 Several chart widgets (pie, line, area, spline) .................................................................. 59
Figure 44 Example of Widget Tree Maps (single fact / multiple facts) ............................................... 60
Figure 45 - Example of aggregation table (Multiple queries) ............................................................... 61
Figure 46 - Example of aggregation table (Single queries) ................................................................... 61
Figure 47 - Example of aggregation table with several units (ratio, number, ms) ............................ 61
Figure 48 Aggregation Table Configuration Panel .............................................................................. 62
Figure 49 - Example of top table (Top 10 of Network QOE score by Cell Name) .................................. 62
Figure 50 Top Table Configuration Panel ........................................................................................... 63
Figure 51 - Example of www.hp.com web site integration ................................................................... 64
Figure 52 - Example of Unified Correlation Analysis integration .......................................................... 64
Figure 53 - Example of Topology map integration ................................................................................ 65
Figure 54 Data Exchange Inspector .................................................................................................... 65
Figure 55 Expanding QoE score with the Drill up and down widget ................................................... 66

Figure 56 Example of drill up and down widget waiting for result ..................................................... 67
Figure 57 Example of drill up and down widget integrated into an analysis dashboard ................... 67
Figure 58 Example of a widget Panel with icons/threshold configuration ........................................ 68
Figure 59 Example of dashboard with 3 widgets Panel (icons) .......................................................... 69
Figure 60 Example of dashboard with multiple individual widgets Panel (icons) .............................. 69
Figure 61 Visual Threshold style ......................................................................................................... 70
Figure 62 Example of threshold icons for hp panel ............................................................................ 70
Figure 63 Example of presentation icons for hp panel ....................................................................... 71
Figure 64 Example of summarized value for web Score (result is Warning) ...................................... 71
Figure 65 Example of expanded values for web Score ....................................................................... 71
Figure 66 Widget Panel configuration box .......................................................................................... 72
Figure 67 Widget Group ....................................................................................................................... 73
Figure 68 Example of widget group view (one time selector, multiple pie charts) ............................ 73
Figure 69 Widget Navigation ............................................................................................................... 74
Figure 70 Example of widget navigation (customer list) .................................................................... 74
Figure 71 Example of widget navigation (customer details) .............................................................. 74
Figure 72 Example of widget menu bar .............................................................................................. 75
Figure 73 Example of widget breacrumb ............................................................................................ 75
Figure 74 New Widget Form ................................................................................................................ 76
Figure 75 Example of widget menu bar .............................................................................................. 76
Figure 76 Example of widget table ..................................................................................................... 77
Figure 77 Widget table column visibility setting ................................................................................ 78
Figure 78 Widget Kob Gauge ............................................................................................................... 78
Figure 79 Widget Kob Gauge Configuraiton panel ........................................................................... 78
Figure 80 New Widget Launch Tree ..................................................................................................... 79
Figure 81 Example of launch tree to start favorite links like HP ........................................................ 79
Figure 82 Tree Launch widget configuration panel ............................................................................ 80
Figure 83 Widget Map Latitude / Longitude Map (with/without bubble chart option) .................... 81
Figure 84 Widget Map Colored Map (with/without bubble chart option) ........................................ 82
Figure 85 Theme HP (Default) .......................................................................................................... 83
Figure 86 Theme HP Slate ................................................................................................................ 83
Figure 87 Theme HP United .............................................................................................................. 83
Figure 88 Theme enhancement chart widgets support theming .................................................... 84
Figure 89 Menu Bar HP (Default) ...................................................................................................... 85
Figure 90 Menu Bar Demo Custom Sample Menu ............................................................................. 85
Figure 91 Example of launches in the main menu and in a widget toolbar ........................................ 90
Figure 92 Launch Modes ...................................................................................................................... 92
Figure 93 Launch Tags ........................................................................................................................ 93
Figure 94 Report a s a Service RESTAPI .............................................................................................. 95
Figure 95 Export Report from the workspace .................................................................................... 96
Figure 96 Example of responsive dashboards on mobile devices ...................................................... 97
Figure 97 Example of the user Administrator menu (change language) ........................................ 98
Figure 98 Example of the user Administrator menu (change theme) ............................................. 99
Figure 99 User Preferences (Theme slate, custom title, custom version, English) .........................100
Figure 100 User Preferences (Theme united, custom title, no version, French) ..............................100
Figure 101 Add-ons workflow ...........................................................................................................101
Figure 102 UOC - Install and use value packs ...................................................................................105
Figure 103 UOC Reuse and enrich...................................................................................................106
Figure 104 UOC Reuse and enrich...................................................................................................107
Figure 105 Sign in page with the local authentication mode ...........................................................110
Figure 106 Navigation Menu .............................................................................................................111
Figure 107 Workspace Information ..................................................................................................112
Figure 108 Workspace Management ................................................................................................112
Figure 109 Workspace Management Using the search edit box ....................................................113
Figure 110 Example of workspace - Total volume of data per Device Brand ..................................113
Figure 111 Workspace Management Manage workspaces ............................................................114
Figure 112 Workspace Management End workspace management .............................................114
Figure 113 Workspace Management Workspace management operations..................................114
Figure 114 Workspace Management New workspace (Tab General) ............................................115
Figure 115 Workspace Management New workspace (Tab Headers and footer views) ...............116

Figure 116 Workspace Management New workspace (Tab Views) ...............................................117


Figure 117 Workspace Management New workspace (Tab Parameters) ......................................118
Figure 118 Workspace Management Clone workspace .................................................................119
Figure 119 Workspace Management Edit workspace ....................................................................120
Figure 120 Workspace Management Delete workspace................................................................121
Figure 121 Workspace Management Export workspace ...............................................................121
Figure 122 Workspace Management Operations Menu .................................................................122
Figure 123 Workspace Management Operations Menu (Save) ......................................................123
Figure 124 Workspace Management Operations Menu (Save As) ..............................................123
Figure 125 Workspace Management Operations Menu (Reset) ....................................................124
Figure 126 Widget Management Widget Toolbar ..........................................................................125
Figure 127 Widget Toolbar - Export ..................................................................................................125
Figure 128 Example of chart widget configuration ..........................................................................126
Figure 129 Example of aggregation table widget configuration......................................................126
Figure 130 Example of top table widget configuration ....................................................................127
Figure 131 Widget Management - Analysis Tool ..............................................................................128
Figure 132 Analysis Tool enhancement (new data selection) ..........................................................129
Figure 133 Analysis Tool enhancement (browse /edit / delete data selection) ..............................129
Figure 134 Analysis Tool Data Selection ........................................................................................131
Figure 135 Analysis Tool Dimension Filter .....................................................................................132
Figure 136 Example of Top Table with Top Filter (Analysis Tool) ....................................................133
Figure 137 Analysis Tool Top Filter ................................................................................................133
Figure 138 Analysis Tool Advanced options ..................................................................................134
Figure 139 User Management (authentication local mode only) .....................................................135
Figure 140 User Management Delete an existing user ..................................................................135
Figure 141 User Management Edit an existing user ......................................................................136
Figure 142 User Management Create a new user ..........................................................................137
Figure 143 Role Management ...........................................................................................................138
Figure 144 Role Management Delete an existing role ...................................................................138
Figure 145 Role Management Edit an existing role .......................................................................139
Figure 146 Role Management Create a new role ...........................................................................140
Figure 147 Launch Management .......................................................................................................141
Figure 148 Launch Management Delete an existing launch ..........................................................141
Figure 149 Launch Management Edit an existing launch ..............................................................142
Figure 150 Launch Management Change icon ...............................................................................143
Figure 151 Launch Management Create a new launch ..................................................................144
Figure 152 Launch Management Default icon ..................................................................................145
Figure 153 Category Management ....................................................................................................145
Figure 154 Category Management Delete an existing category ...................................................146
Figure 155 Category Management Edit an existing category ........................................................146
Figure 156 Category Management Change icon ............................................................................147
Figure 157 Category Management Create a new category ............................................................147
Figure 158 Category Management Default icon ...............................................................................148
Figure 159 Launch Category Management .......................................................................................148
Figure 160 Launch Category Management Delete an existing launch category ...........................149
Figure 161 Launch Category Management Edit an existing launch category................................149
Figure 162 Launch Category Management Change icon ................................................................149
Figure 163 Launch Category Management Create a new launch category ...................................150
Figure 164 Launch Category Management Default icon ...................................................................150
Figure 165 Add-ons Management Browse layouts ........................................................................151
Figure 166 Add-ons Management Browse widgets .......................................................................152
Figure 167 Add-ons Management Browse themes ........................................................................152
Figure 168 Add-ons Management Browse menu bars ...................................................................153
Figure 169 Add-ons Management Browse menu items .................................................................153
Figure 170 Add-ons Management Browse plugins ........................................................................154
Figure 171 Add-ons Management Browse launch keywords ........................................................154
Figure 172 Add-ons Management Browse modules ......................................................................155
Figure 173 Package Management Browse packages.....................................................................155
Figure 174 Package Management Package definition ...................................................................156
Figure 175 Package Management Package user interface.............................................................157

Figure 176 Package Management Run a selected workspace from the package management ..157
Figure 177 Profile Management........................................................................................................158
Figure 178 Profile Management Manage account .........................................................................158
Figure 179 Profile Management Change password (local Authentication Mode only) .................159
Figure 180 Profile Management Edit preferences (local Authentication Mode only) ...................159

Tables
Table 1 - Software versions ................................................................................................................... 11
Table 2 RBAC Default Roles / Permissions ....................................................................................... 33
Table 3 RBAC List of user interface permissions .............................................................................. 36
Table 4 Add-ons - Skills needed by integrator to extend the UOC framework .................................. 43
Table 5 Default HP Widgets ................................................................................................................. 53
Table 6: HP Menu Items (Default) .......................................................................................................... 88
Table 7: Example of Addons Module in the HP Table widget ................................................................ 89
Table 8: Example of notification message ............................................................................................ 89
Table 9: Example of Global Launch keywords ....................................................................................... 94
Table 10: Example of Contextual Launch keywords ............................................................................. 95
Table 11: Example of Global Launch keywords ...................................................................................100
Table 12: Workspace States.................................................................................................................102
Table 13: View States ...........................................................................................................................102
Table 14: Launch States .......................................................................................................................103

10

Preface
This document describes the user guide for the HP Unified OSS Console product

Intended Audience
Here are some recommendations based on possible reader profiles:
Administrator
Operators
Value Pack Designer
Dashboards / Views Designer
Integrator and delivery teams

Software Versions
The term UNIX is used as a generic reference to the operating system, unless
otherwise specified.
The software versions referred to in this document are as follows:
Product Version

Supported Operating systems

Unified OSS Console V2.1.0

Red Hat Enterprise Linux Server release RHEL 6.5

Unified OSS Console V2.1.0


Add-on OSS Analytics V1.1

Red Hat Enterprise Linux Server release RHEL 6.5

Table 1 - Software versions

11

Typographical Conventions
Courier Font:

Source code and examples of file contents.

Commands that you enter on the screen.

Pathnames

Keyboard key names

Italic Text:

Filenames, programs and parameters.

The names of other documents referenced in this manual.

Bold Text:

To introduce new terms and to emphasize important words.

Associated Documents

HP Unified OSS Console V2.1.0 - Installation Guide

HP Unified OSS Console V2.1.0 Release Notes

Support
Please visit our HP Software Support Online Web site at
https://softwaresupport.hp.com/
For contact information, and details about HP Software products, services, and
support.
The Software support area of the Software Web site includes the following:

12

Downloadable documentation.

Troubleshooting information.

Patches and updates.

Problem reporting.

Training information.

Support program information.

Chapter 1
Unified OSS Console Features
Build a modern and mobile core product extensible and able to provide an Unified
Console value pack driven and extensible to address visualization, analysis and
operational views for multiple heterogeneous domains (Network Operations,
Customer Experience Assurance, Customer Care Dashboard, Fulfillment, NFV
Director, NFV Analytics, Fault Analytics Statistics, Unified OSS Console V1.x, etc
including customers server) and provide an unified visualization and analysis views
for multiple and heterogeneous sources of data on any devices
This version of the Unified OSS Console provides a new advanced architecture, web
oriented, through a mobile first approach. Main features are detailed below.

1.1 Overview
The HP Unified OSS Console (UOC) solution is a new generation of data visualization
software platform, specialized for Operation Support Systems (OSS). It is a generic
web framework that facilitates the integration of various OSS software systems,
and provides modern, responsive and dynamic web dashboards that are able to run
on any devices (tablet, phone, desktop) to represent synthetic, highly
summarized views.
It does not intend to replace existing legacy graphical user interfaces (GUIs) from
underlying systems. It aims more to present aggregated data or dimensions, like
high level statistics or metrics , coming from various sources, various data servers
within the same web client (or page), with rich real-time and interactive graphics.
The data is displayed in real-time in that it can be updated automatically in
matters of seconds or minutes, what makes it useful for Operation and Analysis
dashboards. A lot of features help the end user to analyze and navigate through
information and quickly focus on the right meaningful information and help the
decision makers.
The Unified OSS Console supports multiple security profiles and dynamically
customizes/adapts the graphical user interface and information displayed,
depending on the users roles.
The interface is also totally value pack driven, and includes analysis tools allowing
to browse these value packs, select some data and define some filters. It becomes
easy to navigate and display information coming from multiple sources on the
same dashboard.
The platform also provides report as a service. It is possible to call an URL to
generate and export a PDF Report.

13

The HP Unified OSS Console supports business critical service operations and
processes. Some typical use cases include:
A single page dashboard to represent the overall status of the network.
A consolidated operations portal for an entire OSS solution.
Executive dashboards.
Personalized and dynamic web dashboard, built through definition files, and
easily customizable with no need to develop additional content.
Statistics Reports
Users/viewers can be diverse:
Network operations teams with several profiles and right to access to
information
Service quality monitoring teams analyzing several value packs in multiple
dashboards
Executives
Customer care teams or help desk operators
Etc
Integrators are also able to extend the Unified OSS Console: they can add some new
components called add-ons.
Some add-ons are at the server side to connect the Unified OSS Console to external
data servers.
Other add-ons are at client side to extend graphical components (widgets, layouts,
themes, menus, module) and enhance the customer experience providing
consolidated views at end user level.
Examples of dashboard supported by the Unified OSS Console:

14

Figure 1 Example Several representation available

Figure 2 Example Support of customized layout

Figure 3 Example Analysis dashboard

15

Figure 4 Example Display of several metrics over the time based on a time
range

Figure 5 Example Customer Care dashboard based on QOE scores

Here are dashboards embedding maps representation (topology, geographical )

16

Figure 6 Example Unified Correlation Analyzed Topology maps

Figure 7 Example Topology Maps

17

Figure 8 Example Geographical maps representation

18

Here are OSS Analytics dashboards for the Mobile Broad Band QOE.

Figure 9 Example Aggregated information and detailed metrics over the time

Figure 10 Example QOE Score summary and detailed metrics over the time

19

Figure 11 Example Top 10 QOE Score information and detailed metrics over
the time

Figure 12 Example Customer Care Dashboard

20

Figure 13 Example Daily Alarm Report (Fault Analytics Statistics)

21

Figure 14 Example Incident Monitoring Dashboards

22

Figure 15 Example Variation Alarm Report (Fault Analytics Statistics)

23

Figure 16 Example NFV Catalog (NFV Director)

Figure 17 Example Capacity per Data Center (NFV Analytics)

24

1.2 Key features


Category
Capitalize on Unified OSS
Console platform
modernity

Define the Operational


environment by selecting
& integrating your OSS
applications

Theme & branding


alignment to companys
guidelines, users
preferences
Localization &
internationalization

Combine/enrich existing
dashboards & views,
create new ones, ease
usability & navigation

Supporting features

Portal Approach: Everything is personal. Multi data source / Multi views,


client/server Web UI architecture, multi-device capable with Mobile 1st
approach

Built with modern technologies (html5) client, support of IE (>10), Chrome


and Firefox), highly configurable and customizable. Responsive Web Design

Includes patented innovations

Common presentation layer sharing common services for visualization,


layouts, graphical elements, as well as security, roles, localization,
internationalization

Built with best practices for navigation, information drill down, up, actions

Value pack driven User Interface (intelligence is defined outside the product)

Same GUI Designer tool : Dashboard & Report

Scalable Server deployment (deployment small/medium/large)

Fast asynchronous Engine, scalable and performant

Support modern devices (tablet, smartphone)

Available out of the box User Interfaces for HP NFV Director, HP NFV
Analytics and HP Service Provisioner VPN order Management products

Wide range of integration tools supporting from loose coupling to tight


integration: iFrame, launches, generic plug-in to OSS analytics foundation,
plug-in development

Opened choice for integrating UOC southbound to OSS applications: can use
a UOC normalized, re-usable I/F or be entirely custom

Fully Bi-directional: CRUD forms & support as well as analytics

REST APIs available for native applications

SDK Fully extensive with Add-ons server or client side Plug anything,
display Everything

Possibility to combine (iFrames and Launches) with OSS console assurance


solutions (Out-of the box, preconfigured real time dashboards for service
and network monitoring with iFrames and launch

Flexible look & feel and theme rebranding to adapt to customers branding
(logo, wallpaper, title, links, themes, icons

3 themes available by defaults (based on Bootstrap): hp, Slate, Unity.

Very easy to integrate or build new themes (common web design


knowledge)

Modularity to ease localization and internationalization

Preferences can be set by platform or by users.

Graphical editor to speed up creation of new views & dashboards & reports

Numerous WYSIWYG libraries including a wide set of re-usable components


to optimize GUI enrichments without coding: widgets, layouts & forms,

25

charts, menus, themes

Graphical editor to speed up creation of new workspaces, new views, new


reports

Cross product navigation for analysis, troubleshooting

Ability to export a dashboard and/or a view as a pdf report or csv file

Integration I/F to integrate the CSPs identity provider through the SAML
V2.0 protocol: . Users are managed externally (LDAP, files ) and the UOC
solution supports Single Sign On (SSO) using the CSPs identity provider. A
local model light mode without SSO can be used in POCs

Optionally activate SLL with certificates from a trusted authority

Automatic audit/logging

https communications between client and server, server and database, and
server an OSS applications

Create, delete, modify users

Grant Role Based access control rights (ANSI INCITS 359-2004)

Configure permissions

Per User configurable Workspace to define who access which view and what
information

User preferences, set on a workspace basis

Users access capabilities of integrated products & customized enrichment

Admin GUI & Views to view and monitor

current configuration: Value packs, plugins, add-ons

Graphical extensions

Workspaces

Support users & roles lifecycle: Add/delete/modify users, roles &


permissions

Logging

Audit

Support Replication and archive for GUI Database

Performant server Start/stop (in seconds)

Flexible deployments: monolithic, distributed

Support external Load Balancer

Plan evolution and


extensions

Same GUI architecture used/re-used to support numerous application


integrations and users, whatever nature, role and/or organization

Extent & re-use

Value pack (definition) is the added value ($): develop 1 times, sell and
configure N times on demand

Core capabilities bundled into a Product with product support

Scale up by adding cores, servers etc

Integrate to SSO
authentication,
configure security and
certificates

Configure users, their


roles & permissions,
views and data they are
authorized to see.

Deploy, use &


administrate

1.3 Architecture

26

The new Unified OSS Console V2 has been completely rebuilt with a new
architecture to support modern web architecture. It provides a flexible and open
new user interface that support extensions (pluggable modules) to add features on
the web browser (client) or integrate new domain server (new one or existing
legacy server).
The new user interface is totally compliant with web standard (HTML5, CSS,
Bootstrap and JS), fully web responsive and run on multiple device and multiple
display size. Themes based on Bootstrap allows a strong customization.

es

= Unified OSS Console Add-ons


Figure 18 HP Unified OSS Console Architecture

An add-on is an extension that can be dynamically installed on top of the Unified


OSS Console and extend existing features (new widgets, new layout, new menus,
new data sources)

27

1.1 Modern Web Technology Stack


The new Unified OSS Console has been totally rebuilt on top of modern web
technologies. Client-side and server-side components are both based on a
Javascript technology stack.
Integrators or developpers who want to extend the Unified OSS Console Framework
will require to know these technologies.

Figure 19 HP Unified OSS Console Technologies

1.1.1

28

Server Side

1.1.2

Client Side

1.1.3

Document Database

The GUI document database is a personal datbase dedicated to store grpahical definition useful for
UOC (workspaces, views, roles, permissions).

Important: This database never store, compute or return data value for
dashboard or views.

29

1.2 Authentication
The product supports two ways of authentication:
SAML (Security Assertion Markup Language): Unified OSS Console provides
an integration with identity providers through the SAML V2.0 protocol.
Users can be managed externally (LDAP, files ) and the product supports
the the Single Sign On (SSO) using this identity provider. It is the
recommended production mode for a large volume of users and it is also
recommended to grant a high level of security.
Note: The Open source project Picket Link (http://picketlink.org) is an
option as an identify provider and has been tested with our solution.
Local: It is a built-in authentication mode based on a local document
database in charge of managing the users and their associated roles. It is
mainly for demo purpose or very small deployments. This mode does not
support the SSO and does not provide a high level of security. It is not
recommended to use it in production.

Unified OSS Console


Passport

Local / Built-in

Builtin

SAML (SSO)

Document
database

Users (Local only)


Roles / Permissions
(UI)

SAML

Identity Provider Server

LDAP

Users
Roles

Picketlink
(Identity Provider)

JBOSS
Figure 20 UOC Authentication modes (SAML / Local)

To enforce the security, the connection to SAML Identity Provider and the SAML
token can be encrypted with certificates.
Please refer to the Installation and Configuration Guide to setup your platform
according to your security requirements.

30

1.3 Secure Socket Layer (SSL)


The Unified OSS Console supports SSL encryption at several communication
channels in order to grant a high level of security in production mode.
Certificates can be generated and configured in the platform configuration to
enable the SSL mode. These certificates can be self-signed but it strongly
recommended to use a trusted authorities to generate appropriate trusted
certificates.

All certificates need to be copied in the <install_data_dir>/server/public/ssl


Please refer to the Installation and Configuration Guide to setup correctly your platform.

The following HTTP communications can be encrypted with one or different


certificates.

Portl
et

Web Browsers /
Clients

SS
L

Identity Provider
(SSO / SAML)
Optional

SS
L

UOC
Server

SS
L

SS
L

GUI
database
(CouchDB)

Data Server
(OSS Analytics)

Figure 21 Support Secure Socket Layer (SSL)

Note: Certificates are stored in a certificates directory on the UOC Server. These
certificates can be self-signed (less secure) or trusted (recommended).
Please read chapter Security in the Installation and Configuration Guide to see how
to enable/disable SSL and install certificates.

31

1.4 Role Based Access Control (RBAC)


The product integrates a strong role based access control that drives the user
interface and the access to information. The definition is based on the standard
ANSI INCITS 359-2004.

Figure 22 RBAC - ANSI INCITS 359-2004

A role is job function or title which defines an authority level


A user will have one or several roles (ex: Operator Level 1)
A role has one or several permissions
A permission is an approval of a mode of access to a resource. It is defined by an
operation and an object or resource (ex: create user)
As soon as the end user has been authenticated, a list of his roles are checked, a list
of permissions are loaded and the graphical interface always apply these access
right for display and actions (ex: only a user administrator can have access to
administration page in charge of creating users in the platform, only an operator
level 3 can open a set of advanced analysis dashboards, etc)

1.4.1

Roles
A set of roles is defined by default:
Guest
User Administrator
Platform Administrator
Operator Level 1
Operator Level 2
Operator Level 3
Package (or value pack) Designer
View Designer
Report Exporter

32

This list can be extended through your identity provider used by SAML
authentication, or by using the Role Administration page in the application in case
you are using the local built-in authentication.
Default set of permission on the user interface are:

Table 2 RBAC Default Roles / Permissions

The list of roles associated to a user will impact the user interface that will be
available to him. Here after an example of an operator level 1. He has very few
available actions and limited access to specific dashboards. It will also impact the
available list of dimensions and facts in the analysis tool.

33

Figure 23 Example of operator level 1 dashboard

In this dashboard, the menu is simple and only allows access to workspaces. The
Workspace management operations have been hidden (save, delete).

1.4.2

Permissions
UOC has an internal list of pre-defined permissions that will impact the User
interface. When an administrator defines a new role, he needs to associate some of
these permissions to this role in order to indicate to UOC what actions are available
for the connected user.

The permission list is today not extensible and only User interface oriented, and
deeply linked to the UOC web application. It is totally different from permissions
you may need to tune the privacy setting.

Here is the list of available permission:


Group

Operation

Object

Identifier

Description

Workspace
Management

Browse

Workspace

browse_workspace

Allows the user to browse and display


workspaces

Create

Workspace

create_workspace

Allows the user to create workspaces

Delete

Workspace

delete_workspace

Allows the user to delete workspaces

Save

Workspace

save_workspace

Allows the user to save or save as...


workspaces

Edit

Workspace

edit_workspace

Allows the user to edit properties of


workspaces

Create

View

create_view

Allows the user to create new views

Delete

View

delete_view

Allows the use to delete views

Edit

View

edit_view

Allows the user to edit views

Add

View

add_view

Allows the user to add views to existing

34

workspaces
Remove

View

remove_view

Allows the user to remove views from an


existing workspace

Configure

Widget

configure_widget

Allows the user to access to the configuration


panel of a widget

Configure

Datasource

configure_datasource

Allows the user to select the data to analyze

Configure

Filter

configure_filter

Allows the user to define filters on dimension


for the data to analyze

Configure

Top

configure_top

Allows the user to define top filters for the data


to analyze

Export

Data

export_data

Allows the user to export data

Export

Report

export_report

Allows the user to export report

Browse

Launch
Category

browse_launch_category

Allows the user to browse and display


workspaces

Create

Launch
Category

create_ launch_category

Allows the user to create launch categories

Delete

Launch
Category

delete_ launch_category

Allows the user to delete launch categories

Save

Launch
Category

save_ launch_category

Allows the user to save or save as... launch


categories

Edit

Launch
Category

edit_ launch_category

Allows the user to edit properties of launch


categories

Browse

Category

browse_category

Allows the user to browse and display


workspaces

Create

Category

create_ category

Allows the user to create workspace categories

Delete

Category

delete_ category

Allows the user to delete workspace categories

Save

Category

save_ category

Allows the user to save or save as... workspace


categories

Edit

Category

edit_ category

Allows the user to edit properties of workspace


categories

Configure

Theme

configure_theme

Allows a user to modify the selected theme


browsing the available list of themes.

Configure

Language

configure_language

Allows a user to modify the selected language


brosing the available list of languages

Package
Management

Browse

Package

browse_package

Allows a user to browse packages available in


the platform

Add-ons
Management

Browse

Layout

browse_layout

Allows a user to browse layout available in addons

Browse

Widget

browse_widget

Allows a user to browse widgets available in


add-ons

Browse

Plugin

browse_plugin

Allows a user to browse plugins available in


add-ons

Browse

Menu item

browse_menu_item

Allows a user to browse menu items available


in add-ons

Launch
Category
Management

Category
Management

Preferences
Management

35

User
Management

Role
Management

Platform
Management

Launch
Management

Browse

Menu bar

browse_menu_bar

Allows a user to browse menu bars available in


add-ons

Browse

Menu theme

browse_theme

Allows a user to browse themes available in


add-ons

Browse

Menu
module

browse_module

Allows a user to browse modules available in


add-ons

Browse

User

browse_user

Allows a user to browse available users on the


platform (local authentication mode only)

Create

User

create_user

Allows a user to create a new user on the


platform (local authentication mode only)

Delete

User

delete_user

Allows a user to delete an existing user on the


platform (local authentication mode only)

Edit

User

edit_user

Allows a user to edit an existing user on the


platform (local authentication mode only)

Browse

Role

browse_role

Allows a user to browse available roles on the


platform

Create

Role

create_role

Allows a user to create a new role on the


platform

Delete

Role

delete_role

Allows a user to delete an existing role on the


platform

Edit

Role

edit_role

Allows a user to edit an existing role on the


platform

Edit

Setting

edit_setting

Allows a user to change settings on the


platform

Browse

token

browse_token

Allows a user to browse his authentication


token on the platform

Create

Launch

create_launch

Allows a user to create new launches

Delete

Launch

delete_launch

Allows a user to delete launches

Edit

Launch

edit_launch

Allows a user to edit launches

Execute

Launch

execute_launch

Allows a user to execute launches

Table 3 RBAC List of user interface permissions

36

1.5 Plugins
A plugin is a key component in the UOC architecture. It acts as a gateway between
the UOC application and one or multiple data servers for a specific domain
(Customer Experience Assurance, Fault Management, OSS Analytics).
It is the only one in charge of communicating with the server: querying information,
querying value packs (or packages), views, workspaces, and executing
operations.
It could retrieve any information from an existing server as soon as this server has
a proper interface. A plugin is specific to a server and its implementation is based
on its available interfaces.
A plugin is specific to a data server (or multiple data server using the same
interface) , and have to implement the right interfaces to retrieve all the needed
information. These interfaces can be heterogeneous, custom, etc. The only
constraint of the plugin is to expose a unified format to the UOC server.
This plugin component is a faade to ease dialog with a data server for the UOC
application. All widgets will request information to the plugin through the UOC
server. They never call directly a data server. It allows the architecture to be more
flexible and extremely scalable.

Package A

Package b

Figure 24 Plugin Overview

37

A plugin is a standard Node.js module exposing a set of mandatory REST APIs part
of the unified format support and declaring a descriptor file (JSON format) where
the UOC server can find the plugins definition and server parameters (host, port,
protocol).
A plugin can be disabled by a platform administrator in UOCs web user interface.
An active flag in the configuration of the plugin can be set to True or False. If the
Active flag is False, the plugin is not loaded during UOC Server startup and not
available for dashboards or views.
A plugin has a plugin descriptor file in
<install_dir>/server/addons/plugins/<pluginId>/plugins.json
A plugin can have a plugin configuration file in
<install_data_dir>/server/public/addons/plugins/<pluginId>/config.json
Some plugins like OSS Analaytics plugin has advanced configuration because they
manage several data server configuration sharing the the same interface. So the
configuration definition provide multiple servers ,protocols, ports definition.
During the UOC startup, all defined server will be query to collect all value packs.

Figure 25 Multiple servers configuration for OSSA Plugin

Example of OSSA configuration file:


<installdir>\server\public\addons\plugins\ossa
{
"servers": {
"cea": {
"protocol": "http",
"host": "ossv031.gre.hp.com",
"port": "8080"
},
"fas": {
"protocol": "http",
"host": "dubaiv1.gre.hp.com",
"port": "8080"

38

}
},
"active": true,
"demo": false
}
In such configuration, the UOC will query to the right server, all requests required
for a specific value pack.
Ussually the compression is enabled between the data server and the Unified OSS
Console server. It is possible to disable it explicitely.

1.6 Value Pack (or package)


A value pack (or package) is a predefined content pack for services and network
technologies (KPIs, KQIs, QoE Scores ) that provides new features related to
specific business domain in the UOC product. It is usually built by an OSS Expert
team.
Examples of value packs:
Mobile Data 3G & LTE
Voice & messaging 2G, 3G
VOLTE
Fault Management, etc...
A value pack (or package) is a set of metadata definitions defining the exposed
information to the end user and the way he can analyze information (dimension),
display values (metric or fact), combine some metrics with others, etc.
It extends features of the UOC application by providing new ways of analyzing
metrics related to a specific domain (e.g. specific KPIs, scores). The UOC
application is value pack driven. That is to say UOC will dynamically generate its
display and content depending on the available value packs.
A value pack integrates a strong security check. It can define roles to control what
can be accessed and by whom. Some data can thus be private and not available for
all users/operators.
A value pack has a unified format that ease the integration of multiple
heterogeneous domain of work.
Value packs are designed to work with a specific plugin (and targeting a specific
data server). For instance, it will bring new analysis dashboards, operational
dashboards, network operations screens, predefined content packs for services
and network technologies KPIs, KQIs and QoE scores, , to the end user as soon as
it has been loaded into the UOC platform. It requires the data server to be installed
and fully functional.

39

1.6.1

Structure
Its basic structure is composed of 3 parts:
Metadata. It is internal definition never exposed at the UOC level. It is
usually linked to a data table, or aggregation rules provided by the data
server.
Metadata for user interface (package). (It needs to match a data server). It
defines what will be exposed at the user interface in term of dimensions
and facts (metrics).
Data for the user interface UOC (views and/or workspaces) (optional). It is
composed of pre-defined screens for operators. These screens can be
customized later. It is a way to provide some templates corresponding to a
value packs content, to speed up the deployment of the value pack inside
UOC.

Figure 26 Value pack structure

1.6.2

Value Pack Management


During the startup of the UOC server, through activated plugins exposing their
associated value packs, the UOC server gets dynamically all the value packs
available on data servers, identifies what kind of data is available on these specific
servers and extends dynamically the user interface to support this value packs at
end user level. During the import:
The metadata (1) are ignored and stay on the data server. This cannot be
accessed by UOC applications client-side.
The metadata UI (2) also named package in the UOC application are
dynamically loaded and stored in memory of UOCs server (in his
associated plugin).
The Data UI (3) basically composed of pre-defined graphical views, and predefined workspaces ready to be open, are imported (or updated) in the GUI

40

document database. The UOC application will always use the database
(CouchDB) to find its available graphical workspaces and views.
Example with the OSS Analytics plugin.
The Mobile Broad Band QoE value pack will be loaded into the UOC Server and ready
for usage, and all associated workspaces and views prepared by a View Designer /
Package Designer will be imported (or updated) into the GUI document database
(CouchDB). After this startup, the MBBQoE value pack is available. The operator can
open the new workspaces, display new views, and is ready to use the analysis tools
to troubleshoot quality of service for the mobile domain.

Figure 27 Value Pack Management

Unified format to define packages (value packs) have been extended. The metadata
can now associate objects (like CUSTOMER, SUBSCRIPTION,) and also define
available operations (CRUD + custom operations).
Note: Object definitons and operations still apply the role based access control.
The definition of these objects are requested from the plugin (official RESTAPI) in
charge of the value pack (JSON-Schema) with an identifier and version.

41

A startup import policy is available for customization (see the Installation Guide for details).
By default, all the packages received from data servers are never overwritten by local data.

Figure 28 Objects and operations support in the unified package format

Example of Object definition

"objectTypes": [{
"id": "customers",
"name": "Customers",
"version": "1.0",
"description": "Customers of our business",
"key" : ["name"],
"roles" : ["User Administrator","Authorized_Operator","Guest"],
"operations" : [{
"id": "create",
"name": "Create",
"roles": ["User Administrator","Authorized_Operator"]
},{
"id": "update",
"name": "Update",
"roles": ["User Administrator","Authorized_Operator"]
},{
"id": "delete",
"name": "Delete",
"roles": ["User Administrator"]
},{
"id": "lock",
"name": "Lock",
"roles": ["User Administrator","Authorized_Operator"]
}]
}

42

1.7 Unified OSS Console Add-ons


Add-ons are pluggable, reusable components used to extend the Unified OSS
Console and provide new capabilities. All these extensions are scanned dynamically
at UOC server startup. The UOC platform is always up and running with the latest
extensions available.
A platform administrator can browse these extensions with the add-ons menus
(theme gallery, menu-bar gallery, widget gallery, layout gallery, plugins gallery,
code module gallery) that will let the administrator explore all available add-ons on
the platform and get additional information about them (name, description,
version,).
A developer can build his own add-ons and add new features on the UOC platform.
These add-ons need to follow some development guidelines, implement
mandatory APIs and provide a descriptor file in the right directories (JSON format).

Add-ons

Type

Needed skills

Estimated
Workload

Workspace

Data

No specific skill. JSON definitions

~30 minutes

View

Data

No specific skill. JSON definitions

~1 hour

Launch

Data

No specific skill. JSON definitions

~30 minutes

Layout

Client

Web designer skill (HTML5,CSS,bootstrap recommended)

~ 1 hour

Widget

Client

JavaScript Developer skill. It needs some good knowledge of


Angular JS

~ 2 weeks

Theme

Client

Web designer skill (HTML5,CSS,bootstrap recommended)

~2 weeks

Menu Bar

Client

Web designer skill (HTML5,CSS,bootstrap recommended)

~1 hour

Menu Item

Client

Web designer skill (HTML5, CSS, bootstrap recommended) and


JavaScript Developer skill. It needs some good knowledge of
Angular JS

~2 hours

Launch
Keyword

Client

JavaScript Developer skill. It needs some good knowledge of


Angular JS

~ 2 hours

Module

Client

JavaScript Developer skill. It needs some good knowledge of


Angular JS

~2 or 4 hours

Plugin

Server

JavaScript Developer skills. It needs some good knowledge of


REST API and Node JS

~1or 2 weeks

Value Pack /
Package

Server

Skills in the needed domain (telecom). JSON definitions

~2 or 4 weeks

Table 4 Add-ons - Skills needed by integrator to extend the UOC framework


Note: Estimated wokload is the usual workload seen. It totally depends on the
complexity of the add-ons.
There are two different directories to put these extensions depending on if the addons extend the client or the server part:
<install_dir>/client/addons

43

<install_dir>server/addons
Data add-ons are imported and stored in the GUI database.

Note: group can be created on the client


part to keep together widgets and layouts
related to a same provider and ease
packaging and maintenance

Figure 29 Add-ons Client and Server directories

44

1.8 Graphical Concepts


1.8.1

Overview

The Unified OSS Console has been designed and optimized to dynamically generate views to the end
user and apply security constraints based on his list of roles.
The user starts first to open a workspace, i.e. a set of multiple views.
Views and Workspaces are designed by a dashboard designer. They are pre-defined screen ready for
display, operation dashboards and real-time analysis. Each view is presented in a tab window of a
workspace.
Example of a workspace with 4 views. Each visual tab is a view of the workspace. Each view applies a
layout (i.e. a way of organizing the elements on the page) and displays a set of widgets to predefined spaces that display contents and interact with the end user. Each widget has a specific
configuration to collect the right data from a given value pack from a given domain server.

Menu bar,
Menu items
Workspace
Widget

View

Widget
Widget

Widget

Widget

Widget

Layout
Figure 30 Graphical Concepts - Example of Dashboard

Note: Two modes exist: Dashboard mode (like this figure below) and a Navigation mode that only
displays one active view at a time. Specific buttons or actions will be needed to navigate to another
view of the workspace.

45

Note: If there is only one view available for the workspace then the tabs are not
visible. The view is displayed in full-page.

Figure 31 Graphical Concepts - Overview

This basic concept of generating content allows the UOC to have an infinity of
domain applications and a high level of customization and configuration without
applying patches or writing additional code.
The Unified OSS Console dashboard engine dynamically generates screens based
on several libraries (Add-ons Client).
Widget library
Layout library
View library
Workspace library
Theme Library
Code Module Library
UOC use these add-ons to assemble a final dashboard for the end user and can also
support customized main menus. Developers can extend the current product by
creating additional add-ons.

46

1.8.2

Workspaces
Workspaces can be designed by a view designer or created by operators with
advanced rights. A workspace must have a unique identifier and will be stored in
the document database. It is a JSON definition file.
The purpose of a workspace is to hold customization done by an end user. The end
user can customize the look and feel of a widget, the associated queries, filters to
apply and also customize this workspace at runtime (adding / deleting a view,
changing data configuration, graphical settings ) and save the workspace
customized this way if he has the correct permission.
Since the workspace does not include the view definition but only references to
them, every changes done by a View Designer will be propagated to all workspaces
using the modified view. Only overrided customization will be applied on top of the
view designer choices.
So if a view designer makes changes on views, the end user will inherit of these
changes (if he did not apply a specific configuration that overrides or masks those
changes).
The main screen displays all available workspaces that the connected user can
access. It is possible to define some favorite workspaces to make them appear on
top of the list.
They are organized using workspace categories to ease finding the workspace we
want to display, and a dynamic search text-field is available to quickly find the right
workspace.
It is possible to open a workspace in Navigation or dashboard mode depending on
the option set by the creator of the workspace. A visualization dashboard usually
uses the dashboard mode to present all the views in a tabset. Other workspaces
more focused on operational tasks are more useable with the navigation mode. In
this mode, only one view is active at a time, there is no tabset, and the end user has
to click or execute action to navigate to another view.

47

Figure 32 Workspace Navigation Mode (dashboard vs. Navigation)

Workspace also supports header and footer when the view designer can put global
components. Ideal for example to set a navigation menu depending on the
workspace purpose.

48

Workspace Header

Workspace Footer
Figure 33 Workspace Header and footer

1.8.3

Views
Views are built by a View Designer. A view must have a unique identifier and will be
stored in the Document database. It is a JSON definition file.
They can only be modified by a View Designer. An end user can only customize his
usage of one or several views but these changes will be saved into a workspace.
So an end user can save a customized workspace as a new workspace to apply his
own personal changes (e.g. filter by location of network equipment instead of
filtering by network equipment type). These changes will be read at runtime by
the dashboard engine and will override pre-defined settings done initially by the
View Designer. Not all kinds of customizations are allowed: only the ones available
through the configure button in each widgets (if the widget supports configuration)
and changes made in the Analysis Tools (data selections, filters, ) can be saved.

49

1.8.4

Layouts
The layout object is very important in the UOC screen. The layout stands for the
structure of the displayed page, and lets the view designer identify where the
dynamic elements can be generated (widgets).
It is the first choice to do when designing a new view. Layout file usually created by
a web designer. This HTML definition should support responsive design (using
Twitter Bootstrap) to adjust automatically the layout and eventually reorganize
rows and columns of the layout depending on the screen resolution of the device
used by the end user. It is strongly recommended to understand Twitter Bootstrap
CSS framework.
Bootstrap is the most popular HTML, CSS, and JavaScript framework for developing
responsive, mobile first projects on the web.
See the official Bootstrap web site: http://getbootstrap.com/), especially the
Bootstrap grid examples (see http://getbootstrap.com/examples/grid/
All available layouts can be browsed using the layouts gallery (only accessible by
users having platform administrator rights).

Figure 34 Example of add-ons layouts gallery

By default, HP provides a set of layouts, but this can be easily extended by a web
designer following simple rules (client Add-ons - Layout)

Default HP layouts are under <install_dir>/client/addons/hp/layouts

Note: A Layout can also be customized to embed several information not related to
widgets. It is possible to create a layout that displays images or that re-uses a
company template layout.

50

Widget

Text

Link
Widget

Photo

Figure 35 Example of custom add-ons layout (including static images and text)

1.8.5
1.8.5.1

Widgets
Overview
A widget is a graphical reusable component that can be displayed on views. It uses
a predefined space on a layout (ex: a grid 2x2 will allow 4 widgets to be displayed in
a grid). A widget is part of a widget library.
UOC provides a set of default dashboard-oriented widgets. These widgets support
the unified formats defined in a value pack. So, it is possible to reuse the same
types of widgets for different value packs (different dimensions and facts types can
be used).
A default visual customization is implemented, but all widgets can be customized in
a view and bring a different user experience to the operator (axis, legend, title,
colors, graphical features).
A view designer can refine the customization in the context of the view and can also
predefine data querie, auto execute these queries when the view is displayed, and
this way, build a dashboard ready for use.

51

Figure 36 Example of add-ons widgets gallery

There are several types of widgets:


Selection: A Selection widget is dedicated to capture the input of the user,
validate this input, and publish this information to other widgets (these
informations are called output parameters of the selection widget).
Visualization: A visualization widget is in charge of presenting information.
It displays metrics, status, colors, based on the results of queries from the
data server.
Containers: A container widget is in charge of managing child widgets. It is
usually a way to group widgets or to create a sort of cinematic between
them.
o Widget Group: A widget group is a container (it groups child
widgets and share the same data selection for queries).
o Widget Navigation: This widget manages a set of child widgets and
select one at a time to be active and visible. For example, it can be
used to display first a list of objects in a widget list allowing
clicking on a row to select the item of the list and display its
details with another widget detail. Only the active widget is
visible and all child widgets of a Widget Navigation share the
same area of the view.
Hybrid (Visualization & Selection): This kind of widget is usually used to
display some synthetic information or lists of metrics, locations, ... They
allow also a selection to act as a filter or selector, usually to get more
information about the selected item(s). For example, it can be a colored
map displaying the region with specific status (high, medium, warning)
and each region can be selected to apply a filter to other widgets and focus
on the result of this specific region.
The following widgets are supported and can be reused for all Value Packs.

52

Widget Identifier

Name

hp-chart-line

HP Line Chart

hp-chart-area

HP Area Chart

hp-chart-pie

HP Pie Chart

hp-chart-bubble

HP Bubble Chart

hp-chart-bar

HP Bar Chart

hp-chart-area-range

HP Area Range Chart

hp-chart-area-spline

HP Area Spline Chart

hp-chart-column

HP Column Chart

hp-chart-column-range

HP Column Range Chart

hp-chart-spline

HP Spline Chart

hp-chart-funnel

HP Funnel Chart

hp-chart-pyramid

HP Pyramid Chart

hp-chart-scatter

HP Scatter Chart

hp-chart-boxplot

HP Box Plot Chart

hp-chart-heatmap

HP Heatmap Chart

hp-chart-treemap

HP Treemap Chart

hp-chart-gauge

HP Gauge Chart

hp-chart-solid-gauge

HP Solid Gauge Chart

hp-knob-gauge

HP Knob Gauge Chart

hp-aggregation-table

HP Aggregation Table

hp-data-exchange-inspector

HP Data Exchange Inspector

hp-iframe

HP IFrame

hp-time-selector

HP Time Selector

hp-top-table

HP Top Table

hp-panel

HP Panel

hp-drilldown

HP Drilldown

hp-widget-group (*)

HP Widget Group

hp-widget-navigation (*)

HP Widget Navigation

hp-form

HP Widget Form

hp-table

HP Widget Table

hp-widget-menu-bar

HP Widget Menu Bar

hp-breadcrump

HP Widget Breadcrump

hp-map

HP Widget Map

Hp-tree-launch

HP Tree Launch
Table 5 Default HP Widgets

(*) These widgets are container for other widgets to provide advanced features to
child widgets (animation, information sharing,)

53

1.8.5.2

Widgets Lifecycle
Once they are loaded into the view, widgets are in charge of querying the data to
the domain server through the specific plugin. Each value pack knows what server
is able to answer these requests and the UOC framework will redirect all pending
requests to the right plugins.

UOC Client (web browser)


Workpace

View

Data Server

UOC Server
Rest API

Widget

Any interface

Plugin X

Server X

Data
(Unified format)

Figure 37 Widget lifecycle

A widget can have some actions available in its widget toolbar (launches,
configuration, data selection, refresh/cancel, and full page mode). The View
Designer may choose to hide some of them or let them all visible for the end user.
See 3.6.1 Widget Toolbar for more details.

1.8.5.3

Multiple charts by data series


Charts widget like Lines can be now display using several instances instead of
displaying all in one chart. For example, it is now possible to display one chart by
instance of the requested dimensions.
Example of single chart instance

Figure 38 Chart enhancement Single chart instance

All the serie returned by the request are displayed on the same graph.

54

Example of multiple chart instances


It means one chart will be used by instance. We only display one line per chart.

Figure 39 Chart enhancement Multiple chart instances

1.8.5.4

Multiple data selection on the same widget


Charts widgets supports multiple data request. It is possible to execute multiple
data selection and use the same output chart for rendering the result.
These data can come from different data source (and plugin) to ease comparison,
trending, threshold,
Example of Uplink and downlink volume by brand device ( 2 data selections) over
the time.

55

Figure 40 Chart enhancement Multiple data selection

The analysis tool has been updated to llet the user configure several data requests.
These requests can use different data servers and differents value packs
(package).

There is no consistency on the result, so it is strongly recommended to select


compatible metrics to displays (scale, unit)

1.8.5.5

Graphical decoration on chart widgets


All chart widget also support some graphical decoration like threshold line , style,
color x axis and y axis can be cusotmize with static definition like threshold,
colored area,

Figure 41 Example of x-Axis decoration on line chart widget

Figure 42 Example of y-Axis decoration on line chart widget

56

1.8.5.6

Charts Selection
An option is available in some widget to allow the end user to select a specific
widget and then filter data on other widget based on this selection.
The selector is a graphical indicator on the right of the widget. Cursor indicates it is
a clickable link to navigate in information.

The selected chart has a selected link and a bold title.

Figure 43 Example of chart selector (hp-knob-gauge)

It is an interesting feature to provide several widgets that listen the selection and
update their data based on the users choice (ex: pie chart, table based on a
specific selected instance).
Example: A user can select a first instance of dimension (ex: MOBILE Brand is
Samsung) based on a first metric analysis, and display other analysis and oither
metrics with another charts on the same page using the selection.
It allows the view designer to create dashboard very interactive to navigate in
information and refine filtering at server level when query the data.

57

Empty second table


waiting for a selection

Empty charts waiting


for a selection

The user select one instance


of the first table to populate
the second table

Empty charts waiting


for a selection

The user select one instance


of the second table to
populate the pie chart with
metrics

Figure 44 Example of navigation in information using widget selection

58

1.8.5.7

Chart widgets
A large set of widgets dedicated for charting are available.

Figure 45 Several chart widgets (pie, line, area, spline)

59

1.8.5.8

Widget Treemap
The widget Tree map is dedicated to display information from big data in a very
visual way. By default, the charts supports multiple display algorithms (Slices and
dice, stripes, scarified, strip). It supports one or multiple dimensions, and one or
multiple facts.

Figure 46 Example of Widget Tree Maps (single fact / multiple facts)

1.8.5.9

Widget Aggregation table


An Aggregation table widget is a specific widget, dedicated to display aggregated
data/values/metrics in a table. The operator can select several dimensions for
analysis, several metrics to display, and the aggregated table will query
aggregated result and display them in a colored table. This table is fully
customizable.
Depending on the option set in the data selection, dimensions selected will be
processed with one single query and provide an aggregated result, or processed
separately and generate several requests to complete dynamically the table. Here
are some samples of aggregation table.

60

Figure 47 - Example of aggregation table (Multiple queries)

Figure 48 - Example of aggregation table (Single queries)

Figure 49 - Example of aggregation table with several units (ratio, number,


ms)

It is possible to select a cell, a row, or a column and request a chart of the metric
over time if we associate this aggregation table with a time line chart. Both widgets
are able to exchange data selection.

The configuration button allows the operator to refine the visual presentation:
o The title can be auto generated or static
o Table can manage groups or display a flat list
o Number of displayed decimal
o Display the colored effect in cells
o Display the value in cells, or only the color, or both
o Display units in cells

61

Figure 50 Aggregation Table Configuration Panel

1.8.5.10

Widget Top table


Similar to the aggregated table, a specific top table widget is available to display a
sorted table keeping only the Top X results. The operator can select several
dimensions for analysis, several metrics to display, define the top value he wants
to display and the top table will query aggregated results and display them in a
colored and filtered (top x result). A top table widget is fully customizable.

Figure 51 - Example of top table (Top 10 of Network QOE score by Cell Name)

62

It is possible to select a cell, a row, or a column and request a chart of the metric
over time if we associate this top table with a time line chart. Both widgets are able
to exchange data selection.
The configuration button allows the operator to refine the visual presentation:
o The title can be auto generated or static
o Number of displayed decimal can be pre-defined or automatic based on
results.
o Define a maximum number of columns to displays to avoid to make the top
table unreadable
o Display the colored effect in cells to visually indicate the distribution of the
value.
o Display ranking number on the left or the right or both
o Dsiplay the value in the cell or only the color or both

Figure 52 Top Table Configuration Panel

63

1.8.5.11

Widget IFrame
The Iframe widget is dedicated to the integration of an external web application
(needs the URL). It embeds the external web application in a widget. It is possible to
integrate an external web page inside UOC views with other UOC widgets.

Figure 53 - Example of www.hp.com web site integration

Figure 54 - Example of Unified Correlation Analysis integration

64

Figure 55 - Example of Topology map integration

1.8.5.12

Widget Data Exchange Inspector


The data exchange inspector widget is a troubleshooting widget, very useful for
View Designers, integrators and widget developers. It displays in real-time the
contents of the global memory in charge of exchanging data between components.
Everything set in the Data Exchange Service area is listed in an HTML table and
displayed by this widget.

Figure 56 Data Exchange Inspector

65

1.8.5.13

Widget Drill Down / Up


The Drill down and up widget allows to explore and drill down to metrics that have
been used for the high level value computation. It explores a tree of facts and
applies threshold definitions to provide a summarized presentation.
It is usually linked to another aggregation widget (top table, aggregation table) to
select the right metric (fact) to explore and troubleshoot the eventual issue met by
a customer.
Each line displays the name of the fact, its returned value, and a color that changes
depending on the threshold.

Expand

Expand

Figure 57 Expanding QoE score with the Drill up and down widget

Each expand operation executes one or several queries to retrieve all the
associated values. A spinner indicates on each line that the widget is waiting for
results.

66

Figure 58 Example of drill up and down widget waiting for result

All the threshold definitions are done during the view design by a view designer
and cannot be changed at runtime

The user selects a fact


from a top table widget.
The selected fact is used
to update the aggregation
fact tree. The user can
select one of the facts in
the tree (drill down/up
widget) to display its
values over time in
another line chart widget.

Figure 59 Example of drill up and down widget integrated into an analysis


dashboard

67

1.8.5.14

Widget Panel
A panel widget is a very generic presentation widget, which is able to display and
present values returned by a query, apply thresholds to facilitate the interpretation
of the results, and make clear good result from bad ones.
A panel is a set of metrics (KPIs, KQIs) associated with a set of thresholds to
understand values, and a configuration of style to indicate how to display results.

Figure 60 Example of a widget Panel with icons/threshold configuration

68

Figure 61 Example of dashboard with 3 widgets Panel (icons)

Figure 62 Example of dashboard with multiple individual widgets Panel (icons)

It is possible to displays as a result:

69

Presentation icons
Title
Value
Threshold icon
-or Threshold colored badge
-or Threshold color
Presentation Icons
to visually identify
the metric

Presentation title of the


metric and its associated
current value
Threshold icon
Threshold colored badge
and its associated
current value
Threshold color

Figure 63 Visual Threshold style

The View designer can define the best way to display results returned by a previous
query. This panel is usually used in association with another widget that captures
users inputs and process the query (like the ossa-ccd to query QoE scores to
present a customer care view depending on a customer identifier and a period of
time).
All the icons associated to a threshold are customizable and are available under the
location: <install_data_dir>/client/public/images/addons/widgets/hp-panel

Figure 64 Example of threshold icons for hp panel

Some threshold icons are available by default (24x24, 32x32, and 48 x 48 pixels).
Some presentation icons (24x24, 36x36, 48x48 pixels) are available in the location:
<install_data_dir>/client/public/images/addons/widgets/hp-panel/ccd

70

Figure 65 Example of presentation icons for hp panel

Some metrics are often associated to other ones and the widget panel allows the
user to expand/collapse these metrics to display details of the summarized result.

Figure 66 Example of summarized value for web Score (result is Warning)

After expand action, more details are displayed about the web score ant its other
associated metrics.

Figure 67 Example of expanded values for web Score


Details describe other metrics (accessibility in the example above) and their
associated results and thresholds. The user can collapse and hide these details
after having checked the details by clicking on the graphical indicator.
A configuration dialog box is also available to allow customization at runtime (this
configuration can be saved into the workspace, if the user have the right
permissions).

71

Figure 68 Widget Panel configuration box

The configuration box allows to change the associated color and show/hide some
of the visual information in the panel.

All the threshold definitions are done during the view design by a view designer
and cannot be changed at runtime

72

1.8.5.15

Widget Group
A Widget Group is a special widget that acts like a widgets container to integrate
several widgets that share the same data selection. It defines a layout and other
widgets (like a view), child widgets. Only one select data icon is provided in the
widget groups toolbar: it pops up the analysis tools and apply the data selections
and filters to all widgets integrated inside the group.
A widget group allows to display the same data with different representations.

Figure 69 Widget Group

Figure 70 Example of widget group view (one time selector, multiple pie
charts)

73

1.8.5.16

Widget Navigation
A Widget Navigation is a special widget, which acts like a widgets container to
integrate several widgets and manage navigation between them. It defines a list of
possible widgets. Only one widget is active at a time and they all share the same
area in the view (this is different from a widget group that displays all of them and
applys a layout).
A Widget Navigation is useful for example to display first a list of customers and
allow the user to click on one row for to get more details. Another widget becomes
active (customer details widget) and usually provides a navigation button to go
back to the previous one.

Figure 71 Widget Navigation


For example, the following workspace displays a view containing 2 widgets: time a
time selector and a customer list widget.
As soon as the user clicks on one row, the widget is replaced by a customer details
widget. The page is not refreshed, only the widget area is impacted.

Customer list widget

Figure 72 Example of widget navigation (customer list)

Customer details widget

This button allows to go back to the


list widget
Figure 73 Example of widget navigation (customer details)

74

1.8.5.17

Widget Menu Bar


A Widget Menu Bar is a widget dedicated to display menu bar provided by the
Addons Menu Bar.
The view designer can easily integrates a menu inside a view. The Widget Menu Bar
requires the Menu Bar Identifier to display a given Menu Bar.
Widget Menu Bar

Figure 74 Example of widget menu bar

1.8.5.18

Widget Breadcrumb
A Widget Breadcrumb is a widget dedicated to display information about the
position of the end user in the workspaces.
The view designer can easily integrates a breadcrumb inside a view. The
information will be describe by the view designer with icons, label and/or clickable
links.

Widget Breadcrumb

Figure 75 Example of widget breacrumb


In the example below, the breadcrumb has been integrated with a widget menu bar
as header view in a workspace.

1.8.5.19

Widget Form
A widget Form is a widget that can generate forms inside a widget and collect some
end user input and execute an operation. The widget uses definition provided by
packages to get a description of the object type and the way to represent these
information.
The plugin will receive all the data and the operation to execute.

75

The widget uses definition provided by packages to get a description of the object
type and the way to represent these information.

Figure 76 New Widget Form

Widget Form that displays


user interface based on a
object definition and a form
definition provided by
packages

Figure 77 Example of widget menu bar

1.8.5.20

Widget Table
The widget table is a very generic widget able to display table of objects, and also
provide a high level of customization. It can dispay objects using the definition
provided in packages.

76

It uses package definiton (value pack) to deduce columns name, units and
formatting.
This table can manage an unified format (dimension/facts or- object types) by
configuration or dynamically driven by another widget.
Multiple selctions are supported and exported as selection for other widget which
want to handle it.
The graphical interface is fully customizable (column positions, single or multiple
sorting, visibility, filtering)
This widget also provides a powerful formatting options for columns (icons, color,
threshold or enumeration), and also integrate the add-ons module to totally let
the integrators adjust the exact look & feel of a cell based on values.
For specific needs, it is also possible to define new column to compute small
formula based on different columns (and data requests) like exposing a variation in
%,
All these options makes this widget very generic and usefull.

Figure 78 Example of widget table

The table provides columns configuration and visibility, sorting, header filtering
and also provide several way to format data for representation (text, icons,)
It supports client side pagination and server side in case of large volume of objects
to display.

77

Figure 79 Widget table column visibility setting

1.8.5.21

Widget Knob Gauge


The widget knob is now available to display a summarized value and optionally its
unit. It also provide a configuration to setup generated title, and threshold color by
fact with several level (danger, warning, ok)

Figure 80 Widget Kob Gauge

This widget can also be used to select instance for other charts or define a new
value an apply a changes.
Several graphical options are available in the configuration panel like automatic
generated title, number of digit, show/hide value or unit

Figure 81 Widget Kob Gauge Configuraiton panel

78

1.8.5.22

Widget Tree Launch


The Launch tree is a widget that display in a tree representation a set of launches
defined by categories. It usually associated to a n widget Iframe to embed the
launch next to the tree launch, and then provide a very seamless integration of
external systems.

Start an external
URL or update a
widget IFrame

Figure 82 New Widget Launch Tree

Figure 83 Example of launch tree to start favorite links like HP

It is possible to customize the title, group by category and collapse panel using the
configuration panel.

79

Figure 84 Tree Launch widget configuration panel

This widget tree launch supports all the launch keywords defined in the UOC
platform.

1.8.5.1

Widget Map
The widget hp-map supports GeoJSON map format and displays two
representation of map:
Colored Map: The widget is able to display a colored sector based on
threshold or value distribution, or a bubble chart in the middle of the
sector using the metrics value.
Latitude / Longitude Map: The widget is able to display a colored point
(based on threshold) or a bubble chart using the metrics value.
The widget is able to execute a data request and use the first metric as a value to
apply. This value can also optionally be used with threshold definition to display a
given status or color.
It also supports zoom in/out and selection of section to explore data in other
widgets.
All kind of maps requires a geo json map format setup in the following directory:
<install_dir>/client/public/maps
(ex: fr-all-all.geo.json)
It is possible to download free GeoJSON map or create your own one.
Check the Highmaps collection at http://code.highcharts.com/mapdata/ that
provide more than one hundred maps.
Note: GeoJSON is a format for encoding a variety of geographic data structures.
You can find more details about GeoJSON on the following website:
http://geojson.org/

Latitude / Longitude Maps


This map needs a definition to identify which dimension is used as latitude and
which one define the longitude.

80

Example of configuration
"configuration": {
"geoJson": [{
"map": "fr-all-all.geo.json",
"latLong": ["DIM_LATITUDE", "DIM_LONGITUDE"],
bubbleChart : false
}],
Where DIM_LATITUDE, DIM_LONGITUDE are dimension of the value pack and map
define the GeoJSON map to load in the widget Map.

Figure 85 Widget Map Latitude / Longitude Map (with/without bubble chart option)

81

Colored Maps
This map needs a definition to identify which dimension is used as a key to identify
the sector of the map.
Example of configuration
"configuration": {
"geoJson": [{
"map": "fr-all-all.geo.json",
"joinBy": ["name", "REGION_NAME"],
bubbleChart : false
}],
Where REGION_NAME is the dimension to use as a key for the map.

Figure 86 Widget Map Colored Map (with/without bubble chart option)

82

1.8.6

Themes
A Theme is an object in charge of the look and feel of the whole application. It
basically contains a customization of Bootstrap (CSS framework) and allows an end
user or platform administrator to select a specific user interface rendering.
Themes allow to customize the color of all bootstrap elements (navigation bar,
lists, buttons, text, ...) and it is recommended to use a visual editor to create a new
theme and refer to the official documentation (see
http://getbootstrap.com/customize/ ).
It is also possible to re-use an existing Bootstrap theme from Bootstraps web site
providers. In addition, it is also possible to select a specific wallpaper and associate
it to a theme, as well as a logo and a favicon (icon associated to an URL for the web
browser), to create a specific branded web application.

Figure 87 Theme HP (Default)

Figure 88 Theme HP Slate

Figure 89 Theme HP United

83

The following themes are installed by default as Client Add-ons:


HP (default theme)
HP Slate
HP United

All themes are under: <install_dir>/client/addons/<add-on id>/themes.


HP Theme is under <install_dir>/client/addons/hp/themes

An Add-ons developer with web design skills can easily extend the list of themes
available for the UOC platform.
A platform designer can select the predefined user preferences by editing a
configuration file to select the default theme to be used by all users (cf. 1.15 User
Preferences)
It is also possible to refine the theme used by charts widget customizing the
highcharts json file.

Figure 90 Theme enhancement chart widgets support theming

Highcharts Theme is under


<install_dir>/client/addons/hp/themes/<themeId>/highcharts.highcharts.json

84

1.8.7 Menu Bar


A menu bar is a main menu. HP provides a default menu bar (hp-menu-bar) but it is
possible to customize the menu bar to create a new one by adding or deleting
access to features.

Figure 91 Menu Bar HP (Default)

All sub-menus, called menu items, are available in add-ons and could be used
separately in another customized menu bar.

All menu bars are under: <install_dir>/client/addons/<add-on id>/menubars.


HP Menu bar is under <install_dir>/client/addons/hp/menu-bars

For example, in the following sample, the menu bar reuses the HP official menu for
Workspaces and User Preferences (Administrator) and adds a specific operations
menu

Figure 92 Menu Bar Demo Custom Sample Menu

Operations menu (Menu Item) displays a list of tasks that will automatically open
the right workspace for the end user and avoid him to go through the workspace
management page to find the right one.
An Add-ons developer with web-design skills can easily extend the list of menu
bars available for the UOC platform.
Only one menu bar is provided by default: HP Menu Bar (default menu bar)

85

1.8.8 Menu Item


A menu item is a component of a menu bar (sub-menus, search zones, links). A
menu item can only be visible if integrated into a menu bar (i.e. main menu).
By Default HP provides several menu-items in its add-ons:
Menu Item / Identifier

Description

HP Menu Item Logo

Displays a logo, a title and


optionally a link to click on

HP Menu Item Administration

Allows a user administrator


(user or platform) to access to
the platform management
screens

(hp-menu-item-administration)

HP Menu Item Add-ons


(hp-menu-item-addons)

86

Allows a Platform
Administrator to browse
available add-ons on the
platform

Screenshot

Menu Item / Identifier

Description

HP Menu Item Packages

Allows a Platform
Administrator to browse the
available packages available
for the platform per domain
server.

(hp-menu-item-packages)

HP Menu Item Launches


(hp-menu-item-launches)

HP Menu Item Workspaces


(hp-menu-item-workspaces)

Screenshot

Allows a user to browse and


execute global launches
available on the platform

Allows a user to access to the


workspace management page
and browse workspaces, by
category, open a workspace
and all associated
management operations
available for the user,
depending on his profile and
associated permissions.

87

Menu Item / Identifier

Description

HP Menu Item Preferences

Allows a user to access to the


language selection, theme
selection, logout button and
his personal information

(hp-menu-item-preferences)

HP Menu Item Notification


(hp-menu-item-notification)

Screenshot

Allow a user to access to the


notification console, and see
latest messages and their
severity level (info, success,
error, warning). It also provide
a configurayion panel to filter
these notitifcation message.
Table 6: HP Menu Items (Default)

All menu items are under: <install_dir>/client/addons/<add-on id>/menuitems.


HP Menu Items are under <install_dir>/client/addons/hp/menu-items

88

1.8.9 Modules
Modules are a small piece of code used packaged as a component module for
specific and advanced usages. They are typically used by other components
(example: formatter for table, service to replace default behavior). The Addon
developer can refer to each widget documentation to know the list of possible
customization based on this add-on.

All modules are under: <install_dir>/client/addons/<add-on id>/modules.

Example: this module can be used to format a specific column of a table.

Table 7: Example of Addons Module in the HP Table widget

1.9 Notification Messages


The Unified OSS Console displays all the end user messages (info, success, error,
warning) in a specific area called the notification message.
The user can filter the list of visible message. By default, all the warning, error and
success messages are notified to the user with a graphical effect and color.
These message supports localization and display in the selected language of the
user.

Table 8: Example of notification message

89

1.10 Launches
Launches are external applications that can be run from the UOC application.
Basically, they are URLs that can be executed from the main menu, the widgets
toolbars or from a specific action inside a widget. The URLs may contain variables,
allowing the use of dynamic contextual parameters.
Typically, all external systems accessible through an URL that an administrator
wants to expose to the end users can be defined as launches. This includes nonexhaustively PDF reports, online geographic maps (Google Maps, OpenStreetMap,
...), incident management systems ... They are very useful for integration purposes.

Main Menu

Widget Toolbar

Figure 93 Example of launches in the main menu and in a widget toolbar

1.10.1 Launch Definition


All launches come with launch definitions.
A launch definition has the following properties:
A unique identifier
A presentation name
An optional description
A version
An author
The URL to use when executing the launch. This URL can integrate
placeholder keywords that have to be solved at runtime. This allows the
launches to be dynamic and not fully hardcoded. These keywords are
called launch keywords. See 1.10.5 Launch Keywords for detailed
explanations.
A launch mode: internal or external. Cf. 1.9.3 Launch Modes
An icon to represent visually the launch in menus and toolbars
Roles to apply a role based security on the launch
A category to associate this launch with a logical group. This is mainly for
organization purposes.
A state to indicate if the launch definition is active and ready to be used (or
still under construction). Cf. 1.17.3 Launches.

90

Tags to organize the launch lookup. See 1.10.4 Launch Tags for detailed
explanations.

All the launch definitions are read from a JSON definition file and stored in the
GUI Database (couchdb).
Default launch definitions can be found in <install_dir>/data/launches

1.10.2 Launch Categories


To improve the organization of launches and to allow searching them more easily,
a launch is associated with a launch category. It qualifies the purpose of the launch
and allows to distribute the work related to the launch design and maintenance.
For example, we can find categories like Reporting to display external PDF
generated by Business Intelligence Servers, or Search to group all links related to
internet search, etc
Launch Categories do not have any functional impact but when we display launches
we can visually see the categories of the launch (presentation topic).
By default, there is no launch category.

All the launch categories are read from a JSON definition file and stored in the
GUI Database (couchdb).
Default launch categories can be found in <install_dir>/data/launch-categories

91

1.10.3 Launch Modes


There are 2 launch modes available for launches:
Internal. The execution of the URL is done in a specific widget (hp-iframe),
part of a view.
External. The execution of the URL is done in a pop-up window or a new tab
in the web browser.

Figure 94 Launch Modes

92

1.10.4 Launch Tags


Launch tags are a very powerful concept to associate a launch with a specific area
(i.e. main menu, widget, ).
They are a free list of text definitions that allows a view designer or platform
administrator to set launches available on a strategic area of a workspace. A tag
defines a semantic and creates an association.
The view designer designs views and can configure on each widget the list of
available tags to use to select the right set of launch to expose.

Figure 95 Launch Tags


In the figure below, Widget A filters all launches with tags Report AND
Performance and displays the Launch 4.
Widget B filters all launches with tag Report and then display the list of 3
launches with this tag .i.e. it displays all the reports available.
Widget C filters all launches with tags Report AND Customer C and then display
only the report for a given customer.
The main menu displays all launches with tag Global to expose all launches that
are not contextual.

In order to maximize efficiency, the launch tags need to be well defined and
organized.

93

1.10.5 Launch Keywords


A launch keyword defines a placeholder key in a launch URL definition that will be
solved dynamically by the UOC by browsing all launch keywords available. This
keyword can also be solved from a widget and then use a context (ex: customer
identifier, a selected information, a period of time )
Launch keywords are organized by group to ease the search of all these keywords
available in the library.
There are 2 types of launch keywords:
Global launch keywords
Contextual launch keywords
The launch engine will try to solve all launch global keywords first, and then ask to
the widget to solve the contextual launch keywords, those are keywords that the
widget is the only thing able to solve it, dynamically. At the end, the entire URL
should be built and ready for use.

1.10.5.1

Global launch keywords


They do not need a context and they can be solved from anywhere in the UOC. They
usually are global definitions that can be changed by a platform administrator
(host, port, protocol, title). These launch keywords are stored in the client addons directory and can be extended by add-ons developer with JavaScript skills.
Typically, launches using global launch keywords can be executed from anywhere
and it makes sense to have them available in the main menu or specific widget
listing all global launches (ex: a widget that lists all external systems the operator
can log on from UOC)

Group

Keyword

Description

UOC

HOST

Will be replaced by the real host address of the UOC Server


during execution of the launch

UOC

PORT

Will be replaced by the real port of the UOC Server during


execution of the launch

DATE

NOW

Will be replaced by the date now() during execution of the launch


Table 9: Example of Global Launch keywords

1.10.5.2

Contextual launch keywords


A contextual launch keyword is only available from a widget and expose selected
data or results from queries. It is in charge of the widget developer to define the
right contextual launch keyword available for the launch engine.
Ex: An add-on developer has implemented the following launch keywords
(group/keywords) ready to be used by URL in launch definitions.

94

Keyword

Description

CUSTOMER_ID

Will be replaced by the selected customer identifier during the execution of the
launch. The URL definition uses contextual information.

START_DATE

Will be replaced by the selected start date of the widget during the execution
of the launch. The widget should describe the format of the result.

DIMENSION

Will be replaced by the selected dimension used to collect data in the widget
during the execution of the launch
Table 10: Example of Contextual Launch keywords

1.11 Export Report


1.11.1 Report as a Service API
A new RestAPI is available on the UOC server to generate a PDF report ready for
download. This API allows to :

Export a Workspace as a PDF file.

Allow a set of configuration (size, orientation)

Multiple views generate multiple pages

Remove interactive button and menus

This API is dedicated to be called by an external system (business engine,


scripts,) like the Analytics foundation solution to get the PDF file, store this
file and optionally send email notification.
The UOC Server is only in charge of generating the PDF file through the RESTAPI.
Example: Ex: http://localhost:3000/V1.0/report?uri=/workspaces/myDemo

Figure 96 Report a s a Service RESTAPI

95

1.11.2 Export Report from the workspace


The end user (if his role has the permission) can export the report as a PDF file from
the workspace.

Figure 97 Export Report from the workspace

96

1.12 Mobility
The unified OSS Console can run without problems on several devices from various
types: tablet, desktop, laptop, smartphone The user interface is responsive and
able to adjust its rendering based on a devices constraints.
If the devices width is lower than a certain value, the navigation menu becomes
stacked and only available on demand to expand the main menu. This is a normal
behavior to enhance the customer experience on small devices.

Figure 98 Example of responsive dashboards on mobile devices

1.13 Localization / Internationalization


The UOC completely supports the localization and the internationalization.
By default, the UOC uses the locale of the web browser to set the locale to use (if
available). In case the detected locale is not supported, the platform will use the
default setting in the user-preferences settings (usually English).

97

The end user can dynamically switch the language using the language selector in
the user menu of the navigation menu bar.

List of available languages


(Note: language are not add-ons)

Figure 99 Example of the user Administrator menu (change language)

It is also possible to force a specific local in the start URL. See 3.2.1 Force a specific
locale for details.

Integrator and Add-ons developer Note


Each widget is in charge of implementing specific catalogue files to support
multiple languages. These files must respect a naming convention and will be
loaded dynamically on demand.

98

1.14 Themes
The UOC supports branding and theming to improve the user experience. The
platform administrator can setup the initial theme to use and in case the user has
access to the theme selection, he can easily select the right one for this usage.
The end user can dynamically switch the theme using the theme selector in the
user menu of the navigation menu bar.

List of available themes found


browsing the Client - Add-ons

Figure 100 Example of the user Administrator menu (change theme)

1.15 User Preferences


User Preferences are, for now, limited to platform settings defined by the platform
administrator. These preferences allow to select the right look and feel for the user
interface. It is a way to completely rebrand the UOC application for integrators.
Platform administrators can configure them in a user preferences configuration file
which can contain the following options:
Preference

Default

Description

Title

Unified OSS Console

Title of the application displayed in the title page, login page and
the main menu.

Version

2.1

Version associated to the application displayed in the login page.


If this value is not defined. The version is hidden (no visible
version badge)

Link

URL available if the user clicks on the title. It usually redirects to


the home page of the application but it can define another
internet address.

Language

En-us

Default language to use if the setting of the web browser is not


available.

Theme

hp

Default theme to apply in the application

Menu Bars

hp-menu-bar

Default main menu to use. This main menu can be customized in


add-ons (see 1.8.7 Menu Bar)

Show/Hide

True

Indicates if after login the main page contains the available

99

Workspace
Management
Initial
Workspace

workspaces list and allows workspaces operations or if this page


needs to stay empty. Useful in case of custom menu Operations
that expose pre-defined workspace to select.
(not defined)

Indicates if a workspace need to be open by default after login or


if the user has to be redirected to the main page.
Table 11: Example of Global Launch keywords

Figure 101 User Preferences (Theme slate, custom title, custom version, English)

Figure 102 User Preferences (Theme united, custom title, no version, French)

100

1.16 Add-ons Workflow


Add-ons are created by specific types of persons with specific roles. It could be
data, add-ons for the client side or add-ons for the server side.
A View Designer is in charge of the creation, design and modification of views and
can also assemble pre-defined workspaces to provide high level template ready for
usage and configuration.
An Add-ons developer is in charge of creating new reusable components for the
Unified OSS Console. Several profiles are usually needed depending on the type of
add-ons to produce. Some of them are highly graphical and require web design
skills, others require more JavaScript skills to produce code.

Figure 103 Add-ons workflow

101

1.17 Data Objects States


Design, creation and update of workspaces, views and launches can take several
steps and may involve different people in a team (Designer, tester, ). Workspaces,
Views and launches objects have a state to qualify if they are in a final version,
approved and ready to use.

Note: These states are available and will be completely supported in a future version

1.17.1 Workspaces
A Workspace can have the following states:
Identifier

Name

Description

UNDER_CONSTRUCTION

Under Construction

The workspace is under construction and can only


be used by the designer

WAITING_VALIDATION

Waiting Validation

The workspace has been released and available for


testing

ACTIVE

Active

The workspace is approved and available for usage

INACTIVE

Inactive

The workspace is seen as obsolete and should not


be used anymore
Table 12: Workspace States

An operator can only use workspaces with state Active


A view designer can browse, edit workspaces and update their state.

Note: There is no check on the valid changes between states in this version of Unified OSS Console.

1.17.2 Views
A View can have the following states:
Identifier

Name

Description

UNDER_CONSTRUCTION

Under Construction

The view is under construction and can only be used


by the designer

WAITING_VALIDATION

Waiting Validation

The view has been released and available for testing

ACTIVE

Active

The view is approved and available for usage

INACTIVE

Inactive

The view is seen as obsolete and should not be used


anymore
Table 13: View States

An operator can only add/remove views with state Active


A view designer can browse, edit views and update their state.

Note: There is no check on the valid changes between transition states in this version of Unified OSS Console.

102

1.17.3 Launches
A Launch can have the following states:
Identifier

Name

Description

UNDER_CONSTRUCTION

Under Construction

The launch is under construction and can only be used


by designer

WAITING_VALIDATION

Waiting Validation

The launch has been released and available for


testing

ACTIVE

Active

The launch is approved and available for usage

INACTIVE

Inactive

The launch is seen as obsolete and should not be used


anymore
Table 14: Launch States

An operator can only browse and execute launches with state Active
A platform administrator or view designer can browse, execute and update
launches.

Note: There is no check on the valid changes between transition states in this version of Unified OSS Console.

1.18 Security Audit


The UOC platform provides several security audit logs.The UOC Server tracks all
information related to:
Sessions: Log all information related to the user session (login, logout). It
is possible to see user id, date/time, and IP address to ease the audit.
Resource accesses: Log all resource accesses, operations, applications and
data requests. It tracks all actions done by a user on resources with
date/time, IP address, user id to ease the audit.
Please read chapter Security in the Installation and Configuration Guide to see how
to enable/disable logs and how to customize the audit policy and output format.

Important: These logs are only accessible to platform administrator and may content sensitive or private
information (IP address)

103

1.19 Logging
The UOC Server has a customizable logger to facilitate troubleshooting of the UOC
Platform. This log file supports several levels of log (info, warning, error, warning,
debug). Default level is warning. It is also possible to customize the format of the
logged line (layout pattern).
The UOC server logs all information related to:
Server activites: General logs related to the server.
HTTP requests : Log all http requests done by clients (web browsers)
Please read chapter Security in the Installation and Configuration Guide to see how
to enable/disable logs and how to customize the audit policy and output format.

Important: These logs can only be accessed by a platform administrator for troubleshooting reasons and may
content sensitive or private information, especially if the debug level is enabled.

104

Chapter 2
How to leverage Unified OSS Console
2.1 Install & use Value Packs
It is possible to only install and use the Unified OSS Console with pre-defined GUI.
Simple steps are:

Installation of the Unified OSS Console

Installation and configuration of existing plugins and value packs (domain specific)
The plug-in acts as a gateway between UOC & the OSS application
A Value pack is the set of defined data model/views/interactions for that OSS
application ( exist Out-of-the-box for NFVD, NFA, Service provisioner VPN,
CMS can develop new Value packs with a dedicated plug-in or re-use of
OSS Analytics generic plug-in)

Simple configuration (server host, port, security)

Open prepared default views from the value packs (automatically detected and imported by
UOC Server)

Unified OSS Console


Web Client

Unified OSS Console


GUI Server
Value Pack &
Plug-in

I/F abc

I/F def

OSS application x
Figure 104 UOC - Install and use value packs

No coding. The GUI is ready to use.

105

2.2 Reuse and enrich


It is possible to reuse and enrich the Unified OSS Console, i.e. extending views for/from one or
several value packs, and porivde multiple integrations with or without cross-applications navigation,
and execute external applications with context (launches)
Simple steps are:

Installation of the Unified OSS Console

Installation and configuration of plugin and value packs

Simple configuration (server host, port, security)

Open prepared default views from the value packs (automatically detected and imported by
UOC Server)

Configure or modify options and existing workspaces

Configure new launch applications

Create new views from available libraries

Create new workspaces and extend value pack views.

Share these extensions

Unified OSS Console


Web Client

Unified OSS Console


GUI Server
Value Pack &
Plug-in

I/F abc

I/F def

New views
New
workspaces
New
launches

OSS application x
Figure 105 UOC Reuse and enrich

106

No coding. Most of the configuration is done through GUI.

2.3 Reuse and extend


It is possible to reuse and extend the Unified OSS Console:

Extending components libraries to provide a new user experience to the end user.

Cover specific needs reusing the same GUI engine

Simple steps are :

Installation and configuration of plugin and value packs

Simple configuration (server host, port, security)

Open prepared default views from the value packs (automatically detected and imported by
UOC Server)

Configure or modify options and existing workspaces

Configure new launch applications

Create new views from available libraries

Create new workspaces and extend value pack views.

Develop new add-ons to extend libraries (New widgets, New layouts, New menus, New
themes)

Develop new plugins to plug another data server (new domain)

Share these extensions

Rebuild new views integrating existing components and new components

Package these add-ons to install on top of Unified OSS Console (if needed)

Provide a new user experience to the end user

New views
Unified OSS Console
Web Client

Unified OSS Console


GUI Server
Value Pack &
Plug-in

I/F abc

I/F def

OSS application x
Figure 106 UOC Reuse and enrich

New
workspaces

New
launches
Additional
widgets
Additional
layouts
Additional
themes
Additional
menus

Coding new components and extends add-ons libraries. Ready for reuse

107

Chapter 3
Getting Started
3.1 Pre-requisite
3.1.1

Web Browser
Only the following web browsers are supported:

3.1.2

Web Browser

Version

Microsoft Internet Explorer

10 or later

Mozilla Firefox
Google Chrome

V32 or later
V37 or later

Web site
http://windows.microsoft.com/enus/internet-explorer/download-ie
https://www.mozilla.org/en-US/firefox
https://www.google.com/chrome

Mobile Device
UOC is fully compliant with mobile device and provides responsive screens able to
adapat their display to the devices constraints.

Requirements

Minimal

Recommended

CPU
RAM
WIFI
Display Size

2 cores
1 GB

4 cores
2 GB

802.11b/g/n
any

802.11ac
Tablet 10

3.2 Start UOC


Using a web browser, you can start the Unified OSS Console with the following URL:
<Protocol>:<host>:<port>
Note: These parameters depend on the install and configuration done by the
platform administrator.
Ex: http://myhost.mydomain.com:3000
The locale of the web browser will be detected and used by the UOC if this locale is
available. If it is not the case, the English (En-us) will be used instead.

108

3.2.1

Force a specific locale


It is also possible to start the UOC using a specific locale and override the web
browser locale definition adding an option in the URL:
<Protocol>:<host>:<port>?lang=<language code>
Ex: http://myhost.mydomain.com:3000?lang=fr-fr will start the UOC with the
French (France) locale.
The language code can be found in http://www.w3.org/TR/ltli/

3.2.2

Open a workspace by default


It is also possible to start the UOC opening a specific workspace by adding an option
in the URL:
<Protocol>:<host>:<port>/workspaces/<workspaceId>
Ex: http://myhost.mydomain.com:3000/workspaces/OSSA-MYDAHBOARD will
start the UOC and open the given workspace (if you have been already
authenticated, else you will have to login first and then you will be redirected).

Note: The Workspace will use the default view set during the creation of the
workspace

It is also possible to start the UOC opening a specific workspace and load a specific
view (navigation view or dashboard view) adding an option in the URL:
<Protocol>:<host>:<port>/workspaces/<workspaceId>/views/<viewId>?<optio
nal input parameters>
Ex: http://myhost.mydomain.com:3000/workspaces/OSSAMYDAHBOARD/views/service-monitoring will start the UOC and open the given
workspace My Dashboard on the specific view Service Monitoring (if you have
been already authenticated, else you will have to login first and then you will be
redirected).
All these URLs are useful for integration in other applications (like portals) or to
predefine an access to a specific dashboard. It can also be useful if as a Add-ons
developer you are planning to implement your own menu item component to open
pre-defined workspaces and views (menu item is a list of pre-defined URLs).
It is also possible to add optional input parameters used by the workspace
Ex: http://myhost.mydomain.com:3000/workspaces/OSSAMYDAHBOARD/views/service-monitoring?param1=abc&param2=def will start
the UOC and open the given workspace My Dashboard on the specific view
Service Monitoring and define listed parameters with the given values.

109

Note: This URL can be used to ease integration into a JSR286 Portal to display
UOC content inside an external portal. Integrator will use the IFrame Portlet to
embed this URL.

3.3 Sign In
The first page is the authentication page. If you setup the authentication mode with
SAML, your identity provider will display the login page.
If you used the built-in local authentication (without SSO support), you will have
the internal login page (see below).

Figure 107 Sign in page with the local authentication mode

After entering the user name and your password, the user is authenticated and the
UOC application will uses the list of associated roles to customize and restrict the
user interface following the rights.
The main page is a page where the user can see available workspaces and click to
open one.

It is possible to customize the login page with a specific theme (wallpaper, logo,
colors), title and version. (See 1.15 User Preferences)

110

3.4 Main Menu


The main menu provides to the user access to all available actions for his profile.

Figure 108 Navigation Menu


The user can access to:
Administration (only for user administrator right)
o User Management
o Role Management
o Category Management
o Launch Category Management
o Launch Management
Add-ons (only for platform administrator right)
o Themes
o Layouts
o Widgets
o Menu Bars
o Menu Items
o Launch Keywords
o Modules
o Plugins
Packages (only for platform administrator right)
o All packages (or value packs) for all available plugins
o Dynamic list of plugins available. The user can see only associated
packages or value packs for the selected domain server.
Workspaces
o All workspaces available for the user
o Dynamic list of workspaces categories. The user can see only
associated workspaces associated to a selected categories.
<User name> of the connected user.
o Sign out to exit the application and go back to the sign in page
o My profile
o Language selection. By default, 2 languages are available.
English
French
o Theme selection. By default, 3 themes are available.
HP
Slate
United

111

<Notification> list all notified messages

3.5 Workspace Management


3.5.1

Overview
The workspace management page is the main page. It describes the list of available
workspaces the end user can access based on his profile.
Each workspace displays a name, description, and icon. Some of them are seen as
favorite and have an additional yellow star icon. The favorites (with yellow stars)
appear first in the page and all workspaces are sorted by name.

Figure 109 Workspace Information

Figure 110 Workspace Management

The user can navigate using the categories (or the breadcrumb) to quickly find
dashboards or can also use the search text field to dynamically filter all
workspaces on the page.

112

Breadcrumb
Workspace / category

Textual search
(Not case sensitive)

Figure 111 Workspace Management Using the search edit box

Clicking on a workspace will open the workspace and all its associated views. All
queries will be requested to the data server to display needed information.

Figure 112 Example of workspace - Total volume of data per Device Brand

113

3.5.2

Manage workspaces
There are many management operations available on workspaces if the user has
the right permissions (role based access control). It is possible to:
Create a new workspace
Clone an existing workspace to quickly create a new instance
Edit an existing workspace to modify its configuration
Delete an existing workspace
Export the workspace as workspace definition file (JSON)
By default, to avoid user errors, all these operations are not available on the
workspace management page. The user needs to active the management mode by
clicking on a toggle button called Manage Workspaces.

Activate the
management mode

Figure 113 Workspace Management Manage workspaces

Deactivate the
management mode
Figure 114 Workspace Management End workspace management

In the management mode, the workspace manager page is updated with a set of
workspace operations.
Available
workspace
operations

Figure 115 Workspace Management Workspace management operations

All search features related to the workspace manager are still available and the
user can continue to search and filter workspaces he is interested in.

114

The user can toggle the button End Management to disable workspace
management and go back to the simple workspace manager.

3.5.3

Create a new workspace


The user can create a new workspace by clicking on New workspace button.
A workspace has general options, a list of views displayed in this workspace, and
optionally a list of parameters with default values. These parameters are set
globally and are available for all widgets that have input parameters in their
configuration.
All these options are available in 3 different tab windows of the dialog box:
General
Header and footer views
Views
Parameters
Create button is active only if all mandatory fields are correctly filled.

3.5.3.1

Tab General
The tab General lists all the general options for the workspace.

Figure 116 Workspace Management New workspace (Tab General)

Field with (*) are mandatory to create a workspace (unique identifier,


presentation name and version)

Workspace icon represents the name of the picture/icon associated to the


workspace.

115

A workspace icon is a PNG file (48x48 pixels) stored in the following location:
<install_data_dir>/client/public/images/workspaces

State is set by default to under construction when you create a workspace. It can
be changed to make the workspace available for usage (see 1.17 Data Objects
States)
Roles is the list of roles defined on the platform and corresponding to the logged in
user. These roles define authorizations to open the workspace. No role Check
means everyone can access to it.

3.5.3.2

Tab Header and Footer Views


The Tab header and footer views are dedicated to select an optional and global
header and footer. These parts need to be specific view (menu, breadcrumb) the
user want to see in the new workspace and configure them.
The user can search in the list of available views. All these views have been created
by a View Designer and loaded in the GUI database.
He can explore them by name or expand packages to see associated views.

Search and explore


available views

Figure 117 Workspace Management New workspace (Tab Headers and footer
views)

3.5.3.3

116

Tab Views

The Tab view is dedicated to select the view the user want to see in the new
workspace and configure them.
The user can search in the list of available views. All these views have been created
by a View Designer and loaded in the GUI database.
He can explore them by name or expand packages to see associated views.

Search and explore


available views

Figure 118 Workspace Management New workspace (Tab Views)

A user can associate a view with the workspace in 3 steps:


1. Select the view from the list. The View details appears on the right panel
2. Click to Add button to add the selected view in the workspace
3. Configure, order and delete views in the bottom panel that display a
WYSIWYG view of the workspace (dashboard mode)

117

3.5.3.4

Tab Parameters
The user can define default value for global parameters (ex: start date, end date to
pre-defined dashboard on a specific time range, default customer id, default
options for widgets)
These parameters are useful input data for widgets. It is recommended to check
the documentation of used widgets to see what the supported parameters are.
Usually these parameters are set by a selection widget that exposes entered
criteria or data (ex: Time selector expose start / end time, time period granularity
)

Figure 119 Workspace Management New workspace (Tab Parameters)

These parameters can be checked using the HP Data Exchange inspector Widget
(see 1.8.5.12 Widget Data Exchange Inspector)

118

3.5.4

Clone a new workspace


The user can create a new workspace cloning an existing workspace. In such case,
he needs to give new unique identifier.

Figure 120 Workspace Management Clone workspace

A check if performed to grant the id is unique in the GUI database. An error


message is displayed and the clone button is disabled.

After a successful cloning, the user can see the workspace manager updated with
the new workspace. This new instance is ready for use and can be edited, deleted
without impacting the original workspace.

3.5.5

Edit an existing workspace


The user can edit an existing workspace and apply modification. He can add or
remove views, changes global options, or add/remove parameters exactly like
during the creation of a workspace.
Please refer to the 3.5.3 Create a new workspace for more details.

119

Figure 121 Workspace Management Edit workspace

After a successful edition, the user can see the workspace manager updated with
the modified workspace.

3.5.6

Delete an existing workspace


A user can delete a workspace by clicking on the associated link. The deletion is
done in the GUI database only and the workspace will no more be available for
usage.
A confirmation box is displayed and must be validated to continue the operation.
The deleted workspace cannot be restored and the delete operation cannot be
undone. It is only possible to restore this workspace if the workspace definition file
(JSON) has been saved as a backup (see 3.5.7 Export an existing workspace)

120

Figure 122 Workspace Management Delete workspace

3.5.7

Export an existing workspace


All operations on workspaces are saved in the GUI database. It means new
workspaces are only available in the GUI database and not available as a
standalone file.
An export operation is available to extract the workspace definition file (JSON)
associated to the workspace. It is useful for backup reason or to add a workspace
to pre-defined workspaces loaded during database initialization and keep its
definition this way.

Figure 123 Workspace Management Export workspace

A new web window is open with the JSON definition (Internet Explorer). The user
can copy/paste, print or save the contents if needed. If you are using Mozilla Firefox
or Google Chrome, the browser may directly download the file and save it on your
system.

Note: The local repository used to populate the GUI database with workspaces
are under the following location: <install_dir>/data/workspaces

121

3.5.8

Workspace Operations
If a workspace is open, the user can perform some workspace management
operations on it (available operations depend on the role based access control).
Close to the breadcrumb, a menu allows the user to:
Save (default operation)
Save As
Edit
Reset
Delete
Export
Export Report

Workspace operations
menu

Figure 124 Workspace Management Operations Menu

3.5.8.1

Save
The user can configure his widgets, select data, use dimension filters and save
this changes to the current workspace using the save button. (Default operation).

122

Figure 125 Workspace Management Operations Menu (Save)

3.5.8.2

Save As
The user can perform changes to the current workspace ant then use the button
called Save As and decide to create a new instance with the changes instead of
modifying the open one. In this case, the user needs to give a new unique identifier.

Figure 126 Workspace Management Operations Menu (Save As)

A check is performed to grant the id is unique in the GUI database. An error


message is displayed and the Create button is disabled.

After a successful Save As operation, the user can see the newly saved workspace
with changes that were made.

123

3.5.8.3

Edit
The operations menu provides a shortcut to the edit workspace. See 3.5.5 Edit an
existing workspace for more details.

3.5.8.4

Reset
The reset operation removes all configurations saved in the workspace and then
restore a simple workspace. It restores the initial configuration defined by the View
Designer.

Figure 127 Workspace Management Operations Menu (Reset)

3.5.8.5

Export
The Operations menu provides a shortcut to the Export workspace. See 3.5.7
Export an existing workspace for more details.

3.5.8.6

Export Report
The Operations menu provides a shortcut to the Export reports. See 1.11.2 Export
Report from the workspace for more details.

124

3.6 Widgets Management


Each widget can have its own widget toolbar to let the user access to features for
this specific widget.

3.6.1

Widget Toolbar
Execute contextual or
global launches

Open Analysis Tools


(select data)

Refresh / Cancel data


query

Configure

Full page

Export

Figure 128 Widget Management Widget Toolbar


A user can:
Execute launches (all launches associated to the tag configured for this
widget. (See 1.10.4 Launch Tags)
Configure a widget by opening its configuration panel
Request a data refresh and cancel refresh query if needed
Open the analysis tools to change the data selection, data filtering or top
value definitions. (See 3.6.3 Analysis tools)
Display this widget in full page
Some widgets also provide an export button to export the widget as an
image, as a PDF, or CSV (chart widgets)

Figure 129 Widget Toolbar - Export

125

3.6.2

Widget Configuration
If the View Designer enables the configuration of a widget and the widget
developer exposes a set of configuration available through the configure
button, the user can apply changes on top of the pre-defined configuration
of the view.
For example, the user can override the title, colors, alignment of objects,
tune specific style and save this version in his workspace (note: views
definitions are not impacted, all changes are saved inside the workspace
instance).
The user can click on the configure button to popup the configuration
panel. This panel is specific to each widget.

Figure 130 Example of chart widget configuration

Figure 131 Example of aggregation table widget configuration

126

Figure 132 Example of top table widget configuration

127

3.6.3

Analysis tools
For an operator with advanced skills, analysis dashboards are available, and
additional tools like the Analysis Tools can be popup from displayed widgets. The
operator can use a widgets select data button to open a dedicated tool for
analysis on the right-side of the screen.
The Analysis tools provide several features to select and aggregate dimensions,
refine, filter and extract the meaningful informations on a visual dashboard.

Figure 133 Widget Management - Analysis Tool

3.6.3.1

Multiple Data request


The analysis tool let the user select multiple data selection and filters.
The New data selection button is available to add a new data selection. This data
selection can get information from aother domain, packages, dimension, facts
and is totally independent from the other ones.
The user who has the right to configure the data selection can:
Browse existing data selection list
Add a new data selection
Edit an existing data selection

128

Delete an existing data selection


Apply changes to the selected widget

Add a new data selection

Figure 134 Analysis Tool enhancement (new data selection)

Tab selection to edit


the adta selection from
the available list of
data selection (ex: 3)

Delete an existing data


selection

Figure 135 Analysis Tool enhancement (browse /edit / delete data selection)

After applying the changes, the widget can be refresh and then multiple data
request will be executed by the right domain plugin to the right data server.
Multiple responses will be handled by the widget to provided advanced
representations and correlation of heterogeneous data.

129

3.6.3.2

Data Selection
The data selection allows the operator to select the dimensions and the associated
facts to analyze and display.
The data selection tool dynamically uses the list of installed value packs to provide
a unified view for the end user. It allows to select packages, and explore the
metadata to expose the content of a package. Each time an operator selects a
dimension or a fact, the tool dynamically refines the possible choices to always
grant a valid selection.
It is possible to manage selected dimensions in an aggregated way (query result
matching the aggregation of dimension) or use the list of dimension separately
(some widgets, like the aggregation table, are able to send multiple requests with
one dimension at a time to ease the table construction and display information by
column (help comparison of dimensions)
It is also possible to refine the list of facts by filtering only facts that are
compatible with the same unit. It is useful to select the right facts that have to be
displayed on the same charts.

130

Value pack selection

Aggregate
dimensions or use
them separately in
requests

Dimensions selection
and detail

Display facts having


a compatible unit or
all

Facts selection and


detail

Reminder of the
dimensions and facts
selection. It can be used to
unselect them by clicking
the x
Blue = dimension
Orange = fact
Figure 136 Analysis Tool Data Selection

131

3.6.3.3

Dimension Filter
The dimension filter allows the operator to apply filters to the selected data. The
query will be sent to the server with the filters to apply. The response will be
smaller and more useable. For example, the operator can analyze information
related to a specific brand, OS, technology, applying these filters, he can also
provide wildcards using the operators starts with, contains, ends with that
can help to isolate a group of data.
Configuration (Sorting
Ascending/Descending,
number of retrieved values)

Dimension selection

Dynamic search
based on text

Direct selection of filter to


apply. If you select values, it
disable the filtering starts
with,contains, and ends
with below.

Reminder of the
filters
It can be used to
unselect them
clicking the x

Wildcard selection (starts


with/contains/ends with)

Green = filter

Figure 137 Analysis Tool Dimension Filter


Filters can be set by a View Designer when building the view and it is also possible
to make the dimension filter not available as an analysis tool for the operator.

To use NOT operator, the user needs to click on the reminder and toggle the
option include to inverse the filter.

3.6.3.4

Top Filter
The top filter allows the operator to apply a top filter to the results returned by the
data server. This tool is useful for operators playing with a top table to refine the
number of results (ex: top 3 bandwidth consumer for the region X )

132

Figure 138 Example of Top Table with Top Filter (Analysis Tool)

The Top filter can select a top value and also request the worst first or the best first depending on the fact unit
and metadata definition. Sometimes, sorting can be ascending or descending depending on the metric. This
information is part of the package.

Figure 139 Analysis Tool Top Filter

3.6.3.5

Advanced options
Some advance options are available in a specific dialog box. It allows to specify
specific settings.
Aggregate facts: True | False to indicate if the facts need to be aggregated
in time or used sperarately.

133

It could be useful in a widget table to enable this option to see correctly the
result

Batchsize : number of returned item in the response


Offset: the first item offset to use for the response

Use these options very carefully. It can impact the returnd display and analysis

Figure 140 Analysis Tool Advanced options

134

3.7 User Management


If the administrator sets the authentication as local mode, a screen dedicated to
the user management is available through the UOC application. The user has to
have the user administrator rights to access to this administration page.

3.7.1

Users list

Figure 141 User Management (authentication local mode only)

The user administrator can see the list of users authorized for this UOC application.
He can search some specific users with the help of the search text field.

3.7.2

Delete an existing user


The user can also delete an existing user by clicking on the Delete button. A
confirmation box is always displayed before deleting a user.

Figure 142 User Management Delete an existing user

135

3.7.3

Edit an existing user


It is possible to edit an existing user and modify his user name, presentation name
description, password and his list of associated roles.

Figure 143 User Management Edit an existing user

Note : It is strongly recommended to use a complex password policy (mixing uppercase / lowercase,
numerical and special characters).
There is no evaluation check of your password to identify weak passwords.

136

3.7.4

Create a new user


The user administrator can also create a new user by clicking on the Add User
button.

Figure 144 User Management Create a new user

It is possible to see details of roles (they are displayed with tooltips).

For security reasons, it is not possible to delete users with the role User
Administrator and it is not possible to edit his permissions.

Note : It is strongly recommended to use a complex password policy (mixing uppercase / lowercase,
numerical and special characters).
There is no evaluation check of your password to identify weak passwords.

137

3.8 Role Management


The user administrator can access the role manager page to define, modify or
delete roles on the platform. These definitions (role identifier) must match the
Identity provider in SAML authentication mode. The reference is always the identity
provider, in any case, this defined roles are used to identify the list of permissions
that are used to adapt UOCs user interface by displaying or not some features
(what role can access to what user interface actions).
Please refer to the 1.4 Role Based Access Control (RBAC) for details about the role
based access and their associated Graphical User Interface permissions.

3.8.1

Roles list

Figure 145 Role Management


The user administrator can see the list of roles defined for the UOC application and
their fine grain permission concerning user interface access.
He can search some specific roles with the help of the search text field.

3.8.2

Delete an existing role


He can also delete an existing role by clicking on the Delete button. A
confirmation box is always displayed before deleting a role.

Figure 146 Role Management Delete an existing role

138

3.8.3

Edit an existing role


It is possible to edit an existing role and modify its unique identifier, name,
presentation name, description, password and its list of associated permissions.

Figure 147 Role Management Edit an existing role

139

3.8.4

Create a new role


A platform administrator can also create a new role by clicking on the Add Role
button, and define its permissions mapping.
Please refer to 1.4.2 Permissions for details of the available list of permissions.

Figure 148 Role Management Create a new role

140

3.9 Launch Management


A platform administrator has rights to manage the launch using the administration
menu Launch Management. He can easily, through the user interface, create new
launch categories to organize launches, delete unused launch categories, edit and
update their attributes.

3.9.1

Launch list

Figure 149 Launch Management


The platform administrator can see the list of launches available on the platform.
He can search some specific launch with the help of the search text field.

3.9.2

Delete an existing launch


He can also delete an existing launch by clicking on the Delete button. A
confirmation box is always displayed before deleting a launch.

Figure 150 Launch Management Delete an existing launch

141

3.9.3

Edit an existing launch


It is possible to edit an existing launch and modify its presentation name,
description, URL, general information and launch definition properties and its
associated icon (font awesome syntax).

Figure 151 Launch Management Edit an existing launch

142

Icons are using the iconic font from Font Awesome. Font Awesome gives you
scalable vector icons that can instantly be customized size, color, drop shadow,
and anything that can be done with the power of CSS3 (Cascading Style Sheet).

Figure 152 Launch Management Change icon

To see the available list of icons, please check the font cheat sheet
http://fortawesome.github.io/Font-Awesome/cheatsheet/ and get more details
on Fontawesomes official main page: http://fortawesome.github.io/FontAwesome/

143

3.9.4

Create a new launch


A platform administrator can also create a new launches by clicking on the Add
Launch button.

Figure 153 Launch Management Create a new launch

144

Default icon is font awesome rocket

Figure 154 Launch Management Default icon

3.10 Category Management


A platform administrator has rights to manage the workspace categories using the
administration menu Category Management. He can easily, through the user
interface, create new categories to organize workspaces, delete unused categories,
edit and update their attributes.

3.10.1 Category list

Figure 155 Category Management

The platform administrator can see the list of categories available for workspaces
on the platform. He can search some specific categories with the help of the search
text field.

145

3.10.2 Delete an existing category


He can also delete an existing category by clicking on the Delete button. A
confirmation box is always displayed before deleting a category.

Figure 156 Category Management Delete an existing category

3.10.3 Edit an existing category


It is possible to edit an existing category and modify its presentation name,
description, associated icon (font awesome syntax) and its list of associated roles.

Figure 157 Category Management Edit an existing category


Icons are using the iconic font from Font Awesome. Font Awesome gives you
scalable vector icons that can instantly be customized size, color, drop shadow,
and anything that can be done with the power of CSS3 (Cascading Style Sheet).

146

Figure 158 Category Management Change icon

To see the available list of icons, please check the font cheat sheet
http://fortawesome.github.io/Font-Awesome/cheatsheet/ and get more details
on Fontawesomes official main page: http://fortawesome.github.io/FontAwesome/

3.10.4 Create a new category


A platform administrator can also create a new category for workspaces by clicking
on the Add Category button.

Figure 159 Category Management Create a new category

147

Details of roles can be displayed with tooltips


Default icon is font awesome newspaper-o

Figure 160 Category Management Default icon

3.11 Launch Category Management


A platform administrator has rights to manage the launch categories using the
administration menu Launch Category Management. He can easily, through the
user interface, create new launch categories to organize launches, delete unused
launch categories, edit and update their attributes.

3.11.1 Launch Category list

Figure 161 Launch Category Management

The platform administrator can see the list of categories available for launches on
the platform. He can search some specific launch categories with the help of the
search text field.

3.11.2 Delete an existing launch category


He can also delete an existing category by clicking on the Delete button. A
confirmation box is always displayed before deleting a category.

148

Figure 162 Launch Category Management Delete an existing launch category

3.11.3 Edit an existing launch category


It is possible to edit an existing launch category and modify its presentation name,
description, and its associated icon (font awesome syntax).

Figure 163 Launch Category Management Edit an existing launch category


Icons are using the iconic font from Font Awesome. Font Awesome gives you
scalable vector icons that can instantly be customized size, color, drop shadow,
and anything that can be done with the power of CSS3 (Cascading Style Sheet).

Figure 164 Launch Category Management Change icon

To see the available list of icons, please check the font cheat sheet
http://fortawesome.github.io/Font-Awesome/cheatsheet/ and get more details
on Fontawesomes official main page: http://fortawesome.github.io/FontAwesome/

149

3.11.4 Create a new launch category


A platform administrator can also create a new category for launches by clicking on
the Add Launch Category button.

Figure 165 Launch Category Management Create a new launch category


Default icon is font awesome newspaper-o

Figure 166 Launch Category Management Default icon

150

3.12 Add-ons Management


A platform administrator can browse all the Add-ons for the client and the server
part using administration pages.
He can see all available layouts, all available widgets and active plugins on the UOC
platform.
These screens can ease troubleshooting after installation of new extensions and it
displays some useful information like version, date/time, description, author,
etcthat are defined in all descriptors of UOC graphical objects.

3.12.1 Layouts
The Add-ons Management for layouts allows to list and search available layouts in
the layout library. It displays the unique identifier, the name, the description, the
version and the specific icon of each layout.

Figure 167 Add-ons Management Browse layouts

151

3.12.2 Widgets
The Add-ons Management for widgets allows to list and search available widgets in
the widgets library. It displays the unique identifier, the name, the description, the
version and the specific icon of each widget.

Figure 168 Add-ons Management Browse widgets

3.12.3 Themes
The Add-ons Management for themes allows to list and search available themes
installed on the platform and available in the themes library. It displays the unique
identifier, the name, the description, the version and the specific icon of each
theme.

Figure 169 Add-ons Management Browse themes

152

3.12.4 Menu Bars


The Add-ons Management for menu bars allows to list and search available custom
menu bars installed on the platform and available in the menu bars library. It
displays the unique identifier, the name, the description, the version and the
specific icon of each menu bar.

Figure 170 Add-ons Management Browse menu bars

3.12.5 Menu Items


The Add-ons Management for menu items allows to list and search available
custom menu items installed on the platform and available in the menu items
library. It displays the unique identifier, the name, the description, the version and
the specific icon of each menu item. These menu items are integrated into menu
bars.

Figure 171 Add-ons Management Browse menu items

153

3.12.6 Plugins
The Add-ons Management for plugins allows to list and search available plugins
that have been set active on the platform. It displays the unique identifier, the
name, the description, the version and the specific icon of each plugin.

Figure 172 Add-ons Management Browse plugins

Clicking on a given plugin will open the list of available packages managed by this
plugin. This screen is detailed in the Packages Administration

3.12.7 Launch Keywords


The Add-ons Management for launch keywords allows to list and search available
keywords installed on the platform and available to use for launches. It displays
the unique identifier, the name, the description, the version and the specific icon of
each launch.

Figure 173 Add-ons Management Browse launch keywords

By default, the product provide a core launch keywords:


Launch Keywords

Description

<USER:ID>

Return the user identifier

<USER:NAME>

Return the user name

<USER:LANGUAGE>

Return the language of the user

<USER:THEME_ID>

Return the theme of the user

<USER:ROLES_ID>

Return the list of role identifier of the user

<WORKSPACE:CURRENT_ID>

Return the workspace identifier of the current open workspace

154

3.12.8 Modules
The Add-ons Management for modules allows to list and search available code
modules available on the platform. It displays the unique identifier, the name, the
description, the version and the specific icon of each module.

Figure 174 Add-ons Management Browse modules

See the graphical concept of Code module for more details about its usage by
widgets (see 1.8.9 Modules)

3.13 Packages Management


A platform administrator can browse all the installed packages using the package
Management page.

Figure 175 Package Management Browse packages

It allows to list and search available packages. It displays the unique identifier, the
name, the description, the version, the associated plugin and the specific icon of
each package.
Clicking on a given package (or value pack) will open a page containing details
about this package. This page facilitates the understanding of its metadata
definition, and pre-defined user interface data (views, workspaces).

155

The screen displays 2 tabs:


o Definition
o User Interface
The package definition tab displays the content of the value pack in term of
metadata (dimensions exposed to UOC, facts (metrics) associated to these
dimensions), some general information to track the name, date, version,
description of the package.
The user interface tab displays the list of available workspaces for this packages,
and the list of views pre-defined by a package and view designer. These views are
usually ready to use. This user interface data are optional and can be done later by
a View Designer.

Figure 176 Package Management Package definition

It is possible to explore the tree of dimensions and facts, and get some additional
information expanding the items.

156

Figure 177 Package Management Package user interface

The platform administrator can also click on the workspace to open dynamically
the selected workspace and see it in action.

Figure 178 Package Management Run a selected workspace from the package
management

Note: this workspace is part of the kit (plugin_sample, value_pack_sample, value_pack_sample_workspace1)


and provided as a sample. It does not require a data server and has been setup in demo mode (all JSON files have
been captured and saved for the demo without any data server running)

157

3.14 Profile Management


A logged user can access to his personal informations in the preferences menu, by
clicking on the My profile menu entry.

3.14.1 User information


The user can see his roles, login identifier, description and has the capability to
update his personal password (for local authentication mode only) and his current
authentication token with its expiration date.

Figure 179 Profile Management

Figure 180 Profile Management Manage account

3.14.2 User password


He also can change his password (in local authentication mode only), clicking to
Change password button.

158

Figure 181 Profile Management Change password (local Authentication Mode


only)

Note : It is strongly recommended to use a complex password policy (mixing uppercase / lowercase, numerical
and special characters). There is no evaluation check of your password to identify weak passwords.

3.14.1 Edit preferences


The user can modify some user preferences, like the preferred language, preferred
theme, preferred page after login (workspace manager or a pre-defined
workspace).

Figure 182 Profile Management Edit preferences (local Authentication Mode


only)

Note: Changes will occurred at the next login

159

S-ar putea să vă placă și