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

3863 lines
112 KiB
HTML
Raw 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>Save Object List (QSRSAVO) 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. -->
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
<!-- Change history: -->
<!-- 021009 DRH v5r3 XPF D99207 Ragged SWA -->
<!-- 030418 DRH v5r3 UHLP P9A28560 See CL help text updates -->
<!-- 031105 DRH v5r4 XPF D99654 Save Spool support -->
<!-- 041217 DRH v5r4 XPF D93274 Allow > 300 list values -->
<!-- 050126 DRH v5r4 XPF D93015 Add QDTA support -->
<!-- File cleanup completed Jan 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>Save Object List (QSRSAVO) API</h2>
<div class="box" style="width: 80%;">
&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">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 Save Object List (QSRSAVO) API saves a list of objects
<img src="delta.gif" alt="Start of change">or spooled files
<img src="deltaend.gif" alt="End of change"> specified by the
user. The list of objects, as well as any additional information needed for the
save operation, is generated by the user into a user space.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><strong><em>User Space</em></strong></dt>
<dd>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*SHRNUP</dd>
</dl>
</dd>
</dl>
<dl>
<dt><strong><em>Objects to Be Saved</em></strong><br>
If the user has save system (*SAVSYS) special authority,
the following authorities are not needed. When saving user profiles,
*SAVSYS special authority is required.</dt>
<dd>
<dl>
<dt><em>Object Authority</em></dt>
<dd>*OBJEXIST</dd>
<dt><em>Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Object Lock</em></dt>
<dd>*SHRNUP</dd>
<dt><em>Library Lock</em></dt>
<dd>*SHRUPD</dd>
</dl>
</dd>
</dl>
<p><strong>Note:</strong> Lower levels of locking may be used for objects in
certain cases. See <a href="../rzaiu/rzaiurzaiu319.htm">Save while
active object locking rules</a> in the Backup and Recovery topic for more
information on these special cases.</p>
<dl>
<dt><img src="delta.gif" alt="Start of change">
<strong><em>Spooled Files to Be Saved</em></strong><br>
If the user has save system (*SAVSYS)
special authority, the following authorities are not needed.</dt>
<dd>
<dl>
<dt><em>Output Queue Authority</em></dt>
<dd>*OBJEXIST</dd>
<dt><em>Output Queue Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Output Queue Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
</dd>
</dl>
<p><strong>Note:</strong> Additional authority may be needed to
change spooled file attributes.
See <a href="#HDRNEWATTRS">New Attributes Format</a>
for more information.
<img src="deltaend.gif" alt="End of change"></p>
<dl>
<dt><strong><em>Devices</em></strong></dt>
<dd>
<dl>
<dt><em>Save File Authority</em></dt>
<dd>*USE and *ADD</dd>
<dt><em>Save File Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Save File Lock</em></dt>
<dd>*EXCLRD</dd>
<dt><em>Tape or Optical<!--, or Diskette--> Authority</em></dt>
<dd>*USE</dd>
<dt><em>Tape or Optical<!--, or Diskette--> Lock</em></dt>
<dd>*EXCL</dd>
<dt><em>Media Library Device Lock</em></dt>
<dd>*SHRUPD</dd>
<dt><em>Media Definition Authority</em></dt>
<dd>*USE</dd>
<dt><em>Media Definition Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Media Definition Lock</em></dt>
<dd>*EXCLRD</dd>
<dt><em>Auxiliary
Storage Pool (ASP)</em></dt>
<dd>*USE
</dd>
</dl>
</dd>
</dl>
<p><strong>Note:</strong> If the save file will be cleared, *OBJMGT authority
is also required.</p>
<dl>
<dt><strong><em>Save While Active</em></strong></dt>
<dd>
<dl>
<dt><em>Message Queue Authority</em></dt>
<dd>*OBJOPR and *ADD</dd>
<dt><em>Message Queue Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
</dd>
</dl>
<dl>
<dt><strong><em>Output Files</em></strong></dt>
<dd>
<dl>
<dt><em>Output File Lock</em></dt>
<dd>*SHRRD</dd>
</dl>
</dd>
</dl>
<dl>
<dt>If the output file does not exist:</dt>
<dd>
<dl>
<dt><em>Output File Library Authority</em></dt>
<dd>*READ and *ADD</dd>
</dl>
</dd>
</dl>
<dl>
<dt>If the output file exists and a new member will be added:</dt>
<dd>
<dl>
<dt><em>Output File Authority</em></dt>
<dd>*OBJMGT, *OBJOPR, and *ADD</dd>
<dt><em>Output File Library Authority</em></dt>
<dd>*EXECUTE and *ADD</dd>
</dl>
</dd>
</dl>
<dl>
<dt>If the output file exists and an existing member will be appended:</dt>
<dd>
<dl>
<dt><em>Output File Authority</em></dt>
<dd>*OBJMGT and *ADD</dd>
<dt><em>Output File Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
</dd>
</dl>
<dl>
<dt>If the output file exists and an existing member will be replaced:</dt>
<dd>
<dl>
<dt><em>Output File Authority</em></dt>
<dd>*OBJMGT, *OBJOPR, *ADD, and *DLT</dd>
<dt><em>Output File Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
</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 hold all the information for the save operation.
The first 10 characters contain the user space name. The second 10 characters
contain the name of the library where the user space is located. See <a href=
"#HDRUSRSPC">User space format</a> for the format of the information in the
user space.</p>
<p>You can use the following special values for the library name. It should be
noted, however, that the library name that is actually used is not passed back
to the user. Care should be taken when using these special values to avoid
unexpected results.</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 is used to locate the
user space. If no library is specified as the current library for the job, the
QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the user
space.</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="HDRUSRSPC">User Space Format</a></h3>
<p>The following defines the format for the information in the user space. For
detailed descriptions of the fields in the user space format, see <a href=
"#HDRUSFDS">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%">Number of variable length
records</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each variable length record.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of variable length record</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</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">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<p>If you specify a data length that is longer than the key field's defined
data length, the data is truncated at the right. No error message is
returned.</p>
<p>If you specify a data length that is shorter than the key field's defined
data length, an error message is returned for binary fields. If the field is a
character field, the data is padded with blanks.</p>
<p><strong>Note:</strong> This does not apply to keys that allow a list of
values to be specified. In these cases, the amount of data read is based on the
specified number of entries in the list.</p>
<p>If keys are duplicated in the user space, only the last value for a given
key is used for the save operation.</p>
<p>It is recommended, but not required, to align each variable length record
on a 4-byte boundary. That is, you should make the length of each variable
length record a multiple of 4, even if the data length is not a multiple
of 4.</p>
<br>
<h3><a name="HDRUSFDS">Field Descriptions</a></h3>
<strong>Data.</strong> The data used to specify the value for the given key.
<p><strong>Key.</strong> The parameter of the Save Object (SAVOBJ) command to
specify. See <a href="#HDRKEYFLD">Valid Keys</a> for the list of valid
keys.</p>
<p><strong>Length of data.</strong> The length of the data used to specify the
value for the given parameter.</p>
<p><strong>Length of variable length record.</strong> The length of the
variable length record.</p>
<p><strong>Number of variable length records.</strong> The number of variable
length records that are passed in the user space. <img src="delta.gif" alt=
"Start of change">The valid range is from 2 through 36. <img src=
"deltaend.gif" alt="End of change"></p>
<br>
<h3><a name="HDRKEYFLD">Valid Keys</a></h3>
The following table lists the valid keys for the key field area of the variable
length record. For detailed descriptions of the keys, see <a href=
"#HDRSOLDESC">Field Descriptions</a>.
<p>Some messages for this API refer to parameters and values of the Save Object
(SAVOBJ) command. This table can also be used to locate the key names that
correspond to the SAVOBJ command parameters. The field descriptions contain, in
addition to detailed descriptions, the corresponding parameter values.</p>
<p>The library key and the device key are required keys. The other keys are
optional.</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>
<th align="left" valign="bottom">SAVOBJ Command Parameter</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="35%">Object information</td>
<td align="left" valign="top" width="35%">OBJ, OBJTYPE</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Library</td>
<td align="left" valign="top">LIB</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Device</td>
<td align="left" valign="top">DEV</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Save file</td>
<td align="left" valign="top">SAVF</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Update history</td>
<td align="left" valign="top">UPDHST</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Volume identifier</td>
<td align="left" valign="top">VOL</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sequence number</td>
<td align="left" valign="top">SEQNBR</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Label</td>
<td align="left" valign="top">LABEL</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Expiration date</td>
<td align="left" valign="top">EXPDATE</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End of media option</td>
<td align="left" valign="top">ENDOPT</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Target release</td>
<td align="left" valign="top">TGTRLS</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Clear</td>
<td align="left" valign="top">CLEAR</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Object precheck</td>
<td align="left" valign="top">PRECHK</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save while active</td>
<td align="left" valign="top">SAVACT</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Save while active wait time for object locks</td>
<td align="left" valign="top">SAVACTWAIT</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Save while active message queue</td>
<td align="left" valign="top">SAVACTMSGQ</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">File member</td>
<td align="left" valign="top">FILEMBR</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save access paths</td>
<td align="left" valign="top">ACCPTH</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save file data</td>
<td align="left" valign="top">SAVFDTA</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Storage</td>
<td align="left" valign="top">STG</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data compression</td>
<td align="left" valign="top">DTACPR</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data compaction</td>
<td align="left" valign="top">COMPACT</td>
</tr>
<tr>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">OUTPUT</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Qualified output file</td>
<td align="left" valign="top">OUTFILE</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="left" valign="top">CHAR(11)</td>
<td align="left" valign="top">Output member</td>
<td align="left" valign="top">OUTMBR</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Type of output information</td>
<td align="left" valign="top">INFTYPE</td>
</tr>
<tr>
<td align="center" valign="top">27</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Optical file</td>
<td align="left" valign="top">OPTFILE</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Use optimum block size</td>
<td align="left" valign="top">USEOPTBLK</td>
</tr>
<tr>
<td align="center" valign="top">29</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Omit library</td>
<td align="left" valign="top">OMITLIB</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Omit object information</td>
<td align="left" valign="top">OMITOBJ</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Media definition</td>
<td align="left" valign="top">MEDDFN</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name</td>
<td align="left" valign="top">ASPDEV</td>
</tr>
<tr>
<td align="center" valign="top">33</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Save while active wait time for pending record changes</td>
<td align="left" valign="top">SAVACTWAIT</td>
</tr>
<tr>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Save while active wait time for other pending changes</td>
<td align="left" valign="top">SAVACTWAIT</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">
35</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Spooled file data</td>
<td align="left" valign="top">SPLFDTA</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Queue data</td>
<td align="left" valign="top">QDTA <img src="deltaend.gif" alt=
"End of change"></td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSOLDESC">Field Descriptions</a></h3>
<p>The values shown in parentheses are the corresponding values for the SAVOBJ
command parameters.</p>
<p><strong>ASP device
name.</strong> The names of the auxiliary storage pool (ASP) devices to be
included in the save operation. When saving user profiles, these are the ASPs
from which private authorities are saved. The default is *. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*</em></td>
<td align="left" valign="top">The operation includes the system ASP (ASP number
1), all basic user ASPs (ASP numbers 2-32), and, if the job has a linked ASP
group, all independent ASPs in the linked ASP group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALLAVL</em></td>
<td align="left" valign="top">The operation includes the system ASP, all basic
user ASPs, and all available independent ASPs.
<p><strong>Note:</strong> This value is valid only when saving user
profiles.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSBAS</em></td>
<td align="left" valign="top">The operation includes the system ASP and all
basic user ASPs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURASPGRP</em></td>
<td align="left" valign="top">If the job has a linked ASP group, all
independent ASPs in the linked ASP group are included in the save
operation.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>ASP device name</em></td>
<td align="left" valign="top">The operation includes the specified independent
ASP.</td>
</tr>
</table>
<p><strong>Clear.</strong> Whether active data on the media is cleared or
replaced automatically. Active data is any file on the media that has not
expired. Clearing active data removes all files from the volume, starting at
the specified sequence number for the tape. Replacing active data on optical
media replaces only the optical files created by this operation. The default is
0.</p>
<p><strong>Notes:</strong></p>
<ol type="a">
<li>Clearing a tape does not initialize it. Before the save command is issued,
you should initialize the tape to a standard label format by using the
Initialize Tape (INZTAP) command and specifying a value on the NEWVOL
parameter.<br>
<br>
</li>
<li>Clearing an optical volume does initialize it.<br>
<br>
</li>
<!-- <li>Clearing a diskette does not initialize it. Before the save command is
issued, you should initialize the diskette to a save and restore format by
using the Initialize Diskette (INZDKT) command and specifying FMT(*SAVRST).<br>
<br>
</li> -->
<li>If a volume that is not initialized is encountered during the save
operation, an inquiry message is sent and an operator can initialize the
volume.</li>
</ol>
<p>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">None of the media is cleared automatically. If
the save operation encounters active data on a tape<!--, diskette,--> or save file, an
inquiry message is sent, allowing the operator to either end the save operation
or clear the media. If the save operation encounters the specified optical
file, an inquiry message is sent, allowing the operator to either end the save
operation or replace the file. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">All of the media is cleared automatically. (*ALL)
<p>If tapes are used and a sequence number is specified for the sequence number
key, the first tape is cleared beginning at that sequence number. All tapes
following the first tape are completely cleared. To clear the entire first
tape, 1 must be specified for the sequence number key.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">All media after the first volume is cleared
automatically. If the save operation encounters active data on the first tape<!--
or diskette-->, an inquiry message is sent, allowing the operator to either end
the save operation or clear the media. If the save operation encounters the
specified optical file on the first volume, an inquiry message is sent,
allowing the operator to either end the save operation or replace the file.
(*AFTER)
<p><strong>Note:</strong> This value is not valid for save files.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Active data on the media is replaced
automatically. Optical volumes are not initialized. Tapes<!--, diskettes,--> and save
files are cleared automatically in the same way as the value 1. (*REPLACE)</td>
</tr>
</table>
<p><strong>Data compaction.</strong> Whether data compaction is used. The
default is 1. 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">Device data compaction is not performed.
(*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Device data compaction is performed if the data
is saved to tape and all tape devices specified support the compaction feature.
(*DEV)</td>
</tr>
</table>
<p><strong>Data compression.</strong> Whether data compression is used. The
default is 2. 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">No data compression is performed. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">If the save operation is to tape and the target
device supports compression, hardware compression is performed. If compression
is not supported on the device, or if the save data is written to optical<!--,
diskette,--> or save file, software compression is performed.
Low (SNA) software compression is used for all devices except optical DVD,
which uses medium (TERSE) software compression.
(*YES)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">If the save operation is to tape and the target
device supports compression, hardware compression is performed. Otherwise, no
data compression is performed. (*DEV)
<p><strong>Note:</strong> Note: If 2 is specified for the data compression key
and 1 is specified for the data compaction key, only device data compaction is
performed if compaction is supported on the device. Otherwise, data compression
is performed if supported on the device.
</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, low (SNA) software data compression is done. If the save operation is
being done while other jobs on the system are active and software data
compression is used, the overall system performance may be affected. Low
compression is usually faster than medium or high compression. The compressed
data is usually larger than if medium or high compression is used. (*LOW)
</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, medium (TERSE) software data compression is done. If the save
operation is being done while other jobs on the system are active and software
data compression is used, the overall system performance may be affected.
Medium compression is usually slower than low compression but faster than high
compression. The compressed data is usually smaller than if low compression is
used and larger than if high compression is used. (*MEDIUM)</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, high (LZ1) software data compression is done. If the save operation is
being done while other jobs on the system are active and software data
compression is used, the overall system performance may be affected. High
compression is usually slower than low and medium compression.The compressed
data is usually smaller than if low or medium compression is used. (*HIGH)</td>
</tr>
</table>
<p><strong>Device.</strong> The names of the devices used for the save
operation. The device must already be known on the system by a device
description. For the format of this field, see <a href="#HDRDEVKEY">Device Key
Format</a>.</p>
<p><strong>End of media option.</strong> The operation that is performed
automatically on the tape or optical volume after the save operation ends. If
more than one volume is used, this key applies only to the last volume used;
all other volumes are unloaded when the end of the volume is reached. The
default is 0.</p>
<p><strong>Note:</strong> This parameter is valid only if a tape or optical
device name is specified. For optical devices, 2 is the only value supported; 0
and 1 are ignored.</p>
<p>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 tape is automatically rewound, but not
unloaded, after the operation ends. (*REWIND)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape does not rewind or unload after the
operation ends. It remains at the current position on the tape drive.
(*LEAVE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The tape is automatically rewound and unloaded
after the operation ends. Some optical devices eject the volume after the
operation ends. (*UNLOAD)</td>
</tr>
</table>
<p><strong>Expiration date.</strong> The expiration date of the tape file<!--,
diskette file,--> or optical file created by the save operation. If a date is
specified, the file is protected and cannot be overwritten until the specified
expiration date. The default is 0999999. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0999999</em><br>
<br>
</td>
<td align="left" valign="top">The file is protected permanently. (*PERM)</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Expiration date</em></td>
<td align="left" valign="top">The date when protection for the file ends,
specified in the format CYYMMDD:
<dl compact>
<dt><em>C</em></dt>
<dd>Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.<br><br></dd>
<dt><em>YY</em></dt>
<dd>Year<br><br></dd>
<dt><em>MM</em></dt>
<dd>Month<br><br></dd>
<dt><em>DD</em></dt>
<dd>Day</dd>
</dl>
</td>
</tr>
</table>
<p><strong>File member.</strong> A list of the database files and their members
that are to be saved. Each database file specified here must also be specified
in the list of objects to be saved. If this key is not specified, the default
of *ALL will be used for both the file name and the member name. For the format
of this field, see <a href="#HDRFILMKEY">File Member Format</a>.</p>
<p><strong>Label.</strong> The name that identifies the data file on the tape<!--
or diskette-->. Although the label key is defined as CHAR(*), the maximum length
of a label is currently 17. If the length of data field is specified as more
than 17, the label is truncated such that only the first 17 characters are
used. The default is *LIB.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIB</em></td>
<td align="left" valign="top">The file label is created by the system using the
name of the library specified for the library key.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Data file identifier</em></td>
<td align="left" valign="top">The data file identifier of the data file used.
This option is valid only for a single-library save operation.</td>
</tr>
</table>
<p><strong>Library.</strong> A list of libraries that contain the objects that
are saved. If more than one library is specified, *ALL must be the only object
name specified (object information key) and the device cannot be *SAVF. For the
format of this field, see <a href="#HDRLIBKEY">Library Key Format</a>.</p>
<p><strong>Media definition.</strong> The name and library of the media
definition that identifies the devices and media used to contain the saved
data. For information about creating and using a media definition,
see <a href="../rzaiu/rzaiurzaiuparandcon.htm">Save to multiple devices</a>
in the Backup and recovery topic
and the <a href="qsrcrtmd.htm">Create
Media Definition</a> (QSRCRTMD, QsrCreateMediaDefinition) API. The first 10
characters contain the media definition name; the second 10 characters contain
the library in which the media definition is located.</p>
<p>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 is used to locate the
media definition. If no library is specified as the current library for the
job, the QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<p><strong>Object information.</strong> A list of the name and type of the
objects to be saved. If *ALL is specified for the object name and object type,
the list cannot contain other entries. The default for both the object name and
the object type is *ALL. For the format of this field, see <a href=
"#HDROBJKEY">Object Information Format</a>.</p>
<p><strong>Object precheck.</strong> Whether the save operation for a library
should end if all objects specified by the API do not satisfy all the following
conditions:</p>
<ul>
<li>The objects exist</li>
<li>The objects were not previously found to be damaged</li>
<li>The objects are not locked by another job</li>
<li>The requester of the save operation has authority to save the objects</li>
</ul>
<p>The default is 0. 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 save operation for a library continues,
saving only those objects that can be saved. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">If one or more objects cannot be saved after the
specified objects are checked, the save operation for a library ends before any
data is written. (*YES)</td>
</tr>
</table>
<p><strong>Omit libraries.</strong> A list of the libraries to be omitted from
the save operation. The default is *NONE. For the format of this field, see <a
href="#HDROLIBKEY">Omit Library Key Format</a>.</p>
<p><strong>Omit object information.</strong> A list of the name and type of the
objects and library to be omitted from the save operation. If *ALL is specified
for the object name and object type, the list cannot contain other entries. The
default for both the object name and the object type is *ALL. For the format of
this field, see <a href="#HDROBJOMIT">Omit Object Information Format</a>.</p>
<p><strong>Optical file.</strong> The name that identifies the file on the
optical volume. Although the optical file is defined as CHAR(*), the maximum
length of an optical file name is currently 256 characters. If the length of
data field is specified as more than 256 characters, the name is truncated such
that only the first 256 characters are used. The default is '*'. The possible
values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>'*'</em></td>
<td align="left" valign="top">The system generates an optical file name in the
root directory of the optical volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'Optical-directory-path-name/*'</em></td>
<td align="left" valign="top">The system generates an optical file name in the
specified directory of the optical volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Optical file path name</em></td>
<td align="left" valign="top">The path name of the optical file that is used
for the save operation, beginning with the root directory of the volume.</td>
</tr>
</table>
<p><strong>Output.</strong> Whether a list of information about the saved
objects is created. The default is 0. 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">No output listing is created. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The output is printed with the job's spooled
output. (*PRINT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The output is directed to the database file
specified with the output file key. (*OUTFILE)</td>
</tr>
</table>
<p><strong>Output member.</strong> The name of the database file member used to
save the object information. This field also determines whether to replace or
add the data if the member already exists. The defaults are *FIRST for the
output member name field and 0 for the option field. For the format of this
field, see <a href="#HDROUTPKEY">Output Member Format</a>.</p>
<p><strong>Qualified output file.</strong> The qualified name of the database
file to which the information about the objects is directed. This key is
required only if the output key is set to 2. The first 10 characters contain
the output file name; the second 10 characters contain the output file library.
The possible values for output file library are:</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 is used to locate the
output file. If no library is specified as the current library for the job, the
QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the output
file.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Library name</em></td>
<td align="left" valign="top">The name of the library where the output file is
located.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change">
<strong>Queue data.</strong> A description of queue data to be
saved. The default is no queue data.
For the format of this key, see <a href="#HDRQDTAKEY">Queue Data Key Format</a>.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Save access paths.</strong> Whether the logical file access paths
that are dependent on the physical files being saved are also saved.
The default is 2. 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 logical file access paths are not saved.
(*NO)<br>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The specified physical files and all eligible
logical file access paths over them are saved. (*YES)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The system value QSAVACCPTH determines whether
to save the logical file access paths that are dependent on the physical files
that are being saved. (*SYSVAL)</td>
</tr>
</table>
<p><strong>Save file.</strong> The name and library of the save file that is
used to contain the saved data. The first 10 characters contain the save file
name; the second 10 characters contain the library where the save file is
located.</p>
<p>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 is used to locate the
save file. If no library is specified as the current library for the job, the
QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<p><strong>Save file data.</strong> For save file objects, whether only the
description of a save file, or both the description and the contents of a save
file are saved. The default is 1. 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">Only the description of a save file is saved.
(*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The description and contents of a save file are
saved. (*YES)</td>
</tr>
</table>
<p><strong>Note:</strong> For System/38 environments, the default value of 1 is
not valid; therefore, this key must explicitly be set to a value of 0.</p>
<p><strong>Save while active.</strong> Whether an object can be updated while
it is being saved. The default is 0. 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">Objects that are in use are not saved. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Objects in a library can be saved while they are
in use by another job. Objects in a library may reach checkpoints at different
times and may not be in a consistent state in relationship to each other.
(*SYSDFN)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Objects in a library can be saved while they are
in use by another job. All the objects in a library reach a checkpoint
together. They are saved in a consistent state in relationship to each other.
(*LIB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Objects in a library can be saved while they are
in use by another job. All the objects and all the libraries in the save
operation reach a checkpoint together. They are saved in a consistent state in
relationship to each other. (*SYNCLIB)</td>
</tr>
</table>
<p><strong>Save while active message queue.</strong> The name and library of
the message queue that is used to notify the user that the checkpoint
processing for a library is complete. The first 10 characters contain the
message queue name; the second 10 characters contain the name of the library
where the message queue is located. If *NONE or *WRKSTN is specified for the
message queue name, blanks must be specified for the message queue library. The
defaults are *NONE for the message queue name and blanks for the library.</p>
<p>The possible values for the message queue name are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No notification message is sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WRKSTN</em></td>
<td align="left" valign="top">The notification message is sent to the work
station message queue. This is not valid in batch mode.</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.</td>
</tr>
</table>
<p>The possible values for the message queue library are:</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 is used to locate the
message queue. If no library is specified as the current library for the job,
the QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the message
queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Library name</em></td>
<td align="left" valign="top">The name of the library where the message queue
is located.</td>
</tr>
</table>
<p><strong>Save while active wait time for object locks.</strong> If an object is not available,
the amount of time to wait for a lock on the object before
continuing the save operation.
The default is 120. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">No maximum wait time exists.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>0-99999</em></td>
<td align="left" valign="top">The time (in seconds) to wait.</td>
</tr>
</table>
<p><strong>Save while active wait time for other pending changes.</strong>
For each library, the amount of time to wait for transactions with
other pending changes to reach a commit boundary.
Other pending changes include the following:</p>
<ul>
<li>Data Definition Language (DDL) object level changes for that library.</li>
<li>Any API commitment resource that was added without the option
to allow normal save processing. For more information, see the
<a href="QTNADDCR.htm">Add Commitment Resource (QTNADDCR)</a> API.</li>
</ul>
<p>If a commit boundary is not reached
for a library in the specified time, library is not saved.
The default is -2. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">No maximum wait time exists. (*NOMAX)</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">The system waits up to the value specified on the
Save while active wait time for object locks key for the types of transactions
that are listed above to reach a commit boundary. (*LOCKWAIT)</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>0-99999</em></td>
<td align="left" valign="top">The time (in seconds) to wait.
If 0 is specified, and only one object is specified on the Object information key,
and that object is a file, then the system will save the object without requiring
the types of transactions that are listed above to reach a commit boundary.</td>
</tr>
</table>
<p><strong>Save while active wait time for pending record changes.</strong>
For each group of objects that are checkpointed together, the amount of time
to wait for transactions with pending record changes to reach a commit boundary.
The Save while active key determines which objects are checkpointed together.
If 0 is specified, all objects being saved must be at commit boundaries.
If any other value is specified, all objects that are journaled to the same
journals as the objects being saved must reach commit boundaries.
If a commit boundary is not reached in the specified time,
the save operation is ended, unless the value -3 is specified.
The default is -2. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">No maximum wait time exists. (*NOMAX)</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">The system waits up to the value specified on the
Save while active wait time for object locks key for transactions
with pending record changes to reach a commit boundary. (*LOCKWAIT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">The system will save objects without requiring
transactions with pending record changes to reach a commit boundary.
Therefore, objects may be saved with partial transactions. (*NOCMTBDY)
<p>If you restore an object that was saved with partial transactions,
you cannot use the object until you apply or remove journal changes
(APYJRNCHG or RMVJRNCHG command) to reach commit boundaries.
You will need all journal receivers that contain information about
the partial transactions to apply or remove the changes.
Until you apply or remove the changes, any future save of that object will
include the partial transactions, even if you do not specify this value.</p>
<p><strong>Note:</strong> This value cannot be specified if
the Target release key is earlier than V5R3M0.</p></td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>0-99999</em></td>
<td align="left" valign="top">The time (in seconds) to wait.</td>
</tr>
</table>
<p><strong>Sequence number.</strong> The sequence number to use for the save
operation when tape is used. The default is -1. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The save operation begins after the last sequence
number on the tape volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-16777215</em></td>
<td align="left" valign="top">The sequence number of the file to be used for
the save operation.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change">
<strong>Spooled file data.</strong> A description of spooled file data to be
saved. The default is no spooled file data.
For the format of this key, see <a href="#HDRSPLFKEY">Spooled File
Data Key Format</a>.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Storage.</strong> Whether the system storage that is occupied by the
data portion of the following objects in the library being saved is freed:</p>
<ul>
<li>Files</li>
<li>Modules</li>
<li>Programs</li>
<li>Service programs</li>
<li>Structured Query Language (SQL) packages</li>
<li>Journal receivers</li>
</ul>
<p>The default is 0. 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 storage occupied by the data portion of the
objects is not freed. (*KEEP)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The storage occupied by the data portion of the
objects is freed. The storage is freed only after all the objects in the
library are saved successfully. (*FREE)</td>
</tr>
</table>
<p><strong>Target release.</strong> The release of the operating system on
which the objects will be restored and used. The object types specified (in the
object information field) must exist on the specified release. The default is
*CURRENT. The possible 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 objects are restored to, and used on, the
release of the operating system currently running on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRV</em></td>
<td align="left" valign="top">The objects are to be restored on the previous
release that has modification level 0 of the operating system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Release level</em></td>
<td align="left" valign="top">The release level in the format VxRxMx, where x
is the number of the version, release, and modification level.</td>
</tr>
</table>
<p><strong>Type of output information.</strong> The type of information that is
printed or directed to the output database file. The default is 0. 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 list contains an entry for each object
requested to be saved. (*OBJ)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The list contains an entry for each library
requested to be saved. (*LIB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The list contains an entry for each object,
database file member, <img src="delta.gif" alt="Start of change">and
spooled file<img src="deltaend.gif" alt="End of change">
requested to be saved. (*MBR)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The list contains an entry for each library that
is requested to be saved and an entry for each object that was not
successfully saved. (*ERR)</td>
</tr>
</table>
<p><strong>Update history.</strong> Whether the save history information of
each object is changed to the date, time, and location of this save operation.
The default is 1. 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 save history information of each object saved
is not updated. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The last save date, time, and location is updated
in each object saved. (*YES)</td>
</tr>
</table>
<p><strong>Use optimum block size.</strong> Whether the tape device's optimum
block size should be used. The default is 0. 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 tape device's optimum block size is not used.
A block size that is compatible with all i5/OS releases and tape devices is
used. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape device's optimum block size is used. The
system may create a tape that is only compatible with a tape device that
supports the same block size. Performance will likely but not necessarily
improve. Commands such as Duplicate Tape (DUPTAP) do not duplicate the tape
unless it is being duplicated to a tape device that supports the same block
size. (*YES) Data compression is ignored when optimum block size is used.
<!--Optimum block size is ignored when the target release value specified is before
V3R7M0.--></td>
</tr>
</table>
<p><strong>Volume identifier.</strong> The volume identifiers of the tape
volumes<!--, diskette volumes,--> or optical volumes on which the object data is to be
saved. All volume identifiers must be entered in the order in which you want
them saved. The default is *MOUNTED. For the format of this field, see <a href=
"#HDRVOLKEY">Volume Identifier Format</a>.</p>
<br>
<h3><a name="HDRDEVKEY">Device Key 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each device name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Device name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRMORFDS">Field Descriptions</a></h3>
<p><strong>Device name.</strong> The name of the device used for the save
operation. The possible values for each element of the array are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAVF</em></td>
<td align="left" valign="top">The save operation is done using the save file
specified by the save file key. If specified, it must be the only element in
the array.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MEDDFN</em></td>
<td align="left" valign="top">The save operation is done by using the devices
and media that are identified in the media definition, which is specified by
the media definition key. If specified, it must be the only element in the
array.</td>
</tr>
<!-- <tr>
<td align="left" valign="top"><em>Diskette device name</em></td>
<td align="left" valign="top">The name of the diskette device used for the save
operation. If specified, it must be the only element in the array.</td>
</tr> -->
<tr>
<td align="left" valign="top"><em>Media library device name</em></td>
<td align="left" valign="top">The name of the media library device used for the
save operation. If specified, it must be the only element in the array.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Optical device name</em></td>
<td align="left" valign="top">The name of the optical device used for the save
operation. If specified, it must be the only element in the array.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Tape device name</em></td>
<td align="left" valign="top">The name of the tape device used for the save
operation. A maximum of four tape devices may be used. They must be specified
in the order in which they should be used.</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of devices to be used during
the save operation. The possible values are 1 through 4.</p>
<br>
<h3><a name="HDRFILMKEY">File Member 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each file.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">File name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of members</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each member associated with the given file.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Member</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>File name.</strong> The name of the file being saved. The possible
values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The list of member names that follow this value
applies to all files indicated in the list of objects to save. If *ALL is
specified for the file name, it must be the only file name in the list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Database file name</em></td>
<td align="left" valign="top">The name of the database file from which the
listed members are saved.</td>
</tr>
</table>
<p><strong>Member.</strong> The name of the member to save. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All members are saved from the specified file. If
*ALL is specified for member name, it must be the only member name for that
file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No members are saved from the specified file.
Only the file description is saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Member name</em></td>
<td align="left" valign="top">The name of the member to save. It may be either
a simple name or a generic name.</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of file and member structures
used during the save operation. The possible values are 1 through 50.</p>
<p><strong>Number of members.</strong> The number of member names for the given
file name. Possible values are 1 through 50.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<br>
<h3><a name="HDRLIBKEY">Library Key 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each library name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Library name.</strong> The name of the library containing the
objects. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change"><em>*SPLF</em></td>
<td align="left" valign="top">Spooled file data is to be saved.
If this value is specified, it must be the only element in the array,
the spooled file data key must be specified,
and *ALL must be specified for the object name and object type.
<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top"><em>Library name</em></td>
<td align="left" valign="top">Either a simple or generic library name</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of libraries used during the
save operation. <img src="delta.gif" alt="Start of change">
The possible values are 1 through 32767.
<img src="deltaend.gif" alt="End of change"></p>
<br>
<h3><a name="HDROBJKEY">Object Information 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each object name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<strong>Number in array.</strong> The number of objects that are specified for
this key. There is no limit for the number in array field. The total amount of
information in the user space, however, cannot exceed 16MB.
<p><strong>Object name.</strong> The name of the object that is to be saved.
The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All the objects in the specified libraries,
depending on the values specified for object type</td>
</tr>
<tr>
<td align="left" valign="top"><em>Object name</em></td>
<td align="left" valign="top">Either a simple name or a generic name</td>
</tr>
</table>
<p><strong>Object type.</strong> The type of the object that is to be saved.
The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All objects with the specified object name that
are valid types for the SAVOBJ command on the current release of the
system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">All user profiles with the specified object name.
If this value is specified, all entries in the object information key must
specify this type and the saved data must be restored with the RSTUSRPRF
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Object type</em></td>
<td align="left" valign="top">A valid type for the SAVOBJ command on the
current release of the system</td>
</tr>
</table>
<br>
<h3><a name="HDROLIBKEY">Omit Library Key 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each library name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Library name.</strong> The name of the library containing the
objects to omit. 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">No libraries are excluded from the
save operation.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>Library name</em></td>
<td align="left" valign="top">Either a simple or generic library name</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of libraries to omit from
the save operation. <img src="delta.gif" alt="Start of change">
The possible values are 1 through 32767.
<img src="deltaend.gif" alt="End of change"></p>
<br>
<h3><a name="HDROBJOMIT">Omit Object Information 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each object name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<strong>Library name.</strong> The name of the library that is to be omitted.
The possible values are:
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All the libraries, depending on the values
specified for object and object type</td>
</tr>
<tr>
<td align="left" valign="top"><em>Library name</em></td>
<td align="left" valign="top">Either a simple name or a generic name</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of values that are specified
for this key. <img src="delta.gif" alt="Start of change">
The possible values are 1 through 32767.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Object name.</strong> The name of the object that is to be omitted.
The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All the objects in the specified libraries,
depending on the values specified for object type</td>
</tr>
<tr>
<td align="left" valign="top"><em>Object name</em></td>
<td align="left" valign="top">Either a simple name or a generic name</td>
</tr>
</table>
<p><strong>Object type.</strong> The type of the object that is to be omitted.
The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All objects with the specified object name that
are valid types for the SAVOBJ command on the current release of the
system</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">All user profiles with the specified object
name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Object type</em></td>
<td align="left" valign="top">A valid type for the SAVOBJ command on the
current release of the system</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDROUTPKEY">Output Member 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Output member name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Option</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<strong>Option.</strong> An indicator of whether to add to or replace the
existing member. The possible values are:
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The existing records in the specified database
file member are replaced by the new records. (*REPLACE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The new records are added to the existing
information in the database file member. (*ADD)</td>
</tr>
</table>
<p><strong>Output member name.</strong> The name of the file member that
receives the output. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*FIRST</em></td>
<td align="left" valign="top">The first member in the file is used and receives
the output.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Member name</em></td>
<td align="left" valign="top">If the member does not exist, the system creates
it.</td>
</tr>
</table>
<br>
<br>
<h3><img src="delta.gif" alt="Start of change"><a name="HDRQDTAKEY">Queue Data Key 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="left" valign="bottom">Dec</th>
<th align="left" 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%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each queue data value.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BIN(4)</td>
<td align="left" valign="top">Queue data</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Queue data.</strong> For queue objects, whether only the
description of a queue, or both the description and the contents of a queue are saved. The default is 0.</p>
<p>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">Only the description of a queue is saved.
(*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The description and contents of a standard data queue are saved. Only the description of a Distributed Data Management (DDM) data queue is saved. (*DTAQ)</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of queue data values. The possible value is 1.</p>
<br>
<br>
<h3><a name="HDRSPLFKEY">Spooled File Data Key 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%">Spooled file data</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">Length of spooled file data header</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">Offset to spooled file selection list</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Length of spooled file data header.</strong> The length of the
spooled file data header information. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">The header information ends with the
length field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>12</em></td>
<td align="left" valign="top">The header information ends with the
offset to selection list field.</td>
</tr>
</table>
<p><strong>Offset to spooled file selection list.</strong> The offset from the
start of the user space to the first
<a href="#HDRSPLFSEL">spooled file selection list entry</a>.
The default is 0.
If the value of the spooled file data field is 2, the value of this field
must be greater than 0. Otherwise, the value must be 0.</p>
<p><strong>Spooled file data.</strong> Whether to save spooled file
data and attributes. The default is 0. 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">No spooled file data is saved. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">For each output queue that is saved,
all available spooled file data on the output queue is saved. (*ALL)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Selected spooled file data is saved.
The offset to selection list field must be specified.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSPLFSEL">Spooled File Selection List Entry 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 spooled file selection list entry</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">Offset to next spooled file selection list entry</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">Include or omit</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Selection criteria format</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to selection criteria</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to new attributes</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Include or omit.</strong> Whether the spooled files selected
by this entry are included or omitted from the save operation. Omit takes
precedence over include. 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">Spooled files that match all of the values
specified in the selection criteria are omitted from the save operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Spooled files that match all of the values
specified in the selection criteria are included in the save operation,
unless another entry omits them.
At least one entry must have this value.</td>
</tr>
</table>
<p><strong>Length of spooled file selection list entry.</strong> The length of the
spooled file selection list entry information. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>20</em></td>
<td align="left" valign="top">The selection list entry ends with the
offset to selection criteria field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>24</em></td>
<td align="left" valign="top">The selection list entry ends with the
offset to new attributes field.</td>
</tr>
</table>
<p><strong>Offset to new attributes.</strong> The
offset from the start of the user space to the new attributes
for the spooled files included by this selection list entry.
The value must be 0 if the Include or omit field value is 0.
For the format of the new attributes, see
<a href="#HDRNEWATTRS">New Attributes Format</a>.</p>
<p><strong>Offset to next spooled file selection list entry.</strong> The
offset from the start of the user space to the next
spooled file selection list entry.
The value must be 0 for the last entry in the list.</p>
<p><strong>Offset to selection criteria.</strong> The
offset from the start of the user space to the selection criteria.</p>
<p><strong>Selection criteria format.</strong> The format of the
spooled file selection criteria. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The selection criteria is specified by the
<a href="#HDRSPLFID">Spooled File ID Format</a>. This format identifies
exactly one spooled file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The selection criteria is specified by the
<a href="#HDRSPLFATTRS">Spooled File Attributes Format</a>. This format
identifies any number of spooled files.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSPLFID">Spooled File ID Format</a></h3>
<p>This is the format of the spooled file selection criteria
when a value of 1 is specified for the
selection criteria format field.
The criteria specified must uniquely
identify a single spooled file.</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">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of Spooled file ID</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%">CHAR(26)</td>
<td align="left" valign="top" width="60%">Qualified job name</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file name</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Spooled file number</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Creation date</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="center" valign="top">3B</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Creation time</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Creation date.</strong> The date the spooled file
was created. This value is considered after the qualified
job name, spooled file name, spooled file number, and job system name
values. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LAST</em></td>
<td align="left" valign="top">The spooled file with the latest creation
date and time for the specified qualified job name, spooled file name,
spooled file number, and job system name is selected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">There is only one spooled file with the
specified qualified job name, spooled file name, spooled file number,
and job system name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Date</em></td>
<td align="left" valign="top">The date the spooled file was created,
in the format CYYMMDD:
<dl compact>
<dt><em>C</em></dt>
<dd>Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.<br><br></dd>
<dt><em>YY</em></dt>
<dd>Year<br><br></dd>
<dt><em>MM</em></dt>
<dd>Month<br><br></dd>
<dt><em>DD</em></dt>
<dd>Day</dd>
</dl>
</td>
</tr>
</table>
<p><strong>Creation time.</strong> The time the spooled file
was created. This field must be set to blanks if *LAST or
*ONLY is specified for creation date. This value
is considered after the qualified job name, spooled file name,
spooled file number, job system name, and creation date
values. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LAST</em></td>
<td align="left" valign="top">The spooled file with the latest creation
time for the specified qualified job name, spooled file name, spooled file
number, job system name, and creation date is selected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">There is only one spooled file with the
specified qualified job name, spooled file name, spooled file number,
job system name, and creation date.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Time</em></td>
<td align="left" valign="top">The time the spooled file was created,
in the format HHMMSS:
<dl compact>
<dt><em>HH</em></dt>
<dd>Hour</dd>
<dt><em>MM</em></dt>
<dd>Minute</dd>
<dt><em>SS</em></dt>
<dd>Second</dd>
</dl>
</td>
</tr>
</table>
<p><strong>Job system name.</strong> The name of the system where the
job that owns the spooled file ran. This value is
considered after the qualified job name, spooled file name, and spooled
file number values. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">There is only one spooled file with the
specified qualified job name, spooled file name, spooled file number,
creation date, and creation time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">The spooled file created on the current
system with the specified qualified job name, spooled file name,
spooled file number, creation date, and creation time is selected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The job system name is not considered when
selecting a spooled file. Use this value when you want the creation
date and creation time values to take precedence over
the job system name when selecting a spooled file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>System name</em></td>
<td align="left" valign="top">The name of the system where the job that
owns the spooled file ran.</td>
</tr>
</table>
<p><strong>Length of spooled file ID.</strong> The length of the
spooled file ID information. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>65</em></td>
<td align="left" valign="top">The spooled file ID ends with
the creation time field.</td>
</tr>
</table>
<p><strong>Qualified job name.</strong> The name of the job that owns
the spooled file. The qualified job name has three parts:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top">Job name</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">A specific job name or the following special
value:<br>
* Current job. The rest of the qualified job name must be blank.</td>
</tr>
<tr>
<td align="left" valign="top">User name</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">A specific user profile name or blanks when
the job name is *.</td>
</tr>
<tr>
<td align="left" valign="top">Job number</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">A specific job number or blanks when
the job name is *.</td>
</tr>
</table>
<p><strong>Spooled file name.</strong> The name of the spooled file.</p>
<p><strong>Spooled file number.</strong> The unique number of the
spooled file. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is only one spooled file with the
specified qualified job name and spooled file name. (*ONLY)</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The spooled file with the highest number
for the specified qualified job name and spooled file name
is selected. (*LAST)</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">The spooled file number is not considered
when selecting a spooled file. Use this value when you want the system name
value or spooled file create date and spooled file create time values to
take precedence over the spooled file number when selecting a spooled file.
(*ANY)</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-999999</em></td>
<td align="left" valign="top">The number of the spooled file for the
specified qualified job name and spooled file name.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSPLFATTRS">Spooled File Attributes Format</a></h3>
<p>This is the format of the spooled file selection criteria
when a value of 2 is specified for the
selection criteria format field.</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 spooled file attributes</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Qualified output queue</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Spooled file name</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 name</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="center" valign="top">36</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User-specified data</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="center" valign="top">46</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Job system name</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="center" valign="top">4E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Form type</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Starting creation date and time</td>
</tr>
<tr>
<td align="center" valign="top">101</td>
<td align="center" valign="top">65</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Ending creation date and time</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Ending creation date and time.</strong> Spooled files with a
creation date and time less than or equal to this date and time are
selected. The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Ending creation date and time are not used
to select spooled files.</td>
</tr>
</table>
<p>The date and time must be specified in the format CYYMMDDHHMMSS:</p>
<dl compact>
<dt><em>C</em></dt>
<dd>Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.<br><br></dd>
<dt><em>YY</em></dt>
<dd>Year<br><br></dd>
<dt><em>MM</em></dt>
<dd>Month<br><br></dd>
<dt><em>DD</em></dt>
<dd>Day</dd>
<dt><em>HH</em></dt>
<dd>Hour</dd>
<dt><em>MM</em></dt>
<dd>Minute</dd>
<dt><em>SS</em></dt>
<dd>Second</dd>
</dl>
<p><strong>Form type.</strong> Spooled files with this form type are
selected. Either a specific value or generic value may be specified.
The default is *ALL. The following special values are allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files with any form
type are selected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STD</em></td>
<td align="left" valign="top">Spooled files that specify the standard form
type are selected.</td>
</tr>
</table>
<p><strong>Job name.</strong> Spooled files owned by this job are
selected. Either a specific name or generic name may be specified.
The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files owned by any job
are selected.</td>
</tr>
</table>
<p><strong>Job number.</strong> Spooled files owned by a job with
this job number are selected. If a job number is specified, then
a specific job name and a specific user name must also be specified.
The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files owned by a job with
any job number are selected.</td>
</tr>
</table>
<p><strong>Job system name.</strong> Spooled files owned by a job on
this system are selected.
Either a specific name or generic name may be specified.
The default is *ALL. The following special values are allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files created on
any system are selected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">Spooled files owned by a job on
the current system are selected.</td>
</tr>
</table>
<p><strong>Length of spooled file attributes.</strong> The length of the
spooled file data attributes information. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>24</em></td>
<td align="left" valign="top">The spooled file attributes end with
the qualified output queue field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>34</em></td>
<td align="left" valign="top">The spooled file attributes end with
the spooled file name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>44</em></td>
<td align="left" valign="top">The spooled file attributes end with
the job name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>54</em></td>
<td align="left" valign="top">The spooled file attributes end with
the user name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>60</em></td>
<td align="left" valign="top">The spooled file attributes end with
the job number field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>70</em></td>
<td align="left" valign="top">The spooled file attributes end with
the user-specified data field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>78</em></td>
<td align="left" valign="top">The spooled file attributes end with
the job system name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>88</em></td>
<td align="left" valign="top">The spooled file attributes end with
the form type field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>101</em></td>
<td align="left" valign="top">The spooled file attributes end with
the starting creation date and time field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>114</em></td>
<td align="left" valign="top">The spooled file attributes end with
the ending creation date and time field.</td>
</tr>
</table>
<p><strong>Qualified output queue.</strong> Spooled files on this
output queue are selected, if they are found in the ASPs
specified for the ASP device key.
The qualified output queue has two parts:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">Object name</td>
<td align="left" valign="top">CHAR(10). A specific or generic
output queue name or the following special value:
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files on all
output queues that satisfy the library name are selected.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Library name</td>
<td align="left" valign="top">CHAR(10). A specific or generic
library name, or one of the following special values:
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All libraries.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.
If no library is specified as the current library for the job, the
QGPL library is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The libraries in the library list.</td>
</tr>
</table>
</td>
</tr>
</table>
<p><strong>Spooled file name.</strong> Spooled files with this name are
selected. Either a specific name or generic name may be specified.
The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files with any name
are selected.</td>
</tr>
</table>
<p><strong>Starting creation date and time.</strong> Spooled files with a
creation date and time greater than or equal to this date and time are
selected. The default is *ALL.
The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Starting creation date and time are not used
to select spooled files.</td>
</tr>
</table>
<p>The date and time must be specified in the format CYYMMDDHHMMSS:</p>
<dl compact>
<dt><em>C</em></dt>
<dd>Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.<br><br></dd>
<dt><em>YY</em></dt>
<dd>Year<br><br></dd>
<dt><em>MM</em></dt>
<dd>Month<br><br></dd>
<dt><em>DD</em></dt>
<dd>Day</dd>
<dt><em>HH</em></dt>
<dd>Hour</dd>
<dt><em>MM</em></dt>
<dd>Minute</dd>
<dt><em>SS</em></dt>
<dd>Second</dd>
</dl>
<p><strong>User name.</strong> Spooled files owned by this user
are selected. Either a specific name or generic name may be specified.
The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files with any user
are selected.</td>
</tr>
</table>
<p><strong>User-specified data.</strong> Spooled files with this
user-specified data value are selected.
Either a specific value or generic value may be specified.
The default is *ALL. The following special value is allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Spooled files with any user-specified
data value are selected.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRNEWATTRS">New Attributes Format</a></h3>
<p>This is the format of new attributes to be assigned
to the selected spooled files.</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">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of new attributes</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">Expiration days</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Expiration days.</strong> The number of days from
the start of the operation when the selected spooled files
will expire. The expiration date will be set for the spooled
files on the system after they have been successfully saved.
The default is 0.</p>
<p><strong>Note:</strong> The user needs additional
authority to use any value other than 0. The default value of 0
will be used for any spooled files which the user is not
authorized to change. The user is authorized to change the
expiration date of a spooled file if any of the following
conditions are met.</p>
<ul>
<li>The user owns the spooled file.</li>
<li>The user has spool control (*SPLCTL) special authority.</li>
<li>The user has job control (*JOBCTL) special authority, and
the output queue on which the spooled file resides is
specified as OPRCTL(*YES).</li>
<li>The user owns the output queue on which the spooled file resides,
and the output queue is specified as AUTCHK(*OWNER).</li>
<li>The user has read, add, and delete authorities to
the output queue on which the spooled file resides,
and the output queue is specified as AUTCHK(*DTAAUT).</li>
</ul>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The expiration date for the selected
spooled files will be set to *NONE (no expiration date).</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The expiration date for the selected
spooled files will not be changed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-366</em></td>
<td align="left" valign="top">The expiration date for the selected
spooled files will set to the number of days specified past the date
that the save operation begins.</td>
</tr>
</table>
<p><strong>Length of new attributes.</strong> The length
of the new attributes information. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">The new attributes end with
the expiration days field.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<br>
<br>
<h3><a name="HDRVOLKEY">Volume Identifier 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each volume identifier.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of volume identifier</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Volume identifier</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<strong>Length of volume identifier.</strong> The character length of the
identifier of the volume. The possible value is:
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The size of a single volume identifier. The
maximum size of a tape<!-- or diskette--> volume identifier is 6 characters. The
maximum size of an optical volume identifier is 32 characters. If a volume
identifier larger than the maximum size is entered for this key, it is
truncated to the maximum size. If the volume identifier is *MOUNTED, this value
must be 8.</td>
</tr>
</table>
<p><strong>Number in array.</strong> The number of volume identifiers used
during the save operation. The possible values are 1 through 75.</p>
<p><strong>Volume identifier.</strong> The identifier of a volume. The possible
values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MOUNTED</em></td>
<td align="left" valign="top">The volume currently placed in the device is
used. If *MOUNTED is specified, it must be the only value specified. This value
cannot be specified for an optical media library device. *MOUNTED cannot be
specified for a tape media library device unless a category is set with the Set
Tape Category (SETTAPCGY) command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Volume identifier</em></td>
<td align="left" valign="top">The identifier of a volume.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRKEYDPD">Dependencies between Keys</a></h3>
<p>The following two tables list the dependencies between the different keys.
If the dependency holds only for a certain value, then that value is also shown
(key&nbsp;=&nbsp;<em>n</em>, where <em>n</em> is the value). Otherwise, if the
dependency is true for all values of the key, then only the name of the key is
given.</p>
<p>The following table lists the conditions where specifying a certain key
forces the use of another key.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">If you specify...</th>
<th align="left" valign="top">...must be specified</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Multiple library names or generic
library</td>
<td align="left" valign="top" width="50%">Object name = *ALL</td>
</tr>
<tr>
<td align="left" valign="top">Device = tape device</td>
<td align="left" valign="top">Volume identifier <sup>1</sup><br>
Sequence number <sup>1</sup><br>
Label <sup>1</sup><br>
Expiration date <sup>1</sup><br>
End of media option <sup>1</sup></td>
</tr>
<!-- <tr>
<td align="left" valign="top">Device = diskette device</td>
<td align="left" valign="top">Volume identifier <sup>1</sup><br>
Label <sup>1</sup><br>
Expiration date <sup>1</sup></td>
</tr> -->
<tr>
<td align="left" valign="top">Device = optical device</td>
<td align="left" valign="top">Volume identifier<br>
Optical file <sup>1</sup><br>
Expiration date <sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">Device = media definition</td>
<td align="left" valign="top">Media definition</td>
</tr>
<tr>
<td align="left" valign="top">Output = 1</td>
<td align="left" valign="top">Type of output information <sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">Output = 2</td>
<td align="left" valign="top">Output file<br>
Output member <sup>1</sup><br>
Type of output information <sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">Save while active = 1, 2, or 3</td>
<td align="left" valign="top">
Save while active wait time for object locks <sup>1</sup><br>
Save while active wait time for pending record changes <sup>1</sup><br>
Save while active wait time for other pending changes <sup>1</sup><br>
Save while active message queue <sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">Storage = 1</td>
<td align="left" valign="top">Save while active = 0 <sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">Object type = *USRPRF</td>
<td align="left" valign="top">Library = QSYS<br>
Label = QFILEUPR<sup>1</sup></td>
</tr>
<tr>
<td align="left" valign="top">
<img src="delta.gif" alt="Start of change">Library name = *SPLF</td>
<td align="left" valign="top">Object name = *ALL<sup>1</sup><br>
Object type = *ALL<sup>1</sup><br>
Spooled file data = 2</td>
</tr>
<tr>
<td align="left" valign="top">Library name &lt;&gt; *SPLF</td>
<td align="left" valign="top">Spooled file data = 0<sup>1</sup> or 1
<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Notes:</strong>
<ol type="1">
<li>This key does not have to be explicitly specified. The default may be taken
to satisfy this dependency.</li>
</ol>
</td>
</tr>
</table>
<p>The following table lists the conditions where specifying a certain key
excludes the user from using another key, or a particular value of that
key.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">If you specify...</th>
<th align="left" valign="top">...cannot be specified</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Save file</td>
<td align="left" valign="top" width="50%">Volume identifier<br>
Sequence number<br>
Label<br>
Expiration date<br>
End of media option<br>
Clear = 2<br>
Optical file<br>
Use optimum block size<br>
Media definition</td>
</tr>
<tr>
<td align="left" valign="top">Media definition</td>
<td align="left" valign="top">Volume identifier<br>
Sequence number<br>
Optical file<!--<br>
Target release = release earlier than<br>
<br>
<br>
<br>
Version 4 Release 4--></td>
</tr>
<tr>
<td align="left" valign="top">Tape,<!-- diskette,--> optical, or media<br>
definition for the device</td>
<td align="left" valign="top">Save file</td>
</tr>
<tr>
<td align="left" valign="top">Save while active = 0</td>
<td align="left" valign="top">
Save while active wait time for object locks<br>
Save while active wait time for pending record changes<br>
Save while active wait time for other pending changes<br>
Save while active message queue</td>
</tr>
<tr>
<td align="left" valign="top">Output = 0</td>
<td align="left" valign="top">Output file<br>
Output member<br>
Type of output information</td>
</tr>
<tr>
<td align="left" valign="top">Optical file</td>
<td align="left" valign="top">Label<br>
Use optimum block size<!--<br>
Target release = release earlier than<br>
&nbsp;&nbsp;&nbsp;Version 3 Release 7--></td>
</tr>
<tr>
<td align="left" valign="top">Object type = *USRPRF</td>
<td align="left" valign="top">Any other object type<br>
Save while active<br>
Save while active wait time for object locks<br>
Save while active wait time for pending record changes<br>
Save while active wait time for other pending changes<br>
Save while active message queue<br>
File member<br>
<img src="delta.gif" alt="Start of change">Queue data<img src="deltaend.gif" alt="End of change"><br>
Save access paths<br>
Save file data<br>
<img src="delta.gif" alt="Start of change">Spooled file data<img src="deltaend.gif" alt="End of change"><br>
Storage<br>
Omit library<br>
Media definition<!--<br>
Target release = release earlier
than<br>
&nbsp;&nbsp;&nbsp;Version 5 Release 1--></td>
</tr>
<tr>
<td align="left" valign="top">
Save while active wait time for pending record changes = -3</td>
<td align="left" valign="top"> Target release = release earlier than<br>
&nbsp;&nbsp;&nbsp;Version 5 Release 3</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">
Spooled file data &lt;&gt; 0</td>
<td align="left" valign="top">
Target release = release earlier than<br>
&nbsp;&nbsp;&nbsp;Version 5 Release 4</td>
</tr>
<tr>
<td align="left" valign="top">Queue data = 1</td>
<td align="left" valign="top">
Target release = release earlier than<br>
&nbsp;&nbsp;&nbsp;Version 5 Release 4
<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
<h3>Relationship to SAVOBJ and SAVSECDTA Commands</h3>
<p>Because of the relationship between the QSRSAVO API and the SAVOBJ and
SAVSECDTA commands, the following situations should be noted:</p>
<ul>
<li>Message text: Several messages produced by this API refer to parameters or
values of the SAVOBJ command (for example, *AFTER). To determine which key a
given parameter corresponds to, see <a href="#HDRKEYFLD">Valid Keys</a>. To
determine which key value a given parameter value corresponds to, see <a href=
"#HDRSOLDESC">Field Descriptions</a>.</li>
<li>Command type: The command type listed for the API on headings of displays
and print files is SAVOBJ or SAVSECDTA, not QSRSAVO.</li>
<li>This API can be used to save one or more user profiles. It does not save
other objects that are saved by the SAVSECDTA command, such as authorization
lists and authority holders. The saved user profiles must be restored with the
RSTUSRPRF command.</li>
<li>This API can be used to save
user profiles for a previous release; the SAVSECDTA command saves user profiles
for the current release only. When a user profile is saved for a previous
release, the interactive profile section of the user profile which contains
session settings and product level information, is not saved.</li>
</ul>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF222E E</td>
<td align="left" valign="top" width="85%">&amp;1 special authority is required.</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">CPF3700 E</td>
<td align="left" valign="top">All CPF37xx messages could be signalled. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3800 E</td>
<td align="left" valign="top">All CPF38xx messages could be signalled. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C31 E</td>
<td align="left" valign="top">Object type &amp;1 is 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">CPF3C83 E</td>
<td align="left" valign="top">Key &amp;1 not allowed with value specified for
key &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C84 E</td>
<td align="left" valign="top">Key &amp;1 required with value specified for key
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C85 E</td>
<td align="left" valign="top">Value for key &amp;1 not allowed with value for
key &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C86 E</td>
<td align="left" valign="top">Required key &amp;1 not specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C87 E</td>
<td align="left" valign="top">Key &amp;1 allows one value with special
value.</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">CPF5729 E</td>
<td align="left" valign="top">Not able to allocate object &amp;1.</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>
<tr>
<td align="left" valign="top">CPFB8ED E</td>
<td align="left" valign="top">Device description &amp;1 not correct for
operation.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R1
<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=
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink