Preparing DB2 Application Plans › Connecting Plans to Applications › Plan Name Exit › Plan-Specific Parameters

Plan-Specific Parameters

01 ID-PARM-2.
              05  FILLER                          PIC X(08)
               05  PLA-RUN-SYSTEM                   PIC X(03).
               05  PLA-RUN-PROGRAM                  PIC X(08).
               05  PLA-SUB-SYSTEM                   PIC X(03).
               05  PLA-SUB-PROGRAM                  PIC X(08).
               05  PLA-SUB-TYPE                     PIC X(01).
               05  PLA-SET-PLAN                     PIC X(08).
               05  PLA-DB2-PLAN-NAME                PIC X(08).
               05  FILLER                           PIC X(16)

The sample plan name exit programs contain 88-level names with appropriate values for fields containing CA Ideal's internal codes.

ID-EXIT-TYPE

Type of exit invoked for this command. A 3 indicates that a plan exit is invoked.

ID-SYNC

Reserved.

ID-RELEASE-LEVEL

CA Ideal Release level (for example 1400 for Version 14.0).

ID-USER-SHORT-ID

One- to three-character CA Ideal user short ID defined for the user who is executing the command.

ID-USER-NAME

Name of the CA Ideal user who is executing the command.

ID-TERMINAL-ID

• In CICS-CICS ID of the terminal from which the command is executed.
• In batch-Hex zeros.

ID-TRANSACTION-ID

• In CICS-CICS signon transaction-ID.
• In batch-IDEA.

ID-TP-MONITOR-CODE

• C-Represents CICS.
• Y-Represents batch.

ID-OPERATING-SYSTEM-CODE

• O-Represents z/OS.

ID-NETWORK-ID

In CICS- VTAM LU name. If the terminal is VTAM, the system ID and terminal ID of the Terminal Owning Region (TOR). If the terminal is MRO but not VTAM, low values under any other circumstances.

PLA-RUN-SYSTEM (Input)

System of the main program (named in the RUN command).

PLA-RUN-PROGRAM (Input)

Name of the main program (named in the RUN command).

PLA-SUB-SYSTEM (Input)

System of the current subprogram.

PLA-SUB-PROGRAM (Input)

Name of the current subprogram.

PLA-SUB-TYPE (Input)

An indicator of the subprogram type:

• I (CA Ideal)-SQL to execute is in a CA Ideal module.
• N (Non-Ideal)-CA Ideal is about to call the program PLA‑SUB-PROGRAM. (See the Note at end of this section.)

PLA-SET-PLAN (Input)

Value of the most recent SET $PLAN statement. It is set initially to the value of the SET RUN PLAN command or to the default plan name established at installation. (This is the plan that supports CA Ideal's development environment.)

PLA-DB2-PLAN-NAME (Update)

Value returned to CA Ideal. CA Ideal passes this value to DB2 as the actual plan name. If SPACES or LOW-VALUES is returned to CA Ideal, the installation default plan is selected. The exit is free to return any value in the PLA‑DB2‑PLAN-NAME field. However, invalid plan names can result in runtime errors.

Note: Non‑ideal subprograms can use a plan name with up to eight characters. CA Ideal application plans are a maximum of seven characters long.