friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwclscde.htm

1310 lines
37 KiB
HTML
Raw Permalink Blame History

<!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>List Job Schedule Entries (QWCLSCDE) API</title>
<!-- Begin Header Records ========================================= -->
<!-- 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. -->
<!-- WM SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- File cleanup completed on 12 July 2001 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>List Job Schedule Entries (QWCLSCDE) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;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="50%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">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">Job schedule entry name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Continuation handle</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(16)</td>
</tr>
<tr>
<td align="center" valign="top">5</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Job Schedule Entries (QWCLSCDE) API lists the entries in the job
schedule, QDFTJOBSCD. A subset of the list can be created by using the job
schedule entry name parameter. The generated list replaces any existing list in
the user space.</p>
<p>The QWCLSCDE API produces a list similar to the list produced by the Work
with Job Schedule Entries (WRKJOBSCDE) command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
<dt><em>Job Schedule Entry Authority</em></dt>
<dd>*JOBCTL or the adder of the entry if using
format SCDL0200</dd>
<dt><em>Job Schedule Authority</em></dt>
<dd>*USE</dd>
<dt><em>Job Schedule Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Job Schedule Lock</em></dt>
<dd>*SHRRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the created list. The first 10 characters
contain the user space name, and the second 10 characters contain the name of
the library where the user space is located. You can use these special values
for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information returned for each member. The
possible format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>SCDL0100</em></td>
<td align="left" valign="top">Basic job schedule entries list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SCDL0200</em></td>
<td align="left" valign="top">Detailed job schedule entries list. This format
requires more processing than the SCDL0100 format.</td>
</tr>
</table>
<p>For more information, see <a href="#HDRSCDL1">SCDL0100 Format</a> or <a
href="#HDRSCDL2">SCDL0200 Format</a>.</p>
</dd>
<dt><strong>Job schedule entry name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The job schedule entry about which to retrieve information. This can be used
to create a subset of job schedule entries by using the following values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All of the job schedule entries are returned in
the list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>generic*</em></td>
<td align="left" valign="top">All of the job schedule entries beginning with
the generic value are returned in the list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>name</em></td>
<td align="left" valign="top">The job schedule entries with the given name are
returned in the list.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Continuation handle</strong></dt>
<dd>INPUT; CHAR(16)
<p>The value returned to the user in the header section when a partial list is
returned. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">This will start at the beginning of the
list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>value</em></td>
<td align="left" valign="top">The entries after this value matching the job
schedule entry name specified will be returned in the list. For more
information on using this value to process a partial list, see <a href=
"../apiref/usf.htm#HDRPARTLST">Partial list considerations</a>.</td>
</tr>
</table>
<br>
</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="HDRSCDLIST">Format of the Generated Lists</a></h3>
<p>The file member list consists of:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>SCDL0100 format</li>
<li>SCDL0200 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
User space format for list APIs</a>. For details about the remaining items, see
the following sections. For detailed descriptions of the fields in the list
returned, see <a href="#HDRLSCDDE">Field Descriptions</a>.</p>
<p>When you retrieve list entry information from a user space, you must use the
entry size returned in the generic header. The size of each entry may be padded
at the end. If you do not use the entry size, the result may not be valid. For
examples of how to process lists, see API <a href="../apiref/apiexmp.htm">Examples</a>.</p>
<br>
<h3><a name="HDRSCDLIP1">Input Parameter Section</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job schedule entry name</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Continuation handle</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSCDLIP2">Header Section</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Job schedule entry name used</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Continuation handle</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSCDL1">SCDL0100 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%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Information status</td>
</tr>
<tr>
<td align="center" valign="top">1</td>
<td align="center" valign="top">1</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Entry number</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Scheduled date</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(70)</td>
<td align="left" valign="top">Scheduled days</td>
</tr>
<tr>
<td align="center" valign="top">101</td>
<td align="center" valign="top">65</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Scheduled time</td>
</tr>
<tr>
<td align="center" valign="top">107</td>
<td align="center" valign="top">6B</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Frequency</td>
</tr>
<tr>
<td align="center" valign="top">117</td>
<td align="center" valign="top">75</td>
<td align="left" valign="top">ARRAY(5) of CHAR(10)</td>
<td align="left" valign="top">Relative day of the month</td>
</tr>
<tr>
<td align="center" valign="top">167</td>
<td align="center" valign="top">A7</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Recovery action</td>
</tr>
<tr>
<td align="center" valign="top">177</td>
<td align="center" valign="top">B1</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Next submission date</td>
</tr>
<tr>
<td align="center" valign="top">187</td>
<td align="center" valign="top">BB</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Status</td>
</tr>
<tr>
<td align="center" valign="top">197</td>
<td align="center" valign="top">C5</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job queue name</td>
</tr>
<tr>
<td align="center" valign="top">207</td>
<td align="center" valign="top">CF</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job queue library name</td>
</tr>
<tr>
<td align="center" valign="top">217</td>
<td align="center" valign="top">D9</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile of entry adder</td>
</tr>
<tr>
<td align="center" valign="top">227</td>
<td align="center" valign="top">E3</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Last submission date</td>
</tr>
<tr>
<td align="center" valign="top">237</td>
<td align="center" valign="top">ED</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last submission time</td>
</tr>
<tr>
<td align="center" valign="top">243</td>
<td align="center" valign="top">F3</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text</td>
</tr>
<tr>
<td align="center" valign="top">293</td>
<td align="center" valign="top">125</td>
<td align="left" valign="top">CHAR(23)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSCDL2">SCDL0200 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%"><br>
</td>
<td align="left" valign="top" width="60%">Returns everything from format
SCDL0100</td>
</tr>
<tr>
<td align="center" valign="top">316</td>
<td align="center" valign="top">13C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job queue status</td>
</tr>
<tr>
<td align="center" valign="top">326</td>
<td align="center" valign="top">146</td>
<td align="left" valign="top">ARRAY(20) of CHAR(10)</td>
<td align="left" valign="top">Dates omitted</td>
</tr>
<tr>
<td align="center" valign="top">526</td>
<td align="center" valign="top">20E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job description name</td>
</tr>
<tr>
<td align="center" valign="top">536</td>
<td align="center" valign="top">218</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job description library name</td>
</tr>
<tr>
<td align="center" valign="top">546</td>
<td align="center" valign="top">222</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile for submitted job</td>
</tr>
<tr>
<td align="center" valign="top">556</td>
<td align="center" valign="top">22C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue name</td>
</tr>
<tr>
<td align="center" valign="top">566</td>
<td align="center" valign="top">236</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue library name</td>
</tr>
<tr>
<td align="center" valign="top">576</td>
<td align="center" valign="top">240</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Save entry</td>
</tr>
<tr>
<td align="center" valign="top">586</td>
<td align="center" valign="top">24A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Last submission job name</td>
</tr>
<tr>
<td align="center" valign="top">596</td>
<td align="center" valign="top">254</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Last submission user name</td>
</tr>
<tr>
<td align="center" valign="top">606</td>
<td align="center" valign="top">25E</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last submission job number</td>
</tr>
<tr>
<td align="center" valign="top">612</td>
<td align="center" valign="top">26E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Last attempted submission date</td>
</tr>
<tr>
<td align="center" valign="top">622</td>
<td align="center" valign="top">26E</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last attempted submission time</td>
</tr>
<tr>
<td align="center" valign="top">628</td>
<td align="center" valign="top">274</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Status of last attempted submission</td>
</tr>
<tr>
<td align="center" valign="top">638</td>
<td align="center" valign="top">27E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">640</td>
<td align="center" valign="top">280</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of command string</td>
</tr>
<tr>
<td align="center" valign="top">644</td>
<td align="center" valign="top">284</td>
<td align="left" valign="top">CHAR(512)</td>
<td align="left" valign="top">Command</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLSCDDE">Field Descriptions</a></h3>
<p><strong>Command.</strong> A command that runs in the submitted batch job if
the routing program used when this batch job is started is the IBM-supplied
default routing program QCMD. Because this command is used for the request
data, this parameter takes the place of any value specified for the RQSDTA
parameter in the job description.</p>
<p><strong>Continuation handle.</strong> The value used to process a partial
list. This value is put in the header section when a partial list is returned.
For more information on processing a partial list, see <a href=
"../apiref/usf.htm#HDRPARTLST">Partial list considerations</a>.</p>
<p><strong>Dates omitted.</strong> Specifies up to 20 dates when the job should
not be submitted. The dates will be in the format CYYMMDD, where C is the
century, YY is the year, MM is the month, and DD is the day. A 0 for the
century flag indicates years 19<em>xx</em> and a 1 indicates years
20<em>xx</em>. If no omit dates are specified, this field contains hexadecimal
zeros.</p>
<p><strong>Entry number.</strong> The entry number assigned to the job schedule
entry. The entry number can range from 000001 through 999999.</p>
<p><strong>Format name.</strong> The content and format of the information
returned for each job schedule entry.</p>
<p><strong>Frequency.</strong> How often the job schedule entry is to be
submitted to run. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ONCE</em></td>
<td align="left" valign="top">The job schedule entry does not repeat.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WEEKLY</em></td>
<td align="left" valign="top">The job schedule entry is submitted on the same
day of each week at the scheduled time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MONTHLY</em></td>
<td align="left" valign="top">The job schedule entry is submitted on the same
day of each month at the scheduled time.</td>
</tr>
</table>
<p><strong>Information status.</strong> Whether or not the entry information
could be successfully retrieved.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No errors occurred. All information is returned
for this entry.</td>
</tr>
<tr>
<td align="left" valign="top"><em>A</em></td>
<td align="left" valign="top">Insufficient authority to entry. Only the
SCDL0100 information is returned for this entry. The rest of the entry is
blank.</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em></td>
<td align="left" valign="top">The entry is locked. Only the SCDL0100
information is returned for this entry. The rest of the entry is blank.</td>
</tr>
</table>
<p><strong>Job description name.</strong> The name of the job description used
for the job schedule entry.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">The job description in the user profile under
which the job runs is used as the job description of the job schedule
entry.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>job description name</em></td>
<td align="left" valign="top">The name of the job description used for the
job schedule entry.</td>
</tr>
</table>
<p><strong>Job description library name.</strong> The name of the library in
which the job description is located.</p>
<p><strong>Job name.</strong> The job name associated with the job schedule
entry.</p>
<p><strong>Job queue library name.</strong> The name of the library in which
the specified job queue resides.</p>
<p><strong>Job queue name.</strong> The name of the job queue where the job
should be placed when it is submitted. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*JOBD</em></td>
<td align="left" valign="top">The job is placed in the job queue named in the
specified job description.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>job queue name</em></td>
<td align="left" valign="top">The name of the job queue where the job is placed
when it is submitted.</td>
</tr>
</table>
<p><strong>Job queue status.</strong> The current status of the job queue.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The job queue name specified *JOBD, the job queue
could not be found, or the job queue is damaged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>HLD</em></td>
<td align="left" valign="top">The job queue is held. The job queue is not
allocated to a subsystem.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RLS</em></td>
<td align="left" valign="top">The job queue is released. The job queue is not
allocated to a subsystem.</td>
</tr>
<tr>
<td align="left" valign="top"><em>HLD/SBS</em></td>
<td align="left" valign="top">The job queue is held. The job queue is allocated
to a subsystem.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RLS/SBS</em></td>
<td align="left" valign="top">The job queue is released. The job queue is
allocated to a subsystem.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LOCKED</em></td>
<td align="left" valign="top">The job queue is locked, and the status could not
be obtained.</td>
</tr>
</table>
<p><strong>Job schedule entry name used.</strong> The job name used to identify
the job schedule entry.</p>
<p><strong>Last attempted submission date.</strong> The date on which a job
could have been last submitted. The value is returned in the format CYYMMDD,
where C is the century, YY is the year, MM is the month, and DD is the day. A 0
for the century flag indicates years 19<em>xx</em> and a 1 indicates years
20<em>xx</em>. If no submission has been attempted, this field contains
hexadecimal zeros.</p>
<p><strong>Last attempted submission time.</strong> The time at which a job
could have been last submitted from this entry. The value is returned in the
format HHMMSS, where HH is hours, MM is minutes, and SS is seconds. If no
submission has been attempted, this field contains hexadecimal zeros.</p>
<p><strong>Last submission date.</strong> The date on which a job was last
submitted from this entry. The value is returned in the format CYYMMDD, where C
is the century, YY is the year, MM is the month, and DD is the day. A 0 for the
century flag indicates years 19<em>xx</em> and a 1 indicates years
20<em>xx</em>. If there has been no previous submission, this field contains
hexadecimal zeros.</p>
<p><strong>Last submission job name.</strong> The job name of the last job that
was submitted from this entry. If there has been no previous submission, this
field contains blanks.</p>
<p><strong>Last submission job number.</strong> The job number of the last job
that was submitted from this entry. If there has been no previous submission,
this field contains blanks.</p>
<p><strong>Last submission time.</strong> The time at which a job was last
submitted from this entry. The value is returned in the format HHMMSS, where HH
is hours, MM is minutes, and SS is seconds. If there has been no previous
submission, this field contains hexadecimal zeros.</p>
<p><strong>Last submission user name.</strong> The user name of the last job
that was submitted from this entry. If there has been no previous submission,
this field contains blanks.</p>
<p><strong>Length of command string.</strong> The length of the command string
specified in the command field.</p>
<p><strong>Message queue name.</strong> The name of the message queue, if any,
to which a completion message is sent when the job is submitted. A completion
message is sent when the submitted job has completed running, and error
messages are sent if the Submit Job (SBMJOB) command fails for some reason.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">A completion message is sent to the message queue
specified in the user profile associated with the job schedule entry.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">Messages are not sent to a user-specified message
queue. In this case, completion messages are not sent, but error messages are
sent to the QSYSOPR message queue.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>message queue name</em></td>
<td align="left" valign="top">The name of the message queue where the messages
are sent.</td>
</tr>
</table>
<p><strong>Message queue library name.</strong> The library in which the
message queue is located.</p>
<p><strong>Next submission date.</strong> The next date that a job from this
entry is scheduled to be submitted. The next submission date is returned in the
format CYYMMDD, where C is the century, YY is the year, MM is the month, and DD
is the day. A 0 for the century flag indicates years 19<em>xx</em> and a 1
indicates years 20<em>xx</em>. If this entry has a status of SAV, this field
contains hexadecimal zeros.</p>
<p><strong>Recovery action.</strong> The action that will happen if the job
cannot be submitted at the designated time because the system is powered down
or the system is in the restricted state. The action specified by this
parameter then occurs when the system is IPLed or when the system comes out of
the restricted state. This parameter does not pertain to the situation where a
job was held (by the user) when the designated time elapsed and then released
(by the user) at a later time. Also, the recovery action does not pertain to
timer events that elapse as a result of changes to the QTIME system value.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*SBMRLS</em></td>
<td align="left" valign="top">Submit the job in the released state (RLS).</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SBMHLD</em></td>
<td align="left" valign="top">Submit the job in the held state (HLD).</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOSBM</em></td>
<td align="left" valign="top">No job is submitted.</td>
</tr>
</table>
<p><strong>Relative day of the month.</strong> The relative day of the month
the job should be submitted to run. A total of five values can be returned. If
no relative day of the month was specified, this area contains blanks. Valid
values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1-5</em></td>
<td align="left" valign="top">The job should be submitted on the specified day
of the week every first, second, third, fourth, or fifth week of the
month.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LAST</em></td>
<td align="left" valign="top">The job should be submitted on the last specified
day of the week each month.</td>
</tr>
</table>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Save entry.</strong> Whether or not an entry that has FRQ(*ONCE)
specified should be kept in the job schedule after the job has been
submitted.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">This entry will not be kept after the job is
submitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">This entry will be kept after the job is
submitted.</td>
</tr>
</table>
<p><strong>Scheduled date.</strong> The date that the job will be submitted.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">The current date will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MONTHSTR</em></td>
<td align="left" valign="top">The first day of the month will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MONTHEND</em></td>
<td align="left" valign="top">The last day of the month will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">A scheduled date was not specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>date</em></td>
<td align="left" valign="top">An actual date in the format CYYMMDD, where C is
the century, YY is the year, MM is the month, and DD is the day. A 0 for the
century flag indicates years 19<em>xx</em> and a 1 indicates years
20<em>xx</em>.</td>
</tr>
</table>
<p><strong>Scheduled days.</strong> The day of the week that the job will be
submitted. A total of seven values can be returned. Valid values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The job will be submitted every day. This cannot
be specified with any other values.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">A scheduled day is not specified. This cannot be
specified with any other values.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MON</em></td>
<td align="left" valign="top">The job will be submitted on Monday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TUE</em></td>
<td align="left" valign="top">The job will be submitted on Tuesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WED</em></td>
<td align="left" valign="top">The job will be submitted on Wednesday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*THU</em></td>
<td align="left" valign="top">The job will be submitted on Thursday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FRI</em></td>
<td align="left" valign="top">The job will be submitted on Friday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAT</em></td>
<td align="left" valign="top">The job will be submitted on Saturday.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SUN</em></td>
<td align="left" valign="top">The job will be submitted on Sunday.</td>
</tr>
</table>
<p><strong>Scheduled time.</strong> The time (on the scheduled date) when the
job will be submitted to run. This value is returned in the format HHMMSS,
where HH is the hours, MM is the minutes, and SS is the seconds.</p>
<p><strong>Status.</strong> The status of the job schedule entry. Valid values
are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>SCD</em></td>
<td align="left" valign="top">The entry is scheduled.</td>
</tr>
<tr>
<td align="left" valign="top"><em>HLD</em></td>
<td align="left" valign="top">The entry is held.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SAV</em></td>
<td align="left" valign="top">The entry is saved.</td>
</tr>
</table>
<p><strong>Status of last attempted submission.</strong> The action that
occurred the last time the system could have submitted a job from this entry.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Job not previously submitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Job successfully submitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Last job submission failed. Check the message
queue for details.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Job not submitted due to held status.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Job submitted after scheduled time as specified
by recovery action.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Job not submitted as specified by recovery
action.</td>
</tr>
</table>
<p><strong>Text.</strong> Text that briefly describes the job schedule entry.
If no text was specified, this field contains blanks.</p>
<p><strong>User profile for submitted job.</strong> The user profile under
which the job will be submitted. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*JOBD</em></td>
<td align="left" valign="top">The user profile named in the specified job
description is used for the job.</td>
</tr>
<tr>
<td align="left" valign="top"><em>user name</em></td>
<td align="left" valign="top">The name of the user profile that is used for the
job.</td>
</tr>
</table>
<p><strong>User profile of entry adder.</strong> The user profile that created
this entry.</p>
<p><strong>User space library name.</strong> The library name or special value
specified in the call to this API.</p>
<p><strong>User space name.</strong> The name of the user space that receives
the list.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1629 E</td>
<td align="left" valign="top">Not authorized to job schedule &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1632 E</td>
<td align="left" valign="top">Job schedule entry &amp;3 number &amp;4
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1637 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2 in
use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1640 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2 does not
exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1641 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1643 E</td>
<td align="left" valign="top">Job schedule entry name 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 &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF811A E</td>
<td align="left" valign="top">User space &amp;4 in &amp;9 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF812C E</td>
<td align="left" valign="top">Job schedule &amp;4 in &amp;9 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8122 E</td>
<td align="left" valign="top">&amp;8 damage on library &amp;4.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td align="left" valign="top">One or more libraries in library list
deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9838 E</td>
<td align="left" valign="top">User profile storage limit exceeded.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top">Top</a> | <a href="wm1.htm">
Work Management APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink