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

137 lines
4.3 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>End HTTP Crawler (ENDHTTPCRL)</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="ENDHTTPCRL.Top_Of_Page"></a>
<h2>End HTTP Crawler (ENDHTTPCRL)</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="#ENDHTTPCRL.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ENDHTTPCRL.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ENDHTTPCRL.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ENDHTTPCRL"></a>
<p>The End HTTP Crawling (ENDHTTPCRL) command allows you to end or temporarily pause a crawling session for a specified document list.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDHTTPCRL.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="#ENDHTTPCRL.DOCLIST"><b>DOCLIST</b></a></td>
<td valign="top">Document list file</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ENDHTTPCRL.ACTION"><b>ACTION</b></a></td>
<td valign="top">Crawling action</td>
<td valign="top">*PAUSE, <b><u>*END</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ENDHTTPCRL.DOCLIST"></a>
<h3>Document list file (DOCLIST)</h3>
<p>Specifies a document list file that was used for a crawling session that is either active or paused.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the document list file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDHTTPCRL.ACTION"></a>
<h3>Crawling action (ACTION)</h3>
<p>Specifies the action to perform on an active crawling session identified with a document list.
</p>
<dl>
<dt><b><u>*END</u></b></dt>
<dd>End the crawling session.
</dd>
</dl>
<dl>
<dt><b>*PAUSE</b></dt>
<dd>Pause or temporarily suspend the crawling session. A paused session can be resumed by running the Resume HTTP Crawler (RSMHTTPCRL) command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDHTTPCRL.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Ending a Crawling Session</b>
</p>
<p>
<pre>
ENDHTTPCRL
DOCLIST('/QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST')
ACTION(*END)
</pre>
</p>
<p>This command ends the crawling session that had been previously started using document list file <b>myindex.DOCUMENT.LIST</b> located in the directory path <b>/QIBM/USERDATA/HTTPSVR/INDEX</b>.
</p>
<p><b>Example 2: Ending a Crawling Session</b>
</p>
<p>
<pre>
ENDHTTPCRL
DOCLIST('/QIBM/USERDATA/HTTPSVR/INDEX/myindex.DOCUMENT.LIST')
ACTION(*PAUSE)
</pre>
</p>
<p>This command pauses a crawling session that had been previously started. The crawling session can be resumed by running the Resume HTTP Crawler (RSMHTTPCRL) command and specifying the same document list file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDHTTPCRL.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>HTP165E</b></dt>
<dd>Request to pause or end a crawling session failed. Reason &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDHTTPCRL.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>