15.2.7 Placing restrictions on file reception
Setting restrictions on file reception allows you to restrict the size of files that can be received by a manager host or agent host when a job is exeucted. This subsection describes how to set restrictions on file reception.
- Using restrictions on file reception in version 11-00 or later
-
You can use restrictions on file transfer for agent hosts for JP1/AJS3 version 11-00 or later. If a job is executed on an agent host of version 11-00 or later, use restrictions on file transfer on the agent host in addition to restrictions on file reception on the manager host.
For details about restrictions on file transfer, see 15.2.24 Placing restrictions on file transmission.
When a job# has been executed in JP1/AJS3, result files (standard output and standard error output files) and transfer files are transferred between the manager and agent hosts, or between the client and manager hosts. If the size of these files is very large, data analysis of the files places a burden on the manager host. As a result, CPU and memory usage increases, and other problems that delay job execution and degrade overall system performance can occur.
- #:
-
The description in this subsection applies to only PC jobs, Unix jobs, custom jobs, QUEUE jobs executed by JP1/AJS3, and submit jobs. The description does not apply to event jobs, custom event jobs, passing information setting jobs, HTTP connection jobs, flexible jobs, and queueless jobs.
The restrictions on file reception described in this subsection allow you to set the maximum size for these types of files that are transferred after a job is executed. You can set maximums for the total size of result files (standard output and standard error output files) received by the manager host and for the total size of transfer files received by an agent host.
The restrictions on file reception also allow you to specify the status in which the job will be placed and the message that will be output if the size of the received files exceeds the maximum.
The following table describes the type of operation that is performed and how file data is handled when the size of received files exceeds the maximum.
File type |
Category |
Value of the ReceiveFileSizeStatus environment setting parameter |
|||
---|---|---|---|---|---|
0 |
1 |
2 |
3 |
||
Result file |
Status in which job is placed |
Actual termination status of the job |
Ended abnormally |
Ended with warning# |
Actual termination status of the job |
Type of message output |
Information |
Error |
Warning |
Information |
|
Handling of file data |
All file data is received. |
File data exceeding the maximum is discarded. |
File data exceeding the maximum is discarded. |
File data exceeding the maximum is discarded. |
|
Transfer file |
Status in which job is placed |
Actual termination status of the job |
Failed to start |
Failed to start |
Actual termination status of the job |
Type of message output |
Information |
Error |
Error |
Information |
|
Handling of file data |
All file data is received. |
No file data is received. |
No file data is received. |
No file data is received. |
- #:
-
If status of the job is Ended abnormally on the agent host, that status is inherited.
- Organization of this subsection
(1) Definition procedure
-
Execute the following command to set the environment setting parameters described in (2) below:
jajs_config -k "definition-key" "parameter-name-1"=value-1 ["parameter-name-2"=value-2]
-
Restart JP1/AJS3.
The new settings are applied.
(2) Environment setting parameters
Definition key |
Environment setting parameter |
Explanation |
---|---|---|
|
"ReceiveFileSizeStatus"= |
Specifies the restrictions applied if the size of received files reaches the maximum. |
"LimitReceiveFileSize"= |
Specifies the maximum for the size of received files. |
- #:
-
The specification of the {JP1_DEFAULT|logical-host} part depends on whether the host is a physical host or a logical host. For a physical host, specify JP1_DEFAULT. For a logical host, specify the logical host name.
For details about the definition of these environment setting parameters, see the following:
(3) Operation performed if the size of received files exceeds the maximum
The following describes the operation performed if the size of received files exceeds the maximum.
-
Result files
-
If the maximum is reached when the value of the ReceiveFileSizeStatus environment setting parameter is 1, 2, or 3, no more data is output to the standard output and standard error output files on the manager host. Because the result files are not complete, confirm that the incomplete result files will not cause any problems in cases such as when a succeeding job references these files.
-
For the return code and end status of a job when the size of received result files reaches the maximum, see the following table.
Table 15‒22: End status and return code when the size of received result files exceeds the maximum Actual job status
Category
Value of the ReceiveFileSizeStatus environment setting parameter
1
2
0 or 3
Ended normally
(Includes cases when Always normal is specified.)
Status
Ended abnormally
Ended with warning
Ended normally
Return code
Return value of the job#
Return value of the job#
Return value of the job#
Ended with warning
Status
Ended abnormally
Ended with warning
Ended with warning
Return code
Return value of the job#
Return value of the job#
Return value of the job#
Ended abnormally
Status
Ended abnormally
Ended abnormally
Ended abnormally
Return code
Return value of the job#
Return value of the job#
Return value of the job#
Killed
Status
Killed
Killed
Killed
Return code
PC job: -1
Unix job: -1
PC job: -1
Unix job: -1
PC job: -1
Unix job: -1
Failed to start
Status
Failed to start
Failed to start
Failed to start
- #:
-
Return code of the job process executed as a job
-
-
Transfer files
-
If the maximum is reached when the value of the ReceiveFileSizeStatus environment setting parameter is 1, 2, or 3, none of the transfer files are received, and all the data received as the specified transferred files is discarded.
-
For the return code and end status of a job when the size of received transfer files reaches the maximum, see the following table.
Table 15‒23: End status and return code when the size of received transfer files exceeds the maximum Actual job status
Category
Value of the ReceiveFileSizeStatus environment setting parameter
1
2
0 or 3
None#1
Status
Failed to start
Failed to start
Actual job termination status
Return code
PC job: -1
Unix job: -1
PC job: -1
Unix job: -1
Return value of the job#2
- #1:
-
Because transfer files are processed before a job is registered, the status of the job is None, which is the status of a job before its status becomes Now queuing.
- #2:
-
Return code of the job process executed as a job
-
(4) Note
If you place restrictions on file reception when the host that sends and receives files is in a Japanese environment that is not Shift-JIS, the actual file size might be different from the specified maximum file size.
When a result file is received or when a transfer file is sent, the size of the file is checked as Shift-JIS file data. After the check, the file is created on the host receiving the result file or the host receiving the transfer file by converting the data to the character code set used by the receiving host.
For both transfer files and result files, the character code set of the applicable file is converted to Shift-JIS before the file size is checked. Therefore, if the file sender host is in a Japanese environment that is not Shift-JIS and the character code set is changed to Shift-JIS, the file size might be reduced by the change. In this case, restrictions on file reception are disabled on the file sender host even if the file size is greater than the maximum.
If the host on which a file is created is in a Japanese environment that is not Shift-JIS, the Shift-JIS data is converted to the character codes of the host after the size is checked. Therefore, the file size after conversion might be greater than the size reported by the size check. In this case, even if you place restrictions on file reception to prevent files greater than the maximum from being received, a file greater than the maximum will be created. Note that such a large file could consume more disk area than you are expecting.
When executing a passing information setting job, set an appropriate value for the LimitReceiveFileSize environment setting parameter. If the preceding job outputs a standard output file whose file size is larger than the value of the LimitReceiveFileSize environment setting parameter, the passing information setting job might fail when retrieving information from the standard output file.