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

1432 lines
49 KiB
HTML
Raw Normal View History

Add readme and dist folders
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>Configure HTTP Search (CFGHTTPSCH)</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="CFGHTTPSCH.Top_Of_Page"></a>
<h2>Configure HTTP Search (CFGHTTPSCH)</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="#CFGHTTPSCH.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CFGHTTPSCH.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CFGHTTPSCH.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CFGHTTPSCH"></a>
<p>The Configure Search (CFGHTTPSCH) command allows you to do various search administration tasks that include working with an index, a document list, a URL mapping rules file, or a thesaurus, plus building objects used for web crawling.
</p>
<p>You can create an index, add documents to an index, remove documents from an index, delete an index, create, update, or delete a document list, create or update a mapping rules file.
</p>
<p>To create an index, add or remove documents from an index, you will need to provide a document list. Specify *CRTDOCL for the <b>Option (OPTION)</b> parameter to create a document list.
</p>
<p>To create an index, specify *CRTIDX for the OPTION parameter.
</p>
<p>To create a document list, specify *CRTDOCL for the OPTION parameter. The document list can be used when you create (*CRTIDX) or update (*ADDDOC or *RMVDOC) an index.
</p>
<p>To append additional document paths to a document list, specify *UPDDOCL for the OPTION parameter. The document list can be used when you create (*CRTIDX) or update (*ADDDOC or *RMVDOC) an index.
</p>
<p>To add documents to an index, specify *ADDDOC for the OPTION parameter. All new or changed documents in the document list will be added to the index.
</p>
<p>To remove documents from the index, specify *RMVDOC for the OPTION parameter.
</p>
<p>To delete a document list, specify *DLTDOCL for the OPTION parameter.
</p>
<p>To delete an index, specify *DLTIDX for the OPTION parameter.
</p>
<p>To create a mapping rules file, specify *CRTMAPF for the OPTION parameter.
</p>
<p>To add additional configuration directives to a mapping rules file, specify *UPDMAPF for the OPTION parameter.
</p>
<p>To create a thesaurus dictionary that can be used on a search, specify *CRTTHSDCT for the OPTION parameter.
</p>
<p>To delete a thesaurus dictionary, specify *DLTTHSDCT for the OPTION parameter.
</p>
<p>To retrieve a thesaurus definition file from a thesaurus dictionary, specify *RTVTHSDFNF for the OPTION parameter.
</p>
<p>The next set of OPTIONS are used for working with objects that are used when crawling remote web sites.
</p>
<p>To create a URL object that contains a list of URLs to crawl, specify *CRTURLOBJ for the OPTION parameter.
</p>
<p>To update a URL object, specify *UPDURLOBJ for the OPTION parameter.
</p>
<p>To delete a URL object, specify *DLTURLOBJ for the OPTION parameter.
</p>
<p>To create an options object, specify *CRTOPTOBJ for the OPTION parameter.
</p>
<p>To update an options object, specify *UPDOPTOBJ for the OPTION parameter.
</p>
<p>To delete an options object, specify *DLTOPTOBJ for the OPTION parameter.
</p>
<p>To print the status of an index, specify *PRTIDXSTS for the OPTION parameter.
</p>
<p>To print the status of a document list, specify *PRTDOCLSTS for the OPTION parameter.
</p>
<p><b>Restrictions</b>
</p>
<ul>
<li>You must have input/output system configuration (*IOSYSCFG) special authority to use this command.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CFGHTTPSCH.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="#CFGHTTPSCH.OPTION"><b>OPTION</b></a></td>
<td valign="top">Option</td>
<td valign="top">*CRTIDX, *MRGIDX, *DLTIDX, *ADDDOC, *RMVDOC, *CRTDOCL, *UPDDOCL, *REGDOCL, *DLTDOCL, *CRTMAPF, *UPDMAPF, *CRTTHSDCT, *DLTTHSDCT, *RTVTHSDFNF, *CRTURLOBJ, *UPDURLOBJ, *DLTURLOBJ, *CRTOPTOBJ, *UPDOPTOBJ, *DLTOPTOBJ, *CRTVLDL, *ADDVLDLDTA, *RMVVLDLDTA, *DLTVLDL, *PRTIDXSTS, *PRTDOCLSTS</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.IDX"><b>IDX</b></a></td>
<td valign="top">Index name</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.IDXDIR"><b>IDXDIR</b></a></td>
<td valign="top">Index directory</td>
<td valign="top"><i>Path name</i>, <b><u>'/QIBM/USERDATA/HTTPSVR/INDEX'</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.TEXT"><b>TEXT</b></a></td>
<td valign="top">Index description</td>
<td valign="top"><i>Character value</i>, <b><u>*BLANK</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.DOCLIST"><b>DOCLIST</b></a></td>
<td valign="top">Document list file</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.STRDIR"><b>STRDIR</b></a></td>
<td valign="top">Start directory</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.SUBTREE"><b>SUBTREE</b></a></td>
<td valign="top">Traverse directory</td>
<td valign="top"><b><u>*ALL</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.PATTERN"><b>PATTERN</b></a></td>
<td valign="top">Filter</td>
<td valign="top"><i>Character value</i>, <b><u>'*.HTM*'</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.CONTENT"><b>CONTENT</b></a></td>
<td valign="top">Document content</td>
<td valign="top"><b><u>*HTML</u></b>, *TEXT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.ALWERR"><b>ALWERR</b></a></td>
<td valign="top">Allow file errors</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.ENBCASE"><b>ENBCASE</b></a></td>
<td valign="top">Enable case sensitive search</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.ALWCHAR"><b>ALWCHAR</b></a></td>
<td valign="top">Valid characters</td>
<td valign="top"><b><u>*ALPHANUM</u></b>, *ALPHA</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.IDXHTML"><b>IDXHTML</b></a></td>
<td valign="top">Index HTML fields</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values (up to 5 repetitions): *TITLE, *AUTHOR, *ABSTRACT, *DESCRIPTION, *KEYWORDS, *ALLMETA</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.CFG"><b>CFG</b></a></td>
<td valign="top">HTTP server</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.URLPFX"><b>URLPFX</b></a></td>
<td valign="top">Prefix for URL</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.MAPFILE"><b>MAPFILE</b></a></td>
<td valign="top">Mapping rules file</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.DLTTYPE"><b>DLTTYPE</b></a></td>
<td valign="top">Delete type</td>
<td valign="top"><b><u>*ALL</u></b>, *SUPP</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.THSDCT"><b>THSDCT</b></a></td>
<td valign="top">Thesaurus dictionary name</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.THSDCTDIR"><b>THSDCTDIR</b></a></td>
<td valign="top">Thesaurus directory</td>
<td valign="top"><i>Path name</i>, <b><u>'/QIBM/USERDATA/HTTPSVR/SEARCH'</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.THSDFNF"><b>THSDFNF</b></a></td>
<td valign="top">Thesaurus definition file</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.URLOBJ"><b>URLOBJ</b></a></td>
<td valign="top">URL object</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.DOCDIR"><b>DOCDIR</b></a></td>
<td valign="top">Document storage directory</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.LANG"><b>LANG</b></a></td>
<td valign="top">Language of documents</td>
<td valign="top">*ARABIC, *BALTIC, *CENTEUROPE, *CYRILLIC, *ESTONIAN, *GREEK, *HEBREW, *JAPANESE, *KOREAN, *SIMPCHINESE, *TRADCHINESE, *THAI, *TURKISH, *WESTERN</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.URLACT"><b>URLACT</b></a></td>
<td valign="top">URL list action</td>
<td valign="top"><b><u>*NONE</u></b>, *ADD, *REMOVE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="5"><a href="#CFGHTTPSCH.URLLST"><b>URLLST</b></a></td>
<td valign="top">URL list entries</td>
<td valign="top">Values (up to 100 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="5">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: URL</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: URL filter</td>
<td valign="top">
<i>Character value</i>, <b><u>*NONE</u></b></td>
</tr>
<tr>
<td valign="top">Element 3: Maximum crawling depth</td>
<td valign="top">
0-100, <b><u>3</u></b>, *NOMAX</td>
</tr>
<tr>
<td valign="top">Element 4: Enable robots</td>
<td valign="top">
<b><u>*YES</u></b>, *NO</td>
</tr>
<tr>
<td valign="top" rowspan="2"><a href="#CFGHTTPSCH.RMVURLLST"><b>RMVURLLST</b></a></td>
<td valign="top">Remove URL list entries</td>
<td valign="top">Values (up to 100 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="2">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: URL</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.OPTOBJ"><b>OPTOBJ</b></a></td>
<td valign="top">Options object</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.PRXSVR"><b>PRXSVR</b></a></td>
<td valign="top">Proxy server for HTTP</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.PRXPORT"><b>PRXPORT</b></a></td>
<td valign="top">Proxy port for HTTP</td>
<td valign="top">1-65535, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.PRXSVRSSL"><b>PRXSVRSSL</b></a></td>
<td valign="top">Proxy server for HTTPS</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.PRXPORTSSL"><b>PRXPORTSSL</b></a></td>
<td valign="top">Proxy port for HTTPS</td>
<td valign="top">1-65535, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.MAXSIZE"><b>MAXSIZE</b></a></td>
<td valign="top">Maximum file size</td>
<td valign="top">1-6000, <b><u>1000</u></b>, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.MAXSTGSIZE"><b>MAXSTGSIZE</b></a></td>
<td valign="top">Maximum storage size</td>
<td valign="top">1-65535, <b><u>100</u></b>, *NOMAX, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.MAXTHD"><b>MAXTHD</b></a></td>
<td valign="top">Maximum threads</td>
<td valign="top">1-50, <b><u>20</u></b>, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CFGHTTPSCH.MAXRUNTIME"><b>MAXRUNTIME</b></a></td>
<td valign="top">Maximum run time</td>
<td valign="top">Single values: *NOMAX, *SAME<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Hours</td>
<td valign="top">
0-1000, <b><u>2</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Minutes</td>
<td valign="top">
0-59, <b><u>0</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.LOGFILE"><b>LOGFILE</b></a></td>
<td valign="top">Logging file</td>
<td valign="top"><i>Path name</i>, <b><u>*NONE</u></b>, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.CLRLOG"><b>CLRLOG</b></a></td>
<td valign="top">Clear logging file</td>
<td valign="top"><b><u>*YES</u></b>, *NO, *SAME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.LSTTYPE"><b>LSTTYPE</b></a></td>
<td valign="top">Document list type</td>
<td valign="top"><b><u>*LOCAL</u></b>, *REMOTE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CFGHTTPSCH.VLDL"><b>VLDL</b></a></td>
<td valign="top">Validation list</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#CFGHTTPSCH.VLDLE"><b>VLDLE</b></a></td>
<td valign="top">Validation list entries</td>
<td valign="top">Values (up to 100 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: URL</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: User ID</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 3: Password</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top" rowspan="2"><a href="#CFGHTTPSCH.RMVVLDLE"><b>RMVVLDLE</b></a></td>
<td valign="top">Remove validation list entries</td>
<td valign="top">Values (up to 100 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="2">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: URL</td>
<td valign="top">
<i>Character value</i></td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CFGHTTPSCH.OPTION"></a>
<h3>Option (OPTION)</h3>
<p>Specifies the administrative task to be performed.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*CRTIDX</b></dt>
<dd>Create an index.
</dd>
<dt><b>*MRGIDX</b></dt>
<dd>Merge an index after documents have been added.
</dd>
<dt><b>*DLTIDX</b></dt>
<dd>Delete an index.
</dd>
<dt><b>*ADDDOC</b></dt>
<dd>Add documents to an index.
</dd>
<dt><b>*RMVDOC</b></dt>
<dd>Remove documents from an index.
</dd>
<dt><b>*CRTDOCL</b></dt>
<dd>Create a document list. If the file already exists, it will be replaced.
</dd>
<dt><b>*UPDDOCL</b></dt>
<dd>Append additional document paths to a document list.
</dd>
<dt><b>*DLTDOCL</b></dt>
<dd>Delete a document list.
</dd>
<dt><b>*CRTMAPF</b></dt>
<dd>Create a mapping rules file. If the file already exists, it will be replaced.
</dd>
<dt><b>*UPDMAPF</b></dt>
<dd>Append additional configuration directives to a mapping rules file.
</dd>
<dt><b>*CRTTHSDCT</b></dt>
<dd>Create a thesaurus dictionary.
</dd>
<dt><b>*RTVTHSDFNF</b></dt>
<dd>Retrieve a thesaurus definition file from a thesaurus dictionary.
</dd>
<dt><b>*DLTTHSDCT</b></dt>
<dd>Delete a thesaurus dictionary.
</dd>
<dt><b>*CRTURLOBJ</b></dt>
<dd>Create a URL object to use when crawling remote web sites.
</dd>
<dt><b>*UPDURLOBJ</b></dt>
<dd>Update a URL object to use when crawling remote web sites.
</dd>
<dt><b>*DLTURLOBJ</b></dt>
<dd>Delete a URL object.
</dd>
<dt><b>*CRTOPTOBJ</b></dt>
<dd>Create an options object to use when crawling remote web sites.
</dd>
<dt><b>*UPDOPTOBJ</b></dt>
<dd>Update an options object to use when crawling remote web sites.
</dd>
<dt><b>*DLTOPTOBJ</b></dt>
<dd>Delete an options object.
</dd>
<dt><b>*CRTVLDL</b></dt>
<dd>Create a validation list object to use when crawling remote web sites.
</dd>
<dt><b>*ADDVLDLDTA</b></dt>
<dd>Add entries to a validation list object.
</dd>
<dt><b>*RMVVLDLDTA</b></dt>
<dd>Remove entries from a validation list object.
</dd>
<dt><b>*DLTVLDL</b></dt>
<dd>Delete a validation list object.
</dd>
<dt><b>*PRTIDXSTS</b></dt>
<dd>Print the status of an index.
</dd>
<dt><b>*PRTDOCLSTS</b></dt>
<dd>Print the status of a document list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.IDX"></a>
<h3>Index name (IDX)</h3>
<p>Specifies the index to be created or updated.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specifies the name of the index.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.IDXDIR"></a>
<h3>Index directory (IDXDIR)</h3>
<p>Specifies the index directory that is used for several files created during index administration.
</p>
<dl>
<dt><b><u>'/QIBM/USERDATA/HTTPSVR/INDEX'</u></b></dt>
<dd>This directory is used for the index directory.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the index directory path name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.TEXT"></a>
<h3>Index description (TEXT)</h3>
<p>Specifies the text that describes the index.
</p>
<dl>
<dt><b><u>*BLANK</u></b></dt>
<dd>No text is specified.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the text description, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.DOCLIST"></a>
<h3>Document list file (DOCLIST)</h3>
<p>Specifies the document list file that contains a list of the documents to be indexed.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the document list file path name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.STRDIR"></a>
<h3>Start directory (STRDIR)</h3>
<p>Specifies the starting directory to use to find documents to add to the document list.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the directory to use to find documents to index.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.SUBTREE"></a>
<h3>Traverse directory (SUBTREE)</h3>
<p>Specifies whether to traverse subdirectories of the starting directory when building the document list file.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Traverse the subdirectories.
</dd>
<dt><b>*NONE</b></dt>
<dd>Do not traverse subdirectories.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.PATTERN"></a>
<h3>Filter (PATTERN)</h3>
<p>Specifies the pattern or filter to use when building the document list. To find HTML files, use the filter *.HTM*.
</p>
<dl>
<dt><b><u>'*.HTM*'</u></b></dt>
<dd>This filter will find files with the extension .HTM or .HTML.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>SPecify the pattern or filter to use for selecting files to add to the document list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.CONTENT"></a>
<h3>Document content (CONTENT)</h3>
<p>Specifies the contents of the documents to be indexed.
</p>
<dl>
<dt><b><u>*HTML</u></b></dt>
<dd>Documents are HTML. All HTML tags are removed during indexing. See also IDXHTML parameter.
</dd>
<dt><b>*TEXT</b></dt>
<dd>Documents contain text.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.ALWERR"></a>
<h3>Allow file errors (ALWERR)</h3>
<p>Specifies whether to skip document file errors and continue processing the request or to stop processing on a document file error.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Allow file errors and continue processing.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not allow file errors. Stop indexing the documents.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.ENBCASE"></a>
<h3>Enable case sensitive search (ENBCASE)</h3>
<p>Specifies whether a case sensitive search is allowed for this index.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>A case sensitive search is allowed.
</dd>
<dt><b>*NO</b></dt>
<dd>Only case insensitive searches are allowed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.ALWCHAR"></a>
<h3>Valid characters (ALWCHAR)</h3>
<p>Specifies the characters that are valid for a search on this index.
</p>
<dl>
<dt><b><u>*ALPHANUM</u></b></dt>
<dd>Alphanumeric characters are valid.
</dd>
<dt><b>*ALPHA</b></dt>
<dd>Only alphabetic characters are valid.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.IDXHTML"></a>
<h3>Index HTML fields (IDXHTML)</h3>
<p>Specifies the HTML tags that are used to find additional character strings to index. If *NONE, is selected, all HTML tags are removed from the document before indexing. All searches will be done on the entire document.
</p>
<p>Any tag field that is selected will be indexed separately and will also be included in the indexing of the entire document. Tagged fields or the entire document can be selected for a search.
</p>
<p>This parameter is ignored unless CONTENT(*HTML) is also specified.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>All of the document is indexed except for HTML tags.
</dd>
</dl>
<p><b>Other values (up to 5 repetitions)</b>
</p>
<dl>
<dt><b>*TITLE</b></dt>
<dd>Index the title field.
</dd>
<dt><b>*ABSTRACT</b></dt>
<dd>Index the META tag NAME="Abstract"
</dd>
<dt><b>*AUTHOR</b></dt>
<dd>Index the META tag NAME="Author"
</dd>
<dt><b>*DESCRIPTION</b></dt>
<dd>Index the META tag NAME="Description"
</dd>
<dt><b>*KEYWORDS</b></dt>
<dd>Index the META tag NAME="Keywords"
</dd>
<dt><b>*ALLMETA</b></dt>
<dd>Index all META tags with NAME="xxxx".
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.CFG"></a>
<h3>HTTP server (CFG)</h3>
<p>Specifies the HTTP server that contains routing directives. The appropriate directives are added to the URL mapping rules file and used with the URL prefix to define the URLs that are displayed for search results.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the HTTP server containing the configuration to use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.URLPFX"></a>
<h3>Prefix for URL (URLPFX)</h3>
<p>Specifies the prefix to use for the URL for documents found on a search.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No URL prefix is used.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specifies the prefix to use for the URL such as 'http://www.mysys.com'.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.MAPFILE"></a>
<h3>Mapping rules file (MAPFILE)</h3>
<p>Specifies the name of the mapping rules file that contains routing information to use for creating URLs for documents found on a search.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specifies the path name of the mapping rules file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.DLTTYPE"></a>
<h3>Delete type (DLTTYPE)</h3>
<p>Specifies whether to delete all of the index or only the supplemental index. The supplemental index is temporarily created when new or modified documents are added to the index.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Delete the main and supplemental index.
</dd>
<dt><b>*SUPP</b></dt>
<dd>Delete only the supplemental index.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.THSDCT"></a>
<h3>Thesaurus dictionary name (THSDCT)</h3>
<p>Specifies the thesaurus dictionary that can be used on a search.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the name of the thesaurus dictionary.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.THSDCTDIR"></a>
<h3>Thesaurus directory (THSDCTDIR)</h3>
<p>Specifies the directory to use for the thesaurus dictionary. Specify a directory that is not used for search indexes.
</p>
<dl>
<dt><b><u>'/QIBM/USERDATA/HTTPSVR/SEARCH'</u></b></dt>
<dd>Directory <b>SEARCH</b> located using the directory path <b>/QIBM/USERDATA/HTTPSVR</b> is used.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specifies the thesaurus dictionary directory path name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.THSDFNF"></a>
<h3>Thesaurus definition file (THSDFNF)</h3>
<p>Specifies the thesaurus definition file used to create a thesaurus dictionary.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specifies the path name of the thesaurus definition file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.URLOBJ"></a>
<h3>URL object (URLOBJ)</h3>
<p>Specifies the URL object to use for web crawling. This parameter is used when *CRTURLOBJ or *UPDURLOBJ is specified for the OPTION parameter. This object contains a list of URLs that you want to crawl.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the name of a URL object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.DOCDIR"></a>
<h3>Document storage directory (DOCDIR)</h3>
<p>Specifies the directory to use to store documents found when crawling remote web sites. This parameter is used when *CRTURLOBJ or *UPDURLOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the directory for storing downloaded documents.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.LANG"></a>
<h3>Language of documents (LANG)</h3>
<p>Specifies the language of the documents that are to be downloaded. These language choices are similar to the character sets or encodings that can be selected on a browser. This parameter is used when *CRTURLOBJ or *UPDURLOBJ is specified for the OPTION parameter
</p>
<dl>
<dt><b>*ARABIC</b></dt>
<dd>The documents are in Arabic.
</dd>
<dt><b>*BALTIC</b></dt>
<dd>The documents are in a Baltic language such as Latvian or Lithuanian.
</dd>
<dt><b>*CENTEUROPE</b></dt>
<dd>The documents are in a Central European language such as Czech, Hungarian, Polish, Slovakian, or Slovenian.
</dd>
<dt><b>*CYRLLIC</b></dt>
<dd>The documents are in Cyrillic language such as Russian, Ukranian, or Macedonian.
</dd>
<dt><b>*ESTONIAN</b></dt>
<dd>The documents are in Estonian.
</dd>
<dt><b>*GREEK</b></dt>
<dd>The documents are in Greek.
</dd>
<dt><b>*HEBREW</b></dt>
<dd>The documents are in Hebrew.
</dd>
<dt><b>*JAPANESE</b></dt>
<dd>The documents are in Japanese.
</dd>
<dt><b>*KOREAN</b></dt>
<dd>The documents are in Korean.
</dd>
<dt><b>*SIMPCHINESE</b></dt>
<dd>The documents are in Simplified Chinese.
</dd>
<dt><b>*TRADCHINESE</b></dt>
<dd>The documents are in Traditional Chinese.
</dd>
<dt><b>*THAI</b></dt>
<dd>The documents are in Thai.
</dd>
<dt><b>*TURKISH</b></dt>
<dd>The documents are in Turkish.
</dd>
<dt><b>*WESTERN</b></dt>
<dd>The documents are in a Western language such as English, French, Spanish, or German.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.URLACT"></a>
<h3>URL list action (URLACT)</h3>
<p>Specifies the action to take on the URL list for the specifed URL object. This parameter is used when *UPDURLOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not change the URL list.
</dd>
<dt><b>*ADD</b></dt>
<dd>Add the specified URLs to the URL object.
</dd>
<dt><b>*REMOVE</b></dt>
<dd>Remove the specified URLs from the URL object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.URLLST"></a>
<h3>URL list entries (URLLST)</h3>
<p>This parameter is used when *CRTURLOBJ is specified for the OPTION parameter or *UPDURLOBJ is specified for the OPTION parameter and URLACT is *ADD. It specifies the list of URLs and URL attributes that are used in a crawling session:
</p>
<ul>
<li>URL is the Universal Resource Locator where the crawling begins.
</li>
<li>URL filter limits crawling to the specified domain.
</li>
<li>Maximum crawling depth is the distance of links found from the original URL. A depth of 0 means to limit the crawling to the starting URL. A depth of 3 means that crawling should continue for links that are 3 levels from the starting URL.
</li>
<li>Enable robots indicates whether crawling supports robot exclusion. If you select to support robot exclusion, any site or pages that contain robot exclusion META tags or files will not be downloaded.
</li>
</ul>
<p>You can specify 100 values for this parameter.
</p>
<p><b>Element 1: URL</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a starting URL.
</dd>
</dl>
<p><b>Element 2: URL filter</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not use a URL domain filter.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a URL domain filter such as 'ibm.com' with no slashes or colons.
</dd>
</dl>
<p><b>Element 3: Maximum crawling depth</b>
</p>
<p>The maximum depth to crawl from the starting URL. Zero means to stop crawling at the starting URL site. Each additional layer refers to following referenced links within the current URL.
</p>
<dl>
<dt><b><u>3</u></b></dt>
<dd>Referenced links will be crawled three layers deep.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>Referenced links will be crawled regardless of depth.
</dd>
<dt><b><i>0-100</i></b></dt>
<dd>Specify the maximum crawling depth.
</dd>
</dl>
<p><b>Element 4: Enable robots</b>
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Support robot exclusion.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not support robot exclusion.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.RMVURLLST"></a>
<h3>Remove URL list entries (RMVURLLST)</h3>
<p>Specifies the list of URLs to remove from the URL object. This parameter is used when *UPDURLOBJ is specified for the OPTION parameter and URLACT is *REMOVE. Enter up to a maximum of 100 URLs to remove from the URL list.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the URL to remove.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.OPTOBJ"></a>
<h3>Options object (OPTOBJ)</h3>
<p>Specifies the options object to use for crawling. The options object contains crawling session attributes. This parameter is used when *CRTOPTOBJ, *UPDOPTOBJ, or *DLTOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the name of the options object to use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.PRXSVR"></a>
<h3>Proxy server for HTTP (PRXSVR)</h3>
<p>Specifies the HTTP proxy server to be used. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not use an HTTP proxy server.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same HTTP proxy server.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the name of the HTTP proxy server.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.PRXPORT"></a>
<h3>Proxy port for HTTP (PRXPORT)</h3>
<p>Specifies the HTTP proxy server port. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter. A proxy server port is required if a proxy server is also specified.
</p>
<dl>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same HTTP proxy server port.
</dd>
<dt><b><i>1-65535</i></b></dt>
<dd>Specify the number of the HTTP proxy server port.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.PRXSVRSSL"></a>
<h3>Proxy server for HTTPS (PRXSVRSSL)</h3>
<p>Specifies the HTTPS proxy server for using SSL support. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not use an HTTPS proxy server.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same HTTPS proxy server.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the name of the HTTPS proxy server for SSL support.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.PRXPORTSSL"></a>
<h3>Proxy port for HTTPS (PRXPORTSSL)</h3>
<p>Specifies the HTTPS proxy server port for SSL support. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter. An HTTPS proxy server port is required if an HTTPS proxy server is also specified.
</p>
<dl>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same HTTPS proxy server port.
</dd>
<dt><b><i>1-65535</i></b></dt>
<dd>Specify the number of the HTTPS proxy server port for SSL support.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.MAXSIZE"></a>
<h3>Maximum file size (MAXSIZE)</h3>
<p>Specifies the maximum file size, in kilobytes, to download. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>1000</u></b></dt>
<dd>Download files that are no greater than 1000 kilobytes.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>All files will be downloaded regardless of size.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same maximum file size.
</dd>
<dt><b><i>1-6000</i>.</b></dt>
<dd>Specify the maximum file size to download, in kilobytes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.MAXSTGSIZE"></a>
<h3>Maximum storage size (MAXSTGSIZE)</h3>
<p>Specifies the maximum storage size, in megabytes, to allocate for downloaded files. Crawling will end when this limit is reached. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>100</u></b></dt>
<dd>Up to 100 megabytes of storage will be used for downloaded files.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>No maximum storage size for downloaded files.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same maximum storage size.
</dd>
<dt><b><i>1-65535</i>.</b></dt>
<dd>Specify the maximum storage size, in megabytes, for downloaded files.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.MAXTHD"></a>
<h3>Maximum threads (MAXTHD)</h3>
<p>Specifies the maximum number of threads to start for crawling web sites. Set this value based on the system resources that are available. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>20</u>.</b></dt>
<dd>Start up to 20 threads for web crawling.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same maximum number of threads.
</dd>
<dt><b><i>1-50</i>.</b></dt>
<dd>Specify the maximum number of threads to start.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.MAXRUNTIME"></a>
<h3>Maximum run time (MAXRUNTIME)</h3>
<p>Specifies the maximum time for crawling to run, in hours and minutes. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*NOMAX</b></dt>
<dd>Run the crawling session until it completes normally or is ended by using the ENDHTTPCRL (End HTTP Crawler) command.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object, but want to use the same maximum number of hours and minutes to run.
</dd>
</dl>
<p><b>Element 1: Hours</b>
</p>
<dl>
<dt><b><u>2</u></b></dt>
<dd>Run the crawling session for 2 hours plus the number of minutes specified.
</dd>
<dt><b><i>0-1000</i>.</b></dt>
<dd>Specify the number of hours to run the crawling session.
</dd>
</dl>
<p><b>Element 2: Minutes</b>
</p>
<dl>
<dt><b><u>0</u></b></dt>
<dd>Run the crawling session for the number of hours specified.
</dd>
<dt><b><i>0-59</i>.</b></dt>
<dd>Specify the number of minutes to run the crawling session. The crawling session will run for the number of hours specified in the first element of this parameter plus the number of minutes specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.LOGFILE"></a>
<h3>Logging file (LOGFILE)</h3>
<p>Specifies the activity logging file to be used. This file contains information about the crawling session plus any errors that occur. This file must be in a directory. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not use an activity log file.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object, but want to use the same logging file.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the logging file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.CLRLOG"></a>
<h3>Clear logging file (CLRLOG)</h3>
<p>Specifies whether to clear the activity log file before starting the crawling session. This parameter is used when *CRTOPTOBJ or *UPDOPTOBJ is specified for the OPTION parameter.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Always clear the activity log file before each crawling session.
</dd>
<dt><b>*SAME</b></dt>
<dd>Use this value when you are updating the options object but want to use the same value for clearing the logging file.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not clear the activity log file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.LSTTYPE"></a>
<h3>Document list type (LSTTYPE)</h3>
<p>Specifies whether the document list file to be registered contains paths for files on this system or for files on remote web sites that have been downloaded to this system using the web crawling function. This parameter is used when *REGDOCL is specified for the OPTION parameter
</p>
<dl>
<dt><b><u>*LOCAL</u></b></dt>
<dd>The documents in the document list are on this system.
</dd>
<dt><b>*REMOTE</b></dt>
<dd>The documents in the document list are on a remote system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.VLDL"></a>
<h3>Validation list (VLDL)</h3>
<p>Specifies the name of the validation list to use for SSL sessions. A validation list contains a URL, a userid, and password. The validation list object is owned by the signed on user and excludes public use. This parameter is used when *CRTVLDL, *ADDVLDLDTA, *RMVVLDLDTA,or *DLTVLDL is specified for the OPTION parameter.
</p>
<p><b>Restrictions:</b> Passwords will be stored in the validation list object in encrypted form. In order to store and decrypt the passwords for authentication, the system value QRETSVRSEC (Retain Server Security) must be set to 1 <b>before</b> the validation list is created. If the system value is changed from 1 to 0 once the validation list exists, the encrypted passwords will be removed and authentication will fail. In this case, the system value will need to be reset to 1 and the validation list deleted and created again.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the validation list. The validation list will be created in library QUSRSYS with the name QZHAxxxxxx where xxxxxx is the name you entered.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.VLDLE"></a>
<h3>Validation list entries (VLDLE)</h3>
<p>Specifies the list of URLs, userids, and passwords to use for SSL sessions. The userid and password pair will be used for the specified URL and any other URLs encountered while crawling within the same domain. This parameter is used when *CRTVLDL or *ADDVLDLDTA is specified for the OPTION parameter. Each validation list entry contains the following:
</p>
<ul>
<li>URL that requires authentication
</li>
<li>a userid
</li>
<li>a password
</li>
</ul>
<p>A maximum of 100 entries can be added to the validation list. This parameter is used when *CRTVLDL or *ADDVLDLDTA is specified for the OPTION parameter.
</p>
<p><b>Element 1: URL</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a URL (Universal Resource Locator).
</dd>
</dl>
<p><b>Element 2: User ID</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a valid user ID.
</dd>
</dl>
<p><b>Element 3: Password</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a password for the userid.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CFGHTTPSCH.RMVVLDLE"></a>
<h3>Remove validation list entries (RMVVLDLE)</h3>
<p>Specifies the list of URLs to remove from an existing validation list. A maximum of 100 entries can be removed from the validation list. This parameter is used when *RMVVLDLDTA is specified for the OPTION parameter.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a URL (Universal Resource Locator) that has an associated entry in the validation list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CFGHTTPSCH.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Create a Document List</b>
</p>
<p>
<pre>
CFGHTTPSCH OPTION(*CRTDOCL)
DOCLIST('/QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST')
STRDIR('/QIBM/ProdData/HTTP/Public/HTTPSVR/HTML')
</pre>
</p>
<p>This example will create a document list called /QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST from the directory /QIBM/ProdData/HTTP/Public/HTTPSVR/HTML using the defaults SUBTREE(*ALL) PATTERN('*.HTM*'). The subdirectories will be searched and only files containing the pattern *.HTM will be included in the list.
</p>
<p><b>Example 2: Create an Index</b>
</p>
<p>
<pre>
CFGHTTPSCH OPTION(*CRTIDX) IDX(myindex)
DOCLIST('/QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST')
IDXHTML(*ABSTRACT)
</pre>
</p>
<p>This example will create an index called <b>myindex</b> in index directory /QIBM/USERDATA/HTTPSVR/INDEX. The document list is in the file /QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST.
</p>
<p>In this example the following is defined:
</p>
<ul>
<li>The documents are HTML documents by default.
</li>
<li>Any file errors found for a document are ignored.
</li>
<li>Searches can be case-sensitive.
</li>
<li>Alphanumeric characters are valid search characters.
</li>
<li>The META tag with "Abstract" will be indexed separately.
</li>
<li>The character string following the META tag will also be included when the document is indexed.
</li>
<li>Searches are enabled for the entire document and the META tag field.
</li>
</ul>
<p><b>Example 3: Create a Mapping Rules File</b>
</p>
<p>
<pre>
CFGHTTPSCH OPTION(*CRTMAPF) CFG('MYCFG')
URLPFX('http://www.myserver.com')
MAPFILE(/QIBM/USERDATA/HTTPSVR/INDEX/myindex.MAP_FILE)
</pre>
</p>
<p>This example will create a mapping file called '/QIBM/USERDATA/HTTPSVR/INDEX/myindex.MAP_FILE'. The URL prefix 'http://www.myserver.com' plus all of the Pass directives from the MYCFG configuration will be copied to the mapping rules file. When documents are found on a search, the URLPFX will be followed by the path determined from the actual file path and the Pass directive.
</p>
<p>If a document is physically located at <b>/root/clothing/doc1.htm</b>, and there is a <b>Pass /clothing/* /root/clothing/*</b> directive in the configuration file, the URL for the document on the search results will be <b>http://www.myserver.com/clothing/doc1.htm</b> .
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CFGHTTPSCH.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>HTP1603</b></dt>
<dd>Request to add or delete documents was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP1608</b></dt>
<dd>Request to create an index failed. Reason &amp;1.
</dd>
<dt><b>HTP1609</b></dt>
<dd>Request to add or delete documents from an index failed. Reason &amp;1.
</dd>
<dt><b>HTP160A</b></dt>
<dd>Request to merge an index failed. Reason &amp;1.
</dd>
<dt><b>HTP160B</b></dt>
<dd>Request to delete an index failed. Reason &amp;1.
</dd>
<dt><b>HTP160C</b></dt>
<dd>Request to create or append to a document list failed. Reason &amp;1.
</dd>
<dt><b>HTP160D</b></dt>
<dd>Request to delete a document list failed. Reason &amp;1.
</dd>
<dt><b>HTP160E</b></dt>
<dd>Request to create or append to a mapping rules file failed. Reason &amp;1.
</dd>
<dt><b>HTP160F</b></dt>
<dd>*IOSYSCFG special authority required to use CHGHTTPSCH command.
</dd>
<dt><b>HTP1621</b></dt>
<dd>Request to create an index was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP1623</b></dt>
<dd>Request to create a thesaurus dictionary failed. Reason &amp;1.
</dd>
<dt><b>HTP1624</b></dt>
<dd>Request to delete a thesaurus dictionary failed. Reason &amp;1.
</dd>
<dt><b>HTP1625</b></dt>
<dd>Request to retrieve a definition file failed. Reason &amp;1.
</dd>
<dt><b>HTP164B</b></dt>
<dd>Request to create a validation list failed. Reason &amp;1.
</dd>
<dt><b>HTP164C</b></dt>
<dd>Request to add or remove entries from a validation list failed. Reason &amp;1.
</dd>
<dt><b>HTP164D</b></dt>
<dd>Request to delete a validation list failed. Reason &amp;1.
</dd>
<dt><b>HTP164F</b></dt>
<dd>Request to create or update an options object failed. Reason &amp;1.
</dd>
<dt><b>HTP165A</b></dt>
<dd>Request to delete an options object failed. Reason &amp;1.
</dd>
<dt><b>HTP165B</b></dt>
<dd>Request to create or update a URL object failed. Reason &amp;1.
</dd>
<dt><b>HTP165C</b></dt>
<dd>Request to delete URL object failed. Reason &amp;1.
</dd>
<dt><b>HTP165F</b></dt>
<dd>Request to register a document list failed. Reason &amp;1.
</dd>
<dt><b>HTP1666</b></dt>
<dd>Request to create a validation list was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP1668</b></dt>
<dd>Request to add or remove entries from a validation list was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP1669</b></dt>
<dd>Request to create or update a URL object was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP166C</b></dt>
<dd>Request to create or update a document list was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP166D</b></dt>
<dd>Request to print the status of an index failed. Reason &amp;1.
</dd>
<dt><b>HTP166E</b></dt>
<dd>Request to print the status of a document list failed. Reason &amp;1.
</dd>
<dt><b>HTP1674</b></dt>
<dd>Request to print the status of index &amp;3 in index directory &amp;4 was incomplete. Reason &amp;1.
</dd>
<dt><b>HTP1675</b></dt>
<dd>Request to print the status of document list &amp;3 was incomplete. Reason &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CFGHTTPSCH.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink