Documente Academic
Documente Profesional
Documente Cultură
User Guide
Edition: 1.0
June 2015
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
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 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
11
Typographical Conventions
Courier Font:
Pathnames
Italic Text:
Bold Text:
Associated Documents
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.
Problem reporting.
Training 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
15
Figure 4 Example Display of several metrics over the time based on a time
range
16
17
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
20
21
22
23
24
Combine/enrich existing
dashboards & views,
create new ones, ease
usability & navigation
Supporting features
Built with best practices for navigation, information drill down, up, actions
Value pack driven User Interface (intelligence is defined outside the product)
Available out of the box User Interfaces for HP NFV Director, HP NFV
Analytics and HP Service Provisioner VPN order Management products
Opened choice for integrating UOC southbound to OSS applications: can use
a UOC normalized, re-usable I/F or be entirely custom
SDK Fully extensive with Add-ons server or client side Plug anything,
display Everything
Flexible look & feel and theme rebranding to adapt to customers branding
(logo, wallpaper, title, links, themes, icons
Graphical editor to speed up creation of new views & dashboards & reports
25
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
Automatic audit/logging
https communications between client and server, server and database, and
server an OSS applications
Configure permissions
Per User configurable Workspace to define who access which view and what
information
Graphical extensions
Workspaces
Logging
Audit
Value pack (definition) is the added value ($): develop 1 times, sell and
configure N times on demand
Integrate to SSO
authentication,
configure security and
certificates
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
27
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.
Local / Built-in
Builtin
SAML (SSO)
Document
database
SAML
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
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)
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.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:
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
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.
Operation
Object
Identifier
Description
Workspace
Management
Browse
Workspace
browse_workspace
Create
Workspace
create_workspace
Delete
Workspace
delete_workspace
Save
Workspace
save_workspace
Edit
Workspace
edit_workspace
Create
View
create_view
Delete
View
delete_view
Edit
View
edit_view
Add
View
add_view
34
workspaces
Remove
View
remove_view
Configure
Widget
configure_widget
Configure
Datasource
configure_datasource
Configure
Filter
configure_filter
Configure
Top
configure_top
Export
Data
export_data
Export
Report
export_report
Browse
Launch
Category
browse_launch_category
Create
Launch
Category
create_ launch_category
Delete
Launch
Category
delete_ launch_category
Save
Launch
Category
save_ launch_category
Edit
Launch
Category
edit_ launch_category
Browse
Category
browse_category
Create
Category
create_ category
Delete
Category
delete_ category
Save
Category
save_ category
Edit
Category
edit_ category
Configure
Theme
configure_theme
Configure
Language
configure_language
Package
Management
Browse
Package
browse_package
Add-ons
Management
Browse
Layout
browse_layout
Browse
Widget
browse_widget
Browse
Plugin
browse_plugin
Browse
Menu item
browse_menu_item
Launch
Category
Management
Category
Management
Preferences
Management
35
User
Management
Role
Management
Platform
Management
Launch
Management
Browse
Menu bar
browse_menu_bar
Browse
Menu theme
browse_theme
Browse
Menu
module
browse_module
Browse
User
browse_user
Create
User
create_user
Delete
User
delete_user
Edit
User
edit_user
Browse
Role
browse_role
Create
Role
create_role
Delete
Role
delete_role
Edit
Role
edit_role
Edit
Setting
edit_setting
Browse
token
browse_token
Create
Launch
create_launch
Delete
Launch
delete_launch
Edit
Launch
edit_launch
Execute
Launch
execute_launch
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
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.
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.
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.
1.6.2
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.
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.
"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
Add-ons
Type
Needed skills
Estimated
Workload
Workspace
Data
~30 minutes
View
Data
~1 hour
Launch
Data
~30 minutes
Layout
Client
~ 1 hour
Widget
Client
~ 2 weeks
Theme
Client
~2 weeks
Menu Bar
Client
~1 hour
Menu Item
Client
~2 hours
Launch
Keyword
Client
~ 2 hours
Module
Client
~2 or 4 hours
Plugin
Server
~1or 2 weeks
Value Pack /
Package
Server
~2 or 4 weeks
43
<install_dir>server/addons
Data add-ons are imported and stored in the GUI database.
44
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.
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
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).
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)
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
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-chart-area-spline
hp-chart-column
HP Column Chart
hp-chart-column-range
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-chart-heatmap
HP Heatmap Chart
hp-chart-treemap
HP Treemap Chart
hp-chart-gauge
HP Gauge Chart
hp-chart-solid-gauge
hp-knob-gauge
hp-aggregation-table
HP Aggregation Table
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-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.
View
Data Server
UOC Server
Rest API
Widget
Any interface
Plugin X
Server X
Data
(Unified format)
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
All the serie returned by the request are displayed on the same graph.
54
1.8.5.4
55
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).
1.8.5.5
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.
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
58
1.8.5.7
Chart widgets
A large set of widgets dedicated for charting are available.
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.
1.8.5.9
60
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
1.8.5.10
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
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.
64
1.8.5.12
65
1.8.5.13
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
All the threshold definitions are done during the view design by a view designer
and cannot be changed at runtime
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.
68
69
Presentation icons
Title
Value
Threshold icon
-or Threshold colored badge
-or Threshold color
Presentation Icons
to visually identify
the metric
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
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
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.
After expand action, more details are displayed about the web score ant its other
associated metrics.
71
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 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.
74
1.8.5.17
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
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.
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.
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
1.8.5.21
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
78
1.8.5.22
Start an external
URL or update a
widget IFrame
It is possible to customize the title, group by category and collapse panel using the
configuration panel.
79
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/
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.
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.
83
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.
84
All sub-menus, called menu items, are available in add-ons and could be used
separately in another customized menu bar.
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
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
Description
(hp-menu-item-administration)
86
Allows a Platform
Administrator to browse
available add-ons on the
platform
Screenshot
Description
Allows a Platform
Administrator to browse the
available packages available
for the platform per domain
server.
(hp-menu-item-packages)
Screenshot
87
Description
(hp-menu-item-preferences)
Screenshot
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.
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
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
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
92
In order to maximize efficiency, the launch tags need to be well defined and
organized.
93
1.10.5.1
Group
Keyword
Description
UOC
HOST
UOC
PORT
DATE
NOW
1.10.5.2
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
95
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.
97
The end user can dynamically switch the language using the language selector in
the user menu of the navigation menu bar.
It is also possible to force a specific local in the start URL. See 3.2.1 Force a specific
locale for details.
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.
Default
Description
Title
Title of the application displayed in the title page, login page and
the main menu.
Version
2.1
Link
Language
En-us
Theme
hp
Menu Bars
hp-menu-bar
Show/Hide
True
99
Workspace
Management
Initial
Workspace
Figure 101 User Preferences (Theme slate, custom title, custom version, English)
Figure 102 User Preferences (Theme united, custom title, no version, French)
100
101
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
WAITING_VALIDATION
Waiting Validation
ACTIVE
Active
INACTIVE
Inactive
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
WAITING_VALIDATION
Waiting Validation
ACTIVE
Active
INACTIVE
Inactive
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
WAITING_VALIDATION
Waiting Validation
ACTIVE
Active
INACTIVE
Inactive
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.
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 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)
Open prepared default views from the value packs (automatically detected and imported by
UOC Server)
I/F abc
I/F def
OSS application x
Figure 104 UOC - Install and use value packs
105
Open prepared default views from the value packs (automatically detected and imported by
UOC Server)
I/F abc
I/F def
New views
New
workspaces
New
launches
OSS application x
Figure 105 UOC Reuse and enrich
106
Extending components libraries to provide a new user experience to the end user.
Open prepared default views from the value packs (automatically detected and imported by
UOC Server)
Develop new add-ons to extend libraries (New widgets, New layouts, New menus, New
themes)
Package these add-ons to install on top of Unified OSS Console (if needed)
New views
Unified OSS Console
Web Client
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
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
108
3.2.1
3.2.2
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¶m2=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).
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
111
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.
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)
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
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
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
3.5.3.1
Tab General
The tab General lists all the general options for 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
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.
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
)
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
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
119
After a successful edition, the user can see the workspace manager updated with
the modified workspace.
3.5.6
120
3.5.7
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
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
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.
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.
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.1
Widget Toolbar
Execute contextual or
global launches
Configure
Full page
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.
126
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.
3.6.3.1
128
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
Aggregate
dimensions or use
them separately in
requests
Dimensions 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
Reminder of the
filters
It can be used to
unselect them
clicking the x
Green = filter
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.
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
Use these options very carefully. It can impact the returnd display and analysis
134
3.7.1
Users list
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
135
3.7.3
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
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.1
Roles list
3.8.2
138
3.8.3
139
3.8.4
140
3.9.1
Launch list
3.9.2
141
3.9.3
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).
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
144
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
146
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/
147
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.
148
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
150
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.
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.
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.
152
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.
Clicking on a given plugin will open the list of available packages managed by this
plugin. This screen is detailed in the Packages Administration
Description
<USER:ID>
<USER:NAME>
<USER:LANGUAGE>
<USER:THEME_ID>
<USER:ROLES_ID>
<WORKSPACE:CURRENT_ID>
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.
See the graphical concept of Code module for more details about its usage by
widgets (see 1.8.9 Modules)
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
It is possible to explore the tree of dimensions and facts, and get some additional
information expanding the items.
156
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
157
158
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.
159