Job Management Partner 1/Performance Management Planning and Configuration Guide

5.4.6 Changing PFM - Web Console settings

Use the Windows initialization file (config.xml) to set the environment necessary to operate PFM - Web Console.

The Windows initialization file (config.xml) is stored in installation-folder\conf\.

Note:

The Windows initialization file (config.xml) is loaded when a PFM - Web Console service starts. Restart the PFM - Web Console service to enable the settings you changed in the Windows initialization file. Change only the required information. PFM - Web Console might not operate correctly if you change locations that are not specified.

Items to set in the Windows initialization file are described below.

Organization of this subsection

(1) Items to set in Windows initialization file (config.xml)

(2) Procedure to return a changed Windows initialization file (config.xml) to the default

(1) Items to set in Windows initialization file (config.xml)

Items set in the config.xml file are as follows:

(a) File output settings

The following table lists and describes the config.xml file items used to change the settings related to output of the PFM - Web Console file.

Table 5-18 File output settings

Content Item Available value Default value

Output directory for log files logDir Directory to which PFM - Web Console outputs log files installation-folder\log

Number of log files output by PFM - Web Console logFileNumber 1 - 16 10^#

Size of each log file logFileSize 1 - 100 4^#

Number of days to keep log files logFileRetention 1 - 30 30^#

Line terminal code for output in files lineSeparator

CRLF:
Linefeed code used in Windows

LF:
Linefeed code used in UNIX

CRLF^#

Character code for output in files characterCode

US-ASCII

Windows-1252

ISO-8859-1

UTF-8

UTF-16

UTF-16BE

UTF-16LE

US-ASCII^#

File name to output csvFileName

Numbers from 0 - 9

. (Period)

_ (Underscore)

Space

Alphabet letters A - Z, a - z

You can specify up to 100 characters although you cannot specify a name that consists only of spaces and periods. Export.csv^#

#

The default value is set if you specify an invalid value.

(b) Setting PFM - Manager for the connection destination

The following table lists and describes the config.xml file items used to change settings for PFM - Manager for the connection destination of PFM - Web Console.

Table 5-19 Settings for PFM - Manager for the connection destination

Content Item Available value Default value

Host name or IP address of PFM - Manager for the connection destination host

For host name:

- Numbers from 0 - 9

- . (Period)

- - (Hyphen)

- Alphabet letters A - Z, a - z

You can use 1 - 32 characters.

For IP address:

- From 0.0.0.0 to 255.255.255.255

localhost^#

Port number for the View Server service by PFM - Manager for the connection destination port 1024 - 65535 22286^#

#

The default value is set if you specify an invalid value or omit a required value.

Note:

Do not specify the following port numbers in order to avoid duplication of port numbers used by other processes.

Port numbers assigned by the OS (port numbers called dynamic port or ephemeral port)

(c) Data acquisition and display settings

The following table lists and describes the config.xml file setting items used to change settings related to data acquisition and display for PFM - Web Console.

Table 5-20 Data acquisition and display settings

Content Item Available value Default value

Maximum number of records obtained from PFM - Manager maxFetchCount
(under the <vsa> tag) 1 - 2,147,483,647 (Integer) 1,440

Number of records displayed per one page of the report window table displayCountPerPage 1 - 2,147,483,647(Integer) 20

Maximum number of records saved in the cache for one real time report. maxRealtimeCache 1 - 360 (Integer) 30

Interval for automatic update updateInterval 10 - 3,600 60

Specifiable range for conditional expression definitions that use ulong data types condExpValueUlongExtension

Specified value: Specifiable range of ulong data type

true: 0 - 4,294,967,295

false: 0 - 2,147,483,648

false

Maximum number of characters displayable as a label on a report graph^#1 maxSeriesLabelLength 1 - 1,024 30

Whether block transfer mode is enabled blockTransferMode true (enabled)
false (disabled) true

Maximum number of reports displayable by tiling maxTileReports 1 - 256 50

Interval time limit for an automatic update request of a real-time report^#2 realtimeCacheInterval^#3 60,000 - 3,600,000 (Milliseconds) 600,000

Installation location of the repository^#3 for saving the definition information of the bookmark function bookmarkRepository^#3 Use an absolute pathname.
Maximum path length: 150 characters
A new folder is created when a Web Console service starts if the specified folder does not exist. installation-folder\bookmarks

Availability of operation for defining reports, or for creating, editing, deleting, importing, or exporting bookmarks by ordinary users editReportByOrdinaryUser on (available)
off (unavailable) on

Maximum number of server operation statuses to be displayed in the summary format (when using the User Agents display format) maxDisplayServer
(under the <user-agents> tag) 1 - 100 5

Maximum number of server operation statuses to be displayed in the summary format (when using the Products display format) maxDisplayServer
(under the <products> tag) 1 - 100 5

Maximum number of agent operation statuses to be displayed in the summary and User tree view display format (when using the User Agents display format) maxDisplayAgentsUser
(under the <user-agents> tag) 1 - 100 5

Maximum number of agent operation statuses to be displayed in the summary and Product type view display format (when using the User Agents display format) maxDisplayAgentsProducts
(under the <user-agents> tag) 1 - 100 5

Maximum number of agent operation statuses to be displayed in the summary format (when using the Products display format) maxDisplayAgentsProducts
(under the <products> tag) 1 - 100 5

Maximum number of agent alarm statuses to be displayed in the summary format (when using the User Agents display format) maxDisplayAlarm
(under the <user-agents> tag) 1 - 100 5

Maximum number of agent alarm statuses to be displayed in the summary format (when using the Products display format) maxDisplayAlarm
(under the <products> tag) 1 - 100 5

Maximum number of events to be displayed in the summary format maxEvents 1 - 999 256

Maximum number of searchable fields searchLimit 1 - 100 50

Maximum number of output records obtained from View Server by using the jpcrpt command maxFetchCount
(under the <command> tag) 1 - 2,147,483,647
(Specified by integer) maxFetchCount value under the <vsa> tag

#1

You must specify this item in bytes. However, if the last byte is used by a multi-byte character, the whole multi-byte character is displayed.

#2

When the interval between automatic update requests exceeds the period limit, then the server and agent determine that the report has ended without a notification and processing is terminated. However, whether the request interval exceeds the time period limit is determined every 10 seconds.

For example, when the time period limit is set to 61,000 milliseconds, the time period ranges from 61,000 to 70,000 milliseconds.

#3

The default config.xml file does not contain settings for realtimeCacheInterval and bookmarkRepository.

To add these settings, see the description of the initialization file (config.xml) in the appendixes of the Job Management Partner 1/Performance Management Reference, and add the items to the config.xml file located at installation-folder\conf\.

(d) Settings for communication with View Server service

The following table lists and describes the config.xml file setting items used to change settings related to communication between PFM - Web Console and the View Server service.

Table 5-21 Settings for communication between PFM - Web Console and View Server

Content Item Available value Default value

Port number used by PFM - Web Console (Web server) to communicate with the View Server service ownPort^{#1, #2} 1,024 - 65,535 Any available port

Port number used by PFM - Web Console (commands) to communicate with the View Server service ownCmdPort^{#1, #2} 1,024 - 65,535 Any available port

Host name or IP address used as the callback destination for the View Server Service during communication with PFM - Web Console ownHost^#1

Numerals 0-9

Periods (.)

Underscores (_)

Spaces

Alphabetic characters A-Z, a-z

The string must begin with an alphanumeric character. None

#1

The default config.xml file does not contain settings for ownPort, ownCmdPort, and ownHost.

To add these settings, see the description of the initialization file (config.xml) in the appendixes of the Job Management Partner 1/Performance Management Reference, and add the items to the config.xml file located at installation-folder\conf\.

#2

This setting is required if you use Performance Management in a firewall environment. For details, see the description of firewall routing in the appendixes of the Job Management Partner 1/Performance Management Reference.

(e) Automatic logout settings

The following table lists and describes the config.xml file items that determine the length of time before users are automatically logged out from PFM - Web Console.

Table 5-22 Automatic logout settings

Content Item Available value Default value

Length of time before automatic logout from PFM - Web Console (seconds) sessionTimeout 0 - 86,400 4,000

Content	Item	Available value	Default value
Output directory for log files	logDir	Directory to which PFM - Web Console outputs log files	installation-folder\log
Number of log files output by PFM - Web Console	logFileNumber	1 - 16	10^#
Size of each log file	logFileSize	1 - 100	4^#
Number of days to keep log files	logFileRetention	1 - 30	30^#
Line terminal code for output in files	lineSeparator	CRLF: Linefeed code used in Windows LF: Linefeed code used in UNIX	CRLF^#
Character code for output in files	characterCode	US-ASCII Windows-1252 ISO-8859-1 UTF-8 UTF-16 UTF-16BE UTF-16LE	US-ASCII^#
File name to output	csvFileName	Numbers from 0 - 9 . (Period) _ (Underscore) Space Alphabet letters A - Z, a - z You can specify up to 100 characters although you cannot specify a name that consists only of spaces and periods.	Export.csv^#

Content	Item	Available value	Default value
Host name or IP address of PFM - Manager for the connection destination	host	For host name: - Numbers from 0 - 9 - . (Period) - - (Hyphen) - Alphabet letters A - Z, a - z You can use 1 - 32 characters. For IP address: - From 0.0.0.0 to 255.255.255.255	localhost^#
Port number for the View Server service by PFM - Manager for the connection destination	port	1024 - 65535	22286^#

Content	Item	Available value	Default value
Maximum number of records obtained from PFM - Manager	maxFetchCount (under the <vsa> tag)	1 - 2,147,483,647 (Integer)	1,440
Number of records displayed per one page of the report window table	displayCountPerPage	1 - 2,147,483,647(Integer)	20
Maximum number of records saved in the cache for one real time report.	maxRealtimeCache	1 - 360 (Integer)	30
Interval for automatic update	updateInterval	10 - 3,600	60
Specifiable range for conditional expression definitions that use ulong data types	condExpValueUlongExtension	Specified value: Specifiable range of ulong data type true: 0 - 4,294,967,295 false: 0 - 2,147,483,648	false
Maximum number of characters displayable as a label on a report graph^#1	maxSeriesLabelLength	1 - 1,024	30
Whether block transfer mode is enabled	blockTransferMode	true (enabled) false (disabled)	true
Maximum number of reports displayable by tiling	maxTileReports	1 - 256	50
Interval time limit for an automatic update request of a real-time report^#2	realtimeCacheInterval^#3	60,000 - 3,600,000 (Milliseconds)	600,000
Installation location of the repository^#3 for saving the definition information of the bookmark function	bookmarkRepository^#3	Use an absolute pathname. Maximum path length: 150 characters A new folder is created when a Web Console service starts if the specified folder does not exist.	installation-folder\bookmarks
Availability of operation for defining reports, or for creating, editing, deleting, importing, or exporting bookmarks by ordinary users	editReportByOrdinaryUser	on (available) off (unavailable)	on
Maximum number of server operation statuses to be displayed in the summary format (when using the User Agents display format)	maxDisplayServer (under the <user-agents> tag)	1 - 100	5
Maximum number of server operation statuses to be displayed in the summary format (when using the Products display format)	maxDisplayServer (under the <products> tag)	1 - 100	5
Maximum number of agent operation statuses to be displayed in the summary and User tree view display format (when using the User Agents display format)	maxDisplayAgentsUser (under the <user-agents> tag)	1 - 100	5
Maximum number of agent operation statuses to be displayed in the summary and Product type view display format (when using the User Agents display format)	maxDisplayAgentsProducts (under the <user-agents> tag)	1 - 100	5
Maximum number of agent operation statuses to be displayed in the summary format (when using the Products display format)	maxDisplayAgentsProducts (under the <products> tag)	1 - 100	5
Maximum number of agent alarm statuses to be displayed in the summary format (when using the User Agents display format)	maxDisplayAlarm (under the <user-agents> tag)	1 - 100	5
Maximum number of agent alarm statuses to be displayed in the summary format (when using the Products display format)	maxDisplayAlarm (under the <products> tag)	1 - 100	5
Maximum number of events to be displayed in the summary format	maxEvents	1 - 999	256
Maximum number of searchable fields	searchLimit	1 - 100	50
Maximum number of output records obtained from View Server by using the jpcrpt command	maxFetchCount (under the <command> tag)	1 - 2,147,483,647 (Specified by integer)	maxFetchCount value under the <vsa> tag

Content	Item	Available value	Default value
Port number used by PFM - Web Console (Web server) to communicate with the View Server service	ownPort^{#1, #2}	1,024 - 65,535	Any available port
Port number used by PFM - Web Console (commands) to communicate with the View Server service	ownCmdPort^{#1, #2}	1,024 - 65,535	Any available port
Host name or IP address used as the callback destination for the View Server Service during communication with PFM - Web Console	ownHost^#1	Numerals 0-9 Periods (.) Underscores (_) Spaces Alphabetic characters A-Z, a-z The string must begin with an alphanumeric character.	None

Content	Item	Available value	Default value
Length of time before automatic logout from PFM - Web Console (seconds)	sessionTimeout	0 - 86,400	4,000

(2) Procedure to return a changed Windows initialization file (config.xml) to the default

It is possible that the configuration of the config.xml file is changed when the version upgrade is performed. After the version upgrade, use the following procedure to reflect the edited content of the config.xml file in the new config.xml file.

To return a changed Windows initialization file to the default:

Check the content of installation-folder\conf\config.xml and take note of the edited content.

Backup installation-folder\conf\config.xml.

Overwrite installation-folder\sample\conf\config.xml on the installation-folder\conf\config.xml.

Apply the edited content you checked in step 1 in new-installation-folder\conf\config.xml.

Restart PFM - Web Console when you change the Windows initialization file since the Windows initialization file is updated when PFM - Web Console starts.

Note:

When you wish to return the data of the config.xml file to the previous status, copy the config.xml file in installation-folder\sample\conf\ and overwrite on the above folder.

[Contents][Back][Next]

[Trademarks]