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

427 lines
15 KiB
HTML
Raw Normal View History

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>Print Text for OnDemand (PRTTXTOND)</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="PRTTXTOND.Top_Of_Page"></a>
<h2>Print Text for OnDemand (PRTTXTOND)</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="#PRTTXTOND.PARAMETERS.TABLE">Parameters</a><br>
<a href="#PRTTXTOND.COMMAND.EXAMPLES">Examples</a><br>
<a href="#PRTTXTOND.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="PRTTXTOND"></a>
<p>The Print Text for OnDemand (PRTTXTOND) command allows you to print all or part of a spooled file in a text-only format. This allows the report administrator to see what the report looks like to ADDRPTOND when it is indexed. Using this output, the administrator can determine how to index the report.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTTXTOND.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="#PRTTXTOND.SPLF"><b>SPLF</b></a></td>
<td valign="top">Spooled file</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#PRTTXTOND.JOB"><b>JOB</b></a></td>
<td valign="top">Job name</td>
<td valign="top">Single values: <b><u>*</u></b><br>Other values: <i>Qualified job name</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job name</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: User</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 3: Number</td>
<td valign="top">000000-999999</td>
</tr><tr>
<td valign="top"><a href="#PRTTXTOND.SPLNBR"><b>SPLNBR</b></a></td>
<td valign="top">Spooled file number</td>
<td valign="top">1-999999, <b><u>*ONLY</u></b>, *LAST, *ANY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTTXTOND.JOBSYSNAME"><b>JOBSYSNAME</b></a></td>
<td valign="top">Job system name</td>
<td valign="top"><i>Name</i>, <b><u>*ONLY</u></b>, *CURRENT, *ANY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#PRTTXTOND.CRTDATE"><b>CRTDATE</b></a></td>
<td valign="top">Spool file created</td>
<td valign="top">Single values: <b><u>*ONLY</u></b>, *LAST<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Creation date</td>
<td valign="top">
<i>Date</i></td>
</tr>
<tr>
<td valign="top">Element 2: Creation time</td>
<td valign="top">
<i>Time</i>, <b><u>*ONLY</u></b>, *LAST</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#PRTTXTOND.PAGERANGE"><b>PAGERANGE</b></a></td>
<td valign="top">Page range to print</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Starting page</td>
<td valign="top">
<i>Integer</i>, <b><u>1</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Ending page</td>
<td valign="top">
<i>Integer</i>, <b><u>10</u></b>, *END</td>
</tr>
<tr>
<td valign="top"><a href="#PRTTXTOND.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="#PRTTXTOND.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>QOND400</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>QRDARS</u></b>, *LIBL, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#PRTTXTOND.STMF"><b>STMF</b></a></td>
<td valign="top">Stream file</td>
<td valign="top"><i>Path name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTTXTOND.REPLACE"><b>REPLACE</b></a></td>
<td valign="top">Replace object</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="PRTTXTOND.SPLF"></a>
<h3>Spooled file (SPLF)</h3>
<p>Specifies the name of the spooled file to use as input to OnDemand. This is the file name that was specified by the user program when the file was created, or the name of the device file used to create this file.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.JOB"></a>
<h3>Job name (JOB)</h3>
<p>Specifies the name of the job which created the spooled file.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The job that issued this command is the job that created the spooled file.
</dd>
<dt><b><i>job-name</i></b></dt>
<dd>Specify the name of the job to use. If no job qualifier is given, all of the jobs currently in the system are searched for the simple job name. If duplicates of the specified name are found, a list of messages containing the qualified job names of all duplicates is displayed.
</dd>
<dt><b><i>user-name</i></b></dt>
<dd>Specify the user profile name that ran the job.
</dd>
<dt><b><i>number</i></b></dt>
<dd>Specify the job number assigned by the system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.SPLNBR"></a>
<h3>Spooled file number (SPLNBR)</h3>
<p>Specifies, by number, which of the job's spooled files is printed.
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>Only one spooled file in the job has the specified file name; therefore, the number of the spooled file is not necessary.
</dd>
<dt><b>*LAST</b></dt>
<dd>The spooled file with the highest number and the specified file name is used.
</dd>
</dl>
<dl>
<dt><b>*ANY</b></dt>
<dd>The spooled file number is not used to determine which spooled file is used. Use this value when the job system name parameter or the spooled file create date and time parameter is to take precedence over the spooled file number when selecting a spooled file.
</dd>
</dl>
<dl>
<dt><b><i>spooled-file-number</i></b></dt>
<dd>Specify the number of the spooled file having the specified file name to use.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.JOBSYSNAME"></a>
<h3>Job system name (JOBSYSNAME)</h3>
<p>Specifies the name of the system where the job that created the spooled file (JOB parameter) ran. This parameter is considered after the job name, user name, job number, spooled file name, and spooled file number parameter requirements have been met.
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, and spooled file create date and time.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The spooled file created on the current system with the specified job name, user name, job number, spooled file name, spooled file number, and create date and time is used.
</dd>
<dt><b>*ANY</b></dt>
<dd>The job system name is not used to determine which spooled file is used. Use this value when the spooled file create date and time parameter is to take precedence over the job system name when selecting a spooled file.
</dd>
<dt><b><i>job-system-name</i></b></dt>
<dd>Specify the name of the system where the job that created the spooled file ran.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.CRTDATE"></a>
<h3>Spool file created (CRTDATE)</h3>
<p>Specifies the date and time the spooled file was created. This parameter is considered after the job name, user name, job number, spooled file name, spooled file number, and job system name parameter requirements have been met.
</p>
<p>The possible single values are:
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, and job system name.
</dd>
<dt><b>*LAST</b></dt>
<dd>The spooled file with the latest create date and time of the specified job name, user name, job number, spooled file name, spooled file number, and job system name is used.
</dd>
</dl>
<p>The possible create date value is:
</p>
<dl>
<dt><b><i>spooled-file-create-date</i></b></dt>
<dd>Specify the date the spooled file was created.
</dd>
</dl>
<p>The possible create time values are:
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>There is one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, job system name, and spooled file create date.
</dd>
<dt><b>*LAST</b></dt>
<dd>The spooled file with the latest create time of the specified job name, user name, job number, spooled file name, spooled file number, job system name, and spooled file create date is used.
</dd>
<dt><b><i>spooled-file-create-time</i></b></dt>
<dd>Specify the time the spooled file was created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.PAGERANGE"></a>
<h3>Page range to print (PAGERANGE)</h3>
<p>Specifies the starting and ending pages to print.
</p>
<p><b>Element 1: Starting page</b>
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>Start at page 1 of the report.
</dd>
<dt><b><i>starting-page-number</i></b></dt>
<dd>Specify the starting page to print.
</dd>
</dl>
<p><b>Element 2: Ending page</b>
</p>
<dl>
<dt><b><u>10</u></b></dt>
<dd>End printing at the tenth page.
</dd>
<dt><b>*END</b></dt>
<dd>Printing continues until the last page is printed.
</dd>
<dt><b><i>ending-page-number</i></b></dt>
<dd>Specify the last page to print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.SBMJOB"></a>
<h3>Submit to batch (SBMJOB)</h3>
<p>Specify if you want to print the specified data interactively or in a batch job.
</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="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.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>QOND400</u></b></dt>
<dd>The QOND400 job description is used as the job description for the submitted job.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name (name/name) of the job description used for the job.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>QRDARS</u></b></dt>
<dd>Library QRDARS is used as the job description's library.
</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 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="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.STMF"></a>
<h3>Stream file (STMF)</h3>
<p>Specifies the path to the stream file to contain the output data.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>Output is directed to the spooled file QPRLMTXT.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specifies the path to the stream file to contain the output data.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTOND.REPLACE"></a>
<h3>Replace object (REPLACE)</h3>
<p>Specifies whether the output operation replaces or fails to copy the records to the stream file if the stream file with the specified name already exists. If the stream file does not exist, it is created.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>No records are output and an error condition is created.
</dd>
<dt><b>*YES</b></dt>
<dd>The records replace the existing stream file records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTTXTOND.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
PRTTXTOND SPLF(CKSTMTPRTF)
</pre>
</p>
<p>This command submits a job to batch to print a text-only version of the first ten pages of the CKSTMTPRTF spooled file that was generated in the current job. (This function is of particular value to aid in indexing AFP (Advanced Function Presentation) spooled files.)
</p>
<p><b>Example 2: More Complex Example</b>
</p>
<p>
<pre>
PRTTXTOND SPLF(CKSTMTPRTF) JOB(123456/OPERATOR/NIGHTBATCH)
SPLNBR(*LAST)STMF('/MYDIR/MYOUTPUT.TXT')
</pre>
</p>
<p>This command is similar to Example 1 but specifies a particular job and spooled file number (*LAST) for the spooled file as well as a stream file to receive the output.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTTXTOND.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3342</b></dt>
<dd>Job &amp;5/&amp;4/&amp;3 not found.
</dd>
<dt><b>CPF3343</b></dt>
<dd>Duplicate job names found.
</dd>
<dt><b>CPF3344</b></dt>
<dd>File &amp;1 number &amp;8 no longer in the system.
</dd>
<dt><b>CPF3492</b></dt>
<dd>Not authorized to spooled file.
</dd>
<dt><b>CPF3C40</b></dt>
<dd>Spooled file &amp;4 not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTOND.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>