148 lines
4.9 KiB
HTML
148 lines
4.9 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>User Application Administration 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 ========================================== -->
|
||
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
||
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
||
|
|
<!--File Edited October 2001 -->
|
||
|
|
<!--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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>User Application Administration Exit Program</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Required 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="50%">Exit processing indicator</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
Exit Point Name: QIBM_QOE_USR_ADM
|
||
|
|
|
||
|
|
Exit Point Format Name: UADM0100
|
||
|
|
</pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The main administration panel has option 50 (User Application
|
||
|
|
Administration) that passes control to the application enabler. One or more of
|
||
|
|
the registered alternate administration programs is then called.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Program Registration</h3>
|
||
|
|
|
||
|
|
<p>To register user exit programs, see <a href="reg1.htm">Registration Facility
|
||
|
|
APIs</a>. If you use the callable API, be sure to specify all 20 characters
|
||
|
|
(the 19-character API followed by a blank character).</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Exit processing indicator</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(4)
|
||
|
|
|
||
|
|
<p>This is provided for communication from the user exit program back to the
|
||
|
|
OfficeVision programs. The valid values are listed later.</p>
|
||
|
|
|
||
|
|
<p>Any code returned that is not valid will cause an information message to be
|
||
|
|
sent to the job log. This message will identify the invalid return code
|
||
|
|
received, the user exit program name, and the library name that issued the
|
||
|
|
invalid return code. After the information message has been sent to the job
|
||
|
|
log, processing will continue as if a 0000 return code had been returned from
|
||
|
|
the user exit program.</p>
|
||
|
|
|
||
|
|
<p>An exception condition returned from the user exit program to the
|
||
|
|
OfficeVision program will post an information message in the job log. This
|
||
|
|
message will attempt to identify the user exit program name and the library
|
||
|
|
name that caused the exception. After the information message has been sent to
|
||
|
|
the job log, processing will continue as if a 0000 return code had been
|
||
|
|
returned from the user exit program.</p>
|
||
|
|
|
||
|
|
<table cellpadding="3">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>0000</em></td>
|
||
|
|
<td valign="top">No additional processing is required for this request. That
|
||
|
|
is, processing is complete for the user exit program.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>0002</em></td>
|
||
|
|
<td valign="top">The user exit program requests cancelation of calling
|
||
|
|
additional user exit programs. This provides the opportunity for a user exit
|
||
|
|
program to support an end user request to stop processing any additional user
|
||
|
|
exit programs and immediately return to the administration main menu. The user
|
||
|
|
exit program should take into consideration that the end user may not
|
||
|
|
understand the impact of the cancel request. Also, consider that the
|
||
|
|
administrator has the opportunity to change the user exit program numbers and
|
||
|
|
may cause a change in the processing sequence of multiple user exit programs.
|
||
|
|
|
||
|
|
<p>A message will be put in the job log identifying the user exit program and
|
||
|
|
library that requested this cancelation.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Processing of multiple user exit programs</strong></p>
|
||
|
|
|
||
|
|
<p>The user may have multiple user exit programs registered for this exit
|
||
|
|
point. Each exit program will have an <em>exit program number</em> defined when
|
||
|
|
it is registered.</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The lowest numbered registered exit program will be called first.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>The second lowest numbered registered exit program will be called.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>This process will continue until all of the registered user exit programs
|
||
|
|
for this exit point have been called.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
Exit Program Introduced: V3R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"off1a.htm">Office APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|