Presystem Request Program Exit Program

The Presystem Request Program exit program is called when the user presses the System Request key.

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.

This exit point supports eight exit programs. (For information about adding an exit program to an exit point, see Registration Facility APIs.)

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 Work Management APIs.)

Notes:

1. 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.
   
   
2. 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.
   
   
3. 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.
   
   
4. 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.

Authorities and Locks

User Profile Authority

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.

Required Parameter Group

System Request menu display flag

I/O; BINARY(4)

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.

Optional Parameter Group

System Request user option data

I/O; CHAR(128)

The user-entered data from the System Request user option field. The default is all blanks.

Program Data

When you register the exit program, the following is required to enable passing of the System Request option data for the program data field.

Field Descriptions

Pass user option data flag. 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.

[ Back to top | Work Management APIs | APIs by category ]