IBM SC34-6814-04 User Manuals

Table of Contents

• Contents

  5
• Preface

  19
  • What this book is about

    19
  • Who this book is for

    19
  • What you need to know to understand this book

    19
  • How to use this book

    19
  • Notes on terminology

    19
  • Syntax notation and conventions used in this book

    20
• Summary of changes

  21
  • Changes for CICS Transaction Server for z/OS, Version 3 Release 2

    21
  • Changes for CICS Transaction Server for z/OS, Version 3 Release 1

    21
  • Changes for CICS Transaction Server for z/OS, Version 2 Release 3

    22
• Part 1. Customizing with user exit programs

  23
• Chapter 1. Global user exit programs

  25
  • Writing global user exit programs

    25
    • Register conventions

      25
    • 31-bit addressing implications

      26
      • Access register implications

        26
    • Using CICS services

      26
      • Using EXEC CICS and XPI calls in the same exit program

        27
    • Using channels and containers

      27
    • Assembler programs and LEASM

      28
    • EDF and global user exits

      28
    • The global work area

      28
    • Making trace entries

      28
    • Parameters passed to the global user exit program

      29
      • DFHUEPAR standard parameters

        29
    • Returning values to CICS

      32
    • Restrictions on the use of fields as programming interfaces

      33
    • Exit programs and the CICS storage protection facility

      33
    • Errors in user exit programs

      34
  • Defining, enabling, and disabling an exit program

    34
  • Viewing active global user exits

    35
  • Invoking more than one exit program at a single exit

    35
  • Invoking a single exit program at more than one exit

    36
  • Making programs threadsafe

    36
  • Sample global user exit programs

    37
    • Basic sample and example programs

      37
      • Global work area (GWA) sample exit programs

        37
      • The DFH$PCPI program

        38
      • Sample program definitions

        39
      • Example program

        40
    • Sample programs for specific exits

      40
      • The Application Associated Data sample exit program

        40
      • The Basic Mapping Support sample exit program

        40
      • The data tables sample exit programs

        40
      • The dump domain sample exit program

        41
      • The enqueue EXEC interface sample exit program

        41
      • The file control state program sample exit program

        41
      • The file control recovery program sample exit programs

        41
      • The function-shipping and DPL queue control sample exit program

        42
      • The HTTP client sample exit programs

        42
      • The interval control EXEC interface sample exit program

        45
      • The log manager domain sample exit program

        45
      • The message domain sample exit programs

        45
      • The MRO and APPC session queue management sample exit program

        46
      • The pipeline sample exit program

        46
      • The session queue management sample exit program, for IPIC connections

        46
      • The transaction-abend sample exit program

        46
      • The terminal-not-known sample exit program

        47
  • Alphabetical list of global user exit points

    47
  • Global user exit points by functional area

    54
    • Activity keypoint program exit XAKUSER

      54
    • Application Associated Data exit, XAPADMGR, in the AP domain

      55
    • Basic Mapping Support exits XBMIN and XBMOUT

      56
      • Exit XBMIN

        57
      • Exit XBMOUT

        57
      • The field element table structure

        58
      • Programming the XBMIN exit

        59
      • Programming the XBMOUT exit

        60
    • Bridge facility exit XFAINTU

      60
    • Data tables management exits XDTRD, XDTAD, and XDTLC

      62
      • Exit XDTRD

        63
      • Exit XDTAD

        65
      • Exit XDTLC

        66
    • DBCTL interface control program exit XXDFA

      67
    • DBCTL tracking program exits XXDFB and XXDTO

      68
      • Exit XXDFB

        68
      • Exit XXDTO

        68
    • Dispatcher domain exits XDSBWT and XDSAWT

      69
      • Exit XDSBWT

        69
      • Exit XDSAWT

        70
    • DL/I interface program exits XDLIPRE and XDLIPOST

      70
      • Exit XDLIPRE

        71
      • Exit XDLIPOST

        73
    • Dump domain exits XDUREQ, XDUREQC, XDUCLSE, and XDUOUT

      75
      • Exit XDUREQ

        75
      • Exit XDUREQC

        78
      • Exit XDUCLSE

        81
      • Exit XDUOUT

        81
    • Enqueue EXEC interface program exits XNQEREQ and XNQEREQC

      82
      • Exit XNQEREQ

        82
      • Exit XNQEREQC

        83
      • The command-level parameter structure

        85
      • Sample exit program, DFH$XNQE

        88
    • EXEC interface program exits XEIIN, XEIOUT, XEISPIN, and XEISPOUT

      89
      • The command parameter list

        90
      • Bypassing commands

        91
      • Exit XEIIN

        91
      • Exit XEISPIN

        92
      • Exit XEIOUT

        93
      • Exit XEISPOUT

        93
    • File control domain exits, XFCFRIN and XFCFROUT

      94
      • XFCFRIN

        94
      • XFCFROUT

        95
      • Exit XFCFRIN

        96
      • Exit XFCFROUT

        102
    • File control EXEC interface API exits XFCREQ and XFCREQC

      107
      • The command-level parameter structure

        109
      • Modifying fields in the command-level parameter structure

        113
      • Modifying the EID

        114
      • Use of the task token UEPTSTOK

        115
      • Use of the parameter UEPFSHIP

        116
      • The EIB

        116
      • Example of how XFCREQ and XFCREQC can be used

        116
      • Exit XFCREQ

        117
      • Exit XFCREQC

        118
    • File control EXEC interface SPI exits XFCAREQ and XFCAREQC

      120
      • Exit XFCAREQ

        121
      • Exit XFCAREQC

        122
      • The command-level parameter structure

        123
      • Modifying fields in the command-level parameter structure

        129
      • Modifying the EID

        132
      • Use of the task token UEPTSTOK

        132
      • Modifying user arguments

        133
    • File control file state program exits XFCSREQ and XFCSREQC

      133
      • Exit XFCSREQ

        134
      • Exit XFCSREQC

        138
    • File control open/close program exit XFCNREC

      143
      • Using XFCNREC with a back out recovery setting mismatch

        143
      • Using XFCNREC with a BWO mismatch

        144
    • File control quiesce receive exit, XFCVSDS

      144
      • Exit XFCVSDS

        145
    • File control quiesce send exit XFCQUIS

      146
    • File control recovery program exits XFCBFAIL, XFCBOUT, XFCBOVER, and XFCLDEL

      148
      • Order of invocation

        148
      • Enabling the exit programs

        148
      • Exit XFCBFAIL, file control backout failure exit

        149
      • Exit XFCBOUT, file control backout exit

        153
      • Exit XFCBOVER, file control backout override exit

        154
      • Exit XFCLDEL, file control logical delete exit

        157
    • Front End Programming Interface exits XSZARQ and XSZBRQ

      159
    • Good morning message program exit XGMTEXT

      160
    • HTTP client open and send exits: XWBAUTH, XWBOPEN and XWBSNDO

      160
    • Intersystem communication program exits XISCONA and XISLCLQ

      160
      • The XISCONA exit

        160
      • The XISLCLQ exit

        163
    • Interval control program exits XICREQ, XICEXP, and XICTENF

      165
      • Exit XICREQ

        165
      • Exit XICEXP

        166
      • Exit XICTENF

        167
    • Interval control EXEC interface program exits XICEREQ, XICERES, and XICEREQC

      167
      • Parameters passed to each of the exits

        168
      • Exit XICEREQ

        168
      • Exit XICERES

        170
      • Exit XICEREQC

        171
      • The command-level parameter structure

        172
    • Loader domain exits XLDLOAD and XLDELETE

      184
      • Exit XLDLOAD

        185
      • Exit XLDELETE

        185
    • Log manager domain exit XLGSTRM

      186
      • Exit XLGSTRM

        188
      • An example of how XLGSTRM can be used

        189
      • The sample program for the XLGSTRM exit, DFH$LGLS

        189
    • Message domain exit XMEOUT

      190
      • Exit XMEOUT

        191
      • The sample XMEOUT global user exit programs

        193
    • Monitoring domain exit XMNOUT

      194
      • Exit XMNOUT

        194
    • Pipeline domain exits

      196
      • Exit XWSPRROO

        196
    • Program control program exits XPCREQ, XPCERES, XPCREQC, XPCFTCH, XPCHAIR, XPCTA, and XPCABND

      197
      • XPCREQ, XPCERES, and XPCREQC

        197
      • Exit XPCFTCH

        208
      • The sample XPCFTCH global user exit program, DFH$PCEX

        210
      • Exit XPCHAIR

        210
      • Exit XPCTA

        212
      • The sample XPCTA global user exit program, DFH$PCTA

        213
      • Exit XPCABND

        214
    • Resource manager interface program exits XRMIIN and XRMIOUT

      215
      • Exit XRMIIN

        215
      • Exit XRMIOUT

        216
    • Resource management install and discard exit XRSINDI

      217
      • Exit XRSINDI

        218
    • Signon and signoff exits XSNON, XSNOFF, and XSNEX

      221
      • Exit XSNON

        221
      • Exit XSNOFF

        222
      • Exit XSNEX

        223
    • Statistics domain exit XSTOUT

      224
      • Exit XSTOUT

        224
    • System recovery program exit XSRAB

      225
    • System termination program exit XSTERM

      228
      • Exit XSTERM

        228
    • Temporary storage domain exits XTSQRIN, XTSQROUT, XTSPTIN, and XTSPTOUT

      229
      • Exit XTSQRIN

        229
      • Exit XTSQROUT

        230
      • Exit XTSPTIN

        232
      • Exit XTSPTOUT

        233
    • Temporary storage EXEC interface program exits XTSEREQ and XTSEREQC

      234
      • Exit XTSEREQ

        235
      • Exit XTSEREQC

        236
      • The command-level parameter structure

        237
    • Terminal allocation program exit XALCAID

      243
      • Exit XALCAID

        243
    • Terminal control program exits XTCIN, XTCOUT, and XTCATT

      245
      • Exit XTCIN

        245
      • Exit XTCOUT

        245
      • Exit XTCATT

        246
    • ‘Terminal not known’ condition exits XALTENF and XICTENF

      246
      • The exits

        247
      • Exit XALTENF

        248
      • Exit XICTENF

        250
      • The sample program for the XALTENF and XICTENF exits, DFHXTENF

        252
    • Transaction manager domain exit XXMATT

      254
      • Exit XXMATT

        254
    • Transient data program exits XTDREQ, XTDIN, and XTDOUT

      256
      • Exit XTDREQ

        256
      • Exit XTDIN

        256
      • Exit XTDOUT

        257
    • Transient data EXEC interface program exits XTDEREQ and XTDEREQC

      258
      • Exit XTDEREQ

        259
      • Exit XTDEREQC

        260
      • The command-level parameter structure

        261
    • User log record recovery program exits XRCINIT and XRCINPT

      266
      • Coding the exit programs

        267
      • Enabling the exit programs

        267
      • Exit XRCINIT

        268
      • Exit XRCINPT

        268
    • VTAM terminal management program exit XZCATT

      269
      • Exit XZCATT

        269
    • VTAM working-set module exits XZCIN, XZCOUT, XZCOUT1, and XZIQUE

      270
      • Exit XZCIN

        270
      • Exit XZCOUT

        270
      • Exit XZCOUT1

        271
      • XZIQUE exit for managing MRO and APPC intersystem queues

        271
      • Designing an XZIQUE global user exit program

        278
    • XISQUE exit for managing IPIC intersystem queues

      280
      • When the XISQUE exit is invoked

        280
      • Exit XISQUE

        280
      • Using an XISQUE global user exit program

        282
      • Statistics fields in DFHISRDS

        283
      • Designing an XISQUE global user exit program

        284
    • XRF request-processing program exit XXRSTAT

      285
      • Exit XXRSTAT

        286
• Chapter 2. Task-related user exit programs

  289
  • Introduction to the task-related user exit mechanism (the adapter)

    289
  • The stub program

    291
    • Returning control to the application program

      292
    • Task-related user exits and EDF

      292
  • Writing a task-related user exit program

    293
    • Obligations of OPENAPI task-related user exits

      293
      • Threadsafe restrictions

        294
      • Calling an OPENAPI task-related user exit

        294
    • User exit parameter lists

      295
      • DFHUEPAR

        296
      • DFHUERTR (the function definition)

        300
      • Caller parameter lists

        301
      • Summary of the task-related user exit parameter lists

        307
    • The schedule flag word

      309
    • Register handling in the task-related user exit program

      310
      • Saving CICS registers

        310
      • The calling program’s registers

        311
      • The RMI registers

        311
    • Addressing-mode implications

      311
    • Exit programs and the CICS storage protection facility

      312
      • Execution key for task-related user exit programs

        312
      • Data storage key for task-related user exit programs

        312
    • Recursion within a task-related user exit program

      312
    • Purging tasks

      312
    • Using CICS services in your task-related user exit program

      313
    • Using channels and containers

      314
    • Assembler programs and LEASM

      314
    • Wait states in your task-related user exit program

      314
    • Work areas

      314
      • The global work area

        314
      • The local work area

        315
    • Coding a program to be invoked by the CICS SPI

      315
    • Coding a program to be invoked by the CICS syncpoint manager

      315
      • Increasing efficiency – single-update and read-only protocols

        316
      • Return codes

        316
      • What is expected of your resource manager

        317
      • Limitations

        317
      • Sample code for a TRUE invoked by the CICS syncpoint manager

        317
      • Resynchronization

        319
    • Coding a program to be invoked by the CICS task manager

      319
      • Limitations

        320
    • Coding a program to be invoked at CICS termination

      320
      • Limitations

        320
      • Sample code for a TRUE invoked at CICS termination

        321
    • Using EDF with your task-related user exit program

      323
  • Administering the adapter

    324
    • What you must do before using the adapter

      325
      • Enabling for specific invocation-types

        325
      • The administration routines

        326
    • Tracing a task-related user exit program

      326
• Chapter 3. The user exit programming interface (XPI)

  327
  • Overview of the XPI

    327
  • Making an XPI call

    330
    • Setting up the XPI environment

      334
    • XPI register usage

      334
    • The XPI copy books

      335
    • Reentrancy considerations resulting from XPI calls

      335
  • Global user exit XPI examples, showing the use of storage

    335
    • An example showing how to build a parameter list incrementally

      340
  • XPI syntax

    341
  • Directory domain XPI functions

    343
    • The BIND_LDAP call

      343
      • RESPONSE and REASON values for BIND_LDAP:

        344
    • The END_BROWSE_RESULTS call

      345
      • RESPONSE and REASON values for END_BROWSE_RESULTS:

        345
    • The FLUSH_LDAP_CACHE call

      345
      • RESPONSE and REASON values for FLUSH_LDAP_CACHE:

        346
    • The FREE_SEARCH_RESULTS call

      346
      • RESPONSE and REASON values for FREE_SEARCH_RESULTS:

        346
    • The GET_ATTRIBUTE_VALUE call

      347
      • RESPONSE and REASON values for GET_ATTRIBUTE_VALUE:

        348
    • The GET_NEXT_ATTRIBUTE call

      348
      • RESPONSE and REASON values for GET_NEXT_ATTRIBUTE:

        349
    • The GET_NEXT_ENTRY call

      349
      • RESPONSE and REASON values for GET_NEXT_ENTRY:

        350
    • The SEARCH_LDAP call

      350
      • RESPONSE and REASON values for SEARCH_LDAP:

        351
    • The START_BROWSE_RESULTS call

      351
      • RESPONSE and REASON values for START_BROWSE_RESULTS:

        352
    • The UNBIND_LDAP call

      352
      • RESPONSE and REASON values for UNBIND_LDAP:

        353
  • Dispatcher XPI functions

    353
    • Synchronization protocols for SUSPEND and RESUME processing

      353
      • The normal synchronization protocol

        354
      • The synchronization protocol and task purge

        354
    • The ADD_SUSPEND call

      356
      • RESPONSE and REASON values for ADD_SUSPEND:

        357
    • The SUSPEND call

      357
      • RESPONSE and REASON values for SUSPEND:

        360
    • The RESUME call

      361
      • RESPONSE and REASON values for RESUME:

        361
    • The DELETE_SUSPEND call

      362
      • RESPONSE and REASON values for DELETE_SUSPEND:

        362
    • The WAIT_MVS call

      362
      • RESPONSE and REASON values for WAIT_MVS:

        366
    • The CHANGE_PRIORITY call

      366
      • RESPONSE and REASON values for CHANGE_PRIORITY:

        367
  • Dump control XPI functions

    367
    • The SYSTEM_DUMP call

      367
      • RESPONSE and REASON values for SYSTEM_DUMP:

        368
    • The TRANSACTION_DUMP call

      369
      • RESPONSE and REASON values for TRANSACTION_DUMP:

        370
  • Enqueue domain XPI functions

    371
    • The ENQUEUE function

      371
      • RESPONSE and REASON values for ENQUEUE

        372
    • The DEQUEUE function

      372
      • RESPONSE and REASON values for DEQUEUE

        373
  • Kernel domain XPI functions

    373
    • The START_PURGE_PROTECTION function

      373
      • RESPONSE values for START_PURGE_PROTECTION:

        373
    • The STOP_PURGE_PROTECTION function

      373
      • RESPONSE values for STOP_PURGE_PROTECTION:

        374
    • Nesting purge protection calls

      374
  • Loader XPI functions

    374
    • The DEFINE_PROGRAM call

      375
      • RESPONSE and REASON values for DEFINE_PROGRAM:

        377
    • The ACQUIRE_PROGRAM call

      378
      • RESPONSE and REASON values for ACQUIRE_PROGRAM:

        380
    • The RELEASE_PROGRAM call

      380
      • RESPONSE and REASON values for RELEASE_PROGRAM:

        381
    • The DELETE_PROGRAM call

      381
      • RESPONSE and REASON values for DELETE_PROGRAM:

        382
  • Log manager XPI functions

    382
    • The INQUIRE_PARAMETERS call

      382
      • RESPONSE and REASON values for INQUIRE_PARAMETERS:

        382
    • The SET_PARAMETERS call

      383
      • RESPONSE and REASON values for SET_PARAMETERS:

        383
  • Monitoring XPI functions

    383
    • The MONITOR call

      384
      • RESPONSE and REASON values for MONITOR:

        386
    • The INQUIRE_MONITORING_DATA call

      386
      • RESPONSE and REASON values for INQUIRE_MONITORING_DATA:

        387
  • Program management XPI functions

    388
    • The INQUIRE_PROGRAM call

      388
      • RESPONSE and REASON values for INQUIRE_PROGRAM:

        395
    • The INQUIRE_CURRENT_PROGRAM call

      395
      • RESPONSE and REASON values for INQUIRE_CURRENT_PROGRAM:

        397
    • The SET_PROGRAM call

      397
      • RESPONSE and REASON values for SET_PROGRAM:

        400
    • The START_BROWSE_PROGRAM call

      401
      • RESPONSE and REASON values for START_BROWSE_PROGRAM:

        401
    • The GET_NEXT_PROGRAM call

      402
      • RESPONSE and REASON values for GET_NEXT_PROGRAM:

        403
    • The END_BROWSE_PROGRAM call

      403
      • RESPONSE and REASON values for END_BROWSE_PROGRAM:

        403
    • The INQUIRE_AUTOINSTALL call

      404
      • RESPONSE and REASON values for INQUIRE_AUTOINSTALL:

        404
    • The SET_AUTOINSTALL call

      404
      • RESPONSE and REASON values for SET_AUTOINSTALL:

        405
  • State data access XPI functions

    406
    • The INQ_APPLICATION_DATA call

      406
      • RESPONSE and REASON values for INQ_APPLICATION_DATA:

        408
    • The INQUIRE_SYSTEM call

      408
      • RESPONSE and REASON values for INQUIRE_SYSTEM

        412
    • The SET_SYSTEM call

      413
      • RESPONSE and REASON values for SET_SYSTEM:

        414
  • Storage control XPI functions

    414
    • The GETMAIN call

      414
      • RESPONSE and REASON values for GETMAIN:

        416
    • The FREEMAIN call

      417
      • RESPONSE and REASON values for FREEMAIN:

        417
    • The INQUIRE_ACCESS call

      417
      • RESPONSE and REASON values for INQUIRE_ACCESS:

        418
    • The INQUIRE_ELEMENT_LENGTH call

      418
      • RESPONSE and REASON values for INQUIRE_ELEMENT_LENGTH:

        419
    • The INQUIRE_SHORT_ON_STORAGE call

      419
      • RESPONSE and REASON values for INQUIRE_SHORT_ON_STORAGE:

        420
    • The INQUIRE_TASK_STORAGE call

      420
      • RESPONSE and REASON values for INQUIRE_TASK_STORAGE:

        420
    • The SWITCH_SUBSPACE call

      421
      • RESPONSE and REASON values for SWITCH_SUBSPACE:

        421
  • Trace control XPI function

    421
    • The TRACE_PUT call

      422
      • RESPONSE values for TRACE_PUT

        423
  • Transaction management XPI functions

    423
    • The INQUIRE_CONTEXT call

      423
      • RESPONSE and REASON values for INQUIRE_CONTEXT:

        424
    • The INQUIRE_DTRTRAN call

      425
      • RESPONSE and REASON values for INQUIRE_DTRTRAN:

        425
    • The INQUIRE_MXT call

      425
      • RESPONSE and REASON values for INQUIRE_MXT:

        426
    • The INQUIRE_TCLASS call

      427
      • RESPONSE and REASON values for INQUIRE_TCLASS:

        428
    • The INQUIRE_TRANDEF call

      428
      • RESPONSE and REASON values for INQUIRE_TRANDEF:

        436
    • The INQUIRE_TRANSACTION call

      436
      • RESPONSE and REASON values for INQUIRE_TRANSACTION:

        440
    • The SET_TRANSACTION call

      440
      • RESPONSE and REASON values for SET_TRANSACTION:

        441
  • User journaling XPI function

    441
    • The WRITE_JOURNAL_DATA call

      441
      • RESPONSE and REASON values for WRITE_JOURNAL_DATA:

        442
• Part 2. Customizing with initialization and shutdown programs

  445
• Chapter 4. Writing initialization and shutdown programs

  447
  • Writing initialization programs

    447
    • First-phase PLT programs

      447
    • Second phase PLT programs

      448
    • Effect of delayed recovery on PLTPI processing

      449
  • Writing shutdown programs

    450
    • First phase PLT programs

      450
    • PLT programs for the second quiesce stage

      450
    • The shutdown assist utility program, DFHCESD

      451
  • General considerations when writing initialization and shutdown programs

    451
    • Storage keys for PLT programs

      452
      • Execution key for PLT programs

        452
      • Data storage key for PLT programs

        453
• Part 3. Customizing with user-replaceable programs

  455
• Chapter 5. General notes about user-replaceable programs

  457
  • Rewriting user-replaceable programs

    457
  • Assembling and link-editing user-replaceable programs

    458
  • User-replaceable programs and the storage protection facility

    459
    • Execution key for user-replaceable programs

      459
    • Data storage key for user-replaceable programs

      460
• Chapter 6. Writing a program error program

  461
  • The sample program error programs

    465
• Chapter 7. Writing a transaction restart program

  467
  • The DFHREST communications area

    468
  • The CICS-supplied transaction restart program

    469
• Chapter 8. Writing a terminal error program

  471
  • Background to error handling for sequential devices

    471
    • When an abnormal condition occurs

      471
    • Terminal control program

      472
    • Terminal abnormal condition program

      472
    • Terminal error program

      472
    • The communication area

      473
    • Terminal abnormal condition line entry (TACLE)

      473
  • The sample terminal error program

    473
    • Components of the sample terminal error program

      473
      • TEP error table

        474
      • TEP default table

        475
    • Structure of the sample terminal error program

      475
      • Entry and initialization

        476
      • Terminal ID and error code lookup

        476
      • Error processor selection

        476
      • Error processing execution

        476
      • General exit

        477
      • Common subroutines

        477
    • Sample terminal error program messages

      478
    • Generating the sample terminal error program

      480
      • Job control for generating the sample terminal error program

        481
      • DFHTEPM–generating the sample DFHTEP module

        481
      • DFHTEPM TYPE=ENTRY and EXIT–for user entry and exit routines

        484
      • DFHTEPM TYPE=ERRPROC–replacing error processors

        484
      • DFHTEPM TYPE=FINAL–ending the sample DFHTEP module

        485
      • DFHTEPM macro examples

        485
      • DFHTEPT–generating the sample DFHTEP tables

        486
      • DFHTEPT TYPE=INITIAL–establishing the control section

        487
      • DFHTEPT TYPE=PERMTID–assigning permanent terminal error blocks

        487
      • DFHTEPT TYPE=PERMCODE|ERRCODE–defining error status elements

        488
      • DFHTEPT TYPE=BUCKET–using the error bucket for specific errors

        490
      • DFHTEPT TYPE=FINAL–terminating DFHTEPT entries

        491
      • DFHTEPT–examples of how the macros are used

        491
  • Writing your own terminal error program

    492
    • Why write your own terminal error program?

      492
    • Restrictions on the use of EXEC CICS commands

      492
    • Addressing the contents of the communication area

      493
      • Resetting the flags in the user action byte, TEPCAACT

        494
    • Addressing the contents of the TACLE

      495
    • Example of a user-written terminal error program

      497
      • DFHTEP recursive retry routine

        498
• Chapter 9. Writing a node error program

  501
  • Background to CICS-VTAM error handling

    502
    • Why use a NEP to supplement CICS default actions?

      502
    • An overview of writing a NEP

      503
    • The default NEP

      504
    • The sample NEP

      504
      • The node error table

        504
      • Coding the sample NEP

        505
    • Multiple NEPs

      507
  • When an abnormal condition occurs

    508
    • The communication area

      509
      • The user option bytes (TWAOPTL)

        513
      • Additional information for the NEP (TWAADINF)

        516
      • The additional system parameters (TWASYSPM)

        517
      • XRF parameters (TWAXRNOT)

        517
  • The sample node error program

    518
    • Compatibility with the sample terminal error program

      518
    • Components of the sample node error program

      518
      • Entry section

        519
      • Routing mechanism

        519
      • Node error table

        519
      • Optional common subroutines

        520
      • Optional error processors for 3270 logical units

        520
      • Optional error processor for interactive logical units

        521
    • Generating the sample node error program

      521
      • DFHSNEP TYPE=USTOR and USTOREND—defining user storage

        521
      • DFHSNEP TYPE=INITIAL—generating the routing mechanism

        522
      • DFHSNEP TYPE=DEF3270—including error processors for 3270 LUs

        522
      • DFHSNEP TYPE=DEFILU—including error processors for INTLUs

        523
      • DFHSNEP TYPE=FINAL—terminating DFHSNEP entries

        523
      • DFHSNEP TYPE=ERRPROC—specifying a user error processor

        523
      • DFHSNET—generating the node error table

        525
      • DSECTs

        526
  • Writing your own node error program

    527
    • Restrictions on the use of EXEC CICS commands

      527
    • Entry and addressability

      528
    • Coding for the 3270 ‘unavailable printer’ condition

      528
    • Coding for session failures

      529
    • Coding for specific VTAM sense codes

      530
    • Writing multiple NEPs

      530
    • DFHZNEPI macros

      530
      • DFHZNEPI TYPE=INITIAL—specifying the default routine

        531
      • DFHZNEPI TYPE=ENTRY—specifying a transaction-class routine

        531
      • DFHZNEPI TYPE=FINAL—terminating DFHZNEPI entries

        531
    • Handling shutdown hung terminals in the node error program

      532
      • How DFHZNAC passes the setting of TCSACTN to DFHZNEP

        532
      • How DFHZNAC passes the DFHZC2351 reason code to DFHZNEP

        532
      • How DFHZNEP can modify the force-close action for the current terminal

        532
  • Using the node error program with XRF or persistent sessions

    532
    • The node error program in an XRF environment

      532
    • The node error program with persistent session support

      533
    • Changing the recovery notification

      533
    • Changing the recovery message

      534
    • Changing the recovery transaction

      534
  • Using the node error program with VTAM generic resources

    534
• Chapter 10. Writing a program to control autoinstall of terminals

  537
  • Autoinstalling terminals—preliminary considerations

    537
    • Coding entries in the VTAM LOGON mode table

      538
    • Using model terminal support (MTS)

      538
      • Coding entries for MTS

        539
    • The autoinstall control program for terminals

      539
  • The autoinstall control program at INSTALL

    539
    • The communication area at INSTALL for terminals

      540
    • How CICS builds the list of autoinstall models

      541
    • Returning information to CICS

      542
      • Selecting the autoinstall model

        543
      • Setting the TERMINAL name

        544
    • CICS action on return from the control program

      545
  • The autoinstall control program at DELETE

    547
    • The communication area at DELETE for terminals

      547
  • Naming, testing, and debugging your autoinstall control program

    548
    • Finding the name of an autoinstall control program

      548
    • Testing and debugging

      548
  • The sample autoinstall control programs for terminals

    549
    • Customizing the sample program

      550
      • Assembler language

        550
      • COBOL

        552
      • PL/I

        553
• Chapter 11. Writing a program to control autoinstall of consoles

  557
  • Autoinstalling consoles—preliminary considerations

    557
    • Leaving it all to CICS

      557
    • Using an autoinstall control program

      557
  • The autoinstall control program at INSTALL

    558
    • The communication area at INSTALL for consoles

      558
    • How CICS builds the list of autoinstall models

      560
    • Returning information to CICS

      560
      • Selecting the autoinstall model

        561
      • Setting the TERMINAL name

        561
    • CICS action on return from the control program

      562
  • The autoinstall control program at DELETE

    562
  • The sample autoinstall control programs for consoles

    563
• Chapter 12. Writing a program to control autoinstall of APPC connections

  565
  • Autoinstalling APPC connections—preliminary considerations

    565
    • Local APPC single-session connections initiated by CINIT

      565
    • Local APPC parallel-session and single-session connections initiated by BIND

      565
    • Autoinstall templates for APPC connections

      566
    • Benefits of autoinstall

      566
    • Requirements for autoinstall

      566
    • The autoinstall control program for APPC connections

      567
    • Recovery and restart

      567
  • The autoinstall control program at INSTALL

    567
    • The communication area at INSTALL for APPC connections

      567
  • The autoinstall control program at DELETE

    571
    • When autoinstalled APPC connections are deleted

      571
      • Single-session connections installed via a CINIT

        571
      • Synclevel 1 connections installed via a BIND

        572
      • Synclevel 2 connections installed via a BIND

        572
  • The sample autoinstall control program for APPC connections

    572
    • Default actions of the sample program

      572
    • Resource definitions

      573
• Chapter 13. Writing a program to control autoinstall of IPIC connections

  575
  • Autoinstalling IPIC connections: preliminary considerations

    575
  • The autoinstall user program at INSTALL

    577
  • The autoinstall user program at DELETE

    578
    • When autoinstalled IPCONNs are deleted

      579
  • The sample autoinstall user program for IPIC connections (IPCONN)

    579
    • Default actions of the sample program

      580
    • Resource definitions

      580
• Chapter 14. Writing a program to control autoinstall of shipped terminals

  581
  • Installing shipped terminals and connections

    581
    • CICS-generated aliases

      582
    • Resetting the terminal identifier

      582
      • Example

        583
  • The autoinstall control program at INSTALL

    583
    • The communications area at INSTALL for shipped terminals

      584
  • The autoinstall control program at DELETE

    586
  • Default actions of the sample programs

    587
• Chapter 15. Writing a program to control autoinstall of virtual terminals

  589
  • How Client virtual terminals are autoinstalled

    589
    • Autoinstall models

      589
    • Terminal identifiers

      589
    • Why override TERMIDs?

      590
      • Overriding CICS-generated TERMIDs

        590
      • Overriding Client-specified TERMIDs

        591
  • How bridge facility virtual terminals are autoinstalled

    592
    • Using the terminal autoinstall control program for bridge facilities

      592
      • Autoinstall of a START bridge facility

        592
      • Autoinstall of a Link3270 bridge facility

        593
    • Bridge facility name uniqueness

      593
  • The autoinstall control program at INSTALL

    593
    • The communications area at INSTALL for Client virtual terminals

      593
    • The communications area at INSTALL for bridge facility virtual terminals

      595
  • The autoinstall control program at DELETE

    597
    • The communications area at DELETE for Client virtual terminals

      597
    • The communications area at DELETE for bridge facility virtual terminals

      598
  • Default actions of the sample programs

    599
• Chapter 16. Writing a program to control autoinstall of programs

  601
  • Autoinstalling programs—preliminary considerations

    601
    • Autoinstall model definitions

      602
    • Autoinstalling programs invoked by EXEC CICS LINK commands

      602
    • Autoinstall processing of mapsets

      603
    • System autoinstall

      603
  • Benefits of autoinstalling programs

    603
    • Reduced system administration costs

      603
    • Saving in virtual storage

      603
    • Faster startup times

      604
      • Warm and emergency starts

        604
      • Initial and cold starts

        604
  • Requirements for program autoinstall

    604
  • The autoinstall control program at INSTALL

    605
  • The sample autoinstall control program for programs, DFHPGADX

    608
    • Customizing the sample program

      608
    • Resource definition

      609
    • Testing and debugging your program

      610
• Chapter 17. Writing a dynamic routing program

  611
  • Routing transactions dynamically

    612
    • Dynamic transactions

      612
    • When the dynamic routing program is invoked

      612
    • Information passed to the dynamic routing program

      613
    • Changing the target CICS region

      614
      • Using a common transaction definition in the TOR

        614
    • Changing the program name

      615
    • Telling CICS whether to route or terminate a transaction

      615
    • If the system is unavailable or unknown

      616
    • Invoking the dynamic routing program at end of routed transactions

      616
    • Invoking the dynamic routing program on abend

      616
    • Modifying the initial terminal data

      617
    • Modifying the application’s communications area

      617
    • Receiving information from a routed transaction

      618
      • Monitoring the output communications area

        618
      • Monitoring the output TIOA

        618
    • Some processing considerations

      618
    • Unit of work considerations

      619
  • Routing DPL requests dynamically

    619
    • When the dynamic routing program is invoked

      620
    • Changing the target CICS region

      621
    • Changing the program name

      621
    • Changing the transaction ID

      622
    • Telling CICS whether to route or terminate a DPL request

      622
    • If an error occurs in route selection

      622
    • Using the XPCERES exit to check the availability of resources on the target region

      623
    • Invoking the dynamic routing program at end of routed requests

      624
    • Modifying the application’s input communications area

      624
    • Monitoring the application’s output communications area

      624
    • Some processing considerations

      624
    • Unit of work considerations

      625
  • Routing bridge requests dynamically

    625
    • Changing bridge request parameters

      626
      • Changing the Link3270 bridge request SYSID

        626
      • Changing the bridge request TRANSID

        627
      • Changing the Link3270 bridge request transaction priority

        627
    • Rejecting a Link3270 bridge request

      627
    • Handling route selection errors of Link3270 bridge requests

      627
    • Using the XPCERES exit to check the availability of resources on the target region

      627
    • Re-invoking the dynamic routing program after Link3270 bridge requests

      628
    • Link3270 bridge dynamic routing considerations

      628
  • Modifying the application’s containers

    629
  • Routing by user ID

    629
  • Parameters passed to the dynamic routing program

    629
  • Naming your dynamic routing program

    643
  • Testing your dynamic routing program

    643
  • Dynamic transaction routing sample programs

    644
• Chapter 18. Writing a distributed routing program

  645
  • Differences between the distributed and dynamic routing interfaces

    646
  • Routing BTS activities

    647
    • Which BTS activities can be dynamically routed?

      647
    • When the distributed routing program is invoked

      648
    • Changing the target CICS region

      649
    • Telling CICS whether to route the activity

      649
    • If an error occurs in route selection

      650
    • Invoking the distributed routing program on the target region

      650
  • Routing method requests for enterprise beans and CORBA stateless objects

    651
    • Where workload balancing occurs

      651
      • Local and remote clients

        652
    • Which requests can be dynamically routed?

      653
    • When the distributed routing program is invoked

      654
    • Changing the target CICS region

      655
    • Telling CICS whether to route the method request

      656
    • If an error occurs in route selection

      656
    • Invoking the distributed routing program on the target region

      656
    • Dealing with a disabled CorbaServer

      657
    • Performing a rolling upgrade of an EJB/CORBA server

      659
  • Routing non-terminal-related START requests

    659
    • Which requests can be dynamically routed?

      659
    • When the distributed routing program is invoked

      660
    • Changing the target CICS region

      661
    • Telling CICS whether to route the request

      661
    • If an error occurs in route selection

      662
    • Using the XICERES exit to check the availability of resources on the target region

      662
    • Invoking the distributed routing program on the target region

      663
  • Routing inbound Web service requests

    663
    • Which requests can be dynamically routed?

      663
    • When the distributed routing program is invoked

      664
    • Changing the target CICS region

      665
    • Telling CICS whether to route the request

      665
    • If an error occurs in route selection

      666
    • Invoking the distributed routing program on the target region

      666
  • Routing by user ID

    666
  • Dealing with an abend on the target region

    666
  • Some processing considerations

    667
  • Parameters passed to the distributed routing program

    667
  • Naming your distributed routing program

    678
  • Distributed transaction routing sample programs

    679
• Chapter 19. Writing a CICS–DBCTL interface status program

  681
  • The sample CICS–DBCTL interface status program

    682
• Chapter 20. Writing a 3270 bridge exit program

  683
• Chapter 21. Writing a security exit program for IIOP

  685
  • The sample programs

    687
    • DFHXOPUS

      687
    • DFHEBURM

      688
• Chapter 22. Writing programs to customize JVMs

  689
  • Writing Java classes to redirect JVM stdout and stderr output

    689
    • The com.ibm.cics.server.OutputRedirectionPlugin interface

      690
    • Possible destinations for output

      691
    • Handling output redirection errors and internal errors

      691
  • Using DFHJVMRO to modify the Language Environment enclave for a JVM

    692
  • Using DFHJVMAT to modify options in a JVM profile

    693
    • Options in the JVM profile that are available to DFHJVMAT

      694
• Chapter 23. Writing a distinguished name program for clients of enterprise beans

  697
  • Sample programs and copy books

    699
• Chapter 24. Writing an EJB event program

  701
  • Overview of the EJB event program

    701
  • The DFHEJEP communications area

    702
  • Event codes

    703
  • The EJB event sample program

    704
    • Actions of the default program

      704
    • Writing your own EJB event program

      704
• Chapter 25. Writing programs to customize Language Environment run-time options for XPLink programs

  707
  • DFHAPXPO

    707
    • Defining run-time options

      707
• Part 4. Customizing the XRF overseer program

  709
• Chapter 26. The extended recovery facility overseer program

  711
  • The sample XRF overseer program

    711
    • The functions of the sample program

      711
      • The display function

        712
      • The restart-in-place function

        713
      • Opening CAVM data sets dynamically

        714
    • How the sample overseer program interfaces with CICS

      715
    • How to tell the overseer which actives and alternates to monitor

      715
  • The DFHWOSM macros

    717
    • The DFHWOSM tokens

      717
    • DFHWOSM FUNC=BUILD macro

      718
    • DFHWOSM FUNC=CLOSE macro

      718
    • DFHWOSM FUNC=DSECT macro

      719
    • DFHWOSM FUNC=JJC macro

      719
    • DFHWOSM FUNC={JJS|QJJS} macro

      719
    • DFHWOSM FUNC=OPEN macro

      720
    • DFHWOSM FUNC=OSCMD macro

      721
    • DFHWOSM FUNC=READ macro

      721
      • Reading DBCTL status information from the CAVM data sets

        724
    • DFHWOSM FUNC=TERM macro

      725
  • Customizing the sample XRF overseer program

    725
    • Loop or wait detection

      727
    • Assembling and link-editing the overseer program

      727
• Part 5. CICS journaling, monitoring, and statistics

  729
• Chapter 27. CICS logging and journaling

  731
  • The CICS log manager

    731
  • Log stream storage

    731
  • Enabling, disabling, and reading journals

    733
    • Enabling and disabling a journal

      733
    • Reading journal records offline

      734
  • Structure and content of CICS Transaction Server for z/OS format journal records

    734
    • Format of general log block header

      735
    • Format of general log journal record

      736
    • Start-of-run record

      738
    • Format of caller data

      738
      • Caller data written by file control

        739
      • Read-only, read-update, write-update, write-add, write-add complete record types

        740
      • Write-delete record types

        743
      • File-close record types

        744
      • Tie-up record types

        746
      • Terminal control prefix data

        748
      • FEPI prefix data

        749
  • Structure and content of COMPAT41-format journal records

    751
    • Format of COMPAT41 journal control label header

      751
    • Format of journal record

      753
    • Identifying records for the start of tasks and UOWs

      759
  • Format of journal records written to SMF

    759
    • The SMF block header

      760
    • The CICS product section

      762
    • The CICS data section

      764
• Chapter 28. CICS monitoring

  765
  • Introduction to CICS monitoring

    765
    • How CICS monitoring data is passed to SMF

      765
    • Coding additional event-monitoring points

      766
    • Application naming event monitoring points

      766
      • Examples of invoking application naming EMPs

        767
    • The monitoring control table (MCT)

      769
      • DFHMCT TYPE=EMP

        770
      • DFHMCT TYPE=RECORD

        770
      • Examples of MCT coding with MONITOR commands

        770
      • DFHMCT TYPE=EMP entries for DBCTL

        771
  • CICS monitoring record formats

    772
    • SMF header and SMF product section

      772
    • CICS data section

      776
      • Dictionary data sections

        776
      • Performance data sections

        783
      • Relationship of the dictionary record to the performance records: field connectors

        784
      • Exception data sections

        786
      • Transaction resource data sections

        787
• Chapter 29. Writing statistics collection and analysis programs

  791
  • Writing a program to collect CICS statistics

    791
    • Background information

      791
    • Resetting statistics counters

      792
    • Using the EXEC CICS COLLECT and EXTRACT STATISTICS commands

      792
  • CICS statistics record format

    793
    • SMF header and SMF product section

      793
    • CICS statistics data section

      795
  • Using an XSTOUT global user exit program to filter statistics records

    798
  • Processing the output from CICS statistics

    799
• Part 6. Customizing CICS compatibility interfaces

  801
• Chapter 30. The dynamic allocation sample program

  803
  • Overview of the dynamic allocation program

    803
  • Installing the program and transaction definitions

    804
  • The dynamic allocation program—terminal operation

    804
  • Using the dynamic allocation program’s Help feature

    804
  • The dynamic allocation program—values

    805
    • Abbreviation rules for keywords

      806
    • System programming considerations

      806
  • The flow of control when a DYNALLOC request is issued

    806
• Part 7. Customizing CICS security processing

  809
• Chapter 31. Invoking an external security manager

  811
  • An overview of the CICS-ESM interface

    811
  • The MVS router

    811
    • The MVS router exit

      811
      • The MVS router parameter list

        812
      • Router exit return codes

        812
      • Passing control to a user-supplied ESM

        813
  • Using ESM exit programs to access CICS-related information

    813
    • For non-RACF users — the ESM parameter list

      814
    • For RACF users — the RACF user exit parameter list

      814
    • The installation data parameter list

      815
  • CICS security control points

    818
  • Using early verification processing

    819
    • Writing an early verification routine

      820
    • Using CICS API commands in an early verification routine

      821
    • Return and reason codes from the early verification routine

      821
• Chapter 32. Writing a “good night” program

  823
  • The communications area of the “good night” program

    823
  • The sample “good night” program, DFH0GNIT

    825
    • What the sample program does

      825
  • Customizing the sample “good night” program

    826
• Part 8. Examining and modifying resource attributes

  829
• Chapter 33. Using the programmable interface to CEDA

  831
  • When to use the programmable interface

    832
  • Using DFHEDAP in a DTP environment

    832
• Chapter 34. User programs for the system definition utility program (DFHCSDUP)

  835
  • An overview of DFHCSDUP

    835
  • Invoking a user program from DFHCSDUP

    836
    • Writing a program to be invoked during EXTRACT processing

      836
    • The EXTRACT command

      836
    • When the user program is invoked

      837
    • Parameters passed from DFHCSDUP to the user program

      837
    • The sample EXTRACT programs

      838
      • The CSD cross-referencing program

        840
      • The DB2 formatting program

        840
      • The CSD backup utility program

        840
    • Assembling and link-editing EXTRACT programs

      841
      • An assembler-language version

        842
      • A Language Environment version

        842
  • Invoking DFHCSDUP from a user program

    843
    • Entry parameters for DFHCSDUP

      844
    • Responsibilities of the user program

      846
  • The user exit points in DFHCSDUP

    846
    • Parameters passed to the user exit routines

      846
    • The initialization exit

      847
    • The get-command exit

      847
    • The extract exit

      848
    • The put-message exit

      849
    • The termination exit

      850
  • The sample program, DFH$CUS1

    851
• Part 9. Appendixes

  853
• Appendix A. Coding entries in the VTAM LOGON mode table

  855
  • Overview of the VTAM LOGON mode table

    855
  • TYPETERM device types and pointers to related LOGON mode data

    855
  • VTAM MODEENT macro operands

    857
  • PSERVIC screen size values for LUTYPEx devices

    862
  • Matching models and LOGON mode entries

    863
  • LOGON mode definitions for CICS-supplied autoinstall models

    872
• Appendix B. Default actions of the node abnormal condition program

  877
  • DFHZNAC—default actions for terminal error codes

    877
  • CICS messages associated with VTAM errors

    883
  • DFHZNAC—default actions for system sense codes

    888
  • Action flag settings and meanings

    890
• Appendix C. Analyzing CICS restart information

  893
• Appendix D. Using the transient data write-to-terminal program (DFH$TDWT)

  895
  • DFH$TDWT—resource definitions required

    895
• Appendix E. Uppercase translation

  897
  • Translating national characters to uppercase

    897
    • Using the XZCIN exit

      897
    • Using DFHTCTxx

      897
  • Translating TS data sharing messages to uppercase

    898
• Appendix F. The example program for the XTSEREQ global user exit, DFH$XTSE

  899
• Appendix G. Threadsafe XPI commands

  915
• Bibliography

  917
  • The CICS Transaction Server for z/OS library

    917
    • The entitlement set

      917
    • PDF-only books

      917
      • CICS books for CICS Transaction Server for z/OS

        917
      • CICSPlex SM books for CICS Transaction Server for z/OS

        918
      • CICS family books

        919
      • Licensed publications

        919
  • Other CICS books

    919
  • Books from related libraries

    919
    • MVS books

      919
    • VTAM books

      920
    • Other related books

      920
  • Determining if a publication is current

    920
• Accessibility

  923
• Index

  925
  • Special characters

    925
  • Numerics

    925
  • A

    925
  • B

    926
  • C

    926
  • D

    927
  • E

    931
  • F

    931
  • G

    932
  • I

    933
  • J

    933
  • K

    933
  • L

    933
  • M

    934
  • N

    934
  • O

    936
  • P

    936
  • Q

    936
  • R

    936
  • S

    937
  • T

    938
  • U

    940
  • V

    941
  • W

    941
  • X

    941
• Notices

  945
• Trademarks

  947
• Readers’ Comments — We'd Like to Hear from You

  949