Hitachi

JP1 Version 12 JP1/Performance Management Reference


1.4.5 View Report window

The View Report window displays a report. The window is displayed when you perform any of the operations below. Note that if you log in as an ordinary user or a business group ordinary user when off is specified for editReportByOrdinaryUser in the initialization file (config.xml), Baseline, Bookmarks, and Save Report Definition are not displayed. For details about the initialization file (config.xml), see Initialization file (config.xml).

The View Report window consists of the following four pages:

The following describes the items that are common to all four pages:

Baseline

Baseline appears in the upper right corner of the View Report window only for reports that are not realtime reports, reports without graphs, or reports specified with the display key fields.

A baseline refers to a report that covers a period in the past that has been saved as a reference value. A baseline can be overlaid as the reference value on a combination report. See 1.4.5(1) Baseline window.

Bookmark

The Bookmark window that is used to register a bookmark or combination bookmark opens as a new window. See 1.4.14(2) Bookmark window.

Save Report Definition

Displays a separate Save Report Definition window, where you can specify the location for storing reports. See 1.4.5(2) Save Report Definition window.

Description

For each data model version of each applicable product, the Description of Record and Fields window is displayed as a new window. See 1.4.5(3) Description of Record and Fields window.

Close

Closes the Display Reports window.

The following describes the windows and pages.

Organization of this subsection

(1) Baseline window

The Baseline window is used to register the baseline.

The following figure shows the Baseline window.

Figure 1‒32: Baseline window

[Figure]

The following describes the displayed items:

Refresh

Updates the display of the Baseline window to the latest status.

Text box

Use this text box to filter bookmarks by keywords. Specify a character string of 1 to 1,024 characters to filter the bookmarks that will be displayed. To perform a multi-keyword AND search, delimit keywords by using a single-byte space, a two-byte space, or a tab. A delimiter is counted as one word. The maximum number of words that can be entered as filtering keywords is 100.

Filter button

Filters bookmarks by using the string specified in the text box.

Clear button

Clears the filtering status and the filtering condition.

Bookmarks tree

Specify the location for storing the baseline.

Specify the baseline name

Enter 1 to 64 single-byte or two-byte characters for the baseline name.

OK button

Depending on the selected object, either of the following applies:

  • When a combination bookmark is selected

    A baseline is added under the selected combination bookmark.

  • When a baseline is selected

    The selected baseline is updated.

Cancel button

Discards the definitions specified in the Baseline window, and closes the window.

(2) Save Report Definition window

The Save Report Definition window saves the report definitions. You can use the initialization file (config.xml) to specify whether to display the Save Report Definition menu for a user who logs in with an account that has general user permissions only. For details about the initialization file (config.xml), see Initialization file (config.xml).

The following figure shows the Save Report Definition window.

Figure 1‒33: Save Report Definition window

[Figure]

The following describes the displayed items:

Refresh

Refreshes the information displayed in the Save Report Definition window.

OK button

Saves the report according to the definition specified in the Save Report Definition window, and then closes the window.

An error message is displayed in the following cases:

  • If the report name entered in the text box is the same as an existing report name

  • If the report to be overwritten does not exist

Cancel button

Discards the specified definition and closes the Save Report Definition window.

Save (and overwrite) radio button

Overwrites the existing report definition. This item is not displayed in the following cases:

  • For an instant report

  • When a registered report is displayed

  • If the report to be overwritten has been deleted

  • For the report definition of the monitoring template

Save as radio button

Displays the reports tree that specifies the location for storing the report.

Text box

Use this text box to filter the locations for storing report definitions by keywords. Specify a character string of 1 to 1,024 characters to filter the locations for storing the report definitions that will be displayed. To perform a multi-keyword AND search, delimit keywords by using a single-byte space, a two-byte space, or a tab. A delimiter is counted as one word. The maximum number of words that can be entered as filtering keywords is 100.

New Folder

Filters the locations by using the string specified in the text box.

Cancel

Clears the filtering status and the filtering condition.

Reports tree

Specify the folder for storing the report definitions.

Specify a report name

Enter a report name within the range of 1 to 64 characters by using single-byte or two-byte characters.

You can enter a value in this text box only when a folder has been selected in the reports tree.

New Folder button

Displays the Save Report Definition (for entering a folder name) window.

In this window, a text box is displayed only if a folder has been selected in the reports tree.

Figure 1‒34: Save Report Definition (for entering a folder name) window

[Figure]

Enter a report folder name by using 1 to 64 single-byte or two-byte characters.

When you click the OK button after entering the name, the Save Report Definition (for entering a folder name) window closes, and a report folder is created.

If you click the Cancel button, the entered name is discarded, and the Save Report Definition (for entering a folder name) window closes.

(3) Description of Record and Fields window

The Description of Record and Fields window displays information about a record and the fields in the record. The same window is displayed for the Reports window and the Alarms window.

The following figure shows the Description of Record and Fields window.

Figure 1‒35: Description of Record and Fields window

[Figure]

The following describes the displayed items:

Record name

Displays record names in a hierarchical structure. If you click a link for a record name, you can jump to the record information section in a list.

Field name index

Lists the initial characters of the fields in the applicable record. If you click the link, you can jump to the applicable field information section in a list.

Record

Displays the record name.

Description (for Record)

Displays a description of the record.

Field

Lists the field names in the applicable record in alphabetical order.

Description (for Field)

Displays field descriptions.

(4) View report page

This page displays the specified report. It displays performance data collected by each agent as a graphical report in graph or table format.

The following figure shows the View Report window (View report page).

Figure 1‒36: View Report window (View report page) (when only a graph is displayed)

[Figure]

The following describes the displayed items:

Check boxes
Graph

Displays the report's data as a graph. This check box is selected as a default.

If there is no applicable data or no applicable settings in the report definition, this check box is disabled.

List

Displays a listing of the report's data. This check box is selected as a default.

If there is no applicable data or no applicable settings in the report definition, this check box is disabled.

Table

Displays the report's data as a table. This check box is selected as a default.

If there is no applicable data or no applicable settings in the report definition, this check box is disabled.

Data group buttons

A data group is data grouped by record collection time.

[Figure] button

Displays the first data or data group.

[Figure] button

Displays the previous data or data group.

[Figure] button

Displays the next data or data group.

[Figure] button

Displays the last data or data group.

Drilldown report selection list

Enables you to select a drilldown report from a pull-down menu. This item appears only when a drilldown report is defined for the displayed report, bookmark, or combination bookmark.

When you move the mouse pointer to the selection list, the name of the currently selected report appears in the tool tips, allowing you to check the complete report name if it is too long to fit in the selection list box.

Link menu
Display Reports

Clicking this item while a drilldown report is selected from the drilldown report selection list displays a new View Report window.

Refresh

Acquires data again and refreshes the display.

Export

Exports to a CSV text file the data acquired for displaying the report. This item is not displayed for automatically refreshed realtime reports. To display this item in this case, first choose Stop to stop automatic refreshing. Choosing Export displays a dialog box for downloading files.

Print

Displays the Print Reports window as a new window.

This item is not displayed in a realtime report that is being updated automatically. If you want to display this item during an automatic update, choose the Stop menu item to stop the update.

For details about the Print Reports window, see 1.4.6 Print Reports window.

Stop

Stops automatic refreshing of realtime reports.

Button for changing the report display period:

For a historical report, you can move data of the same period of time as that in the currently displayed report forward or backward by using any of the buttons below. Note that on the Show Options page, you can change the setting for the report display period in finer detail.

[Figure] button

Displays a report after moving the period backward for the same period of time as the displayed period.

[Figure] button

Displays a report after moving the period backward by one-half the time of the currently displayed period.

[Figure] button

Displays a report after moving the period forward by one-half the time of the currently displayed period.

[Figure] button

Displays a report after moving the period forward for the same period of time as the currently displayed period.

For example, if the data for one hour from 10:00 to 11:00 is displayed, the following data is displayed:

  • [Figure] button: The data from 9:00 to 10:00

  • [Figure] button: The data from 9:30 to 10:30

  • [Figure] button: The data from 10:30 to 11:30

  • [Figure] button: The data from 11:00 to 12:00

Also, if data for 30 days from January 1 to January 30 is displayed, the following data is displayed:

  • [Figure] button: The data from December 2 to December 31

  • [Figure] button: The data from December 17 to January 15

  • [Figure] button: The data from January 16 to February 14

  • [Figure] button: The data from January 31 to March 1

Message display icon ([Figure] [Figure])

This icon is displayed if a message related to automatic refresh is generated when a realtime report is displayed. Clicking [Figure] displays the message.

Name of operation mode for realtime reports

If a realtime report is displayed while the setting is configured so that collecting history data takes priority over displaying realtime reports, either the re-schedule mode or temporary log mode is displayed, depending on the setting.

For details about the settings for prioritizing collecting history data over displaying realtime reports, see the chapter on troubleshooting in the JP1/Performance Management User's Guide.

Graph display area

Displays the graph area.

[Figure] button

Displays the first page when a graph field spans multiple pages.

[Figure] button

Displays the pervious page when a graph field spans multiple pages.

[Figure] button

Displays the next page when a graph field spans multiple pages.

[Figure] button

Displays the last page when a graph field spans multiple pages.

Zoom

Zooms the graph display. Available magnifications are 100%, 200%, 400%, 600%, and 800%.

List display area

Displays a list of field values for each agent or instance. In the list, if a field name has a link, clicking the link displays a drilldown report (field level).

[Figure] button

Displays data for the first agent or instance in the same data group.

[Figure] button

Displays data for the previous agent or instance in the same data group.

[Figure] button

Displays data for the next agent or instance in the same data group.

[Figure] button

Displays data for the last agent or instance in the same data group.

Table display area

Displays accumulated time-series historical data in table format. If a table value has a link, clicking the link displays a drilldown report (field level).

First Instance

Displays the first page.

Previous Instance

Displays the previous page.

Data number

first-data-number-on-displayed-page - last-page-number-of-displayed-page OF total-number-of-data-items is displayed.

Example: 5-24 OF 50

Next Instance

Displays the next page.

Last Instance

Displays the last page.

Note that you can select the display position of the time field by changing dateFieldCheckboxDisplay and dateFieldState in the initialization file (config.xml). For details, see Initialization file settings (config.xml).

(5) Properties page

This page displays the report definitions displayed on the View report page. The information that is displayed is the settings you specified in the window for creating a new report definition or the window for editing definitions.

The following figure shows the View Report window (Properties page).

Figure 1‒37: View Report window (Properties page)

[Figure]

If you click the link at the top of the window on the Properties page, you can jump to the area that displays the applicable information. For details about the items displayed in each area, see 1.5.3 Windows for creating and editing report definitions.

The following describes the items displayed on this page:

Name and type

This area displays the information set in the New Report > Name and Type or Edit > Name and Type window for report definitions.

Field

This area displays the information set in the New Report > Field or Edit > Field window for report definitions.

Indication settings(Realtime) or Indication settings (Historical)
  • For a realtime report

    The Indication settings(Realtime) area displays the information set in the New Report > Indication Settings(Realtime) or Edit > Indication Settings(Realtime) window for report definitions.

  • For a historical report

    The Indication settings (Historical) area displays the information set in the New Report > Indication Settings (Historical) or Edit > Indication Settings (Historical) window for report definitions.

Components

This area displays the information set in the New Report > Indication Settings or Edit > Indication Settings window for report definitions.

Graph

This area displays the information set in the New Report > Graph or Edit > Graph window for report definitions.

Drilldown

This area displays the information set in the New Report > Drilldown or Edit > Drilldown window for report definitions.

(6) Edit Report Definition page

This page enables you to edit the definitions for the report displayed on the View report page.

The following figure shows the View Report window (Edit Report Definition page).

Figure 1‒38: View Report window (Edit Report Definition page)

[Figure]

If you click the link at the top of the Edit Report Definition page, you can jump to the display area of the applicable information. For details about the display items and settings in each area, see 1.5.3 Windows for creating and editing report definitions.

The following describes the displayed items:

OK button

Saves the settings and returns to the View Report window.

Cancel button

Discards the definitions in the Edit Report Definition window and returns to the View report page.

Name and type

This area displays the information set in the New Report > Name and Type or Edit > Name and Type window for report definitions.

Field

This area displays the information set in the New Report > Field or Edit > Field window for report definitions. You can edit information other than the record name.

Filter

By default, no value is displayed in the Filter area. You can add definitions in this area.

Indication settings(Realtime) or Indication settings (Historical)
  • For a realtime report

    The Indication settings(Realtime) area displays the information set in the New Report > Indication Settings(Realtime) or Edit > Indication Settings(Realtime) window for report definitions. You can edit definitions in this area.

  • For a historical report

    The Indication settings (Historical) area displays the information set in the New Report > Indication Settings (Historical) or Edit > Indication Settings (Historical) window. You can edit definitions in this area.

Components

This area displays the information set in the New Report > Indication Settings or Edit > Indication Settings window for report definitions. You can edit definitions in this area.

Graph

This area displays the information set in the New Report > Graph or Edit > Graph window for report definitions. You can edit definitions in this area.

Drilldown

This area displays the information set in the New Report > Drilldown or Edit > Drilldown window for report definitions. You cannot edit definitions in this area.

(7) Show Options page

You can specify the display settings for the report displayed in the View report page.

The display items on the Show Options page vary according to the report type (either realtime report or historical report). The following describes each case.

(a) Show Options page (For a realtime report)

The following figure shows the Show Options page (for a realtime report) of the View Report window.

Figure 1‒39: Show Options page of the View Report window (for a realtime report)

[Figure]

The following describes the items displayed on this page:

OK button

Applies the settings. Clicking this button displays the View report page again.

Cancel button

Discards the settings and returns to the View report page.

Indicate delta value

Displays the report in terms of delta values. When this item is selected and delta values have been collected in a field of the corresponding record, the amount of change in the performance data from the previously collected delta value to the most recently collected delta value is displayed.

Note that this setting is disabled if realtime reports are set to be displayed in temporary log mode, and realtime reports are always displayed by using the amount of change in the performance data from the previously collected value.#

Refresh interval
Do not refresh automatically

Does not automatically refresh the View Report window.

Refresh interval

Specifies the interval (in seconds) at which the View Report window is to be refreshed automatically. The maximum value is 3,600 seconds

Note that this setting is disabled if realtime reports are set to be displayed in temporary log mode, and realtime reports are automatically refreshed according to the value set for the Collection Interval property for the records.#

Display by ranking

Specifies that there is to be a limit on the higher- or lower-order data that is displayed in the report. This item is displayed for multi-instance records.

Field

Specifies a field that is to be used as the reference for displaying the number of higher- or lower-order data items specified in Display number.

Display number

Specifies the number of higher- or lower-order data items to be displayed, in the range of 1 to 100. This item is enabled only when a field is selected in Field.

In descending order

Specifies that the data is to be displayed in descending order.

Graph options
Show 3D graph

Specifies that a 3-dimensional graph is to be displayed.

Show gridlines

Specifies that gridlines are to be displayed on the graph.

Show AutoLabel

Select this check box to display the value for the corresponding data as a tool tip when you move the cursor onto the plot in a graph.

Manually set the max. and min. values of the vertical axis

Specifies that maximum and minimum values to be displayed on the vertical axis are to be set. When you select this item, specify desired values in Max. value and Min. value.

Max. value

This item is enabled when Manually set the max. and min. values of the vertical axis is selected. Specify a desired value as the maximum value to be displayed on the graph's vertical axis.

Min. value

This item is enabled when Manually set the max. and min. values of the vertical axis is selected. Specify a desired value as the minimum value to be displayed on the graph's vertical axis.

#:

For details about temporary log mode for realtime reports, see the chapter on troubleshooting in the JP1/Performance Management User's Guide.

(b) Show Options page (for a historical report)

The following figure shows the Show Options page of the View Report window (for a historical report).

Figure 1‒40: Show Options page of the View Report window (for a historical report)

[Figure]

The following describes the items displayed on this page:

OK button

Applies the settings. Clicking this button displays the View report page again.

Cancel button

Discards the settings and returns to the Display report page.

Settings for the report display period

Specifies a report display period.

Date range

From the pull-down menu, select the display period for the report.

You can select from the following values:

  • Specify when displayed

  • Within the past hour

  • Within the past 24 hours

  • Within the past 7 days

  • Within the past month

  • Within the past year

If a value other than Specify when displayed is selected, the appropriate dates and times are set automatically in Start time and End time.

Start time and End time

When you selected Specify when displayed in Date range, enter a start date and time and an end date and time for event display.

Specify Start time and End time in the format YYYY MM DD hh:mm (YYYY: year, MM: month, DD: date, hh: hour, mm: minute).

The permitted date and time range is from 01-01-1971 00:00 to 12-31-2035 23:59. The date and time set in End time must be later than the date and time set in Start time.

If you selected a date range other than Specify when displayed, the appropriate dates and times are set automatically. If you change an automatically set date and time, the Date range setting changes to Specify when displayed.

Report interval

Set the interval for displaying data in the report. This item is enabled for records of the PI record type.

When this item is set, average values (summarized) over the specified period are displayed in the report.

Available values are as follows:

  • Minute: Displays the report based on 1-minute intervals.

  • Hour: Displays the report based on 1-hour intervals.

  • Day: Displays the report based on 1-day intervals.

  • Week: Displays the report based on 1-week intervals.

  • Month: Displays the report based on 1-month intervals.

  • Year: Displays the report based on 1-year intervals.

If you specified an interval other than Minute, then in the window with the View report page, in the display area of the table, click the value in Date and Time to display drilldown reports.

Display the start time data and Display the end time data

Switches between displaying and hiding the data that matches the date and time you specified in Start time or End time for the data that will be displayed in a report. By default, these check boxes are selected. You can set the default selection status in excludeTerminalData (under the <vsa> tag) of the initialization file (config.xml). For details about the initialization file (config.xml), see Initialization file (config.xml).

If both check boxes are selected, data that matches the date and time you specified in Start time or End time is displayed.

If both check boxes are cleared, data that matches the date and time you specified in Start time or End time is not displayed.

Maximum number of records

Specifies the maximum number of records to be displayed in the report, in the range of 1 to 1,440.

You can specify in PFM - Web Console's initialization file (config.xml) the maximum number of records (maxFetchCount) in the range of 1 to 2,147,483,647. In this case, you can only specify in Maximum number of records a value that is within the range specified in the config.xml file.

Peak time

Specifies that the display is to be of only the data at the time at which the field specified in Field contains its maximum value for the day (the peak time).

Field

From the pull-down menu, select the field on which the peak-time display is to be based on. This item is enabled for a single-instance record (single-row record) when Hour is selected in Report interval.

Graph options
Show 3D graph

Specifies that a 3-dimensional graph is to be displayed.

Show gridlines

Specifies that gridlines are to be displayed on the graph.

Show AutoLabel

Select this check box to display the value for the corresponding data as a tool tip when you move the cursor onto the plot in a graph.

Manually set the max. and min. values of the vertical axis

Specifies that maximum and minimum values to be displayed on the vertical axis are to be set. When you select this item, specify desired values in Max. value and Min. value.

Max. value

This item is enabled when Manually set the max. and min. values of the vertical axis is selected. Specify a desired value as the maximum value to be displayed on the graph's vertical axis.

Min. value

This item is enabled when Manually set the max. and min. values of the vertical axis is selected. Specify a desired value as the minimum value to be displayed on the graph's vertical axis.