friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/strmonrdar.htm

526 lines
19 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>Start Monitor for OnDemand (STRMONRDAR)</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="STRMONRDAR.Top_Of_Page"></a>
<h2>Start Monitor for OnDemand (STRMONRDAR)</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="#STRMONRDAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#STRMONRDAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#STRMONRDAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="STRMONRDAR"></a>
<p>The Start Monitor for OnDemand (STRMONRDAR) command allows you to specify the name of an output queue to monitor. When a spooled file is added to the output queue, the spooled file is automatically processed by STRCDSRDAR. You can end the monitor by:
</p>
<ul>
<li>Specifying a date and time to end on this command.
</li>
<li>Running the ENDMONRDAR command.
</li>
<li>Ending the monitor job using the ENDJOB command. Specify OPTION(*CNTRLD) and DELAY(999999). The job will end as soon as the monitor finishes processing the current report.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRMONRDAR.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="#STRMONRDAR.OUTQ"><b>OUTQ</b></a></td>
<td valign="top">Output queue</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: 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="4"><a href="#STRMONRDAR.RPTNAMSRC"><b>RPTNAMSRC</b></a></td>
<td valign="top">Value to use as report name</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Check first</td>
<td valign="top">
<b><u>*SPLFNAME</u></b>, *FORMTYPE, *USERDATA</td>
</tr>
<tr>
<td valign="top">Element 2: Check next</td>
<td valign="top">
<b><u>*NONE</u></b>, *FORMTYPE, *USERDATA, *SPLFNAME</td>
</tr>
<tr>
<td valign="top">Element 3: Check last</td>
<td valign="top">
<b><u>*NONE</u></b>, *USERDATA, *SPLFNAME, *FORMTYPE</td>
</tr>
<tr>
<td valign="top"><a href="#STRMONRDAR.VERSION"><b>VERSION</b></a></td>
<td valign="top">Version</td>
<td valign="top">1-99, <b><u>*HIGHEST</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRMONRDAR.ERROUTQ"><b>ERROUTQ</b></a></td>
<td valign="top">Error output queue</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Error output queue</td>
<td valign="top"><i>Name</i>, <b><u>ERROR</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>QUSRRDARS</u></b>, *LIBL, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#STRMONRDAR.DLTSPLF"><b>DLTSPLF</b></a></td>
<td valign="top">Delete processed spooled files</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRMONRDAR.PRCOUTQ"><b>PRCOUTQ</b></a></td>
<td valign="top">Processed output queue</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Processed output queue</td>
<td valign="top"><i>Name</i>, <b><u>PROCESSED</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>QUSRRDARS</u></b>, *LIBL</td>
</tr><tr>
<td valign="top"><a href="#STRMONRDAR.ENDDATE"><b>ENDDATE</b></a></td>
<td valign="top">End date</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *TODAY, *TIME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRMONRDAR.ENDTIME"><b>ENDTIME</b></a></td>
<td valign="top">Time to end</td>
<td valign="top"><i>Time</i>, <b><u>235500</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRMONRDAR.CHKITV"><b>CHKITV</b></a></td>
<td valign="top">Check interval</td>
<td valign="top">0-99999, <b><u>90</u></b>, *IMMED, *MAX</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRMONRDAR.NBRMON"><b>NBRMON</b></a></td>
<td valign="top">Number of monitors to start</td>
<td valign="top">1-99, <b><u>1</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRMONRDAR.SBMJOB"><b>SBMJOB</b></a></td>
<td valign="top">Submit to batch</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRMONRDAR.JOBD"><b>JOBD</b></a></td>
<td valign="top">Job description</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job description</td>
<td valign="top"><i>Name</i>, <b><u>QRDARS400</u></b></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="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="STRMONRDAR.OUTQ"></a>
<h3>Output queue (OUTQ)</h3>
<p>Specifies the name and library of the output queue for which a monitor is to be started.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Output queue</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the output queue to monitor.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is where the output queue is located. 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 output queue is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.RPTNAMSRC"></a>
<h3>Value to use as report name (RPTNAMSRC)</h3>
<p>Specifies which spooled file attribute to use as the report name source. Up to three sources can be specified. If a valid report definition is not found using the first source, the second source is used. If a valid report definition is not found using the second source, the third source is used.
</p>
<p>Each value other than *NONE can only be used once.
</p>
<p><b>Element 1: Check first</b>
</p>
<dl>
<dt><b><u>*SPLFNAME</u></b></dt>
<dd>Use the spooled file name as the source for the report name.
</dd>
<dt><b>*FORMTYPE</b></dt>
<dd>Use the form type as the source for the report name.
</dd>
<dt><b>*USERDATA</b></dt>
<dd>Use the user data as the source for the report name.
</dd>
</dl>
<p><b>Element 2: Check next</b> and <b>Element 3: Check last</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No further sources should be checked.
</dd>
<dt><b>*SPLFNAME</b></dt>
<dd>Use the spooled file name as the source for the report name.
</dd>
<dt><b>*FORMTYPE</b></dt>
<dd>Use the form type as the source for the report name.
</dd>
<dt><b>*USERDATA</b></dt>
<dd>Use the user data as the source for the report name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.VERSION"></a>
<h3>Default version to process (VERSION)</h3>
<p>Specifies which version of the report definition is used to store the report.
</p>
<dl>
<dt><b><u>*HIGHEST</u></b></dt>
<dd>The highest defined version of the report definition is used.
</dd>
<dt><b><i>01-99</i></b></dt>
<dd>Specify the version number of the report to use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.ERROUTQ"></a>
<h3>Error output queue (ERROUTQ)</h3>
<p>Specifies the name of the output queue to receive spooled files that STRCDSRDAR fails to store.
</p>
<p><b>Qualifier 1: Error output queue</b>
</p>
<dl>
<dt><b><u>ERROR</u></b></dt>
<dd>Spooled files that are not stored are placed in the output queue named ERROR.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the output queue to receive spooled files that fail to store.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>QUSRRDARS</u></b></dt>
<dd>The output queue is located in library QUSRRDARS.
</dd>
<dt><b>*LIBL</b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is where the output queue is located. 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 output queue is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.DLTSPLF"></a>
<h3>Delete processed spooled files (DLTSPLF)</h3>
<p>Specifies whether or not to delete a spooled file that STRCDSRDAR stores successfully. If STRCDSRDAR is unsuccessful, the spooled file is not deleted.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The spooled file is never automatically deleted.
</dd>
<dt><b>*YES</b></dt>
<dd>The spooled file is only deleted if the reports were stored.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.PRCOUTQ"></a>
<h3>Processed output queue (PRCOUTQ)</h3>
<p>Specifies the name of the output queue to receive spooled files that STRCDSRDAR stores.
</p>
<p><b>Qualifier 1: Processed output queue</b>
</p>
<dl>
<dt><b><u>PROCESSED</u></b></dt>
<dd>Spooled files that are stored are placed in the output queue named PROCESSED.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the output queue to receive spooled files that were stored.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>QUSRRDARS</u></b></dt>
<dd>The output queue is located in library QUSRRDARS.
</dd>
<dt><b>*LIBL</b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is where the output queue is located. 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 output queue is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.ENDDATE"></a>
<h3>End date (ENDDATE)</h3>
<p>Specifies the date when the monitor will automatically end.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Do not automatically end the monitor.
</dd>
<dt><b>*TODAY</b></dt>
<dd>The monitor ends today at the time specified on the ENDTIME parameter.
</dd>
<dt><b>*TIME</b></dt>
<dd>The monitor will end at the time specified on the ENDTIME parameter regardless of what date it is. If the ENDTIME is after the current time, the ENDDATE is set to *TODAY. If the ENDTIME is before the current time, the ENDDATE is effectively set to tomorrow's date.
</dd>
<dt><b><i>ending-date</i></b></dt>
<dd>Specify the date that you want the monitor to end. The date must be today or later.
<p>Specify a date using the format YYYYMMDD where YYYY represents the year, MM the month, and DD the day. Do not use any type of special characters to separate year, month, and day values.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.ENDTIME"></a>
<h3>Time to end (ENDTIME)</h3>
<p>Specifies the time when the monitor will automatically end.
</p>
<dl>
<dt><b><u>235500</u></b></dt>
<dd>The monitor will automatically end at 11:55 pm.
</dd>
<dt><b><i>ending-time</i></b></dt>
<dd>Specify the time that the monitor should end. This time is specified in HHMMSS format where HH is the hour, MM is the minute and SS is the second.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.CHKITV"></a>
<h3>Check interval (CHKITV)</h3>
<p>Specifies in seconds, how long the monitor will wait for a spooled file to become ready on the output queue. Once this time has expired, a check is made to see if:
</p>
<ul>
<li>The ENDDATE and ENDTIME values are met.
</li>
<li>The ENDMONRDAR command has been issued.
</li>
<li>An ENDJOB with the OPTION(*CNTRLD) has bee issued for this job.
</li>
</ul>
<p>
<b>Note: </b>Specifying a small value will cause the monitor to use more of the available CPU time.
</p>
<dl>
<dt><b><u>90</u></b></dt>
<dd>The monitor will wait up to 90 seconds for a spooled file to become ready.
</dd>
<dt><b>*IMMED</b></dt>
<dd>The monitor will not wait for a spooled file to become ready. It constantly checks to see if a spooled file is ready.
</dd>
<dt><b>*MAX</b></dt>
<dd>The monitor will wait forever for a spooled file to become ready. Whenever a spooled file does become ready, a check is made to see if the monitor should end (either ending time or ENDMONRDAR issued or ENDJOB).
</dd>
<dt><b><i>time-interval</i></b></dt>
<dd>Specify the number of seconds to wait for a spooled file to become ready in the output queue. The value must be between 0 and 9999 seconds. A value of 0 causes the monitor to continuously check if there are any spooled files that are ready.
<p>
<b>Note: </b>Specifying a smaller number will cause degraded performance for lower priority jobs.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.NBRMON"></a>
<h3>Number of monitors to start (NBRMON)</h3>
<p>Specifies the number of monitors to start with these characteristics.
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>One monitor is started.
</dd>
<dt><b><i>1-99</i></b></dt>
<dd>A number representing the number of monitors to start.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.SBMJOB"></a>
<h3>Submit to batch (SBMJOB)</h3>
<p>Specifies if you want to monitor the output queues in this current job or in a another job.
</p>
<p>
<b>Note: </b>*YES must be specified when the NBRMON parameter is greater than 1.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>This command should be submitted to run in a different job.
</dd>
<dt><b>*NO</b></dt>
<dd>This command should be run within the current job. If you are entering this command from a terminal, this will prevent you from doing any other work from this terminal session until this command completes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRMONRDAR.JOBD"></a>
<h3>Job description (JOBD)</h3>
<p>Specifies the name of the job description used for the submitted job.
</p>
<p><b>Qualifier 1: Job description</b>
</p>
<dl>
<dt><b><u>QRDARS400</u></b></dt>
<dd>The QRDARS400 job description is used as the job description for the submitted job.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the job description used for the job.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the job description name. 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 job description name is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRMONRDAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
STRMONRDAR OUTQ(QUSRRDARS/ONDEMANDQ)
</pre>
</p>
<p>This command submits a job to batch that monitors for spooled files that are to be archived into OnDemand Spooled File Archive. When issued with no other parameters, the monitor uses the spooled file name attribute of the spooled file as the report definition name. Spooled files that do not archive successfully are moved to the ERROR output queue in the QUSRRDARS library. Spooled files that do archive successfully are also not deleted; they are moved to the PROCESSED output queue in the QUSRRDARS library. This command as shown will submit the monitor job without any specified end criteria.
</p>
<p><b>Example 2: More Complex Example</b>
</p>
<p>
<pre>
STRMONRDAR OUTQ(QUSRRDARS/ONDEMANDQ)
RPTNAMSRC(*SPLFNAME *FORMTYPE *USERDATA)
DLTSPLF(*YES) ENDDATE(*TIME) ENDTIME(235900)
</pre>
</p>
<p>This command submits a job to batch that monitors for spooled files that are to be archived into OnDemand Spool File Archive. The monitor attempts to use spooled file name and then form type and then user data attributes of the spooled file (in that order) for use as the report definition name. With this command example, successfully processed spooled files are deleted automatically; spooled files that do not archive successfully are moved to the ERROR output queue in the QUSRRDARS library. In this example, the monitor will end at one minute before midnight of the current day.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRMONRDAR.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>OND0281</b></dt>
<dd>Output queue &amp;1 in library &amp;2 can not be monitored. Another monitor is already active.
</dd>
<dt><b>RDR0184</b></dt>
<dd>Output queue &amp;1 in library &amp;2 can not be monitored. No data queue is or can be attached.
</dd>
<dt><b>RDR0186</b></dt>
<dd>Output Queue &amp;1 in library &amp;2 not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRMONRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink