MasterScope SystemManager G 7.1 WebConsole Option · Environment Configuration Guide First Edition August, 2017 NEC Corporation. ... The target readers need to be able to perform

MasterScope SystemManager G 7.1WebConsole Option

Environment Configuration 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 build a SystemManager G environment,and describes how to build the environment.

The target readers need to be able to perform basic operations of the Linux OS.

Overview of the documentThis document describes the procedures and settings for applying SystemManager G to an actualsystem.

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. Introduction............................................................................................................... 1

1.1 Cautions on building an environment ....................................................................................2

Chapter 2. HA Cluster................................................................................................................. 3

Chapter 3. Widget Options.......................................................................................................... 43.1 Creating a widget option file .................................................................................................5

3.1.1 Creating widgets.properties .........................................................................................53.1.2 Creating widgets_[Locale].properties .........................................................................63.1.3 URL replacement keywords ........................................................................................7

3.2 Editing preset widget option files ..........................................................................................7

Chapter 4. Settings for Display on the Monitoring Window ................................................... 84.1 Editing the display configuration file of the monitoring window...........................................9

Chapter 5. How to Back up and Restore Data ........................................................................ 115.1 Backing up the manager ......................................................................................................12

5.2 Restoring the manager.........................................................................................................13

Appendix A. Setting Items of the Property File ...................................................................... 16A.1 Setting items of the property file for msc components........................................................16

A.1.1 Common configuration file (msc_common.properties).............................................16A.1.2 License management configuration file (msc_license.properties) .............................18A.1.3 Authority management configuration file (msc_auth.properties) ..............................20A.1.4 External link configuration file (msc_extlink.properties)..........................................22A.1.5 Message store configuration file (msc_messagestore.properties) ..............................26A.1.6 Monitoring status management configuration file (msc_status.properties)................29A.1.7 Business view configuration file (msc_businessview.properties) ..............................32

Appendix B. Revision History................................................................................................... 35

v

List of TablesTable 3-1 Widget option file .....................................................................................................5Table 3-2 Format of widgets.properties.....................................................................................5Table 3-3 Format of widgets_ja.properties................................................................................6Table 3-4 URL replacement keyword .......................................................................................7Table 3-5 Preset files provided for the product..........................................................................7Table 4-1 Character code and line feed code of displaySetting.json ..........................................9Table 4-2 JSON format used for displaySetting.json.................................................................9

vi

Chapter 1. IntroductionThis chapter describes cautions for applying SystemManager G to an actual system.

Contents1.1 Cautions on building an environment ...........................................................................................2

Chapter 1. Introduction

1

1.1 Cautions on building an environment1. Perform the procedures described in this manual as the administrator user.

For procedures that are performed as a different user, a description is made.

Chapter 1. Introduction

2

Chapter 2. HA ClusterThis chapter describes how to build the SystemManager G manager in an HA cluster environment.For details on the installation and building of the manager, see "2.1 Installation (manager)" of"MasterScope SystemManager G v7.1 Installation Guide".

Chapter 2. HA Cluster

3

Chapter 3. Widget OptionsThe widget URLs from which a URL will be selected when a widget is added to the dashboard arecalled widget options. This chapter describes how to set a widget option file for the dashboard.

Contents3.1 Creating a widget option file ........................................................................................................5

3.2 Editing preset widget option files .................................................................................................7

Chapter 3. Widget Options

4

3.1 Creating a widget option fileThe following describes how to create a widget option file.

A widget option file consists of the following two types of files.

Table 3-1 Widget option file

File name Meaning

<Tomcat-install-folder>/conf/NEC/widgets.properties Main configuration file for widget options.Set URLs, authority, and titles in default language.

<Tomcat-install-folder>/conf/NEC/widgets_[Locale].properties

Language file for widget options.[Locale] is a language locale.When support for multiple languages is needed, morethan one language file can be created.For example, the file for Japanese is namedwidgets_ja.properties. When it is necessary to usedifferent indications between American English andBritish English, separate settings can be made bycreating widgets_en_US.properties andwidgets_en_UK.properties.

3.1.1 Creating widgets.propertiesThe following describes how to create widgets.properties, the main configuration file for widgetoptions. When editing a preinstalled widget option file, replace the file name appropriately.

widget.properties is stored in the following location.

<Tomcat-install-folder>/conf/NEC/widget.properties

Open widgets.properties with a text editor and then add, edit, or delete a widget option.widgets.properties is a file in property format.

Each widget option is described in the following format.

Table 3-2 Format of widgets.properties

Property key Default value Required/Optional Description

[Widget key].url - Required Set the URL of the widget.The URL needs to have been encoded.URL replacement keywords can be used. Fordetails, see "3.1.3 URL replacementkeywords (page 7)".

[Widget key].title - Required Set a character string that will be displayedas the widget option.If the language that is in agreement with theuser setting is not found, this character stringwill be used.When the set string consists of multibytecharacters, they need to be ASCII orUnicode characters containing an escapecharacter.

[Widget key].auth ALL Optional Set user authority for displaying the widgetoption.


5

Property key Default value Required/Optional DescriptionThe following character strings can be used.

• ALL: All users• ROLE_SYSTEM_ADMIN: System

administrator• ROLE_TENANT_ADMIN Tenant

administrator• ROLE_TENANT_USER: Tenant user

When setting multiple strings, separate themwith single-byte commas (,).If no setting is made, the default value,"ALL", will be applied.

Any character string can be set as [Widget key]. The widget addition dialog box of the dashboarddisplays URLs that are arranged by sorting [Widget key] in ascending order.

If "[Widget key].url" and "[Widget key].title" that have the set [Widget key] are not found, the widgetsetting will be regarded as invalid.

If multiple settings have the same [Widget key], only any one of them will be valid, and the otherswill be regarded as invalid.

The edits of widget.properties are applied to the server immediately. They are applied to the displayof the browser on reloading of the dashboard.

If a widget option is deleted from widget.properties, the relevant widget will be deleted the next timethe user loads the dashboard. You are recommended to notify the user of the deletion of the relevantwidget beforehand by using the "notice" function or some other means.

If the [Widget key].url of a widget option is edited in widget.properties, the URL to be loaded by therelevant widget will be changed the next time the user loads the dashboard. You are recommended tonotify the user of the change to the relevant widget setting beforehand by using the "notice" functionor some other means.

3.1.2 Creating widgets_[Locale].propertiesThe following describes how to create widgets_[Locale].properties, the language setting file forwidget options. When editing a preinstalled widget option file, replace the file name appropriately.

widgets_[Locale].properties is stored in the following location.

<Tomcat-install-folder>/conf/NEC

In the following, a description is given for widgets_ja.properties, a setting file for the Japaneselanguage, as an example. When creating a setting file for a different language, replace the file nameappropriately.

Open widgets_ja.properties with a text editor and then add, edit, or delete the language setting of awidget option. widgets_ja.properties is a file in property format.

Each widget option is described in the following format.

Table 3-3 Format of widgets_ja.properties

Property key Default value Required/Optional Description

[Widget key].title - Optional Set a character string that will be displayedas the internationalized string for the widgetoption.


6

Property key Default value Required/Optional DescriptionWhen the set string consists of multibytecharacters, they need to be ASCII orUnicode characters containing an escapecharacter.If this setting is omitted, the value of [Widgetkey].title set in widgets.properties.

If "[Widget key].url" having the [Widget key] is not found in widgets.properties, the widget settingwill be regarded as invalid.

If multiple settings have the same [Widget key], only any one of them will be valid, and the otherswill be regarded as invalid.

The edits of widgets_ja.properties are applied to the server at intervals of approximately 10 seconds.They are applied to the display of the browser on reloading of the dashboard.

3.1.3 URL replacement keywordsURL replacement keywords can be set for the URLs of widget options.

The following URL replacement keywords can be used to set the URLs of widget options.

Table 3-4 URL replacement keyword

URL replacement keyword Description

TenantName Replace the URL with the tenant ID of the login user.When the user is logged in as the system administrator, it is a null characterstring. When the system administrator acts as a tenant, the URL is replacednot with the tenant ID of the relevant tenant but with a null character.

%USERID% Replaces the URL with the user ID of the login user.

3.2 Editing preset widget option filesWidget option files provided as preset files for the product can be customized depending on thepurpose of the operation.

The preset files for widget options are stored in the following location.

<Tomcat-install-folder>/conf/NEC

The following types of preset files are provided for the product.

Table 3-5 Preset files provided for the product

Widget option mainconfiguration file

Widget optionlanguage setting file

Description

cloudportal.common.properties

cloudportal.common_ja.properties

This file defines a window for common functions as awidget option.

sysmgrg.monitoring.properties

sysmgrg.monitoring_ja.properties

This file defines a window for monitoring functions as awidget option.

The widget option main configuration file can be edited in the same manner as forwidgets.properties. For details, see "3.1.1 Creating widgets.properties (page 5)".

The widget option language setting file can be edited in the same manner as forwidgets_[Locale].properties. For details, see "3.1.2 Creating widgets_[Locale].properties (page 6)".


7

Chapter 4. Settings for Display on the MonitoringWindowThe names and colors displayed on the monitoring window can be customized by editing theconfiguration file. This chapter describes how to set the display configuration file of the monitoringwindow.

Contents4.1 Editing the display configuration file of the monitoring window..................................................9

Chapter 4. Settings for Display on the Monitoring Window

8

4.1 Editing the display configuration file of themonitoring window

The following describes how to edit the display configuration file of the monitoring window.

The display configuration file of the monitoring window is stored in the following location.

<Tomcat-install-folder>/conf/NEC/displaySetting.json

The values described immediately after installation are default values.

Open displaySetting.json with a text editor and then add, edit, or delete the settings for display on themonitoring window. displaySetting.json is a JSON format file.

Its character code and line feed code are as follows.

Table 4-1 Character code and line feed code of displaySetting.json

Item Value

Character code UTF (without BOM)

Line feed code LF or CRLF

Display on the monitoring window can be configured separately for each tenant.

JSON format is defined by the following values.

Table 4-2 JSON format used for displaySetting.json

Parameter Datatype

Description Valid value

(ROOT) object[] Root object -

(*) object Display settings for onetenant

-

tenant string Tenant ID 1 to 14 single-byte alphanumeric characters.If omitted or specified with a null or a nullcharacter, it will be regarded as a setting forthe whole system (default value used whenno setting is made in the tenant IDspecification).If multiple tenants have the same tenant ID,the setting corresponding to any one ofthem will be valid, and the settingscorresponding to the others will be ignored.

severities object[] Severity setting array -

severities[n].severity number Severity value Integer value from 0 to 255.If it is omitted or specified with a null, thesettings for displaying severity will beregarded as default (not specified).If specified with an invalid value, thesetting will be invalid.If multiple tenants have the same severityvalue, the setting corresponding to any oneof them will be valid, and the settingscorresponding to the others will be ignored.


9

Parameter Datatype

Description Valid value

severities[n].bg_color string Background color Hexadecimal triplet format (with no #included).If omitted or specified with an invalidvalue, it will be regarded as FFFFFF(white).

severities[n].fg_color string Character color Hexadecimal triplet format (with no #included).If omitted or specified with an invalidvalue, it will be regarded as 000000 (black).

severities[n].display_name Severitydisplayname

String consisting of 1 to 256 characters.Control characters are excluded.If included, control characters will beremoved. The 257th and later characters ofthe string will be ignored.If omitted or specified with an invalidvalue, it will be regarded as specified with anull character.Duplicate display names are used as theyare.

marks object[] Mark setting array -

marks[n].mark string String that uniquelyidentifies the mark

1 to 64 single-byte alphanumeric characters,hyphens, and/or underscores.If omitted or specified with an invalidvalue, the setting will be invalid.If multiple tenants have the same mark, thesetting corresponding to any one of themwill be valid, and the settings correspondingto the others will be ignored.

marks[n].display_name string Mark display name String consisting of 0 to 256 characters.Control characters are excluded.If included, control characters will beremoved. The 257th and later characters ofthe string will be ignored.If omitted or specified with an invalidvalue, a character string, marks[n].mark,will be used.Duplicate display names are used as theyare.


10

Chapter 5. How to Back up and Restore DataThis chapter describes how to back up and restore the data of MasterScope SystemManager G.

Contents5.1 Backing up the manager .............................................................................................................12

5.2 Restoring the manager................................................................................................................13

Chapter 5. How to Back up and Restore Data

11

5.1 Backing up the managerThis section describes how to back up the manager.

Note• The description is given on the premise that all the components of the manager are installed on one

machine. When dispersedly installing them on more than one machine, replace terms appropriately inthe description.

• The description is given on the premise that the backup data will be stored in the C:\backup directory.If a different directory is used for the backup, replace terms appropriately in the description.

• Online backup is not supported. Acquire backups after stopping the components.• For databases (PostgreSQL), the following describes a logical backup method using the pg_dumpall

command. Perform physical backup in such cases where it is necessary to shorten backup time.

1. Stop the API gateway, the msc components, and the portal/user authentication infrastructure.

• SystemManager G API Gateway

• SystemManager G License Service

• SystemManager G MessageStore Service

• SystemManager G Authorization Service

• SystemManager G ExternalLink Service

• SystemManager G Status Service

• SystemManager G BusinessView Service

• Apache Tomcat 8.0 ServiceGovernor

2. Acquire the backup of the msc components.

• Make a backup directory. (C:\backup\opm)

• Make zip files.

- <install-folder>\conf

→ C:\backup\opm\conf.zip

- <install-folder>\data

→ C:\backup\opm\data.zip

NoteIn an HA cluster environment, back up the data directory present on the shared disk. Back up the confdirectory on both the active and standby nodes.

3. Acquire the backup of the API gateway.

• Make a backup directory. (C:\backup\wso2am)

• Make zip files.

- <wso2-install-folder>\solr

→ C:\backup\wso2am\solr.zip

- <wso2-install-folder>\repository\deployment\server

→ C:\backup\wso2am\server.zip

- <wso2-install-folder>\repository\components\default\configuration


12

→ C:\backup\wso2am\configuration.zip

NoteThe tar command at the end is indicated on the separate lines due to the limited space. However,specify the command in one line.

4. Acquire the backup of the portal/user authentication infrastructure.

• Make a backup directory. (C:\backup\msc_portal)

• Make zip files.

- <Tomcat-install-folder>\conf

→ C:\backup\msc_portal\conf.zip

- <Tomcat-install-folder>\cloudportal

→ C:\backup\msc_portal\cloudportal.zip

NoteIn an HA cluster environment, back up the cloudportal directory present on the shared disk. Back upthe conf directory on both the active and standby nodes.

5. Acquire the backups of the databases.

> mkdir C:\backup\pgsql> mkdir %APPDATA%\postgresql> echo localhost:5432:*:postgres:********> %APPDATA%\postgresql\pgpass.conf> "C:\Program Files\PostgreSQL\9.6\bin\pg_dumpall.exe" -U postgres -c -f C:\backup\pgsql\db_dumpall.sql> del %APPDATA%\postgresql\pgpass.conf> exit

Note• Specify ******** with the administrator user (postgres) password.• Perform a restore while the databases are in operation.

6. Start up the API gateway, the msc components, and the portal/user authenticationinfrastructure.









5.2 Restoring the managerThe following describes how to restore the manager.


13

Note• The description is given on the premise that all the components of the manager are installed on one

machine. When dispersedly installing them on more than one machine, replace terms appropriately inthe description.

• The description is given on the premise that the manager has been installed before the data restore. Inan HA cluster environment, complete tasks as far as the re-setup of the HA cluster.

• The description is given on the premise that the backup data are stored in the C:\backup directory. Ifthe backup data are stored in another d directory, replace terms appropriately in the description.

• Online restore is not supported. Restore data after stopping the components.• For databases (PostgreSQL), the description is given on the premise that a logical backup has been

acquired by using the pg_dumpall command.

1. Stop the API gateway, the msc components, and the portal/user authentication infrastructure ifthey are in operation.









2. Extract the backup data(zip) of the msc components.

• C:\backup\opm\conf.zip

→ C:\backup\opm\conf

• C:\backup\opm\data.zip

→ C:\backup\opm\data

3. Restore the backup data of the msc components.

> rmdir /s /q "<install-folder>\conf"> xcopy /E /R /K /Y C:\backup\opm\conf "<install-folder>\conf\"> rmdir /s /q "<install-folder>\data"> xcopy /E /R /K /Y C:\backup\opm\data "<install-folder>\data\"

NoteIn an HA cluster environment, restore the data directory on the shared disk. Restore the confdirectory on both the active and standby nodes.

4. Extract the backup data(zip) of the API gateway.

• C:\backup\wso2am\wso2am.zip

→ C:\backup\wso2am\solr

• C:\backup\wso2am\server.zip

→ C:\backup\wso2am\repository\deployment\server

• C:\backup\wso2am\configuration.zip


14

→ C:\backup\wso2am\repository\components\default\configuration

5. Restore the backup data of the API gateway.

> rmdir /s /q "<wso2-install-folder>\solr"> rmdir /s /q "<wso2-install-folder>\repository\deployment\server"> rmdir /s /q "<wso2-install-folder>\repository\components\default\configuration"> xcopy /E /R /K /Y C:\backup\wso2am "<wso2-install-folder>"

6. Extract the backup data of the portal/user authentication infrastructure.

• C:\backup\msc_portal\conf.zip

→ C:\backup\msc_portal\conf

• C:\backup\msc_portal\cloudportal.zip

→ C:\backup\msc_portal\cloudportal

7. Restore the backup data of the portal/user authentication infrastructure.

> rmdir /s /q "<Tomcat-install-folder>\conf"> rmdir /s /q "<Tomcat-install-folder>\cloudportal"> xcopy /E /R /K /Y C:\backup\msc_portal "<Tomcat-install-folder>\"

NoteIn an HA cluster environment, restore the cloudportal directory on the shared disk. Restore the confdirectory on both the active and standby nodes.

8. Restore the backup data of the databases.

> "C:\Program Files\PostgreSQL\9.6\bin\psql.exe" -f C:\backup\pgsql\db_dumpall.sql -U postgresPassword:　　　　　　　　　　　　　　 ← Enter the password of the database management user (postgres).> exit

NotePerform a restore while the databases are in operation.

9. Start up the API gateway, the msc components, and the portal/user authenticationinfrastructure.










15

Appendix A. Setting Items of theProperty File

A.1 Setting items of the property file for msccomponents

The following describes the setting items of the property file for msc components.

A.1.1 Common configuration file (msc_common.properties)This configuration file is used to make settings common to msc components. The settings describedin this file are valid for all the msc components installed on the relevant machine.

File location

<install-folder>\manager\conf\msc_common.properties

Format

It is a text format file (Character code: UTF-8; Line feed code: LF).

Describe a key and a value in each line by coupling them with "=" placed in-between.

When including a comment in the file, place # at the top of the relevant line.

A file in which valid values are commented out is stored in the "<install-folder>\manager\conf\sample" directory. Use the file as a reference for file format.

Description of keys

Key Description Value used if itis omitted

system.name Manager name. When multiple managers are installed, it is used to identify therelevant manager.When dispersedly installing components, specify it with the same value on allthe machines without any omissions.Only the following characters can be used: a to z, A to Z, 0 to 9, a hyphen (-),and an underscore (_). Specify it with up to 128 characters.

Host name ofthe machine

log.size Log file size (KB). If this value is exceeded, log file rotation will be performed.Specify it with a value from 100 to 100000.

5000

log.purge_count

Number of generations during which the log file will be stored. In log rotation,past logs corresponding to the specified number of generations will be stored.Specify it with a value from 1 to 9.

4

log.level Log file output level.Specify it with a value from 1 to 8. The larger the value is, the more the logs areoutput.

6

log.path Log file output directory.Specify it with the absolute path to a valid directory.

<install-folder>\manager\log

data.path Data storage directory.Specify it with the absolute path to a valid directory. For an HA clusterconfiguration, specify it with the path to a shared disk.

<install-folder>\manager\data

Appendix A. Setting Items of the Property File

16


http.listen_address

Listening IP address of each component, or host name resolvable by nameresolution.Specify it when dispersedly installing msc components.

localhost

license.address Listening IP address of the license management component. Or host nameresolvable by name resolution.Specify it when dispersedly installing msc components.

localhost

license.port Port number of the listening port of the license management component.Change it appropriately when http.listen_port has been changed in thelicense.properties file.

22522

database.server

IP address of the database. Or host name resolvable by name resolution.Specify it when the component operates on a machine different from themachine on which the database operates.

localhost

database.port Port number of the listening port of the database.Specify it when the listening port number has been changed in the database(PostgreSQL) settings.

5432

database.admin.user

Name of the administrator user of the database. postgres

database.admin.pass

Administrator password to the database. postgres

database.admin.pass.hide *1

Encryption function for the administrator password to the database.When it is specified with "on", the database administrator password described inthe property file can be encrypted.

off

database.user Connection user of the database.The user is automatically created at the start of the component. Accordingly, it isnot necessary to create it in advance.

Componentname(Example:msc_messagestore)

database.pass Connection password to the database.If specifying it at your discretion, make the specification before the first startupof the component. User information is created at the first startup. Accordingly, ifthe password is changed after the first startup, connection to the database cannotbe established.When the connection user password has been changed by using a setting tool ofthe database or the like, make a change appropriately for the changed password.

Componentname(Example:msc_messagestore)

database.pass.hide *1

Encryption function for the connection password to the database.When it is specified with "on", the database connection password described inthe property file can be encrypted.

off

database.driver Name of the connection driver of the database. PostgreSQLUnicode(x86)

apigateway.address

IP address of the API gateway. Or host name resolvable by name resolution.Specify it when the component operates on a machine different from themachine on which the API gateway operates.

localhost

apigateway.port

Port number of the (HTTP) listening port for API registration of the APIgateway.

9763

apigateway.password

Administrator (admin) password to the API gateway. admin


17


apigateway.password.hide *1

Encryption function for the administrator (admin) password to the API gateway.When it is specified with "on", the API gateway administrator (admin) passworddescribed in the property file can be encrypted.

off

*1 When "*****.hide = on" is set, encryption processing will be performed at the startup of thecomponent. Once encrypted, passwords cannot be decrypted.

Note• If the same key is described in the configuration file dedicated to msc components, the corresponding

setting made in the configuration file dedicated to msc components will be valid.• The settings described in this file are applied on the restart of the relevant msc component. After a

setting change is made, restart the msc component.

A.1.2 License management configuration file(msc_license.properties)

This configuration file is dedicated to license management components.

File location

<install-folder>\manager\conf\msc_license.properties

Format





Description of keys


system.name*1

Manager name. When multiple managers are installed, it is used to identify therelevant manager.When dispersedly installing components, specify it with the same value on allthe machines without any omissions.Only the following characters can be used: a to z, A to Z, 0 to 9, a hyphen (-),and an underscore (_). Specify it with up to 128 characters.

Host name of themachine

log.size *1 Log file size (KB). If this value is exceeded, log file rotation will be performed.Specify it with a value from 100 to 100000.

5000

log.purge_count *1


4

log.level *1 Log file output level.Specify it with a value from 1 to 8. The larger the value is, the more the logs areoutput.

6


18


log.path *1 Log file output directory.Specify it with the absolute path to a valid directory.


data.path *1 Data storage directory.Specify it with the absolute path to a valid directory. For an HA clusterconfiguration, specify it with the path to a shared disk.


http.listen_address *1


localhost

http.listen_port

Port number of listening port of the component. Specify it with a value that doesnot conflict within each machine.

22522

http.min_threads

Minimum number of API reception processing threads.Specify it with a value from 1 to 1000.

1

http.max_threads

Maximum number of API reception processing threads.Specify it with a value from 1 to 1000.

10

http.max_queue

Maximum number of queues that wait for API reception processing request.Specify it with a value from 1 to 1000.

64

http.thread.stack_size

Stack size of API reception processing threads.Specify it with a value in bytes that ranges from 0 to the maximum valid size ofthe system. When it is specified with 0, the default size of the system will beused.

0 (default size ofthe system)

location.operation_if.address

Listening IP address of IoT Connectivity Engine, or host name resolvable byname resolution.Specify it when dispersedly installing msc components.

localhost

location.operation_if.port

Port number of the listening port of IoT Connectivity Engine.Change it appropriately when the port number of the listening port of IoTConnectivity Engine has been changed.

22401

apigateway.port


9763

apigateway.password


apigateway.password.hide*1


off

*1 Making settings in the common configuration file (msc_common.properties) will allow you to applyunified settings to the whole manager. Use this specification method only to make settings unique tocomponents.

NoteThe settings described in this file are applied on the restart of the license management. After a setting changeis made, restart the license management.


19

A.1.3 Authority management configuration file(msc_auth.properties)

This configuration file is dedicated to authority management components.

File location

<install-folder>\manager\conf\msc_auth.properties

Format





Description of keys


system.name*1




5000

log.purge_count *1


4


6







localhost

http.listen_port


22520

http.max_queue


64





20


license.address *1

Listening IP address of the license management component. Or host nameresolvable by name resolution.Specify it when dispersedly installing msc components.

localhost

license.port *1 Port number of the listening port of the license management component.Change it appropriately when http.listen_port has been changed in thelicense.properties file.

22522

database.server *1


localhost

database.port*1

Port number of the listening port of the database.Specify it when the listening port number has been changed in the database(PostgreSQL) settings.

5432

database.admin.user *1


database.admin.pass *1



*2


off

database.dbname

Database name. msc_auth

database.user*1

Connection user of the database.The user is automatically created at the start of the component. Accordingly, itis not necessary to create it in advance.

msc_auth

database.pass*1

Connection password to the database.If specifying it at your discretion, make the specification before the first startupof the component. User information is created at the first startup. Accordingly, ifthe password is changed after the first startup, connection to the database cannotbe established.When the connection user password has been changed by using a setting tool ofthe database or the like, make a change appropriately for the changed password.

msc_auth

database.pass.hide *1 *2


off

database.driver *1

Name of the connection driver of the database. PostgreSQLUnicode(x86)

database.max_field_size

Upper limit of the return size of the text type data of the database.Specify it with a value from 1024 to 2147483647.

10485760

apigateway.address *1


localhost

apigateway.port *1


9763

apigateway.user

Name of the administrator user of the API gateway. admin


21


apigateway.password *1


apigateway.password.hide*1 *2


off

apigateway.proxy_address

Connection destination address that will be used when HTTP requests areproxied from the API gateway to the component.

The value ofhttp.listen_address is used.

apigateway.proxy_port

Port number of the connection destination port that will be used when HTTPrequests are proxied from the API gateway to the component.

The value ofhttp.listen_port isused.

service_start.retry

Number of retries for establishing connection with other components during thestartup processing of the component.Specify it with a value from 0 to 2147483647. When it is specified with 0, retrywill be repeated unlimitedly.

0 (unlimited)

service_start.retry_interval

Retry interval for establishing connection with other components during thestartup processing of the component.Specify it with a value in seconds that ranges from 1 to 86400.

60

authentication_server.address

IP Address of the user authentication infrastructure. Or host name resolvable byname resolution.Specify it when dispersedly installing msc components.

localhost

authentication_server.port

Port number of the listening port of the user authentication infrastructure.Change it appropriately when the port number of the listening port of the userauthentication infrastructure has been changed.

12080

authentication_server.application_name

Application name of the user authentication infrastructure.Change it appropriately when the application name of the user authenticationinfrastructure has been changed.

portal



NoteThe settings described in this file are applied on the restart of the authority management. After a settingchange is made, restart the authority management.

A.1.4 External link configuration file (msc_extlink.properties)This is an external link component-specific configuration file.

File location

<install-folder>\manager\conf\msc_extlink.properties

Format

Text format file with a character code of UTF-8 and line feed code of LF.


22

On each line, write a key and a value, concatenating with "= ".

To write a comment in a file, start the line with #.

A file with each valid value commented out is stored in the <installation-folder>/manager/conf/sample directory, which can be used as a reference for the format.

Description of keys

Key Description Default value

system.name*1



log.size *1 Log file size (KB). If this size is exceeded, the log file is rotated.Specify a value within the range of 100 to 100000.

5000

log.purge_count *1

Number of generations of the log file to save. When the log is rotated, the pastlog is saved for the specified number of generations.Specify a value within the range of 1 to 9.

4

log.level *1 Output level of the log file.Specify a value within the range of 1 to 8. The larger the value, the more logsare output.

6

log.path *1 Output directory of the log file.Specify a valid directory with an absolute path.


data.path *1 Directory for data storage.Specify a valid directory with an absolute path. For an HA cluster configuration,specify a path on the shared disk.



Standby IP address of each component or a host name for which nameresolution can be performed.Set one if distributing msc components.

localhost

http.listen_port

Standby port number of the component. Specify a noncompetitive value in thesame machine.

22529

http.min_threads

Minimum number of API reception process threads.Specify a value within the range of 1 to 1000.

1

http.max_threads

Maximum number of API reception process threads.Specify a value within the range of 1 to 1000.

10

http.max_queue

Maximum number of API reception process request queues.Specify a value within the range of 1 to 1000.

64


Stack size of the API reception process thread.Specify it in byte units within the range of 0 to the maximum valid size of thesystem. If 0 is specified, the default size of the system is adopted.


license.address *1

Standby IP address of the license management component. Or, a host name forwhich name resolution can be performed.Set one if distributing msc components.

localhost

license.port *1 Standby port number of the license management component.If http.listen_port in the license.properties file is changed, change it accordingly.

22522


23


database.server *1

IP address of the database. Or, a host name for which name resolution can beperformed.Set one if the operation is to be performed in a machine separate from thedatabase.

localhost

database.port*1

Standby port number of the database.Set one if the standby port number is changed with database (PostgreSQL)settings.

5432


Database administrator user name. postgres


Database administrator password. postgres


*2

Database administrator password encryption function.By specifying "on", it is possible to encrypt the database administrator passwordcontained in the property file.

off

database.dbname

Database name. msc_extlink

database.user*1

Database connecting user.A user is automatically created when a component is started. It is not necessaryto create one in advance.

msc_extlink

database.pass*1

Database connection password.If wanting to specify any desired one, specify it before the component is startedfor the first time. User information is created when it is started for the first time.Thus, if the password is changed after it is started for the first time, it is nolonger possible to connect to the database.If the password of the connecting user is changed from a database setting tool,etc., change the password according to the value.

msc_extlink


Database connection password encryption function.By specifying "on", it is possible to encrypt the database connection passwordcontained in the property file.

off

database.driver *1

Database connecting driver name. PostgreSQLUnicode(x86)


Upper limit on the return size of the text type data of the database.Specify a value within the range of 1024 to 2147483647.

8190


IP address of the API gateway. Or, a host name for which name resolution canbe performed.Set one if operation is to be performed in a machine different from the APIgateway.

localhost

apigateway.port *1

Number of the standby port for API gateway API registration (HTTP). 9763


API gateway administrator (admin) password. admin


API gateway administrator (admin) password encryption function.By specifying "on", it is possible to encrypt the API gateway administrator(admin) password contained in the property file.

off


Connection destination address to use to proxy an HTTP request from the APIgateway to the component.

Use the value ofhttp.listen_address


24



Connection destination number to use to proxy an HTTP request from the APIgateway to the component.

Use the value ofhttp.listen_port


Interval (seconds) of retries to confirm the existence of the link componentduring a component start process.Specify a value in second units within the range of 10 to 86400.

10

service_start.retry

Number of retries to confirm the existence of the link component during acomponent start process.

0 (Unlimited)

external_product.count

Number of link destination definitions.Specify the number of managers to link to.

0

external_product.1.management_id

Identifier for identifying the link destination manager.Specify the "local host name of manager" specified when installing the manager.

(sample)external_product.count=1external_product.1.management_id=SystemManagerGexternal_product.1.url=http://localhost:20100

-

external_product.1.url

URL of the manager executing recovery. The only specifiable protocol is "http".For the port number, specify the value that is set with the Web API function ofthe manager.Specification method　http://<Host address of the manager>:<Port number>

(sample)external_product.count=1external_product.1.management_id=SystemManagerGexternal_product.1.url=http://localhost:20100

-

external_product.1.config.user_name

Name of the user executing recovery. -

external_product.1.healthcheck.use

Specify whether to perform alive monitoring.0:off、1:on

0:off

external_product.1.healthcheck.interval

Interval (seconds) at which to perform manager alive monitoring.Specify a value in second units within the range of 30 to 86400.

60

tenant.auto_register_id

Default tenant when registering a node. -

*1 By setting it in the common configuration file (msc_common.properties), it is possible to use the samesetting throughout the manager. Specify it only if wanting to make component-specific settings.

*2 The encryption process to be performed if "*****.hide = on" is performed when the component isstarted. Once encrypted, the password cannot be decrypted.

NoteThe settings made in this file are reflected when the external link component is restarted. After changing anysettings, restart the external link component.


25

A.1.5 Message store configuration file(msc_messagestore.properties)

This configuration file is dedicated to message store components.

File location

<install-folder>\manager\conf\msc_messagestore.properties

Format





Description of keys


system.name*1




5000

log.purge_count *1


4


6







localhost

http.listen_port


22524

http.min_threads


1

http.max_threads


20


26


http.max_queue


128




license.address *1


localhost


22522

database.server *1


localhost

database.port*1


5432






*2


off

database.dbname

Database name. msc_messagestore

database.user*1


msc_messagestore

database.pass*1


msc_messagestore



off

database.driver *1




10485760


27




localhost

apigateway.port *1

Port number of the HTTP listening port of the API gateway. 9763

apigateway.user






off







definition.language

Language setting for message definition.Specify it with ja (Japanese) or en (English).

ja

message.delete_schedule

Time for periodic message deletion.Specify it in the HHMM format. If this key is not specified, periodic deletionwill not be performed.

None (periodicdeletion will notbe performed.)

message.stored_number

Number of messages to be retained. If the number of accumulated messagesexceeds the specified number, excess messages will be deleted at the time ofperiodic deletion.

30240000

thread.filter_max

Maximum number of threads that perform message filtering.Specify it with a value from 10 to 100.

100

thread.customize_max

Maximum number of threads that perform message generation.Specify it with a value from 10 to 250.

250

queue.store_max

Maximum queue size for message storing.Specify it with a value from 1 to 1000.

500

queue.filter_max

Maximum queue size for message filtering.Specify it with a value from 1 to 1000.

500

queue.report_max

Maximum queue size for reporting.Specify it with a value from 1 to 1000.

500

option.agent_event_receive_interval

Interval of acquiring notifications received from agents from IoT ConnectivityEngine.Specify it with a value in milliseconds that ranges from 100 to 3600000.

1000

option.agent_event_receive_limit

Maximum number of notifications received from agents that are acquired fromIoT Connectivity Engine.Specify it with a value from 1 to the maximum valid size of the system.

1000


28



NoteThe settings described in this file are applied on the restart of the message store. After a setting change ismade, restart the message store.

A.1.6 Monitoring status management configuration file(msc_status.properties)

This configuration file is dedicated to monitoring status management components.

File location

<install-folder>\manager\conf\msc_status.properties

Format





Description of keys


system.name*1




5000

log.purge_count *1


4


6






29




localhost

http.listen_port


22523

http.min_threads


1

http.max_threads


1

http.max_queue


64




license.address *1


localhost


22522

database.server *1


localhost

database.port*1


5432






*2


off

database.dbname

Database name. msc_status

database.user*1


msc_status


30


database.pass*1


msc_status



off

database.driver *1




10485760



localhost

apigateway.port *1


apigateway.user






off







service_start.retry

Number of retries for establishing connection with other components during thestartup processing of the component.Specify it with a value from 0 to 2147483647. When it is specified with 0, retrywill be repeated unlimitedly.

0 (unlimited)


Retry interval for establishing connection with other components during thestartup processing of the component.Specify it with a value in seconds that ranges from 1 to 86400.

10

status.notify.thread.num

Maximum number of threads that process notification from agents.Specify it with a value from 1 to 1000.

10

option.agent_event_receive_interval

Interval of acquiring notifications received from agents from IoT ConnectivityEngine.Specify it with a value in milliseconds that ranges from 100 to 3600000.

1000


31


option.agent_event_receive_limit

Maximum number of notifications received from agents that are acquired fromIoT Connectivity Engine.Specify it with a value from 1 to the maximum valid size of the system.

1000



NoteThe settings described in this file are applied on the restart of the monitoring status management. After asetting change is made, restart the monitoring status management.

A.1.7 Business view configuration file(msc_businessview.properties)

This configuration file is dedicated to business view components.

File location

<install-folder>\manager\conf\msc_businessview.properties

Format





Description of keys


system.name*1




5000

log.purge_count *1


4


6


32








localhost

http.listen_port


22530

http.min_threads


1

http.max_threads


20

http.max_queue


128




license.address *1


localhost


22522

database.server *1


localhost

database.port*1


5432






*2


off

database.dbname

Database name. msc_businessview

database.user*1


msc_businessview


33


database.pass*1


msc_businessview



off

database.driver *1




10485760



localhost

apigateway.port *1


apigateway.user






off









NoteThe settings described in this file are applied on the restart of the business view. After a setting change ismade, restart the business view.


34

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

Appendix B. Revision History

35

MasterScope SystemManager G 7.1 WebConsole OptionEnvironment Configuration Guide

August, 2017 First Edition

NEC Corporation

©NEC Corporation 2017-2017

Documents

MasterScope SystemManager G 7.1 WebConsole Option · Environment Configuration Guide First Edition August, 2017 NEC Corporation. ... The target readers need to be able to perform