The FEPI SPI commands

The FEPI system programming commands are:

These commands are

an addition to the system programming group of EXEC CICS® commands (programming information about these is in the CICS System Programming Reference manual) and have the same features and properties. To use these commands, you should be familiar with:

Brief notes on some of these topics are included here. For programming information about system programming commands, see the CICS System Programming Reference.

Command format

The general format of a command is:

EXEC CICS FEPI command option(argument)...

where:

command
Is the command name (for example, ADD)
option
Is an option name (for example, POOL)
argument
Is the source or destination for data, as required for the specified option, that is passed to or returned from the command.

The way that you terminate the command is determined by the programming language that you use--COBOL, for example, requires an END-EXEC statement.

Arguments and data types

The text used to identify arguments in this book indicates the type of data represented by the argument and whether it is a value used by the command, or an area in which the command returns data. For example:

Exceptionally, arguments that are lists have to be data areas, even though they are input values.

Errors and exception conditions

All FEPI commands support the RESP and RESP2 options to signal successful completion or an exception condition. Alternatively, you can use HANDLE CONDITION to trap errors.

Most FEPI command errors give the ‘INVREQ’ exception condition. The particular error in each case is uniquely identified by the RESP2 value.

Both RESP and RESP2 take, as an argument, the name of a user-defined fullword binary data area. Possible values of the RESP2 option are given in the description of each of the commands and a full list is given in RESP2 values. The following copy books provide declarations for the RESP2 values:

The following conditions and RESP2 values can occur for any system programming command:

Condition RESP2 Meaning
INVREQ 10 Command bypassed by user exit.
INVREQ 11 FEPI not installed, or not active.
INVREQ 12 CICS shutting down, command not allowed.
INVREQ 13 FEPI unavailable.
INVREQ 14 FEPI busy or cannot get storage.
INVREQ 15 Unknown command.
INVREQ 16 Internal error.
INVREQ 17 FEPI cannot get storage for user exit.
INVREQ 18 Command failed through operator or system action.
NOTAUTH 100 Not authorized for this command.

If there is an error, the command does nothing, and the output arguments are not changed.

By their nature, some commands (for example, FEPI SET NODE INSERVICE) initiate a function and return before the function has completed. Errors in the execution of the function cannot be reported as an exception condition on the command. Such errors are reported by writing a record to a transient data (TD) queue and a message to the message log CSZL. See Transient data queue records for details.

List processing

Commands that operate on a list of resources can fail for some of the resources in the list, but succeed for others. If this happens, a ‘list error’ is returned on the command. A record is written to a TD queue for each of the resources for which the command failed.

Even if the command fails for all of the resources in the list, it may still be partially successful if other parameters are valid. For example, a FEPI INSTALL POOL command installs a valid pool even if the array of node names specified on the NODELIST parameter does not exist.

Syntax notation

The notation used in this book to show the syntax of FEPI commands is the same as that used in the CICS System Programming Reference.

Translator options

Unlike other CICS system programming commands, the FEPI system programming commands do not need the ‘SP’ translator option. However, you do need to specify the ‘FEPI’ translator option.

INQUIRE and SET commands

The FEPI INQUIRE and SET commands work in the same way as other CICS INQUIRE and SET commands. They allow you to look at named FEPI resource definitions, browse sets of related definitions, and modify some of the defined values.

Other points

[[ Contents Previous Page | Next Page Index ]]