SET DELETSHIPPED

Change the system settings that control automatic deletion of shipped terminal definitions.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

SET DELETSHIPPED

Conditions: INVREQ, NOTAUTH

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations.

Description

The SET DELETSHIPPED command allows you to change values that control the timeout mechanism that CICS® provides for deleting definitions of shipped terminals that are inactive. A shipped definition is inactive if the terminal has not been used locally for a specified period of time and no task that requires the terminal is waiting to be attached. For more information about shipped definitions, see Intercommunication methods and TERMINAL resources.

You can change both the length of time a shipped terminal must remain inactive before being eligible for deletion (IDLE time), and the interval at which CICS checks for such terminals (the INTERVAL). Time values can be expressed in several different ways:

A 4-byte packed decimal composite, in the format 0hhmmss+, where the hours (hh) are in the range 0–99, and minutes (mm) and seconds (ss) are both from 0–59. Use the IDLE and INTERVAL options for this format.
With separate values for hours, minutes, and seconds. Use IDLEHRS, IDLEMINS, and IDLESECS instead of IDLE for this format, and INTERVALHRS, INTERVALMINS, and INTERVALSECS instead of INTERVAL. You can use any combination of hours, minutes, and seconds. If you use only one, the time value must be less than 100 hours, so that the range for hours is 0-99, the range for minutes is 0-5999, and the range for seconds is 0-359999. If you use two or three, the range is the same for hours, but minutes and seconds must both be in the range 0-59.

For example, to specify an IDLE time of 1 hour and 15 minutes, you could use any of the following:

IDLE(011500)
IDLEHRS(1) IDLEMINS(15)
IDLEMINS(75)
IDLESECS(4500).

Options

IDLE(data-value)

specifies the idle time, as a 4-byte packed decimal value in the form “0hhmmss+”. Idle time is the minimum time that a terminal must be inactive to be eligible for deletion.

See the notes at the beginning of this command description for the range of values allowed.

IDLEHRS(data-value)

Specifies, as a fullword binary value, the idle time in hours (when used alone) or the hours component of the idle time (when used with IDLEMINS or IDLESECS). See the IDLE option.

IDLEMINS(data-value)

Specifies, as a fullword binary value, the idle time in minutes (when used alone) or the minutes component of the idle time (when used with IDLEHRS or IDLESECS). See the IDLE option.

IDLESECS(data-value)

Specifies, as a fullword binary value, the idle time in seconds (when used alone) or the seconds component of the idle time (when used with IDLEHRS or IDLEMINS). See the IDLE option.

INTERVAL(data-value)

Specifies, as a 4-byte packed decimal value in the form “0hhmmss+”, the interval between invocations of the timeout delete mechanism.

When you change the checking interval, the next interval is measured from the time the command is issued, not from the previous invocation or CICS startup. If you want immediate deletion, use the PERFORM DELETSHIPPED command.

See the notes at the beginning of this command description for the range of values allowed.

INTERVALHRS(data-value)

Specifies, as a fullword binary value, the invocation interval in hours (when used alone) or the hours component of the interval (when used with IDLEMINS or IDLESECS). See the INTERVAL option.

INTERVALMINS(data-value)

Specifies, as a fullword binary value, the invocation interval in minutes (when used alone) or the minutes component of the interval (when used with INTERVALHRS or INTERVALSECS). See the INTERVAL option.

INTERVALSECS(data-value)

Specifies, as a fullword binary value, the invocation interval in seconds (when used alone) or the seconds component of the interval (when used with INTERVALHRS or INTERVALMINS). See the INTERVAL option.

Conditions

INVREQ

RESP2 values:

1: The INTERVAL value is invalid.
2: The INTERVALHRS value is not in the range 0-99.
3: The INTERVALMINS value is invalid.
4: The INTERVALSECS value is invalid.
5: The IDLE value is invalid.
6: The IDLEHRS value is not in the range 0-99.
7: The IDLEMINS value is invalid.
8: The IDLESECS value is invalid.

NOTAUTH

RESP2 values:

100: The user associated with the issuing task is not authorized to use this command.