jp1pfmSuggestionGetPerformanceEvents

Organization of this page

Description
Prerequisite version
How to specify the function in the suggestion definition file
What value is contained in the suggestion member in the response
Error case
Notes
Example of how to specify in the suggestion definition file

Description

This function gets a list of severe events in the Unprocessed response status from JP1 events that are mapped to an IM management node.

JP1 events to be obtained are as follows:

All JP1 user events of Performance Management
JP1 system events with event ID 00004840
Events that are JP1 system events with event ID 00004850, but not issued by the Store service

To Page Top

Prerequisite version

PFM - Manager and PFM - Web Console: 12-00 or later
JP1/IM2: 12-50 or later

To Page Top

How to specify the function in the suggestion definition file

Specify necessary values for the members of the following objects to be specified in suggestion activation criteria and response action:

key object with the plugin type in the suggestion activation criteria
params object with the plugin type in the response action

The following table lists and describes the values you specify.

Table 5‒12: Values specified for the members of the key and params objects
No.	Member name		Data type	Optional	Description
1	`sid`		string	No	Specify the tree ID of the IM management node of Performance Management. You can specify the tree ID of the IM management node that corresponds to one of the following: PFM - Manager (health check agent) Performance data of PFM - Agent instance Performance data of remote agent Group agent For details on how to specify the tree ID, see Suggestion definition file settings (imdd_suggestion_arbitrary-character-string.conf).
2	`method`		string	No	Specify `"jp1pfmSuggestionGetPerformanceEvents"`.
3	`args`		object	No	Specify an object with the members in No. 4 and later.
4		`startTime`	string	No	Specify the search range (start time) of the registration date and time of events in `YYYY-MM-DDThh:mm:ssZ` format^#.
5		`endTime`	string	No	Specify the search range (end time) of the registration date and time of events in `YYYY-MM-DDThh:mm:ssZ` format^#.

#

It indicates that the UTC time is specified in ISO 8601 extended format (decimal places of seconds cannot be specified). Individual values mean:

YYYY: Year
MM: Month
DD: Date
T: T is used to separate the date and time.
hh: Hour
mm: Minute
ss: Second
Z: Indicates a time zone equivalent to UTC.

When you call the jp1pfmSuggestionGetCurrentlyNormalEvents function and the jp1pfmSuggestionSetStatusOfEventsToProcessed function after running this function and change the response status of the JP1 event that has been recovered to normal to Processed, the JP1 events within the search range specified in startTime and endTime of this function are the target whose status is to be changed to Processed. Specify the values of startTime and endTime according to how frequently the suggestion to change the response statuses of the JP1 events to Processed is used.

To Page Top

What value is contained in the suggestion member in the response

If the processing is successful, an array of objects for events within the search range that are JP1 events mapped to the IM management node, listed in the table below, is stored in JSON format. If there is no applicable JP1 event at all, an empty string is stored.

Member name	Data type	Value to be stored
`eventSid`	string	The SID of the event is stored.
`B.ID`	string	The event ID is stored.
`B.TIME`	string	The registration date and time of the event is stored.
`E.SEVERITY`	string	The severity of the event is stored.
`E.PRODUCT_NAME`	string	The product name of the event is stored.
`E.OBJECT_NAME`	string	When the event ID is `00004840` or the event is a user event The alarm name is stored. When the event ID is `00004850` The service ID of the agent is stored.
`E.ROOT_OBJECT_NAME`	string	When the event ID is `00004840` or the event is a user event The alarm table name is stored. When the event ID is `00004850` The service ID of the agent is stored.

To Page Top

Error case

If an error occurs, the args.setError() function is called to store its message.

The following table describes causes of errors and message IDs of messages to be stored.

Cause of error	Message ID
The `args` object in the suggestion definition file does not specify necessary members required.	`KAJY24113-E`
A Performance Management tree SID of a type that cannot be accepted in this function was specified for `sid` in the suggestion definition file.
An incorrect value was specified for `startTime` or `endTime` in the suggestion definition file.
A date and time earlier than `startTime` was specified for `endTime` in the suggestion definition file.
An error occurred in the API of JP1/IM2.	`KAJY24116-E`

To Page Top

Notes

It might take long for the processing if you specify a long search range for the registration dates and times of events.
This function uses the jp1EmService.getEvent method of JP1/IM2. The method sometimes cannot get a JP1 event depending on the settings of JP1/IM2. For details see the topic describing the jp1EmService.getEvent method in the manuals on JP1/IM2.

To Page Top

Example of how to specify in the suggestion definition file

For an example of the suggestion definition file that contains this function, see Example of changing the response status of an event to Processed when the status of the alarm or agent is recovered to normal in Examples of suggestion definition file (imdd_suggestion_arbitrary-character-string.conf).

To Page Top