6.3.21 Report definition file

lang

Specify one of the following values as the language to be used when a report file is output:

• English: C

• Japanese (Shift-JIS): SJIS

• Japanese (EUC): EUC

• Japanese (UTF-8): UTF-8

All the titles specified in the definition file are converted into the language specified in this key when a report file is output. The character encoding of the report definition file must match the character encoding specified here.

title

((character string of up to 255 bytes))

Specify the title of each report. You can write spaces in the title.

target

Specify the collection server, collection target server, and the serial number to be output to the report, separated by commas (,).

• Collection server: specify the monitoring manager.

• Collection target server: specify the monitoring server.

• Serial number^#1: specify the serial number of the copy database to be reported. Specify none when you report the master database.

resource_id

Specify the resource ID to be output to the report.

subresource_id^#2

Specify the subresource ID to be output to the report. If you omit this item, all subresources are to be output to the report.

instance

((character string of up to 255 bytes))

Specify the instance name of the instance to be reported. To specify multiple instance names, specify this key multiple times. If you omit this item, all instances are to be output to the report. You cannot specify an instance name that has a space character at the beginning or the end.

format

Specify a report type.

tableA: Outputs the report in the table format that lists subresources in columns and instances in rows.

tableB: Outputs the report in the table format that lists instances in columns and subresources in rows.

tableC: Outputs the report in the table format that lists data according to instance.

tableD: Outputs the report in the table format that lists data according to subresource.

graph: Outputs the report in the line graph format.

graphB: Outputs the report in the histogram format.

graphC: Outputs the report in the bar graph format that displays data according to subresource.

graphD: Outputs the report in the bar graph format that displays data according to instance.

graphE: Outputs the report in the stacked bar graph format that displays data according to subresource.

graphF: Outputs the report in the stacked bar graph format that displays data according to instance.

graphG: Outputs the report in the pie chart format that displays data according to subresource.

graphH: Outputs the report in the pie chart format that displays data according to instance.

If you omit this key, tableA is assumed to be specified.

plot_type

((5 minutes to 1 day))

Specify the plot type for the output in a graph format. The average data at the specified time is plotted in the graph. You can specify m (minute), h (hour), or d (day) as the unit.

• When the report output format is the line graph:

  An average of collected data is calculated at intervals of the time specified in plot_type, and the average values are used to determine plot points. The line formed by connecting adjacent plot points is a collected-data line.

  If no data is collected during a plot interval, no plot point is created. In such a case, the period in which no plot point is created is ignored, and the next plot point is used to plot the line.

• When the report output format is the bar graph or stacked bar graph:

  An average of collected data is calculated at intervals of the time specified in plot_type, and the average values are displayed in a bar graph.

  If no data is collected during a plot interval, no bar is displayed for the period in the graph.

• When the report output format is the pie chart:

  An average of collected data is calculated at intervals of the time specified in plot_type, and the ratios between elements are displayed in a pie chart.

  If a standard value for pie chart is specified in graph_piechart_std, the percentage of each element in relation to the specified value is displayed in the pie chart.

• When the report output format is the table or histogram:

  This key is ignored even if a value is specified.

graph_xdivide

<<4n>>

When number of division: ((1 to 60))

When time specification: ((1 minutes to 365 day))

Specify the scale on the time axis for a report to be output in a graph format. For a report in a table format, this key is ignored.

Write a unit after the numerical value to be specified. Write n (number of divisions), m (minute), h (hour), or d (day) as the unit.

When a number of divisions is to be specified (when the unit is n), the specifiable range of values is 1 to 60. When a time interval is to be specified (when the unit is m, h, or d), the specifiable range of values is 1 minutes to 365 days.

Specification of an invalid value or unit causes an error in report creation and disables report creation.

graph_threshold_info

<<*,off,off>>

Specify whether to display threshold information in the report to be output in a graph format. For a report in a table format, this key is ignored.

subrsc_id

Specify the target subresource ID. The ID to be specified must match the subresource_id definition. If you specify *, the specification of this key applies to all the subresources to be output in the report. If you specify an ID instead of *, specify a unique ID.

[on|off] (first)

Specify whether to display the warning threshold. When on is specified, the threshold is displayed. When off is specified, the threshold is not displayed.

[on|off] (second)

Specify whether to display the critical threshold. When on is specified, the threshold is displayed. When off is specified, the threshold is not displayed.

If both * and a subresource ID are specified, * overrides.

Specification of an invalid value or character string causes an error in report creation and disables report creation.

When the display of threshold line is specified, the threshold line is output as the line whose value is 0 if threshold monitoring is not performed for the subresource or instance that is the object of threshold display.

graph_blank

<<off>>

Specify whether to display a graph line when no resource data was collected during the time interval specified for each plot type in the specified data extraction period. For a report in a table format, this key is ignored.

[on|off]

When on is specified, the graph line is not displayed (the blank is not reflected). When off is specified, the graph line is displayed (the blank is reflected).

Specification of an invalid value or character string causes an error in report creation and disables report creation.

graph_legend_row

<<10>> ((integer from 0 to 100))

Specify the number of rows of instance display in the legend for a graph. For a report in a table format, this key is ignored.

Numerical value

When a value is specified, the legend is output in the format to display instances separately for each subresource. When no value is specified or this key is omitted, the legend is output in the format to display instances by line wrapping for the number of instances.

When a value is specified, the legend is displayed with the specified number of columns even if the number of instances is larger than the specified number of columns. If the number of instances is smaller than the specified number of columns, the legend is displayed with the same number of columns as the number of instances. Specification of an invalid value or character string causes an error in report creation and disables report creation.

graph_statistics_info

Specify whether to display statistical information in a graph. For a report in a table format, this key is ignored.

[tableA|tableB|tableC|tableD]

Specify a table format among the values that can be specified in the format key. When a value is specified, statistical information is displayed in the specified table format under the graph.

When no value is specified or this key is omitted, statistical information is not displayed.

Specification of an invalid value or character string causes an error in report creation and disables report creation.

graph_time_adjust

<<off>>

Specify whether to apply the start time and end time specified for the data extraction period to the start time and end time on the time axis of the graph. For a report in a table format, this key is ignored.

When on is specified:

The start time and end time specified for the data extraction period are used as the start time and end time on the time axis of the graph.

When off is specified:

The earliest time and latest time of resource data collected during the data extraction period are used as the start time and end time on the time axis of the graph.

If on is specified when either the start time or end time, or both, are not specified for the data extraction period, the time to be applied when off is specified is applied to the time that is not specified.

Specification of an invalid value or character string causes an error in report creation and disables report creation.

graph_maxline

<<64>> ((1 to 1024))

Specify the maximum number of graph lines that can be displayed in the bar graph, stacked bar graph, or pie chart.

graph_piechart_std

<<100>> ((1 x 10^-2 to 1.7976931348623157 x 10³⁰⁸))

When the report format is the pie chart, specify a value that is used as the 100-percent value to calculate the percentages of graph elements and display them in a pie chart.

graph_histo_num

<<10>> ((4 to 20))

When the report format is histogram, specify the number of data sections.

graph_max_min

<<off,100.00,0.00>>

((-1.7976931348623157 x 10³⁰⁸ to 1.7976931348623157 x 10³⁰⁸))

When you specify on, a maximum value on the vertical axis, and a minimum value on the vertical axis, the maximum value and minimum value are set for the vertical axis of the graph. If a value in the graph is more than the set maximum value on the vertical axis or less than the set minimum value on the vertical axis, the vertical axis is adjusted automatically. Similarly, the vertical axis is adjusted automatically when a threshold is more than the set maximum value on the vertical axis or less than the set minimum value on the vertical axis.

• The specified maximum value must be larger than the specified minimum value.

• For the histogram, specify 4,294,967,295 or less as the maximum value and 0 or more as the minimum value. For a graph other than the histogram, specify maximum and minimum values between which the difference is 1.7976931348623157 x 10³⁰⁸ or less.

• As the maximum value and minimum value, specify values that have at most 2 digits after the decimal point. (If a value that has 3 or more digits after the decimal point is specified, the value is rounded off to 2 decimal places.)

When off, a maximum value and a minimum value are specified on the vertical axis, and the action to be taken when on is specified is disabled. Then, the maximum and minimum values on the vertical axis are set automatically. Note, however, that the maximum and minimum values specified in this key are checked for validity (the valid range of the values on the vertical axis in a created graph is the same as that of SSO version 08-00).

title

N

Y

Y

Y

Y

Y

Y

Y

target

N

N

Y

Y

Y

Y

Y

Y

resource_id

N

N

Y

Y

Y

Y

Y

Y

subresource_id

Y

Y

Y

Y

Y

Y

Y

Y

instance

Y

Y

Y

Y

Y

Y

Y

Y

format

N

Y

Y

Y

Y

Y

Y

Y

plot_type

N

Y

N

Y

N

Y

Y

Y

graph_xdivide

N

Y

N

Y

N

N

N

N

graph_threshold_info

Y

Y

N

Y

N

N

N

N

graph_blank

N

Y

N

Y

N

N

N

N

graph_legend_row

N

Y

N

Y

Y

Y

Y

Y

graph_statistics_info

N

Y

N

Y

N

Y

Y

Y

graph_time_adjust

N

Y

N

Y

N

Y

Y

Y

graph_maxline

N

Y

N

N

N

Y

Y

Y

graph_piechart_standard

N

Y

N

N

N

N

N

Y

graph_histo_num

N

Y

N

N

Y

N

N

N

graph_max_min

N

Y

N

Y

Y

Y

Y

N