jp1pfmSuggestionSetStatusOfEventsToProcessed
- Organization of this page
Description
This function changes the response status of a JP1 event to Processed.
Prerequisite version
-
PFM - Manager and PFM - Web Console: 12-00 or later
-
JP1/IM2: 12-50 or later
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.
|
No. |
Member name |
Data type |
Optional |
Description |
|
|---|---|---|---|---|---|
|
1 |
sid |
string |
No |
Specify the tree ID of the IM management node of Performance Management. 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 "jp1pfmSuggestionSetStatusOfEventsToProcessed". |
|
|
3 |
args |
object |
No |
Specify an object with the member in No. 4. |
|
|
4 |
eventSids |
string |
No |
Specify the value in JSON format, derived from event SIDs in the array. If you change the response statuses of JP1 events that have been recovered to normal to Processed, specify the value stored in suggestion of the response of the jp1pfmSuggestionGetPerformanceEvents function. |
|
What value is contained in the suggestion member in the response
If the processing is successful, an empty string is stored.
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 |
|
An incorrect value is specified for eventSids in the suggestion definition file. |
|
|
An error occurred in the API of JP1/IM2. |
KAJY24116-E |
Notes
-
This function uses the jp1EmService.changeEventStatus method of JP1/IM2. The response status cannot be updated depending on the settings of JP1/IM2. For details see the topic describing the jp1EmService.changeEventStatus method in the manuals on JP1/IM2.
-
If an error occurs in the API of JP1/IM2, the response statuses of some JP1 events might be changed to Processed. If that happens, take action according to the message, remove the cause of the error, and then execute this function again.
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).