229 lines
7.9 KiB
HTML
229 lines
7.9 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>Find Key for OnDemand (FNDKEYOND)</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="FNDKEYOND.Top_Of_Page"></a>
|
|
<h2>Find Key for OnDemand (FNDKEYOND)</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="#FNDKEYOND.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#FNDKEYOND.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#FNDKEYOND.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="FNDKEYOND"></a>
|
|
<p>The Find Key for OnDemand (FNDKEYOND) command allows you to search for a particular document that is available through the folder specified in the FOLDER parameter. The OnDemand client is launched to view the results of the search. The key fields entered must exist in the folder. This command is intended as an API to launch the OnDemand client from a "green screen" application.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="FNDKEYOND.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="#FNDKEYOND.FOLDER"><b>FOLDER</b></a></td>
|
|
<td valign="top">Folder</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Required, Positional 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#FNDKEYOND.LGLREL"><b>LGLREL</b></a></td>
|
|
<td valign="top">Logical relation</td>
|
|
<td valign="top"><b><u>*AND</u></b>, *OR</td>
|
|
<td valign="top">Optional, Positional 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top" rowspan="5"><a href="#FNDKEYOND.KEYFLD"><b>KEYFLD</b></a></td>
|
|
<td valign="top">Search argument</td>
|
|
<td valign="top">Values (up to 10 repetitions): <i>Element list</i></td>
|
|
<td valign="top" rowspan="5">Optional, Positional 3</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">Element 1: Key field</td>
|
|
<td valign="top">
|
|
<i>Character value</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">Element 2: Operator</td>
|
|
<td valign="top">
|
|
<b><u>*EQ</u></b>, *NE, *LT, *GT, *GE, *BETWEEN, *NOTBETWEEN, *IN, *NOTIN, *LIKE, *NOTLIKE</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">Element 3: Value 1</td>
|
|
<td valign="top">
|
|
<i>Character value</i></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">Element 4: Value 2</td>
|
|
<td valign="top">
|
|
<i>Character value</i></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="FNDKEYOND.FOLDER"></a>
|
|
<h3>Folder (FOLDER)</h3>
|
|
<p>Specify the name of the folder to search.
|
|
</p>
|
|
<p>If the value to be entered contains lower case letters, blanks, or special characters, it must be enclosed in apostrophes.
|
|
</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 the valid entries is presented to you. The entries listed are only valid for the default instance on the server the command is run on.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="FNDKEYOND.LGLREL"></a>
|
|
<h3>Logical relation (LGLREL)</h3>
|
|
<p>Specify the logical relationship between the different key fields.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*AND</u></b></dt>
|
|
<dd>Multiple keys are to be ANDed.
|
|
</dd>
|
|
<dt><b>*OR</b></dt>
|
|
<dd>Multiple keys are to be ORed.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="FNDKEYOND.KEYFLD"></a>
|
|
<h3>Search argument (KEYFLD)</h3>
|
|
<p>Specifies one or more key fields, operators, and values to search for.
|
|
</p>
|
|
<p>
|
|
<b>Note: </b>You can enter multiple values for this parameter. If you are on an entry display and you need additional entry fields to enter these multiple values, type a plus sign (+) in the entry field opposite the phrase "+ for more" and press the Enter key.
|
|
</p>
|
|
<p><b>Key field</b>
|
|
</p>
|
|
<p>Specify the key field name this search is for. A valid key field must be specified.
|
|
</p>
|
|
<p>If the value to be entered contains lower case letters, blanks, or special characters, it must be enclosed in apostrophes.
|
|
</p>
|
|
<p><b>Element 1: Operator</b>
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*EQ</u></b></dt>
|
|
<dd>EQUAL search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*NE</b></dt>
|
|
<dd>NOT EQUAL search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*LT</b></dt>
|
|
<dd>LESS THAN search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*LE</b></dt>
|
|
<dd>LESS THAN OR EQUAL search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*GT</b></dt>
|
|
<dd>GREATER THAN search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*GE</b></dt>
|
|
<dd>GREATER THAN OR EQUAL search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*BETWEEN</b></dt>
|
|
<dd>BETWEEN search using the data in Value 1 and Value 2.
|
|
</dd>
|
|
<dt><b>*NOTBETWEEN</b></dt>
|
|
<dd>NOT BETWEEN search using the data in Value 1 and Value 2.
|
|
</dd>
|
|
<dt><b>*IN</b></dt>
|
|
<dd>IN search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*NOTIN</b></dt>
|
|
<dd>NOT IN search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*LIKE</b></dt>
|
|
<dd>LIKE search using the data in Value 1.
|
|
</dd>
|
|
<dt><b>*NOTLIKE</b></dt>
|
|
<dd>NOT LIKE search using the data in Value 1.
|
|
</dd>
|
|
</dl>
|
|
<p><b>Element 2: Value 1</b>
|
|
</p>
|
|
<p>Specify the data value to search for.
|
|
</p>
|
|
<p>If the value to be entered contains lower case letters, blanks, or special characters, it must be enclosed in apostrophes.
|
|
</p>
|
|
<p><b>Element 3: Value 2</b>
|
|
</p>
|
|
<p>Specify the data value that is the ending value for a between or not between search.
|
|
</p>
|
|
<p>If the value to be entered contains lower case letters, blanks, or special characters, it must be enclosed in apostrophes.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="FNDKEYOND.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p><b>Example 1: Simple Example</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
FNDKEYOND FOLDER(CHECKSTMTS)
|
|
KEYFLD(('Account Number' *EQ '251000022')
|
|
</pre>
|
|
</p>
|
|
<p>This command allows you to search for a particular OnDemand Common Server document that is available through the CHECKSTMTS folder. If the OnDemand Client launch environment is set up on your workstation and you are logged on to the client "listener" program, then the OnDemand Client displays the results of the search. The key field name that you enter (Account Number) must be defined in the OnDemand Common Server folder definition. (This command is intended as an API to launch the OnDemand Client from a green screen application.)
|
|
</p>
|
|
<p><b>Example 2: More Complex Example</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
FNDKEYOND FOLDER(CHECKSTMTS)
|
|
KEYFLD(('Account Number' *EQ '251000022')
|
|
('Document Date' *BETWEEN '06/16/88' '08/16/02'))
|
|
</pre>
|
|
</p>
|
|
<p>This command is similar to Example 1 but shows the use of more than one key field/value and the *BETWEEN operator. Multiple key fields and values can be specified, and a variety of operators are available with this command.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="FNDKEYOND.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>RDR2882</b></dt>
|
|
<dd>Client Launch API program QRLRLCV ended with error code &1.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#FNDKEYOND.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|