Basic mapping support exits (XBMIN, XBMOUT)
Two basic mapping support exits are provided: XBMIN and XBMOUT. The XBMIN exit allows you to intercept a RECEIVE MAP request after BMS has successfully processed the request. The XBMOUT exit allows you to intercept a SEND MAP request after BMS has successfully processed the request; or, if cumulative mapping is in progress, on completion of each page of output.
The XBMIN exit is called, if enabled, when all the following are
true:
- A RECEIVE MAP command has been successfully processed.
- The map referenced in the command contains at least one field specified as VALIDN=USEREXIT.
- At least one USEREXIT field has been returned in the inbound datastream and has been mapped into the application data structure.
Using XBMIN, you can:
- Analyze each field defined as VALIDN=USEREXIT mapped to the application on this request
- Use the mapset name, map name, and field length defined in the map, and the actual length of field data returned in the inbound datastream
- Modify the data in each field.
The XBMOUT exit is called, if enabled, when all the following are
true:
- A SEND MAP command has been successfully processed.
- The map referenced in the command contains at least one field specified as VALIDN=USEREXIT.
- At least one USEREXIT field has been generated in the outbound datastream.
Using XBMOUT, you can:
- Analyze each field defined as VALIDN=USEREXIT which has been generated in the outbound datastream
- Use the mapset name, map name, and field length defined in the map, and the actual length of field data placed in the outbound datastream
- Modify the data in each field
- Modify the attributes sent with each field.
Both exits are passed four exit-specific parameters:
- The address of the TCTTE associated with the mapping request
- The address of the system EIB associated with the task issuing the mapping request
- The address of a halfword binary count of the number of elements in the field element table
- The address of the field element table.
Sample program, DFH$BMXT
CICS® supplies a sample program, DFH$BMXT, that shows how mapped input and output data can be modified with reference to the information provided in the “field element” table. A copybook, DFHXBMDS, is also supplied. This copybook is a DSECT which defines the structure of the field element.