CICS VSAM Transparency for z/OS, Version 1.2


Description and usage of FBE parameters

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

EXDIMNAM
This is the name of the DIM being processed. This parameter is useful when your exit is used by multiple DIMs, and the processing varies in each case.
EXDDMNAM
This is the name of the DDM being processed.
EXFLDNAM
This is the name of the field that the exit is mapped to. This parameter is useful when your exit is used by multiple fields and the processing varies in each case.
EXCONVAD
This is the address of the VT module VIDCONV that contains the field conversion routines. You use this in assembler FBEs to branch to VIDCONV.
EXVSAIO
This is the address of the VSAM record area. If your FBE is operating at an individual field level, like the samples CNULLCL or CJULGREG, this parameter is not required. FBEs at a record level such as MULTFBE and CTLRECF use this parameter.
EXDB2IO
This is the address of the DB2® record area and its usage is similar to EXVSAIO.
EXRSVD1-4
Reserved.
EXVSAFLD
This is the address of the VSAM field the FBE is mapped to. Use this parameter when your FBE is operating at an individual field level, like the samples CNULLCL or CJULGREG.
EXDB2FLD
This is the address of the DB2 column the FBE is mapped to. This is only valid for fields that are mapped to a column. If the field is not mapped to a column, this address is zero. Usage is similar to EXVSAFLD.
EXWRKA
This is the address of the 16k work area that is shared between all the exits in a single DIM. For assembler FBEs, use this to store the save area to enable your FBE to be re-entrant. For high-level language FBEs, use this to share data areas between exits.
EXFLDNUM
This is the build order number of this field in the mapping. If your FBE handles multiple fields, you can use this parameter instead of EXFLDNAM.
EXVSAFLN
This contains the length of the VSAM field. This is a 1-byte field and is intended for use by an EXECUTE instruction in an assembler exit. (See EXVSAFLV for high-level language FBEs).
EXDB2FLN
This is the length of the DB2 column. This is a 1-byte field and is intended for use by an EXECUTE instruction in an assembler exit. (See EXDB2FLV for high-level language FBEs).
EXFUNCT
This is the function being performed when the exit is invoked. Possible values are:
V
Building VSAM field
D
Building DB2 field
If your FBE is mapped to a key field, use EXFUNCT in conjunction with EXVSABLD and EXDB2BLD.
EXRET
This is the return code that is set by the FBE. Possible values are:
"blank"
Good return code. VT continues building the remaining mapped fields.
Y
Good return code. The IO area is fully built. This is used in CTLRECF.
P
Bad return code. Control returns to the application program.
E
Bad return code. The VSAM call abends U3017 in batch and 3107 transaction abend code in CICS® .
When an FBE is invoked, EXRET is blank. See EXSTAT.
EXNULOFF
VT maintains a table of null variables for every column in the table that the DIM maps to. This field contains the offset in the table to the column that is mapped to the field being processed by the exit.
EXNULLS
This is the address of the nulls table. To locate the null indicator variable for any given field, add EXNULOFF to the address in EXNULLS. An example of how to do this in COBOL is in CNULLCL.
EXRTNTAB
This is the address of the field routine table. This is for use by an assembler FBE only.
EXFILLCH
This is the value of the filler character for unmapped areas of the VSAM record area. This is user-specified in the mapping.
EXFLDTYP
This is the VSAM field type that is specified in the mapping. Possible values are:
C
The VSAM field contains character (or zoned decimal) data
P
The VSAM field contains signed packed decimal data
U
The VSAM field contains unsigned packed decimal data
H
The VSAM field contains hexadecimal data
B
The VSAM field is 2 fullwords and contains hexadecimal data
EXFLDMAP
This indicates if the VSAM field is mapped to a column. Possible values are:
X'00'
The field is mapped to a column
X'FF'
The field is not mapped to a column
EXFLDNL
This indicates if the DB2 column in nullable. Possible values are:
N
The DB2 column is not nullable
Y
The DB2 column is nullable
EXDB2TYP
This is the DB2 column type that the field maps to. Possible values are:
F
INTEGER
H
SMALLINT
N
DECIMAL
C
CHAR
B
BIGINT
V
VARCHAR
D
DATE
T
TIME
S
TIMESTAMP
EXCICS
This parameter is set to C if the exit is being invoked in a CICS environment.
EXFILLER
Reserved
EXSQLCA
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.
EXWRKDS
Reserved
EXVSABLD
This indicates that the VSAM record area is being built. It is only relevant when EXFUNCT = V. Possible values are:
Y
The VSAM IO area is being built
N
A VSAM key value is being built for a call using a key
This parameter is required when the FBE is on a field that is part of the key or an alternate index path. It is used in CTLRECF.
EXRSVD5
Reserved
EXSTAT
This is the status code returned by the exit. This is used in conjunction with EXRET. It is set by CICS VT to 0000 when the FBE is invoked. If your FBE sets EXRET = P, CICS VT sets EXSTAT to 0020.
EXVSAFLV
This is the length of the VSAM field. It is equivalent to EXVSAFLN but is for use by high-level language exits.
EXDB2FLV
This is the length of the DB2 column. It is equivalent to EXDB2FLN but is for use by high-level language exits. If you are processing a file containing variable length records and your DB2 table has a VARCHAR column, this field contains the length of the variable data.
EXDB2BLD
This indicates that the DB2 record area is being built. It is only relevant when EXFUNCT = ‘D'. Possible values are:
Y
The DB2 record area is being built
N
A DB2 key value is being built for a call using a key
This parameter is required when the FBE is on a field that is part of the key or an alternate index path. It is used in CTLRECF.
EXRSVD6
Reserved
EXCALL
This field shows the VSAM call being processed. Possible values are:
  • OPEN
  • CLOS
  • GETU
  • GET
  • LOAD
  • PUTI
  • PUTR
  • ERAS
  • POIN
  • ENDR


Concept topic


Last updated: December 6, 2013 20:44:59

Concept Concept

Feedback


Timestamp icon Last updated: Friday, 6 December 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic///topics/cvtdecDescriptionAndUsageOfFBEParameters.html