2.6.1 Get JP1/PFM report
Function
This service template acquires a JP1/PFM - RM report collected by JP1/PFM - Manage.
This service template assumes the following server:
• PFM management server
This is the server on which JP1/PFM - Web Console is installed.
The service template performs the following task:
(1) The service template outputs the JP1/PFM - RM report for a specified service ID from the PFM management server to a specified file in CSV format. The output format of the file is the same as the format of the results output by JP1/PFM's jpcrpt command.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
JP1/Automatic Operation 12-00 or later
[Required products in the system executing the service template]
(1)Job Management Partner 1/PFM - Web Console 10-00 or later, or
JP1/PFM - Web Console 11-00 or later
(2)Job Management Partner 1/PFM - Manager 10-00 or later, or
JP1/PFM - Manager 11-00 or later
(3)Job Management Partner 1/PFM - Remote Monitor for Platform 10-00 or later, or
JP1/PFM - Remote Monitor for Platform 11-00 or later
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
[Usage conditions of prerequisite products in the system executing the service template]
(1) Job Management Partner 1/PFM - Manager and the target Job Management Partner 1/PFM - RM must be running.
(2) Job Management Partner 1/PFM's jpcrpt command must be specified correctly, in accordance with its usage conditions.
(3) Authentication for Job Management Partner 1/PFM - Manager is required when this service is run.
If an authentication key file has not been created, you must use the jpcmkkey command before you execute the command to create an authentication key file.
Cautions
(1) Outputting a large amount of report data might affect the system.
Limit the amount of output by adjusting settings, such as the input file reporting interval and the display period (start and end dates and times).
(2) Reports cannot be output in HTML format. Do not specify <html-output> in the input file definition.
(3) If you run this service in a Linux environment, do not use multi-byte characters in the properties. Also, do not use multi-byte characters in report folder names or report names for the Job Management Partner 1/PFM that is subject to report output.
(4) If the file name specified in the remote or the local system already exists, that file will be overwritten. Also, if reports are forwarded, the file in the remote system will be deleted. Therefore, make sure that you specify the correct file names.
(5) If there is no folder on the specified path in the remote system, such a folder will be created. A folder that is created will remain and will not be deleted; for this reason, you should delete unneeded folders periodically.
Version
03.00.00
Tags
Gather JP1 information,PFM
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Monitored system environment information |
Specify the environment information for the PFM management server. |
Y |
|
Report acquisition information |
Specify the report information to be retrieved. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1pfm.jp1pfmWebconHostName |
JP1/PFM - Web Console host name |
Specify the host name or IP addr. of the server where JP1/PFM - Web Console are installed. IPv6 is not supported. Specify the physical host name of primary server. In a cluster configuration, specify the logical host name. |
Input |
Disabled |
R |
Monitored system environment information |
|
jp1pfm.inputFileNameLocal |
Input file name(local) |
Specifies the full path name of the source input file for transferring to the PFM management server. |
Input |
Disabled |
R |
Report acquisition information |
|
jp1pfm.inputFileNameRemote |
Input file name(remote) |
Specifies the full path name of the file on the PFM management server for acquiring the report. |
Input |
Disabled |
R |
Report acquisition information |
|
jp1pfm.reportOutputFileNameRemote |
Report output file name(remote) |
Specifies the full path name of the file on the PFM management server to which the report is to be output. |
Input |
Disabled |
R |
Report acquisition information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1pfm.serviceId |
Service ID |
Specifies the agent that is the report output target using the service ID. |
Input |
Disabled |
R |
Report acquisition information |
|
common.transferLogFile |
Whether to transfer the report file |
Specifies whether to transfer the report. In case of transfer, deletes the file of the output file name (remote). |
Input |
Disabled |
R |
Report acquisition information |
|
jp1pfm.reportOutputFileNameLocal |
Report output file name(local) |
Specifies the full path name of the file on the JP1/AO server for acquiring the report. Must be specified if the report is to be transferred to the JP1/AO server. |
Input |
Disabled |
O |
Report acquisition information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1pfm.jp1pfmWebconHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1pfm.inputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
|
jp1pfm.inputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, `, or a trailing \. |
|
jp1pfm.reportOutputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, `, or a trailing \ or /. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1pfm.serviceId |
A maximum of 258 characters can be entered. Characters that can be used include alphanumeric characters, as well as @ , [ , ] , . , and - . |
|
common.transferLogFile |
Select one of the following values: yes,no |
|
jp1pfm.reportOutputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
InputFileTransfer |
Flow Plug-in |
Transfers an input file. |
-- |
|
1-3 |
Compatible Plug-in |
Checks whether an input file has been specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-4 |
File-forwarding plug-in |
Transfers an input file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2 |
outputReportJP1PFM |
Flow Plug-in |
Acquires a report. |
-- |
|
2-1 |
Get report |
Acquires a report. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
3 |
outputFileTransfer |
Flow Plug-in |
Transfers a report. |
-- |
|
3-1 |
Compatible Plug-in |
Checks whether a file transfer occurred. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
3-2 |
File-forwarding plug-in |
If transfer is required, transfers a report. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4 |
osDeleteFile |
Flow Plug-in |
Deletes the report in cases where transfer is required. |
-- |
|
4-1 |
Delete file |
Deletes an input file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-2 |
Compatible Plug-in |
Checks whether a file transfer occurred. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-3 |
Delete file |
Deletes an output file. |
Eliminate the cause of the error, and then re-execute the service. |
|