Hitachi

JP1 Version 12 JP1/Performance Management Reference


Initialization file settings (config.xml)

The following table describes the setting items in the initialization file (config.xml).

For items whose value is either true or false, letter case is not distinguished.

Organization of this page

Setting file output

Table 4‒11: Setting items for file output

Item

Description

characterCode

Specifies the character code that is to be output when the report displayed in the PFM - Web Console window is output in CSV format or when a file is output in CSV format by the jpcrpt command. The specifiable values are as follows:

  • US-ASCII

  • windows-1252

  • ISO-8859-1

  • UTF-8

  • UTF-16

  • UTF-16BE

  • UTF-16LE

  • Shift_JIS

  • EUC-JP

  • EUC-JP-LINUX

  • MS932

The default is UTF-8. If any other value is specified, the default value is set.

csvFileName

Specifies the name of the file to which the report displayed in the PFM - Web Console window is to be output in CSV format. Specify the file name by using characters totalling 100 bytes or less. The following characters can be used:

  • Numeric characters 0 to 9

  • . (period)

  • _ (underscore)

  • Single-byte space

  • Alphabetic characters A to Z and a to z

Note that you cannot specify a name consisting of only a single-byte space and period (.).

The default is Export.csv. If any value other than those allowed is specified, the default value is set.

lineSeparator

Specifies the end-of-line symbol that is to be output when the report displayed in the PFM - Web Console window is output in CSV format or when a file is output in CSV format by the jpcrpt command. The specifiable values are as follows:

  • CRLF: Linefeed code supported by Windows

  • LF: Linefeed code supported by UNIX

The default is CRLF.

If any value other those allowed is specified, the default value is set.

logDir

Specifies the directory to which PFM - Web Console log files are to be output.

You can specify single-byte alphanumeric characters or single-byte symbols.

Note that you cannot use the following characters:

  • In Windows:

    $ % ^ ' ! = + { } @ [ ] ;

The default directory is as follows:

  • In Windows:

    installation-folder\log\

  • In UNIX:

    /opt/jp1pcwebcon/log/

If an invalid directory is specified or specification is omitted, the default value is set.

logFileNumber

Specifies the number of log files to be output by PFM - Web Console as an integer.

  • Specifiable values: 1 to 16

  • Default: 10

If the specified value is outside the specifiable range, the default value is set.

logFileNumberMulti

Specifies the number of log files to be output by the jpcrpt command as an integer.

  • Specifiable values: 1 to 64

  • Default: 10

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

When the outputMultiProcessForJpcrpt value is false, this setting is ineffective, and the logFileNumber setting value of <logging> is applied.

logFileRetention

Specifies the number of days for which log files are to be retained as an integer. This specification sets the retention period for log files output by the jpcrpt command.

  • Specifiable values: 1 to 30

  • Specifiable values: 1 to 30

If the specified value is outside the specifiable range, the default value is set.

logFileSize

Specifies the size of a single log file in megabytes.

  • Specifiable values: 1 to 100

  • Default: 10

If the specified value is outside the specifiable range, the default value is set.

logFileSizeMulti

Specifies the upper limit for the file size of a log file to be output by the jpcrpt command in megabytes.

  • Specifiable values: 1 to 16

  • Default: 4

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

When the outputMultiProcessForJpcrpt value is false, this setting is ineffective, and the logFileSize setting value of <logging> is applied.

outputCsvHeader (under <export> tag)

Specifies whether to output the header when the report displayed in the PFM - Web Console window is output in CSV format.

  • true: The header is output.

  • false: No header is output.

The default is true.

outputCsvHeader (under <command><export> tag)

Specifies whether to output the header when a file is output in CSV format by a jpcrpt command.

  • true: The header is output.

  • false: No header is output.

If the specification is omitted, the value specified for outputCsvHeader under the <export> tag is applied.

outputMultiProcessForJpcrpt

Specifies the log output method for when the jpcrpt command is executed.

  • true: Outputs a single log file regardless of the process of the jpcrpt command. The logFileRetention setting is ineffective, and there is no limit on the log file retention period.

  • false: Outputs a single log file for each process of the jpcrpt command.

The default is true. Note that when the PFM - Web Console version is earlier than 10-00 or PFM - Web Console is upgraded from the previous version to 10-00, the default is false.

If the specified value is outside the specifiable range or specification is omitted, false is set.

Setting PFM - Manager for the connection destination

Table 4‒12: Setting items for PFM - Manager for the connection destination

Item

Description

host

Specifies the host name or the IP address of PFM - Manager to be connected.

For a host name:

The following characters can be used. Note that only an alphanumeric character can be specified as the first character.

Specify this item by using characters totalling 1 to 32 bytes.

  • Numeric characters 0 to 9

  • . (period)

  • - (hyphen)

  • Alphabetic characters A to Z and a to z

For an IP address:
  • 0.0.0.0 to 255.255.255.255

If you specify an invalid character, the KAVJV5006-I message is output and startup of the PFM - Web Console service fails. If you specify a host name that does not exist, the KAVJS0029-E message is output and an error occurs at login to PFM - Web Console.

An error may occur if a host name with only numbers is specified.

If specification is omitted, localhost is set.

Note that when you specify a host name for this item, even if the PFM - Manager to be connected uses an alias name added by the function for setting monitoring host names, specify the physical host name of the PFM - Manager host. The following shows an example:

Setting Examples:
  • PFM - Manager host name: hostA

  • The alias name of PFM - Manager added by the function for setting monitoring host names: hostB

  • Value to be set in this item: hostA

If a host name is specified in this item, the hosts file or DNS is used for name resolution. Therefore, confirm, beforehand, that the host name specified in this item can be resolved by using the hosts file or DNS.

port

Specifies the port number of the View Server service of PFM - Manager to be connected.

  • Specifiable values: 1024 to 65535

  • Default: 22286

Settings for acquiring and displaying data

Table 4‒13: Setting items for acquiring and displaying data

Item

Description

agentTreeAccessLimit

Specifies whether to limit the operation (creating and editing the Agents tree, and displaying it in the Products display format) of the Agents tree with the general user permission level.

  • on: Limited

  • off: Not limited (default)

If you specify on, the following limits are applied to the operation of the Agents tree with the general user permission level.

  • Products cannot be specified for Display Style in the navigation frame.

  • Edit Agents is not displayed in the method frame.

appendCommaDisplayedForNum (under <draw> tag)

Specifies whether to delimit the data label to be displayed for the graph scale every three digits with a comma.

  • true: Delimits the data label every three digits with a comma for display.

  • false: Does not delimit the data label with a comma for display.

The default is false. If the specified value is outside the specifiable range or specification is omitted, the default value is set.

area (under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report (including combination reports) graph is displayed as an area graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any value other than those allowed or you do not specify a value, the default value is set.

autoLabelMaxFractionDigits (under <draw> tag)

Specifies the maximum number of digits that can be displayed as the decimal part of a data value to be displayed in the tool tips of the Autolabel function.

  • Specifiable values: 1 to 6

  • Default: 3

If the actual decimal part of the data value has more digits than the number of digits specified for this item, the data is displayed only for the specified number of digits from the first decimal place. If the specified number of digits is exceeded, the data is rounded off to the decimal place prior to the specified decimal place. For example, when the specified value is 2, and the data value of the specified plot in the tool tips is 1.23456, 1.23 is displayed in the tool tips.

If specification is omitted, the default value is set.

For details about the Autolabel function, see the part that describes how to display reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

autoLabelMaxIntegerDigits (under <draw> tag)

Specifies the maximum number of digits that can be displayed as the integer part of a data value to be displayed in the tool tips of the Autolabel function.

  • Specifiable values: 1 to 14

  • Default: 7

If the actual integer part of the data value has more digits than the number of digits specified for this item, the data is displayed only for the specified number of digits from the first digit. For example, when the specified value is 3, and the data value of the specified plot in the tool tips is 123456, 456 is displayed in the tool tips.

If specification is omitted, the default value is set.

For details about the Autolabel function, see the part that describes how to display reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

blockTransferMode

Specifies whether block transmission mode is set.

You can specify true (enabled) or false (disabled). The default value is true (enabled).

If you specify any other value or you do not specify a value, the default value is set.

The block transmission mode is enabled only for outputting reports in CSV format. The mode is disabled for output in HTML format.

bookmarkRepository#2

Specifies the directory where bookmark definition information is stored as an absolute path.

If the specified directory does not exist, the directory is created when the PFM - Web Console service starts.

Maximum length of path: 150 characters

You can specify single-byte alphanumeric characters or single-byte symbols.

Note that you cannot use the following characters.

  • In Windows:

    $ % ^ ' ! = + { } @ [ ] ;

The default directory is as follows:

  • In Windows:

    installation-folder\bookmarks\

  • In UNIX:

    /opt/jp1pcwebcon/bookmarks/

If an invalid directory is specified, the following occurs: In Windows, the KAVJT0003-E message is displayed and a PFM - Web Console service startup error occurs, and in UNIX, the KAVJZ0999-E message is displayed when an attempt is made to access the specified directory from a Web browser and an application initialization error occurs.

cmdHtmlTableOutputMaxRowSize

Specifies the maximum number of lines of table data in an HTML-format report to be output by the jpcrpt command as an integer.

  • Specifiable values: 0 to 15000

  • Default: 0 (when PFM - Web Console 10-00 or later is newly installed, the default is 15000)

If the specified number of lines is exceeded, a message is output and table data is output up to the specified number of lines. Lines exceeding the specified number of lines are not output.

Note that if 0 is specified, there is no limit on the number of lines of table data. In this case, if you try to output a report containing a large amount of table data in HTML format by the jpcrpt command to display it in a Web browser, the Web browser might freeze up. For details, see the part that describes notes on displaying reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

If specification is omitted, 0 is set.

color1 to color16 (under <chart-symbolColors> tag)

Specifies a line color to be used in a graph.

You can select from 16 colors (color1 to color16). color1 is used for the first line of a graph, and color2, color3, color4, (omitted), and then color16 are used sequentially. For the 17th line, color1 is used again.

Specify a value in RGB format by delimiting each value of R, G, and B with a single-byte comma (,).

  • Specifiable values: 0 to 255

  • Default: As follows:

    color1: 235,143,21 ([Figure])

    color2: 204,0,0 ([Figure])

    color3: 102,153,0 ([Figure])

    color4: 0,102,255 ([Figure])

    color5: 102,0,255 ([Figure])

    color6: 255,51,153 ([Figure])

    color7: 255,185,0 ([Figure])

    color8: 255,17,17 ([Figure])

    color9: 136,204,0 ([Figure])

    color10: 71,145,255 ([Figure])

    color11: 134,51,255 ([Figure])

    color12: 255,149,246 ([Figure])

If even one of the specified R, G, and B values of the color1 to color12 items is outside the range of the specifiable range, the default value is used for the line color. If even one of the specified R, G, and B values of the color13 to color16 items is outside the range of the specifiable range, it is considered that the specification of the line color is omitted.

When the specification of the line color is omitted, the color with the applicable number is skipped. For example, if you omit specifying only color3, color1, color2, color4, (omitted) are used sequentially.

In addition, if even one of the color1 to color16 items is effective, only the effective item is used as the line color of a graph. For example, if there are three effective items (colors), only the three colors are used as the line colors.

columnBar

(under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report (including combination reports) graph is displayed as a clustered vertical or horizontal bar graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

condCacheSize

Specifies the maximum number of history reports that can be stored in a cache (in memory).

Specify an integer from 5 to 20. The default value is 20. If you specify an invalid value, or if you do not specify a value, the default value (20) is set.

condExpValueUlongExtension#3

Sets the specifiable range for the definition of a conditional expression using the ulong data type. You can specify true or false.

  • true: 0 to 4294967295

  • false: 0 to 2147483647

The default is false.

If any other value than those allowed is specified, the default value is set.

numericSeparator

(under <number-format> tag)

Specifies a thousand separator symbol for numeric values to be output in CSV format by commands.

The specifiable value is either of the following values:

  • space: half-width space

  • quotation:'

  • period: .

  • comma: ,

The default is comma.

If any value other than the values allowed is specified, the default value is set.

Also, the same value as the one set for decimalPointSymbol cannot be specified. If the same value is specified, the default value is set.

decimalPointSymbol

(under <number-format> tag)

Specifies a decimal symbol for numeric values to be output in CSV format by GUI display or commands, and a decimal interpretative symbol for user entry values to be entered in GUI or a command parameter file.

The specifiable value is either of the following values:

  • period: .

  • comma: ,

The default is period.

If any value other than the values allowed is specified, the default value is set.

Also, the same value as the one set for numericSeparator cannot be specified. If the same value is specified, the default value is set.

dateFieldCheckboxDisplay

Specifies whether to display the check box used to change the display position of the time field in the table area in the View Report window.

  • true: The check box is displayed.

  • false: The check box is not displayed.

The default is false.

The time field means either of the following:

  • For a real-time report: Record Time

  • For a historical report: Date and Time

dateFieldState

Specifies the initial value of the display position of the time field in the table area in the View Report window.

  • LEFT: Displayed on the left side only

  • RIGHT: Displayed on the right side only

  • BOTH: Displayed on both sides

  • NONE: Not displayed

The default is BOTH.

The time field means either of the following:

  • For a real-time report: Record Time

  • For a historical report: Date and Time

defaultAutoRefresh

(under <vsa> tag)

Specifies the initial value for Automatic Refresh (check box) of the Main window upon login to PFM - Web Console. (This setting is not applicable when the PFM - Web Console window is displayed from Integrated Operation Viewer of JP1/IM2 (that is, when single sign-on is used).)

  • true: Enabled (selected)

  • false: Disabled (cleared)

The default is true.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

defaultAutoRefresh

(under <vsa><im2Coop> tag)

Specifies whether to enable or disable Automatic Refresh of the Main window when the PFM - Web Console window is displayed from Integrated Operation Viewer of JP1/IM2 (that is, when single sign-on is used).

  • true: Enabled

  • false: Disabled

The default is true.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

displayAlarmTablesSeparately

Specifies whether to display the alarm tree separately.

The specifiable value is either of the following values:

  • true: Separate display is enabled.

  • false: Separate display is disabled.

The default is false. However, when PFM - Web Console 10-00 or later is newly installed, the default is true.

If the specified value is outside the specifiable range or specification is omitted, false is set.

For details about separate display, see the part that describes procedure for setting and operating alarms in the chapter that describes operation monitoring by alarms in the JP1/Performance Management User's Guide.

displayCountPerPage

Specifies the number of records to be displayed per page as an integer when a table is displayed in the View Report window.

  • Specifiable values: 1 to 2147483647

  • Default: 20

If the specified value is outside the specifiable range, the default value is set.

displayLegendCount

Specifies the maximum number of fields that can be displayed in the legend of a graph when the report series paging function is enabled. If the report series paging function is disabled, the value specified for this item is ignored.

  • Specifiable values: 1 to 40

  • Default: 14

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

dispPosUnassignedHostInBG

Specifies the position where Unassigned is displayed when an administrator user logs in to an environment where the business group function is enabled.

The specifiable value is either of the following values:

  • top: Displays at the top.

  • bottom: Displays at the bottom.

The default is top.

If you specify a value that is not allowed, if you omit this item, or if the business group function is disabled, top is set.

dispReportsSameTime

(under <vsa> tag)

Specifies not to disconnect a session of a user who has already logged in when the following PFM - Web Console windows are displayed in a shared-session-type browser if linkage is established with JP1/IM2:

  • PFM - Web Console window that is displayed in the Details area of the Integrated Operation Viewer window of JP1/IM2

  • View Report window that is opened via monitor startup from a JP1/IM2 event

  • View Report window that is displayed through the suggestion function of JP1/IM2

You can specify true or false.

  • true: Do not disconnect the session of the user who has already logged in.

  • false: Disconnect the session of the user who has already logged in (whether the forced login confirmation window is displayed upon the disconnection of the session is determined by the informOfSharedSession setting).

The default is true.

If you specify any other value, the default value is set, and if you do not specify a value, false is set.

editReportByOrdinaryUser

Specifies whether to allow an ordinary user or business group ordinary user to operate (create, edit, delete, import, export) report definitions and bookmarks.

  • on: Editing allowed (default)

  • off: Editing not allowed

If you select off, ordinary users and business group ordinary users can no longer display editing methods or menus for reports and bookmarks.

enableAntiAliasForNonAreaGraph

(under <draw> tag)

Specifies whether to perform anti-aliasing for graph drawing.

This parameter is applied only in the following case:

  • A graph for which Area is not specified as the graph type

    (For combination reports, when Area is not specified for any series group.)

If this parameter is not applied, true is set.

  • true: Anti-aliasing is performed.

  • false: Anti-aliasing is not performed.

The default is true. If specification is omitted, the default value is set.

When anti-aliasing is not performed, a jagged edge might be displayed at the boundary of a graph (the boundary of a graph is jagged). However, the display rate of a line graph is improved.

enableAutoLabelAtDefaultDisp

Specifies the initial value of the report graph option item Show Autolabel.

  • true: Specifies the initial value as checked.

  • false: Specifies the initial value as unchecked.

This setting is applied to reports other than combination reports.

The default is false. If the specified value is outside the specifiable range or specification is omitted, the default value is set.

enableDuplicateLogin

Controls concurrent logins to PFM - Web Console by the same user.

  • true: Permits concurrent logins

  • false: Does not permit concurrent logins

The default is true.

If false is set, concurrent logins by the same user are suppressed. If a user tries to log in under a user name that is already logged in, a confirmation message is displayed. If the user forcibly logs in, the session of the user who was already logged in is deleted and a new session is created.

excludeTerminalData (under <command> tag)

Specifies whether to output the report start time and end time data to a report when the <exclude-terminal-data> tag is omitted from the parameter file specified for entering the jpcrpt command.

  • STARTTIME: Start time data is not output to a report.

  • ENDTIME: End time data is not output to a report.

  • BOTHTIME: Start time and end time data are not output to a report.

  • NONE: Start time and end time data are output to a report.

The default is NONE.

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

excludeTerminalData (under <vsa> tag)

Specifies the initial value of Display the start time data and Display the end time data of the Settings for the report display period items.

  • STARTTIME: Specifies the initial value of Display the start time data as unchecked, and the initial value of Display the end time data as checked.

  • ENDTIME: Specifies the initial value of Display the start time data as checked, and the initial value of Display the end time data as unchecked.

  • BOTHTIME: Specifies the initial value of Display the start time data as unchecked, and the initial value of Display the end time data as unchecked.

  • NONE: Specifies the initial value of Display the start time data as checked, and the initial value of Display the end time data as checked.

The default is NONE.

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

exponentialDisplayMode

Specifies whether to display the scale on the vertical axis of a graph in exponential form.

You can specify true (enabled) or false (disabled).

If you specify true (enabled), the scale on the vertical axis of a graph is displayed in exponential form for values equal to or greater than 107 or less than 0.001.

The default value is true (enabled). If you specify any other value than those allowed, or you do not specify a value, the default value is set.

firstDayOfWeek

Specifies the starting day of the week. The specifiable values are as follows:

  • AUTO

  • SUNDAY

  • MONDAY

  • TUESDAY

  • WEDNESDAY

  • THURSDAY

  • FRIDAY

  • SATURDAY

The default value is AUTO, which automatically selects the starting day of the week according to the locale. For example, Sunday is selected in Japan and America, and Monday is selected in France. If the specified value is outside the specifiable range, the default value is set.

foregroundCombinationGraph (under <draw> tag)

Specifies the graph type to be displayed in the foreground of a combination report.

  • Specifiable values: 3DBAR and LINE (Specify 3DBAR when you want to bring a clustered vertical or stacked vertical bar graph for which 3D display is enabled to the foreground; specify LINE when you want to bring a line graph to the foreground. The alphabetical characters are not case-sensitive.)

  • Default: 3DBAR

When no clustered vertical or stacked vertical bar graph for which 3D display is enabled is set or no line graph is set in a combination report, this setting is ignored.

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

graphMaxReportData

Specifies the maximum number of data items that can be displayed in a graph when the report cache filing function is enabled. If the report cache filing function is disabled, the value specified for this item is ignored.

  • Specifiable values: 1 to 2000000

  • Default: 2000000

If you specify any other value, the default value is set.

The number of data items that can be displayed in a graph can be calculated by the following expressions:

  • When a graph is a line, area, or stacked area

    Number of data items displayable in a graph = Number of fields set in a report#4 × Number of obtained records

  • When a graph is not a line, area, and stacked area

    Number of data items displayable in a graph = Number of fields set in a report#4 × Number of records for a single collection

informOfSharedSession

Specifies the settings of the login confirmation window when you disconnect the session of the user who was already logged in from a browser sharing the session to log out the user.

  • true: Displays the forced login confirmation window.

  • false: Does not display the forced login confirmation window.

If no value is set, false is set.

PFM - Web Console disconnects the session of the user who was already logged in to log out that user during the login processing from a browser sharing the session.

If true is set, the forced login confirmation window is displayed to notify a user that the session of the user who was already logged in is to be disconnected, and the notified user is allowed to select whether to forcibly log in.

legendSeriesOrderForHBar (under <draw> tag)

Changes the display order of the legend of a clustered horizontal bar graph (not a stacked horizontal bar graph).

  • Specifiable values: FORWARD and REVERSE (The alphabetical characters are not case-sensitive.)

    FORWARD: The legend is displayed in order from the line displayed at the top of a graph.

    REVERSE: The legend is displayed in order from the line displayed at the bottom of a graph (this is the same legend order as that in PFM - Web Console 09-00 or earlier).

  • Default: REVERSE

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

Note that setting this item changes only the line legend order. The line legend color is not changed.

line

(under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report (including combination reports) graph is displayed as a line graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

lineSymbolSize (under <draw> tag)

Specifies the size of a plot to be used for displaying a line graph.

  • Specifiable values: LARGE, MEDIUM, SMALL, and AUTO (The alphabetical characters are not case-sensitive.)

  • Default: MEDIUM

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

If AUTO is specified, the size is automatically adjusted to a size appropriate for display of LARGE, MEDIUM, and SMALL depending on the number of time points in the report display range.

Note that this item is not applied to a thumbnail graph image in a tiling display. For such an image, a plot is always displayed with SMALL.

maxAutoLabelPoints (under <draw> tag)

If the number of plots in a graph exceeds a certain number, the Autolabel function is disabled. This item specifies the maximum number of plots that can be enabled for the Autolabel function for this item.

  • Specifiable values: 0 to 2000

  • Default: 1440

If 0 is specified, no limit is placed on the number of plots. If no value is specified, the default is set.

For details about the Autolabel function, see the part that describes how to display reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

maxDisplayAgentsProducts (under <products> tag)

Specifies the display count for the higher-level agent operating statuses in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is products.

maxDisplayAgentsProducts (under <user-agents> tag)

Specifies the display count for the higher-level agent operating statuses (Product type view) in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is user-agents.

maxDisplayAgentsUser (under <user-agents> tag)

Specifies the display count for the higher-level agent operating statuses (User tree view) in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is user-agents.

maxDisplayAlarm (under <products> tag)

Specifies the display count for the higher-level agent alarm monitoring statuses in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is products.

maxDisplayAlarm (under <user-agents> tag)

Specifies the display count for the higher-level agent alarm monitoring statuses in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is user-agents.

maxDisplayServer (under <products> tag)

Specifies the display count for the higher-level server operational statuses in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is products.

maxDisplayServer (under <user-agents> tag)

Specifies the display count for the higher-level server operational statuses in the display summary. The specifiable range is 1 to 100.

The default is 5. If specification is omitted, the default value is set.

The value specified here is reflected when the display format for the Agents tree is user-agents.

maxDrilldownPoints

Specifies the maximum number of drilldown data items in a graph as an integer.

  • Specifiable values: 0 to 1500

  • Default: 0 (when PFM - Web Console 10-00 or later is newly installed, the default is 1500)

If the specified value is exceeded, displaying a drilldown report from a graph is disabled.

Note that if 0 is specified, there is no limit on the maximum number of drilldown data items in a graph. In this case, memory might run out and the PFM - Web Console service might stop, depending on the number of field points in the graph area. For details, see the part that describes notes on displaying reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

If specification is omitted, 0 is set.

maxEvents

Specifies the maximum number of events displayed in the display summary. The specifiable range is 1 to 999.

The default is 256.

maxFetchCount

(under <command> tag)

Specifies the maximum number of records that are to be acquired from View Server for a report output by the jpcrpt command as an integer.

  • Specifiable values: 1 to 2147483647

  • Default: maxFetchCount value under the <vsa> tag

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

Note:

Because the value of Maximum number of records specified when a report is registered as a bookmark is applied for combination reports or tiling displays, the maxFetchCount value is not applied in such situations.

maxFetchCount

(under <vsa> tag)

Specifies the maximum number of records that can be acquired from PFM - Manager as an integer.

  • Specifiable values: 1 to 2147483647

  • Default: 1440

If the specified value is outside the specifiable range, the default value is set.

Note:

Because the value of Maximum number of records specified when a report is registered as a bookmark is applied for combination reports or tiling displays, the maxFetchCount value is not applied in such situations.

maxMonitorEventNumForMultiTenant (under <multi-tenant> tag)

Specifies the maximum number of events that can be retained in the cache by PFM - Web Console when a business group is used.

  • Specifiable values: 1 to 10000

  • Default: 999

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

maxRealtimeCache

Specifies the maximum number of records per realtime report for which data is to be cached as an integer.

  • Specifiable values: 1 to 360

  • Default: 30

If the specified value is outside the specifiable range, the default value is set.

maxSeriesLabelLength

Specifies the maximum size of a string of characters in bytes that can be displayed in the legend label in a graph in a report. However, if the final character is the first byte of a multi-byte character, the final character is displayed properly. Specify the character string length as an integer within the range 1 to 1024 bytes. The default is 30. If you omit the specification, or you specify a value outside the range or an invalid value, the default value is set.

maxTileReports

Specifies the maximum number of reports that can be displayed in the Tiling Display. The specifiable range is 1 to 256.

The default is 50.

minimumNumberOfAgentsTitle

Specifies the minimum number of selected agents for displaying a title to be displayed in the method frame with the number of agents when showNumberOfAgentsTitle is true.

  • Specifiable values: 1 to 65535

  • Default: 4

If showNumberOfAgentsTitle is false, this setting is disabled. If the specified value is outside the specifiable range or specification is omitted, the default value is set.

nfMessageDisplay

Specifies whether to display the message area in the navigation frame in the Agents tree.

  • true: Display the message area (only if there are messages).

  • false: Do not display the message area.

The default value is true. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

noUseCircleColor (under <chart-symbolColors> tag)

Specifies a color number of color numbers from color1 to color16 that you do not want to use for pie graphs.

  • Specifiable values: 0 to 16

  • Default: 0 (There are no color numbers excluded for use for pie graphs.)

To specify multiple color numbers, delimit the specified color numbers with a single-byte comma (,).

In the following cases, it is assumed that 0 is specified. Therefore, all the colors specified for color1 to color16 are used for pie graphs.

  • Specification is omitted.

  • When multiple values are specified, but even one of the values is outside the specifiable range or invalid.

  • When multiple values are specified, but the values include 0.

In the following cases, the default colors of color1 to color12 are used for pie graphs.

  • All the color numbers are specified.

  • None of the color numbers from color1 to color16 is specified.

numericSeparator (under <number-format> tag)

Specifies a thousand separator symbol for numeric values to be output in CSV format by commands.

The specifiable value is either of the following values:

  • space:half-width space

  • quotation:'

  • period: .

  • comma: ,

The default is comma.

If any value other than the values allowed is specified, the default value is set.

Also, the same value as the one set for decimalPointSymbol cannot be specified. If the same value is specified, the default value is set.

pie

(under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report graph is displayed as a pie graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any value other the values allowed, or you do not specify a value, the default value is set.

precision (under <draw> tag)

  • Specifies the maximum number of displayed digits of the decimal part when the data label to be displayed for the graph scale is a decimal value.

  • Specifiable values: 0 to 15

Default: 0 (when PFM - Web Console 10-00 or later is newly installed, the default is 3)

If you specify 0 for this item, the decimal part is not displayed.

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

Note that when the data label is an integer value, or the number of digits in the decimal part is smaller than the number of digits specified for this item, only the actual data label value is displayed and 0 is not applied to the rest of the digits.

printCacheSize

Specifies the maximum number of data items in the Print window to be cached as an integer.

  • Specifiable values: 5 to 20

  • Default: 20 (when PFM - Web Console 10-00 or later is newly installed, the default is 10)

If you specify any other value than those allowed, or you do not specify a value, 20 is set.

printTableMaxRowSize

Specifies the maximum number of lines of table data to be displayed in the Print window as an integer.

  • Specifiable values: 0 to 15000

  • Default: 0 (when PFM - Web Console 10-00 or later is newly installed, the default is 15000)

If the specified number of lines is exceeded, a message is output and table data is output up to the specified number of lines. Lines exceeding the specified number of lines are not output.

Note that if 0 is specified, there is no limit on the number of lines of table data. In this case, if you try to display a report containing a large amount of table data in the Print window, the Web browser might freeze up. For details, see the part that describes notes on displaying reports in the chapter that describes creation of reports for operation analysis in the JP1/Performance Management User's Guide.

If specification is omitted, 0 is set.

priority

Specifies how to propagate the health check icon in the Agents tree. You can select either of the following options as the propagation method:

Setting value

Order of priority for propagation

Note

HOST

H7 > H6 > H5 > H4 > H3 > H2 > H1

When monitoring the host operating status

AGENT

H6 > H5 > H4 > H7 > H3 > H2 > H1

When monitoring the agent operating status

Legend:

H1: Not supported (not supported)

H2: Running (running)

H3: Suspended (monitoring suspended)

H4: Incomplete (Incomplete)

H5: Stopped (stopped service)

H6: Unconfirmed (unconfirmed)

H7: Host Not Available (Host Not Available)

The default value is HOST. If you omit the specification, or if you specify an invalid value, the default value is set.

processMonitoringTemplatesRepository#2

Specifies the directory where the process monitoring definition templates are stored as an absolute path.

If the specified directory does not exist, the directory is created when the PFM - Web Console service starts.

  • Maximum length of path: 100 characters

You can specify single-byte alphanumeric characters or single-byte symbols.

Note that you cannot use the following characters.

  • In Windows:

    $ % ^ ' ! = + { } @ [ ] ;

The default directory is as follows:

  • In Windows:

    installation-folder\processMonitoringTemplates\

  • In UNIX:

    /opt/jp1pcwebcon/processMonitoringTemplates/

If an invalid directory is specified, a PFM - Web Console service startup error occurs.

quickGuideHideReportIcon

Specifies whether to hide the icons for reports that cannot be displayed in the list of fields of the quick guide.

  • true: Hides the icons for reports that cannot be displayed.

  • false: Displays the icons for reports that cannot be displayed.

The default value is true. However, if a new installation of PFM - Web Console version 10-10-20 was performed, the default value is false.

If you specify any other value than those allowed or if you do not specify a value, true is set.

realtimeCacheInterval

Specifies the request interval limit time (in milliseconds) when realtime reports are refreshed automatically. If the automatic refreshing request interval exceeds this limit value, the server and agent assume that the report ended without a notification and terminate processing. Whether or not the request interval has exceeded the limit time is checked every 10 seconds.

For example, if the limit time is set to 61,000 milliseconds, the actual limit time is from 61,000 to 70,000 milliseconds.

Specifiable values: 60000 to 3600000

Default: 600000

If the specified value is outside the specifiable range or specification is omitted, the default value is set.

reportCacheFileDir#2

Specifies the absolute path to the directory that stores report cache files.

If the specified directory does not exist, the directory is created when the PFM - Web Console service starts.

  • Maximum length of path: 150 characters

You can specify single-byte alphanumeric characters or single-byte symbols.

Note that you cannot use the following characters.

  • In Windows:

    $ % ^ ' ! = + { } @ [ ] ;

The default directory is as follows:

  • In Windows:

    installation-folder\reportcache\

  • In UNIX:

    /opt/jp1pcwebcon/reportcache/

Note that if one or more of the following errors occur, the directory is not created.

  • The specified value is not a directory.

  • The specified value exceeds the maximum allowed length of a path.

  • An attempt to create the directory that stores report cache files has failed.

Note:

Specify a directory on the local disk as the directory that stores report cache files. If you specify a directory on the network, the operation of the GUI and the jpcrpt command takes more time than when a directory on the local disk is specified.

reportFirstDataTimeout

Specifies the timeout time in seconds for when a report is initially displayed.

This setting is applied only to the first display, and does not affect the refresh interval of real-time reports.

  • Specifiable values: 10 to 3600

  • Default: 600

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

searchLimit

Specifies the limit on the number of searches for fields that match the search keyword. The specifiable range is 1 to 100.

The default is 50.

selectFormat

Specifies the date format when the locale is not en_US, en, or ja. For details, see the chapter that describes installation and setup in JP1/Performance Management Planning and Configuration Guide.

You can specify the following values:

  • pattern-ddMMyyyy

  • pattern-MMddyyyy

  • pattern-yyyyMMdd

The default is pattern-ddMMyyyy. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

showNumberOfAgentsTitle

Specifies whether to use the agent name or the number of agents as the title to be displayed in the method frame depending on the number of agents selected in the navigation frame in the Agents tree.

  • true: Displays the number of agents.

  • false: Displays the agent name.

The default is true. Note that when the PFM - Web Console version is earlier than 10-00 or PFM - Web Console is upgraded from the previous version to 10-00, the default is false.

When the number of selected agents is fewer than the value specified for minimumNumberOfAgentsTitle, false is set. In addition, if the specified value is outside the specifiable range or specification is omitted, false is set.

stackedArea

(under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report (including combination reports) graph is displayed as a stacked area graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

stackedColumnBar

(under <graph-time-correction> tag)#1

Specifies the time correction method when a historical report (including combination reports) graph is displayed as a stacked vertical or horizontal bar graph.

You can specify NONE (disabled) or SECOND (enabled).

If you specify SECOND, the time is corrected in units of seconds.

The default value is NONE. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

updateInterval

Specifies the refresh interval (in seconds) for automatic refreshing.

  • Specifiable values: 10 to 3600

  • Default: 60

If the specified value is outside the specifiable range, the default value is set.

useReportCacheFile

Specifies whether to enable the report cache filing function.

  • true: The report cache filing function is used.

  • false: The report cache filing function is not used.

The report cache filing function can be used only when the block transmission mode is enabled. When the block transmission mode is disabled, even though true is specified, false is assumed.

The default is false.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

usingSeriesPagingOnTheGraph

Specifies whether to enable the report series paging function.

  • true: The report series paging function is used.

  • false: The report series paging function is not used.

The default is false. However, when PFM - Web Console 10-00 or later is newly installed, the default is true.

If you specify any other value than those allowed, or you do not specify a value, false is set.

#1

In the default initialization file (config.xml), the XML tags are commented out. So, if you want to set these items, uncomment the desired tag or tags and specify a value.

#2

The values of bookmarkRepository, ownPort, ownCmdPort, ownHost, reportCacheFileDir, and processMonitoringTemplatesRepository are not set in the default initialization file (config.xml). In addition, the XML tags themselves are also commented out. So, if you want to set these items, uncomment the desired tag or tags and specify a value.

#3

In the initial state of PFM - Web Console, when the following windows or commands are used to set a conditional expression for a field with the ulong type, only values between 0 and 2,147,483,647 can be specified.

  • Windows for creating and editing report definitions > Filter window

  • Windows for creating and editing report definitions > Edit Conditional Expression for Drilldown window

  • View Report window

  • Window for creating a new alarm or editing an existing alarm > Alarm Conditions window

  • Properties window in Service Hierarchy > LOGIF Expression Editor window

  • jpcrdef create command

  • jpcrpt command

  • jpcasrec update command

Set the condExpValueUlongExtension parameter to true in the initial settings file (config.xml) to specify a value between 0 and 4,294,967,295.

Note that when the condExpValueUlongExtension parameter is set to true, and

a value between 2,147,483,648 and 4,294,967,295 is specified in the condition for a field of the ulong type when the following definition information is created, the definition information cannot be edited in PFM - Web Console or PFM - View whose condExpValueUlongExtension parameter is set to false.

  • Report definitions

  • Alarm definitions

  • Log collection condition definitions

For operation on system environment using both PFM - Web Console and PFM - View, set the condExpValueUlongExtension parameter to false.

#4

This indicates the number of fields specified for the report definition rather than the number of fields specified for the graph.

Setting up communication with the View Server service

Table 4‒14: Setting items for when PFM - Web Console communicates with View Server

Item

Description

ownCmdPort#1

Specifies the port number to be used by PFM - Web Console (command) to communicate with the View Server service.

  • Specifiable values: 1024 to 65535

  • Default: Any available port

If specification is omitted, an available port number is set.

You must specify this item for a firewall environment. For details, see C.2 Firewall passage directions.

ownHost#1#2

Specifies the host name or IP address to be used as the callback target from the View Server service when PFM - Web Console communicates with the View Server service. This must be the name of a host running PFM - Web Console.

For a host name:

The following characters can be used. Note that only an alphanumeric character can be specified as the first character. Specify this item by using characters totalling from1 to 255 bytes.

  • Numeric characters 0 to 9

  • . (period)

  • - (hyphen)

  • Alphabetic characters A to Z and a to z

For an IP address:
  • 0.0.0.0 to 255.255.255.255

If the specified value is outside the specifiable range or invalid, the IP address of the PFM - Web Console host is set.

ownPort#1

Specifies the port number to be used by PFM - Web Console (Web server) to communicate with the View Server service.

  • Specifiable values: 1024 to 65535

If specification is omitted, an available port number is set.

You must specify this item for a firewall environment. For details, see C.2 Firewall passage directions.

#1

The values of bookmarkRepository, ownPort, ownCmdPort, ownHost, reportCacheFileDir, and processMonitoringTemplatesRepository are not set in the default initialization file (config.xml). In addition, the XML tags themselves are also commented out. So, if you want to set these items, uncomment the desired tag or tags, and specify a value.

#2

TCP/IP is used for communication between PFM - Manager and PFM - Web Console. This is also applied when PFM - Manager and PFM - Web Console exist together on the same host, not only when each of them exists on a separate host. Therefore, when you operate Performance Management, the host name or IP address that allows constant communication must be set on both the PFM - Manager host and the PFM - Web Console host. If the setting is not specified, the IP address that is first resolved from the PFM - Manager host name or PFM - Web Console host name is used.

For example, in the following configurations or operations, the host name or IP address that allows constant communication must be set on both the PFM - Manager host and the PFM - Web Console host.

  • When IP address translation (NAT) is used between the PFM - Manager host and the PFM - Web Console host

  • When the PFM - Manager host is connected to both the business LAN and the monitoring LAN, and Performance Management performs communication between hosts via the monitoring LAN

  • When the LAN cable is temporarily disconnected from the NIC for host maintenance operation (Because at this time, the IP address assigned to the NIC might be disabled)

Setting automatic logout

Table 4‒15: Setting items for automatic logout

Item

Description

sessionTimeout#

Specifies the expiration time in seconds to perform automatic logoff from PFM - Web Console if the user attempts no operations for a preset length of time or automatic update is not performed for a preset length of time.

  • Specifiable values: 0 to 86400

  • Default: 4000

If you specify 0, no timeout occurs. If the specified value is outside the specifiable range, the default value is set.

#

If you close the Web browser without logging off, session information remains in the PFM - Web Console memory as invalid and will be deleted automatically when a session timeout is detected. We recommend that you not set 0 as the value for sessionTimeout.

Setting linkage with other products

Table 4‒16: Setting items for linkage with other products

Item

Description

host (under <vsa><search-WebConsole> tag)#1

This item is used when a Performance Management report is displayed from an event in the Central Console via linkage with JP1/IM, or when a Performance Management report is displayed via linkage with JP1/AJS3.

To display a report of PFM - Web Console (not preset as the connection destination in the definition file #2) from another product window, specify the host name or IP address of that PFM - Web Console.

For a host name:

Specify the setting so that host names can be resolved on the host that displays reports.

Specify this item by using characters totalling from1 to 255 bytes.

  • Numeric characters 0 to 9

  • . (period)

  • - (hyphen)

  • Alphabetic characters A to Z and a to z

For an IP address:
  • 0.0.0.0 to 255.255.255.255

The default is blank.

https (under <vsa><search-WebConsole> tag)#1

This item is used when a Performance Management report is displayed from an event in the Central Console via linkage with JP1/IM, or when a Performance Management report is displayed via linkage with JP1/AJS3.

Specify whether to enable or disable encrypted communication for PFM - Web Console specified for host (under the <vsa><search-WebConsole> tag).

  • on: Encrypted communication for PFM - Web Console is enabled.

  • off: Encrypted communication for PFM - Web Console is disabled.

The default is off.

port (under <vsa><search-WebConsole> tag)#1

This item is used when a Performance Management report is displayed from an event in the Central Console via linkage with JP1/IM, or when a Performance Management report is displayed via linkage with JP1/AJS3.

Specify the port number for PFM - Web Console specified for host (under the <vsa><search-WebConsole> tag).

  • Specifiable values: 1 to 65535

  • Default: 20358

#1

To display reports for multiple instances of PFM - Web Console from the window of another product, define the <search-WebConsole> tag for the number of instances of PFM - Web Console. You can define a maximum of ten <search-WebConsole> tags.

#2

The definition file in which the connection-destination PFM - Web Console is set depends on the linked product.

For JP1/IM: Performance report definition file (performance.conf)

For JP1/AJS3: JP1/AJS3 - Web Console environment-settings file (ajs3web.conf)

Other settings

Table 4‒17: Other setting items

Item

Description

alarmCompatibleMode(under <vsa> tag)

Specifies whether to enable measures to address the problem that occurs when an alarm is illegally deleted when the alarm is updated.

The specifiable value is either of the following values:

  • true: The measures are enabled.

  • false: The measures are disabled.

The default is true.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

When true is specified, the problem that may occur when an alarm is illegally deleted when the alarm is updated is resolved. However, the Alarm Cleared event that used to occur for the following alarms (when the alarm is updated), no longer occurs.

  • All the alarms (except for the alarm to be updated) of agents related to the alarm to be updated.

  • Alarms in the Warning or Abnormal state

cmdRptBookmarkNameDecodeOnce(under <command><export> tag)

Specifies how to read the attribute value of the bookmark name specified in the input parameter file when a registered report or a report with combination bookmarks is output by the jpcrpt command.

  • true: Replace \\ by \ and replace \/ by / to read the value.

  • false: Replace \\\\ by \ and replace \\\/ by / to read the value. \\ and \/ are read as delimiters.

The default is true. If you specify any other value than those allowed, or you do not specify a value, the default value is set.

dispListByEachVirtualEnv

Specifies the default setting of either the Display the program(s) for each virtual environment or Display the command line(s) for each virtual environment check box displayed under either Add from Running Processes or Add from Running Processes (Command Lines) in either the Process Monitoring Settings > Create a New Application Definition window or the Process Monitoring Settings > Edit an Application Definition window.

  • on: Selected.

  • off: Not selected.

The default is off.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

selectAHModeForJP1Event

Specifies how to decide the Action Handler service to be selected by default in the window displayed by selecting New Alarm and Action Definition or Edit and Action Definition when JP1 event issuance is enabled as an action in the alarm definition. The following describes the specifiable values and their explanations:

  • compatible

    When the PFM - Manager host name specified for host in the initialization file (config.xml) matches the physical host name of the PFM - Manager host, the Action Handler service of PFM - Manager is selected. If they do not match, LOCAL is selected. In the following cases, they do not match:

    - When the IP address (other than 127.0.0.1) is specified

    - When an alias name is assigned to PFM - Manager by the function responsible for setting monitoring host names

    - When the case is different from that of the host name specified for host in the initialization file (config.xml)

  • local

    LOCAL is always selected.

  • manager

    The Action Handler service of PFM - Manager is always selected.

  • maintain

    When you edit an already existing alarm, the setting status of the Action Handler service is inherited. When you create an alarm, LOCAL is selected.

  • multipleManager

    When one host name is specified for PFM - Manager for the connection destination, the Action Handler service of PFM - Manager is selected. When two host names are specified for PFM - Manager for the connection destination, Manager is selected.

The default is compatible. However, when PFM - Web Console 10-00 or later is newly installed, the default is manager.

If you specify any other value than those allowed, or you do not specify a value, compatible is set.

setHostnameFolderWithNewAgent

Specifies the default setting of the Create a folder by using the host name check box in the Edit Agents > New Agents window.

One of the following values can be specified:

  • on: Selected.

  • off: Not selected.

The default is on.

If you specify any other value than those allowed, or you do not specify a value, the default value is set.

validate

Enables or disables the check rule specified in the property definition file.

  • on: Enable (default)

  • off: Disable