Document Outline

• Contents
• Preface
  • What this book is about
  • Who this book is for
  • What you need to know to understand this book
  • How to use this book
  • Notes on terminology
  • Syntax notation and conventions used in this book
• Summary of changes
  • Changes for CICS Transaction Server for z/OS, Version 3 Release 2
  • Changes for CICS Transaction Server for z/OS, Version 3 Release 1
  • Changes for CICS Transaction Server for z/OS, Version 2 Release 3
• Part 1. Customizing with user exit programs
• Chapter 1. Global user exit programs
  • Writing global user exit programs
    • Register conventions
    • 31-bit addressing implications
      • Access register implications
    • Using CICS services
      • Using EXEC CICS and XPI calls in the same exit program
    • Using channels and containers
    • Assembler programs and LEASM
    • EDF and global user exits
    • The global work area
    • Making trace entries
    • Parameters passed to the global user exit program
      • DFHUEPAR standard parameters
    • Returning values to CICS
    • Restrictions on the use of fields as programming interfaces
    • Exit programs and the CICS storage protection facility
    • Errors in user exit programs
  • Defining, enabling, and disabling an exit program
  • Viewing active global user exits
  • Invoking more than one exit program at a single exit
  • Invoking a single exit program at more than one exit
  • Making programs threadsafe
  • Sample global user exit programs
    • Basic sample and example programs
      • Global work area (GWA) sample exit programs
      • The DFH$PCPI program
      • Sample program definitions
      • Example program
    • Sample programs for specific exits
      • The Application Associated Data sample exit program
      • The Basic Mapping Support sample exit program
      • The data tables sample exit programs
      • The dump domain sample exit program
      • The enqueue EXEC interface sample exit program
      • The file control state program sample exit program
      • The file control recovery program sample exit programs
      • The function-shipping and DPL queue control sample exit program
      • The HTTP client sample exit programs
      • The interval control EXEC interface sample exit program
      • The log manager domain sample exit program
      • The message domain sample exit programs
      • The MRO and APPC session queue management sample exit program
      • The pipeline sample exit program
      • The session queue management sample exit program, for IPIC connections
      • The transaction-abend sample exit program
      • The terminal-not-known sample exit program
  • Alphabetical list of global user exit points
  • Global user exit points by functional area
    • Activity keypoint program exit XAKUSER
    • Application Associated Data exit, XAPADMGR, in the AP domain
    • Basic Mapping Support exits XBMIN and XBMOUT
      • Exit XBMIN
      • Exit XBMOUT
      • The field element table structure
      • Programming the XBMIN exit
      • Programming the XBMOUT exit
    • Bridge facility exit XFAINTU
    • Data tables management exits XDTRD, XDTAD, and XDTLC
      • Exit XDTRD
      • Exit XDTAD
      • Exit XDTLC
    • DBCTL interface control program exit XXDFA
    • DBCTL tracking program exits XXDFB and XXDTO
      • Exit XXDFB
      • Exit XXDTO
    • Dispatcher domain exits XDSBWT and XDSAWT
      • Exit XDSBWT
      • Exit XDSAWT
    • DL/I interface program exits XDLIPRE and XDLIPOST
      • Exit XDLIPRE
      • Exit XDLIPOST
    • Dump domain exits XDUREQ, XDUREQC, XDUCLSE, and XDUOUT
      • Exit XDUREQ
      • Exit XDUREQC
      • Exit XDUCLSE
      • Exit XDUOUT
    • Enqueue EXEC interface program exits XNQEREQ and XNQEREQC
      • Exit XNQEREQ
      • Exit XNQEREQC
      • The command-level parameter structure
      • Sample exit program, DFH$XNQE
    • EXEC interface program exits XEIIN, XEIOUT, XEISPIN, and XEISPOUT
      • The command parameter list
      • Bypassing commands
      • Exit XEIIN
      • Exit XEISPIN
      • Exit XEIOUT
      • Exit XEISPOUT
    • File control domain exits, XFCFRIN and XFCFROUT
      • XFCFRIN
      • XFCFROUT
      • Exit XFCFRIN
      • Exit XFCFROUT
    • File control EXEC interface API exits XFCREQ and XFCREQC
      • The command-level parameter structure
      • Modifying fields in the command-level parameter structure
      • Modifying the EID
      • Use of the task token UEPTSTOK
      • Use of the parameter UEPFSHIP
      • The EIB
      • Example of how XFCREQ and XFCREQC can be used
      • Exit XFCREQ
      • Exit XFCREQC
    • File control EXEC interface SPI exits XFCAREQ and XFCAREQC
      • Exit XFCAREQ
      • Exit XFCAREQC
      • The command-level parameter structure
      • Modifying fields in the command-level parameter structure
      • Modifying the EID
      • Use of the task token UEPTSTOK
      • Modifying user arguments
    • File control file state program exits XFCSREQ and XFCSREQC
      • Exit XFCSREQ
      • Exit XFCSREQC
    • File control open/close program exit XFCNREC
      • Using XFCNREC with a back out recovery setting mismatch
      • Using XFCNREC with a BWO mismatch
    • File control quiesce receive exit, XFCVSDS
      • Exit XFCVSDS
    • File control quiesce send exit XFCQUIS
    • File control recovery program exits XFCBFAIL, XFCBOUT, XFCBOVER, and XFCLDEL
      • Order of invocation
      • Enabling the exit programs
      • Exit XFCBFAIL, file control backout failure exit
      • Exit XFCBOUT, file control backout exit
      • Exit XFCBOVER, file control backout override exit
      • Exit XFCLDEL, file control logical delete exit
    • Front End Programming Interface exits XSZARQ and XSZBRQ
    • Good morning message program exit XGMTEXT
    • HTTP client open and send exits: XWBAUTH, XWBOPEN and XWBSNDO
    • Intersystem communication program exits XISCONA and XISLCLQ
      • The XISCONA exit
      • The XISLCLQ exit
    • Interval control program exits XICREQ, XICEXP, and XICTENF
      • Exit XICREQ
      • Exit XICEXP
      • Exit XICTENF
    • Interval control EXEC interface program exits XICEREQ, XICERES, and XICEREQC
      • Parameters passed to each of the exits
      • Exit XICEREQ
      • Exit XICERES
      • Exit XICEREQC
      • The command-level parameter structure
    • Loader domain exits XLDLOAD and XLDELETE
      • Exit XLDLOAD
      • Exit XLDELETE
    • Log manager domain exit XLGSTRM
      • Exit XLGSTRM
      • An example of how XLGSTRM can be used
      • The sample program for the XLGSTRM exit, DFH$LGLS
    • Message domain exit XMEOUT
      • Exit XMEOUT
      • The sample XMEOUT global user exit programs
    • Monitoring domain exit XMNOUT
      • Exit XMNOUT
    • Pipeline domain exits
      • Exit XWSPRROO
    • Program control program exits XPCREQ, XPCERES, XPCREQC, XPCFTCH, XPCHAIR, XPCTA, and XPCABND
      • XPCREQ, XPCERES, and XPCREQC
      • Exit XPCFTCH
      • The sample XPCFTCH global user exit program, DFH$PCEX
      • Exit XPCHAIR
      • Exit XPCTA
      • The sample XPCTA global user exit program, DFH$PCTA
      • Exit XPCABND
    • Resource manager interface program exits XRMIIN and XRMIOUT
      • Exit XRMIIN
      • Exit XRMIOUT
    • Resource management install and discard exit XRSINDI
      • Exit XRSINDI
    • Signon and signoff exits XSNON, XSNOFF, and XSNEX
      • Exit XSNON
      • Exit XSNOFF
      • Exit XSNEX
    • Statistics domain exit XSTOUT
      • Exit XSTOUT
    • System recovery program exit XSRAB
    • System termination program exit XSTERM
      • Exit XSTERM
    • Temporary storage domain exits XTSQRIN, XTSQROUT, XTSPTIN, and XTSPTOUT
      • Exit XTSQRIN
      • Exit XTSQROUT
      • Exit XTSPTIN
      • Exit XTSPTOUT
    • Temporary storage EXEC interface program exits XTSEREQ and XTSEREQC
      • Exit XTSEREQ
      • Exit XTSEREQC
      • The command-level parameter structure
    • Terminal allocation program exit XALCAID
      • Exit XALCAID
    • Terminal control program exits XTCIN, XTCOUT, and XTCATT
      • Exit XTCIN
      • Exit XTCOUT
      • Exit XTCATT
    • ‘Terminal not known’ condition exits XALTENF and XICTENF
      • The exits
      • Exit XALTENF
      • Exit XICTENF
      • The sample program for the XALTENF and XICTENF exits, DFHXTENF
    • Transaction manager domain exit XXMATT
      • Exit XXMATT
    • Transient data program exits XTDREQ, XTDIN, and XTDOUT
      • Exit XTDREQ
      • Exit XTDIN
      • Exit XTDOUT
    • Transient data EXEC interface program exits XTDEREQ and XTDEREQC
      • Exit XTDEREQ
      • Exit XTDEREQC
      • The command-level parameter structure
    • User log record recovery program exits XRCINIT and XRCINPT
      • Coding the exit programs
      • Enabling the exit programs
      • Exit XRCINIT
      • Exit XRCINPT
    • VTAM terminal management program exit XZCATT
      • Exit XZCATT
    • VTAM working-set module exits XZCIN, XZCOUT, XZCOUT1, and XZIQUE
      • Exit XZCIN
      • Exit XZCOUT
      • Exit XZCOUT1
      • XZIQUE exit for managing MRO and APPC intersystem queues
      • Designing an XZIQUE global user exit program
    • XISQUE exit for managing IPIC intersystem queues
      • When the XISQUE exit is invoked
      • Exit XISQUE
      • Using an XISQUE global user exit program
      • Statistics fields in DFHISRDS
      • Designing an XISQUE global user exit program
    • XRF request-processing program exit XXRSTAT
      • Exit XXRSTAT
• Chapter 2. Task-related user exit programs
  • Introduction to the task-related user exit mechanism (the adapter)
  • The stub program
    • Returning control to the application program
    • Task-related user exits and EDF
  • Writing a task-related user exit program
    • Obligations of OPENAPI task-related user exits
      • Threadsafe restrictions
      • Calling an OPENAPI task-related user exit
    • User exit parameter lists
      • DFHUEPAR
      • DFHUERTR (the function definition)
      • Caller parameter lists
      • Summary of the task-related user exit parameter lists
    • The schedule flag word
    • Register handling in the task-related user exit program
      • Saving CICS registers
      • The calling program’s registers
      • The RMI registers
    • Addressing-mode implications
    • Exit programs and the CICS storage protection facility
      • Execution key for task-related user exit programs
      • Data storage key for task-related user exit programs
    • Recursion within a task-related user exit program
    • Purging tasks
    • Using CICS services in your task-related user exit program
    • Using channels and containers
    • Assembler programs and LEASM
    • Wait states in your task-related user exit program
    • Work areas
      • The global work area
      • The local work area
    • Coding a program to be invoked by the CICS SPI
    • Coding a program to be invoked by the CICS syncpoint manager
      • Increasing efficiency – single-update and read-only protocols
      • Return codes
      • What is expected of your resource manager
      • Limitations
      • Sample code for a TRUE invoked by the CICS syncpoint manager
      • Resynchronization
    • Coding a program to be invoked by the CICS task manager
      • Limitations
    • Coding a program to be invoked at CICS termination
      • Limitations
      • Sample code for a TRUE invoked at CICS termination
    • Using EDF with your task-related user exit program
  • Administering the adapter
    • What you must do before using the adapter
      • Enabling for specific invocation-types
      • The administration routines
    • Tracing a task-related user exit program
• Chapter 3. The user exit programming interface (XPI)
  • Overview of the XPI
  • Making an XPI call
    • Setting up the XPI environment
    • XPI register usage
    • The XPI copy books
    • Reentrancy considerations resulting from XPI calls
  • Global user exit XPI examples, showing the use of storage
    • An example showing how to build a parameter list incrementally
  • XPI syntax
  • Directory domain XPI functions
    • The BIND_LDAP call
      • RESPONSE and REASON values for BIND_LDAP:
    • The END_BROWSE_RESULTS call
      • RESPONSE and REASON values for END_BROWSE_RESULTS:
    • The FLUSH_LDAP_CACHE call
      • RESPONSE and REASON values for FLUSH_LDAP_CACHE:
    • The FREE_SEARCH_RESULTS call
      • RESPONSE and REASON values for FREE_SEARCH_RESULTS:
    • The GET_ATTRIBUTE_VALUE call
      • RESPONSE and REASON values for GET_ATTRIBUTE_VALUE:
    • The GET_NEXT_ATTRIBUTE call
      • RESPONSE and REASON values for GET_NEXT_ATTRIBUTE:
    • The GET_NEXT_ENTRY call
      • RESPONSE and REASON values for GET_NEXT_ENTRY:
    • The SEARCH_LDAP call
      • RESPONSE and REASON values for SEARCH_LDAP:
    • The START_BROWSE_RESULTS call
      • RESPONSE and REASON values for START_BROWSE_RESULTS:
    • The UNBIND_LDAP call
      • RESPONSE and REASON values for UNBIND_LDAP:
  • Dispatcher XPI functions
    • Synchronization protocols for SUSPEND and RESUME processing
      • The normal synchronization protocol
      • The synchronization protocol and task purge
    • The ADD_SUSPEND call
      • RESPONSE and REASON values for ADD_SUSPEND:
    • The SUSPEND call
      • RESPONSE and REASON values for SUSPEND:
    • The RESUME call
      • RESPONSE and REASON values for RESUME:
    • The DELETE_SUSPEND call
      • RESPONSE and REASON values for DELETE_SUSPEND:
    • The WAIT_MVS call
      • RESPONSE and REASON values for WAIT_MVS:
    • The CHANGE_PRIORITY call
      • RESPONSE and REASON values for CHANGE_PRIORITY:
  • Dump control XPI functions
    • The SYSTEM_DUMP call
      • RESPONSE and REASON values for SYSTEM_DUMP:
    • The TRANSACTION_DUMP call
      • RESPONSE and REASON values for TRANSACTION_DUMP:
  • Enqueue domain XPI functions
    • The ENQUEUE function
      • RESPONSE and REASON values for ENQUEUE
    • The DEQUEUE function
      • RESPONSE and REASON values for DEQUEUE
  • Kernel domain XPI functions
    • The START_PURGE_PROTECTION function
      • RESPONSE values for START_PURGE_PROTECTION:
    • The STOP_PURGE_PROTECTION function
      • RESPONSE values for STOP_PURGE_PROTECTION:
    • Nesting purge protection calls
  • Loader XPI functions
    • The DEFINE_PROGRAM call
      • RESPONSE and REASON values for DEFINE_PROGRAM:
    • The ACQUIRE_PROGRAM call
      • RESPONSE and REASON values for ACQUIRE_PROGRAM:
    • The RELEASE_PROGRAM call
      • RESPONSE and REASON values for RELEASE_PROGRAM:
    • The DELETE_PROGRAM call
      • RESPONSE and REASON values for DELETE_PROGRAM:
  • Log manager XPI functions
    • The INQUIRE_PARAMETERS call
      • RESPONSE and REASON values for INQUIRE_PARAMETERS:
    • The SET_PARAMETERS call
      • RESPONSE and REASON values for SET_PARAMETERS:
  • Monitoring XPI functions
    • The MONITOR call
      • RESPONSE and REASON values for MONITOR:
    • The INQUIRE_MONITORING_DATA call
      • RESPONSE and REASON values for INQUIRE_MONITORING_DATA:
  • Program management XPI functions
    • The INQUIRE_PROGRAM call
      • RESPONSE and REASON values for INQUIRE_PROGRAM:
    • The INQUIRE_CURRENT_PROGRAM call
      • RESPONSE and REASON values for INQUIRE_CURRENT_PROGRAM:
    • The SET_PROGRAM call
      • RESPONSE and REASON values for SET_PROGRAM:
    • The START_BROWSE_PROGRAM call
      • RESPONSE and REASON values for START_BROWSE_PROGRAM:
    • The GET_NEXT_PROGRAM call
      • RESPONSE and REASON values for GET_NEXT_PROGRAM:
    • The END_BROWSE_PROGRAM call
      • RESPONSE and REASON values for END_BROWSE_PROGRAM:
    • The INQUIRE_AUTOINSTALL call
      • RESPONSE and REASON values for INQUIRE_AUTOINSTALL:
    • The SET_AUTOINSTALL call
      • RESPONSE and REASON values for SET_AUTOINSTALL:
  • State data access XPI functions
    • The INQ_APPLICATION_DATA call
      • RESPONSE and REASON values for INQ_APPLICATION_DATA:
    • The INQUIRE_SYSTEM call
      • RESPONSE and REASON values for INQUIRE_SYSTEM
    • The SET_SYSTEM call
      • RESPONSE and REASON values for SET_SYSTEM:
  • Storage control XPI functions
    • The GETMAIN call
      • RESPONSE and REASON values for GETMAIN:
    • The FREEMAIN call
      • RESPONSE and REASON values for FREEMAIN:
    • The INQUIRE_ACCESS call
      • RESPONSE and REASON values for INQUIRE_ACCESS:
    • The INQUIRE_ELEMENT_LENGTH call
      • RESPONSE and REASON values for INQUIRE_ELEMENT_LENGTH:
    • The INQUIRE_SHORT_ON_STORAGE call
      • RESPONSE and REASON values for INQUIRE_SHORT_ON_STORAGE:
    • The INQUIRE_TASK_STORAGE call
      • RESPONSE and REASON values for INQUIRE_TASK_STORAGE:
    • The SWITCH_SUBSPACE call
      • RESPONSE and REASON values for SWITCH_SUBSPACE:
  • Trace control XPI function
    • The TRACE_PUT call
      • RESPONSE values for TRACE_PUT
  • Transaction management XPI functions
    • The INQUIRE_CONTEXT call
      • RESPONSE and REASON values for INQUIRE_CONTEXT:
    • The INQUIRE_DTRTRAN call
      • RESPONSE and REASON values for INQUIRE_DTRTRAN:
    • The INQUIRE_MXT call
      • RESPONSE and REASON values for INQUIRE_MXT:
    • The INQUIRE_TCLASS call
      • RESPONSE and REASON values for INQUIRE_TCLASS:
    • The INQUIRE_TRANDEF call
      • RESPONSE and REASON values for INQUIRE_TRANDEF:
    • The INQUIRE_TRANSACTION call
      • RESPONSE and REASON values for INQUIRE_TRANSACTION:
    • The SET_TRANSACTION call
      • RESPONSE and REASON values for SET_TRANSACTION:
  • User journaling XPI function
    • The WRITE_JOURNAL_DATA call
      • RESPONSE and REASON values for WRITE_JOURNAL_DATA:
• Part 2. Customizing with initialization and shutdown programs
• Chapter 4. Writing initialization and shutdown programs
  • Writing initialization programs
    • First-phase PLT programs
    • Second phase PLT programs
    • Effect of delayed recovery on PLTPI processing
  • Writing shutdown programs
    • First phase PLT programs
    • PLT programs for the second quiesce stage
    • The shutdown assist utility program, DFHCESD
  • General considerations when writing initialization and shutdown programs
    • Storage keys for PLT programs
      • Execution key for PLT programs
      • Data storage key for PLT programs
• Part 3. Customizing with user-replaceable programs
• Chapter 5. General notes about user-replaceable programs
  • Rewriting user-replaceable programs
  • Assembling and link-editing user-replaceable programs
  • User-replaceable programs and the storage protection facility
    • Execution key for user-replaceable programs
    • Data storage key for user-replaceable programs
• Chapter 6. Writing a program error program
  • The sample program error programs
• Chapter 7. Writing a transaction restart program
  • The DFHREST communications area
  • The CICS-supplied transaction restart program
• Chapter 8. Writing a terminal error program
  • Background to error handling for sequential devices
    • When an abnormal condition occurs
    • Terminal control program
    • Terminal abnormal condition program
    • Terminal error program
    • The communication area
    • Terminal abnormal condition line entry (TACLE)
  • The sample terminal error program
    • Components of the sample terminal error program
      • TEP error table
      • TEP default table
    • Structure of the sample terminal error program
      • Entry and initialization
      • Terminal ID and error code lookup
      • Error processor selection
      • Error processing execution
      • General exit
      • Common subroutines
    • Sample terminal error program messages
    • Generating the sample terminal error program
      • Job control for generating the sample terminal error program
      • DFHTEPM–generating the sample DFHTEP module
      • DFHTEPM TYPE=ENTRY and EXIT–for user entry and exit routines
      • DFHTEPM TYPE=ERRPROC–replacing error processors
      • DFHTEPM TYPE=FINAL–ending the sample DFHTEP module
      • DFHTEPM macro examples
      • DFHTEPT–generating the sample DFHTEP tables
      • DFHTEPT TYPE=INITIAL–establishing the control section
      • DFHTEPT TYPE=PERMTID–assigning permanent terminal error blocks
      • DFHTEPT TYPE=PERMCODE|ERRCODE–defining error status elements
      • DFHTEPT TYPE=BUCKET–using the error bucket for specific errors
      • DFHTEPT TYPE=FINAL–terminating DFHTEPT entries
      • DFHTEPT–examples of how the macros are used
  • Writing your own terminal error program
    • Why write your own terminal error program?
    • Restrictions on the use of EXEC CICS commands
    • Addressing the contents of the communication area
      • Resetting the flags in the user action byte, TEPCAACT
    • Addressing the contents of the TACLE
    • Example of a user-written terminal error program
      • DFHTEP recursive retry routine
• Chapter 9. Writing a node error program
  • Background to CICS-VTAM error handling
    • Why use a NEP to supplement CICS default actions?
    • An overview of writing a NEP
    • The default NEP
    • The sample NEP
      • The node error table
      • Coding the sample NEP
    • Multiple NEPs
  • When an abnormal condition occurs
    • The communication area
      • The user option bytes (TWAOPTL)
      • Additional information for the NEP (TWAADINF)
      • The additional system parameters (TWASYSPM)
      • XRF parameters (TWAXRNOT)
  • The sample node error program
    • Compatibility with the sample terminal error program
    • Components of the sample node error program
      • Entry section
      • Routing mechanism
      • Node error table
      • Optional common subroutines
      • Optional error processors for 3270 logical units
      • Optional error processor for interactive logical units
    • Generating the sample node error program
      • DFHSNEP TYPE=USTOR and USTOREND—defining user storage
      • DFHSNEP TYPE=INITIAL—generating the routing mechanism
      • DFHSNEP TYPE=DEF3270—including error processors for 3270 LUs
      • DFHSNEP TYPE=DEFILU—including error processors for INTLUs
      • DFHSNEP TYPE=FINAL—terminating DFHSNEP entries
      • DFHSNEP TYPE=ERRPROC—specifying a user error processor
      • DFHSNET—generating the node error table
      • DSECTs
  • Writing your own node error program
    • Restrictions on the use of EXEC CICS commands
    • Entry and addressability
    • Coding for the 3270 ‘unavailable printer’ condition
    • Coding for session failures
    • Coding for specific VTAM sense codes
    • Writing multiple NEPs
    • DFHZNEPI macros
      • DFHZNEPI TYPE=INITIAL—specifying the default routine
      • DFHZNEPI TYPE=ENTRY—specifying a transaction-class routine
      • DFHZNEPI TYPE=FINAL—terminating DFHZNEPI entries
    • Handling shutdown hung terminals in the node error program
      • How DFHZNAC passes the setting of TCSACTN to DFHZNEP
      • How DFHZNAC passes the DFHZC2351 reason code to DFHZNEP
      • How DFHZNEP can modify the force-close action for the current terminal
  • Using the node error program with XRF or persistent sessions
    • The node error program in an XRF environment
    • The node error program with persistent session support
    • Changing the recovery notification
    • Changing the recovery message
    • Changing the recovery transaction
  • Using the node error program with VTAM generic resources
• Chapter 10. Writing a program to control autoinstall of terminals
  • Autoinstalling terminals—preliminary considerations
    • Coding entries in the VTAM LOGON mode table
    • Using model terminal support (MTS)
      • Coding entries for MTS
    • The autoinstall control program for terminals
  • The autoinstall control program at INSTALL
    • The communication area at INSTALL for terminals
    • How CICS builds the list of autoinstall models
    • Returning information to CICS
      • Selecting the autoinstall model
      • Setting the TERMINAL name
    • CICS action on return from the control program
  • The autoinstall control program at DELETE
    • The communication area at DELETE for terminals
  • Naming, testing, and debugging your autoinstall control program
    • Finding the name of an autoinstall control program
    • Testing and debugging
  • The sample autoinstall control programs for terminals
    • Customizing the sample program
      • Assembler language
      • COBOL
      • PL/I
• Chapter 11. Writing a program to control autoinstall of consoles
  • Autoinstalling consoles—preliminary considerations
    • Leaving it all to CICS
    • Using an autoinstall control program
  • The autoinstall control program at INSTALL
    • The communication area at INSTALL for consoles
    • How CICS builds the list of autoinstall models
    • Returning information to CICS
      • Selecting the autoinstall model
      • Setting the TERMINAL name
    • CICS action on return from the control program
  • The autoinstall control program at DELETE
  • The sample autoinstall control programs for consoles
• Chapter 12. Writing a program to control autoinstall of APPC connections
  • Autoinstalling APPC connections—preliminary considerations
    • Local APPC single-session connections initiated by CINIT
    • Local APPC parallel-session and single-session connections initiated by BIND
    • Autoinstall templates for APPC connections
    • Benefits of autoinstall
    • Requirements for autoinstall
    • The autoinstall control program for APPC connections
    • Recovery and restart
  • The autoinstall control program at INSTALL
    • The communication area at INSTALL for APPC connections
  • The autoinstall control program at DELETE
    • When autoinstalled APPC connections are deleted
      • Single-session connections installed via a CINIT
      • Synclevel 1 connections installed via a BIND
      • Synclevel 2 connections installed via a BIND
  • The sample autoinstall control program for APPC connections
    • Default actions of the sample program
    • Resource definitions
• Chapter 13. Writing a program to control autoinstall of IPIC connections
  • Autoinstalling IPIC connections: preliminary considerations
  • The autoinstall user program at INSTALL
  • The autoinstall user program at DELETE
    • When autoinstalled IPCONNs are deleted
  • The sample autoinstall user program for IPIC connections (IPCONN)
    • Default actions of the sample program
    • Resource definitions
• Chapter 14. Writing a program to control autoinstall of shipped terminals
  • Installing shipped terminals and connections
    • CICS-generated aliases
    • Resetting the terminal identifier
      • Example
  • The autoinstall control program at INSTALL
    • The communications area at INSTALL for shipped terminals
  • The autoinstall control program at DELETE
  • Default actions of the sample programs
• Chapter 15. Writing a program to control autoinstall of virtual terminals
  • How Client virtual terminals are autoinstalled
    • Autoinstall models
    • Terminal identifiers
    • Why override TERMIDs?
      • Overriding CICS-generated TERMIDs
      • Overriding Client-specified TERMIDs
  • How bridge facility virtual terminals are autoinstalled
    • Using the terminal autoinstall control program for bridge facilities
      • Autoinstall of a START bridge facility
      • Autoinstall of a Link3270 bridge facility
    • Bridge facility name uniqueness
  • The autoinstall control program at INSTALL
    • The communications area at INSTALL for Client virtual terminals
    • The communications area at INSTALL for bridge facility virtual terminals
  • The autoinstall control program at DELETE
    • The communications area at DELETE for Client virtual terminals
    • The communications area at DELETE for bridge facility virtual terminals
  • Default actions of the sample programs
• Chapter 16. Writing a program to control autoinstall of programs
  • Autoinstalling programs—preliminary considerations
    • Autoinstall model definitions
    • Autoinstalling programs invoked by EXEC CICS LINK commands
    • Autoinstall processing of mapsets
    • System autoinstall
  • Benefits of autoinstalling programs
    • Reduced system administration costs
    • Saving in virtual storage
    • Faster startup times
      • Warm and emergency starts
      • Initial and cold starts
  • Requirements for program autoinstall
  • The autoinstall control program at INSTALL
  • The sample autoinstall control program for programs, DFHPGADX
    • Customizing the sample program
    • Resource definition
    • Testing and debugging your program
• Chapter 17. Writing a dynamic routing program
  • Routing transactions dynamically
    • Dynamic transactions
    • When the dynamic routing program is invoked
    • Information passed to the dynamic routing program
    • Changing the target CICS region
      • Using a common transaction definition in the TOR
    • Changing the program name
    • Telling CICS whether to route or terminate a transaction
    • If the system is unavailable or unknown
    • Invoking the dynamic routing program at end of routed transactions
    • Invoking the dynamic routing program on abend
    • Modifying the initial terminal data
    • Modifying the application’s communications area
    • Receiving information from a routed transaction
      • Monitoring the output communications area
      • Monitoring the output TIOA
    • Some processing considerations
    • Unit of work considerations
  • Routing DPL requests dynamically
    • When the dynamic routing program is invoked
    • Changing the target CICS region
    • Changing the program name
    • Changing the transaction ID
    • Telling CICS whether to route or terminate a DPL request
    • If an error occurs in route selection
    • Using the XPCERES exit to check the availability of resources on the target region
    • Invoking the dynamic routing program at end of routed requests
    • Modifying the application’s input communications area
    • Monitoring the application’s output communications area
    • Some processing considerations
    • Unit of work considerations
  • Routing bridge requests dynamically
    • Changing bridge request parameters
      • Changing the Link3270 bridge request SYSID
      • Changing the bridge request TRANSID
      • Changing the Link3270 bridge request transaction priority
    • Rejecting a Link3270 bridge request
    • Handling route selection errors of Link3270 bridge requests
    • Using the XPCERES exit to check the availability of resources on the target region
    • Re-invoking the dynamic routing program after Link3270 bridge requests
    • Link3270 bridge dynamic routing considerations
  • Modifying the application’s containers
  • Routing by user ID
  • Parameters passed to the dynamic routing program
  • Naming your dynamic routing program
  • Testing your dynamic routing program
  • Dynamic transaction routing sample programs
• Chapter 18. Writing a distributed routing program
  • Differences between the distributed and dynamic routing interfaces
  • Routing BTS activities
    • Which BTS activities can be dynamically routed?
    • When the distributed routing program is invoked
    • Changing the target CICS region
    • Telling CICS whether to route the activity
    • If an error occurs in route selection
    • Invoking the distributed routing program on the target region
  • Routing method requests for enterprise beans and CORBA stateless objects
    • Where workload balancing occurs
      • Local and remote clients
    • Which requests can be dynamically routed?
    • When the distributed routing program is invoked
    • Changing the target CICS region
    • Telling CICS whether to route the method request
    • If an error occurs in route selection
    • Invoking the distributed routing program on the target region
    • Dealing with a disabled CorbaServer
    • Performing a rolling upgrade of an EJB/CORBA server
  • Routing non-terminal-related START requests
    • Which requests can be dynamically routed?
    • When the distributed routing program is invoked
    • Changing the target CICS region
    • Telling CICS whether to route the request
    • If an error occurs in route selection
    • Using the XICERES exit to check the availability of resources on the target region
    • Invoking the distributed routing program on the target region
  • Routing inbound Web service requests
    • Which requests can be dynamically routed?
    • When the distributed routing program is invoked
    • Changing the target CICS region
    • Telling CICS whether to route the request
    • If an error occurs in route selection
    • Invoking the distributed routing program on the target region
  • Routing by user ID
  • Dealing with an abend on the target region
  • Some processing considerations
  • Parameters passed to the distributed routing program
  • Naming your distributed routing program
  • Distributed transaction routing sample programs
• Chapter 19. Writing a CICS–DBCTL interface status program
  • The sample CICS–DBCTL interface status program
• Chapter 20. Writing a 3270 bridge exit program
• Chapter 21. Writing a security exit program for IIOP
  • The sample programs
    • DFHXOPUS
    • DFHEBURM
• Chapter 22. Writing programs to customize JVMs
  • Writing Java classes to redirect JVM stdout and stderr output
    • The com.ibm.cics.server.OutputRedirectionPlugin interface
    • Possible destinations for output
    • Handling output redirection errors and internal errors
  • Using DFHJVMRO to modify the Language Environment enclave for a JVM
  • Using DFHJVMAT to modify options in a JVM profile
    • Options in the JVM profile that are available to DFHJVMAT
• Chapter 23. Writing a distinguished name program for clients of enterprise beans
  • Sample programs and copy books
• Chapter 24. Writing an EJB event program
  • Overview of the EJB event program
  • The DFHEJEP communications area
  • Event codes
  • The EJB event sample program
    • Actions of the default program
    • Writing your own EJB event program
• Chapter 25. Writing programs to customize Language Environment run-time options for XPLink programs
  • DFHAPXPO
    • Defining run-time options
• Part 4. Customizing the XRF overseer program
• Chapter 26. The extended recovery facility overseer program
  • The sample XRF overseer program
    • The functions of the sample program
      • The display function
      • The restart-in-place function
      • Opening CAVM data sets dynamically
    • How the sample overseer program interfaces with CICS
    • How to tell the overseer which actives and alternates to monitor
  • The DFHWOSM macros
    • The DFHWOSM tokens
    • DFHWOSM FUNC=BUILD macro
    • DFHWOSM FUNC=CLOSE macro
    • DFHWOSM FUNC=DSECT macro
    • DFHWOSM FUNC=JJC macro
    • DFHWOSM FUNC={JJS|QJJS} macro
    • DFHWOSM FUNC=OPEN macro
    • DFHWOSM FUNC=OSCMD macro
    • DFHWOSM FUNC=READ macro
      • Reading DBCTL status information from the CAVM data sets
    • DFHWOSM FUNC=TERM macro
  • Customizing the sample XRF overseer program
    • Loop or wait detection
    • Assembling and link-editing the overseer program
• Part 5. CICS journaling, monitoring, and statistics
• Chapter 27. CICS logging and journaling
  • The CICS log manager
  • Log stream storage
  • Enabling, disabling, and reading journals
    • Enabling and disabling a journal
    • Reading journal records offline
  • Structure and content of CICS Transaction Server for z/OS format journal records
    • Format of general log block header
    • Format of general log journal record
    • Start-of-run record
    • Format of caller data
      • Caller data written by file control
      • Read-only, read-update, write-update, write-add, write-add complete record types
      • Write-delete record types
      • File-close record types
      • Tie-up record types
      • Terminal control prefix data
      • FEPI prefix data
  • Structure and content of COMPAT41-format journal records
    • Format of COMPAT41 journal control label header
    • Format of journal record
    • Identifying records for the start of tasks and UOWs
  • Format of journal records written to SMF
    • The SMF block header
    • The CICS product section
    • The CICS data section
• Chapter 28. CICS monitoring
  • Introduction to CICS monitoring
    • How CICS monitoring data is passed to SMF
    • Coding additional event-monitoring points
    • Application naming event monitoring points
      • Examples of invoking application naming EMPs
    • The monitoring control table (MCT)
      • DFHMCT TYPE=EMP
      • DFHMCT TYPE=RECORD
      • Examples of MCT coding with MONITOR commands
      • DFHMCT TYPE=EMP entries for DBCTL
  • CICS monitoring record formats
    • SMF header and SMF product section
    • CICS data section
      • Dictionary data sections
      • Performance data sections
      • Relationship of the dictionary record to the performance records: field connectors
      • Exception data sections
      • Transaction resource data sections
• Chapter 29. Writing statistics collection and analysis programs
  • Writing a program to collect CICS statistics
    • Background information
    • Resetting statistics counters
    • Using the EXEC CICS COLLECT and EXTRACT STATISTICS commands
  • CICS statistics record format
    • SMF header and SMF product section
    • CICS statistics data section
  • Using an XSTOUT global user exit program to filter statistics records
  • Processing the output from CICS statistics
• Part 6. Customizing CICS compatibility interfaces
• Chapter 30. The dynamic allocation sample program
  • Overview of the dynamic allocation program
  • Installing the program and transaction definitions
  • The dynamic allocation program—terminal operation
  • Using the dynamic allocation program’s Help feature
  • The dynamic allocation program—values
    • Abbreviation rules for keywords
    • System programming considerations
  • The flow of control when a DYNALLOC request is issued
• Part 7. Customizing CICS security processing
• Chapter 31. Invoking an external security manager
  • An overview of the CICS-ESM interface
  • The MVS router
    • The MVS router exit
      • The MVS router parameter list
      • Router exit return codes
      • Passing control to a user-supplied ESM
  • Using ESM exit programs to access CICS-related information
    • For non-RACF users — the ESM parameter list
    • For RACF users — the RACF user exit parameter list
    • The installation data parameter list
  • CICS security control points
  • Using early verification processing
    • Writing an early verification routine
    • Using CICS API commands in an early verification routine
    • Return and reason codes from the early verification routine
• Chapter 32. Writing a “good night” program
  • The communications area of the “good night” program
  • The sample “good night” program, DFH0GNIT
    • What the sample program does
  • Customizing the sample “good night” program
• Part 8. Examining and modifying resource attributes
• Chapter 33. Using the programmable interface to CEDA
  • When to use the programmable interface
  • Using DFHEDAP in a DTP environment
• Chapter 34. User programs for the system definition utility program (DFHCSDUP)
  • An overview of DFHCSDUP
  • Invoking a user program from DFHCSDUP
    • Writing a program to be invoked during EXTRACT processing
    • The EXTRACT command
    • When the user program is invoked
    • Parameters passed from DFHCSDUP to the user program
    • The sample EXTRACT programs
      • The CSD cross-referencing program
      • The DB2 formatting program
      • The CSD backup utility program
    • Assembling and link-editing EXTRACT programs
      • An assembler-language version
      • A Language Environment version
  • Invoking DFHCSDUP from a user program
    • Entry parameters for DFHCSDUP
    • Responsibilities of the user program
  • The user exit points in DFHCSDUP
    • Parameters passed to the user exit routines
    • The initialization exit
    • The get-command exit
    • The extract exit
    • The put-message exit
    • The termination exit
  • The sample program, DFH$CUS1
• Part 9. Appendixes
• Appendix A. Coding entries in the VTAM LOGON mode table
  • Overview of the VTAM LOGON mode table
  • TYPETERM device types and pointers to related LOGON mode data
  • VTAM MODEENT macro operands
  • PSERVIC screen size values for LUTYPEx devices
  • Matching models and LOGON mode entries
  • LOGON mode definitions for CICS-supplied autoinstall models
• Appendix B. Default actions of the node abnormal condition program
  • DFHZNAC—default actions for terminal error codes
  • CICS messages associated with VTAM errors
  • DFHZNAC—default actions for system sense codes
  • Action flag settings and meanings
• Appendix C. Analyzing CICS restart information
• Appendix D. Using the transient data write-to-terminal program (DFH$TDWT)
  • DFH$TDWT—resource definitions required
• Appendix E. Uppercase translation
  • Translating national characters to uppercase
    • Using the XZCIN exit
    • Using DFHTCTxx
  • Translating TS data sharing messages to uppercase
• Appendix F. The example program for the XTSEREQ global user exit, DFH$XTSE
• Appendix G. Threadsafe XPI commands
• Bibliography
  • The CICS Transaction Server for z/OS library
    • The entitlement set
    • PDF-only books
      • CICS books for CICS Transaction Server for z/OS
      • CICSPlex SM books for CICS Transaction Server for z/OS
      • CICS family books
      • Licensed publications
  • Other CICS books
  • Books from related libraries
    • MVS books
    • VTAM books
    • Other related books
  • Determining if a publication is current
• Accessibility
• Index
  • Special characters
  • Numerics
  • A
  • B
  • C
  • D
  • E
  • F
  • G
  • I
  • J
  • K
  • L
  • M
  • N
  • O
  • P
  • Q
  • R
  • S
  • T
  • U
  • V
  • W
  • X
• Notices
• Trademarks
• Readers’ Comments — We'd Like to Hear from You