12.3.2 Setup for linking with JP1/IM

If the name of the Performance Management monitoring host differs from its actual host name, the monitoring host name must be added to the JP1/IM host information file (jcs_hosts). After editing the file, use the following procedure to apply the changes:

Import the host information.

jcshostsimport -o (host-information-file)
Reload JP1/IM.

jco_spmd_reload

For details on the host information file and JP1/IM commands, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide or the manual Job Management Partner 1/Integrated Management - Command and Definition File Reference.

The following table shows the process flow for setup. The required steps depend on the JP1 event type used and the extent of linkage between Performance Management and JP1/IM.

Table 12‒3: Process flow for setup
No.	Setup procedure	Refer to:	Necessity for setup
No.	Setup procedure	Refer to:	JP1 system event	JP1 user event
1	Configuration for issuing JP1 events In the PFM - Web Console, set up the configuration so that JP1 events are issued when a monitored event occurs in JP1/IM.	12.3.2(1)	Required	Required
2	Defining alarm events and reports Define alarm events to be monitored in JP1/IM and operation reports in the PFM - Web Console.	12.3.2(2)	Required	Required
3	Setting for linking with JP1/IM integrated console Edit the definition files required in JP1/IM - Manager, and then store them under a directory for JP1/IM.	12.3.2(3)(a)	None required^#1	Required
4	Setting for linking with the Tool Launcher window of JP1/IM^#2 Edit the definition files required in JP1/IM - View, and then store them under a directory for JP1/IM.	12.3.2(3)(b)	Required if linking	Required if linking
5	Setting for linking with the integrated scope of JP1/IM^#3 Execute the command for linkage with the monitored object (`jpcconf im` command).	12.3.2(4)	Required if linking	Required if linking
6	Specifying whether the messages of JP1 user events are enclosed in quotes In UNIX, specify whether JP1 user event messages are enclosed in quotes.	12.3.2(5)	Unavailable	Optional (Set if not using quotation mark)

#1: For a JP1 system event, you do not need to edit or copy the definition file, even when linking with JP1/IM integrated console.
#2: You must complete no. 3 in the table (setting for linking with JP1/IM integrated console) before you can configure Performance Management to link with the JP1/IM Tool Launcher.
#3: You must complete no. 3 in the table (setting for linking with JP1/IM integrated console) before you can configure Performance Management to link with the JP1/IM integrated scope.
Note:: Linkage with the system-monitored object for Performance Management in JP1/IM is required in order to enable monitoring with the integrated scope. For details on settings and operations of JP1/IM, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide and Job Management Partner 1/Integrated Management - Manager Configuration Guide.

This subsection describes the setup procedures for linking with JP1/IM.

Organization of this subsection

(1) Configuring so that JP1 events are issued
(2) Associating alarms with JP1 events and reports
(3) Editing and copying the definition files for linkage
(4) Using icons to monitor the system operating status by linking with the JP1/IM monitored object function
(5) Setting quotation marks enclosing a JP1 user event message

(1) Configuring so that JP1 events are issued

(a) Configuring the issuing of JP1 system events by individual PFM services

From the monitoring console Web browser, log on to PFM - Web Console.

Log on to a user account that has administrator user permissions.

You must have administrator user permissions to use the Services window.
In the navigation frame of the main window, select the Services tab.

In the navigation frame of the Services window, choose the service to be set.

The selected service is marked with a checkmark.

The following table lists the events that trigger JP1 system events and the properties to be set for each target service.

Table 12‒4: Events that trigger JP1 system events and properties to be set for each target service
Event	Target service	Properties to be set
Occurrence of events related to the status change and operation of Performance Management services	PFM - Manager service Name Server Master Manager Master Store Correlator Trap Generator View Server	Master Manager
	PFM - Agent and PFM - RM services Agent Collector and Remote Monitor Collector Agent Store or Remote Monitor Store These services are used instance by instance (for multi-instance agents).	Agent Collector and Remote Monitor Collector
	Status Server service^#2 Status Server	Master Manager, Agent Collector, Remote Monitor Collector, or Action Handler^#1
	Action Handler service Action Handler

#1: Use the same value for the listed services on the same host.
#2: The Status Server service does not appear as a service on a logical host.

Select the JP1 Event Configurations node.

At the bottom of the information frame, the properties of the JP1 Event Configurations node are displayed.
For JP1 system events, set the properties as follows.

Target service: Yes
JP1 Event Send Host
Specify the name of an event server connected to JP1/Base using 255 or less alphanumeric characters. You can only specify an event server running on the same logical or physical host as the Performance Management service that issues the JP1 events. You cannot specify an IP address. Any preceding or trailing spaces in the specified value are ignored.

localhost indicates a physical host. If an out-of-range value is specified or if no value is specified, the event-issuing host is assumed to be a host (a physical host in a physical host environment or a logical host in an logical host environment) running Performance Management services that issue JP1 events.

The default value is blank.
Reference note
Normally, you do not need to set this parameter. Set the parameter in situations like the following:

Performance Management services are running on host 1 (physical host), but you want to use JP1/Base running on host 2 (logical host) to issue JP1 events.

In this case, we recommend that you set JP1 Event Send Host to host 2 (the logical host).

The name of the event server in this parameter is different from the name set for the using the function for setting monitoring-host names. If you have already set a monitoring host name, you do not need to set this parameter.
Monitoring Console Host

To start the PFM - Web Console, specify the name of the PFM - Web Console host in the JP1/IM - Manager monitor startup function. Specify the name with 255 or less alphanumeric characters. You cannot specify an IP address. Any preceding or trailing spaces in the specified value are ignored.

If an out-of-range value is specified or if no value is specified, the name of the PFM - Manager for the connection destination of PFM - Web Console is assumed.

The default value is blank.

Monitoring Console Port

Specify the port number (http request port number) for the PFM - Web Console to be started. If no value is specified, the value 20358 is assumed.

The default value is blank.

(b) Configuring the issuing of JP1 system events by alarms

Select the Alarm node under the JP1 Event Configurations node.

At the bottom of the information frame, the properties of the Alarm node are displayed.
Set the properties to the following:

Specify a JP1 event type to be associated if an alarm event occurs.

JP1 Event Mode

To use a JP1 system event: JP1 System Event

To use a JP1 user event: JP1 User Event

(c) Configuring the issuing of JP1 system events for monitoring suspension or resumption

Select the System node under the JP1 Event Configurations node.

At the bottom of the information frame, the properties of the System node are displayed.
Set the properties to the following:

Monitoring Suspend

Specify whether to issue a JP1 system event when monitoring is suspended or resumed. The default value is No.

To issue a JP1 system event: Yes

To issue a JP1 system event only in the primary system in a multiple monitoring environment: Yes(Primary)

To issue no JP1 system event: NO

To Page Top

(2) Associating alarms with JP1 events and reports

In the Alarms window of PFM - Web Console, set up the following items:

Set up the issuing of a JP1 event as an action.

This item sets up the issuing of a JP1 event as the action to be performed when an alarm is issued.
Associate alarms with reports.

This item enables reports to be displayed in the window of PFM - Web Console from the JP1/IM event console.

For details on the definition of alarms, see 6. Monitoring Operations with Alarms.

The following procedure mainly describes operations for setting up JP1 events to be issued and for associating alarms with reports.

Log on to PFM - Web Console as a user with administrator user permissions.
In the navigation frame of the Main window, select the Alarms tab.
In the navigation frame of the Alarms window, select the alarm definition for which you want to issue JP1 events.

The selected alarm is marked with a checkmark.
Choose the Edit method in the method frame.
In the Edit > Main Information window in the information frame, click the Next button.
In the Edit > Action window, enter settings in the Actions to be executed area.

In Command, select conditions (Abnormal, Warning, or Normal) of the alarm for which you want to issue JP1 events.
In Report to be displayed, click the Browse button to select the report to be associated with the alarm.

The selected report is marked with a checkmark.
Click the Finish button.
Click the Next button.
In the Command definition area of the Edit > Action Definitions window, click the JP1 Event button.
In the New Alarm > Action Definitions > JP1 Event Settings window, set the event ID and other information.

For example, suppose you want to send the JP1 event under the following conditions:

Conditions:
- Set the event ID to 001.
- Set the message text to the content of the message text (%MTS), which you set in the Message of the New Alarm Table > Main Information dialog box.
- Convert the alarm status to a severity-level JP1 event.
Set as follows:

Event ID: 001

Message: %MTS

Convert the alarm level to the severity level: Selected

Note:

Do not modify the attributes of the JP1 event if you want to link with the JP1/IM monitoring objects.

For a JP1 system event, the information set for Event ID is output as an event ID (JPC_USER_EVENTID) identifying an extended JP1 event attribute. For a JP1 user event, the information is output as an event ID for a basic JP1 event attribute.

For details on JP1 event types, see 12.2 JP1 events issued from Performance Management to JP1/IM.
Click the OK button.

The issuing of the JP1 event is defined as an alarm action, and the selected report is associated. For details on the issued JP1 events, see 12.5 List of attributes of JP1 events issued when linking with JP1/IM.
Select the Action Handler service of the host that issues the JP1 event.

When you enter settings in the JP1 Event Settings window, the setting in Action handler changes automatically. By default, the Action Handler service on the PFM - Manager host is selected. If you want to issue the JP1 event on a host other than the PFM - Manager host, you must modify the setting in Action handler.

Note 1

To issue a JP1 event, JP1/Base must be installed on the same host as the Action Handler that issues the event.

Note 2

To issue a JP1 event during Performance Management monitoring using the JP1/IM integrated scope, you must select an Action Handler service running on the same host as PFM - Manager.

Note 3

You can change which host's Action Handler service is selected by setting the selectAHModeForJP1Event parameter in the initialization file (config.xml). For details on how to enter settings in the initialization file (config.xml), see the section describing the file in the appendixes of the manual Job Management Partner 1/Performance Management Reference.

If you want to issue the JP1 event on a host other than the automatically selected host, you must modify the setting in Action handler manually.
When you want to issue a JP1 event to a logical host in a logical host environment, add the -r logical-host-name option to Command arguments.

If you do not specify this option, JP1 events are registered in the physical host.
Click the Finish button.

To Page Top

(3) Editing and copying the definition files for linkage

In order to enable monitoring of JP1 events by using JP1/IM, you need to edit the JP1/IM definition files that are provided by Performance Management according to the environment and to copy the files to each of the corresponding JP1/IM directories.

Tip

You might need to restart JP1/IM to enable the editing of definition files in JP1/IM. For details on restart timings of the definition files and timing when the definition files take effect, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide, Job Management Partner 1/Integrated Management - Manager Configuration Guide, and the manual Job Management Partner 1/Integrated Management - Manager Command and Definition file Reference.
If the source and destination hosts for the copied JP1/IM definition files are running different operating systems, you might need to change the file encoding.

The JP1/IM definition file provided by Performance Management is stored in the following folder:

In Windows:

PFM-Web-Console-installation-folder\sample\imconf
In UNIX:

/opt/jp1pcwebcon/sample/imconf/

(a) Definition files required in JP1/IM - Manager

When you use monitoring with the integrated console to issue a JP1 user event, you must edit and copy the definition file required by JP1/IM - Manager. This is not necessary when you use monitoring with the integrated console to issue a JP1 system event.

Definition file for the extended event attributes

This file defines the extended event attributes of JP1 events.

File name:

hitachi_jp1_pfmWebCon_attr_language-codes.conf

Items to edit:

Change the order id value to the event ID set by the JP1 event-issuing command. To display reports from JP1/IM, you also need to set the specified event ID in the definition file for opening monitor windows.

For example, specify the following when the event ID is 00001234:

[Figure]

Copy destination

Copy the edited definition file for the extended event attributes to the directory on the host that has JP1/IM - Manager installed as listed below:

For physical hosts:

In Windows:

installation-folder-for-jp1/im-manager\conf\console\attribute\
In UNIX:

/etc/opt/jp1cons/conf/console/attribute/

For logical hosts:

In Windows:

shared-folder\jp1cons\conf\console\attribute\
In UNIX:

shared-directory/jp1cons/conf/console/attribute/

For details, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide, Job Management Partner 1/Integrated Management - Manager Configuration Guide, and the manual Job Management Partner 1/Integrated Management - Manager Command and Definition file Reference.

Definition file for opening monitor windows

This file defines settings for opening monitor windows. The definition file for opening monitor windows is used to open a monitor window, such as one for the event-issuing source, from the event console window of JP1/IM - View. You need to enter settings in this file if you want to display a View Report window in PFM - Web Console when a JP1 event occurs.

File name:

hitachi_jp1_pfmwebcon_mon_language-codes.conf

Items to edit:

Change the value of the EVENT_ID to the event ID set with the JP1 event-issuing command. Also, change the PATH host name and port number to those of PFM - Web Console. Note that the specified event ID needs to be set in the definition file for the extended event attributes.

For example, if 00001234, PFM-WebCon, and 20358 are assigned to the event ID, host name, and port number respectively are specified as follows:

[Figure]

Copy destination

Copy the edited definition file for opening monitor windows to the directory on the host that has JP1/IM - Manager installed as listed below:

For physical hosts:

In Windows:

installation-folder-for-jp1/im-manager\conf\console\monitor\
In UNIX:

/etc/opt/jp1cons/conf/console/monitor/

For logical hosts:

In Windows:

shared-folder\jp1cons\conf\console\monitor\
In UNIX:

shared-directory/jp1cons/conf/console/monitor/

Example of displaying View Report windows in PFM - Web Console for several instances of PFM - Manager

Note

A PFM - Web Console instance is required for each PFM - Manager instance. For example, if there are two PFM - Manager instances, there must be two PFM - Web Console instances.

You need to use different event IDs to display View Report windows in PFM - Web Console for multiple PFM - Managers.

For example, if 00000000 and 00001111 are assigned to the event IDs, specify the definition file for the extended event attributes and the definition file for opening monitor windows as follows:

Definition file for the extended event attributes:
Definition file for opening monitor windows:

In the example above, the event ID 00000000 corresponds to PFM - Web Console host name PFM-Webcon1 and port number 8080. Similarly, the event ID 00001111 corresponds to PFM - Web Console host name PFM-Webcon2 and port number 20358.

(b) Definition files required in JP1/IM - View

Definition file for the tool launcher

The definition file for the tool launcher defines the tree structure and display items to be displayed in the Tool Launcher window in JP1/IM - View. You need to set the definition file for the tool launcher to enable the window of PFM - Web Console to be displayed from the Tool Launcher window.

File name

hitachi_jp1_pfmWebCon_tree.conf

Items to edit

Change the host name and port number of arguments to the host name and port number of PFM - Web Console.

If PFM-WebCon and 20358 are assigned to the host name and port number of PFM - Web Console respectively, specify as follows:

[Figure]

Copy destination

Copy the edited definition file for the tool launcher to the folder on the host that has JP1/IM - View installed, as follows:

installation-folder-for-JP1/IM - View\conf\function\language-codes\

Example: Windows of PFM - Web Console are started respectively by differing hosts

You need to define blocks within the definition file for the tool launcher corresponding to respective PFM - Web Console to enable differing hosts to start windows of PFM - Web Console respectively. For details, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide, Job Management Partner 1/Integrated Management - Manager Configuration Guide, and the manual Job Management Partner 1/Integrated Management - Manager Command and Definition file Reference.

The following provides an example of setting the definition file for the tool launcher and an example of the Tool Launcher window display.

In the examples above, double-clicking Server Availability Management 1 in the Tool Launcher window connects the program to PFM - Web Console with the host name of PFM - WebCon1 and port number 20358, and then starts the corresponding window of PFM - Web Console. Similarly, double-clicking Server Availability Management 2 in the Tool Launcher window connects the program to PFM - Web Console with the host name of PFM - WebCon2 and port number 32222, and then starts the corresponding window of PFM - Web Console.

To Page Top

(4) Using icons to monitor the system operating status by linking with the JP1/IM monitored object function

If you want to use icons to monitor the operating status of the system in Performance Management by linking with the monitored object function of JP1/IM, you need to execute the jpcconf im command on the PFM - Manager host and then automatically generate the monitoring tree. This step is required for JP1/IM to collect definition information from Performance Management.

Execute the jpcconf im command on the PFM - Manager host.

Execute the jpcconf im command on the PFM - Manager host as shown below to start linkage with JP1/IM:
```
jpcconf im enable
```
Execute the command as shown below to stop linkage with JP1/IM:
```
jpcconf im disable
```
If PFM - Manager is in a logical host environment, execute the command one time on both the active and standby nodes.
In the JP1/IM integrated scope, automatically generate the monitoring tree.

For details on how to do so, see the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide, the Job Management Partner 1/Integrated Management - Manager Configuration Guide, and the manual Job Management Partner 1/Integrated Management - Manager Command and Definition File Reference.

To Page Top

(5) Setting quotation marks enclosing a JP1 user event message

For UNIX, a JP1 user event message can be enclosed in double quotation marks ("). To enclose such a message in double quotation marks, directly edit the jpccomm.ini file, which is located on the host running the Action Handler server that executes the action. To specify whether the messages of JP1 user events are enclosed in quotes:

Stop the Action Handler service to be configured.

For the logical host environment, stop the Action Handler services of the logical host.

Edit the jpccomm.ini file.

The jpccomm.ini file is stored in the following locations:

On physical hosts:: /opt/jp1pc/
On logical hosts:: environment-directory/jp1pc/

The following table describes the section name, label name, and range of setting values that you can edit in the jpccomm.ini file.

Table 12‒5: Setting item for specifying whether the messages of JP1 user events are enclosed in quotes
Section	Label name	Value range	Default value	Description
[Common Section]	JP1 Event Double Quote	0 \| 1	1	Specify whether the messages of JP1 user events are enclosed in quotes. `0`: Do not enclose in quotes `1`: Enclose in quotes

This label is available only for UNIX. In Windows, the setting of the label is ignored.

Start the Action Handler service that has been configured.

To Page Top