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

212 lines
7.5 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>Add Search Index Entry (ADDSCHIDXE)</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="ADDSCHIDXE.Top_Of_Page"></a>
<h2>Add Search Index Entry (ADDSCHIDXE)</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="#ADDSCHIDXE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDSCHIDXE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDSCHIDXE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDSCHIDXE"></a>
<p>The Add Search Index Entry (ADDSCHIDXE) command is used to load panel group online help information into a search index.
</p>
<p>A search index is a reference to online help information from one or more panel groups. A panel group contains online help information, which the user can access from display panels, by pressing the HELP key, or through the index search function using the Start Search Index (STRSCHIDX) command.
</p>
<p>The sequence in which panel groups are loaded into a search index controls the sequence in which topic entries are presented when an index search is requested. The topics (ISCH tag entries) from the first-loaded panel group are presented first.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have change (*CHANGE) authority for the search index that is to be changed, use (*USE) authority for the panel group, and *USE authority for the library where the search index is located.
</li>
<li>Only user-created panel groups can be added to user-created search indexes and only IBM-supplied panel groups can be added to IBM-supplied search indexes.
</li>
<li>Panel group names must be unique within a search index.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDSCHIDXE.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" rowspan="3"><a href="#ADDSCHIDXE.SCHIDX"><b>SCHIDX</b></a></td>
<td valign="top">Search index</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Search index</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="#ADDSCHIDXE.PNLGRP"><b>PNLGRP</b></a></td>
<td valign="top">Panel group</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Panel group</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></table>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDSCHIDXE.SCHIDX"></a>
<h3>Search index (SCHIDX)</h3>
<p>Specifies the search index into which entries are to be loaded.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Search index</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the search index.
</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 used to locate the search index. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the search index is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDSCHIDXE.PNLGRP"></a>
<h3>Panel group (PNLGRP)</h3>
<p>Specifies the panel group that contains the help source for which the index entries are to be loaded into the search index.
</p>
<p>The search index object contains the name and library of the panel group. When help information is displayed for a search index, the name and library of the panel group that is contained in the search index object is used to find the panel group.
</p>
<p>When *LIBL is used to qualify the panel group name, *LIBL is saved in the search index object. When the panel group name is qualified with a library name or with *CURLIB, the actual name of the library containing the panel group is saved in the search index object.
</p>
<p>The names of panel groups added to a search index must be unique.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Panel group</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the panel group.
</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 used to locate the panel group. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the panel group is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDSCHIDXE.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
ADDSCHIDXE SCHIDX(ACCOUNTING) PNLGRP(PAYROLL)
</pre>
</p>
<p>This command adds panel group PAYROLL to search index ACCOUNTING. Both the panel group and the search index must exist in the library list.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDSCHIDXE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF6E07</b></dt>
<dd>Panel group cannot be added to search index.
</dd>
<dt><b>CPF6E08</b></dt>
<dd>Panel group cannot be added to search index.
</dd>
<dt><b>CPF6E09</b></dt>
<dd>Panel group does not contain any synonyms or root words.
</dd>
<dt><b>CPF6E12</b></dt>
<dd>Panel group not added to search index.
</dd>
<dt><b>CPF6E47</b></dt>
<dd>Panel group &amp;1 cannot be added to search index &amp;3
</dd>
<dt><b>CPF6E48</b></dt>
<dd>Panel group &amp;1 cannot be added to search index &amp;3
</dd>
<dt><b>CPF6E49</b></dt>
<dd>Panel group &amp;1 cannot be added to search index &amp;3
</dd>
<dt><b>CPF6E61</b></dt>
<dd>Panel group &amp;1 cannot be added to search index &amp;3.
</dd>
<dt><b>CPF6E62</b></dt>
<dd>Panel group &amp;1 already exists in search index &amp;3.
</dd>
<dt><b>CPF6E63</b></dt>
<dd>Error occurred while trying to recover from another error.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDSCHIDXE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink