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/fndkeyrdar.htm

309 lines
10 KiB
HTML
Raw Blame History

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Find by Key using OnDemand (FNDKEYRDAR)</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="FNDKEYRDAR.Top_Of_Page"></a>
<h2>Find by Key using OnDemand (FNDKEYRDAR)</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="#FNDKEYRDAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#FNDKEYRDAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#FNDKEYRDAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="FNDKEYRDAR"></a>
<p>The Find by Key using OnDemand (FNDKEYRDAR) command allows you to search for a particular document or segment that has been stored in the report specified in the REPORT parameter. If more than one document or segment satisfies the search, a list is shown and you can select which document or segment should be viewed. You can limit the documents or segments that are found by specifying a date range or by entering more that one key field. A value must be specified for at least one of the key fields on this command. This is intended as an API for the OnDemand key search function.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="FNDKEYRDAR.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="#FNDKEYRDAR.REPORT"><b>REPORT</b></a></td>
<td valign="top">Report name</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.RPTKEY1"><b>RPTKEY1</b></a></td>
<td valign="top">Key 1 value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.RPTKEY2"><b>RPTKEY2</b></a></td>
<td valign="top">Key 2 value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.RPTKEY3"><b>RPTKEY3</b></a></td>
<td valign="top">Key 3 value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.RPTKEY4"><b>RPTKEY4</b></a></td>
<td valign="top">Key 4 value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.RPTKEY5"><b>RPTKEY5</b></a></td>
<td valign="top">Key 5 value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.GROUP"><b>GROUP</b></a></td>
<td valign="top">Group search</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#FNDKEYRDAR.RPTDATE"><b>RPTDATE</b></a></td>
<td valign="top">Report date range</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>*AVAIL</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: To date</td>
<td valign="top">
<i>Character value</i>, <b><u>*CURRENT</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#FNDKEYRDAR.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *FAX</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="FNDKEYRDAR.REPORT"></a>
<h3>Report name (REPORT)</h3>
<p>Specify the name of the report to search.
</p>
<p>This is a required parameter.
</p>
<p>
<b>Note: </b>If you press the F4 key for this parameter while prompting the command, a list of all the valid entries is presented to you.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTKEY1"></a>
<h3>Key 1 value (RPTKEY1)</h3>
<p>Specify the key one of the report to find.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTKEY2"></a>
<h3>Key 2 value (RPTKEY2)</h3>
<p>Specify the key two of the report to find.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTKEY3"></a>
<h3>Key 3 value (RPTKEY3)</h3>
<p>Specify the key three of the report to find.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTKEY4"></a>
<h3>Key 4 value (RPTKEY4)</h3>
<p>Specify the key four of the report to find.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTKEY5"></a>
<h3>Key 5 value (RPTKEY5)</h3>
<p>Specify the key five of the report to find.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.GROUP"></a>
<h3>Group search (GROUP)</h3>
<p>Specifies if the search is for this report only or for all reports in the report group.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The search is only for the report specified in the REPORT parameter.
</dd>
<dt><b>*YES</b></dt>
<dd>The search is performed across all reports in the report group. The report group used is that of the report specified on the REPORT parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.RPTDATE"></a>
<h3>Report date range (RPTDATE)</h3>
<p>Specifies the earliest and latest dates of the reports that should be searched.
</p>
<p><b>Element 1: From date</b>
</p>
<dl>
<dt><b><u>*AVAIL</u></b></dt>
<dd>The date of the earliest available report is used.
</dd>
<dt><b><i>date</i></b></dt>
<dd>Specify a date using the format YYYYMMDD where YYYY represents the year, MM the month, and DD the day. Do not use any type of special characters to separate year, month, and day values.
</dd>
</dl>
<p><b>Element 2: To date</b>
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>Today's date is used.
</dd>
<dt><b><i>date</i></b></dt>
<dd>Specify a date using the format YYYYMMDD where YYYY represents the year, MM the month, and DD the day. Do not use any type of special characters to separate year, month, and day values.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="FNDKEYRDAR.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies what should be done with the report when it is found.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The found documents or segments are shown on the display where this command is run.
</dd>
<dt><b>*PRINT</b></dt>
<dd>The document or segment is printed. A selection list is shown if a single document or segment is not found.
</dd>
<dt><b>*FAX</b></dt>
<dd>The document or segment is faxed. A selection list is shown if a single document or segment is not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="FNDKEYRDAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
FNDKEYRDAR REPORT(CHECKSTMTS) RPTKEY1(251000022)
</pre>
</p>
<p>This command allows you to search for a particular OnDemand Spool File Archive document that is archived using the report definition name of CHECKSTMTS. The key value that you enter must correspond with the keys (keys 1 through 5) defined in the OnDemand Spool File Archive report definition.
</p>
<p><b>Example 2: More Complex Example</b>
</p>
<p>
<pre>
FNDKEYRDAR REPORT(CHECKSTMTS) RPTKEY1(251000022)
RPTKEY3(KATIE*)RPTDATE(19880616 20020816)
OUTPUT(*PRINT)
</pre>
</p>
<p>This command is similar to Example 1 but shows the use of more than one key field/value and the *PRINT option.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="FNDKEYRDAR.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>RDR0001</b></dt>
<dd>Report definition not found.
</dd>
<dt><b>RDR0006</b></dt>
<dd>No documents found with this key.
</dd>
<dt><b>RDR0007</b></dt>
<dd>From Date must be entered with To Date.
</dd>
<dt><b>RDR0010</b></dt>
<dd>Page number must not exceed 999999.
</dd>
<dt><b>RDR0011</b></dt>
<dd>Page number must be numeric.
</dd>
<dt><b>RDR0013</b></dt>
<dd>Segment number must not exceed 999999.
</dd>
<dt><b>RDR0053</b></dt>
<dd>Access denied. Not authorized to access this report.
</dd>
<dt><b>RDR0054</b></dt>
<dd>Severe directory problem.
</dd>
<dt><b>RDR0055</b></dt>
<dd>Report access denied. You are not enrolled in the System Directory.
</dd>
<dt><b>RDR0104</b></dt>
<dd>From date not valid.
</dd>
<dt><b>RDR0105</b></dt>
<dd>To date not valid.
</dd>
<dt><b>RDR0124</b></dt>
<dd>Cannot perform a more than one key search with this key combination.
</dd>
<dt><b>RDR0183</b></dt>
<dd>You are not authorized to the document with this key value.
</dd>
<dt><b>RDR9999</b></dt>
<dd>No more licenses for OnDemand are available.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#FNDKEYRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink