ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/rstdlo.htm

976 lines
39 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Restore Document Lib Object (RSTDLO)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="RSTDLO.Top_Of_Page"></a>
<h2>Restore Document Lib Object (RSTDLO)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#RSTDLO.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RSTDLO.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RSTDLO.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RSTDLO"></a>
<p>The Restore Document Library Object (RSTDLO) command restores documents, folders, and distribution objects (mail).
</p>
<p>This command can be used to restore the documents and folders if the document was or was not freed by the Save Document Library Object (SAVDLO) command, or to restore documents and folders that were deleted by the Delete Document Library Object (DLTDLO) command.
</p>
<p>Restoring a document either replaces the existing document content and control information if the document exists on the system, or it adds new document content and control information if the document does not exist.
</p>
<p>For a filed document (electronic mail or a document stored in the document library), the document and folder name of the document object on the media must be the same as the document name and folder name of the document on the system, unless the document is renamed and put in a different folder during the restore operation.
</p>
<p>
<b>Note: </b>Folder names must match exactly for restored folders. All objects that are not in use are restored from the folder on the media or in the save file to the existing folder. Restoring a folder creates a new folder object if the folder does not exist and adds to this new folder all objects saved with the folder on the media or in the save file. If the folder exists, any document or folder objects that do not exist within it are created. The existing documents are replaced with the version from the media.
</p>
<p>For a filed document restored on the system whose owner is not known to the system or is not enrolled in the system distribution directory, the user profile of the default owner (QDFTOWN) becomes the owner of the document or folder.
</p>
<p>The creation date of a document does not change if the document exists. If the document does not exist, the creation date is set to the date on which the document is created.
</p>
<p>The security does not change if a document or folder exists on the system where it is to be restored. If the document or folder does not exist, public authority, authorization list, and personal status are restored; however, all other private document and folder authorities are not restored. These authorities must be established again by the owner.
</p>
<p>If a document is restored that had a mail log entry when it was saved, the mail log entry is restored if the distribution tracking object exists on the system. If the distribution tracking object does not exist on the system, a message is sent saying that the document was restored without a mail log entry.
</p>
<p>If this command ends abnormally, objects are left on the system in an unknown state and cannot be found in a library. This can happen if a power failure occurs when this command is run. The Reclaim Storage (RCLSTG) command can be used to clean up the auxiliary storage and delete most of those objects from the system; however, unknown mail objects are not cleaned up with the RCLSTG command.
</p>
<p>When a set of documents and folders are restored, all documents and folders in the set must exist in the same tape, optical volume, or save file.
</p>
<p>If a document exists in more than one tape file, the user can control which document is restored by specifying the media file using the sequence number or label parameter. If more than one version of the document exists, the SAVDATE and SAVTIME parameters can also be used to select the correct document.
</p>
<p>When text search services are on the system and the user restores a document library object, the text search index for the object is restored.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>This command is shipped with no public authority (*EXCLUDE).
</li>
<li>You must have save system (*SAVSYS) or all object (*ALLOBJ) special authority or be enrolled in the system distribution directory to run this command.
</li>
<li>This command cannot be run when RCLDLO DLO(*ALL) is running because RCLDLO requires exclusive use of internal objects.
</li>
<li>When saving or restoring to an existing database file using the OUTFILE parameter, you must have execute (*EXECUTE) authority to the library where the output database file is located.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RSTDLO.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.DLO"><b>DLO</b></a></td>
<td valign="top">Document library object</td>
<td valign="top">Single values: *ALL, *SYSOBJNAM, *MAIL<br>Other values (up to 300 repetitions): <i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.SAVFLR"><b>SAVFLR</b></a></td>
<td valign="top">Saved folder</td>
<td valign="top">Single values: <b><u>*ANY</u></b>, *NONE<br>Other values (up to 300 repetitions): <i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.RENAME"><b>RENAME</b></a></td>
<td valign="top">New object name</td>
<td valign="top">Single values: <b><u>*SAME</u></b><br>Other values (up to 300 repetitions): <i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.RSTFLR"><b>RSTFLR</b></a></td>
<td valign="top">Restore into folder</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.DEV"><b>DEV</b></a></td>
<td valign="top">Device</td>
<td valign="top">Single values: *SAVF<br>Other values (up to 4 repetitions): <i>Name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.SYSOBJNAM"><b>SYSOBJNAM</b></a></td>
<td valign="top">System object name</td>
<td valign="top">Values (up to 300 repetitions): <i>Name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top">Single values: <b><u>*MOUNTED</u></b><br>Other values (up to 75 repetitions): <i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RSTDLO.SEQNBR"><b>SEQNBR</b></a></td>
<td valign="top">Sequence number</td>
<td valign="top">Single values: <b><u>*SEARCH</u></b><br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Beginning sequence number</td>
<td valign="top">
1-16777215</td>
</tr>
<tr>
<td valign="top">Element 2: Ending sequence number</td>
<td valign="top">
1-16777215, <b><u>*ONLY</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.ENDOPT"><b>ENDOPT</b></a></td>
<td valign="top">End of media option</td>
<td valign="top"><b><u>*REWIND</u></b>, *LEAVE, *UNLOAD</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.LABEL"><b>LABEL</b></a></td>
<td valign="top">Label</td>
<td valign="top"><i>Character value</i>, <b><u>*GEN</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RSTDLO.SAVF"><b>SAVF</b></a></td>
<td valign="top">Save file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Save file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#RSTDLO.OPTFILE"><b>OPTFILE</b></a></td>
<td valign="top">Optical file</td>
<td valign="top"><i>Path name</i>, <b><u>*</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.NEWOBJ"><b>NEWOBJ</b></a></td>
<td valign="top">Object name generation</td>
<td valign="top"><b><u>*SAME</u></b>, *NEW</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.SAVDATE"><b>SAVDATE</b></a></td>
<td valign="top">Date when saved</td>
<td valign="top"><i>Date</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.SAVTIME"><b>SAVTIME</b></a></td>
<td valign="top">Time when saved</td>
<td valign="top"><i>Time</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.ALWOBJDIF"><b>ALWOBJDIF</b></a></td>
<td valign="top">Allow object differences</td>
<td valign="top"><b><u>*NONE</u></b>, *ALL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.SAVASP"><b>SAVASP</b></a></td>
<td valign="top">Saved from ASP number</td>
<td valign="top">1-32, <b><u>*ANY</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.RSTASP"><b>RSTASP</b></a></td>
<td valign="top">Restore to ASP number</td>
<td valign="top">1-32, <b><u>*SAVASP</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RSTDLO.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*NONE</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RSTDLO.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#RSTDLO.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RSTDLO.DLO"></a>
<h3>Document library object (DLO)</h3>
<p>Specifies the document library objects to be restored.
</p>
<p>This is a required parameter.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All documents, folders, and distribution objects (mail) that are saved on media and meet the criteria specified for the <b>Saved folder (SAVFLR)</b> parameter are restored.
</dd>
<dt><b>*MAIL</b></dt>
<dd>All distribution objects and documents that were referred to by a mail log are restored.
</dd>
<dt><b>*SYSOBJNAM</b></dt>
<dd>All documents with the system object names specified for the <b>System object name (SYSOBJNAM)</b> parameter are restored.
</dd>
</dl>
<p><b>Other values (up to 300 repetitions)</b>
</p>
<dl>
<dt><b><i>document-name</i></b></dt>
<dd>Specify the user-assigned names of the documents to be restored. All documents named must be in the folder specified for the SAVFLR parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SAVFLR"></a>
<h3>Saved folder (SAVFLR)</h3>
<p>Specifies the name of the folder on the media from which the documents and folders are restored.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>All document library objects that meet the values specified for the <b>Document library object (DLO)</b> parameter are restored, regardless of the folders (if any) from which they were saved. This value is valid only if *ALL, *MAIL, or *SYSOBJNAM is specified for the DLO parameter.
</dd>
<dt><b>*NONE</b></dt>
<dd>All documents that were saved as documents not in any folder are restored. *NONE is valid for documents only and is valid only when *ALL is specified for the DLO parameter.
</dd>
</dl>
<p><b>Other values (up to 300 repetitions)</b>
</p>
<dl>
<dt><b><i>folder-name</i></b></dt>
<dd>Specify the name of the saved folder from which documents are to be restored, or the name of the folders to be restored if *ALL was specified for the DLO parameter. A maximum of 63 characters can be specified for the folder name. When *ALL is specified for the DLO parameter, a maximum of 300 folder names can be specified. The name of a saved folder must be specified when DLO(document-name) is specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.RENAME"></a>
<h3>New object name (RENAME)</h3>
<p>Specifies the new user-assigned name for the restored document.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The documents are restored with the names they had when they were saved.
</dd>
</dl>
<p><b>Other values (up to 300 repetitions)</b>
</p>
<dl>
<dt><b><i>document-name</i></b></dt>
<dd>Specify the new user-assigned names that the documents have after being restored. When document names are specified for the <b>Document library object (DLO)</b> parameter, a maximum of 300 user-assigned names can be specified for documents being restored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.RSTFLR"></a>
<h3>Restore into folder (RSTFLR)</h3>
<p>Specifies the name of the folder in which the restored folders and documents to be restored will be placed. The folder must exist on the system or when *ALL is specified for the <b>Document library object (DLO)</b> parameter, the saved folder must exist on the media.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The folders and documents to be restored are placed into the same folder from which they were saved.
</dd>
<dt><b><i>folder-name</i></b></dt>
<dd>Specify the name of the folder where the restored documents and folders are to be placed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.DEV"></a>
<h3>Device (DEV)</h3>
<p>Specifies the name of the device used for the restore operation. The device name must already be known on the system by a device description.
</p>
<p>This is a required parameter.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*SAVF</b></dt>
<dd>The restore operation is done using the save file specified for the <b>Save file (SAVF)</b> parameter.
</dd>
</dl>
<p><b>Other values</b>
</p>
<dl>
<dt><b><i>optical-device-name</i></b></dt>
<dd>Specify the name of the optical device used for the restore operation.
</dd>
</dl>
<dl>
<dt><b><i>tape-media-library-device-name</i></b></dt>
<dd>Specify the name of the tape media library device used for the restore operation.
</dd>
</dl>
<dl>
<dt><b><i>tape-device-name</i></b></dt>
<dd>Specify the names of one or more tape devices used for the restore operation. If a virtual tape device is used, it must be the only device specified. If you are using more than one tape device (up to a maximum of four), specify the names of the devices in the order in which they are used. When more than one tape volume is to be restored, using more than one tape device permits one tape volume to be rewound while another tape device processes the next tape volume.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SYSOBJNAM"></a>
<h3>System object name (SYSOBJNAM)</h3>
<p>Specifies the system object names of the documents to be restored if *SYSOBJNAM is specified for the <b>Document library object (DLO)</b> parameter.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>A system object name is not specified.
</dd>
</dl>
<p><b>Other values (up to 300 repetitions)</b>
</p>
<dl>
<dt><b><i>system-object-name</i></b></dt>
<dd>Specify the system object names of the documents to be restored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the volume identifiers of the media or the cartridge identifiers of tapes in a tape media library device, from which the objects are being restored. The volumes must be in the same order as they were when the data was saved. The volume that contains the beginning of the file to be restored should be placed in the device.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*MOUNTED</u></b></dt>
<dd>The objects are restored from the volumes placed in the device specified for the <b>Device (DEV)</b> parameter. For a media library device, the volume to be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY) command.
<p>
<b>Note: </b>This value cannot be specified when using an optical media library device.
</p>
</dd>
</dl>
<p><b>Other values (up to 75 repetitions)</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the identifiers of one or more volumes in the order in which they are placed in a device and used to restore the data.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SEQNBR"></a>
<h3>Sequence number (SEQNBR)</h3>
<p>Specifies the sequence numbers of the tape files used for the restore operation.
</p>
<p><b>Note:</b>When restoring document library objects (DLOs) from more than one auxiliary storage pool (ASP), a beginning and ending sequence number must be specified. The beginning and ending sequence numbers were shown in the completion message for the SAVDLO command used to create the tape media files. Or use the Display Tape (DSPTAP) command to find the sequence numbers of the QDOC and QDOCnnnn files, where nnnn is the ASP number.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SEARCH</u></b></dt>
<dd>The tape is searched for the first data file with an identifier matching the <b>Label (LABEL)</b> parameter value and with contents of a minimum of one of the specified document library objects. If the last operation on the device specified ENDOPT(*LEAVE) (that is, the tape is positioned at the location at which the last operation ended), the file search begins with the first data file beyond the current tape position. If ENDOPT(*LEAVE) was not specified on the last operation (or if the tape has been rewound since the ENDOPT(*LEAVE) operation), the search begins with the first data file on the volume.
</dd>
</dl>
<p><b>Element 1: Beginning sequence number</b>
</p>
<dl>
<dt><b><i>1-16777215</i></b></dt>
<dd>Specify the sequence number of the first file used for the restore operation.
</dd>
</dl>
<p><b>Element 2: Ending sequence number</b>
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>The ending sequence number is the same as the starting sequence number.
</dd>
<dt><b><i>1-16777215</i></b></dt>
<dd>Specify the sequence number of the last file used for the restore operation.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.ENDOPT"></a>
<h3>End of media option (ENDOPT)</h3>
<p>Specifies the operation that is automatically done on the tape or optical volume after the restore operation ends. If more than one volume is used, this parameter applies only to the last volume used; all other volumes are unloaded when the end of the volume is reached.
</p>
<p>
<b>Note: </b>This parameter is valid only if a tape or optical device name is specified for the DEV parameter. For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.
</p>
<dl>
<dt><b><u>*REWIND</u></b></dt>
<dd>The tape is automatically rewound, but not unloaded, after the operation has ended.
</dd>
</dl>
<dl>
<dt><b>*LEAVE</b></dt>
<dd>The tape does not rewind or unload after the operation ends. It remains at the current position on the tape drive.
</dd>
</dl>
<dl>
<dt><b>*UNLOAD</b></dt>
<dd>The tape is automatically rewound and unloaded after the operation ends. Some optical devices will eject the volume after the operation ends.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.LABEL"></a>
<h3>Label (LABEL)</h3>
<p>Specifies the file label used to find the file that was written onto the media during the save operation.
</p>
<dl>
<dt><b><u>*GEN</u></b></dt>
<dd>The system generates the default name of the file label for which to search.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the file label of the file that contains the document library objects to be restored. A maximum of 17 alphanumeric characters can be used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SAVF"></a>
<h3>Save file (SAVF)</h3>
<p>Specifies the save file used to restore the data.
</p>
<p>
<b>Note: </b>A value must be specified for this parameter if *SAVF is specified for the <b>Device (DEV)</b> parameter.
</p>
<p><b>Qualifier 1: Save file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of save file to be used.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is used to locate the save file. If no current library entry exists in the library list, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the save file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.OPTFILE"></a>
<h3>Optical file (OPTFILE)</h3>
<p>Specifies the path name of the optical file that is used for the restore operation, beginning with the root directory of the volume.
</p>
<p>For more information on specifying path names, refer to "Object naming rules" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The system searches the root directory of the optical volume for the default name generated by the corresponding save operation.
</dd>
<dt><b><i>'optical-directory-path-name/*'</i></b></dt>
<dd>The system searches the specified directory of the optical volume for the default name generated by the corresponding save operation.
</dd>
</dl>
<dl>
<dt><b><i>'optical-file-path-name'</i></b></dt>
<dd>Specify the path name of the optical file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.NEWOBJ"></a>
<h3>Object name generation (NEWOBJ)</h3>
<p>Specifies whether a new library-assigned name and system object name are generated for the folders and documents that are restored.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The library-assigned name and system object name do not change.
</dd>
<dt><b>*NEW</b></dt>
<dd>A new library-assigned name and system object name are generated for each document or folder that is restored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SAVDATE"></a>
<h3>Date when saved (SAVDATE)</h3>
<p>Specifies the date on which the document library objects were saved. If more than one version of the document library objects exist on the media, use this parameter to identify which version of the document library objects to restore. The date must be specified in the job date format. If separators are used, the value must be enclosed in apostrophes. If the SAVDATE parameter is not specified, the version of the documents and folders to be restored will be the first version found on the volume or the version found with the specified file label.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SAVTIME"></a>
<h3>Time when saved (SAVTIME)</h3>
<p>Specifies the time when the document library objects were saved. If more than one version of the document library objects exist on the media with the same value for the date saved, use this parameter to identify which version of the document library objects to restore. Specify the time as a 6-digit value, in the format hours, minutes, seconds (hhmmss). If separators are used, the value must be enclosed in apostrophes ('hh:mm:ss'). If a volume identifier is specified, but the <b>Time when saved (SAVTIME)</b> parameter is not specified, the version of the document library objects to be restored will be the first version found on the volume or the first version found with the specified file label.
</p>
<p>This parameter is valid only if the <b>Date when saved (SAVDATE)</b> parameter is specified also.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.ALWOBJDIF"></a>
<h3>Allow object differences (ALWOBJDIF)</h3>
<p>Specifies whether the following differences encountered during a restore operation are allowed.
</p>
<ul>
<li>Ownership--the owner of the object on the system is different than the owner of the object from the save operation.
</li>
<li>System object name--the system object name on the system does not match the system object name on the media.
</li>
<li>Authorization list linking--the object is being restored to a system different from the one on which it was saved.
</li>
</ul>
<p>The ALWOBJDIF parameter can be used to allow an object to be restored whose owner or object name on the system is different than on the media used for the restore operation. By specifying the *ALL special value, an object with a different name is restored to the name on the media, while an object with a different owner keeps the owner name from the system instead of the media.
</p>
<p>
<b>Note: </b>To use this parameter, you need all object (*ALLOBJ) authority.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>None of the differences described above are allowed on the restore operation. For authorization list cases, the object is restored, but the object is not linked to the authorization list, and public authority is set to *EXCLUDE. For other cases, a diagnostic message is sent for the object, and the object is not restored.
</dd>
<dt><b>*ALL</b></dt>
<dd>All of the differences described above are allowed for the restore operation. An informational message is sent, and the object is restored.
<p><b>Notes:</b>
</p>
<ul>
<li>If the owners of the object do not match, the object is restored, but it will keep the ownership and authorities of the object on the system before the restore operation.
</li>
<li>If *ALL is specified on this parameter, *NEW cannot be specified for the <b>Object name generation (NEWOBJ)</b> parameter.
</li>
<li>If you are restoring objects to a system different from the one on which they were saved and the objects are secured by an authorization list, specifying *ALL automatically links the objects to the authorization list. If the authorization list does not exist on the new system, a message that includes the name of the missing list is issued.
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.SAVASP"></a>
<h3>Saved from ASP number (SAVASP)</h3>
<p>Specifies the number of the auxiliary storage pool (ASP) on media from which saved documents and folders are to be restored.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The documents and folders saved in any ASP are restored.
<p><b>Note:</b>When restoring document library objects (DLOs) from more than one ASP, the sequence number (SEQNBR) parameter must be specified.
</p>
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Specify the number of the ASP from which documents and folders are restored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.RSTASP"></a>
<h3>Restore to ASP number (RSTASP)</h3>
<p>Specifies the number of the auxiliary storage pool (ASP) on media in which restored documents and folders are to be placed.
</p>
<dl>
<dt><b><u>*SAVASP</u></b></dt>
<dd>The documents and folders are placed in the same ASP from which they were saved.
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Specify the number of the ASP in which restored documents and folders are placed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether a listing that shows information about the status of the objects is created and directed to an output file. The listing shows the restore information and shows all objects restored, not restored, and excluded. Information about each object's security is listed for the restored objects.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No output is created.
</dd>
</dl>
<dl>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
<dl>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database file specified for the <b>File to receive output (OUTFILE)</b> parameter.
</dd>
</dl>
<dl>
<dt><b></b></dt>
<dd>
<p>
<b>Note: </b>You must specify a database file name for the OUTFILE parameter when OUTPUT(*OUTFILE) is specified.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the qualified name of the database file to which the information about the object is directed when *OUTFILE is specified for the <b>Output (OUTPUT)</b> parameter. If the file does not exist, this command creates a database file in the specified library. If a new file is created, the system uses QAOJRSTO in QSYS with the format name QOJRST as a model.
</p>
<p><b>Qualifier 1: File to receive output</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the database file to which output from the command is directed. If this file does not exist, it is created in the specified library.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is used to locate the file. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RSTDLO.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output is directed when *OUTFILE is specified for the <b>Output (OUTPUT)</b> parameter.
</p>
<p><b>Element 1: Member to receive output</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified for the <b>File to receive output (OUTFILE)</b> parameter.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the system creates it.
<p>If the member exists, you can add records to the end of the existing member or clear the existing member and add the records.
</p>
</dd>
</dl>
<p><b>Element 2: Replace or add records</b>
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The existing records in the specified database file member are replaced by the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The new records are added to the existing information in the specified database file member.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RSTDLO.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Restoring Documents with System Object Names</b>
</p>
<p>
<pre>
RSTDLO DLO(*SYSOBJNAM) DEV(TAP01) SYSOBJNAM(HZ83B55219)
</pre>
</p>
<p>This command restores the document named HZ83B55219 from the tape unit TAP01.
</p>
<p><b>Example 2: Restoring Documents from a Save Folder</b>
</p>
<p>
<pre>
RSTDLO DLO(A) DEV(TAP01) SAVFLR(X)
</pre>
</p>
<p>This command restores the document named A from folder X.
</p>
<p><b>Example 3: Restoring All Documents</b>
</p>
<p>
<pre>
RSTDLO DLO(*ALL) DEV(TAP01)
</pre>
</p>
<p>This command restores all documents and folders that are on the first tape file on tape unit TAP01.
</p>
<p><b>Example 4: Restoring a Folder Saved from the System ASP to a User ASP</b>
</p>
<p>
<pre>
RSTDLO DLO(*ALL) FLR(Y) SAVASP(1) RSTASP(2)
</pre>
</p>
<p>This command restores folder Y, which was saved from ASP 1, to user ASP 2. Folder Y must be deleted from ASP 1 before it can be restored to ASP 2.
</p>
<p><b>Example 5: Creating New Library-Assigned Name</b>
</p>
<p>
<pre>
RSTDLO DLO(*SYSOBJNAM) DEV(TAP01) SYSOBJNAM(HZ83B55219)
NEWOBJ(*NEW)
</pre>
</p>
<p>This command restores document HZ83B55219 from tape unit TAP01 and gives it a new library-assigned name and a new system object name.
</p>
<p><b>Example 6: Renaming Documents</b>
</p>
<p>
<pre>
RSTDLO DLO(A B) DEV(TAP01) SAVFLR(C)
RENAME(Y Z) RSTFLR(X)
</pre>
</p>
<p>This command restores documents A and B from within folder C. Document A is renamed to Y and document B is renamed to Z. The command then puts them in folder X.
</p>
<p><b>Example 7: Specifying Sequence Numbers</b>
</p>
<p>
<pre>
RSTDLO DLO(*ALL) DEV(tape-device-name) SAVFLR(A)
SEQNBR(1 3) LABEL(*GEN)
</pre>
</p>
<p>This command restores all of folder A from tape files with the sequence numbers 1, 2, and 3, and the label QDOC or QDOCxxxx.
</p>
<p><b>Example 8: Specifying Allowed Differences</b>
</p>
<p>
<pre>
RSTDLO DLO(A) DEV(TAP01) SAVFLR(X) ALWOBJDIF(*ALL)
</pre>
</p>
<p>This command restores document A from folder X. If document A in folder X exists on the system and the owner of the document on the system does not match the owner of the document being restored, the document is restored and the owner of the document on the system remains unchanged.
</p>
<p><b>Example 9: Reporting Information about Objects Restored and Not Restored</b>
</p>
<p>
<pre>
RSTDLO DLO(*ALL) DEV(TAP01) OUTPUT(*OUTFILE)
OUTFILE(INFO92) OUTMBR(FOURQT *ADD)
</pre>
</p>
<p>This command restores all documents and folders from the tape device TAP01. A list reporting information about objects restored and objects not restored is directed to the output file INFO92. The output is received in the member FOURQT as an addition to existing information in the member.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RSTDLO.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF370C</b></dt>
<dd>Not authorized to ALWOBJDIF parameter.
</dd>
<dt><b>CPF3718</b></dt>
<dd>Restore command not valid for file &amp;1.
</dd>
<dt><b>CPF3728</b></dt>
<dd>Device &amp;1 specified with other devices.
</dd>
<dt><b>CPF3767</b></dt>
<dd>Device &amp;1 not found.
</dd>
<dt><b>CPF3780</b></dt>
<dd>Specified file for library &amp;1 not found.
</dd>
<dt><b>CPF3782</b></dt>
<dd>File &amp;1 in &amp;2 not a save file.
</dd>
<dt><b>CPF381B</b></dt>
<dd>No DLOs restored to ASP &amp;1.
</dd>
<dt><b>CPF3812</b></dt>
<dd>Save file &amp;1 in &amp;2 in use.
</dd>
<dt><b>CPF384D</b></dt>
<dd>Save or restore operation not allowed on ASP &amp;1.
</dd>
<dt><b>CPF8AB5</b></dt>
<dd>ASP &amp;5 is not configured.
</dd>
<dt><b>CPF8A47</b></dt>
<dd>Internal system objects in use.
</dd>
<dt><b>CPF90AF</b></dt>
<dd>RSTFLR value not allowed.
</dd>
<dt><b>CPF90A4</b></dt>
<dd>RENAME value not allowed.
</dd>
<dt><b>CPF90B4</b></dt>
<dd>&amp;1 folders restored to system, &amp;2 not restored.
</dd>
<dt><b>CPF90CD</b></dt>
<dd>Not authorized to restore distributions.
</dd>
<dt><b>CPF90CF</b></dt>
<dd>Search index data base is damaged.
</dd>
<dt><b>CPF90E0</b></dt>
<dd>Not enough authority for ALWOBJDIF(*ALL).
</dd>
<dt><b>CPF90E7</b></dt>
<dd>Document library objects not restored.
</dd>
<dt><b>CPF9003</b></dt>
<dd>&amp;1 document library objects restored. &amp;10 not restored.
</dd>
<dt><b>CPF905C</b></dt>
<dd>Error occurred trying to find a translation table.
</dd>
<dt><b>CPF9050</b></dt>
<dd>Ending sequence number not valid.
</dd>
<dt><b>CPF9069</b></dt>
<dd>User not permitted to restore into folder &amp;1.
</dd>
<dt><b>CPF908A</b></dt>
<dd>Requester &amp;1 not enrolled.
</dd>
<dt><b>CPF909B</b></dt>
<dd>&amp;1 document library objects restored. &amp;10 not restored.
</dd>
<dt><b>CPF9412</b></dt>
<dd>List of folder names not allowed with DLO parameter.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9812</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9825</b></dt>
<dd>Not authorized to device &amp;1.
</dd>
<dt><b>CPF9830</b></dt>
<dd>Cannot assign library &amp;1.
</dd>
<dt><b>CPF9831</b></dt>
<dd>Cannot assign device &amp;1.
</dd>
<dt><b>CPF9845</b></dt>
<dd>Error occurred while opening file &amp;1.
</dd>
<dt><b>CPF9846</b></dt>
<dd>Error while processing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9850</b></dt>
<dd>Override of printer file &amp;1 not allowed.
</dd>
<dt><b>CPF9851</b></dt>
<dd>Overflow value for file &amp;1 in &amp;2 too small.
</dd>
<dt><b>CPF9860</b></dt>
<dd>Error occurred during output file processing.
</dd>
<dt><b>CPF9899</b></dt>
<dd>Error occurred during processing of command.
</dd>
<dt><b>OPT1498</b></dt>
<dd>Volume name list exhausted on device &amp;1.
</dd>
<dt><b>OPT1502</b></dt>
<dd>Attempted to process past the end of a multi-volume set.
</dd>
<dt><b>OPT1605</b></dt>
<dd>Media or device error occurred.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RSTDLO.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>