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

290 lines
9.7 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>Reorganize Document Lib Object (RGZDLO)</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="RGZDLO.Top_Of_Page"></a>
<h2>Reorganize Document Lib Object (RGZDLO)</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="#RGZDLO.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RGZDLO.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RGZDLO.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RGZDLO"></a>
<p>The Reorganize Document Library Object (RGZDLO) command allows you to reorganize:
</p>
<ul>
<li>all document library objects (optionally including unfiled mail documents)
</li>
<li>all filed documents not contained in a folder
</li>
<li>all document library objects within a specified folder
</li>
<li>all unfiled mail documents
</li>
<li>an individual document library object, specified by folder name, document name, or system-object-name
</li>
</ul>
<p>When a document is reorganized, unused storage is removed.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have all object (*ALLOBJ) or security administrator (*SECADM) special authority to specify DLO(*ALL) with either FLR(*ANY) or FLR(*NONE).
</li>
<li>To reorganize a document or folder, you must have *ALLOBJ or *SECADM special authority or you must have at least change (*CHANGE) authority to the document or folder and be enrolled in the system directory.
</li>
<li>To reorganize a document or folder, you must have exclusive access.
</li>
<li>To reorganize unfiled mail documents, all document and folder activity on the system must be stopped.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RGZDLO.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="#RGZDLO.DLO"><b>DLO</b></a></td>
<td valign="top">Document library object</td>
<td valign="top"><i>Character value</i>, *ALL, *SYSOBJNAM</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RGZDLO.FLR"><b>FLR</b></a></td>
<td valign="top">Folder</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *ANY</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RGZDLO.SYSOBJNAM"><b>SYSOBJNAM</b></a></td>
<td valign="top">System object name</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RGZDLO.DAYS"><b>DAYS</b></a></td>
<td valign="top">Days since last referenced</td>
<td valign="top">0-999, <b><u>0</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RGZDLO.MAIL"><b>MAIL</b></a></td>
<td valign="top">Reorganize unfiled mail</td>
<td valign="top"><b><u>*NO</u></b>, *YES, *ONLY</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RGZDLO.DLO"></a>
<h3>Document library object (DLO)</h3>
<p>Specifies the name of the object being reorganized.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All document library objects are reorganized. If FLR(*NONE) is specified with this parameter, all folderless documents are reorganized. If FLR(*ANY) is specified with this parameter, all filed documents and folders are reorganized. If MAIL(*YES) is specified with this parameter, all unfiled mail documents as well as all filed documents and folders are reorganized. If MAIL(*ONLY) is specified with this parameter, only unfiled mail documents are reorganized. If FLR(name) is specified with this parameter, all folders and documents within it are reorganized.
</dd>
<dt><b>*SYSOBJNAM</b></dt>
<dd>A system object name specified on the <b>System object name (SYSOBJNAM)</b> parameter is used to identify the document or folder being reorganized.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the document or folder to be reorganized. The <b>Folder (FLR)</b> parameter also can be used to reorganize a document by specifying reorganization of:
<ul>
<li>The folder that contains the document being reorganized
</li>
<li>The folder that contains the nested folder that contains the document being reorganized
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RGZDLO.FLR"></a>
<h3>Folder (FLR)</h3>
<p>Specifies the folder that contains the documents or folders. If the documents or folders do not exist in a folder, *NONE is specified.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The document or folder is not contained in a folder. When DLO(*ALL) is specified, this refers to all documents not contained in a folder; when DLO(name) is specified, this refers to a first-level folder.
</dd>
<dt><b>*ANY</b></dt>
<dd>All document library objects will be reorganized including those not contained in any folder. This value is valid only when DLO(*ALL) is specified.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the folder that contains the documents or folders.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RGZDLO.SYSOBJNAM"></a>
<h3>System object name (SYSOBJNAM)</h3>
<p>Specifies the system object name of an individual folder or document being reorganized.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RGZDLO.DAYS"></a>
<h3>Days since last referenced (DAYS)</h3>
<p>Specifies the number of days that must have elapsed since a document library object was last referred to before it can be reorganized.
</p>
<dl>
<dt><b><u>0</u></b></dt>
<dd>All objects requested will be reorganized.
</dd>
<dt><b><i>1-999</i></b></dt>
<dd>Specify the number of days that must have elapsed since a document library object was referred to before it can be reorganized.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RGZDLO.MAIL"></a>
<h3>Reorganize unfiled mail (MAIL)</h3>
<p>Specifies whether objects to be reorganized should include, omit, or be limited to unfiled mail documents.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>Unfiled mail documents will not be reorganized.
</dd>
<dt><b>*YES</b></dt>
<dd>Unfiled mail documents will be reorganized. This value is valid only when DLO(*ALL) and FLR(*ANY) are specified.
</dd>
<dt><b>*ONLY</b></dt>
<dd>Only unfiled mail documents will be reorganized. This value is valid only if DLO(*ALL) and FLR(*ANY) are specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RGZDLO.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Reorganizing Folders and Documents</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(*ANY)
</pre>
</p>
<p>This command reorganizes all filed folders and documents that exist on the system.
</p>
<p><b>Example 2: Reorganizing Folders, Documents, and Unfiled Mail</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*YES)
</pre>
</p>
<p>This command reorganizes all filed folders, documents, and all unfiled mail documents that exist on the system.
</p>
<p><b>Example 3: Reorganizing Unfiled Mail Documents</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*ONLY)
</pre>
</p>
<p>This command reorganizes all unfiled mail documents that exist on the system.
</p>
<p><b>Example 4: Reorganizing Folderless Documents</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(*NONE)
</pre>
</p>
<p>This command reorganizes all folderless documents that exist on the system.
</p>
<p><b>Example 5: Reorganizing Documents Within Folders Within Folders</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(FLRA)
</pre>
</p>
<p>This command reorganizes all documents within folders contained in folder FLRA, then the folders within folder FLRA are reorganized.
</p>
<p><b>Example 6: Reorganizing an Individual Document or Folder</b>
</p>
<p>
<pre>
RGZDLO DLO(*SYSOBJNAM) SYSOBJNAM(DCN1371951)
</pre>
</p>
<p>This command reorganizes the individual document or folder identified by the SYSOBJNAM object.
</p>
<p><b>Example 7: Reorganizing a Document</b>
</p>
<p>
<pre>
RGZDLO DLO(DOC1) FLR(FLRA)
</pre>
</p>
<p>This command reorganizes the document named DOC1 in folder FLRA.
</p>
<p><b>Example 8: Reorganizing Documents Not Referenced</b>
</p>
<p>
<pre>
RGZDLO DLO(*ALL) FLR(*ANY) DAYS(30)
</pre>
</p>
<p>This command reorganizes all filed documents and folders that have not been referenced in the past 30 days.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RGZDLO.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF8AB1</b></dt>
<dd>&amp;1 objects reorganized; &amp;2 objects not reorganized.
</dd>
<dt><b>CPF8AB2</b></dt>
<dd>RGZDLO command failed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RGZDLO.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>