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

331 lines
13 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>Start Remote Writer (STRRMTWTR)</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="STRRMTWTR.Top_Of_Page"></a>
<h2>Start Remote Writer (STRRMTWTR)</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="#STRRMTWTR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#STRRMTWTR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#STRRMTWTR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="STRRMTWTR"></a>
<p>The Start Remote Writer (STRRMTWTR) command starts a spooling writer that sends spooled files from an output queue to a remote system. The writer, which is a system job, takes spooled files from an output queue and sends them to a remote system using SNADS or TCP/IP.
</p>
<p>After the spooled file is successfully sent to a remote system, the spooled file will be deleted or saved, as specified by the SAVE spooled file attribute.
</p>
<p>More than one writer can be active at the same time (as determined by the spooling subsystem description), and up to 10 writers can be active to the same output queue. Each writer must have a unique writer name, and only one type (print, remote, or diskette) of writer can be active to a single output queue. A writer that has been started can be actively sending output or waiting for a file to be put on the output queue. Optionally, the writer can end automatically when it has processed all the files on the output queue. You can also change, hold, or cancel the writer.
</p>
<p>You can continue with other work after starting a writer because each job runs independently. The writer is owned by the user who issues the STRRMTWTR command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRRMTWTR.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="#STRRMTWTR.OUTQ"><b>OUTQ</b></a></td>
<td valign="top">Output queue</td>
<td valign="top">Single values: *ALL<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Output queue</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="#STRRMTWTR.MSGQ"><b>MSGQ</b></a></td>
<td valign="top">Queue for writer messages</td>
<td valign="top">Single values: <b><u>*OUTQ</u></b>, *REQUESTER<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Queue for writer messages</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="#STRRMTWTR.FORMTYPE"><b>FORMTYPE</b></a></td>
<td valign="top">Form type options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Form type</td>
<td valign="top">
<i>Character value</i>, <b><u>*ALL</u></b>, *STD, *FORMS</td>
</tr>
<tr>
<td valign="top">Element 2: Message option</td>
<td valign="top">
<b><u>*NOMSG</u></b>, *INQMSG, *MSG, *INFOMSG</td>
</tr>
<tr>
<td valign="top"><a href="#STRRMTWTR.WTR"><b>WTR</b></a></td>
<td valign="top">Writer</td>
<td valign="top"><i>Name</i>, <b><u>*OUTQ</u></b>, *SYSGEN</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRRMTWTR.AUTOEND"><b>AUTOEND</b></a></td>
<td valign="top">Auto-end options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top">Element 1: Automatically end writer</td>
<td valign="top">
<b><u>*NO</u></b>, *YES</td>
</tr>
<tr>
<td valign="top">Element 2: If yes, when to end</td>
<td valign="top">
<b><u>*NORDYF</u></b>, *FILEEND</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="STRRMTWTR.OUTQ"></a>
<h3>Output queue (OUTQ)</h3>
<p>Specifies the output queue that holds the spooled files to be written.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>Starts remote writers for every output queue on the system which have a remote system specified. No writer starts if an output queue has a different type of writer already started. The number of "writers to autostart" attribute in the output queue determines the number of writers started to a particular queue. This will determine how many remote writer jobs will be sending spooled output to a remote system, from a single output queue.
</dd>
</dl>
<p><b>Qualifier 1: Output queue</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the output queue from which the writer processes output files.
</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 thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRRMTWTR.MSGQ"></a>
<h3>Queue for writer messages (MSGQ)</h3>
<p>Specifies the message queue to which messages created by the writer are sent.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*OUTQ</u></b></dt>
<dd>Messages are sent to the message queue of the output queue specified on the OUTQ parameter.
</dd>
<dt><b>*REQUESTER</b></dt>
<dd>The messages are sent to the workstation message queue of the workstation of the user who started the writer. If this value is specified for a batch job, *OUTQ is used.
</dd>
</dl>
<p><b>Qualifier 1: Queue for writer messages</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the message queue to which messages created by the writer are sent.
</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 thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRRMTWTR.FORMTYPE"></a>
<h3>Form type options (FORMTYPE)</h3>
<p>Specifies the name of the form type. The writer uses this value to select spooled files from the specified output queue for sending to a remote system.
</p>
<p>
<b>Note: </b>A spooled file's form type is specified in the device file that produced the spooled file.
</p>
<p><b>Element 1: Form type</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All form types are processed by the writer.
</dd>
<dt><b>*FORMS</b></dt>
<dd>The writer first chooses the first available spooled file on the output queue. After the first spooled file is complete, all spooled files with the same form type are processed. The writer then chooses the first available spooled file on the output queue and repeats the process for that form type.
</dd>
<dt><b>*STD</b></dt>
<dd>Only spooled files that specify the standard form type are selected.
</dd>
<dt><b><i>form-type</i></b></dt>
<dd>Specify the form type of the spooled files being produced.
</dd>
</dl>
<p><b>Element 2: Message option</b>
</p>
<dl>
<dt><b><u>*NOMSG</u></b></dt>
<dd>Neither an inquiry message nor an informational message is sent to the message queue.
</dd>
<dt><b>*INQMSG</b></dt>
<dd>An inquiry message is sent to the message queue when a spooled file has a form type that is different than the form type last sent.
</dd>
<dt><b>*INFOMSG</b></dt>
<dd>An informational message is sent to the message queue when no spooled files requiring this form type remain in the output queue.
</dd>
<dt><b>*MSG</b></dt>
<dd>An inquiry message is sent to the message queue when a spooled file has a form type that is different than the form type in the remote and an informational message is sent when no spooled files requiring this form type remain in the output queue.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRRMTWTR.WTR"></a>
<h3>Writer (WTR)</h3>
<p>Specifies the spooling writer being started. Each writer name must be unique.
</p>
<dl>
<dt><b><u>*OUTQ</u></b></dt>
<dd>The name of the writer is the same as that of the output queue specified on the OUTQ parameter. If OUTQ(*ALL) is specified, and you have more than one writer to start, the name for each additional writer is taken from the first nine characters of the output queue followed by a digit. This last digit is sequentially assigned, starting with 2 for the second writer, 3 for the third writer, and continuing through 0 for the tenth writer.
</dd>
<dt><b>*SYSGEN</b></dt>
<dd>The writer name is generated by the system, starting with 'RMTW000001' and incrementing the numeric part for each successive writer.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name by which the writer being started is identified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRRMTWTR.AUTOEND"></a>
<h3>Auto-end options (AUTOEND)</h3>
<p>Specifies whether the writer ends automatically.
</p>
<p>Element 1: Stop Writer Option
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The writer does not end when the last available file has been removed from the output queue. It waits for another spooled file entry to be put on the queue. This is a single value (Element 2 is not specified).
</dd>
<dt><b>*YES</b></dt>
<dd>The writer automatically ends after it has reached the condition specified on the second element of this parameter.
</dd>
</dl>
<p>Element 2: Conditions for Stopping Writer
</p>
<dl>
<dt><b><u>*NORDYF</u></b></dt>
<dd>The writer automatically ends when there are no ready files (all the available files have been removed from the output queue).
</dd>
<dt><b>*FILEEND</b></dt>
<dd>The writer ends after it finishes processing one spooled file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRRMTWTR.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
STRRMTWTR OUTQ(RMTOUTQ) WTR(TOM)
</pre>
</p>
<p>This command starts a spooling writer named TOM. This writer takes the output from the output queue named RMTOUTQ and sends the output to the remote system and printer queue specified in the output queue RMTOUTQ. Writer messages are sent to the system operator's message queue, and the writer waits for more output when the queue is emptied.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRRMTWTR.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF330A</b></dt>
<dd>Output queue &amp;1 has RMTSYS specified as *NONE.
</dd>
<dt><b>CPF3305</b></dt>
<dd>Output queue &amp;1 in library &amp;2 assigned to another writer.
</dd>
<dt><b>CPF3310</b></dt>
<dd>Writer &amp;1 already started.
</dd>
<dt><b>CPF3357</b></dt>
<dd>Output queue &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF3362</b></dt>
<dd>Objects in QTEMP not valid for parameter values.
</dd>
<dt><b>CPF3363</b></dt>
<dd>Message queue &amp;1 in library &amp;2 not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRRMTWTR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>