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

351 lines
12 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Display DLO Auditing Level (DSPDLOAUD)</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="DSPDLOAUD.Top_Of_Page"></a>
<h2>Display DLO Auditing Level (DSPDLOAUD)</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="#DSPDLOAUD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPDLOAUD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPDLOAUD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPDLOAUD"></a>
<p>The Display Document Library Object Audit (DSPDLOAUD) command allows the user to display the auditing level of a document or folder.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have all object (*ALLOBJ) or audit (*AUDIT) special authority to display the auditing level of the document or folder.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPDLOAUD.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="#DSPDLOAUD.DLO"><b>DLO</b></a></td>
<td valign="top">Document library object</td>
<td valign="top"><i>Character value</i>, *SYSOBJNAM, *ROOT, *ALL</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDLOAUD.FLR"><b>FLR</b></a></td>
<td valign="top">Folder</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *ANY, *ROOT</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDLOAUD.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="#DSPDLOAUD.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDLOAUD.TYPE"><b>TYPE</b></a></td>
<td valign="top">Type of object</td>
<td valign="top"><b><u>*FLR</u></b>, *DOC, *ALL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDLOAUD.LEVEL"><b>LEVEL</b></a></td>
<td valign="top">Level of list</td>
<td valign="top"><b><u>*CURRENT</u></b>, *ALL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPDLOAUD.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="#DSPDLOAUD.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="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPDLOAUD.DLO"></a>
<h3>Document library object (DLO)</h3>
<p>Specifies the name of the document or folder whose auditing value is displayed.
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>The auditing levels for all DLOs in the specified folder are displayed.
</dd>
<dt><b>*ROOT</b></dt>
<dd>The auditing level for the *ROOT level folder is displayed. The *ROOT level folder contains the default auditing level for all new first-level folders.
</dd>
<dt><b>*SYSOBJNAM</b></dt>
<dd>The auditing level for the document or folder with the system object name specified on the <b>System object name (SYSOBJNAM)</b> parameter is displayed.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the document library object for which the auditing level is displayed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.FLR"></a>
<h3>Folder (FLR)</h3>
<p>Specifies the folder containing the document library object whose auditing level is displayed.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The document or folder is not contained in a folder.
</dd>
<dt><b>*ANY</b></dt>
<dd>The auditing levels of all DLOs on the system are displayed.
</dd>
<dt><b>*ROOT</b></dt>
<dd>The auditing level of all first-level folders is displayed.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the folder that contains the document library object for which the auditing level is displayed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.SYSOBJNAM"></a>
<h3>System object name (SYSOBJNAM)</h3>
<p>Specifies the system object name. This parameter is valid only when DLO(*SYSOBJNAM) is specified.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the system object name for the folder or document displayed. Ten characters must be specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies where the output from the command is sent.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).
</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>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.TYPE"></a>
<h3>Type of object (TYPE)</h3>
<p>Specifies whether the documents or folders contained in the folder specified on the FLR parameter are displayed. This parameter is valid when FLR(name) is specified and is defaulted in all other cases. When DLO(*ALL) FLR(*ANY) is specified, TYPE(*ALL) is used. When DLO(*ALL) FLR(*ROOT) is specified, TYPE(*FLR) is used. When DLO(*ALL) FLR(*NONE) is specified, TYPE(*DOC) is used. When a single object is specified on the command, the TYPE parameter is ignored.
</p>
<dl>
<dt><b><u>*FLR</u></b></dt>
<dd>The folders contained in the specified folder are displayed.
</dd>
<dt><b>*DOC</b></dt>
<dd>The documents contained in the specified folder are displayed.
</dd>
<dt><b>*ALL</b></dt>
<dd>The documents and folders contained in the specified folder are displayed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.LEVEL"></a>
<h3>Level of list (LEVEL)</h3>
<p>Specifies whether documents and folders at nested levels in the specified folder are displayed.
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>Only the documents and folders at the current level are included in the output.
</dd>
<dt><b>*ALL</b></dt>
<dd>The documents and folders at all levels are included in the output.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the database file to which the output of the command is directed. If the file does not exist, this command creates a database file in the specified library. If the file is created, the public authority for the file is the same as the create authority specified for the library in which the file is created. Use the Display Library Description (DSPLIBD) command to show the library's create authority.
</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 the command output is directed.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the file. If the file is not found, one is created in the current library. If no current library exists, the file will be created in the QGPL library.
</dd>
<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 thread, 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="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDLOAUD.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="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDLOAUD.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Displaying an Auditing Level</b>
</p>
<p>
<pre>
DSPDLOAUD DLO(MYDOC) FLR(MYFLR)
</pre>
</p>
<p>This command displays the auditing level of document MYDOC in folder MYFLR.
</p>
<p><b>Example 2: Printing Auditing Levels</b>
</p>
<p>
<pre>
DSPDLOAUD DLO(*ALL) FLR(*ROOT) OUTPUT(*PRINT)
</pre>
</p>
<p>This command prints the auditing levels of all first-level folders on the system.
</p>
<p><b>Example 3: Listing all Auditing Levels</b>
</p>
<p>
<pre>
DSPDLOAUD DLO(*ALL) FLR(*ANY)
OUTPUT(*OUTFILE) OUTFILE(MYLIB/MYFILE)
</pre>
</p>
<p>This command lists the auditing levels of all DLOs on the system in the output file MYFILE in library MYLIB.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDLOAUD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF89B0</b></dt>
<dd>Error occurred during output of list.
</dd>
<dt><b>CPF89B1</b></dt>
<dd>Auditing level is not displayed because error occurred.
</dd>
<dt><b>CPF9860</b></dt>
<dd>Error occurred during output file processing.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDLOAUD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>