Hitachi

JP1 Version 11 JP1/Performance Management Reference

1.4.3 Quick Guide window

This window enables you to create brief reports or set up alarms. To display this window, from the method frame in the Agents window, click the Quick Guide button.

The following figure shows the Quick Guide window.

Figure 1‒24: Quick Guide window

[Figure]

The following describes the displayed items:

Refresh

Refreshes the information displayed in the Quick Guide window.

Keywords to find:

Entering a maximum of 64 characters for the search keywords (including spaces used as delimiters) and then clicking the Search Fields button opens the Quick Guide > Search Fields window with the keywords search result displayed. For details about search fields, see (1) Quick Guide > Search Fields window.

However, when the data model description file has not been stored, the Search Fields button is not displayed. If the data model description file has not been stored, see the setup procedure for PFM - Web Console to register PFM - Agent or PFM - RM. For details, see the chapter that explains installation and setup in the JP1/Performance Management Planning and Configuration Guide.

Search Fields button

Displays the Quick Guide > Search Fields window.

List of records

Displays a list of records in alphabetical order. The following items are displayed.

Record name

Displays the record name.#

Clicking a record name or [Figure] to the left of the record name expands the list of fields. The following figure shows the Quick Guide window with the expanded field list.

Figure 1‒25: Quick Guide window (with the expanded field list)

[Figure]

The following shows the items that can be expanded.

Table 1‒11: Items displayed in the field list

Item

Value that is displayed

This is a single-instance record or This is a multi-instance record

Displays the field name.

  • This is a single-instance record

    Displayed when the corresponding record is a single-instance record.

  • This is a multi-instance record

    Displayed when the corresponding record is a multi-instance record.

    Field name and Description are also displayed as a list of ODBC key fields.

Field name

Displays the field name (excluding the ODBC key field).

Action

Displays the type of report or alarm by using an icon. If there is no icon to be displayed, n/a is displayed.

  • [Figure]: Realtime report

    This icon is displayed if the field is not Fields added only when data is stored in the Store database.#

    Clicking this icon opens the applicable View Report window as a new window.

  • [Figure]: Historical report

    This icon is displayed if any of the corresponding records of all the specified agents include Yes for Log, and the field is not Fields added only when data is stored in the Store database.

    Note that this icon is always displayed if false is specified for quickGuideHideReportIcon in the initialization file (config.xml).

    Clicking this icon opens the applicable View Report window as a new window.

  • [Figure]: Alarm

    This icon is displayed if the connection user is an administrator user, the field is not Fields added only when data is stored in the Store database, and the field is not any of the following: KeyDate type, DateTime type, or time_t type.

    Clicking this icon displays the Quick Guide > Create Alarm window in the information frame.

    For details, see 1.4.3(2) Quick Guide > Create Alarm window.

Format

Displays the attribute of the corresponding field by using an icon.

  • [Figure]: Numeric attribute

  • [Figure]: String attribute

Description

Displays a description of the corresponding field.

If there is no description, (No explanation provided) is displayed.

Close button

Closes the list of the expanded fields.
#

If realtime reports are set to be displayed in the re-schedule mode, records whose property value for Over 10 Sec Collection Time is set to Yes cannot be displayed in the realtime reports, and a message that indicates the information is displayed below the relevant record names.

At this time, if the value for quickGuideHideReportIcon in the initialization file (config.xml) is true (or this parameter is not specified), the realtime report icon is not displayed for Action in the field list. For details about the re-schedule mode, see the chapter on troubleshooting in the JP1/Performance Management User's Guide.

Record ID

Displays the record ID of the corresponding record.

Information stored in record

Displays the description of the corresponding record.

If there is no description, (No explanation provided) is displayed.

Log

Displays whether the corresponding record of the agent is set to record to the Agent Store database service.

  • Yes: Record

    If multiple agents are specified and the recording is set for any of the agents, Yes is displayed.

  • No: Do not record

  • n/a: Information cannot be obtained (such as when a connection to the specified agent server is not available).

If JP1/SLM is linked, the recording setting is displayed as shown in the following table according to the combination of the JP1/SLM settings and the Performance Management settings.

JP1/SLM setting

Performance Management setting

Content of Log

Starting monitoring

Recording performance data

Recording the Store database

Performed

Performed

Yes

Performed

Not performed

Yes

Performed

Not performed

Performed

Yes

Performed

Not performed

Not performed

No

Not performed

Performed

Yes

Not performed

Not performed

No
Organization of this subsection

(1) Quick Guide > Search Fields window

In this window, you can search fields. You can search a maximum of 50 fields by default.

You can set the maximum limit of fields to search, in searchLimit of the initialization file (config.xml). For details about the initialization file (config.xml), see Initialization file (config.xml).

The following figure shows the Quick Guide > Search Fields window.

Figure 1‒26: Quick Guide > Search Fields window

[Figure]

The following describes the displayed items:

Cancel button

Displays the Quick Guide window again.

Keywords to find

Enter no more than 64 characters for the search keywords (including spaces as delimiters). Observe the following precautions related to a search:

  • To perform a multi-keyword search by using AND, delimit keywords by using a single-byte or two-byte space.

  • An OR search cannot be performed.

  • Wildcard characters cannot be used.

  • A keyword search that consists only of spaces cannot be specified.

  • Spaces entered at the beginning and ending of a keyword are excluded.

  • If the search keyword includes spaces, the search will not be performed as intended.

  • The search is not case sensitive.

  • In the search keyword, a two-byte character and a single-byte character are recognized as different characters.

  • A search keyword that includes a line feed code cannot be entered.

After entering the search keyword, click the Search button. The search results will be displayed.

Search results are displayed, depending on the selection in the Records to search pull-down menu, in the following different windows:

  • If --All records-- is selected in Records to search

    The search results are displayed in the "Search results: number-of-records record(s)" window.

  • If --Records where Log=Yes-- is selected in Records to search

    The search results are displayed in the "Search results: number-of-records record(s)" window.

  • If a record name is selected in Records to search

    The search results are displayed in the "Search results: List of number-of-fields field(s) found in record record-name" window.

Search button

Performs a search.

Records to search

From the pull-down menu, select the records to search. By default, --All records-- is displayed.

In the pull-down menu, the following items are displayed:

  • --All records--

    Select this item to search all records.

  • --Records where Log=Yes--

    Select this item to search records in which Yes is set for the Log property. This item is displayed in the pull-down menu if the agent is running when this window opens.

  • List of record names of the selected agent

    Displays a list of record names of the selected agent in alphabetical order.

(a) Search results: number-of-records record(s) window

This window displays the number of fields found by a search for each record when --All records-- was selected in Records to search in the Quick Guide > Search Fields window. In the search results, the record names are displayed in alphabetical order. The following figure shows the Search Results: number-of-records record(s) window.

Figure 1‒27: Search Results: number-of-records record(s) window

[Figure]

The following describes the displayed items:

Cancel button

Returns to the Quick Guide window.

Keywords to find

Enter search keywords. For details, see 1.4.3(1) Quick Guide > Search Fields window.

Search button

Performs a search.

Records to search

From the pull-down menu, select the records that you want to search. For details, see 1.4.3(1) Quick Guide > Search Fields window.

Record name

A record name is followed by the following information:

  • Number of fields that correspond to the search result

  • Description of the record

    If there is no description, (No explanation provided) is displayed.

  • Instance type

    (This record is a single-instance record.) or (This record is a multi-instance record.) is displayed.

Clicking the menu of a record name lists the corresponding fields of the selected record in the "Search results: List of number-of-fields field(s) found in record record-name" window.

(b) Search results: List of number-of-fields field(s) found in record record-name window

A list of fields is displayed as a search result. The following figure shows the Search results: List of number-of-fields field(s) found in record record-name window.

Figure 1‒28: Search results: List of number-of-fields field(s) found in record record-name window

[Figure]

The following describes the displayed items:

Cancel button

Returns to the Quick Guide window.

Keywords to find

Enter search keywords. For details, see 1.4.3(1) Quick Guide > Search Fields window.

Search button

Performs a search.

Records to search

From the pull-down menu, select the records that you want to search. For details, see 1.4.3(1) Quick Guide > Search Fields window.

Go to Record List button

Displays the "Search results: number-of-records record(s)" window again. This button is displayed only if you moved to this window from the "Search results: number-of-records record(s)" window.

Field name

The field names are listed in alphabetical order. The search keyword portion is displayed in bold.

Action

The following information is displayed. If there is no icon to be displayed, n/a is displayed.

Table 1‒12: Icons displayed in the Action field

Icon

Meaning

Display condition

Action taken when the icon is clicked

[Figure]

Realtime report

The field is not Fields added only when data is stored in the Store database.

Note that, if all of the following conditions are met, this icon is not displayed:

  • The value for quickGuideHideReportIcon in the initialization file (config.xml) is true (or this parameter is not specified).

  • All of the specified agents are set to display realtime reports in the re-schedule mode.

  • The value for the Over 10 Sec Collection Time property is Yes.

The applicable View Report window opens as a new window.

[Figure]

Historical report

At least one of the corresponding records of all the specified agents includes Yes for Log.

Note that this icon is always displayed if false is specified for quickGuideHideReportIcon in the initialization file (config.xml).

The applicable View Report window opens as a new window.

[Figure]

Alarm

All of the following conditions are satisfied:

  • The connection user is an administrator user.

  • The field is not Fields added only when data is stored in the Store database.

  • The field is not one of the following:

    KeyDate type

    DateTime type

    time_t type

The Quick Guide > Create Alarm window is displayed in the information frame.

For details, see 1.4.3(2) Quick Guide > Create Alarm window.

Format

Displays the attribute of the corresponding field by using the following icons:

  • [Figure]: Numeric attribute

  • [Figure]: String attribute

Description

Displays description of the field. Bold characters indicate the characters that match with the search keyword.

To Page Top

(2) Quick Guide > Create Alarm window

This window, which is displayed when you click the [Figure] icon in the Quick Guide window, enables you to create alarms.

The following figure shows the Quick Guide > Create Alarm window.

Figure 1‒29: Quick Guide > Create Alarm window

[Figure]

The following describes the displayed items:

Cancel button

Clears the information area. If the information in the Quick Guide > Create Alarm window has been changed, a dialog box appears, confirming whether the settings can be discarded.

< Back button

Returns to the Quick Guide window. If you made changes in the Quick Guide > Create Alarm window, a dialog box asking if it is OK to discard the settings appears.

Finish button

Creates an alarm table and completes the alarm creation. You can click the Finish button only if all necessary information has been entered in the Quick Guide > Create Alarm window.

  • When there is a problem with the entered information:

    An error message is displayed on top of the window.

  • When there is no problem with the entered information:

    A dialog box appears, confirming whether to bind the alarm table. Clicking the OK button registers the alarm, binds the alarm table, and opens the Quick Guide > Create Alarm > View Results window.

General settings
Alarm table name

Specify the alarm table name by a character string of no more than 64 bytes. Character types that can be specified are shown below. You cannot specify a name that begins with PFM (in both upper case and lower case).

  • Two-byte characters

  • Alphanumeric characters

  • The following single-byte characters: % - ( ) _ . / @ [ ] and blank spaces

The following character string is displayed by default:

product-name Alarms 1
Alarm name

Specify the alarm name by a character string of no more than 20 bytes. Character types that can be specified are shown below. If you specify an invalid character for the alarm name, that character will be replaced with an underscore (_).

  • Two-byte characters

  • Alphanumeric characters

  • The following single-byte signs: % - ( ) _ . / @ [ ] and blank spaces

By default, the field name displayed in the Quick Guide window is displayed. In a character string that is more than 20 bytes, only the characters in the first 20 bytes are used, and the following characters are omitted.

Alarm message

Specify the message you want to display in the Event Monitor window by a character string that consists of single-byte or two-byte characters and that is no more than 255 bytes.

The following character string is displayed by default:

field-name is %CVS
Alarm-message preview

Displays the message you specified in Alarm message after its variable section is replaced with a string.

Record

Displays the record name specified in the Quick Guide window. You cannot edit the record name.

Description

Clicking this menu displays or hides the description of the record.

This menu is not displayed when the data model description file has not been stored for the product to which the corresponding record belongs.

Field

Displays the field name specified in the Quick Guide window. You cannot edit the field name.

Description

Clicking this menu displays or hides the description of the field.

This menu is not displayed when the data model description file has not been stored for the product to which the corresponding field belongs.

Alarm conditions
Realtime Reports or Historical Reports

Clicking the icon opens the View Report window as a new window in which reference values for creating an alarm are displayed. If no agent is operating, no reports are displayed.

  • [Figure]: Realtime report. Note that, if the value for quickGuideHideReportIcon in the initialization file (config.xml) is true (or this parameter is not specified), and all of the specified agents are set to display realtime reports in the re-schedule mode, this icon is not displayed for the records where the value for the Over 10 Sec Collection Time property is Yes.

  • [Figure]: Historical report. This icon is not displayed if Log, No, or n/a is displayed for all the records of all agents.

    However, if false is specified for quickGuideHideReportIcon in the initialization file (config.xml), this icon is always displayed.

Abnormal condition

Specify when to report an abnormal alarm by using a conditional expression.

Item

Value that is displayed

Field name

Displays the field name specified in the Quick Guide window.

You cannot edit this name.

Operator

Select an operator to use in the conditional expression from the followings:

  • =

  • <

  • <=

  • >

  • >=

  • <>

Threshold value

In the text box, enter the threshold value that is used for evaluation of an abnormal (red) alarm. You cannot omit this entry.

  • Character types that can be specified:

    Integer and decimal fraction using two-byte or single-byte characters (excluding control characters)

  • Character string length that can be specified:

    The length of this string or PQL byte (created from the combination of this value and the threshold value set in Warning condition) must be no more than 749 bytes.

Input format of the threshold value

Displays the data format of the threshold value that can be input according to the field name.
Warning condition

Specify when to report a warning alarm by using a conditional expression.

Item

Value that is displayed

Field name

Displays the field name specified in the Quick Guide window.

You cannot edit this name.

Operator

Displays an operator specified in Abnormal condition.

You cannot edit this item.

Threshold value

In the text box, enter the threshold value that is used for evaluation of a warning (yellow) alarm. You cannot omit this entry.

  • Character types that can be specified:

    Integer and decimal fraction using two-byte or single-byte characters (excluding control characters)

  • Character string length that can be specified:

    The length of this string or PQL byte (created from the combination of this value and the threshold value set in Abnormal condition) must be no more than 749 bytes.

Input format of the threshold value

Displays the data format of the threshold value that can be input according to the field name.

To Page Top

Copyright (C) 2016, 2019, Hitachi, Ltd.

Copyright (C) 2017, 2019, Hitachi Solutions, Ltd.

(C)opyright 2000-2009, by Object Refinery Limited and Contributors.