Description and usage of IRD parameters

Edit online

The explanation of the usage of some parameters refers to the sample exits in Coding FBEs for field level reengineering, FBE for managing a control record and Multiple record type solution.

IRDIMNAM

This is the name of the DIM.

IRDDMNAM

This is the name of the DDM.

IRDCNVAD

This is the address of the VT module VIDCONV that contains the field conversion routines. You use this in assembler IRDs to branch to VIDCONV.

IRDVSAIO

This is the address of the VSAM record area.

IRDDB2IO

This is the address of the DB2® record area.

IRDRSVD1-4

Reserved

IRDWRKA

This is the address of the 64k work area that is shared between all the exits in a single DIM. For assembler IRDs, use this to store the save area to enable your IRD to be re-entrant. For high-level language IRDs, use this to share data areas between exits.

IRDFUNCT

This is the function being performed when the exit is invoked. Possible values are:

I: A new record is being inserted
D: A record is being deleted
R: An existing record is being updated
L: The record is being processed by the VIDLOAD utility
X: An exclusive table lock has been obtained (see PK14457)

IRDRET

This is the return code from the exit. Possible values are:

blank: The exit has ended normally
Y: The exit has ended normally and the call is complete
N: The exit has ended and the call is not complete
P: The exit has ended and a bad return code should be set
E: CICS® VT abends the call with U3018
X: The exit has ended normally and obtained an exclusive table lock

IRDBA

This is the value specified in the mapping for the IRD processing sequence. Possible values are:

B: The exit is called before the DDM has issued an SQL call
A: The exit is called after the DDM has issued an SQL call
blank: The exit is called before and after the DDM has issued an SQL

IRDSTAT

The status code that CICS VT sets for the call. Possible values are:

OK: A normal return code will be set
NO: A bad return code will be set

If you set IRDRET = Y and IRDSTAT=NO, CICS VT sets a return code of 0020 for the call and writes the formatted SQLCA to VIDDMPD.

IRDCICS

This parameter is set to C if the exit is being invoked in a CICS environment.

IRDRPTGR

This parameter is only used for the initial data migration. It is significant when you have a repeating group or array and each group item becomes a single DB2 row. You use it to define the number of DB2 records to be written. It is explained further in IRD parameters for data migration.

IRDTYPE

Use this parameter to identify the output record type. It is only used for the initial data migration and is explained further in IRD parameters for data migration.

IRDB2DLN

Your exit defines the length of the output area that is built. This parameter is only used for the initial data migration and is explained further in IRD parameters for data migration.

IRDB2DAT

This parameter contains the address of the output area your exit builds. It is only used for the initial data migration and is explained further in IRD parameters for data migration.

IRDSQLCA

This is the address of the SQLCA. Set this to the address of the FBE SQLCA to enable CICS VT to format and display the SQL code in the VIDDMPD DD statement.