ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwtdmpfr.htm

229 lines
6.4 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Dump Flight Recorder (QWTDMPFR) API</title>
<!-- Begin Header Records ========================================= -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- WM SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- File cleanup completed on 13 July 2001 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Dump Flight Recorder (QWTDMPFR) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="60%">Qualified job name</td>
<td align="left" valign="top" width="15%">Input</td>
<td align="left" valign="top" width="15%">Char(26)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE&nbsp;<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No&nbsp;<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Dump Flight Recorder (QWTDMPFR) API dumps the contents of flight
recorders for jobs that have them. A <strong>flight recorder</strong> is an
object that stores trace information to record a history of what has happened
in system programs. The flight recorder contains only information that helps to
identify the flow of system programs and status information.
The flight recorder for a job is a temporary object
and is not available after an IPL.</p>
<p>The following types of jobs have flight recorders:</p>
<ul>
<li>Subsystem monitors</li>
<li>System jobs</li>
</ul>
<p>You can use the QWTDMPFR API to collect information
for your IBM service representative.
This API dumps the contents of job flight recorders
to spooled files.
You can then collect the files and submit them
to your IBM service representative for debugging.</p>
<h3>Authorities and Locks</h3>
<p>None.</p>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Qualified job name</strong></dt>
<dd>INPUT; CHAR(26)
<p>The name of the job whose flight recorder is to be dumped.
The qualified job name has three parts:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>Job name</em></td>
<td align="left" valign="top">CHAR(10). A specific job name or one of the
following special values:
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*ACTIVE</em></td>
<td align="left" valign="top">The flight recorders for
all active system jobs and all active subsystem monitor jobs
is dumped.
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>User name</em></td>
<td align="left" valign="top">CHAR(10). A specific user profile name, or blanks
when the job name is a special value.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Job number</em></td>
<td align="left" valign="top">CHAR(6). A specific job number, or blanks when
the job name is a special value.</td>
</tr>
</table>
<br>
</dd>
</dl>
<h3><a name="USAGE_NOTES">Usage Notes</a></h3>
<p>The QWTDMPFR API can be called with no parameters.
This invocation dumps flight recorders
for all active system jobs and all active subsystem monitor jobs.
This is usually the best choice.
You can use a <strong>Call Program (CALL)</strong> command
from the <strong>Command Entry</strong> prompt.
</p>
<pre>
CALL&nbsp;PGM(QSYS/QWTDMPFR)
</pre>
<p>The QWTDMPFR API can be called with one parameter.
This allows you to dump the flight recorder for a single job.
The job does not need to be active,
as long as there has not been an IPL since the job was active.
You can use a <strong>Call Program (CALL)</strong> command
from the <strong>Command Entry</strong> prompt
and use a job name parameter.
The qualified job name must be specified in upper case characters
because the command analyzer does not change character strings
that appear between quote marks.
</p>
<pre>
CALL&nbsp;PGM(QSYS/QWTDMPFR)&nbsp;PARM('QTAPARB&nbsp;&nbsp;&nbsp;QSYS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;001234')
</pre>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1321 E</td>
<td align="left" valign="top">Job &amp;1 user &amp;2 job number &amp;3 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1332 E</td>
<td align="left" valign="top">End of duplicate job names.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3B E</td>
<td align="left" valign="top">Value for parameter &amp;2 for API &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running
of &amp;1 API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9800 E</td>
<td align="left" valign="top">All CPF98xx messages could be signaled. xx is
from 01 to FF.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top">Top</a> | <a href="wm1.htm">
Work Management APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>