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.cl_5.4.0.1/rcldlo.htm

411 lines
16 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Reclaim Document Lib Object (RCLDLO)</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="RCLDLO.Top_Of_Page"></a>
<h2>Reclaim Document Lib Object (RCLDLO)</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="#RCLDLO.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RCLDLO.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RCLDLO.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RCLDLO"></a>
<p>The Reclaim Document Library Object (RCLDLO) command allows you to reclaim:
</p>
<ul>
<li>a document
</li>
<li>a folder
</li>
<li>a folder and all documents and folders directly or indirectly contained within it
</li>
<li>internal Document Library system objects.
</li>
<li>internal Document Library system objects, unfiled distribution documents, and all filed folders and documents on the system. Related document details are synchronized.
</li>
<li>internal document library system objects and all filed folders and documents in one auxiliary storage pool (ASP). Related document details are synchronized.
</li>
</ul>
<p>When using the RCLDLO command to reclaim all document library objects, the objects are synchronized with the search details index and the text search index. The synchronization with the text search index is complete when all the requests to update the text search index generated using the RCLDLO command have been processed.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>To reclaim internal document library system objects or all Document Library objects, you must have all object (*ALLOBJ) or security administrator (*SECADM) special authority. These objects can be reclaimed only when no folders or documents are in use.
</li>
<li>You must have exclusive use of the document or folder while it is being reclaimed. You do not need authority to a document or folder to reclaim it. You also do not need to be enrolled in the System Distribution Directory.
</li>
<li>While using this command, you may encounter an error message indicating that internal objects are locked. Another user may be using Document Library functions, which prevents the RCLDLO command from running. Retry this command after other Document Library activity has ended.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RCLDLO.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="#RCLDLO.DLO"><b>DLO</b></a></td>
<td valign="top">Document library object</td>
<td valign="top"><i>Character value</i>, *SYSOBJNAM, *INT, *ALL, *FLR, *DOCDTL</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RCLDLO.FLR"><b>FLR</b></a></td>
<td valign="top">In folder</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RCLDLO.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="#RCLDLO.SYSOBJATR"><b>SYSOBJATR</b></a></td>
<td valign="top">System object attributes</td>
<td valign="top"><b><u>*NONE</u></b>, *INTDOC, *DST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RCLDLO.ASP"><b>ASP</b></a></td>
<td valign="top">Auxiliary storage pool ID</td>
<td valign="top">1-32, <b><u>*ANY</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RCLDLO.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>, <b><u>*NONE</u></b></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="#RCLDLO.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="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RCLDLO.DLO"></a>
<h3>Document library object (DLO)</h3>
<p>Specifies the name of object to reclaim.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*FLR</b></dt>
<dd>A folder and all folders and documents directly or indirectly within it are to be reclaimed.
</dd>
<dt><b>*SYSOBJNAM</b></dt>
<dd>A system object name is used to identify the folder or document to be reclaimed. This parameter must be used when reclaiming a document that is <b>not</b> in a folder including internal and distribution documents.
</dd>
<dt><b>*INT</b></dt>
<dd>Internal document library system objects are to be reclaimed.
<p>
<b>Note: </b>The internal document library system objects are used to manage the documents and folders on the system. RCLDLO DLO(*INT) is only necessary if the internal objects become damaged. If the internal objects are damaged, attempts to access documents and folders will result in the message CPF8A46 (Internal system objects are damaged), possibly followed by the message CPF9032 (Document interchange session not started),
</p>
</dd>
<dt><b>*DOCDTL</b></dt>
<dd>Internal document library system objects and document details are to be reclaimed. DLO(*DOCDTL) synchronizes the relationships between all document library objects and their document details and will fix inconsistencies between them.
<p>
<b>Note: </b>The RCLDLO DLO(*DOCDTL) command can be a long-running function, performing a subset of the RCLDLO DLO(*ALL) processing necessary to guarantee consistency between internal system objects, document details, and DLOs.
</p>
</dd>
<dt><b>*ALL</b></dt>
<dd>Internal document library system objects and all documents and folders (as specified on the ASP parameter) are to be reclaimed. DLO(*ALL) synchronizes the relationships between all document library objects and their document details and can be used to fix inconsistencies between them.
<p>
<b>Note: </b>The RCLDLO DLO(*ALL) command can be a long-running function, depending on the number of documents and folders on the system. If the RCLDLO command can be issued at the user's discretion, the user may wish to avoid the operation until the time required can be scheduled.
</p>
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the document or folder to be reclaimed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.FLR"></a>
<h3>In folder (FLR)</h3>
<p>Specifies the folder containing the folder or document to reclaim, or specifies the folder to reclaim along with all documents and folders directly or indirectly within it. A folder name is entered on this parameter only if a folder or document name or *FLR is entered on the <b>Document library object (DLO)</b> parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The folder or document to reclaim is not located in a folder.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the folder that contains the document or folder to reclaim or specify the name of the folder to reclaim along with all folders and documents directly contained within it.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.SYSOBJNAM"></a>
<h3>System object name (SYSOBJNAM)</h3>
<p>Specifies the system object name of the object to reclaim. A system object name must be entered on this parameter if *SYSOBJNAM is specified on the <b>Document library object (DLO)</b> parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.SYSOBJATR"></a>
<h3>System object attributes (SYSOBJATR)</h3>
<p>Specifies the attributes of the object to reclaim. A value other than *NONE may be entered on this parameter only if *SYSOBJNAM is specified on the <b>Document library object (DLO)</b> parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No attributes are specified for the object.
</dd>
<dt><b>*INTDOC</b></dt>
<dd>The object to reclaim is an internal document.
</dd>
<dt><b>*DST</b></dt>
<dd>The object to reclaim is a distribution document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.ASP"></a>
<h3>Auxiliary storage pool ID (ASP)</h3>
<p>Specifies the identifier (ID) of the auxiliary storage pool (ASP) of the document library object to be reclaimed. A value other than *ANY can be specified on this parameter only if *ALL or *DOCDTL is specified on the DLO parameter.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The objects to be reclaimed reside in any ASP. When *ALL is specified on the DLO parameter, all document library objects on the system are reclaimed.
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Only document library objects that reside in the specified ASP are to be reclaimed. All document library objects in other ASPs are ignored. The value must designate an existing ASP that contains document library objects. ASP 1 is the system ASP.
<p>
<b>Note: </b>Unfiled distribution documents are classified as document library objects in the system ASP.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the name of the database file to which special output is directed. If the output file does not exist, this command creates a database file in the specified library. If the file is created by this function, the descriptive text is "OUTFILE created by RCLDLO" and the authority for users without specific authority to the file is *EXCLUDE. A value other than *NONE can be specified on this parameter only if *ALL or *DOCDTL is specified on the DLO parameter.
</p>
<p>The output directed to this file includes the names of any documents that are physically damaged (and therefore unusable) or documents or folders that were missing from the system (and for which the document details have been removed). This file is intended to provide the user with a record of what was lost (such as a user ASP) when recovering from hardware failure.
</p>
<p><b>Qualifier 1: File to receive output</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No output is directed to a database file.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the qualified name of the database file that is to receive the output. This file can be reused when other RCLDLO commands are issued. Output is added to the file as specified on the OUTMBR parameter. The IBM-supplied database file, QSYS/QARCLDLO, cannot be specified.
</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 job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<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="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLDLO.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member that receives the output of the command.
</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. If the member already exists, you have the option to add new records to the end of the existing member or clear the member and then add the new records.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the file member that receives the output. If it does not exist, the system creates it.
</dd>
</dl>
<p><b>Element 2: Replace or add records</b>
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
</dl>
<dl>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RCLDLO.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Reclaiming a Folder</b>
</p>
<p>
<pre>
RCLDLO DLO(FLR1)
</pre>
</p>
<p>This command reclaims folder FLR1.
</p>
<p><b>Example 2: Reclaiming a Document Within a Folder</b>
</p>
<p>
<pre>
RCLDLO DLO(A) FLR(FLR2)
</pre>
</p>
<p>This command reclaims folder or document A in folder FLR2.
</p>
<p><b>Example 3: Reclaiming a Folder and All Documents and Folders Within It</b>
</p>
<p>
<pre>
RCLDLO DLO(*FLR) FLR(FLR3)
</pre>
</p>
<p>This command reclaims folder FLR3 and all folders and documents directly or indirectly contained within it.
</p>
<p><b>Example 4: Reclaiming an Internal Document</b>
</p>
<p>
<pre>
RCLDLO DLO(*SYSOBJNAM) SYSOBJNAM(AMBT133080)
SYSOBJATR(*INTDOC)
</pre>
</p>
<p>This command reclaims the internal document specified by the system object name AMBT133080.
</p>
<p><b>Example 5: Reclaiming a Distribution Document</b>
</p>
<p>
<pre>
RCLDLO DLO(*SYSOBJNAM) SYSOBJNAM(AMBT133082)
SYSOBJATR(*DST)
</pre>
</p>
<p>This command reclaims the distribution document specified by the system object name AMBT133082.
</p>
<p><b>Example 6: Reclaiming Document Library System Objects</b>
</p>
<p>
<pre>
RCLDLO DLO(*INT)
</pre>
</p>
<p>This command reclaims internal document library system objects.
</p>
<p><b>Example 7: Reclaiming Document Library System Objects and Document Details</b>
</p>
<p>
<pre>
RCLDLO DLO(*DOCDTL)
</pre>
</p>
<p>This command reclaims internal document library system objects and document details for all folders and documents.
</p>
<p><b>Example 8: Reclaiming Document Library System Objects and All Documents and Folders</b>
</p>
<p>
<pre>
RCLDLO DLO(*ALL)
</pre>
</p>
<p>This command reclaims internal document library system objects and all documents and folders and synchronizes their document details.
</p>
<p><b>Example 9: Reclaiming Document Library System Objects and All Documents and Folders in an ASP</b>
</p>
<p>
<pre>
RCLDLO DLO(*ALL) ASP(2)
</pre>
</p>
<p>This command reclaims internal document library system objects and all documents and folders residing in ASP 2 and synchronizes their document details.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RCLDLO.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF8A44</b></dt>
<dd>Error occurred in document details.
</dd>
<dt><b>CPF8AA4</b></dt>
<dd>Reclaim of &amp;2 not successful.
</dd>
<dt><b>CPF8A29</b></dt>
<dd>Reclaim of &amp;2 partially successful.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLDLO.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink