The user exit, which must be named MFJYssss, and where ssss is the subsystem-name, is optional and is invoked as follows:
CALL 'MFJYssss' USING SXIT
Where SXIT is the user exit interface block (mfjdsxit.cpy). It contains
- A header part that contains among other items, the event code of the event and the action code that represents the action
that can be requested.
- A data part that contains the data describing the event.
mfjdsxit.cpy describes in detail all of the event codes, actions codes, and the data associated with each event. When looking at
mfjdsxit.cpy, note the following:
- Field names containing -I- (for example SXIT-I-size) are input to the subsystem exit and must not be modified.
- Field names containing -U- (for example SXIT-U-PGM-alias) are used for input and output. On entry to the subsystem exit, they
are set as appropriate and may be changed by the subsystem exit to an acceptable value upon return.
- All character data is in ASCII (ANSI). Null values are those appropriate for the data type; that is blanks for character data,
and zeros for numeric and binary data.
The subsystem exit is called as events occur.
If the user exit fails for any reason, it is disabled in the failing process for all subsequent events.
Note:
- The user exit must be named
mfjyssss.cbl. The source for each sample exit is available in
%ProgramFiles(x86)%\Micro Focus\Enterprise Developer\src\enterpriseserver\exits (Windows) or
$COBDIR/src/enterpriseserver/exit (UNIX). We recommend you use this as the base to build an exit to suit your needs. It uses a copybook for SXIT (the subsystem exit
interface block). The source for this copybook,
mfjdsxit.cpy, is in
%ProgramFiles(x86)%\Micro Focus\Enterprise Developer\cpylib (Windows) or
$COBDIR/include (UNIX). A listing of
mfjdsxit.cpy is provided in the topic
Subsystem Exit Interface Block (mfjdsxit.cpy).
- The subsystem exit must use the ASCII (ANSI) character set. We recommend that it uses the non-mainframe COBOL dialect as it is a PC-specific program.
- The exit is optional. The
.dll (Windows) or
.so (UNIX)
file for the subsystem exit must be placed in a directory that is specified in the search path of
PATH (Windows) or
$COBDIR
(UNIX).
If you want it to be in a location independent of the project, then you may place it in
%ProgramFiles(x86)%\Micro Focus\Enterprise Developer\bin (UNIX).
- You must write the subsystem exit in COBOL.