ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwdcsbse.htm

955 lines
30 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>Change Subsystem Entry (QWDCSBSE) 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 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Nov 2001 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>Change Subsystem Entry (QWDCSBSE) 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 subsystem 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">Change 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">Subsystem entry identifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Change information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</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 Change Subsystem Entry (QWDCSBSE) API changes a subsystem entry in the
specified subsystem description.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Job Description Authority</em></dt>
<dd>*USE</dd>
<dt><em>Job Description Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Subsystem Description Authority</em></dt>
<dd>*OBJMGT, *USE</dd>
<dt><em>Subsystem Description Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Profile Authority</em></dt>
<dd>*USE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified subsystem name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The subsystem description that contains the subsystem entry being changed.
The first 10 characters contain the subsystem description name, and the second
10 characters contain the library name. 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 job's library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Change format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the subsystem entry to change. You can use the following
format:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>SBSE0500</em></td>
<td align="left" valign="top">Prestart job entry. For details, see <a href=
"#HDRPRESTEN">SBSE0500 Format (Prestart Job Entry)</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Subsystem entry identifier</strong></dt>
<dd>INPUT; CHAR(*)
<p>The subsystem entry that is to be changed. The identifier is specific to the
entry type. For prestart job entries, see <a href="#HDRPRESTEN">SBSE0500 Format
(Prestart Job Entry)</a> for details.</p>
</dd>
<dt><strong>Change information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information for the subsystem entry that you want to change. The
information must be in the following format:</p>
<dl>
<dt><em>Number of variable length records</em></dt>
<dd>BINARY(4)<br>
The total number of all of the variable length records.<br>
<br>
</dd>
<dt><em>Variable length records</em></dt>
<dd>The attributes of the subsystem entry that are to be changed. Refer to <a
href="#HDRFMTVAR2">Format for Variable Length Record</a> for more
information.</dd>
</dl>
<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="HDRFMTVAR2">Format for Variable Length Record</a></h3>
<p>The following table shows the layout of the variable length record. For a
detailed description of each field, see <a href="#HDRDESCRGK">Field
Descriptions</a>.</p>
<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 variable length record</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Attribute key</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of data</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<p>If the length of the data is longer than the key field's data length, the
data is truncated at the right. No message is issued.</p>
<p>If the length of the data is shorter than the key field's data length and
the key contains binary data, an error message is issued. If the key does not
contain binary data, the field is padded with blanks.</p>
<p>It is not an error to specify a key more than once. If duplicate keys are
specified, the last specified value for that key is used.</p>
<p>Each variable length record must be 4-byte aligned. If not, unpredictable
results may occur.</p>
<br>
<h3><a name="HDRDESCRGK">Field Descriptions</a></h3>
<p><strong>Attribute key.</strong> The attribute to be set. For prestart job
entries, see <a href="#HDRPRESTEN">SBSE0500 Format (Prestart Job Entry)</a> for
details.</p>
<p><strong>Data.</strong> The value to which a specific attribute is to be
set.</p>
<p><strong>Length of data.</strong> The length of the attribute value.</p>
<p><strong>Length of variable length record.</strong> The length of the record
including this field.</p>
<br>
<h3><a name="HDRPRESTEN">SBSE0500 Format (Prestart Job Entry)</a></h3>
<p>This format changes a prestart job entry in the specified subsystem
description. The associated subsystem may be active when the prestart job entry
is changed. Changes made to the entry when the subsystem is active are
reflected over time. Prestart jobs that are created after the API is issued use
the new job-related values.</p>
<br>
<h3><a name="HDRPRESTID">Subsystem Entry Identifier for SBSE0500
Format</a></h3>
<dl>
<dt><strong>Qualified program name</strong></dt>
<dd>CHAR(20)
<p>The qualified name of the program that identifies the prestart job entry
being changed. The first 10 characters contain the program name, and the second
10 characters contain the library name. 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 job's library list</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3><a name="HDRPRESTKY">Attribute Keys for SBSE0500 Format</a></h3>
<p>The following table shows the valid attribute keys for the attribute key
field of the variable length record. For a detailed description of each field,
see <a href="#HDRPRESTDE">Field Descriptions of Attribute Keys for SBSE0500
Format</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom">Key</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Field</th>
</tr>
<tr>
<td align="center" valign="top" width="15%">1</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="65%">User profile name</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Start jobs</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Initial number of jobs</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Threshold</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Additional number of jobs</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum number of jobs</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Job description name</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum number of uses</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Wait for job</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Pool identifier</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Class 1 name</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Class 1 number of jobs</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Class 2 name</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Class 2 number of jobs</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Thread resources affinity</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resources affinity group</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPRESTDE">Field Descriptions of Attribute Keys for SBSE0500
Format</a></h3>
<p><strong>Additional number of jobs.</strong> The additional number of
prestart jobs that are started when the number of prestart jobs drops below the
threshold value. The value of this parameter must be less than the value of the
maximum number of jobs. Valid values range from 0-999.</p>
<p><strong>Class 1 name.</strong> The name of a class under which the prestart
jobs run. Two classes can be specified for a prestart job entry, class 1 name
and class 2 name. Each class defines the number of jobs that run under that
class. See class 1 number of jobs and class 2 number of jobs.</p>
<p>Jobs start under the first class specified until the number of jobs
specified for the first class is reached. After the allowed number of jobs
specified for the first class is reached, jobs are started under the second
class.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SBSD</em></td>
<td align="left" valign="top">The class that has the same name as the subsystem
description specified in the qualified subsystem name is used for prestart
jobs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Qualified class name</em></td>
<td align="left" valign="top">The name of the class used for prestart jobs. The
first 10 characters contain the class name, and the second 10 characters
contain the library name. You can use these special values for the library
name:<br>
<br>
<table cellpadding="5">
<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 job's library list</td>
</tr>
</table>
<p>If the class does not exist when the entry is added, a library qualifier
must be specified because the qualified class name is retained in the subsystem
description.</p>
</td>
</tr>
</table>
<p><strong>Class 1 number of jobs.</strong> The maximum number of jobs to run
that use the first class. If you specified the maximum number of jobs key to be
changed, the value for the number of jobs specified for this key might need to
be changed. If -3 or -4 is specified, the system recalculates the value for the
number of jobs to use the specified class. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">*CALC: The system calculates how many prestart
jobs use this class. If only one class is specified and -3 is specified, all of
the jobs use that class. If two classes are specified and -3 is specified for
both, the first class is the value of the maximum number of jobs divided by
two, and the second class is the value of the maximum number of jobs minus the
value calculated for the first class. If a specific number of jobs is specified
for either class and -3 is specified for the other class, the system calculates
the difference between maximum number of jobs and the specific number of jobs
for the -3 designation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4</em></td>
<td align="left" valign="top">*MAXJOBS: All prestart jobs use the specified
class.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>number of jobs</em></td>
<td align="left" valign="top">The number of jobs that use this class. The sum
of the values specified for class 1 and class 2 number of jobs must equal the
value of the maximum number of jobs. If you specify one of the class number of
job keys, you may also need to specify the maximum number of jobs keys.</td>
</tr>
</table>
<p><strong>Class 2 name.</strong> The name of a class under which the prestart
jobs run. Two classes can be specified for a prestart job entry, class 1 name
and class 2 name. Each class defines the number of jobs that run under that
class. See class 1 number of jobs and class 2 number of jobs.</p>
<p>Jobs start under the first class specified until the number of jobs
specified for the first class is reached. After the allowed number of jobs
specified for the first class is reached, jobs are started under the second
class.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">This value indicates that only one class is
used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SBSD</em></td>
<td align="left" valign="top">The class that has the same name as the subsystem
description specified in the qualified subsystem name is used for prestart
jobs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Qualified class name</em></td>
<td align="left" valign="top">The name of the class being used for prestart
jobs. The first 10 characters contain the class name, and the second 10
characters contain the library name. You can use these special values for the
library name:<br>
<br>
<table cellpadding="5">
<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 job's library list</td>
</tr>
</table>
<p>If the class does not exist when the entry is added, a library qualifier
must be specified because the qualified class name is retained in the subsystem
description.</p>
</td>
</tr>
</table>
<p><strong>Class 2 number of jobs.</strong> The maximum number of jobs that use
the second class. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">*CALC: The system calculates how many prestart
jobs use this class. If only one class is specified and -3 is specified, all of
the jobs use that class. If two classes are specified and -3 is specified for
both, the first class is the value of the maximum number of jobs divided by
two, and the second class is the value of the maximum number of jobs minus the
value calculated for the first class. If a specific number of jobs is specified
for either class and -3 is specified for the other class, the system calculates
the difference between the maximum number of jobs and the specific number of
jobs for the -3 designation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4</em></td>
<td align="left" valign="top">*MAXJOBS: All prestart jobs use the specified
class.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>number of jobs</em></td>
<td align="left" valign="top">The number of jobs that use this class. The sum
of the values specified for class 1 and class 2 number of jobs must equal the
value of the maximum number of jobs. If you specify one of the class number of
job keys, you may also need to specify the maximum number of jobs keys.</td>
</tr>
</table>
<p><strong>Initial number of jobs.</strong> The initial number of prestart jobs
that are started when the subsystem specified in the qualfified subsystem name
is started. The value of this key must be less than or equal to the value of
the maximum number of jobs. The value of this key must be greater than or equal
to the value of the threshold. Valid values range from 1-9999.</p>
<p><strong>Job description name.</strong> The name of the job description being
used for the prestart job. If the job description does not exist when the entry
is changed, a library qualifier must be specified because the qualified job
description name is retained in the subsystem description.</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 name specified in the user
profile for the prestart job entry is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SBSD</em></td>
<td align="left" valign="top">The job description that has the same name as the
subsystem description for this prestart job entry is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Qualified job description name</em></td>
<td align="left" valign="top">The name of the job description being used for
this prestart job. The first 10 characters contain the job description name,
and the second 10 characters contain the library name. You can use these
special values for the library name:
<table cellpadding="5">
<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 job's library list</td>
</tr>
</table>
</td>
</tr>
</table>
<p><strong>Job name.</strong> The name of the prestart job that is started.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PGM</em></td>
<td align="left" valign="top">The job name is the same name as the qualified
program name specified in the subsystem entry identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>job-name</em></td>
<td align="left" valign="top">The name of the prestart job.</td>
</tr>
</table>
<p><strong>Maximum number of jobs.</strong> The maximum number of prestart jobs
that can be active at the same time for this prestart job entry. The value of
this key must be greater than or equal to the value of the initial number of
jobs. The value of this key must be greater than the value of the additional
number of jobs. If the value specified for this key is changed, the value
specified for one or both of the class number of job keys might also need to be
changed. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">*NOMAX: There is no maximum number of jobs that
can be active at the same time.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>maximum-jobs</em></td>
<td align="left" valign="top">The maximum number of prestart jobs that can be
active at the same time. Valid values range from 1-9999.</td>
</tr>
</table>
<p><strong>Maximum number of uses.</strong> The maximum number of that can be
handled by each prestart job before the subsystem ends the job in a controlled
manner. Jobs are ended in a controlled manner by issuing an ENDJOB command with
a value of *CNTRLD on the OPTION parameter.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">*NOMAX: There is no maximum number of that a
prestart job can handle before it is ended. If -1 is specified, the prestart
jobs may end abnormally because the job has exceeded the allowed maximum job
log size, the maximum number of spooled files, the maximum processor unit time,
or the maximum temporary storage space required.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>maximum-uses</em></td>
<td align="left" valign="top">The maximum number of that a prestart job can
handle before it is ended. Valid values range from 1 through 1000.</td>
</tr>
</table>
<p><strong>Pool identifier.</strong> The subsystem pool identifier under which
the prestart jobs are run. Valid values range from 1 through 10.</p>
<p><strong>Resources affinity group.</strong> Specifies whether or not the prestart jobs started by this entry are grouped together having affinity to the same set of processors and memory. The values allowed are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Prestart jobs will not be grouped together. They will be spread across all the available system resources.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Prestart jobs will be grouped together such that they will have affinity to the same system resources.</td>
</tr>
</table>
<p><strong>Start jobs.</strong> Whether prestart jobs are started when the
subsystem is started. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The prestart jobs are not started at the time the
subsystem is started. The Start Prestart Jobs (STRPJ) command must be used to
start these prestart jobs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The prestart jobs are started when the subsystem
is started.</td>
</tr>
</table>
<p><strong>Thread resources affinity.</strong> Specifies whether or not secondary threads running in the prestart jobs are grouped together with the initial thread, or spread across the system resources. The values allowed for the first 10 characters are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SYSVAL</em></td>
<td align="left" valign="top">The thread resources affinity group and level will be retrieved from the QTHDRSCAFN system value when the job starts.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOGROUP</em></td>
<td align="left" valign="top">Secondary threads running in the prestart job will not necessarily have affinity to the same set of processors and memory as the initial thread. They will be spread across all the available system resources.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*GROUP</em></td>
<td align="left" valign="top">Secondary threads running in the prestart job will all have affinity to the same set of processors and memory as the initial thread.</td>
</tr>
</table>
<p>The last 10 characters of this field specifies the degree to which the system tries to maintain the affinity between threads and system resources. If *SYSVAL is specified in the first 10 characters, the last 10 characters must contain blanks. If *SYSVAL is not specified, the values allowed are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NORMAL</em></td>
<td align="left" valign="top">A thread will use any processor or memory in the system if the resources it has affinity to are not readily available.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HIGH</em></td>
<td align="left" valign="top">A thread will only use the resources it has affinity to, and will wait until they become available if necessary.</td>
</tr>
</table>
<p><strong>Threshold.</strong> The number at which additional prestart jobs are
started. When the pool of available prestart jobs (jobs available to service is
reduced below this number, more jobs (specified by the additional number of
jobs value) are started and added to the available pool. The value of this key
must be less than or equal to the value of the initial number of jobs. Valid
values range from 1-9999.</p>
<p><strong>User profile name.</strong> The user profile under which the
prestart job is initiated. In addition, the current user profile of the
prestart job is set to this user whenever the job waits for a request to
handle.</p>
<p><strong>Note:</strong> When a prestart job is given a request to handle, the
current user profile of the job is updated. Refer to the
<a href="../rzaks/rzaks1.htm">Work Management</a> topic for information on how this profile is
determined. This change in current user profile is for authority checking only.
None of the other attributes of the user profile, such as the current library
(CURLIB) or the initial program to call (INLPGM), are given to the prestart
job.</p>
<p><strong>Wait for job.</strong> Whether program start requests wait for a
prestart job to become available or are rejected if a prestart job is not
immediately available when the program start request is received. Refer to the
manual for the communications type being used to determine the timing
considerations for program start requests. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Program start requests are rejected if a prestart
job is not immediately available when the program start request is
received.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Program start requests wait until a prestart job
is available, or a prestart job is started to service the request.</td>
</tr>
</table>
<br>
<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">CPF1619 E</td>
<td align="left" valign="top">Subsystem description &amp;1 in library &amp;2
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1697 E</td>
<td align="left" valign="top">Subsystem description &amp;1 not changed.</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">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C4D E</td>
<td align="left" valign="top">Length &amp;1 for key &amp;2 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C81 E</td>
<td align="left" valign="top">Value for key &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C82 E</td>
<td align="left" valign="top">Key &amp;1 not valid for API &amp;2.</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">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">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">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9811 E</td>
<td align="left" valign="top">Program &amp;1 in library &amp;2 not found.</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: V4R3
<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>