FAILSAFE control statement

Syntax

Usage notes

Up to 10 FAILSAFE statements can be specified. Any additional FAILSAFE statements after the first 10 are ignored.

For information about configuring message queue overflow protection using FAILSAFE, see Message queue overflow protection.

For information about recovering from actions taken by FAILSAFE statements, see Troubleshooting reference for AREA and FAILSAFE actions.

IMS entity type used for FAILSAFE analysis

FAILSAFE does not allow targeting of specific IMS entities; therefore, the TYPE= parameter is not allowed. An implicit TYPE=ALL is enforced, which includes the following entities:

TYPE=APPL: A dependent region application program
TYPE=DC: A VTAM® terminal
TYPE=APPC: An LU 6.2/APPC application
TYPE=OTMA: An OTMA application
TYPE=MSC: An IMS-to-IMS communications page

Keywords

ID=name

The ID parameter specifies a 1- to 8-character ID used to identify the FAILSAFE. This ID must be unique. Duplicate IDs will cause unexpected results.

A valid name consists of uppercase alphabetic characters (A through Z), special characters ($, #, or @), and numeric values (0 through 9). The first character of the name cannot be a numeric value.

PERCENT=(TOTAL=nn,USED=nn)

The required PERCENT parameter specifies a percentage value of 00 - 99.

TOTAL specifies how much of the total queue will be looked at for analysis. A TOTAL value of 00 causes the FAILSAFE processing to check the USED value. After the USED value is reached, the specified action will be taken.

USED specifies how much of the queue a process can use before implementing the specified action. A USED value of 00 causes the specified action to be implemented immediately.

ACTION=action

Values for the ACTION parameter are: NONE, WTO, WAIT, STOP, ABEND.

The following keywords are available for variable action:

NONE

Takes no action.

WTO

Issues IQC68nn messages as write-to-operator (WTO). WTO messages are also written to the job log of the control region or the dependent region.

Exception: When a FAILSAFE condition is met, only one WTO is issued. The purpose of this condition is to ensure that the MCS is not overwhelmed with notification WTOs.

WAIT

Waits for a user action.

You must use the TSO/ISPF Display Waited Tasks panel to end the wait.

In addition, IMS Queue Control Facility issues IQC68nn messages as write-to-operator (WTO). WTO messages are also written to the job log of the control region or the dependent region.

STOP

Conducts a Stop action, which can be one of the following:

For TYPE=APPL (applications), issues an A7 status code to the application
For TYPE=APPC (LU 6.2 /APPC), issues a DFS0777 message to the MTO and deallocates the input terminal
For TYPE=DC (Data communications input terminal, BTAM / VTAM), issues a DFS074 message to the input terminal
For TYPE=OTMA, issues a NAK message to the client
For TYPE=MSC, issues a DFS1945 message to the MTO, issues a DSF2140 message to the MTO in the partner IMS system, and stops the sending path MSNAME

In addition, IMS Queue Control Facility issues IQC68nn messages as write-to-operator (WTO). WTO messages are also written to the job log of the control region or the dependent region.

ABEND

Terminates the application in the dependent region abnormally with abend code U405.

In addition, IMS Queue Control Facility issues IQC68nn messages as write-to-operator (WTO). WTO messages are also written to the job log of the dependent region.

ABEND is applicable to TYPE=APPL only; this keyword is treated as STOP for other destination types.

NOTIFY=(TYPE=TSO,JNAME=member,USERID=tsoid,TEXT=(area0001_notification))

The optional NOTIFY parameter sends notifications to the TSO user IDs when the AREA or FAILSAFE parameters are triggered.

Multiple NOTIFY parameters can be added to each AREA control statement. The NOTIFY parameter sets a job to be started when the ACTION for the AREA is taken. The job sends notifications to TSO user.

TYPE=TSO: This required subparameter, is the type of the started JCL procedure. It is not checked and it can be used to perform other services.
JNAME=jobname: This required subparameter, is the name of a procedure in the PROCLIB DD concatenation for the control region. This procedure is started before the requested action for the AREA. The procedure is not started if the requested action is NONE.
USERID=tsoid: This optional subparameter, set in the started procedure, is the designated TSO user ID that receives the notifications. This subparameter is informational only.
TEXT=area0001_notification: This optional subparameter, set in the started procedure, sends text to the TSO user ID. This subparameter is informational only.

Examples

See the following examples of the FAILSAFE control statement:

FAILSAFE=(ID=FAIL0001,                                                  
          PERCENT=(TOTAL=40,USED=04),                                   
          ACTION=WTO)

FAILSAFE=(ID=FAIL0099,PERCENT=(TOTAL=82,USED=00),                     
NOTIFY=(TYPE=TSO,JNAME=IQCNTM2T,USERID=TEXTME,TEXT=(FAIL0099 NOTIFY)),
      ACTION=STOP)