403 lines
12 KiB
HTML
403 lines
12 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Remove Pending Job Log (QWTRMVJL) API</title>
|
||
|
|
<!-- Begin Header Records ======================================= -->
|
||
|
|
<!-- (C) Copyright IBM Corporation, 2004 -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2><img src="delta.gif" alt="Start of change">
|
||
|
|
Remove Pending Job Log (QWTRMVJL) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="60%">Job selection information</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Job selection format name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes.<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Remove Pending Job Log (QWTRMVJL) API
|
||
|
|
changes a completed job whose job log has not yet been written.
|
||
|
|
The job messages are removed.
|
||
|
|
The job log can no longer be produced or displayed.</p>
|
||
|
|
|
||
|
|
<p>If the spooled file action for the job specifies that spooled files
|
||
|
|
are to be detached or if the only remaining spooled files for the job
|
||
|
|
are in independent auxiliary storage pools (ASPs),
|
||
|
|
the job is removed from the system.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Job Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>The caller of the API must be running under a user profile
|
||
|
|
that is the same as the user name specified in the
|
||
|
|
job selection information.
|
||
|
|
Otherwise, the caller of the API must be running under
|
||
|
|
a user profile that has job control (*JOBCTL) special authority.
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong><a name="HdrRpjlJsi"></a>Job selection information</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>Information that is used for selecting completed jobs
|
||
|
|
for which pending job logs will be removed.
|
||
|
|
See <a href="#HdrRpjlFjsi">Format of Job Selection Information</a> for a
|
||
|
|
description on the layout of this parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Job selection format name</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the job selection information. The possible
|
||
|
|
format names are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>RJLS0100</em></td>
|
||
|
|
<td align="left" valign="top">See
|
||
|
|
<a href="#HdrRpjlS100">RJLS0100 Format</a> for details on the job selection
|
||
|
|
information.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="HdrRpjlFjsi">Format of Job Selection Information</a></h3>
|
||
|
|
|
||
|
|
<p>The organization of the job selection information parameter is shown below.
|
||
|
|
A description of the fields in the parameter follows the table.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HdrRpjlS100">RJLS0100 Format</a></h3>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Length of job selection information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Days since job completion</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Job name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">User name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">Job number</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">34</td>
|
||
|
|
<td align="center" valign="top">22</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">Job log output</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="HdrRpjlJsfd">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Days since job completion.</strong> The minimum number of days
|
||
|
|
that the job log has been pending.
|
||
|
|
This may be zero.
|
||
|
|
This must be non-negative.
|
||
|
|
Refer to <a href="#HdrRpjlUse">Usage Notes</a> before coding a zero
|
||
|
|
for this field.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Job log output.</strong> One of the following special values:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All completed jobs that have a pending job log,
|
||
|
|
regardless of the value specified
|
||
|
|
for the Job log output (LOGOUTPUT) job attribute.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*PND</em></td>
|
||
|
|
<td align="left" valign="top">Only completed jobs that have a pending job log
|
||
|
|
and that specify *PND for the Job log output (LOGOUTPUT) job attribute.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Job name.</strong> A specific job name,
|
||
|
|
a generic name,
|
||
|
|
or one of the following special values:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All completed jobs
|
||
|
|
with the specified user name and job number, regardless of job name.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Job number.</strong> A specific job number
|
||
|
|
or one of the following special values:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All completed jobs
|
||
|
|
with the specified job name and user name, regardless of the job number.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Length of job selection information.</strong>
|
||
|
|
The length of the job selection information passed.
|
||
|
|
Valid values are:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>44</em></td>
|
||
|
|
<td align="left" valign="top">All job selection information is required.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>User name.</strong> A specific user profile name,
|
||
|
|
a generic name,
|
||
|
|
or one of the following special values:</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All completed jobs
|
||
|
|
with the specified job name and job number, regardless of the user name.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="HdrRpjlUse">Usage Notes</a></h3>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>This API can remove pending job logs for all completed jobs,
|
||
|
|
even those jobs that specify *JOBEND or *JOBLOGSVR
|
||
|
|
for the Job log output (LOGOUTPUT) job attribute.
|
||
|
|
Do not code a zero for the <strong>days since job completion</strong> field
|
||
|
|
unless you have verified that you really do not need a job log.
|
||
|
|
There is a delay between the time a job completes and the time
|
||
|
|
a job log server job can write the job log.
|
||
|
|
<br><br></li>
|
||
|
|
<li>This API may be automatically called by the system.
|
||
|
|
Refer to the Change Cleanup (CHGCLNUP) command for more information.
|
||
|
|
To avoid having the system automatically call this API,
|
||
|
|
specify *NO for the Allow cleanup (ALWCLNUP) parameter
|
||
|
|
or specify *KEEP for the Job logs and system output (SYSPRT) parameter
|
||
|
|
of the Change Cleanup (CHGCLNUP) command.
|
||
|
|
<p>Operational Assistant cleanup uses *ALL
|
||
|
|
for the <strong>Job log output</strong> field when calling this API.
|
||
|
|
The system keeps pending job logs and spooled job logs
|
||
|
|
for the same number of days.
|
||
|
|
To specify the value that Operational Assistant uses for the
|
||
|
|
days since job completion,
|
||
|
|
use the Job logs and system output (SYSPRT) parameter
|
||
|
|
of the Change Cleanup (CHGCLNUP) command.
|
||
|
|
This can also be changed by using "GO CLEANUP" from a command line
|
||
|
|
and selecting option 1 to change cleanup options.
|
||
|
|
</p>
|
||
|
|
</li>
|
||
|
|
<li>You can obtain a list of jobs and
|
||
|
|
use the Remove Pending Job Log (QWTRMVJL) API
|
||
|
|
to implement your own cleanup policy.
|
||
|
|
Refer to the <a href="qgyoljob.htm">Open List of Jobs (QGYOLJOB) API</a>,
|
||
|
|
the <a href="qusljob.htm">List Job (QUSLJOB) API</a>, and
|
||
|
|
the <a href="WMAttrDesc.htm"> Work Management API Attribute
|
||
|
|
Descriptions (WMAttrDesc)</a>.
|
||
|
|
Refer to the Add Job Schedule Entry (ADDJOBSCDE) command
|
||
|
|
for information on how to
|
||
|
|
schedule a batch job to be submitted at regular intervals.
|
||
|
|
<br><br></li>
|
||
|
|
</ol>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF1321 E</td>
|
||
|
|
<td width="85%" valign="top">Job &1 user &2 job number &3 not
|
||
|
|
found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF133C E</td>
|
||
|
|
<td align="left" valign="top">Job &3/&2/&1 not completed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF1344 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to control job
|
||
|
|
&3/&2/&1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
||
|
|
<td align="left" valign="top">Severe error while addressing parameter
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
||
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C3B E</td>
|
||
|
|
<td align="left" valign="top">Value for parameter &2 for API &1 not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
||
|
|
<td align="left" valign="top">Error(s) occurred during
|
||
|
|
running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF8100 E</td>
|
||
|
|
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
|
||
|
|
from 01 to FF.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9800 E</td>
|
||
|
|
<td align="left" valign="top">All CPF98xx messages could be signaled. xx is
|
||
|
|
from 01 to FF.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br><br>
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
<br>
|
||
|
|
<!-- ============================================================= -->
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R4
|
||
|
|
<hr>
|
||
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"wm1.htm">Work Management APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|