jp1pfmSuggestionCreateReportURL
- Organization of this page
Description
This function generates the URL to show a report with a specified report ID.
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. You can specify the tree ID of the IM management node that corresponds to one of the following:
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 "jp1pfmSuggestionCreateReportURL". |
|
3 |
args |
object |
No |
Specify an object with the member in No. 4. |
|
4 |
reportId |
string |
No |
Specify the report ID# of the report to display.
|
What value is contained in the suggestion member in the response
If the processing is successful, the string of the URL to show the report with the specified report ID 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 configuration information of JP1/IM2 was changed during the processing. |
KAJY24105-E |
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. |
Note
The function does not check if the report with the specified report ID is defined by PFM - Manager.
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 displaying a report for identifying the causal process when CPU usage surges in Examples of suggestion definition file (imdd_suggestion_arbitrary-character-string.conf).