DFHTEPM–generating the sample DFHTEP module
The sample DFHTEP module is generated by the following macros:
- DFHTEPM TYPE=USTOR—to indicate the start of user storage definitions.
- DFHTEPM TYPE=USTOREND—to indicate the end of user storage definitions.
- DFHTEPM TYPE=INITIAL—to control the printing of CICS® DSECTs, provide optional routines, and indicate the type of information to be logged when errors occur.
- DFHTEPM TYPE=ENTRY—to code a user “ENTRY” routine.
- DFHTEPM TYPE=EXIT—to code a user “EXIT” routine.
- DFHTEPM TYPE=ERRPROC—to allow you to replace the error processors supplied with the sample terminal error program with user-written versions.
- DFHTEPM TYPE=FINAL—to indicate the end of the sample DFHTEP module.
Note: You must code the translator options NOPROLOG and NOEPILOG in
your error processors if you use these macros.
DFHTEPM TYPE=USTOR
This macro indicates the start of user storage definitions. It must be followed by your storage definitions, and then by DFHTEPM TYPE=USTOREND. If you use DFHTEPM TYPE=USTOR to define storage, then both it and DFHTEPM TYPE=USTOREND must be coded before DFHTEPM TYPE=INITIAL.
DFHTEPM TYPE=USTOREND
This macro indicates the end of user storage definitions. Its use
is mandatory if DFHTEPM TYPE=USTOR has been coded. If you use DFHTEPM
TYPE=USTOR to define storage, then both it and DFHTEPM TYPE=USTOREND
must be coded before DFHTEPM TYPE=INITIAL.
DFHTEPM TYPE=INITIAL
[,DSECTPR={YES|NO}]
[,OPTIONS=([TD|(TD,destid)|NOTD]
[,EXITS|,NOEXITS]
[,TIME|,NOTIME]
[,PRINT=([ERRORS|NOERRORS]
[,TACPACTION|,NOTACPACTION]
[,TEPACTION|,NOTEPACTION]
[,TID|,NOTID]
[,DECB|,NODECB]
[,TACLE|,NOTACLE]
[,ESE|,NOESE])]
- TYPE=INITIAL
- establishes the beginning of the generation of the sample DFHTEP module itself.
- DSECTPR={YES|NO}
- controls
the printing of CICS DSECTs on the sample DFHTEP assembly listing.
Its purpose is to reduce the size of the listing. The default is
DSECTPR=YES.
- YES
- Printing of the DSECTs is allowed.
- NO
- Printing of selected CICS DSECTs is suppressed. This parameter should not be used under Assembler F.
- OPTIONS=optional-routines
- includes
or excludes optional routines in the DFHTEP module. The parentheses
are required even when only one option is specified. If this operand
is omitted, all default options are generated.
- TD|(TD, destid)|NOTD
- specifies whether information regarding the errors is to be written
to a transient data queue.
- TD
- The transient data output routine is to be generated. The implied transient data queue is CSMT.
- (TD, destid)
- The transient data output routine is to be generated. The messages are sent to the transient data queue specified by “destid”, which must be defined to CICS with a TDQUEUE resource definition.
- NOTD
- No messages are to be written to a transient data queue.
- EXITS|NOEXITS
- specifies whether “ENTRY” and “EXIT” user routine support is to
be included.
- EXITS
- Branches are taken to ENTRY and EXIT routines before and after error processing. Dummy routines are provided if user routines are not used.
- NOEXITS
- No branches are taken to user routines.
- TIME|NOTIME
- specifies whether threshold tests are to be controlled over prescribed
time intervals. An example might be putting a terminal out of service
if more than three instances of a given type of error occur in one
hour. The parameter must be the same as the OPTIONS operand in the
DFHTEPT TYPE=INITIAL macro.
- TIME
- This type of threshold testing is supported.
- NOTIME
- This type of threshold testing is not supported.
- PRINT=print-information
- specifies
which types of information are to be logged to the transient data
queue each time an error occurs. If NOTD is specified on the OPTIONS
operand, all PRINT parameters default to NO. All PRINT parameters
require the transient data output routine. The parentheses are required
even when only one parameter is specified.
- ERRORS|NOERRORS
- specifies whether unprocessable conditions detected by the sample
DFHTEP are to be recorded on the transient data queue.
- ERRORS
- Error messages are to be logged.
- NOERRORS
- No error messages are to be logged.
- TACPACTION|NOTACPACTION
- specifies whether DFHTACP default actions are to be recorded on
the transient data queue.
- TACPACTION
- The default actions are logged.
- NOTACPACTION
- No default actions are logged.
- TEPACTION|NOTEPACTION
- specifies whether the actions selected as a result of sample DFHTEP
processing are to be recorded on the transient data queue.
- TEPACTION
- The final actions are logged.
- NOTEPACTION
- No final actions are logged.
- TID|NOTID
- specifies whether the symbolic terminal ID of the terminal associated
with an error is to be recorded on the transient data queue.
- TID
- The terminal ID is to be logged.
- NOTID
- No terminal IDs are to be logged.
- DECB|NODECB
- specifies whether the DECB of the line associated with error is
to be recorded on the transient data queue.
- DECB
- The DECB is logged. The hexadecimal representation of the DECB is logged as two 24-byte messages.
- NODECB
- No DECB logging occurs.
- TACLE|NOTACLE
- specifies whether the TACLE prefix is to be recorded on the transient
data queue.
- TACLE
- The 16-byte TACLE prefix as received from DFHTACP is logged.
- NOTACLE
- No TACLE prefix logging occurs.
- ESE|NOESE
- specifies whether the ESE associated with the error is to be recorded
on the transient data queue.
- ESE
- The ESE, after being updated, and before being deleted (if the action puts the terminal out of service) is logged.
- NOESE
- No ESE logging occurs.