masterscope systemmanager g 7.1 webconsole · pdf file installation directory of...

MasterScope SystemManager G 7.1WebConsole Option

Function Reference Guide

First EditionAugust, 2017

NEC Corporation

DisclaimerThe copyrighted information noted in this document shall belong to NEC Corporation.

Copying or revising this document, in whole or in part, is strictly prohibited without thepermission of NEC Corporation.

This document may be changed without prior notice.

NEC Corporation shall not be liable for any technical or editing errors or omissions in thisdocument.

NEC Corporation shall not be liable for the accuracy, usability, or certainty of information notedin this document.

Trademarks• MasterScope is a registered trademark of NEC Corporation.

• Linux is a trademark or registered trademark of Linus Torvalds in the United States of Americaand other countries.

• Red Hat is a trademark or registered trademark of Red Hat, Inc. in the United States and othercountries.

• Debian is a registered trademark of Software in the Public Interest, Inc.

• PostgreSQL is a trademark or registered trademark of PostgreSQL in the United States ofAmerica and other countries.

• Intel and Itanium are trademarks or registered trademarks of Intel Corporation in the UnitedStates of America and other countries.

• Apache, Apache Tomcat, and Tomcat are trademarks or registered trademarks of ApacheSoftware Foundation.

• Java is a registered trademark of Oracle Corporation and its subsidiaries and affiliates in theUnited States of America and other countries.

• Microsoft and Windows are registered trademarks of Microsoft Corporation in the United Statesand other countries. In addition, trademarks of Microsoft products included in this guide areregistered trademarks of Microsoft Corporation in the United States and other countries.

• Adobe, the Adobe logo, and Acrobat are either registered trademarks or trademarks of AdobeSystems Incorporated in the United States and/or other countries.

• WSO2 and the WSO2 logo are trademarks of WSO2.

• Microsoft and Windows are registered trademarks of Microsoft Corporation in the United Statesand other countries. In addition, trademarks of Microsoft products included in this guide areregistered trademarks of Microsoft Corporation in the United States and other countries.

Other system names, company names, and product names in this document are trademarks orregistered trademarks of their respective companies.

Note the ® mark and the ™ mark are not indicated in this document.

i

Notes on exporting this productThis product (including software) may be applicable to the controlled cargo regulated by the ForeignExchange and Foreign Trade Law. To export the product to outside of Japan, the export permit fromJapanese government is required. If you require documents from NEC in order to obtain an exportlicense, please contact the dealer where you purchased your MasterScope product, or your local NECsales office.

ii

PrefaceTarget readers and objective

This document is intended for system administrators who use SystemManager G to performoperation management, and describes the management method.

Overview of the documentThis chapter describes how to use SystemManager G.

Notation rules of this documentIn this document, important notes and related information are described as follows:

NoteNotes, warnings, and supplements on functions, operations, and settings are described.

TipAdditional information and reference information are described.

Notation listThe following conventions apply to this document.

Notation How to use Example

[ ] Squarebrackets

Placed before and after anitem (such as a text box,check box, or tab) on thescreen

Enter the machine name in the [Machine Name] text box.[All] check box

" " Doublequotationmarks

Placed before and after ascreen name (such as a dialogbox or window), and a nameof other manuals

"Setting" window"Installation Guide"

[ ] Squarebrackets in thecommand line

Indicates that thespecification of the value in[ ] can be omitted.

add [/a] Gr1

Monospacefont (couriernew)

Output from the command-line (such as a message orprompt)

Execute the following command:replace Gr1

Italicizedmonospace font(courier new)

Indicates the items to bereplaced with a valid valueand input by users.If the value contains anyspaces, surround it with "" (double quotation marks).

add GroupNameInstallPath=”Install Path”

iii

Notation How to use Example

JSON example To improve readability, linebreaks and indentation areadded to the displayed JSONexamples.

{ "ID": [ "45ed3512" ], "Manager": { "ErrorMessage": "", "Name": "localhost", "Status": 200, "StatusCode": 200 }}

Definitions

Definition Description

<install-folder> Installation directory of SystemManager G WebConsole Option.

<wso2-install-folder> Installation directory of WSO2(SystemManager G WebConsole Option).

<manager-install-folder>

Installation directory of SystemManager G Manager

<Tomcat-install-folder>

Installation directory of Application Server

iv

ContentsChapter 1. How to Operate the Console .................................................................................... 1

1.1 Basic operations ....................................................................................................................21.1.1 User types and roles ....................................................................................................21.1.2 Login...........................................................................................................................2

1.1.2.1 Connecting to the GUI ......................................................................................21.1.2.2 Logging in to the GUI .......................................................................................2

1.1.3 Screen configuration ...................................................................................................31.1.4 Login user operation ...................................................................................................4

1.1.4.1 Checking the detailed login user information ....................................................41.1.4.2 Changing the login user information .................................................................41.1.4.3 Changing the login password.............................................................................5

1.2 Administrator operations.......................................................................................................61.2.1 Dashboard ...................................................................................................................6

1.2.1.1 Displaying the dashboard and widgets...............................................................61.2.1.2 Adding a widget to the dashboard .....................................................................71.2.1.3 Removing a widget from the dashboard ............................................................91.2.1.4 Changing the display order and size of the widgets on the dashboard..............101.2.1.5 Saving the settings of the widget on the dashboard..........................................111.2.1.6 Discarding the settings of the widget on the dashboard ...................................12

1.2.2 Tenant information (administrator)............................................................................131.2.2.1 Tenant management (administrator) ................................................................131.2.2.2 User management............................................................................................17

1.2.3 Monitoring (administrator) ........................................................................................241.2.3.1 System message ..............................................................................................24

1.2.4 Service management .................................................................................................321.2.4.1 Notice management.........................................................................................32

1.3 User operation.....................................................................................................................371.3.1 Dashboard .................................................................................................................37

1.3.1.1 Adding a widget to the dashboard ...................................................................381.3.1.2 Removing a widget from the dashboard ..........................................................391.3.1.3 Changing the display order and size of the widgets on the dashboard..............411.3.1.4 Saving the settings of the widget on the dashboard..........................................421.3.1.5 Discarding the settings of the widget on the dashboard ...................................43

1.3.2 Tenant information (user) ..........................................................................................441.3.2.1 Tenant management (user)...............................................................................451.3.2.2 User management............................................................................................47

1.3.3 Monitoring (user) ......................................................................................................531.3.3.1 Node ...............................................................................................................531.3.3.2 Message ..........................................................................................................641.3.3.3 Message list.....................................................................................................75

1.3.4 Service management .................................................................................................781.3.4.1 Notice management (user)...............................................................................79

Chapter 2. Command Reference .............................................................................................. 842.1 API gateway operation command (msc_apigateway_cmd)..................................................85

2.2 License command (msc_license_cmd) ................................................................................86

v

Appendix A. How to Start up and Stop the Product .............................................................. 89A.1 How to start up and stop the manager.................................................................................89

Appendix B. Revision History................................................................................................... 90

vi

List of FiguresFigure 1-1 Login dialog box.......................................................................................................3Figure 1-2 Dashboard screen......................................................................................................3Figure 1-3 Screen configuration .................................................................................................3Figure 1-4 Login user operation dialog box................................................................................4Figure 1-5 Login user operation dialog box................................................................................4Figure 1-6 [Log-in User Detail] screen.......................................................................................4Figure 1-7 Login user operation dialog box................................................................................5Figure 1-8 [Edit Log-in User(Form)] screen...............................................................................5Figure 1-9 [Edit Log-in User(Confirmation)] screen ..................................................................5Figure 1-10 Login user operation dialog box................................................................................6Figure 1-11 [Change Log-in Password(Form)] screen..................................................................6Figure 1-12 [Change Log-in Password(Confirmation)] screen .....................................................6Figure 1-13 Displaying the dashboard and widgets ......................................................................7Figure 1-14 [Dashboard] screen with the customize menu ...........................................................7Figure 1-15 [Add widget] dialog box ...........................................................................................7Figure 1-16 [Add widget] dialog box ...........................................................................................8Figure 1-17 Displaying the dashboard and a new widgets ............................................................8Figure 1-18 [Dashboard] screen ...................................................................................................9Figure 1-19 Removing a widget from the dashboard ....................................................................9Figure 1-20 [Confirmation - remove widget] dialog box ..............................................................9Figure 1-21 [Dashboard] screen .................................................................................................10Figure 1-22 Changing the display order of the widgets ..............................................................10Figure 1-23 Changing the display order of the widgets ..............................................................11Figure 1-24 Changing the display size of the widgets.................................................................11Figure 1-25 Saving the settings of the widget.............................................................................12Figure 1-26 [Confirmation - save widgets] dialog box ...............................................................12Figure 1-27 Discarding the settings of the widget ......................................................................13Figure 1-28 [Confirmation - cancel] dialog box .........................................................................13Figure 1-29 [Tenant Management] screen ..................................................................................14Figure 1-30 [Tenant detail] screen ..............................................................................................14Figure 1-31 [Tenant detail] screen ..............................................................................................15Figure 1-32 [Modify a tenant(Form)] screen ..............................................................................15Figure 1-33 [Choose a tenant administrator] screen....................................................................16Figure 1-34 [Modify a tenant(Confirmation)] screen..................................................................16Figure 1-35 [Tenant detail] screen (Deletion) .............................................................................17Figure 1-36 [Delete a tenant(Confirmation)] dialog box.............................................................17Figure 1-37 [User Management] screen .....................................................................................17Figure 1-38 [User Management] screen .....................................................................................18Figure 1-39 [Create User(Form)] screen.....................................................................................19Figure 1-40 [Create User(Confirmation)] screen ........................................................................20Figure 1-41 [User detail] screen .................................................................................................20Figure 1-42 [User detail] screen .................................................................................................21Figure 1-43 [Modify User(Form)] screen ...................................................................................21Figure 1-44 [Change User(Confirmation)] screen ......................................................................22Figure 1-45 [User detail] screen .................................................................................................22

vii

Figure 1-46 [Changing password(Form)] screen ........................................................................23Figure 1-47 [Changing password(Confirmation)] screen............................................................23Figure 1-48 [User detail] screen .................................................................................................23Figure 1-49 [Delete User(Confirmation)] dialog box..................................................................24Figure 1-50 [System Message] screen ........................................................................................24Figure 1-51 System Message panel and messages ......................................................................25Figure 1-52 Search condition .....................................................................................................26Figure 1-53 Message details.......................................................................................................28Figure 1-54 Changing the confirmation status - method 1 ..........................................................29Figure 1-55 Changing the confirmation status - method 2 ..........................................................30Figure 1-56 [Confirm] dialog box ..............................................................................................30Figure 1-57 Assigning a mark - method 1 ..................................................................................30Figure 1-58 Assigning a mark - method 2 ..................................................................................31Figure 1-59 [Marking up] dialog box .........................................................................................31Figure 1-60 Editing the comment ...............................................................................................31Figure 1-61 [Edit comment] dialog box......................................................................................32Figure 1-62 [Notice management] screen...................................................................................32Figure 1-63 [Notice management] screen...................................................................................33Figure 1-64 [Submit a new notice(Form)] screen .......................................................................33Figure 1-65 [Select scope of disclosure] dialog box ...................................................................34Figure 1-66 [Submit a new notice(Confirmation)] screen...........................................................35Figure 1-67 [Notice details] screen.............................................................................................35Figure 1-68 [Notice details] screen.............................................................................................36Figure 1-69 [Edit notice(Form)] screen ......................................................................................36Figure 1-70 [Edit notice(Confirmation)] screen..........................................................................37Figure 1-71 [Notice details] screen.............................................................................................37Figure 1-72 [Delete notice(Confirmation)] screen ......................................................................37Figure 1-73 [Dashboard] screen with the customize menu .........................................................38Figure 1-74 [Add widget] dialog box .........................................................................................38Figure 1-75 [Add widget] dialog box .........................................................................................39Figure 1-76 Displaying the dashboard and a new widgets ..........................................................39Figure 1-77 [Dashboard] screen .................................................................................................40Figure 1-78 Removing a widget from the dashboard ..................................................................40Figure 1-79 [Confirmation - remove widget] dialog box ............................................................40Figure 1-80 [Dashboard] screen .................................................................................................41Figure 1-81 Changing the display order of the widgets ..............................................................41Figure 1-82 Changing the display order of the widgets ..............................................................42Figure 1-83 Changing the display size of the widgets.................................................................42Figure 1-84 Saving the settings of the widget.............................................................................43Figure 1-85 [Confirmation - save widgets] dialog box ...............................................................43Figure 1-86 Discarding the settings of the widget ......................................................................44Figure 1-87 [Confirmation - cancel] dialog box .........................................................................44Figure 1-88 [Tenant Management] screen ..................................................................................45Figure 1-89 [Tenant detail] screen ..............................................................................................45Figure 1-90 [Tenant detail] screen ..............................................................................................46Figure 1-91 [Modify a tenant(Form)] screen ..............................................................................46Figure 1-92 [Choose a tenant administrator] screen....................................................................46

viii

Figure 1-93 [Modify a tenant(Confirmation)] screen..................................................................47Figure 1-94 [User Management] screen .....................................................................................47Figure 1-95 [User Management] screen .....................................................................................48Figure 1-96 [Create User(Form)] screen.....................................................................................48Figure 1-97 [Create User(Confirmation)] screen ........................................................................49Figure 1-98 [User detail] screen .................................................................................................50Figure 1-99 [User detail] screen .................................................................................................50Figure 1-100 [Modify User(Form)] screen ...................................................................................51Figure 1-101 [Change User(Confirmation)] screen ......................................................................51Figure 1-102 [User detail] screen .................................................................................................51Figure 1-103 [Changing password(Form)] screen ........................................................................52Figure 1-104 [Changing password(Confirmation)] screen............................................................52Figure 1-105 [User detail] screen .................................................................................................52Figure 1-106 [Delete User(Confirmation)] dialog box..................................................................53Figure 1-107 Node screen ............................................................................................................54Figure 1-108 Node screen when the URL parameters are specified (http://ADDRESS:PORT/

portal/cloudportal/monitoring/topology?view=msg&node=<nodeID>&msg=<message number>) ..............................................................................55

Figure 1-109 [Node List] panel and group tree.............................................................................56Figure 1-110 [Note List] panel .....................................................................................................56Figure 1-111 [Node Detail] dialog box.........................................................................................57Figure 1-112 [Node List] panel and status panel ..........................................................................58Figure 1-113 [Performance Graph] screen....................................................................................59Figure 1-114 Creating a group .....................................................................................................60Figure 1-115 [Node List - Create group] dialog box.....................................................................60Figure 1-116 Changing the group name .......................................................................................61Figure 1-117 [Node List - Edit group name] dialog box ...............................................................61Figure 1-118 Moving a group ......................................................................................................62Figure 1-119 [Node List - Move group] dialog box......................................................................62Figure 1-120 Deleting a group .....................................................................................................63Figure 1-121 [Node List - Delete group] dialog box.....................................................................63Figure 1-122 Moving a node ........................................................................................................64Figure 1-123 [Node List - NodeMove] dialog box .......................................................................64Figure 1-124 Message screen .......................................................................................................65Figure 1-125 [Number of Messages by Severity] panel................................................................67Figure 1-126 [Category List] panel ..............................................................................................68Figure 1-127 [Category List - Add] dialog box ............................................................................68Figure 1-128 [Category List - Rename] dialog box ......................................................................69Figure 1-129 [Category List - Delete] dialog box.........................................................................69Figure 1-130 [Filter List] screen...................................................................................................69Figure 1-131 [Add Message Filter] screen ...................................................................................72Figure 1-132 [Filter Order] screen................................................................................................73Figure 1-133 [Filter List] screen...................................................................................................74Figure 1-134 [Delete Filter] dialog box ........................................................................................75Figure 1-135 Message panel and messages ..................................................................................75Figure 1-136 Search condition .....................................................................................................76Figure 1-137 Message details.......................................................................................................78Figure 1-138 [Notice management] screen...................................................................................79

ix

Figure 1-139 [Notice management] screen...................................................................................80Figure 1-140 [Submit a new notice(Form)] screen .......................................................................80Figure 1-141 [Submit a new notice(Confirmation)] screen...........................................................81Figure 1-142 [Notice details] screen.............................................................................................81Figure 1-143 [Notice details] screen.............................................................................................82Figure 1-144 [Edit notice(Form)] screen ......................................................................................82Figure 1-145 [Edit notice(Confirmation)] screen..........................................................................82Figure 1-146 [Notice details] screen.............................................................................................83Figure 1-147 [Delete notice(Confirmation)] screen ......................................................................83

x

List of TablesTable 1-1 User types .................................................................................................................2Table 1-2 Roles.........................................................................................................................2Table 1-3 Item list ([Edit Log-in User(Form)] screen) ..............................................................5Table 1-4 Item list ([Add widget] dialog box)...........................................................................8Table 1-5 Item list ([Tenant Management] screen) ..................................................................14Table 1-6 Item list ([Tenant search] screen) ............................................................................14Table 1-7 Item list (Tenant detail) ...........................................................................................15Table 1-8 Item list ([Modify a tenant(Form)] screen)..............................................................15Table 1-9 Item list ([User Management] screen) .....................................................................17Table 1-10 Item list ([User search] screen) ...............................................................................18Table 1-11 Item list ([Create User(Form)] screen) ....................................................................19Table 1-12 Item list (User detail) ..............................................................................................20Table 1-13 Item list (System Message panel)............................................................................25Table 1-14 Item list (Message list)............................................................................................25Table 1-15 Item list (Search condition) .....................................................................................26Table 1-16 Item list (Message details) ......................................................................................28Table 1-17 Item list (Notice management) ................................................................................32Table 1-18 Item list ([Notice Search] screen)............................................................................32Table 1-19 Item list (Submit a new notice(Form)) ....................................................................33Table 1-20 Item list (Notice details)..........................................................................................35Table 1-21 Item list ([Add widget] dialog box).........................................................................38Table 1-22 Item list ([Tenant Management] screen) ..................................................................45Table 1-23 Item list (Tenant detail) ...........................................................................................45Table 1-24 Item list ([User Management] screen) .....................................................................47Table 1-25 Item list ([User search] screen) ...............................................................................47Table 1-26 Item list ([Create User(Form)] screen) ....................................................................48Table 1-27 Item list (User detail) ..............................................................................................50Table 1-28 URL parameters......................................................................................................54Table 1-29 Item list ([Node List] panel and group tree) ............................................................56Table 1-30 Item list (Node List)................................................................................................57Table 1-31 Item list ([Node Detail] dialog box) ........................................................................57Table 1-32 Item list (Status panel) ............................................................................................58Table 1-33 Item list (Performance graph) .................................................................................59Table 1-34 Item list (Create group) ...........................................................................................61Table 1-35 Item list (Edit group name) .....................................................................................61Table 1-36 URL parameters......................................................................................................65Table 1-37 Item list (category list) ............................................................................................66Table 1-38 Item list (Category List - Add) ................................................................................68Table 1-39 Item list (Category List - Rename) ..........................................................................69Table 1-40 Item list (Filter list) .................................................................................................70Table 1-41 Item list (Filter detail) .............................................................................................70Table 1-42 Item list (Add Message Filter).................................................................................72Table 1-43 Item list (Filter List)................................................................................................74Table 1-44 Item list ([Confirmation cancel] dialog box) ...........................................................74Table 1-45 Item list ([Confirmation apply] dialog box).............................................................74

xi

Table 1-46 Item list (Message panel) ........................................................................................75Table 1-47 Item list (Message list)............................................................................................75Table 1-48 Item list (Search condition) .....................................................................................76Table 1-49 Item list (Message details) ......................................................................................78Table 1-50 Item list (Notice management) ................................................................................79Table 1-51 Item list ([Notice Search] screen)............................................................................79Table 1-52 Item list (Submit a new notice(Form)) ....................................................................80Table 1-53 Item list (Notice details)..........................................................................................81

xii

Chapter 1. How to Operate the ConsoleThis chapter describes the Web GUI of SystemManager G.

Contents1.1 Basic operations ...........................................................................................................................2

1.2 Administrator operations..............................................................................................................6

1.3 User operation............................................................................................................................37

Chapter 1. How to Operate the Console

1

1.1 Basic operationsThis section describes the basic operations.

1.1.1 User types and rolesThe available screens and operations differ depending on the user type and role.

Table 1-1 User types

Function Operation SystemAdministra

tor

TenantManager

TenantUser

Dashboard Displaying and customizing thedashboard

Y Y Y

Tenant management Displaying a list and details of tenants Y Y N

Tenant management Registering a tenant Y N N

Tenant management Changing a tenant Y Y N

Tenant management Deleting a tenant Y N N

User management Displaying a list and details of users Y Y Y

User management Registering, changing, and deleting a user Y Y N

Notice management Displaying, registering, changing, anddeleting a list and details of notices

Y Y N

Table 1-2 Roles

Function Operation MonitoringAdministra

tor

MonitoringOperator

MonitoringUser

Monitoring Displaying, registering, changing, anddeleting the monitoring settings andoperation settings

Y N N

Monitoring Displaying the monitoring state Y Y Y

Monitoring Handling messages (changing the state,marking, and editing a comment)

Y Y N

1.1.2 LoginThis section describes how to log in to the GUI.

1.1.2.1 Connecting to the GUIAccess the following URLs from a browser.

http://<Server name or server IP address>:<Port number> (Default: 12080)/portal

https://<Server name or server IP address>:<Port number> (Default: 12443)/portal

1.1.2.2 Logging in to the GUIThis section describes how to log in to the GUI.

1. Start the GUI, enter the user ID and password, and then click the [Login] button.

Both the user ID and password of the built-in user is "admin".


2

NoteAfter logging in to the GUI for the first time, register a new system administrator and disable thebuilt-in user (admin).For details about registering a user, see "1.2.2.2.2 Registering a user (administrator) (page 18)".For details about disabling the built-in user, see "1.2.2.2.4 Changing the user information (page21)".

Figure 1-1 Login dialog box

2. The dashboard screen is displayed.

Figure 1-2 Dashboard screen

Note- If you enter an incorrect password 10 times, the account is locked and you will not be able to log in.* Until the 9th password input failure, the failure count will be reset after 10 minutes.The system administrator and the administrator of the tenant to which the locked login user belongs canunlock the user account by enabling the login user.- If all administrator users are locked or disabled and cannot log in to the GUI, run the following commandto enable the admin user.

>psql -f [installation directory]\portal\sql\enable_admin.sql -U msc_portal msc_portal"

1.1.3 Screen configuration

Figure 1-3 Screen configuration


3

(1) Displays the tenant name.

(2) Displays the name of the user who has logged in.

(3) Logs out by clicking this button.

(4) Selects the screen that you want to display from the menu.

1.1.4 Login user operationThe login user operation dialog box is displayed by clicking the login user name.

Figure 1-4 Login user operation dialog box

1.1.4.1 Checking the detailed login user information1. Click [Detail] on the login user operation dialog box.


2. The [Log-in User Detail] screen is displayed.

Figure 1-6 [Log-in User Detail] screen

1.1.4.2 Changing the login user informationThis section describes how to change the login user information.

1. On the dashboard screen, click the user name and then click [Edit].


4


2. The [Edit Log-in User(Form)] screen is displayed. Edit the items by referring to the followingtable and then click the [Next] button.

Figure 1-8 [Edit Log-in User(Form)] screen

Table 1-3 Item list ([Edit Log-in User(Form)] screen)

Item name Input rule Description

Name Up to 1024 characters Enter a name (user name).

e-mail E-mail format Enter an email address.

Notes Up to 255 characters Enter notes.

3. The [Edit Log-in User(Confirmation)] screen is displayed. Click the [Confirm] button to applythe changes.

Figure 1-9 [Edit Log-in User(Confirmation)] screen

1.1.4.3 Changing the login passwordThis section describes how to change the login password.

1. On the dashboard screen, click the user name and then click [Change Password].


5


2. The [Change Log-in Password(Form)] screen is displayed. Specify a password using 6 to 16characters, and then click the [Next] button.

Figure 1-11 [Change Log-in Password(Form)] screen

3. The [Change Log-in Password(Confirmation)] screen is displayed. Click the [Submit] buttonto apply the change.

Figure 1-12 [Change Log-in Password(Confirmation)] screen

1.2 Administrator operationsThis section describes the functions that are operated by the system administrator.

1.2.1 DashboardA user can arrange widgets on the dashboard screen freely.

The widget types that can be arranged differ depending on the server setting and user authority.

1.2.1.1 Displaying the dashboard and widgetsBy selecting [Dashboard] from the menu, the dashboard is displayed and widgets are displayed onthe dashboard.


6

Figure 1-13 Displaying the dashboard and widgets

Widgets can be handled by using a mouse.

To return to the initial display of widgets after handling them, use the reload function of a browser.

1.2.1.2 Adding a widget to the dashboardThis section describes how to add a widget to the dashboard.

1. On the dashboard screen, click [Customize].

The dashboard screen changes to customize mode and the customize menu is displayed.

Figure 1-14 [Dashboard] screen with the customize menu

2. On the dashboard screen, click [Add widget].

The [Add widget] dialog box is displayed.

Figure 1-15 [Add widget] dialog box

3. On the [Add widget] dialog box, enter the information of the widget that you want to add.


7

Table 1-4 Item list ([Add widget] dialog box)

Item name Input rule Initial value Description

Widget title 0 to 64characters

- Name to be displayed as a widget titleMultiple widgets with the same name can beregistered.If a widget name is omitted, "(No name)" isdisplayed.

URL - - Select the URL that you want to display as a widget.Multiple widgets with the same URL can beregistered.

URL parameters 0 to 2048characters

- Specify an option parameter that you want to specifyfor the widget URL.The format is "key=value". When specifyingmultiple parameters, separate them with "&".The character string must have been encoded.

4. Click [OK].

The [Add widget] dialog box is closed.


A new widget is displayed below the displayed widgets on the dashboard.

Figure 1-17 Displaying the dashboard and a new widgets

After adding widgets, click [Save]. For details about the procedure, see "1.2.1.5 Saving the settingsof the widget on the dashboard (page 11)".


8

1.2.1.3 Removing a widget from the dashboardThis section describes how to remove a widget from the dashboard.


The dashboard screen changes to customize mode.

Figure 1-18 [Dashboard] screen

2. Click [x] displayed at the upper right of the widget that you want to remove.

Figure 1-19 Removing a widget from the dashboard

The [Confirmation - remove widget] dialog box is displayed.

Figure 1-20 [Confirmation - remove widget] dialog box

3. Check the contents of the [Confirmation - remove widget] dialog box. If you want to removethe displayed widget, click [OK].


9

Otherwise, click [Cancel].

The [Confirmation - remove widget] dialog box is closed.

The selected widget is removed.

After removing the widget, click [Save]. For details about the procedure, see "1.2.1.5 Saving thesettings of the widget on the dashboard (page 11)".

1.2.1.4 Changing the display order and size of the widgets onthe dashboard

This section describes how to change the display order and size of the widgets displayed on thedashboard.




2. To change the widget display order, drag and drop the desired widget with a mouse.

Figure 1-22 Changing the display order of the widgets

The widget display order is changed.


10


3. To change the widget size, drag the frame of the desired widget with a mouse.

• To change the height of the widget, drag the bottom frame of the desired widget with amouse.

• To change the width of the widget, drag the right frame of the desired widget with amouse.

• To change the height and width of the widget, drag the bottom right corner of the desiredwidget with a mouse.

The widget size is changed.

Figure 1-24 Changing the display size of the widgets

After changing the widget display order or size, click [Save]. For details about the procedure, see"1.2.1.5 Saving the settings of the widget on the dashboard (page 11)".

1.2.1.5 Saving the settings of the widget on the dashboardThis section describes how to save the settings of the widgets on the dashboard.

It is assumed that the dashboard is already in customize mode and the widgets are being handled. Fordetails about how to handle the widgets, see the following:


11

• "1.2.1.2 Adding a widget to the dashboard (page 7)"

• "1.2.1.3 Removing a widget from the dashboard (page 9)"

• "1.2.1.4 Changing the display order and size of the widgets on the dashboard (page 10)"

1. On the dashboard screen, click [Save].

The [Confirmation - save widgets] dialog box is displayed.

Figure 1-25 Saving the settings of the widget

2. Check the contents of the [Confirmation - save widgets] dialog box. If you want to save thedisplayed contents, click [OK].

Figure 1-26 [Confirmation - save widgets] dialog boxOtherwise, click [Cancel].

The [Confirmation - save widget] dialog box is closed.

Information of the added or removed widget and the widget display order and size are saved.

1.2.1.6 Discarding the settings of the widget on the dashboardThis section describes how to discard the setting of the widgets on the dashboard.





1. On the dashboard screen, click [Cancel].


12

Figure 1-27 Discarding the settings of the widget

The [Confirmation - cancel] dialog box is displayed.

Figure 1-28 [Confirmation - cancel] dialog box

2. Check the contents of the [Confirmation - cancel] dialog box. If you want to discard thedisplayed contents, click [OK].


The [Confirmation - cancel] dialog box is closed.

The widget edit contents that have not been saved are discarded and the widget display returns to thelast saved state. Information before the last saving are not discarded.

1.2.2 Tenant information (administrator)This section describes the [Tenants] menu.

The [Tenants] menu provides the following functions:

- Tenant management: Checking, editing, and deleting the registered tenant

- User management: Registering a new user, checking, editing, and deleting the registered user, andchanging the password of the registered user

NoteBy default, the tenant information and the tenant management menu are not displayed. In order to display,delete the following setting from <Tomcat-install-folder>\conf\NEC\webframework.properties file.

product.cloudportal.tenant.default.id = DefaultTenant

1.2.2.1 Tenant management (administrator)This section describes the [Tenant Management] menu.


13

Tenant list (administrator)The [Tenant Management] screen is displayed by selecting [Tenants] and then [Tenant Management]from the menu.

Figure 1-29 [Tenant Management] screen

Table 1-5 Item list ([Tenant Management] screen)

Item name Description

Show [ ] entries Changes the number of the displayed notices in the list.

Tenant list Displays a list of tenants.

To search for a tenant, click [Search] on the [Tenant list] screen and search it by the following items.A string search is a partial match search.

Table 1-6 Item list ([Tenant search] screen)


Tenant ID Tenant ID

Name Tenant name

Status - Active- InactiveOne of the above.

Registration time Registration date and time

Comment Comment

Clear Resets the entered (specified) values to the initial values.

Submit Click this button to start searching.

Checking the detailed tenant informationClicking the line of the tenant whose contents you want to check displays its detailed information.

Figure 1-30 [Tenant detail] screen


14

Table 1-7 Item list (Tenant detail)


Tenant ID Tenant ID

Name Tenant name

Status Any one of the following:- Active- Inactive

Number of registered users Number of users registered to the target tenant

Registered Registration date and time

Comment Comment

Administrator Administrator name of the target tenant

Edit tenant Displays the [Modify a tenant(Form)] screen.

Delete tenant Displays the [Delete a tenant(Confirmation)] screen.

Editing a tenantThis section describes how to edit a tenant.

1. On the [Tenant detail] screen, click [Edit tenant].


2. The [Modify a tenant(Form)] screen is displayed. Edit the items by referring to the followingtable and then click the [Next] button.

Figure 1-32 [Modify a tenant(Form)] screen

Table 1-8 Item list ([Modify a tenant(Form)] screen)


Name Up to 100characters

- Tenant name


15

Item name Input rule Initial value Description* The followingsymbols cannotbe used.\ / : . ; * ? " < > |

* The same tenant name can be specified twice ormore.

Status - ActiveInactive

Select whether to enable (Active) or disable(Inactive) a tenant.When a tenant is disabled, a system administratorcannot be add a user to the tenant and the tenantsubstitution function is disabled.

Comment Up to 255characters

- Comment

Clicking the [Select Manager] button displays the [Choose a tenant administrator] screen.Select a user to be an administrator from the users belonging to the tenant.

Figure 1-33 [Choose a tenant administrator] screen

3. The [Modify a tenant(Confirmation)] screen is displayed. Click the [Confirm] button to applythe changes.

Figure 1-34 [Modify a tenant(Confirmation)] screen

Deleting a tenantThis section describes how to delete a tenant.

NoteBefore deleting a tenant, delete the following items related to the tenant to be deleted.

• Notice• User

1. On the [Tenant detail] screen, click [Delete tenant].


16

Figure 1-35 [Tenant detail] screen (Deletion)

2. The [Delete a tenant(Confirmation)] dialog box is displayed. Click the [Confirm] to delete thetenant.

Figure 1-36 [Delete a tenant(Confirmation)] dialog box

1.2.2.2 User managementThis section describes the user management menu.

User list (administrator)The [User Management] screen is displayed by selecting [Tenants] and then [User Management]from the menu.

Figure 1-37 [User Management] screen

Table 1-9 Item list ([User Management] screen)



Create User Displays the [Create User(Form)] screen.* This is not displayed for a tenant user.

User list Displays a list of users.


17

To search for a user, click [Search] on the [User list] screen and search for it by the following items.A string search is a partial match search.

Table 1-10 Item list ([User search] screen)


Tenant Tenant name

Name Name

User ID User ID

User Type Select any of the following user types:- System Administrator- Tenant Manager- Tenant User

Status Select any of the following:- Active- Inactive- Locked



Registering a user (administrator)This section describes how to add a user.

1. On the [User Management] screen, click [Create User].


2. The [Create User(Form)] screen is displayed. Edit the items by referring to the following tableand then click the [Next] button.


18

Figure 1-39 [Create User(Form)] screen

Table 1-11 Item list ([Create User(Form)] screen)


User Type - Tenant user Select any of the following user types:- System Administrator- Tenant Manager- Tenant User

Role - - Select the role to be given to the user.- MONITORING USER- MONITORING OPERATOR- MONITORING ADMINISTRATOR

Tenant - - Select a tenant to which the user belongs.* This is not displayed when [System Administrator]is selected for [User Type].

User ID 3 to 16charactersOne-bytealphanumericcharacters,underscores (_),and hyphens (-)can be used.

- Enter the user ID.


- Enter the name (user name).

e-mail E-mail format - Enter the email address.

Password 6 to 16charactersOne-bytealphanumericcharacters andthe followingsymbols areavailable: !"#$%&'()*

- Enter the user password.


19

Item name Input rule Initial value Description+,./:;<=>?@[\]^_`{|}~ -.

Password(Confirmation)

Enter the samecharacter stringthat you enteredin [Password].

- Enter the user password (for confirmation).

Status - Active Select any of the following user states:- Active- Inactive

Note Up to 255characters

- Note

3. The [Create User(Confirmation)] screen is displayed. Click the [Confirm] button to add theuser.

Figure 1-40 [Create User(Confirmation)] screen

Checking the detailed user information (administrator)Clicking the line of the user whose contents you want to check displays its detailed information.

Figure 1-41 [User detail] screen

Table 1-12 Item list (User detail)


Tenant Tenant name* This is displayed only for a system administrator.

User ID User ID

Name Name (User name)

User Type User type


20


Role Role

Status - Active- Inactive- LockedOne of the above:

e-mail Email address of the user

Note Note

Edit User Displays the [Modify User] screen.* This is not displayed for a built-in user and tenant user.

Change Password Displays the [Changing password] screen.* This is not displayed for a built-in user and tenant user.

Delete User Displays the [Delete User] screen.* This is not displayed for a built-in user and tenant user.

Changing the user informationThis section describes how to change the user information.

1. On the [User detail] screen, click [Edit User].


2. The [Modify User(Form)] screen is displayed. Edit each item by referring to "Table 1-11 Itemlist ([Create User(Form)] screen) (page 19)" of "1.2.2.2.2 Registering a user (administrator)(page 18)" and click the [Next] button.

Figure 1-43 [Modify User(Form)] screen


21

NoteUser information of a built-in user can be handled only by a system administrator. Only the status canbe changed.

3. The [Change User(Confirmation)] screen is displayed. Click the [Confirm] button to apply thechanges.

Figure 1-44 [Change User(Confirmation)] screen

NoteIf a user name is changed, the changed name will not be applied to the registrant information of the noticethat has been registered before changing the user name.

Changing the passwordThis section describes how to change the password.

1. On the [User detail] screen, click [Change Password].


2. The [Changing password(Form)] screen is displayed. Change the password by referring to thepassword entry rule described in "1.2.2.2.2 Registering a user (administrator) (page 18)" andclick the [Next] button.


22

Figure 1-46 [Changing password(Form)] screen

3. The [Changing password(Confirmation)] screen is displayed. Click the [Submit] button toapply the changes.

Figure 1-47 [Changing password(Confirmation)] screen

Deleting a userThis section describes how to delete a user.

1. On the [User detail] screen, click [Delete User].


2. The [Delete User(Confirmation)] screen is displayed. Click the [Confirm] to delete the user.


23

Figure 1-49 [Delete User(Confirmation)] dialog box

1.2.3 Monitoring (administrator)This section describes the [Monitoring] menu.

The [Monitoring] menu provides the following functions:

- System message: Displaying and handling a message list

1.2.3.1 System messageThis section describes the system message.

The [System Message] screen is displayed by selecting [Monitoring] and then [System Message]from the menu.

On the [System Message] screen, system messages can be browsed. For messages, a user can alsoperform the operations to change the confirmation status, assign a mark, and edit comments. You cansearch messages by specifying a condition.

Selecting the [Auto Update] check box automatically updates the system message list every 30seconds.

Figure 1-50 [System Message] screen

Displaying the message list (administrator)This section describes how to search the system messages and display a list or details of themessages.

When opening the [System Message] screen, a list of system messages that have not been confirmedis displayed on the message panel.


24

Figure 1-51 System Message panel and messages

Table 1-13 Item list (System Message panel)


[System Message] toggle Opens and closes the message panel.

[Update] button Updates the message panel.

[Add widget] button Pastes the currently displayed system message panel to the dashboard as awidget.

[Search] toggle Opens and closes the search condition. This is hidden initially.

[Show numbers] button Specify the number of messages to be displayed in the list below.

[Mark] button Marks the message.

[Confirm] button Changes the confirmation status of the message.

[Previous] button Displays messages newer than the displayed messages.

[Next] button Displays messages older than the displayed messages.

Table 1-14 Item list (Message list)


Check box The message whose check box is selected is an operation target.

Severity Displays the severity.

Mark Displays the mark.

Generated Displays the generation date and time. The time is indicated with a time zone of asystem.

Confirmation Displays the confirmation status.

Message Text Displays the message text.

Application Displays the application.

Object Displays the object


25


Message ID Displays the message ID.

Clicking the search toggle displays the items for which a search condition can be specified.

Specifying a search condition and clicking the [Submit] button displays messages that meet thespecified search condition in a list.

For the items whose search condition is specified by using a character string (such as message textand description), a regular expression search is performed.

Figure 1-52 Search condition

Table 1-15 Item list (Search condition)

Item name Inputrule

Description

Severity - The selected severity and severity range ([Over], [Equal(Multiple selections)], or [Under])are searched. If the severity is not selected, all severity levels are searched.

Mark - The selected mark is searched. If the mark is not selected, all marks are searched.

Generated 1970/01/01/00:00to2999/12/3123:59(UTC)

The selected or entered range of the generation dates and times are searched.

Received 1970/01/01/00:00to2999/12/31

The selected or entered range of the reception dates and times are searched.


26

Item name Inputrule

Description

23:59(UTC)

Confirmation

- The selected confirmation status ([Confirmed] or [Unconfirmed]) is searched. Be sure toselect either check box.

MessageText

Up to1024characters

The entered message text is searched.

Description Up to256characters

The entered message summary is searched.

Application Up to1024characters

The entered application is searched.

Object Up to1024characters

The entered object is searched.

Message ID Up to128characters

The entered message ID is searched.

Comment Up to1024characters

The entered comment is searched.

Selecting a message from the message list displays the details of the selected message.


27

Figure 1-53 Message details

Table 1-16 Item list (Message details)





Received Displays the reception date and time. The time is indicated with a time zone of a system.



Description Displays the message summary.


Object Displays the object.

Message Definition ID Displays the message definition ID.


Comment Displays the comment.


28


[Mark] button Assigns the mark.

[Confirm] button Changes the confirmation status.

[Edit comment] button Edits the comment.

Operations for messagesThis section describes the operations for messages such as changing the confirmation status,assigning a mark, and editing comments.

Changing the confirmation statusThis section describes the following two methods to change the confirmation status.

• Changing method 1

1. Select the check box of the target message in the message list and click the [Confirm]button.

2. The confirmation statuses are displayed under the [Confirm] button. Select the status thatyou want to change.

Figure 1-54 Changing the confirmation status - method 1

• Changing method 2

1. Click the message whose comment you want to edit in the message list.

2. [Message Details] is displayed. Click the [Confirm] button.


29

Figure 1-55 Changing the confirmation status - method 2

3. The [Confirm] dialog box is displayed. Click the [Submit] button.

Figure 1-56 [Confirm] dialog box

Assigning a markThis section describes the following two methods to assign a mark.

• Assigning method 1

1. Select the check box of the target message in the message list and click the [Mark] button.

2. The [Marking up] dialog box is displayed. Select the mark that you want to assign to themessage and click the [Submit] button.

Figure 1-57 Assigning a mark - method 1

• Assigning method 2


2. [Message Details] is displayed. Click the [Mark] button.


30

Figure 1-58 Assigning a mark - method 2

3. The [Marking up] dialog box is displayed. Select the mark that you want to assign to themessage and click the [Submit] button.

Figure 1-59 [Marking up] dialog box

Editing the commentThis section describes how to edit the comment.


2. [Message Details] is displayed. Click the [Edit comment] button.

Figure 1-60 Editing the comment

3. The [Edit comment] dialog box is displayed. Enter a comment and click the [Submit] button.


31

Figure 1-61 [Edit comment] dialog box

1.2.4 Service managementThis section describes the service management menu.

The service management menu provides the following function:

• Notice management

1.2.4.1 Notice managementThis section describes the notice management function.

This function manages the notices to be reported to the target tenant on the dashboard.

A system administrator can specify a tenant to which to report the notices. A tenant administrator canmanage only the notices for its tenants.

Notice listThe [Notice management] screen is displayed by selecting [Service Management] and then [NoticeManagement] from the menu.

Figure 1-62 [Notice management] screen

Table 1-17 Item list (Notice management)


Number of display items Changes the number of the displayed notices in the list.

Submit a new notice Displays the [Submit a new notice] screen.

Notice List Displays the notice list.

To search for a notice, click [Search] on the [Notice management] screen and search for it by thefollowing items. A string search is a partial match search.

Table 1-18 Item list ([Notice Search] screen)


Scope of disclosure Tenant to which to report a notice

Release period Period to publish a notice

State Any of the following:


32

Item name Description- Expired- Released- Not released

Title Title

Contents Contents of a notice

Attachment With or without an attached file- Yes- No



Registering a noticeThis section describes how to add a notice.

1. On the [Notice management] screen, click [Submit a new notice].


2. The [Submit a new notice(Form)] screen is displayed. Enter the items by referring to thefollowing table and then click the [Confirm] button.

Figure 1-64 [Submit a new notice(Form)] screen

Table 1-19 Item list (Submit a new notice(Form))


Scope of disclosure - Click the [Select tenant(s)] button to display the [select scope ofdisclosure] dialog box and select the target tenant to which toreport a notice.See the [Select scope of disclosure] dialog box below.


33

Item name Input rule DescriptionIf you select the [Select All tenants] check box, all tenants areselected.

Start date 1970/01/01/ 00:00to 2999/12/31 23:59(UTC)

Enter the start date and time.

End date 1970/01/01/ 00:00to 2999/12/31 23:59(UTC)

Enter the end date and time.

Title 64 characters Enter the title.

Contents 255 characters Enter the contents of the notice.

Attachment files(s) - Displays the name of the attached file.

Browse... - Displays the dialog box to select a file to be attached.The maximum file size to be attached is 10 MB.* Note that a file whose size is 0 bytes cannot be attached.

Note- If a huge file is specified as a file to be attached to a notice, it takes much time to upload thespecified file. If a file exceeding 10 MB is uploaded, registration fails. Therefore, do not specify a fileexceeding 10 MB.- If there is notices that have been created by users with the exact same name, which user createdwhich notice is determined by the contents of the notice. Therefore, be sure to create a notice so as tobe distinguished by its content.

[Select scope of disclosure]

Select a tenant to which to report a notice from [Choose from] and click [Add]. After selectingall target tenants, click the [Select] button.

If you want to select all tenants as a target, click the [Add all] button.

Figure 1-65 [Select scope of disclosure] dialog box

3. A notice is registered and the [Submit a new notice(Confirmation)] screen is displayed. Clickthe [Confirmation] button.


34

Figure 1-66 [Submit a new notice(Confirmation)] screen

NoteIf the [Select All tenants] check box is selected on the [Submit a new notice(Form)] screen and some tenantsare selected on the [Select scope of disclosure] dialog box, it is assumed that all tenants are selected as atarget regardless of the tenants selected on the [Select scope of disclosure] dialog box. Therefore, do notselect [Select All tenants] and perform tenant selection together.

Checking the detailed notice informationClicking the line of the notice whose contents you want to check displays its detailed information.

Figure 1-67 [Notice details] screen

Table 1-20 Item list (Notice details)


Scope of disclosure Tenant to which to report a notice* This is displayed only for a system administrator.

Start date Start date and time

End date End date and time

State - Expired- Released- Not releasedOne of the above.

Title Title

Contents Contents of the notice

Attachment file(s) Attached file name and link to the attached file

Submitter Person who registered the notice

Time stamp of submission Registration date and time


35


Edit notice Displays the [Edit notice] screen.

Delete notice Displays the [Delete notice] screen.

Editing the contents of the noticeThis section describes how to change the notice.

1. On the [Notice details] screen, click [Edit notice].


2. The [Edit notice(Form)] screen is displayed. Edit each item by referring to "Table 1-19 Itemlist (Submit a new notice(Form)) (page 33)" of "1.2.4.1.2 Registering a notice (page 33)".Click the [Confirm] button to apply the changes.

To delete the attached file, select the [Delete attached file(s)] check box.

NoteIf the [Delete attached file(s)] check box is selected, file selection is disabled. Even if you select afile, it is assumed that the file is not selected.

Figure 1-69 [Edit notice(Form)] screen

3. The [Edit notice(Confirmation)] screen is displayed. Click the [Confirmation] button.


36

Figure 1-70 [Edit notice(Confirmation)] screen

Deleting a noticeThis section describes how to delete a notice.

1. On the [Notice details] screen, click [Delete notice].


2. The [Delete notice(Confirmation)] screen is displayed. Click [Confirmation] to delete thenotice.

Figure 1-72 [Delete notice(Confirmation)] screen

1.3 User operationThis section describes the functions that a user operates.

1.3.1 DashboardA user can arrange widgets on the dashboard screen freely.

The widget types that can be arranged differ depending on the server setting and user authority.


37

1.3.1.1 Adding a widget to the dashboardThis section describes how to add a widget to the dashboard.


The dashboard screen changes to customize mode and the customize menu is displayed.

Figure 1-73 [Dashboard] screen with the customize menu

2. On the dashboard screen, click [Add widget].

The [Add widget] dialog box is displayed.


3. On the [Add widget] dialog box, enter the information of the widget that you want to add.

Table 1-21 Item list ([Add widget] dialog box)


Widget title 0 to 64characters

- Name to be displayed as a widget titleMultiple widgets with the same name can beregistered.If a widget name is omitted, "(No name)" isdisplayed.

URL - - Select the URL that you want to display as a widget.Multiple widgets with the same URL can beregistered.

URL parameters 0 to 2048characters

- Specify an option parameter that you want to specifyfor the widget URL.The format is "key=value". When specifyingmultiple parameters, separate them with "&".The character string must have been encoded.

4. Click [OK].

The [Add widget] dialog box is closed.


38


A new widget is displayed below the displayed widgets on the dashboard.

Figure 1-76 Displaying the dashboard and a new widgets

After adding widgets, click [Save]. For details about the procedure, see "1.2.1.5 Saving the settingsof the widget on the dashboard (page 11)".

1.3.1.2 Removing a widget from the dashboardThis section describes how to remove a widget from the dashboard.




39


2. Click [x] displayed at the upper right of the widget that you want to remove.

Figure 1-78 Removing a widget from the dashboard

The [Confirmation - remove widget] dialog box is displayed.

Figure 1-79 [Confirmation - remove widget] dialog box

3. Check the contents of the [Confirmation - remove widget] dialog box. If you want to removethe displayed widget, click [OK].


The [Confirmation - remove widget] dialog box is closed.

The selected widget is removed.

After removing the widget, click [Save]. For details about the procedure, see "1.2.1.5 Saving thesettings of the widget on the dashboard (page 11)".


40

1.3.1.3 Changing the display order and size of the widgets onthe dashboard

This section describes how to change the display order and size of the widgets displayed on thedashboard.




2. To change the widget display order, drag and drop the desired widget with a mouse.


The widget display order is changed.


41


3. To change the widget size, drag the frame of the desired widget with a mouse.

• To change the height of the widget, drag the bottom frame of the desired widget with amouse.

• To change the width of the widget, drag the right frame of the desired widget with amouse.

• To change the height and width of the widget, drag the bottom right corner of the desiredwidget with a mouse.

The widget size is changed.

Figure 1-83 Changing the display size of the widgets

After changing the widget display order or size, click [Save]. For details about the procedure, see"1.2.1.5 Saving the settings of the widget on the dashboard (page 11)".

1.3.1.4 Saving the settings of the widget on the dashboardThis section describes how to save the settings of the widgets on the dashboard.



42




1. On the dashboard screen, click [Save].

The [Confirmation - save widgets] dialog box is displayed.

Figure 1-84 Saving the settings of the widget

2. Check the contents of the [Confirmation - save widgets] dialog box. If you want to save thedisplayed contents, click [OK].

Figure 1-85 [Confirmation - save widgets] dialog boxOtherwise, click [Cancel].

The [Confirmation - save widget] dialog box is closed.

Information of the added or removed widget and the widget display order and size are saved.

1.3.1.5 Discarding the settings of the widget on the dashboardThis section describes how to discard the setting of the widgets on the dashboard.





1. On the dashboard screen, click [Cancel].


43

Figure 1-86 Discarding the settings of the widget

The [Confirmation - cancel] dialog box is displayed.

Figure 1-87 [Confirmation - cancel] dialog box

2. Check the contents of the [Confirmation - cancel] dialog box. If you want to discard thedisplayed contents, click [OK].


The [Confirmation - cancel] dialog box is closed.

The widget edit contents that have not been saved are discarded and the widget display returns to thelast saved state. Information before the last saving are not discarded.

1.3.2 Tenant information (user)This section describes the [Tenants] menu operations that a tenant administrator and tenant user canperform.

The [Tenants] menu provides the following functions:

- Tenant management (not available for a tenant user): Checking and editing the details of a tenant

- User management (by a tenant administrator): Registering a new user, checking, editing, anddeleting the registered user, and changing the password of the registered user

- User management (by a tenant user): Checking the registered user

NoteBy default, the tenant information and the tenant management menu are not displayed. In order to display,delete the following setting from <Tomcat-install-folder>\conf\NEC\webframework.properties file.

product.cloudportal.tenant.default.id = DefaultTenant


44

1.3.2.1 Tenant management (user)This section describes the tenant management menu.

Tenant list (user)The [Tenant Management] screen is displayed by selecting [Tenants] and then [Tenant Management]from the menu.

Figure 1-88 [Tenant Management] screen

Table 1-22 Item list ([Tenant Management] screen)


Tenant list Displays information of a local tenant.

Checking the detailed tenant information (user)Clicking the line of the tenant whose contents you want to check displays its detailed information.


Table 1-23 Item list (Tenant detail)


Tenant ID Tenant ID

Name Tenant name

Status Any one of the following:- Active- Inactive

Number of registered users Number of users registered to the target tenant

Registered Registration date and time

Comment Comment

Administrator Administrator name of the target tenant

Edit tenant Displays the [Modify a tenant(Form)] screen.


45

Editing a tenant (user)This section describes how to edit a tenant.

1. On the [Tenant detail] screen click [Edit tenant].


2. The [Modify a tenant(Form)] screen is displayed. Edit each item and click the [Next] button.

Figure 1-91 [Modify a tenant(Form)] screen

On the [Modify a tenant(Form)] screen, a tenant administrator can be specified. Specify atenant management user that has been created.

Figure 1-92 [Choose a tenant administrator] screen

3. The [Modify a tenant(Confirmation)] screen is displayed. Click the [Confirm] button to applythe changes.


46

Figure 1-93 [Modify a tenant(Confirmation)] screen

1.3.2.2 User managementThis section describes the user management menu.

User list (user)The [User Management] screen is displayed by selecting [Tenants] and then [User Management]from the menu.


Table 1-24 Item list ([User Management] screen)



Create User Displays the [Create User(Form)] screen.* This is not displayed for a tenant user.

User list Displays a list of users.

To search for a user, click [Search] on the [User list] screen and search it by the following items. Astring search is a partial match search.

Table 1-25 Item list ([User search] screen)


Name Name

User ID User ID

User Type Select any of the following user types:- System Administrator- Tenant Manager- Tenant User


47


Status Select any of the following:- Active- Inactive- Locked



Registering a user (user)This section describes how to add a user.

1. On the [User Management] screen, click [Create User].


2. The [Create User(Form)] screen is displayed. Edit the items by referring to the following tableand then click the [Next] button.

Figure 1-96 [Create User(Form)] screen

Table 1-26 Item list ([Create User(Form)] screen)


User Type - Tenant user Select any of the following user types:- Tenant Manager- Tenant User

Role - - Select the role to be given to the user.- MONITORING USER


48

Item name Input rule Initial value Description- MONITORING OPERATOR- MONITORING ADMINISTRATOR

User ID 3 to 16charactersOne-bytealphanumericcharacters,underscores (_),and hyphens (-)can be used.

- Enter the user ID.


- Enter the name (user name).

e-mail E-mail format - Enter the email address.

Password 6 to 16charactersOne-bytealphanumericcharacters andthe followingsymbols areavailable: !"#$%&'()*+,./:;<=>?@[\]^_`{|}~ -.

- Enter the user password.

Password(Confirmation)

Enter the samecharacter stringthat you enteredin [Password].

- Enter the user password (for confirmation).

Status - Active Select any of the following user states:- Active- Inactive

Note Up to 255characters

- Note

3. The [Create User(Confirmation)] screen is displayed. Click the [Confirm] button to add theuser.

Figure 1-97 [Create User(Confirmation)] screen


49

Checking the detailed user information (user)Clicking the line of the user whose contents you want to check displays its detailed information.


Table 1-27 Item list (User detail)


User ID User ID

Name Name (User name)

User Type User type

Role Role

Status - Active- Inactive- LockedOne of the above.

e-mail Email address of the user

Note Note

Edit User Displays the [Modify User] screen.* This is not displayed for a tenant user.

Change Password Displays the [Changing password] screen.* This is not displayed for a tenant user.

Delete User Displays the [Delete User] screen.* This is not displayed for a tenant user.

Changing the user information (user)This section describes how to change the user information.

1. On the [User detail] screen, click [Edit User].



50

2. The [Modify User(Form)] screen is displayed. Edit each item by referring to "Table 1-26 Itemlist ([Create User(Form)] screen) (page 48)" of "1.3.2.2.2 Registering a user (user) (page 48)"and click the [Next] button.

Figure 1-100 [Modify User(Form)] screen

3. The [Change User(Confirmation)] screen is displayed. Click the [Confirm] button to apply thechanges.

Figure 1-101 [Change User(Confirmation)] screen

Changing the passwordThis section describes how to change the password.

1. On the [User detail] screen, click [Change Password].


2. The [Changing password(Form)] screen is displayed. Change the password by referring to thepassword entry rule described in "1.2.2.2.2 Registering a user (administrator) (page 18)" andclick the [Next] button.


51

Figure 1-103 [Changing password(Form)] screen

3. The [Changing password(Confirmation)] screen is displayed. Click the [Submit] button toapply the changes.

Figure 1-104 [Changing password(Confirmation)] screen

Deleting a userThis section describes how to delete a user.

1. On the [User detail] screen, click [Delete User].


2. The [Delete User(Confirmation)] screen is displayed. Click the [Confirm] to delete the user.


52

Figure 1-106 [Delete User(Confirmation)] dialog box

1.3.3 Monitoring (user)This section describes the [Monitoring] menu.

The [Monitoring] menu provides the following functions:

- Node: Displaying a node list and status, and displaying and handling a message list

- Message: Creating a category group and category, and grouping messages

1.3.3.1 NodeThis section describes the node screen.

The node screen is displayed by selecting [Monitoring] and then [Node] from the menu.

On the node screen, the node list panel, status panel (initially hidden), message panel (initiallyhidden) are displayed.

On the node list and status panels, the current status of the node to be monitored is displayed. Thedisplayed node severity is the most urgent severity among the monitoring items (such as process andperformance information) of the node. Also, nodes can be grouped in any hierarchy. The groupseverity is the most urgent severity among the nodes (groups) in the group. Therefore, the failed nodecan be identified by tracing groups with high severity from the top of the group tree.

On the message panel, messages of the node and group selected on the node list panel are displayedand can be operated. For details of the display contents, see "1.3.3.3 Message list (page 75)". Forthe operation method, see "1.2.3.1.2 Operations for messages (page 29)".

Selecting the [Auto Update] check box automatically updates each panel every 30 seconds.


53

Figure 1-107 Node screen

On the node screen, the display panels are operated by using the URL parameters.

Table 1-28 URL parameters

URLparameter

Validvalues

Description

view listdetailstatusstatus_countstatus_listmsg

Specify the panels to be displayed. If this parameter is not specified, only the [Node List]panel is displayed.list: Displays the node list.detail: Displays the status and message panels. A target group or target node must bespecified. (If no target group or target node is specified, the specified view parameterbecomes invalid.)status: Displays the status panel only that contain both of the number of nodes of eachseverity and the status list. A target group or target node must be specified. (If no targetgroup or target node is specified, the specified view parameter becomes invalid.)status_count: Displays the status panel only that contain the number of nodes of eachseverity only. A target group or target node must be specified. (If no target group or targetnode is specified, the specified view parameter becomes invalid.)status_list: Displays the status panel only that contain the status list only. A target group ortarget node must be specified. (If no target group or target node is specified, the specifiedview parameter becomes invalid.)msg: Displays the message panel only. A target group or a target node must be specified. (Ifno target group or target node is specified, the specified view parameter becomes invalid.)

group Group ID The status and messages of the specified group is displayed. This parameter does not affectnode list. (The node specified here is not selected in node list.)

node Node ID The status and messages of the specified node is displayed. This parameter does not affect[Node List]. (The node specified here is not selected in node list.)

msg Messagenumber

The details of the specified message number are displayed. This parameter becomes invalidif no message is displayed by the view parameter specification. (A target group or targetnode must be specified.)

auto on Automatic update is enabled. If this parameter is not specified or if an invalid value (otherthan "on") is specified, automatic update is not enabled.


54

Figure 1-108 Node screen when the URL parameters are specified (http://ADDRESS:PORT/portal/cloudportal/monitoring/topology?view=msg&node=<node ID>&msg=<message number>)

NoteIn order to access this page from a mail reported by SystemManager G Manager, specify the following assetting of a mail body.

http://ADDRESS:PORT/portal/cloudportal/monitoring/topology?view=detail&node=msc_extlink_manager_host_name~$NODE$&generatedDate=$GENERATEDDATE$&generatedTime=$GENERATEDTIME$&messageId=$MESSAGEID$

Node List panelThe [Node List] panel is displayed by selecting [Monitoring] and then [Node] from the menu. Thegroup tree is displayed at the left to the [Node List] panel.


55

Figure 1-109 [Node List] panel and group tree

Table 1-29 Item list ([Node List] panel and group tree)


[Node List] toggle Opens and closes the node list panel.

[Update] button Updates the [Node List] panel.

[Add widget] button Pastes the currently displayed node list panel to the dashboard as a widget.

Severity selection Displays the groups whose severity is more urgent than the selected severity inthe tree.

[Operation] menu button Displays the [Operation] menu available for the selected group.• "1.3.3.1.4 Creating a group (page 60)"• "1.3.3.1.5 Changing the group name (page 61)"• "1.3.3.1.6 Moving a group (page 61)"• "1.3.3.1.7 Deleting a group (page 62)"

Node listThe node list is displayed by selecting a group in the group tree on the [Node List] panel.

Figure 1-110 [Note List] panel


56

Table 1-30 Item list (Node List)


[Edit] check box Selecting this check box enables to move a node. For details, see"1.3.3.1.8 Moving a node (page 63)".

Search field Searches the node name. Lines of the node names including the entered characterstring are extracted.


Node Name Displays the node name.

Details icon Clicking this icon displays the [Node Detail] dialog box.

Figure 1-111 [Node Detail] dialog box

Table 1-31 Item list ([Node Detail] dialog box)


ID ID to identify a node. (The node ID or agent ID might be displayed.)

OS Displays the OS type.

OS Version Displays the OS version.

Status panelThe status of a group is displayed by selecting the group in the group tree.

The status of a node is displayed by selecting the node on node list.


57

Figure 1-112 [Node List] panel and status panel

Table 1-32 Item list (Status panel)


Status toggle Opens and closes the status panel.

[Update] button Updates the status panel.

[Add widget] button Pastes the currently displayed status panel to the dashboard as a widget.When the group status is displayed, both or either of the number of nodes of eachseverity and the status list can be displayed.

The number of nodes of eachseverity

Tallies and displays the number of nodes of each severity within the group. Thisis displayed when a group is selected.


Node Name Displays the name. This is displayed when [Details] is performed for a group.

Type Displays the type.

Target Displays the target.

Occurence Time Displays the generation date and time. The time is indicated with a time zone ofa system.

Status Displays the status.

Operation Displays the operation icons.This is displayed for a user who has the operation management operation rightwhen a node is selected.If [Type] is [Performance], the performance graph display icon is displayed. Fordetails of performance graph display, see "1.3.3.1.3 Performance graph (page59)".If [Type] is [Process], the [start] and [stop] icons to recover processes aredisplayed.


58

Item name DescriptionIf [Type] is [Windows Service], the [start], [stop], and [Other Operations] iconsto recover Windows services are displayed. Clicking the [Other Operations] icondisplays the pull-down menu. From the displayed pull-down menu, otheroperations such as [pause] and [resume] can be selected.Stopping a Windows service fails if there is any service that depends on theWindows service to be stopped. To stop a Windows service and a service thatdepends on the Windows service, select [force stop] from [Other Operations].If a monitoring item is recovered, no operation can be performed for themonitoring item for a certain period (approximately 20 seconds).

Performance graphClicking a performance graph icon in the agent monitoring status displays a performance graph.

Figure 1-113 [Performance Graph] screen

Table 1-33 Item list (Performance graph)


Last 1 hour Displays a graph for the last hour. This button is selectedat initial display.

Last 1 day Displays a graph for the last day.

Last 1 week Displays a graph for the last week.


59


Specified period Specify the start time and end time and click the[Displaying a graph] button to display a graph for thespecified period.The time range available for the start time and end timeis 1971/01/01 00:00 to 2037/12/31 23:59.The interval between the start time and end time is up toone week.

[Add] widget button Pastes the currently performance graph to the dashboardas a widget.

Creating a groupThis section describes how to create a group.

1. In the group tree, select the parent group in which to create a group.

2. Since [Create group] of the [Operation] menu becomes available, click it.

Figure 1-114 Creating a group

3. The [Node List - Create group] dialog box is displayed. Enter the group name and click the[OK] button to create a group.

Figure 1-115 [Node List - Create group] dialog box


60

Table 1-34 Item list (Create group)


Group Name Up to 128 characters A group is created with the specified name.

Changing the group nameThis section describes how to change the group name.

1. In the group tree, select the group whose name you want to change.

2. Since [Edit group name] of the [Operation] menu becomes available, click it.

Figure 1-116 Changing the group name

3. The [Node List - Edit group name] dialog box is displayed. Enter the group name and click the[OK] button to change the group name.

Figure 1-117 [Node List - Edit group name] dialog box

Table 1-35 Item list (Edit group name)


Group Name Up to 128 characters The group name is changed to the specified name.

Moving a groupThis section describes how to move a group.


61

1. In the group tree, select the group that you want to move.

2. Since [Move group] of the [Operation] menu becomes available, click it.

Figure 1-118 Moving a group

3. The [Node List - Move group] dialog box is displayed. Select the group to which to move thegroup and click the [OK] button to move the group.

Figure 1-119 [Node List - Move group] dialog box

Deleting a groupIf a group exists in the group that you want to delete, the target group cannot be deleted. If a nodeexists in the group that you want to delete, the node is moved to default_group after the group isdeleted.

This section describes how to delete a group.

1. Select the group that you want to delete in the group tree.

2. Since [Delete group] of the [Operation] menu becomes available, click it.


62

Figure 1-120 Deleting a group

3. The [Node List - Delete group] dialog box is displayed. Click the [OK] button to delete theselected group.

Figure 1-121 [Node List - Delete group] dialog box

Moving a nodeThis section describes how to move a node.

1. Select the check box above the node list table.

2. Select the node that you want to move.

3. Click the [Move] button under the node list table.


63

Figure 1-122 Moving a node

4. The [Node List - NodeMove] dialog box is displayed. Select the group to which to move thenode and click the [OK] button to move the node.

Figure 1-123 [Node List - NodeMove] dialog box

1.3.3.2 MessageThis section describes the message screen.

The message screen is displayed by selecting [Monitoring] and then [Message] from the menu.

On the message screen, the [Category List] panel, the [Number of Messages by Severity] panel(initially hidden) and [Message List] panel (initially hidden) are displayed.

On the message screen, messages can be categorized by specifying conditions and the messagemonitoring status can be displayed for each category. The category severity is the most urgentseverity of the unconfirmed messages that are classified into that category. Also, categories can begrouped in any hierarchy. The category group severity is the most urgent severity among thecategories (category groups) in the group. Therefore, the failed category can be identified by tracinggroups with high severity from the top of the group tree.

On the [Message List] panel, messages of the category selected on the category list panel aredisplayed and can be operated. For details of the display contents, see "1.3.3.3 Message list (page75)". For the operation method, see "1.2.3.1.2 Operations for messages (page 29)".

Selecting the [Auto Update] check box automatically updates each panel every 30 seconds.


64

Figure 1-124 Message screen

On the message screen, the display panels are operated by using the URL parameters.

Table 1-36 URL parameters

URLparameter

Validvalues

Description

view listlist_countlist_listdetailmsg

Specify the panels to be displayed. If this parameter is not specified, only the [CategoryList] panel is displayed.list: Displays the [Category List] panel and the [Number of Messages by Severity] panel.list_count: Displays the [Number of Messages by Severity] panel only. A target categorymust be specified. (If no target group or target node is specified, the specified viewparameter becomes invalid.)list_list: Displays the [Category List] panel only. A target category must be specified. (If notarget group or target node is specified, the specified view parameter becomes invalid.)detail: Displays the [Category List] panel, the [Number of Messages by Severity] and the[Message List] panel. A target category must be specified. (If no target category isspecified, the specified view parameter becomes invalid.)msg: Displays the [Message List] panel only. A target category must be specified. (If notarget category is specified, the specified view parameter becomes invalid.)

category

Category The severity and messages of the specified category is displayed. This parameter does notaffect category list. (The node specified here is not selected in category list.)

group Group ID The status and messages of the specified group is displayed. This parameter does not affectnode list. (The node specified here is not selected in node list.)

msg Messagenumber

The details of the specified message number are displayed. This parameter becomes invalidif no message is displayed by the view parameter specification. (A target category must bespecified.)

auto on Automatic update is enabled. If this parameter is not specified or if an invalid value (otherthan "on") is specified, automatic update is not enabled.


65

Table 1-37 Item list (category list)


[Update] button Updates the category list panel.

[Add widget] button Pastes the currently category list panel to the dashboardas a widget.

Severity selection Displays the categories (category groups) whose severityis more urgent than the selected severity in the tree.

Operation Displays the [Operation] pull-down menu. This isdisplayed only for a user who can change the operationmanagement settings.For details, see "1.3.3.2.2 Category list operation (page67)".

Category group node Displays a category group name with a severity icon.The categories in the category group can be displayed orhidden by selecting the open or close icon.

Category node Displays a category name with a severity icon.Clicking the category name shows a list of messagesclassified into the category and the number ofunconfirmed messages of each severity.For the message list, see "1.3.3.3 Message list (page75)".For the number of unconfirmed messages of eachseverity, see "1.3.3.2.1 Number of Messages bySeverity (page 66)".

Number of Messages by SeveritySelecting a category from the category list displays the number of unconfirmed messages of eachseverity.


66

Figure 1-125 [Number of Messages by Severity] panel

Messages can be narrowed down (searched again) by selecting a severity. It is also possible to selectmultiple severity levels. Click the selected severity to cancel the selection.

When the number of messages of each severity is displayed as a widget on the dashboard, the screenis changed to the message screen by selecting a severity. Messages are displayed with narrowingdown by the selected severity.

Category list operationSelecting an operation from the [Operation] pull-down menu on the [Category List] screen displaysthe dialog box of the selected operation.


67

Figure 1-126 [Category List] panel

• Add

Figure 1-127 [Category List - Add] dialog box

Table 1-38 Item list (Category List - Add)


Parent group Displays the name of the parent category group in which to create acategory group or category.

Type Select the type of the [Category Group] or [Category] to be created.

Display Name Enter the name of the category group or category to be created.

Cancel Stops creating a category group or category and closes the dialog box.

OK Creates the specified category group or category and closes the dialogbox.

• Rename


68

Figure 1-128 [Category List - Rename] dialog box

Table 1-39 Item list (Category List - Rename)


Display Name Enter the category group or category name to be changed.

Cancel Stops changing the category group or category name and closes thedialog box.

OK Changes the specified category group or category name and closes thedialog box.

• Delete

Figure 1-129 [Category List - Delete] dialog box

Click [OK] to delete the selected category group or group.

Filter listThe [Filter List] screen is displayed by selecting a category from the category list and then select[Filter List] from the [Operation] menu.

The filters are displayed in priority order. The condition to classify messages into categories is set toeach filter. The output message is filtered in descending order of priority. If the filter type that themessage matches first is [Store], the message is classified into a category. If the filter type that themessage matches first is [Ignore] or the message does not match any filter conditions, the message isnot classified into any category.

A user who can change the operation management definition can add, change, and delete a filter andalso change the filter priority.

Figure 1-130 [Filter List] screen


69

Table 1-40 Item list (Filter list)


Add Add a filter. For details, see "1.3.3.2.4 Adding orchanging the filter (page 71)".When selecting the filter from the filter list and adding anew filter, the added new filter is inserted above theselected filter of the list.When adding a filter without selecting the filter, theadded new filter is inserted at the top of the list.

Filter Order Selecting this check box enables to change the filterorder.For details, see "1.3.3.2.5 Changing the filter order(page 73)".

Delete Selecting this check box enables to delete a filter.For details, see "1.3.3.2.6 Deleting a filter (page 74)".

Filter Name Displays the filter name.

Type Displays the filter type.Store: Messages that match the condition are classifiedinto a category.Ignore: Messages that match the condition are notclassified into a category. (The succeeding filtering is notperformed.)

Status Displays the filter status.EnableDisable: Indicates that the filter condition is not appliedtemporarily.

Node Displays the condition text (in regular expression) forthe node name.

Application Displays the condition text (in regular expression) forthe application.

Object Displays the condition text (in regular expression) forthe object.

Message ID Displays the condition text (in regular expression) forthe message ID.

Message Text Displays the condition text (in regular expression) forthe message text.

[Back] button Returns to the message screen.

Clicking the filter at the top of the list displays filter detail.

Table 1-41 Item list (Filter detail)


Filter Name Displays the filter name.

Status Displays the filter status.EnableDisable: Indicates that the filter condition is not applied temporarily.

Type Displays the filter type.Store: Messages that match the condition is classified into a category.


70

Item name DescriptionIgnore: Messages that match the condition are not classified into a category.(The succeeding filtering is not performed.)

Group Displays the group condition.

Node Name Displays the condition text (in regular expression) for the node name.

Application Displays the condition text (in regular expression) for the application.

Object Displays the condition text (in regular expression) for the object.

Message ID Displays the condition text (in regular expression) for the message ID.

Message Text Displays the condition text (in regular expression) for the message text.

Message Description Displays the condition text (in regular expression) for the message summary.

Message Definition ID Displays the condition text (in regular expression) for the messagedefinition.

Severity Displays the severity condition.

[Edit] button Changes the filter condition.For details, see "1.3.3.2.4 Adding or changing the filter (page 71)".

[Copy] button Add a filter by quoting the filter information being displayed in details.For details, see "1.3.3.2.4 Adding or changing the filter (page 71)".The added filter is inserted at one line above the quoted filter.

NoteFor a "negative" condition (that is, targeting the filter that does not match the specified condition), a notequal sign is displayed at the top of the condition.

Adding or changing the filterThe [Add Message Filter] screen is displayed by clicking [Add] on the [Filter List] screen or byselecting a filter on the [Filter List] screen and clicking [Copy]. When clicking [Copy], eachcondition input field is displayed with the selected condition set.

The [Edit Message Filter] screen is displayed by selecting a filter on the [Filter List] screen andclicking [Edit].


71

Figure 1-131 [Add Message Filter] screen

Table 1-42 Item list (Add Message Filter)


Filter Name Enter the filter name by using 0 to 128 characters.

Status When [Enable] is specified, the status of the filter is"enabled".When [Disable] is specified, the status of the filter is"disabled".

Type Type of the filterWhen [Store] is specified, messages that match the filtercondition are to be classified into a category.When [Ignore] is specified, messages that match thefilter condition are not to be classified into a category. Inaddition, comparison with the subsequent filteringdefinitions is not performed.

Group Select a group. Messages for the nodes in the selectedgroup are targeted.

Include Subgroup When this check box is selected, all groups in theselected group are targeted.

Not (Group) When this check box is selected, groups other than theselected group are targeted. If [Include Subgroup] is alsoselected, groups other than "all groups in the selectedgroup" are targeted.

Not (Node Name) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for thenode, match the condition.

Node Name Specify the filter condition for node names in regularexpression.


72


Not (Application) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for theapplication, match the condition.

Application Specify the filter condition for the application.

Not (Object) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for theobject, match the condition.

Object Specify the filter condition for the object (name of theobject in which a message is generated) in regularexpression.

Not (Message ID) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for themessage ID, match the condition.

Message ID Specify the filter condition for the message ID.

Not (Message Text) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for themessage text, match the condition.

Message Text Specify the filter condition for the message text.

Not (Message Description) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for themessage summary, match the condition.

Message Description Specify the filter condition for the message summary.

Not (Message Definition ID) When this check box is selected, it is assumed that allmessages, which do not match the filter condition for themessage definition ID, match the condition.

Message Definition ID Specify the filter condition for the message definition IDto be used to generate a message text.

Severity Specify the filter condition for the severity.

Severity Range Select [Over], [Equal], or [Under] for the severity.

When you have entered all necessary conditions, click [OK] to register them.

Clicking the [Cancel] button discards the data in the fields and returns you to the [Filter List] screen.

Changing the filter orderSelecting [Filter Order] on the [Filter List] screen enables to change the filter order.

Figure 1-132 [Filter Order] screen


73

Table 1-43 Item list (Filter List)


↑ Moves the selected line up.

↓ Moves the selected line down.

Cancel Displays the [Confirmation cancel] dialog box."Table 1-44 Item list ([Confirmation cancel] dialogbox) (page 74)"

Apply Displays the [Confirmation apply] dialog box."Table 1-45 Item list ([Confirmation apply] dialog box)(page 74)"

[Confirmation cancel] dialog box

Table 1-44 Item list ([Confirmation cancel] dialog box)


Cancel Closes the dialog box without canceling the settings.(Returns to the order change operation.)

OK Stops changing the order and returns to the filter setting (list) display.

[Confirmation apply] dialog box

Table 1-45 Item list ([Confirmation apply] dialog box)


Cancel Closes the dialog box without applying the order.(Returns to the order change operation.)

OK Applies the order and closes the dialog box.

Deleting a filterSelecting [Delete] on the [Filter List] screen enables to delete a filter.

Figure 1-133 [Filter List] screen

Selecting a filter that you want to delete from the filter list and clicking the [Delete] button displaysthe [Delete Filter] dialog box. Click [OK] to delete the selected filter.


74

Figure 1-134 [Delete Filter] dialog box

1.3.3.3 Message listWhen selecting a group and node on the [Node List] panel of the node screen, messages related to theselected group and node are displayed on the message panel.

When selecting a category on the [Category List] panel of the message screen, messages related tothe selected category are displayed on the message panel.

Figure 1-135 Message panel and messages

Table 1-46 Item list (Message panel)


Message toggle Opens and closes the message panel.

[Update] button Updates the message panel.

[Add widget] button Pastes the currently message panel to the dashboard as a widget.

Search toggle Opens and closes [Search Condition]. This item is closed initially.

[Show numbers] button Specify the number of messages to be displayed in the list below.


[Confirm] button Changes the confirmation status of the message.

[Previous] button Displays messages newer than the displayed messages.

[Next] button Displays messages older than the displayed messages.

Table 1-47 Item list (Message list)


Check box The message whose check box is selected is an operation target.

Node Displays a node. This is displayed by selecting a group.


75










Clicking the search toggle displays the items for which a search condition can be specified.

Specifying a search condition and clicking the [Submit] button displays messages that meet thespecified search condition in the table.

For the items whose search condition is specified by using a character string (such as node name,message text, description and comment), a regular expression search is performed.

Figure 1-136 Search condition

Table 1-48 Item list (Search condition)

Item name Inputrule

Description

Target - Displays the search target. Selecting a group displays the check box to select whether tosearch groups in the specified group recursively.

Node Name Up to256characters

The entered node name becomes subject to the search.


76

Item name Inputrule

Description

Severity - The selected severity and severity range are searched. If the severity is not selected, allseverity levels are searched.

Mark - The selected mark is searched. If the mark is not selected, all marks are searched.

Generated 1970/01/01/00:00 to2999/12/3123:59(UTC)

The selected or entered range of the generation dates and times are searched.

Received 1970/01/01/00:00 to2999/12/3123:59(UTC)

The selected or entered range of the reception dates and times are searched.

Confirmation - The selected confirmation status ([Confirmed] or [Unconfirmed]) is searched. Be sure toselect either check box.

Message Text Up to1024characters

The entered message text is searched.

Description Up to256characters

The entered message summary is searched.

Application Up to1024characters

The entered application is searched.

Object Up to1024characters

The entered object is searched.

Message ID Up to128characters

The entered message ID is searched.

Comment Up to1024characters

The entered comment is searched.

Selecting a message from a list of messages displays the details of the selected message.


77

Figure 1-137 Message details

Table 1-49 Item list (Message details)


Node Displays a node. This is displayed by selecting a group.




Received Displays the reception date and time. The time is indicated with a time zone of a system.



Description Displays the message summary.



Message Definition ID Displays the message definition ID.


Comment Displays the comment.


[Confirm] button Changes the confirmation status.

[Edit comment] button Edits the comment.

Operations for messagesFor how to operate messages, see "1.2.3.1.2 Operations for messages (page 29)".

1.3.4 Service managementThis section describes the service management menu.

The service management menu provides the following function:

• Notice management


78

1.3.4.1 Notice management (user)This section describes the notice management function.

Only a tenant administrator can manage the notices. A tenant user can reference the notices.

Notice list (user)The [Notice management] screen is displayed by selecting [Service Management] and then [NoticeManagement] from the menu.


Table 1-50 Item list (Notice management)


Number of display items Changes the number of the displayed notices in the list.

Submit a new notice Displays the [Submit a new notice] screen.

Notice List Displays the list of notices.

To search for a notice, click [Search] on the [Notice management] screen and search it by thefollowing items. A string search is a partial match search.

Table 1-51 Item list ([Notice Search] screen)


Release period Period to publish a notice

State Any of the following:- Expired- Released- Not released

Title Title

Contents Contents of a notice

Attachment With or without an attached file- Yes- No



Registering a notice (user)This section describes how to add a notice.

1. On the [Notice management] screen, click [Submit a new notice].


79


2. The [Submit a new notice(Form)] screen is displayed. Enter the items by referring to thefollowing table and then click the [Confirm] button.

Figure 1-140 [Submit a new notice(Form)] screen

Table 1-52 Item list (Submit a new notice(Form))


Start date 1970/01/01/ 00:00to 2999/12/31 23:59(UTC)

Enter the start date and time.

End date 1970/01/01/ 00:00to 2999/12/31 23:59(UTC)

Enter the end date and time.

Title 64 characters Enter the title.

Contents 255 characters Enter the contents of the notice.

Attachment file(s) - The name of the attached file is displayed.

Browse... - Displays the dialog box to select a file to be attached.The maximum file size to be attached is 10 MB.* Note that a file whose size is 0 bytes cannot be attached.

Note- If a huge file is specified as a file to be attached to a notice, it takes much time to upload thespecified file. If a file exceeding 10 MB is uploaded, registration fails. Therefore, do not specify a fileexceeding 10 MB.- If there is notices that have been created by users with the exact same name, which user createdwhich notice is determined by the notice content. Therefore, be sure to create a notice so that thenotice can be distinguished by its content.

3. A notice is registered and the [Submit a new notice(Confirmation)] screen is displayed. Clickthe [Confirmation] button.


80

Figure 1-141 [Submit a new notice(Confirmation)] screen

Checking the detailed notice information (user)Clicking the line of the notice whose contents you want to check displays its detailed information.


Table 1-53 Item list (Notice details)


Start date Start date and time

End date End date and time

State - Expired- Released- Note releasedOne of the above.

Title Title

Contents Contents of the notice

Attachment file(s) Attached file name and link to the attached file

Submitter Person who registered the notice

Time stamp of submission Registration date and time

Edit notice Displays the [Edit notice] screen.

Delete notice Displays the [Delete notice] screen.

Editing the contents of the notice (user)This section describes how to change the notice.

1. On the [Notice details] screen, click [Edit notice].


81


2. The [Edit notice(Form)] screen is displayed. Edit each item by referring to "Table 1-52 Itemlist (Submit a new notice(Form)) (page 80)" of "1.3.4.1.2 Registering a notice (user) (page79)". Click the [Confirm] button to apply the changes.

To delete the attached file, select the [Delete attached file(s)] check box.

NoteIf the [Delete attached file(s)] check box is selected, file selection is disabled. Even if you select afile, it is assumed that the file is not selected.

Figure 1-144 [Edit notice(Form)] screen

3. The [Edit notice(Confirmation)] screen is displayed. Click the [Confirmation] button.

Figure 1-145 [Edit notice(Confirmation)] screen

Deleting the notice (user)This section describes how to delete a notice.

1. On the [Notice details] screen, click [Delete notice].


82


2. The [Delete notice(Confirmation)] screen is displayed. Click [Confirmation] to delete thenotice.

Figure 1-147 [Delete notice(Confirmation)] screen


83

Chapter 2. Command ReferenceThis chapter describes the commands of SystemManager G.

Contents2.1 API gateway operation command (msc_apigateway_cmd).........................................................85

2.2 License command (msc_license_cmd) .......................................................................................86

Chapter 2. Command Reference

84

2.1 API gateway operation command(msc_apigateway_cmd)

Format

# msc_apigateway_cmd --token [--address=ip_address] [--port=port_num] [--pass=password] [--file[=file_path]]

Functional description

Outputs an authentication token that will be used when a portal or a user application establishesconnection with the API gateway.

Describe the outputted authentication token in the HTTP header in the format of"Authorization :Bearer <token>" when establishing connection with the API gateway.

Example: "Authorization :Bearer d51398e8-d43b-3cc8-9e04-b6fde97eabe4"

This command is available when the common library (msc_common_library) is installed.

Option

Option Value used ifit is omitted

Description

--address=ip_address

-aip_address Specify the IP address of the API gateway or the host name in ip_address. If itis omitted, "localhost" will be applied.

--port=port_num -oport_num Specify the management HTTP port number of the API gateway in port_num. Ifit is omitted, "9763" will be applied.

--pass=password -ppassword Specify the administrator user (admin) password to the API gateway. If it isomitted, "admin" will be applied.

--file[=file_path] -f[file_path] When an option is specified, the authentication token will be output also to afile. When no option is specified, it will be output only to the standard output.In file_path, specify the full path to a file to which the authentication token willbe output. When file_path is omitted, the authentication token will be output tothe current directory as a token named "api_token".

Return value

Returnvalue

Description Action

0 Normal end -

64 Argument syntax error Use a correct syntax and execute the command again.

67 The administrator user (admin) passwordto the API gateway is incorrect.

Use a correct password and execute the command again.

69 Connection with the API gateway wasunable to be established. Or an erroroccurred on the API gateway.

Confirm that the API gateway has been started.

70 Internal software error. An error occurredwithin the command.

Please contact a technical support.


85

Returnvalue

Description Action

73 File output error. A file was unable to beoutput in the specified path.

Confirm that the environment, such as access authority over theoutput destination directory, permits the command to output a file.

Cautions

None

2.2 License command (msc_license_cmd)Format

• Registering a license key

# msc_license_cmd --add {--key=license-key|--File=license-file-path} [--outpath=file]

• Registering a codeword

# msc_license_cmd –register=codeword-file-path [--force]• Deleting a license

# msc_license_cmd --delete• Referencing a license

# msc_license_cmd --list

Functional description


Register the "license key" accompanying the purchased product.

Specify the license key with --key or the file defining the license key with --File.

Output the codeword application code to the file specified with --outpath.

Send the output file to your local NEC sales office, and obtain the codeword.


Register the "codeword" returned from NEC Corporation, and unlock the license.

Specify the codeword file with --register.

If you have received the codeword file from NEC Corporation without "registering a license",specify --force as well.

• Deleting a license

Delete a registered license.

If you specify --delete, the list of currently registered licenses is displayed.


86

Index,LicenseName(Licensekey),ProductID,LicenseID,LicenseNum,ExpireDate,Status1,SystemManager G 7.1 Manager (xxxxxx-xxxxxxxxxxx),103,1,99991231,enable2.SystemManager G 7.1 BusinessView Option (xxxxxx-xxxxxxxxxxx), 103,4,99991231,enablePlease input Index of an eliminated license.(It ends at quit or q.)ex:1 :1,3 :1-3Specify the index of the license to be deleted. Type 'q' repeatedly until the process quits.

• Referencing a license

Outputs a list of registered license information.

Option


Option Value used if itis omitted

Description

--add -a Specify the registration of a license key. Specify --key or --File.

--key -k Specify the license key.

--File -F Specify the file defining the license key.

--outpath -o Specify the file to which to output the code word application file. If thisoption is not specified, the file is output to the current directory with thefollowing file name.

codeword_** indicates an undefined value.



Description

--register -r Specify the registration of the code word of the specified file.

--force -f Specify this option to register the code word without registering a license.Use the option when you register a stored code word in such cases as toreinstall the code word to the system.

• Deleting a license


Description

--delete -d Delete a license.

• Referencing a license


Description

--list -l Directs that licenses be displayed in list form. Required.

Return value


87

Returnvalue

Description Action

0 Normal end -

64 Argument syntax error Use a correct syntax and execute the command again.

70 Internal software error. An error occurredwithin the command.

Check whether license management (License Component) isactive. If license management is active, contact the support center.

Cautions

None.


88

Appendix A. How to Start up and Stopthe Product

This product is automatically started up and stopped according to the startup and stop of the OS.When needing to start up or stop it manually, follow the procedure described below to perform theoperation.

A.1 How to start up and stop the managerDisplay "Services" window from links below and operate Start/Stop services.

[START] - [Controll Panel] - [Administrative Tools] - [Services]

Target Services

• Database

- postgresql-x64-9.6 - PostgreSQL Server 9.6

• API gateway

- SystemManager G API Gateway

• msc component

- SystemManager G License Service

- SystemManager G MessageStore Service

- SystemManager G Authorization Service

- SystemManager G ExternalLink Service

- SystemManager G Status Service

- SystemManager G BusinessView Service

• Portal/user authentication infrastructure

- Apache Tomcat 8.0 ServiceGovernor

Appendix A. How to Start up and Stop the Product

89

Appendix B. Revision History• First edition (August 2017): Newly created

Appendix B. Revision History

90

MasterScope SystemManager G 7.1 WebConsole OptionFunction Reference Guide

August, 2017 First Edition

NEC Corporation

©NEC Corporation 2017-2017

masterscope systemmanager g 7.1 webconsole · pdf file installation directory of...

Documents