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

452 lines
17 KiB
HTML
Raw Permalink 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 AFP Spooled File Text (PRTTXTRDAR)</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="PRTTXTRDAR.Top_Of_Page"></a>
<h2>Print AFP Spooled File Text (PRTTXTRDAR)</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="#PRTTXTRDAR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#PRTTXTRDAR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#PRTTXTRDAR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="PRTTXTRDAR"></a>
<p>The Print AFP Spooled File Text (PRTTXTRDAR) command allows you to print all or part of an AFPDS or LINEAFPDS report. This allows the reports administrator to see what the report looks like to STRCDSRDAR and to determine the values needed to define the report.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.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="#PRTTXTRDAR.REPORT"><b>REPORT</b></a></td>
<td valign="top">Report name</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="#PRTTXTRDAR.VERSION"><b>VERSION</b></a></td>
<td valign="top">Version</td>
<td valign="top">1-99, <b><u>01</u></b>, *HIGHEST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#PRTTXTRDAR.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="#PRTTXTRDAR.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><tr>
<td valign="top"><a href="#PRTTXTRDAR.PRTTYPE"><b>PRTTYPE</b></a></td>
<td valign="top">Type of print</td>
<td valign="top"><b><u>*PRINT</u></b>, *DEBUG, *TRACE</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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>Specifies that the job that created the spooled file issued this command.
</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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.REPORT"></a>
<h3>Report name (REPORT)</h3>
<p>Specifies the name of the report definition to use when printing the spooled file.
</p>
<p>
<b>Note: </b>If you press the F4 key for this parameter while prompting the command, a list of all the valid entries is presented to you.
</p>
<p>*NONE is usually the correct value to use for the report definition name. However, there are times when using a specific report definition is necessary. In V4R4M0, OnDemand introduced an improved method of determining how to print AFP data. This new method results in more accurate column locations for indexing. But these column locations will most likely be different than they would have been before this new method was introduced. If you are using PRTTXTRDAR to help index a new report or a new version of an existing report, *NONE should be used as the report name (REPORT parameter). *NONE always uses the improved method of printing. If you are modifying an existing report definition created before V4R4M0 of OnDemand, you will need to specify that report name (REPORT parameter) and version (VERSION parameter) so PRTTXTRDAR can determine which method of printing to use.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.VERSION"></a>
<h3>Version (VERSION)</h3>
<p>Specifies which version of the report definition is used to store the report.
</p>
<dl>
<dt><b><u>01</u></b></dt>
<dd>The first version of the report definition is used.
</dd>
<dt><b>*HIGHEST</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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.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="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTTXTRDAR.PRTTYPE"></a>
<h3>Type of print (PRTTYPE)</h3>
<p>Specifies how to format the printed output. Values other the *PRINT generate many, many pages of output and are primarily for program DEBUG.
</p>
<dl>
<dt><b><u>*PRINT</u></b></dt>
<dd>Print this report as a listing.
</dd>
<dt><b>*DEBUG</b></dt>
<dd>Print data and debug information. Use this with caution, an AFPDS printer file could generate 100 times the original number of pages.
</dd>
<dt><b>*TRACE</b></dt>
<dd>Print data and trace the AFP structured fields.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTTXTRDAR.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Simple Example</b>
</p>
<p>
<pre>
PRTTXTRDAR 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>
PRTTXTRDAR SPLF(CKSTMTPRTF) JOB(123456/OPERATOR/NIGHTBATCH)
SPLNBR(*LAST)REPORT(CHECKSTMTS) VERSION(*HIGHEST)
</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 an OnDemand Spool File Archive report definition name and version to ensure the correct interpretation of the AFP (Advanced Function Presentation) data for definitions created prior to V4R4.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="PRTTXTRDAR.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>
<dt><b>RDR0322</b></dt>
<dd>PRTTXTRDAR can not print this report
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTTXTRDAR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>