Global User Exits

#### Search Results

Search

# Global User Exits

This section describes the global user exits that can be used to perform version, JCL, symbol or message validation checks in the whole Entire Operations environment. This is useful, for example, if no specific validation checks are defined for single job networks.

Note
The existence of the defined global user exits is checked during the Entire Operations Monitor startup. If at least one of these exits cannot be found, the Entire Operations Monitor performs an immediate shutdown.

The following applies:

- A global user exit may exist only once within the whole Entire Operations installation.

- All global user exits are optional.

- The user exits must reside as Natural objects in the SYSEORU library.

- The same coding rules and restrictions apply as described in the sections User Exits and Starting an Edit Session in the User's Guide apply.

This document covers the following topics:

- Accessing Global User Exits

- Global Exit for Version Names

- Global JCL Activation Exit

- Global Symbol Modification Exit

- Global Symbol Not Found Exit

- Global Message Sending Exit

#### Related Topic:

- User Exits in the User's Guide

## Accessing Global User Exits

To access and maintain global user exits

1. From the System Services Menu, select the Global User Exits option and press ENTER.

   A Global User Exits (optional) screen like the example below appears:

       17.12.13                ***** Entire Operations *****                15:39:57
        Owner NOPALL            Global User Exits (optional)
       -------------------------------------------------------------------------------

                              Exit Name
        Version Names         NVNX0001
        JCL Activation        ________
        Symbol Modification   ________
        Symbol Not Found      ________
        Job Submission        ________  Type   _    A Assembler  N Natural
        Message Sending       ________  Usage  _

        Please note the possible overhead being created by the user exit usage.

        Command => ____________________________________________________________
       Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
             Help        End         Save                                      Menu

2. Enter or change the required values.

   The input fields are described in Fields: Global User Exits.

3. Choose PF5 (Save) when you are finished.

### Fields: Global User Exits

Field | Meaning
--- | ---
Version Names | Name of the user exit to be used as the global exit for version names.
JCL Activation | Name of the user exit to be used as the global JCL activation exit.
Symbol Modification | Name of the user exit to be used as the global symbol modification exit.
Symbol Not Found | Name of the user exit to be used as the global symbol not found exit.
Job Submission Type | This global exit is obsolete and should no longer be used. It is only maintained for backward compatibility with previous versions of Entire Operations. The exit was used for job submission on mainframe operating systems (z/OS and BS2000) only.
Message Sending | Name of the user exit to be used as the global message sending exit.
Usage | Only applies to Message Sending. Option to be used for the global message sending exit. Note Extensive use of this exit can cause considerable overhead. Possible values:
`N` | Never use this exit.
`S` | Use for explicit sending via exit only (`=EXIT`).
`D` | Additionally, for all defined message send actions.
`A` | For all events.

All global exits are described in the following sections.

## Global Exit for Version Names

- Function

- Parameter List

- Return Codes

### Function

If specified, this exit will check each newly created network version name or symbol table version name.

The exit must be coded as a Natural subprogram.

### Parameter List

The parameter list is named NOPXPL-A (see User Exits in the User's Guide) and is available in the SYSEOR system library.

Include it in the exit with:

    DEFINE DATA PARAMETER USING NOPXPL-A

Parameter | Meaning
--- | ---
`P-CALL-PLACE` | `NVN` | For network version checking.
`SVN` | For symbol table version checking.

### Return Codes

P-RC | Meaning
--- | ---
0 | The version name is OK.
1 | The version name is rejected by the exit. If the version name is rejected, the content of `P-RT` will be shown as error message. If `P-RT` is empty, a generic error message will be shown.

## Global JCL Activation Exit

- Function

- Parameter List

- Return Codes

### Function

If specified, Entire Operations will use this exit for each job activation.

The exit must be coded as a Natural subprogram. It is possible to modify almost all fields which describe the JCL location.

Note
You must set `P-RC := 1` to make the modifications valid.

The modifications are effective only for the current run, but not for the job's master definition.

### Parameter List

The parameter list is named AJCLX1-A and is available in the SYSEOR system library.

Include it in the exit with:

    DEFINE DATA PARAMETER USING AJCLX1-A

### Return Codes

P-RC | Meaning
--- | ---
0 | OK, no modification of the JCL location.
1 | OK, JCL location was modified by exit.
other | Access to JCL file denied or other problem. In this case, the JCL load for the given job will be interrupted.

## Global Symbol Modification Exit

- Function

- Parameter List

- Return Codes

### Function

User-defined symbols can be modified, and validation checks can be performed during job network activation. If defined, this exit will be invoked during the activation of all job networks for which no specific symbol prompting or modification exit was defined.

In the case of user-defined map(s) and validation checks during the symbol prompting for job network activation, the symbols must be read and updated by the Entire Operations API routine NOPUSY7N (see API Routines in the User's Guide). This API routine also allows sequential reading in the active symbol table.

See also Specifying User Exits for Symbol Modification in the section Symbol Table and Symbol Maintenance in the User's Guide.

### Parameter List

The user exit is to be written as a Natural subprogram and must use the supplied parameter list NOPSYP3A (see User Exits in the User's Guide). This parameter list contains all environment parameters needed.

A list of symbol tables used for this network activation will be passed.

### Return Codes

P-RC | Meaning
--- | ---
0 | OK, modifications were done.
1 | OK, no symbols prompted or modified.
2 | Activation cancelled.
3 | On input, rewrite modified symbols to the symbol table master.

## Global Symbol Not Found Exit

- Function

- Parameter List

- Return Codes

### Function

This exit is invoked during the activation of all job networks for which no specific symbol prompting or modification exit was defined and symbol search failed within the existing hierarchy.

All actions of this exit will be logged.

Note
Extensive use of this exit can cause considerable overhead.

### Parameter List

For this exit, the common exit parameter list NOPXPL-A (see User Exits in the User's Guide) is used. The field `P-CALL-PLACE` contains `SNF`.

### Return Codes

P-RC | Meaning
--- | ---
0 | Exit returned another symbol value.
1 | Accept that the symbol is missing; skip replacement.
2 | Use another symbol instead. The returned symbol value will be preceded by the current escape character and followed by a period (`.`), which will be used as a wildcard. This causes a new symbol replacement with the returned symbol.
3 | Exit returns: `symbol not found`. The symbol replacement is not successful.

## Global Message Sending Exit

This exit can be used to send messages for job events. The exit must be coded as a Natural subprogram.

For possible option settings, see the Usage field described in Fields: Global User Exits.

Note
Extensive use of this exit can cause considerable overhead.

This section covers the following topics:

- Parameter List

- Return Codes

### Parameter List

The parameter list is named NOPMSG-A and is available in the SYSEOR system library.

Include it in the exit with:

    DEFINE DATA PARAMETER USING NOPMSG-A

### Return Codes

P-RC | Meaning
--- | ---
0 | Exit execution was OK.
1 | Temporary error. The Entire Operations Monitor should try to send the message through the exit later.
2 | Permanent error. The Entire Operations Monitor should not try to send the message through the exit later.

### On this page

- Accessing Global User Exits
- Global Exit for Version Names
- Global JCL Activation Exit
- Global Symbol Modification Exit
- Global Symbol Not Found Exit
- Global Message Sending Exit