227 lines
7.7 KiB
HTML
227 lines
7.7 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>Presystem Request Program Exit Program</title>
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Begin Header Records ========================================= -->
|
||
|
|
<!-- 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 Nov 2001 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>Presystem Request Program Exit Program</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="55%">System Request menu display flag</td>
|
||
|
|
<td align="left" valign="top" width="15%">I/O</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Optional Parameter:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="55%">System Request user option data</td>
|
||
|
|
<td align="left" valign="top" width="15%">I/O</td>
|
||
|
|
<td align="left" valign="top" width="20%">CHAR(128)</td>
|
||
|
|
<td align="left" valign="top"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Exit Point Name: QIBM_QWT_SYSREQPGMS<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Exit Point Format Name: SREQ0100<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Presystem Request Program exit program is called when the user presses
|
||
|
|
the System Request key.</p>
|
||
|
|
|
||
|
|
<p>When a user presses the System Request key, the operating system calls the
|
||
|
|
user-written exit program through the registration facility. There are two
|
||
|
|
parameters used for input and output. After the exit programs from the
|
||
|
|
registration facility are called, the System Request menu is called based on
|
||
|
|
the value that is returned in the System Request menu display flag. This is the
|
||
|
|
first parameter. The second parameter contains the data the user entered on the
|
||
|
|
System Request user option line. When the user presses the the System Request
|
||
|
|
key an input line is displayed at the bottom of the screen. This allows the
|
||
|
|
user to enter one of the option numbers and relevant parameter data for any of
|
||
|
|
the options for the Systems Request menu. All data keyed into the input line,
|
||
|
|
including option numbers, will be passed to the exit programs. This data will
|
||
|
|
be passed and received from each of the exit programs called. This allows one
|
||
|
|
program to modify the data and pass it to the next program called. This data
|
||
|
|
will be passed to the user exit program in the CCSID of the job. The data that
|
||
|
|
the last Presystem Request program returns will the data that is passed to the
|
||
|
|
System Request menu. Normal error checking will be performed on the data at
|
||
|
|
that time.</p>
|
||
|
|
|
||
|
|
<p>This exit point supports eight exit programs. (For information about adding
|
||
|
|
an exit program to an exit point, see the <a href="reg1.htm">Registration
|
||
|
|
Facility APIs</a>.)</p>
|
||
|
|
|
||
|
|
<p>Before any of the exit programs in the registration facility are called, the
|
||
|
|
user profile for each user intending to use this function needs to be updated.
|
||
|
|
The Set Profile Exit Program (QWTSETPX) API needs to be called. This API will
|
||
|
|
set for the requested user profile which of the eight allowed exit programs to
|
||
|
|
call. The user can have from zero to all eight possible exit programs called.
|
||
|
|
No exit programs will be called until the QWTSETPX API is called to set the
|
||
|
|
values in the user profile. To display which exit programs will be called for a
|
||
|
|
particular user, the Retrieve Profile Exit Program (QWTRTVPX) API can be
|
||
|
|
called. (For more information about both of these APIs, see the <a href=
|
||
|
|
"wm1.htm">Work Management APIs</a>.)</p>
|
||
|
|
|
||
|
|
<p><strong>Notes:</strong></p>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>It is recommended that a command line is not displayed from a presystem
|
||
|
|
request exit program. There may be functions that do not work as expected when
|
||
|
|
issued from this type of command line.<br><br></li>
|
||
|
|
|
||
|
|
|
||
|
|
<li>The Presystem Request exit point ignores any error messages that are sent
|
||
|
|
from the exit programs. If multiple exit program are registered, all programs
|
||
|
|
will be called regardless of errors that may occur.<br><br></li>
|
||
|
|
|
||
|
|
|
||
|
|
<li>The user-registered exit program will be called with only the first
|
||
|
|
parameter unless the Pass user option data flag in the Program data section is
|
||
|
|
turned on. If this flag is turned on, the user exit program will be called with
|
||
|
|
both of the parameters.<br><br></li>
|
||
|
|
|
||
|
|
|
||
|
|
<li>It is recommended that the Presystem Request exit program exist in a
|
||
|
|
library in the system auxiliary storage pool (ASP) or in a basic user ASP. It
|
||
|
|
might not be found if it exists in a library in an independent ASP.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>User Profile Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>All object (*ALLOBJ) and security administrator (*SECADM)
|
||
|
|
special authorities are needed
|
||
|
|
to add exit programs to the registration facility
|
||
|
|
or to remove exit programs from the registration facility.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>System Request menu display flag</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; BINARY(4)
|
||
|
|
|
||
|
|
<p>Whether to display the System Request menu after the exit programs from the
|
||
|
|
registration facility have been called. The default value of 1 means that the
|
||
|
|
menu will be displayed. Any other value will mean not to display the menu. This
|
||
|
|
value will be passed to all the exit programs. The value returned from the last
|
||
|
|
program called is the value that will be used to determine if the menu should
|
||
|
|
be displayed.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Optional Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>System Request user option data</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(128)
|
||
|
|
|
||
|
|
<p>The user-entered data from the System Request user option field. The default
|
||
|
|
is all blanks.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Program Data</h3>
|
||
|
|
|
||
|
|
<p>When you register the exit program, the following is required to enable
|
||
|
|
passing of the System Request option data for the program data field.</p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Pass user option data flag</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSREQD0">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Pass user option data flag.</strong> This flag determines how many
|
||
|
|
parameters need to be passed on the call to the user exit program. If the flag
|
||
|
|
is set to a 1, then both of the parameters will be passed on the call to the
|
||
|
|
exit program. If the flag is any other value, only the first parameter will be
|
||
|
|
passed.</p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Exit program introduced: V3R7
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"wm1.htm">Work Management APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|