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

280 lines
11 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>Work with Saved Folders (WRKFLRBRM)</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="WRKFLRBRM.Top_Of_Page"></a>
<h2>Work with Saved Folders (WRKFLRBRM)</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="#WRKFLRBRM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKFLRBRM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKFLRBRM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKFLRBRM"></a>
<p>The Work with Saved Folders using BRM (WRKFLRBRM) command displays or prints a report of saved folders, including all subfolders. Folders are selected by date ranges and the resulting display/print can be sequenced in several ways.
</p>
<p>If the display option is selected, you can display the documents in each folder and restore them from the media inventory. The report that is produced is the Saved Folders report. The report, if printed, is written to printer file QP1AFD.
</p>
<p>To use this command, you must have the Backup Recovery and Media Services for iSeries, 5722-BR1, licensed program installed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKFLRBRM.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="#WRKFLRBRM.FLR"><b>FLR</b></a></td>
<td valign="top">Folder</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#WRKFLRBRM.SLTDATE"><b>SLTDATE</b></a></td>
<td valign="top">Select dates</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: From date</td>
<td valign="top">
<i>Character value</i>, <b><u>*BEGIN</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top">Element 2: To date</td>
<td valign="top">
<i>Character value</i>, <b><u>*END</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top"><a href="#WRKFLRBRM.SAVSTS"><b>SAVSTS</b></a></td>
<td valign="top">Save status</td>
<td valign="top"><b><u>*ALL</u></b>, *ERROR, *NOERROR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKFLRBRM.SORT"><b>SORT</b></a></td>
<td valign="top">Sequence option</td>
<td valign="top"><b><u>*DATE</u></b>, *FLR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKFLRBRM.FROMSYS"><b>FROMSYS</b></a></td>
<td valign="top">From system</td>
<td valign="top"><i>Character value</i>, <b><u>*LCL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKFLRBRM.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKFLRBRM.FLR"></a>
<h3>Folder (FLR)</h3>
<p>Specifies the name of the folder or group of folders that you want to display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Include all folders in the display or print.
</dd>
<dt><b><i>folder-name</i></b></dt>
<dd>Specify the name of the folder that you want to display or print.
</dd>
<dt><b><i>generic*-folder-name</i></b></dt>
<dd>Specify the generic folder name. For example, specifying ACCFLR* would cause all folder whose names that begin with ACCFLR to be included in the display or print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKFLRBRM.SLTDATE"></a>
<h3>Select dates (SLTDATE)</h3>
<p>Specifies a range of dates that you want to use when displaying or printing saved folders. The <b>From date </b>is the beginning of a date range of saved folders and the <b>To date </b>is the end of the date range.
</p>
<p>
<b>Note: </b>Using this parameter, it is possible to enter a date with no separator, or a number of days which can be up to 5 digits in length. For instance, if you are using month/day/year format, the number 12904 would be formatted as January 29, 2004. If on the other hand, you entered a number 13904, BRMS assume that this is not a date, but rather is a number. BRMS always tries to calculate a calendar date first when a number is entered and then if the date it calculates is not valid, assumes that it is a number of days. If the number that is entered is over 5 digits and the date that it calculates is not valid, you receive an error message.
</p>
<p><b>Element 1: From date </b>
</p>
<dl>
<dt><b><u>*BEGIN</u></b></dt>
<dd>Uses the earliest activity date for the beginning date of the date range.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Use the current date for the beginning date of the date range.
</dd>
<dt><b><i>from-date</i></b></dt>
<dd>Specify the date entered in job date format with or without date separators for the beginning date of the date range.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days before the current day that is used to determine the starting date of the date range.
</dd>
</dl>
<p><b>Element 2: To date </b>
</p>
<dl>
<dt><b><u>*END</u></b></dt>
<dd>The last date that a folder was saved is the ending date of the date range that you want to use for the search.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Uses the current date for the ending date of the date range.
</dd>
<dt><b><i>to-date</i></b></dt>
<dd>Specify the date in job date format with or without date separators that you want to be the ending date of the date range.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days before the current day that is used to determine the ending date of the date range.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKFLRBRM.SAVSTS"></a>
<h3>Save status (SAVSTS)</h3>
<p>Specifies whether you want to display or report all successful saves, unsuccessful saves or both.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Include both successful and unsuccessful saves in the display or report.
</dd>
<dt><b>*ERROR</b></dt>
<dd>Include only unsuccessful saves in the display or report.
</dd>
<dt><b>*NOERROR</b></dt>
<dd>Include only successful saves in the display or report.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKFLRBRM.SORT"></a>
<h3>Sequence Option (SORT)</h3>
<p>The Work with Saved Folders display or report can be sequenced several ways.
</p>
<dl>
<dt><b><u>*DATE</u></b></dt>
<dd>Orders the display or report in date sequence.
</dd>
<dt><b>*FLR</b></dt>
<dd>Orders the display or report in folder sequence.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKFLRBRM.FROMSYS"></a>
<h3>From system (FROMSYS)</h3>
<p>Specifies the location and network identification of the system whose folder information that you want to work with.
</p>
<p>
<b>Note: </b>Use the Display Network Attributes (DSPNETA) command to view the system network attributes.
</p>
<p>
<b>Note: </b>The BRMS Network feature (Option 1) is required to use this value if a value other than *LCL is specified.
</p>
<dl>
<dt><b><u>*LCL</u></b></dt>
<dd>Specifies that the from-system is the local system. BRMS uses the <b>Default local location name (LCLLOCNAME)</b> network attribute and not the <b>System name (SYSNAME)</b> network attribute to determine the current system name. In most cases, the systems have the same value specified for LCLLOCNAME as for SYSNAME.
</dd>
<dt><b><i>location-name</i></b></dt>
<dd>Specifies the <b>Default local location name (LCLLOCNAME)</b> network attribute of the remote system for the network operation. The current system <b>Local network ID (LCLNETID)</b> network attribute is used to connect with the remote system.
</dd>
<dt><b><i>network-id.location-name</i></b></dt>
<dd>Specifies the <b>Local network ID (LCLNETID)</b> and the <b>Default local location name (LCLLOCNAME)</b> network attributes of the remote system for the network operation. Specify these values using the format nnnnnnnn.cccccccc where nnnnnnnn is the LCLNETID and cccccccc is the LCLLOCNAME.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKFLRBRM.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed (if requested by a batch job).
</dd>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKFLRBRM.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
WRKFLRBRM SLTDATE(*BEGIN *END)
</pre>
</p>
<p>This command displays the Work with Saved Folders panel, where all folders from the beginning of the file to the end of the file are displayed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKFLRBRM.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>BRM1177</b></dt>
<dd>Cannot establish connection with remote system.
</dd>
<dt><b>BRM1917</b></dt>
<dd>Feature not installed.
</dd>
<dt><b>BRM1921</b></dt>
<dd>Feature not licensed.
</dd>
<dt><b>BRM4040</b></dt>
<dd>Access denied for user &amp;1.
</dd>
<dt><b>BRM4041</b></dt>
<dd>Access denied for user &amp;1.
</dd>
<dt><b>BRM40A2</b></dt>
<dd>BRMS product initialization required.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKFLRBRM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>