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

302 lines
11 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>Print CICS Trace (PRTCICSTRC)</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="PRTCICSTRC.Top_Of_Page"></a>
<h2>Print CICS Trace (PRTCICSTRC)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>
<ul><li>Batch job (*BATCH)</li>
<li>Interactive job (*INTERACT)</li>
<li>Batch program (*BPGM)</li>
<li>Interactive program (*IPGM)</li>
<li>Batch REXX procedure (*BREXX)</li>
<li>Interactive REXX procedure (*IREXX)</li>
<li>Using QCMDEXEC, QCAEXEC, or QCAPCMD API (*EXEC)</li>
</ul><b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#PRTCICSTRC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#PRTCICSTRC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#PRTCICSTRC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="PRTCICSTRC"></a>
<p>The Print CICS Trace (PRTCICSTRC) command produces a job-oriented report from the CICS auxiliary trace user spaces. Entries are selected for inclusion in, or exclusion from, the report based upon a variety of job details and interval times.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTCICSTRC.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="#PRTCICSTRC.TRCUSRSPC"><b>TRCUSRSPC</b></a></td>
<td valign="top">Auxiliary Trace user space</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Element 1: Object name</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: Library name</td>
<td valign="top">
<i>Character value</i>, <b><u>*LIBL</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.TRCFMT"><b>TRCFMT</b></a></td>
<td valign="top">Message/data format</td>
<td valign="top">*BASIC, <b><u>*FULL</u></b>, *NONE</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.OPTION"><b>OPTION</b></a></td>
<td valign="top">Trace entry type</td>
<td valign="top">Values (up to 5 repetitions): <b><u>*ALL</u></b>, *ENTRY, *ERROR, *EVENT, *EXIT, *USER</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.TRANID"><b>TRANID</b></a></td>
<td valign="top">CICS Transaction Id</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.TERMID"><b>TERMID</b></a></td>
<td valign="top">CICS Terminal Id</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.TRCNUM"><b>TRCNUM</b></a></td>
<td valign="top">CICS Trace number</td>
<td valign="top">Values (up to 25 repetitions): <i>Hexadecimal value</i></td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#PRTCICSTRC.JOBNUM"><b>JOBNUM</b></a></td>
<td valign="top">CICS Job number</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional, Positional 7</td>
</tr>
<tr>
<td valign="top" rowspan="7"><a href="#PRTCICSTRC.PERIOD"><b>PERIOD</b></a></td>
<td valign="top">Time period of trace</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="7">Optional, Positional 8</td>
</tr>
<tr>
<td valign="top">Element 1: Start time and date</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 1: Start time</td>
<td valign="top">
<i>Time</i>, <b><u>*AVAIL</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 2: Start date</td>
<td valign="top">
<i>Date</i>, <b><u>*BEGIN</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 3: Ending time and date</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:20pt">Element 1: End time</td>
<td valign="top">
<i>Time</i>, <b><u>*AVAIL</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:20pt">Element 2: End date</td>
<td valign="top">
<i>Date</i>, <b><u>*END</u></b></td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="PRTCICSTRC.TRCUSRSPC"></a>
<h3>Auxiliary Trace user space (TRCUSRSPC)</h3>
<p>Specifies the name and location of the auxiliary trace user space object to report on.
</p>
<ul>
<p><b>Element 1: Object name:</b>
</p>
<p>Specify the name of the auxiliary trace table user space object.
</p>
<li><b>object-name:</b> The name of the auxiliary trace table user space object.
<p><b>Element 2: Library name:</b>
</p>
<p>Specify the name of the library where the CICS auxiliary trace user space object exists.
</p>
</li>
<li>*LIBL: The library list is used to locate the CICS auxiliary trace user space object.
</li>
<li><b>library-name</b> The name of the library where the auxiliary trace user space object exists.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.TRCFMT"></a>
<h3>Message/data format (TRCFMT)</h3>
<p>Specifies the type of format that is produced for this report. Possible values are:
</p>
<ul>
<li>*FULL: All trace data is printed up to a maximum of 4000 bytes.
</li>
<li>*BASIC: A maximum of 3 lines of 32 bytes each of trace data is printed.
</li>
<li>*NONE: No trace data is printed.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.OPTION"></a>
<h3>Trace entry type (OPTION)</h3>
<p>Specifies the information being printed. Any combination, up to five, of the following may be selected.
</p>
<ul>
<li>*ALL: All trace entries are selected for the report.
</li>
<li>*ENTRY: All trace entries marked as ENTRY are selected for the report.
</li>
<li>*ERROR: All trace entries marked as ERROR are selected for the report.
</li>
<li>*EVENT: All trace entries marked as EVENT are selected for the report.
</li>
<li>*EXIT: All trace entries marked as EXIT are selected for the project.
</li>
<li>*USER: All trace entries marked as USER are selected for the report.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.TRANID"></a>
<h3>CICS Transaction Id (TRANID)</h3>
<p>Specifies the transaction identifier that is to be used for producing the trace information.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.TERMID"></a>
<h3>CICS Terminal Id (TERMID)</h3>
<p>Specifies the terminal identifier that is to be used for producing the trace information.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.TRCNUM"></a>
<h3>CICS Trace number (TRCNUM)</h3>
<p>Specifies the trace numbers that are used for producing the trace information. Up to 25 may be specified.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.JOBNUM"></a>
<h3>CICS Job number (JOBNUM)</h3>
<p>Specify the six-digit number of a job to select. All six digits must be specified (use leading zeros, if necessary).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="PRTCICSTRC.PERIOD"></a>
<h3>Time period of trace (PERIOD)</h3>
<p>Specifies the period of time for which the auxiliary trace entries in the specified user space object is shown. This parameter contains two lists of two elements each.
</p>
<ul>
<p><b>Element 1: Starting Time</b>
</p>
<p>One of the following values is used to specify the starting time at which or after which the auxiliary trace entries are collected. Data collected before the specified time and date is not included in the report.
</p>
<li>*AVAIL: The auxiliary trace entries in the specified user space object that are available for the specified starting date are shown.
</li>
<li><b>start-time:</b> Specify the starting time after which the data must be collected to be included in the report. The time is specified in 24-hour format and can be specified with or without a time separator:
<ul>
<li>Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Hours, minutes, and seconds must each be exactly 2 digits (use leading zeros if necessary).
</li>
<li>With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.
</li>
</ul>
<p><b>Element 2: Starting Date</b>
</p>
<p>One of the following values is used to specify the starting date on which or after which the auxiliary trace entries are collected. Data collected before this date is not included in the report.
</p>
</li>
<li>*BEGIN: Data records starting from the beginning of the trace file are included in the report.
</li>
<li><b>start-date:</b> Specify the starting date. The date must be specified in the job date format.
<p><b>Element 3: Ending Time</b>
</p>
<p>Use one of the following values to specify the ending time. Data collected after this time and date is not included in the report.
</p>
</li>
<li>*AVAIL: The logged data that is available for the specified ending date is shown.
</li>
<li><b>end-time</b> Specify the ending time for the specified ending date that determines the auxiliary trace entries to be printed. See start-time for the formats in which time can be entered.
<p><b>Element 4: End Date</b>
</p>
<p>Use one of the following values to specify the date to end collection of the data records. Data collected after the specified date and time is not included in the report.
</p>
</li>
<li>*END: Data records through the last day and time of the collection period are included in the report.
</li>
<li><b>end-date:</b> Specify the ending date for which the auxiliary trace entries are to be printed. The date must be specified in the job date format.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTCICSTRC.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="PRTCICSTRC.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#PRTCICSTRC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>