User Application Administration Exit Program
Required Parameter Group:
| 1 | Exit processing indicator | Output | Char(4) |
Exit Point Name: QIBM_QOE_USR_ADM Exit Point Format Name: UADM0100
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.
Program Registration
To register user exit programs, see Registration Facility APIs. If you use the callable API, be sure to specify all 20 characters (the 19-character API followed by a blank character).
Required Parameter
- Exit processing indicator
- OUTPUT; CHAR(4)
This is provided for communication from the user exit program back to the OfficeVision® programs. The valid values are listed later.
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.
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.
0000 No additional processing is required for this request. That is, processing is complete for the user exit program. 0002 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. A message will be put in the job log identifying the user exit program and library that requested this cancelation.
Processing of multiple user exit programs
The user may have multiple user exit programs registered for this exit point. Each exit program will have an exit program number defined when it is registered.
- The lowest numbered registered exit program will be called first.
- The second lowest numbered registered exit program will be called.
- This process will continue until all of the registered user exit programs
for this exit point have been called.
- The lowest numbered registered exit program will be called first.
Exit Program Introduced: V3R1
[ Back to top | Office APIs | APIs by category ]