JP1/PFM plug-in configuration file (settings.conf)
- Organization of this page
Function
The JP1/PFM plug-in configuration file is a file for setting the behavior of the JP1/PFM plug-in. The model file for a JP1/PFM plug-in configuration is provided to you upon the installation of JP1/IM2.
To reset the JP1/PFM plug-in configuration file to the state it was in immediately after the installation of JP1/IM2, overwrite it with the model file.
For details on the file permission for the JP1/PFM plug-in configuration file, see the JP1/IM2 manual or document.
Files
settings.conf (JP1/PFM plug-in configuration file)
settings.conf.model (Model file for a JP1/PFM plug-in configuration)
Location
- In Windows:
-
-
For physical hosts:
installation-folder-of-JP1/IM2\conf\imdd\plugin\jp1pfm
-
For logical hosts:
environment-directory\jp1imm\conf\imdd\plugin\jp1pfm
-
- UNIX
-
-
For physical hosts:
/var/opt/jp1imm/conf/imdd/plugin/jp1pfm/
-
For logical hosts:
environment-directory/jp1imm/conf/imdd/plugin/jp1pfm/
-
Timing of applying definition information
The definition information is applied immediately after you save the JP1/PFM plug-in configuration file.
How to modify
You can edit the JP1/PFM plug-in configuration file as follows:
-
Open the settings.conf file.
-
Edit the settings.conf file.
-
Save the settings.conf file, and close it.
-
Confirm that the format of the edited file is correct.
You can check the format of the edited file by using one of the following methods:
-
Display trend information in the Integrated Operation Viewer of JP1/IM2 to check the items you have edited.
-
By using the REST API (time-series data acquisition API) provided by JP1/IM2, acquire trend information to check the items you have edited.
When the format of the edited file is correct, you can display or acquire trend information and check the items you have edited.
If the format of the edited file is incorrect, an error message is either displayed or returned. By following the instructions provided in the error message, correct the settings.conf file and then try displaying or acquiring trend information again.
For details on how to operate the Integrated Operation Viewer of JP1/IM2 and how to use REST APIs (time-series data acquisition API), see the JP1/IM2 manual or document.
-
- Note:
-
When the display or acquisition of trend information by the Integrated Operation Viewer of JP1/IM2 or a REST API coincides with the saving of the settings.conf file, the file might not be read correctly, which results in an error message being displayed. In this case, try displaying or acquiring trend information again.
Setting items
Create a JP1/PFM plug-in configuration file with the following format.
|
Item |
Format |
|---|---|
|
Format |
JSON |
|
Character code |
UTF-8 |
|
Line feed code |
One of the following:
|
The JSON-format JP1/PFM plug-in configuration file is shown below.
{
"Item-name":setting-value, ...
}The table below describes the items to be set in the JP1/PFM plug-in configuration file.
|
Item name |
Type |
Specifiable range of values |
Description |
|---|---|---|---|
|
timeSeriesDataLimit |
number |
An integer in the range from 1 to 60000 Default value: 60000 |
Set the maximum number of records that can be acquired from the Store database. If you specify a small value for this item, you will be acquiring data for a time period that is shorter than the specified period. Consequently, trend information might be displayed more quickly in the Integrated Operation Viewer window or the time-series data acquisition API might respond more quickly. |
|
intervalOrder |
string[] |
An array that has the following character strings (case insensitive) as elements:
Set one or more elements in the order shown above.
You cannot set the same element twice. Default value: ["MIN","HOUR","DAY"] |
Set an array of summary types to be used to acquire performance data of the PI record type from the Store database. Set the following character strings as summary types:
Performance data is acquired from the beginning of the array of summary types specified by this item. When the acquisition of performance data is successful, data of that summary type is displayed in the Integrated Operation Viewer window as trend information, and data of that summary type is returned by the time-series data acquisition API. When the acquisition of performance data fails, performance data is acquired from the summary type set in the next element. When the acquisition of performance data from all the specified summary types fails, no performance data is displayed in the Integrated Operation Viewer window as trend information, and no performance data is returned by the time-series data acquisition API. |
Definition example
The following coding example assumes that the maximum number of records that can be acquired from the Store database is 60000, and that performance data of the PI record type is acquired from the Store database in the following order of summary type priority: minute-by-minute record, hourly record, and daily record.
{
"timeSeriesDataLimit": 60000,
"intervalOrder": ["MIN", "HOUR", "DAY"]
}