CICS Administration Reference

WebSphere Application Server Enterprise Edition TXSeries
CICS Administration Reference

V ersion 3.0
SC09-4459-00
WebSphere Application Server Enterprise Edition TXSeries

V ersion 3.0
SC09-4459-00
Note Before using this information and the product it supports, be sure to read the general information under Notices on page 533.
First Edition (June 1999) This edition applies to: VisualAge Component Development for WebSphere Application Server Version 3.0, Enterprise Edition for AIX, program number 5765E27 VisualAge Component Development for WebSphere Application Server Version 3.0, Enterprise Edition for Windows NT, program number 5639I07 WebSphere Application Server Version 3.0, Enterprise Edition for AIX, program number 5765E28 WebSphere Application Server Version 3.0, Enterprise Edition for Solaris, program number 5765E29 WebSphere Application Server Version 3.0, Enterprise Edition for Windows NT, program number 5639I09 WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for Windows NT, program number 5639I11 WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for AIX, program number 5765E31 WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for Solaris, program number 5765E30 and to all subsequent versions, releases, and modications until otherwise indicated in new editions. Consult the latest edition of the applicable system bibliography for current information on these products. Order publications through your IBM representative or through the IBM branch office serving your locality. Copyright International Business Machines Corporation 1999. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
Figures . Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii ix cicscp - region commands . . . . . . . cicscp - SFS commands. . . . . . . . cicscp - SNA commands . . . . . . . cicscp - SNA link commands . . . . . . cicscp - telnet server commands . . . . . cicscvt - Create data conversion table . . . cicsdb2conf - Congure DB2 . . . . . . cicsdb2import - Build metadata for DB2 cicsddt - DB2 diagnostic tool . . . . . . cicsdefault - Create a copy of the default region . . . . . . . . . . . . . cicsdefaultservers - Create default resource les for servers . . . . . . . . . . cicsdelete - Delete CICS resource denitions cicsdestroy - Destroy a CICS region . . . cicsdfmt - Dump formatter . . . . . . cicsexport - Export CICS resource denitions . . . . . . . . . . . . cicsget - Get CICS resource denition information . . . . . . . . . . . cicsgetbindingstring - Get binding string for region or Encina server. . . . . . . . cicsgpid - Get region process identier . . cicshpterm - 3270 terminal emulator . . . cicsimport - Import CICS resource denitions . . . . . . . . . . . . cicsinstall - Install CICS resource denitions cicsivp - Set up resource denitions for installation verication . . . . . . . . cicslssrc - Check subsystem status . . . . cicslterm - Invoke the local CICS client 3270 terminal emulator . . . . . . . . . cicsmakelv - Create a logical volume . . . cicsmfmt - Monitoring data formatter . . . cicsmigrate - Create migration script . . . cicsmigrateclass - Add and delete resource attributes . . . . . . . . . . . . cicsmigrateclients - Recongure DCE . . . cicsmkcobol - Create the cicsprCOBOL le cicsnotify - Deallocate resources . . . . . cicsppcgwy - Start a PPC Gateway server cicsppcgwycreate - Create a PPC Gateway server server . . . . . . . . . . . cicsppcgwydestroy - Destroy a PPC Gateway server . . . . . . . . . . 109 113 117 119 121 124 126 129 131 142 144 145 148 150 153 156 159 161 162 166 169 171 173 175 178 179 181 184 186 187 190 191 193 195
About this book . . . . . Who should read this book . Document organization . . Conventions used in this book How to send your comments.
. xi . xi . xi . xii . xiii . . . . . . . . . . . . . . . . . . . . 1 1 1 1 8 12 14 16 19 21 24 25 27 32 54 57 61 64 66 73 81 85
Chapter 1. Resource denitions . . . Restrictions on the use of characters . . Shorthand notation for resource denitions Communications Denitions (CD) . . . File Denitions (FD). . . . . . . . Gateway Denitions (GD) . . . . . . Gateway Server Denitions (GSD) . . . Journal Denitions (JD) . . . . . . Listener Denitions (LD) . . . . . . Monitoring Denitions (MD) . . . . . Object denitions (OD). . . . . . . Product Denitions (XAD) . . . . . Program Denitions (PD) . . . . . . Region Denitions (RD) . . . . . . Region Denitions (RD) for le server. . Schema File Denitions (SCD) . . . . Structured File Server Denitions (SSD) Temporary Storage Denitions (TSD) . . Terminal Denitions (WD) . . . . . Transaction Denitions (TD) . . . . . Transient Data Denitions (TDD) . . . User Denitions (UD) . . . . . . . Chapter 2. Resource denition commands and offline utilities . . About the CICS commands . . . . cicsadd - Add CICS resource denitions cicscleandce - Remove DCE groups and CDS directories . . . . . . . . cicscopystanza command . . . . . cicscp - CICS control program . . . cicscp - all options . . . . . . . cicscp - COBOL commands . . . . cicscp - DCE commands . . . . . cicscp - PPC Gateway server commands
Copyright IBM Corp. 1999
. .
. .
89 89 91
. . . . . .
. 94 . 96 . 97 . 100 . 101 . 102 105
iii
cicsppcgwylock - Lock or unlock a PPC Gateway server . . . . . . . . . . cicsppcgwyshut - Shut down a PPC Gateway server . . . . . . . . . . cicsremovelv - Remove a logical volume cicsrlck - Remove old region lock les. . . cicssdt - SFS diagnostic tool . . . . . . cicssetupclients - Congure DCE for the CICS clients . . . . . . . . . . . cicssetupdce - Create directories and groups within a DCE cell . . . . . . . . . cicssfmt - Statistics formatter . . . . . . cicssfs - Start a CICS SFS . . . . . . . cicssfsconf - Congure a CICS SFS . . . . cicssfscreate - Create a CICS SFS . . . . cicssfsdestroy - Destroy a CICS SFS . . . cicssfsimport - Build an SFSs metadata cicssfslock - Release an SFS lock le . . . cicssfsshut - Shut Down a CICS SFS . . . cicsstart - Start a CICS region . . . . . cicsstop - Stop a CICS region. . . . . . cicstail - Display the end of a le . . . . cicstcpnetname - Display NETNAME for CICS family TCP/IP connection . . . . . cicsteld - Connect telnet clients to regions cicsterm - Invoke the CICS 3270 terminal emulator . . . . . . . . . . . . cicstermp - Printer emulation. . . . . . cicstfmt - Trace formatter . . . . . . . cicstracelter - Trace lter . . . . . . . cicsupdate - Modify CICS resource denitions . . . . . . . . . . . . cicsupdateclass command . . . . . . . cicsusedceservers - Migrate CICS regions and Encina servers to use DCE . . . . . Chapter 3. CICS-supplied transactions Overview of the CICS-supplied transactions How to invoke the CICS-supplied transactions . . . . . . . . . . . Syntax notation used in the descriptions Minimum abbreviation of keywords Default security settings . . . . . . Complete list of CICS-supplied transactions Interface descriptions for the CICS-supplied transactions . . . . . . . . . . . CALF (Data Conversion) . . . . . . . CDCN (Application Diagnosis Conguration) (CICS for AIX) . . . . . CEBR (Temporary Storage Browse) . . . .
197 199 200 201 203 216 218 221 225 228 230 233 235 237 238 240 242 243 245 247 251 255 258 261 263 267 270 273 273 274 275 276 277 278 279 281 287 292
CECI (Command Level Interpreter) and CECS (Syntax Checker) . . . . . . CEDF (Execution Diagnostic Facility) . . CEMT (Runtime Resource Management) An overview of the CEMT parameters How to invoke CEMT . . . . . . Using the CEMT screen . . . . . Concepts of Inquire and Set Operations CEMT PERFORM SNAP . . . . . CEMT INQ/SET AUTOINSTALL . . CEMT INQ/SET AUXTRACE . . . CEMT INQ/SET DUMP . . . . . CEMT INQ/SET DUMPOPTIONS . . CEMT INQ/SET FILE . . . . . . CEMT INQ/SET JOURNAL . . . . CEMT INQ/SET MONITOR . . . . CEMT INQ/SET NETNAME . . . . CEMT INQ/SET PROGRAM . . . . CEMT INQ/SET TASK . . . . . . CEMT INQ/SET TCLASS . . . . . CEMT INQ/SET TDQUEUE . . . . CEMT INQ SET TERMINAL . . . . CEMT INQ/SET TRACE . . . . . CEMT INQ/SET TRANSACTION . . Inquiring upon CICS system parameters using CEMT . . . . . . . . . CESF (Signoff) and CSSF (Signoff) . . . CESN (Signon) . . . . . . . . . CMLV (Console Message Log Viewer). . CRTE (Routing Transaction) . . . . . CSTD (Statistics) . . . . . . . . . Chapter 4. Operator control of FEPI . CEMTmaster terminal transaction . CEMT DISCARD. . . . . . . . CEMT INQUIRE FECONNECTION . CEMT INQUIRE FENODE . . . . CEMT INQUIRE FEPOOL. . . . . CEMT INQUIRE FEPROPSET . . . CEMT INQUIRE FETARGET . . . . . . . . . . . .
. 298 . 309 321 321 . 323 . 324 328 . 330 . 331 . 332 . 333 . 334 . 335 . 338 . 339 . 340 . 342 . 344 . 347 . 348 . 351 . 353 . 354 . . . . . . . . . . . . . . 355 357 359 362 364 367 369 369 370 371 377 381 384 386 389 390 390 390 393 394 395
Chapter 5. CICS-supplied programs . . . Terminal autoinstall user program . . . . Terminal model denition . . . . . . The supplied terminal autoinstall program. . . . . . . . . . . . Terminal autoinstall program parameters When the terminal autoinstall program is accessed. . . . . . . . . . . . External Security Manager user program
iv
WebSphere: CICS Administration Reference
Performance monitoring user program . Setting up CICS to call performance monitoring . . . . . . . . . . The Supplied Performance Monitoring User Program . . . . . . . . . Performance monitoring user program parameters . . . . . . . . . . When the performance monitoring program is accessed . . . . . . . Chapter 6. User exits . . . . . . Standard denitions and data types . Constants . . . . . . . . . Standard header structure . . . . Task termination user exit (UE014015). Function prototype . . . . . . Exit-specic constants . . . . . Exit-specic structure . . . . . Fields in exit-specic structure . . Return codes . . . . . . . . Dump request user exit (UE052017) . Function prototype . . . . . . Exit-specic constants . . . . . Exit-specic structure . . . . . Fields in exit-specic structure . . Return codes . . . . . . . . Dynamic transaction routing user exit (UE014025) . . . . . . . . . . Function Prototype . . . . . . Exit-specic constants . . . . . Exit-specic structure . . . . . Fields in exit-specic structure . . Return Codes . . . . . . . . Dynamic distributed program link user (UE015050) . . . . . . . . . . Function prototype . . . . . . Exit-specic constants . . . . . Exit-specic structure . . . . . Fields in exit-specic structure . . Return codes . . . . . . . . Syncpoint user exit (UE016051) . . . Function prototype . . . . . . Exit-specic constants . . . . . Exit-specic structure . . . . . Fields in exit-specic structure . . Return codes . . . . . . . . . . . . . . . . . . . . . . . .
. 395 . 395 . 396 . 400 . 406 . . . . . . . . . . . . . . . . 407 408 408 408 410 410 410 410 411 411 411 411 411 412 412 413 413 413 413 414 414 418 418 419 419 419 420 422 422 422 422 423 423 424
CICS_MFMT_OpenMonitorFile and CICS_MFMT_CloseMonitorFile . . Return codes . . . . . . . CICS_MFMT_ReadNext . . . . Return codes . . . . . . . CICS_MFMT_FindField . . . . Return codes . . . . . . . CICS_MFMT_GetMessage, CICS_MFMT_FreeMessage, and CICS_MFMT_ReleaseCatalogue . . Return codes . . . . . . . Statistics formatter functions . . . CICS_SFMT_OpenStatsFile and CICS_SFMT_CloseStatsFile . . . Return codes . . . . . . . CICS_SFMT_FindRecord . . . . Return codes . . . . . . . CICS_SFMT_ReadRecord . . . . Return codes . . . . . . . CICS_SFMT_Msg2Int . . . . . Return codes . . . . . . .
. . . . . .
. . . . . .
. . . . . .
426 426 427 427 428 428
. . . . . . . . . . .
. . . . . . . . . . .
. 428 . 429 . 429 . . . . . . . . . . . . . . . . . . . . . . . 430 430 431 431 431 432 432 432 433 433 434 441 442 445 454 457 458 459 464 473 476 480 483 485
. . . . . . . . . . . . exit . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 8. The statistics records . . . About the statistics records . . . . . General statistics . . . . . . . . . Dump statistics . . . . . . . . . File statistics . . . . . . . . . . Intersystem communication (ISC) statistics Journal statistics . . . . . . . . . Logical unit of work (LUW) statistics . . Program statistics . . . . . . . . Runtime database statistics . . . . . Storage statistics . . . . . . . . . Task statistics . . . . . . . . . . Terminal statistics . . . . . . . . Transient data statistics. . . . . . . Transaction statistics . . . . . . . Temporary storage statistics . . . . .
Chapter 9. Environment variables used by CICS . . . . . . . . . . . . 491 CICS and Encina Environment Variables 491 Environment variables for Micro Focus COBOL and Net Express compiler options 498 Chapter 10. Terminal model denitions Chapter 11. Index of CICS resource attributes . . . . . . . . . . 501
Chapter 7. The CICS monitoring data formatter offline utilities . . . . . . Monitoring data formatter functions . .
. 425 . 425
. 507
Contents
Bibliography . Notices . . .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. 531 . 533
Trademarks and service marks . Index . . . . . . . . .
. .
. .
. .
. 535 . 539
vi
Figures
1. 2. 3. CEMT INQ . . . . . . . . . CEMT status screen . . . . . . CEMT INQUIRE FECONNECTION screen . . . . . . . . . . . . 324 . 329 . 372 4. 5. 6. 7. CEMT CEMT CEMT CEMT INQUIRE INQUIRE INQUIRE INQUIRE FENODE screen FEPOOL screen FEPROPSET screen FETARGET screen 378 382 384 387
vii
viii
Tables
1. Road map for the CICS Administration Reference book . . . . . . . . . 2. Conventions used in this book 3. Monitoring data formatter les 4. Statistics data formatter les . . . . 5. Shortcode and code pages (Open Systems) . . . . . . . . . . . 6. Shortcode and code pages (Windows NT) . . . . . . . . . 7. Default security settings for the CICS-supplied transactions . . . . . 8. The CEMT extended parameters used with INQUIRE and SET . . . . . . 9. The CEMT extended parameters used with INQUIRE only . . . . . . . 10. Statistic categories. . . . . . . . 11. Statistic types . . . . . . . . . 12. Dump statistics. . . . . . . . . 13. File statistics . . . . . . . . . 14. ISC statistics . . . . . . . . . 15. Journal statistics . . . . . . . . 16. Logical unit of work statistics 17. Program statistics . . . . . . . . 18. Runtime database statistics . . . . . 19. Region pool statistics. . . . . . . 20. Task-shared pool statistics . . . . . 21. Task-private pool statistics . . . . . 22. Task statistics . . . . . . . . . 23. Terminal statistics . . . . . . . . 24. Transient data statistics . . . . . . 25. Transaction statistics . . . . . . . 26. Temporary storage statistics . . . . 27. CICS and Encina Environment Variables . . . . . . . . . . . 28. Environment variables for Micro Focus COBOL compiler options . . . . . xi xii 180 221 249 249 277 321 322 434 438 441 442 446 454 458 459 459 464 466 471 473 477 481 483 485 491 498 29. Road map for terminal model denitions . . . . . . . . . . 30. Terminal Denition attributes for autoinstall models MDCL, MDCI, MD01, MD02, MD03, MD04, MD05 and MD06 . . . . . . . . . . 31. Terminal Denition attributes for autoinstall models MD07, MD08, MD09, MD10, MD11, MD12, MD13 and MD14 . . . . . . . . . . 32. Terminal Denition attributes for autoinstall models MD15, MD16, MD17, MD18, MD19, MD20, MD21 and MD22 . . . . . . . . . . 33. Terminal Denition attributes for autoinstall models MD23, MD24, MD25, MD26, MD27 and MD28 . . . 34. Communications Denitions (CD) 35. File Denitions (FD) . . . . . . . 36. Gateway Denitions (GD) . . . . . 37. Gateway Server Denitions (GSD) 38. Journal Denitions (JD) . . . . . . 39. Listener Denitions (LD) . . . . . 40. Monitoring Denitions (MD) . . . . 41. Product Denitions (XAD) . . . . . 42. Program Denitions (PD) . . . . . 43. Region Denitions (RD) . . . . . . 44. Schema File Denitions (SCD) 45. Structured File Server Denitions (SSD) 46. Temporary Storage Denitions (TSD) 47. Terminal Denitions (WD) . . . . . 48. Transaction Denitions (TD) . . . . 49. Transient Data Denitions (TDD) 50. User Denitions (UD) . . . . . . 51. Alphabetic cross-reference of attribute names to attribute descriptions . . . 501
502
502
503
504 507 507 508 508 509 509 509 510 510 510 513 514 515 515 516 517 517 518
ix
About this book

This book contains the reference material required to administer a CICS system. It should be used in conjunction with the CICS Administration Guide.
Who should read this book

This book will be used by system administrators of CICS systems to nd details of commands and denitions. As this book is mostly reference material with little text to guide you on the use of commands and references, it is expected that you will have read the appropriate chapters in the CICS Administration Guidebefore attempting to use this book. The use you make of this book will depend on the tasks you have to perform. Once you have used the CICS Administration Guide to understand the nature of the task, you will use this book to nd the details of the commands, denitions, programs and transactions you need.
Document organization
The material in each reference chapter is organized alphabetically.
Table 1. Road map for the CICS Administration Reference book
If you want information about ... Resource attributes Resource denition commands and offline utilities CICS-supplied transactions CICS-supplied programs User exits Formatting functions for monitor and statistics data Statistics tables Environment variables used by CICS, Encina and the Micro Focus COBOL compiler Refer to ... Chapter 1. Resource denitions on page 1 Chapter 2. Resource denition commands and offline utilities on page 89 Chapter 3. CICS-supplied transactions on page 273 Chapter 5. CICS-supplied programs on page 389 Chapter 6. User exits on page 407 Chapter 7. The CICS monitoring data formatter offline utilities on page 425 Chapter 8. The statistics records on page 433 Chapter 9. Environment variables used by CICS on page 491
xi
Table 1. Road map for the CICS Administration Reference book (continued)
If you want information about ... Resource attribute name to description cross-reference The conventions used in this book. Refer to ... Chapter 11. Index of CICS resource attributes on page 507 xii.
Conventions used in this book

WebSphere Application Server Enterprise Edition documentation uses the following typographical and keying conventions.
Table 2. Conventions used in this book
Convention Bold Meaning Indicates values you must use literally, such as commands, functions, and resource denition attributes and their values. When referring to graphical user interfaces (GUIs), bold also indicates menus, menu items, labels, buttons, icons, and folders. Indicates text you must enter at a command prompt. Monospace also indicates screen text and code examples. Indicates variable values you must provide (for example, you supply the name of a le for leName). Italics also indicates emphasis and the titles of books. Enclose the names of keys on the keyboard. Where x is the name of a key, indicates a control-character sequence. For example, <Ctrl-c> means hold down the Ctrl key while you press the c key. Refers to the key labeled with the word Return, the word Enter, or the left arrow. Represents the UNIX command-shell prompt for a command that does not require root privileges. Represents the UNIX command-shell prompt for a command that requires root privileges. Represents the Windows NT command prompt. When used to describe a menu, shows a series of menu selections. For example, Select File > New means From the File menu, select the New command. When instructed to enter or issue a command, type the command and then press <Return>. For example, the instruction Enter the ls command means type ls at a command prompt and then press <Return>. Enclose optional items in syntax descriptions. Enclose lists from which you must choose an item in syntax descriptions.
Monospace Italics
<> <Ctrl-x> <Return> % # C:\> >
Entering commands
[] {}
xii
Table 2. Conventions used in this book (continued)

Convention | ... Meaning Separates items in a list of choices enclosed in { } (braces) in syntax descriptions. Ellipses in syntax descriptions indicate that you can repeat the preceding item one or more times. Ellipses in examples indicate that information was omitted from the example for the sake of brevity. In function descriptions, indicates parameters whose values are used to pass data to the function. These parameters are not used to return modied data to the calling routine. (Do not include the IN declaration in your code.) In function descriptions, indicates parameters whose values are used to return modied data to the calling routine. These parameters are not used to pass data to the function. (Do not include the OUT declaration in your code.) In function descriptions, indicates parameters whose values are passed to the function, modied by the function, and returned to the calling routine. These parameters serve as both IN and OUT parameters. (Do not include the INOUT declaration in your code.) Indicates the full pathname where the CICS product is installed; for example, C:\opt\cics on Windows NT or /opt/cics on Solaris. If the environment variable named CICS is set to the product pathname, you can use the examples exactly as shown; otherwise, you must replace all instances of $CICS with the CICS product pathname. Refers collectively to the CICS product for all supported UNIX platforms. Refers collectively to the CICS for AIX, CICS for Solaris, and CICS for Windows NT products. Refers generically to the CICS on Open Systems and CICS for Windows NT products. References to a specic version of a CICS on Open Systems product are used to highlight differences between CICS on Open Systems products. Other CICS products in the CICS Family are distinguished by their operating system (for example, CICS for OS/2 or IBM mainframe-based CICS for the ESA, MVS, and VSE platforms).
IN
OUT
INOUT
$CICS
CICS on Open Systems TXSeries CICS CICS
How to send your comments

Your feedback is important in helping to provide the most accurate and highest quality information. If you have any comments about this book or any other WebSphere Application Server Enterprise Edition documentation, send your comments by e-mail to waseedoc@us.ibm.com. Be sure to include the name of the book, the document number of the book, the version of WebSphere Application Server Enterprise Edition, and, if applicable, the specic location of the information you are commenting on (for example, a page number or table number).
About this book
xiii
xiv
Chapter 1. Resource denitions

Restrictions on the use of characters
Some of the resource denitions in this chapter have a <Key> eld. For these elds there are some restrictions on the use of metacharacters for names if you are using SMIT (CICS for AIX), or SAM (CICS for HP-UX), or a similar operating system facility, because these facilities cannot handle them. To specify a name containing a metacharacter, use the RDO command-line facility.
Shorthand notation for resource denitions

The following symbols can be used when specifying the value of resource attributes: %R or %r expands to the current region name. %H or %h expands to the current host name (the name of the machine on which CICS is running). %S or %s expands to the ShortName of the current le server, Structured File Server or Gateway Server, provided that the server is on the local machine. If the server is not on the local machine, the ShortName cannot be determined so %S cannot be resolved. CICS expands the shorthand notation when the resource denition is read from the permanent database. If you need to use a percent sign (%) as a literal, you must use two consecutive percent signs.
Communications Denitions (CD)

Communications Denitions (CD) dene the remote systems with which this region can communicate. The communication may use Transmission Control Protocol/Internet Protocol (TCP/IP) or Systems Network Architecture (SNA). The remote system could be: v another CICS system

v an Encina PPC application such as the Encina Monitor v a SNA Logical Unit (LU) type 6.2 system CD entries are also created dynamically (autoinstalled) when an IBM CICS Client attaches to the region or when a CICS family TCP/IP connection is acquired. <Key> This is the local name for a remote system with which the CICS region can communicate, and is the key of the CD. This is referred to as the SYSID by application programs. This key is not affected by National Language Support (NLS) and can be up to four characters, from the character set A-Z, 0-9, dollar ($), and at sign (@). For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at startup. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AllocateTimeout (Timeout on allocate (in seconds)) This attribute describes how many seconds a front end transaction waits for a backend transaction to be started over a communications link. The default value is 60. This attribute is applicable only to Encina PPC TCP/IP connections (ConnectionType=ppc_tcp) and to connections through a PPC gateway server (ConnectionType=ppc_gateway). AmendCounter (Number of updates) Reserved for CICS internal use. ConnectionType (Connection type) This attribute indicates the type of the connection to the remote system. The values local_sna and ppc_gateway are for connections across SNA networks. The values cics_tcp and ppc_tcp are for connections using TCP/IP. See the CICS Intercommunication Guide for more information on the types of connections supported by CICS. The default value is ppc_tcp.

DCECell (DCE cell name of remote system) This attribute species the ASCII text name of the cell in which the remote system is registered in the Cell Directory Service. The default value is /.:/. DefaultSNAModeName (Default modename for a SNA connection) If the ConnectionType is local_sna or ppc_gateway, set this attribute to the name of the SNA mode group that most of your intersystem requests use. This means that when an intersystem request is made on this connection by a transaction that does not specify an SNA modename in either the PROFILE option of the EXEC CICS ALLOCATE command or the SNAModeName attribute of the Transactions Denition (TD) entry, CICS requests the modename specied in DefaultSNAModeName. The default value of DefaultSNAModeName is , meaning that the modename used will depend on the conguration for your SNA product. See the CICS Intercommunication Guide for more information on conguring modenames. This attribute is ignored if the ConnectionType is cics_tcp or ppc_tcp. GatewayName (Gateway Denition (GD) entry name) This attribute species the name of the Gateway Denitions (GD) entry that describes the PPC gateway to be used for this connection. GatewayName is required only if ConnectionType=ppc_gateway. The default value is "". GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". InService (Set connection in service?) This attribute species whether or not CICS should allow intersystem requests to be sent to, or received from, the remote system. Set the attribute to no if communication with the remote system is not to be allowed initially. The connection can later be set in service using EXEC CICS SET CONNECTION.The default value is yes. LinkUserId (UserId for inbound requests) This attribute is used to identify a locally dened userid that can be associated with inbound requests. Other attributes that are used in conjunction with the LinkUserId attribute are: v The CD RemoteSysSecurity attribute.

v The RD DefaultUserId attribute, as well as the TSL and RSL keys dened in the UD entry for the userid specied with this attribute. If a link userid is not specied, the CD TSLKeyMask and RSLKeyMask attributes are used to determine authorization. Note: It is recommended that a UD entry is dened for the link userid specied with the LinkUserId attribute. See the CICS Intercommunication Guide for more information about how this attribute is used for intersystem requests. The default value is "". ListenerName (Listener Denition (LD) entry name) This attribute species the name of an LD entry that has attribute Protocol=TCP. The Internet Protocol (IP) address and port number specied by this LD entry will be used by the remote system to contact the local region. ListenerName is required only if ConnectionType=cics_tcp and, in this case, it must be specied even if the connection is only to be used for outbound requests. The default value is "". OutboundUserIds (Send userids on outbound requests?) Set this attribute to sent to send userids on outbound requests for this connection
not_sent to prevent userids from being sent on outbound requests for this connection sent_only_with_pswd to send the userid with its password. If the password is not available, do not send the userid. sent_maybe_with_pswd to send the userid with its password. If the password is not available, send the userid already-veried. The default value is sent. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no.

RemoteCodePageTR (Code page for transaction routing) This attribute species the code page for transaction routing data owing between your CICS system and the remote system. If this code page is different from your systems code page, CICS will convert transaction routing data between the local code page and the code page specied by RemoteCodePageTR when sending or receiving data. The code page specied in RemoteCodePageTR must be either the same as the local code page or one of the code pages that is able to convert to and from the local code page. On Open Systems platforms, you can use the operating system utility iconv. The default value for RemoteCodePageTR is:
System CICS for AIX CICS for Windows NT CICS for HP-UX CICS for Solaris Default ISO8859-1 IBM-850 ISO8859-1 ISO8859-1
See the CICS Intercommunication Guide for more information. RemoteLUName (Name of remote system) This attribute species the name of the remote system and the value required depends on the attribute ConnectionType. If ConnectionType=ppc_tcp , set RemoteLUName to the APPLID (region name) of the remote system. If ConnectionType=local_sna or ConnectionType=ppc_gateway, set RemoteLUName to the Logical Unit (LU) name of the remote system. If ConnectionType=cics_tcp , RemoteLUName to the APPLID of the remote system unless the remote system is CICS for OS/2 in which case set it to the NETNAME returnedcicstcpnetname command. The default value is "". RemoteNetworkName (SNA network name for the remote system) This attribute species the name of the network to which the remote system is attached. The name can be up to eight characters long. If the remote system is connected using SNA, the value of this attribute must be the SNA network name of the remote system. If the remote system is connected using TCP/IP, the value of this attribute must be the network name, if any, dened in the remote system. On CICS on Open Systems the network name of the system is specied in the attribute LocalNetworkName in the Region Denitions (RD).The default value is "". RemoteSysEncrypt (Transmission encryption level) This attribute species whether or not encryption is required, and, if

so, the type of encryption required. You can set this attribute to none, control, or alldata. The default value is none. Encryption is not currently supported. RemoteSysSecurity (Security level for inbound requests) This attribute species how CICS is to process security information, such as userids and passwords, received with an inbound request. It can have one of three values. v local means discard all security information received and assign the userid specied in the LinkUserId attribute to the request. (If LinkUserId= the userid from the Region Denition (RD) entry attribute DefaultUserId is used instead.) v verify means that only userids received with a valid password can be assigned to the inbound request. If the password is missing, or incorrect, or no userid was sent, then the userid specied by the RD entry attribute DefaultUserId is to be used. v trusted allows userids received with or without a password to be assigned to the request. If no userid is sent, the userid specied in the RD entry attribute DefaultUserId is to be used. Once the userid is assigned, the Transaction Security Level (TSL) and Resource Security Level (RSL) keys are calculated for the request. The request is given the keys that are specied in both the User Denition (UD) entry for the assigned userid and in the UD entry for the userid specied in the LinkUserId attribute. If the LinkUserId= then the keys from attributes RSLKeyMask and TSLKeyMask are used instead of the LinkUserId keys. The CICS Intercommunication Guide provides more information on when to use the different RemoteSysSecurity options and how it is affected by your network conguration. The default value for RemoteSysSecurity is local. RemoteTCPAddress (TCP address for the remote system) This attribute species the name or address of the network adapter for the remote system. It can be specied in one of the following forms: v The Internet Protocol (IP) address in dotted decimal notation. For example, 1.23.45.67. v The Internet Protocol (IP) address in dotted hexadecimal notation. For example 0x01.0x17.0x2D.0x43. v The host name dened in the Internet name service. For example aix5.cicsland.com. This host name must refer to only one IP address. The RemoteTCPAddress is required only if ConnectionType=cics_tcp. The default value is "".

RemoteTCPPort (TCP port number for the remote system) This attribute species the number of the Transmission Control Protocol/Internet Protocol (TCP/IP) port on which the remote system is listening for requests. RemoteTCPPort is required only if ConnectionType=cics_tcp. The default value is 1435, the port registered for CICS with the Internet Assigned Number Authority (IANA). ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Communications Denition. RSLKeyMask (Resource Security Level (RSL) Key Mask) This attribute contains the list of resource link security keys that CICS uses to control access to resources from transactions. These keys are only used when a LinkUserId is not specied, as described in the CICS Intercommunication Guide. You can specify up to 24 keys, each in the range 1 through 24 and separated by the | character. The following example shows that resources with the RSLKeys 1, 2, 8, and 23 can be accessed: 1|2|8|23 Alternatively, you can specify the value all, which allows access to all the transactions. CICS takes the values that are common to the RSLKeyMask and the RSLKeylist attribute dened in the User Denitions (UD) entry for the user. The result of this operation species the actual resource security keys employed for validation. Note: You should be aware of the implications of resources marked as either public or private. With public, any user may access the resource. With private, CICS only allows access to the resource from transactions which have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. For further information, see the CICS Administration Guide. The CICS Intercommunication Guide also contains more information about how this attribute is used for intersystem requests. The default value for RSLKeyMask is none, which gives access to public transactions. SNAConnectName (SNA prole describing the remote system) This attribute is used only for SNA connections. It species the name of the partner LU alias dened in your SNA product and is required

only if the partner LU alias is different from the LU name of the remote system. Do not code this eld if the partner LU alias is the same as the RemoteLUName. See the CICS Intercommunication Guide for the different requirements of each operating system. The default value is "". TSLKeyMask (Transaction Security Level (TSL) Key Mask) This attribute contains the list of transaction link security keys that CICS uses to control access to transactions. These keys are only used when a LinkUserId is not specied, as described in the CICS Intercommunication Guide. You can specify up to 64 keys, each in the range 1 through 64 and separated by the | character. The following example shows that transactions with the TSLKeys 1, 5, 13, and 52 can be accessed: 1|5|13|52 Alternatively, you can specify the value all, which allows access to all the transactions. CICS takes the values that are common to the TSLKeyMask and the TSLKeyList attribute dened in the UD entry for the user. The result of this operation species the actual transaction security keys employed for validation. Read the CICS Intercommunication Guide for more information about how this attribute is used for intersystem requests and for further information about transaction security. The default value for TSLKeyMask is none.
File Denitions (FD)

File Denitions (FD) identify and describe les available for use by CICS application programs and CICS itself (for example, for monitoring) in this CICS region. <Key> This represents a unique name that identies the le to CICS, and is the key for the FD entry. Filenames are not supported by National Language Support (NLS) and can be up to eight characters, taken from the ASCII characters listed here. For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. For les, CICS allows ASCII characters from exclamation (!) to tilde (), (33 to 126 decimal).
File Denitions (FD)

Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AddOpt (Add access status) This attribute denes whether or not add operations are allowed on the le. The possible settings are: addable and notaddable. The default value is addable. AmendCounter (Number of updates) Reserved for CICS internal use. BaseName (Server lename) This ASCII text attribute species the name of the le as known by the le server. You should set this only for a local le. The default value is "". BrowseOpt (Browse access status) This attribute denes whether or not browse operations are allowed on the le. The possible settings are browsable and notbrowsable. The default value is browsable. DeleteOpt (Delete access status) This attribute denes whether or not delete operations are allowed on the le. The possible settings are deletable and notdeletable. The default value is deletable. EmptyOpt (Empty status for rst le open) This attribute denes whether or not CICS must empty the le when it is opened. The possible settings are empty and do_not_empty. The default value is do_not_empty. EnableStatus (File enable status) This attribute denes whether the le is enabled, disabled, unenabled, or in the process of being disabled. The possible settings are enabled, disabled, unenabled, and disabling. When dening the le, you may only specify enabled or disabled. The default value is enabled. ErrorIsolation (Error isolation) This attribute indicates if SFS Error Isolation is to be used with recoverable OFDs opened on the le. The attribute is ignored for nonrecoverable les. If set to on, all SFS errors are passed on to the application. If set to off, certain SFS errors are not passed on to the
File Denitions (FD)

application and, if an error occurs, the transaction is forced to abend. Performance improves slightly if you set this attribute to off because the time it takes to pass on and deal with SFS errors is eliminated. The default value is on. FileProtection (Protection level per OFD) This attribute sets the authentication level of the Remote Procedure Calls (RPC) between the region and the SFS when it deals with this le. Possible values are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. This attribute should be used in conjunction with the RuntimeProtection attribute in the Region Denitions (RD) as follows: v If RuntimeProtection is set to none, the FileProtection value is ignored. v If RuntimeProtection is set to a value other than none, the value specied in FileProtection is used. v If FileProtection is set to none, the value specied in RuntimeProtection is used. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate and this might affect performance. The default value is none. FileServer (File Server) This ASCII text attribute denes the name of the SFS server for a local le. For a remote le or for a DB2 le, it should be blank. The default value is "". GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". IndexName (Server Index Name) This ASCII text attribute denes the server index name. You should set this only for a local le. The default value is "".
10
File Denitions (FD)

KeyLen (Key length to use with remote requests) This attribute species the key length to be used with requests to remote Key Sequenced Data Set (KSDS) les. The default value is 0. OpenStatus (File open status) This attribute denes whether the le is open, closed, in the process of opening, in the process of closing, or has had a close request issued for it. The possible settings are: open, closed, opening, closing, and closerequest. When dening the le, you may only specify open or closed. The default value is closed. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. PrePages (Number of pages to preallocate) this attribute species the number of pages to be preallocated for a le that has the attribute EmptyOpt=emptywhen it is opened. The default value is 1. ReadOpt (Read access status) This attribute denes whether or not read operations are allowed on the le. The possible settings are readable and notreadable. The default value is readable. RecordSize (Record length to use with remote requests) This attribute species the record length to be used with requests to remote les. The default value is 0. RecoverStatus (Recoverability status) This attribute species whether the le is recoverable or nonrecoverable. The possible settings are recoverable and notrecoverable. The default value is recoverable. RemoteName (Remote lename) If the le resides in a remote region or system, you must enter the name by which the le is known there. If you do not provide this ASCII text attribute, CICS sends the local identier of this le to the remote region. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". RemoteSysId (Remote System Name) If the le resides in a remote region, you must enter the name of a
11
File Denitions (FD)

Communications Denitions (CD) entry that denes a connection to the remote region. The default value is "" meaning that the le resides in the local region. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is File Denition. RSLKey (Resource Level Security Key) This attribute contains the resource security key for this le, in the range 1 through 24. If the user, whose transaction issues this request, does not have this RSLKey value in the RSLKeylist attribute in the User Denitions (UD), CICS raises the NOTAUTH condition. Alternatively, you can specify the value public or private. With public, any user may access the le. With private, CICS only allows access to the le from transactions which have the attribute RSLCheck=none. in their Transaction Denitions (TD) entry. The default value is private. For further information about resource security, read the CICS Administration Guide. TemplateDened (Is a user conversion template dened) If this le can be accessed from a non-ASCII region, or if it contains binary or user-dened data, then you need to dene a conversion template for the le. If such a template exists, you should set this attribute to yes, otherwise to no. The default value is no. UpdateOpt (Update access status) This attributes denes whether or not update operations are allowed on the le. The possible settings are updatable and notupdatable. The default value is updatable.
Gateway Denitions (GD)

Gateway Denitions (GD) dene the PPC gateways to other systems with which this region can communicate. <Key> This represents the identier for a particular GD entry. It may be between one and four characters long. CICS allows the ASCII characters A-Z, 0-9, dollar ($), at sign (@) and number sign (#). Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate resource at cold start?) This attribute can be set to either yes or no. If you set this attribute to yes, the GD entry will be installed automatically at CICS start up,
12

irrespective of whether the RDO group, if any, specied in the GroupName attribute is listed to be installed at start up or not. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. DCECell (DCE cell name of the gateway) This attribute species the ASCII text name of the DCE cell in which the PPC gateway is registered. The default value is /.:/. GatewayCDSName (CDS path name of the gateway) This 32-byte ASCII text attribute takes the name that the PPC gateway registers with the DCE Cell Directory Services (CDS). This attribute can take either the full path name of the PPC gateway (for example /.:/cics/ppc/gateway/CICSOPEN) or a partial name (for example CICSOPEN). CICS will prex a partial name with the string /.:/cics/ppc/gateway/. For example, if you specied the partial name GatewayCDSName=CICSOPEN the full path used by CICS would be /.:/cics/ppc/gateway/CICSOPEN. The default value is "". GatewayLUName (SNA LU name of the gateway) This is the SNA Logical Unit (LU) name that the PPC gateway is to use as your regions local LU name. The LU name should be no more than eight characters long. The rst character must be an upper case alphabetic character (A-Z) and the subsequent characters must be either upper case alphabetic characters or numeric (0-9). For example, the following values are valid for the local LU name: A CICS1 CICSOPEN MYLU and the following values are invalid. 9 (Begins with a number) 1CICS (Begins with a number) CICSunix (Contains lower case alphabetic characters) MY-LU (Contains the unsupported character -) If the GatewayLUName is null () CICS will set it to the value in the LocalLUName in the Region Denition (RD) entry.
13

GatewayPrincipal (DCE principal under which this gateway runs) This ASCII text attribute species the name of the DCE principal used by the PPC gateway. If GatewayPrincipal= CICS will use a value for GatewayPrincipal based on the GatewayCDSName. For example, if GatewayCDSName=/.:/cics/ppc/gateway/CICSOPEN or GatewayCDSName=CICSOPEN CICS would use GatewayPrincipal=cics/ppc/gateway/CICSOPEN. The GatewayPrincipal attribute is ignored if the Region Denition (RD) attribute RuntimeProtection is set to none. If RuntimeProtection is set to anything other than none the region will check that requests coming from the PPC gateway are authenticated using this DCE principal. If the value of GatewayPrincipal is not the same as the DCE principal used by the PPC gateway all requests from the PPC gateway will be rejected by CICS. The default value for GatewayPrincipal is "". GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource description entry belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "", which does not assign the GD entry to any RDO group. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this GD entry. The default value is Gateway Denition.
Gateway Server Denitions (GSD)

Gateway Server Denitions (GSD) dene the characteristics required to start and stop the PPC gateway. A GSD entry is created by the cicsppcgwycreate command and removed by the cicsppcgwydestroy command. The GSD is not used by CICS for Solaris. Your CICS region does not access the Gateway Server Denitions (GSD). Instead, it uses a Gateway Denition (GD) which is described in Gateway Denitions (GD) on page 12.
14

<Key> This is the server name of the PPC gateway. It is of the form /.:/cics/ppc/gateway/gatewayname. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. AmendCounter (Number of updates) Reserved for CICS internal use. LogVolume (Logical volume for logging) This is the name of the logical volume used by the PPC gateway to store its conguration and transaction data. The default value for LogVolume is log_%S, where %S expands to the value in the ShortName attribute. NameService (Name Service for advertising server) This attribute determines whether or not the DCE Name Service is to be used to resolve server names. The possible values are DCE and NONE. The default value is DCE. If NONE is specied, one entry for each server will be required in the le /var/cics_servers/server_bindings (for Open Systems) or \var\cics_servers\server_bindings (for Windows NT). See the CICS Administration Guide for more information. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. ProtectionLevel (Protection level) This attribute sets the minimum authentication level that the PPC gateway uses to send and receive Remote Procedure Calls (RPCs) to and from your CICS regions. The possible values are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default, and the value used must be the same as the RuntimeProtection level set in the Region Denition (RD) entry for each of the CICS regions that use the PPC gateway. If Name Service is set to NONE, ProtectionLevel should be set to none. The default value is none. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is PPC Gateway Server Denition. ShortName (Short name used for subsystem) This is a one to eight character name for the PPC gateway. This value is referenced by other attributes using %S. It is also used to generate
15

default names in other attributes in the GSD entry. Each PPC gateway must have a different ShortName. The default value is PPCGWY. SNADefaultModeName (SNA default mode name (HP only)) This attribute is used on CICS for HP-UX to supply a default modename to a PPC gateway that is using HP SNAplus2. This modename is used on all intersystem requests that do not specify a modename. The default value is "". StartType (Cold or auto start?) This attribute determines the type of initialization that the PPC gateway should perform. It may be set to cold or auto. If StartType=cold then the PPC gateway is started as if it has never been run before. This means all of the CICS conguration and transaction data it has stored is lost. If StartType=auto then the PPC gateway is started using the information, if any, saved from the last time it ran. The default value is auto. You should only use StartType=cold the rst time the PPC gateway is started. ThreadPoolSize (Number of threads for RPC requests) This attribute is the number of Remote Procedure Calls (RPCs) that the PPC gateway can receive at once. The default value is 10. As an RPC to the PPC gateway is very fast this default value should be adequate for most PPC gateways. UserID (User ID for server) This is the operating system userid that the PPC gateway will use when it is running. The default value is %S, which means the value in the ShortName attribute.
Journal Denitions (JD)

The JD controls destinations for journaling output from the CICS region. <Key> This represents a unique user journal identier, and is the key for the JD entry. Journal identiers are in the range 1 to 99. However, 1 is reserved on other CICS systems for the system journal and it is inadvisable to use journal 1 on CICS on Open Systems for migration reasons. ActivateOnStartup (Activate resource at cold start?) If you set this attribute to yes, CICS copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes.
16

AmendCounter (Number of updates) Reserved for CICS internal use. CrucialFlag (Abort region if journal is inaccessible?) If this attribute is set to yes, and an unrecoverable output I/O error occurs, CICS abnormally terminates the region. Typically, journals with this attribute set are used for audit purposes. The default value is no. DiskA (File or path A holding the journal) This ASCII text attribute species the le name that CICS uses to hold the journal in /var/cics_regions/regionName/data. The le must be writeable, and must have a name that is different from the one on DiskB. You can request to switch between DiskA and the alternative le in DiskB, using EXEC CICS SET JOURNAL, or CEMT SET JOURNALNUM. If you do not specify a le name, CICS creates a user journal with the name CjrnlxxA in /var/cics_regions/regionName/data, where xx is the journal id. The journal denitions are not updated to include this name, so it remains as "". The default value is "". CICS does not empty user journals, so you must clear them when they are no longer required. If CICS is offline, delete the two operating system les that are dened as DiskA and DiskB attributes. If CICS is online, see the CICS Administration Guide for further information about clearing journals. On CICS for Windows NT, if CICS is online, use the CEMT transaction to close the journal before deleting it. DiskAStatus (Disk A Status) This attribute species the status of DiskA. Set the attribute to current if you want to use DiskA for journaling output; or set it to ready and set DiskBStatus to current if you want to use DiskB for journaling output. The default value is current. DiskB (File or path B holding the journal) This ASCII text attribute species the le name that CICS uses to hold the journal in regionName/data. The le must be writeable, and must have a name that is different from the one on DiskA. You can request to switch between DiskB and the alternative le in DiskA, using EXEC CICS SET JOURNAL, or CEMT SET JOURNALNUM. If you do not specify a le name, CICS creates a user journal with the name CjrnlxxB in /var/cics_regions/regionName/data, where xx is the journal id. The journal denitions are not updated to include this name, so it remains as . The default value is "". CICS does not empty user journals, so you must clear them when they are no longer required. If CICS is offline, delete the two operating system les that are dened as DiskA and DiskB attributes. If CICS is online, see the CICS Administration Guide for further information about
17

clearing journals. On CICS for Windows NT if CICS is online, use the CEMT transaction to close the journal before deleting it. DiskBStatus (Disk B Status) This attribute species the status of DiskB. Set the attribute to current if you want to use DiskB for journaling output; or set it to ready and set DiskAStatus to current if you want to use DiskA for journaling output. The default value is ready. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". InitialOpenFlag (Open journal on region startup?) This attribute is set to yes or no to indicate whether or not the journal is available for use. The default value is yes. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Journal Denition. RSLKey (Resource Level Security Key) This attribute contains the resource security key for this journal, in the range 1 through 24. If a transaction issues a request to write to this journal, and the user of the transaction does not have this RSLKey value in the RSLKeyList attribute in their User Denitions (UD) entry, CICS raises the NOTAUTH condition. Alternatively, you can specify the value public or private. With public, any user may access the journal. With private, CICS only allows access to the journal from transactions that have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. The default value is private.
18
Listener Denitions (LD) Listener Denitions (LD)

A standard CICS region will, by default, receive requests from clients and servers that use a DCE RPC interface, for example: v Another CICS region v A PPC gateway v CICS terminals such as cicsterm or cicsteld <Key> This is a 12-byte identier for the LD entry. LD keys are not supported by National Language Support (NLS). CICS allows the ASCII characters A-Z, 0-9, dollar ($), at sign (@) and number sign (#). Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate resource at cold start?) If you set this attribute to yes, CICS copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition. The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. CICSUserId The default userid under which IIOP requests run. This can be overridden by one of the IIOP user exits. The default value is "". This user must be dened to the CICS region. If the user is not dened, or this entry is null, then the requests run under the default, CICSUSER. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "", which does not assign the LD entry to any RDO group. NamedPipeName (local Named Pipe name) Species the entry in the le prodDir\bin\cicslcli.ini, which is used by the command cicsltermto connect to this region. The value of the attribute must be 6 alphanumeric characters, of which the last two characters must be unique within the local system. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no,
19
Listener Denitions (LD)

you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is yes. Protocol (Protocol type) This attribute denes the type of LD entry. If it is set to TCP this is an LD entry for CICS clients using TCP/IP, and CICS family TCP/IP connection. If it is set to SNA this is an LD entry for local SNA support. If it is set to NamedPipe this is an LD entry for cicslterm terminal. If it is set to LU0 this is the LD entry for SNA LU0 communication (Windows NT only). If it is set to IIOP, this is an LD entry for IIOP clients using TCP/IP IIOP connections. The default value is TCP. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing the resource. The default value is Listener Denition. SNAServerNodeName (local SNA Node Name) (CICS for Solaris only) This attribute denes the node name of the LU6.2 Server Process. Protocol=SNA. It can be up to 128 bytes long. The default value is "". On CICS for Solaris, if the connection to the SNA server users TCP/IP then the SNAServerNodeName is the IP address or TCP/IP host name of the host on which the SNA server is running. SSLAuthentication This attribute species whether SSL authentication is supported by an IIOP listener. The default no indicates that the listener does not support SSL. Other values are yes and client. Specify yes to congure an IIOP SSL listener that accepts SSL ows other than client authentication. Specify client to accept all SSL ows including client authentication. SSLEncryption This attribute species the level of encryption required on an SSL enabled IIOP listener. Possible values are no, yes and strong. The default is no. Specify no for using SSL message integrity support (no encryption), specify yes or strong for SSL message encryption using 40-bit or 128-bit encryption keys respectively. Note: 128-bit keys are only valid in the US and Canada. SSLKeyFile This attribute species the location and name of the SSL key database le. The default value is "". SSLKeyPassword This attribute species the password for the SSL key database le. The
20
Listener Denitions (LD)

default value is "". If no password is specied, CICS assumes a password has been saved in a stash le in the same directory as the SSL key database le. SSLCerticate The name (label) of the certicate for this SSL listener in the key database le. The default value is "", which causes CICS to use the default nominated certicate in the database. SSLSessionTimeout This is the timeout (in minutes) for SSL to timeout the current session key. SSL then attempts to create a new session key, The default is 0 (the timeout is 1 day). TCPAddress (TCP adapter address) This attribute denes which local network adapter addresses will be used by CICS to accept TCP/IP connections. It is applicable only if Protocol=TCP. Set TCPAddress=""when connection requests are to be accepted on any of the network adapters congured on the local machine. Alternatively, set TCPAddressto a single network adapter address in one of the following forms: v The Internet Protocol (IP) address in dotted decimal notation. For example, 1.23.45.67. v The IP address in dotted hexadecimal notation. For example, 0x01.0x17.0x2D.0x43. v The host name dened in the Internet name service. For example, aix5.cicsland.com. The default value is "". TCPService (TCP service name) This attribute species the service name in the le /etc/services(for Open Systems) or\system32\driver\etc\services (for Windows NT).that should be used by CICS when starting the TCP protocol. A value of means the reserved CICS port number (1435/tcp) will be used. The default value is "". Entries in /etc/services for TCPService must specify the port number and the tcp protocol. For example, if
TCPService = "cicstcp"
The le /etc/services could contain:

cicstcp 2345/tcp # CICS Common Clients
Monitoring Denitions (MD)

The MD controls monitoring output from the CICS region.
21

AmendCounter (Number of updates) Reserved for CICS internal use. Conversational (Write separate records for conversational tasks?) This attribute species whether conversational tasks are to have separate monitoring records written for each pair of terminal control input and output requests. Set it to yes if you require separate records, or to no otherwise. The default value is no. Exclude (Monitoring identiers to be excluded) By default, all performance monitoring elds are reported by CICS to the transient data queue. The Exclude attribute is 1024 bytes long, and contains a list of all elds which are not to be reported by CICS. All available performance monitoring elds have their own numeric eld identier together with an associated group name. This group name identies the group of elds to which each individual eld belongs. You can exclude elds from reporting either by using the numeric identier, to exclude a single eld, or the group name, to exclude a group of elds. Alternatively you can use a combination of numeric and group identications to exclude monitoring elds. The Exclude attribute can contain one or more group names or numeric identiers, and these are separated by commas. The Exclude attribute can just contain the string ALL to indicate that all elds should be excluded from performance monitoring. You cannot exclude eld identiers 1, 2, 4, 5, 6, and 89 which are always part of a Monitoring Record. The default value is "". Include (Monitoring identiers to be included) By default, all performance monitoring elds are reported by CICS to the transient data queue. The Include attribute is 1024 bytes long, and contains a list of all elds which are to be reported by CICS. All available performance monitoring elds have their own numeric eld identier together with an associated group name. This group name identies the group of elds to which each individual eld belongs. You can include elds for reporting either by using the numeric identier, to include a single eld, or the group name, to include a group of elds. Alternatively you can use a combination of numeric and group identications to include monitoring elds. The Include attribute can contain one or more group names or numeric identiers, and these are separated by commas. The default value is "".
22

Note: CICS always processes the Exclude attribute before the Include attribute. This allows the easy encoding of the selection of a limited set of elds to be reported. You normally use the Include attribute to override the effects of the Exclude attribute. For a list of monitoring elds and their associated groups, see the CICS Administration Guide. Modiable (Protect the resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to yes, you can amend or delete the entry. You can still amend or delete an entry with Modiable=no by rst setting Modiable to yes. If you do amend the entry, you should set Modiable back to no afterwards. The default value is no. MonitorStatus (Set monitoring on?) You can set this attribute to yes or no to indicate whether or not CICS is to perform monitoring. If you initially set this to no, you can still use CEMT to set it to yes at a later stage. The default value is no. ResourceDescription (Resource description) A 30-byte text attribute describing the resource. The default value is Monitor Denition. TDQ (TDQ to hold monitoring information) This ASCII text attribute species the name of the transient data queue where CICS writes all the monitoring information. You must dene the queue in the Transient Data Denitions (TDD) as an extrapartition queue for output with variable length records. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". Note: A null TDQ name is valid. Monitoring may still take place, but nothing will be written. UserMonitorModule (File or path of user monitoring program) This contains the name of the CICS-provided monitoring module, which you can amend or replace with your own. This program allows you to customize how monitoring is controlled within your CICS region. For further information, read Performance monitoring user program on page 395.
23
Monitoring Denitions (MD) Object denitions (OD)

A new CICS Resource Denition called the Object Denition (OD) has been introduced for the CICS IIOP ORB. The OD has the following default attributes: < Key> A unique 8-character key GroupName The group to which resource belongs. The default value is "". ActivateOnStartup Species whether to copy to runtime on cold start. The default is yes. ResourceDescription The text describing this resource. The default value is Object Denition. AmendCounter Reserved for CICS internal use. Permanent Species whether to protect from modication. The default value is no. Module The full IDL module name. The default value is "". Interface The full IDL interface name. The default value is "". Operation The full IDL operation name. The operation can be left null, which enables a match on a specic operation, also enabling other attributes (for example, Transid) to be set specically for that operation. If a match for a specic operation cannot be made, then the match is made based on Module::Interface. The default value is "". TransId The transaction identier that is used. The value is passed to the security user exit. The default is value is "" (the transaction then defaults to CIOD). Managed Species whether the resource is workload managed. The default value is no. OrbAdapterDllName The name of the DLL that is loaded. The default value is "".
24

ImplementationLanguage The implementation language (Java). The only supported language is Java. Cached Species whether the object is cached. The default value is no. Reloadable Species whether the object is reloadable. The default value is yes.
Product Denitions (XAD)

CICS uses the Product Denitions (XAD) to hold information needed to interface to other transactional products, using the X/Open XA protocol. Each XAD entry contains information for one product. <Key> This represents the name of the product, and is the key for the XAD entry. Product names can be up to 12 characters long. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you amend the entry, you should set Permanent back to yes afterwards. The default value is no.
25

ResourceDescription (Resource description) A 30-byte ASCII text attribute describing the resource. The default value is XA Product Denition. SwitchLoadFile (Switch Load File Path Name) This ASCII text attribute is a path name to an object le (dll on Windows NT, or to a shared object le on CICS for Solaris) which contains the xa_switch_t structure denition and XA support subroutines for this XA compliant product. The default value is "". This le is loaded into a CICS application server using an operating system call. The le must contain a function which returns the address of an xa_switch_t structure. The path name can either be a full path name, a relative path name, or the base name of the support le, in which case the le is searched for in the current regions bin directory followed by the $CICS/bin directory (for Open Systems) or the c:\opt\cics\bin directory (for Windows NT). This is the same as the PathName attribute in the Program Denitions (PD) denition, and exhibits the same search behavior. XAClose (Resource Manager Termination String) This is an ASCII character close string that is passed to the XA-compliant xa_close function. The content of the string is specic to the XA product being dened. Refer to the product documentation supplied with the XA-compliant product. The default value is "". XAOpen (Resource Manager Initialization String) This is an ASCII character open string that is passed to the XA-compliant xa_open function. The content of the string is specic to the XA product being dened. Refer to the product documentation supplied with the XA-compliant product. The default value is "". Note: By default, the XA open string appears in the CICS regions console le on startup. To prevent this string (which, for certain databases, can contain the userid and password) from appearing in this le, add the line CICS_SUPPRESS_XAOPEN_STRING=1 to the regions environment le, located in: /var/cics_regions/regionName/environment (for CICS on Open Systems) and \var\cics_regions\regionName\environment (for CICS for Windows NT). XASerialize (Resource Manager Serialization Attribute) This is an indication of how CICS should serialize access to an XA compliant resource manager in a multithreaded process. This attribute
26

is used to indicate that an XA compliant resource manager supports XA calls from multiple threads, and what style of serialization the XA compliant product requires. The following values are accepted: all_operations - CICS serializes around each XA call made. start_end - xa_start and xa_end calls. Serialization takes place around a transaction. single_association or multiple_association - Allows CICS to serialize based on whether or not the XA compliant product is thread aware. The default value is all_operations.
Program Denitions (PD)

Program Denitions (PD) identify the application programs, mapsets, and tables you require in your CICS region, including those supplied by CICS. <Key> This key for the PD entry represents a unique program, mapset, or table. It can be up to eight ASCII characters long for programs and tables, and up to seven ASCII characters long for mapsets. Names can be taken from the ASCII characters A-Z, a-z, 0-9, $, and @ (CICS converts all lowercase characters to uppercase). Do not begin names with the sequence DFH; this prex is reserved for CICS internal use. Program names do not have National Language Support (NLS). On all permanent database operations and runtime database insert operations, CICS performs class-specic validation of the bytes forming the database key. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use.
27

EnableStatus (Program enable status) Set this attribute to enabled if the program is available for use or to disabled if the program is not available for use. The default value is enabled. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for a cold start, CICS copy resource denitions belonging to groups named in the Groups attribute of the Region Denitions (RD) from the permanent database to the runtime database. You can also have CICS copy denitions that have the setting ActivateOnStartup=yes to the runtime database. The default value is "". PathName (Program pathname) This is an ASCII text attribute that identies the directory path and lename for the program, mapset, or table. The default value is "". You can specify the path in three different ways: v An absolute pathname to the le, followed by the lename. v A relative pathname to the le, followed by the lename. CICS interprets the pathname to be relative to /var/cics_regions/regionName (for Open Systems) or rootDir\var\cics_regions\regionName (for Windows NT). v A lename string not containing any slash character (/) (for Open Systems) or backslash character (\) (for Windows NT). To nd a program specied as a string, CICS searches the directories in the following order: 1. /var/cics_regions/regionName (for Open Systems) or rootDir\var\cics_regions\regionName (for Windows NT) 2. $CICS/bin (for Open Systems) For CICS to be able to nd a mapset specied as a string, the lename must have the extension .map. CICS searches the directories in the following order: 1. /var/cics_regions/regionName/maps/locale (for Open Systems) or rootDir\var\cics_regions\regionName\maps\locale (for Windows NT) 2. /var/cics_regions/regionName/maps/prime (for Open Systems) or rootDir\var\cics_regions\regionName\maps\prime (for Windows NT) 3. /opt/cics/maps/locale (for Open Systems) or rootDir\opt\cics\maps\locale (for Windows NT) 4. /opt/cics/maps/prime (for Open Systems) or rootDir\opt\cics\maps\prime (for Windows NT)
28

Normally, the value used for locale is determined by the Language setting (in the International section of the Control Panel) of the system on which the region is running. The locale setting for users connected by using the command cicsteld is specied by the -l option of the cicsteld command. The setting for UNIX client terminals is determined by the users UNIX locale. The correspondence between the Language setting and the locale is shown in the following table: Language Chinese English French German Italian Japanese Korean Portuguese Spanish Locale zh_CN en_US fr_FR de_DE it_IT Ja_JP kr_KR pt_BR es_ES
To nd a table specied as a string, CICS searches the directory /var/cics_regions/regionName/data (for Open Systems) or rootDir\var\cics_regions\regionName\data (for Windows NT). For programs written in a language other than Java, the lename specied in the PathName attribute must not contain an extension. For programs written in Java, the lename must include the .class suffix. CICS searches for the program le based on its installed extension in the following orders: v On CICS for Open Systems when Micro Focus COBOL Animator is not used (not all languages are available on all operating systems): 1. C program les (no extension) 2. IBM COBOL les (with extension .ibmcob) 3. Micro Focus COBOL native code les (with extension .gnt) 4. Micro Focus COBOL intermediate code les (with extension .int) 5. IBM PL/I les (with extension .ibmpli) 6. IBM C++ les (with extension .ibmcpp) v On CICS for Open Systems when Micro Focus COBOL Animator is used (not all languages are available on all operating systems):
29

1. C program les (no extension) 2. IBM COBOL les (with extension .ibmcob) 3. Micro Focus COBOL intermediate code les (with extension .int) 4. Micro Focus COBOL native code les (with extension .gnt) 5. IBM PL/I les (with extension .ibmpli) 6. IBM C++ les (with extension .ibmcpp) v On Windows NT systems: 1. Micro Focus COBOL or Net Express les (with extension .cbmfnt, .int, or.gnt)see Note below 2. C program les (with extension .dll) 3. IBM COBOL les (with extension .ibmcob) 4. IBM PL/I les (with extension .ibmpll) 5. IBM C++ les (with extension .ibmcpp) 6. Microsoft C++ les (with extension .cpp) Note: The order by which CICS searches through Micro Focus les depends upon: v Whether you are using Micro Focus COBOL or Net Express v If you are using Micro Focus COBOL, whether you are using Animator If you are using Net Express, CICS searches for Micro Focus les in this order whether or not you are using Animator: 1. Micro Focus COBOL generated code les (with extension .cbmfnt) 2. Micro Focus COBOL native code les (with extension .gnt) 3. Micro Focus COBOL intermediate code les (with extension .int) If you are using Micro Focus COBOL with Animator, CICS searches for Micro Focus les in this order: 1. Micro Focus COBOL intermediate code les (with extension .int) 2. Micro Focus COBOL native code les (with extension .gnt) If you are using Micro Focus COBOL without Animator, CICS searches only for Micro Focus les with the extension .cbmfnt. Permanent (Protect resource from modications?) This attribute species whether CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with
30

the setting Permanent=yes by temporarily setting Permanent to no. If you do amend the entry, set Permanent back to yes afterwards. The default value is no. ProgType (Program type) This attribute species whether the entry is a program, mapset, or table. Specify one of the values: program, map, or table. The default value is program. RemoteName (Name to use for program on remote system) If the program resides in a remote region, enter the name by which the program is known there. If you do not provide this attribute, CICS sends the programs local identier to the remote region. The default value is "". RemoteSysId (Remote system on which to run program) If the program resides in a remote region, you must enter the name of a Communications Denitions (CD) entry that denes a connection to the remote region. The default value is "", meaning that the program resides on the local region. Resident (Is this a program that should be cached?) This attribute species whether a program can reside in the application servers program cache after it has been loaded. If you set this attribute to yes, CICS caches the program if there is room in the program cache. The Region Denitions (RD) ProgramCacheSize attribute determines the cache size. Dening a program cache can improve performance because a resident program is not loaded again until one of the following occurs: v A SET PROGRAM NEWCOPY command is issued. v The Resident attribute is changed to no. v The cache is full and the program is removed to make room for a new entry. In this case, the program used least recently is removed, leaving more-frequently used programs in the cache. A program is given a fresh copy of static data only when it is loaded, so set the Resident attribute to no if a program modies static data. This attribute is ignored for Micro Focus COBOL programs. The default value is no. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Program Denition. RSLKey (Resource Level Security Key) This attribute contains the resource security key for the program,
31

represented by a number from 1 through 24. To enable a transaction to run the program, you must have the RSLKey value in the RSLKeyList attribute in your User Denitions (UD) entry; otherwise, CICS raises the NOTAUTH condition. Instead of a number, you can also enter public or private for the value. With public, any user can access the program. With private, CICS allows access to the program only from transactions that have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. The default value is private. For further information about resource security, see the CICS Administration Guide. TemplateDened (Is a user conversion template dened?) If this resource denition entry represents a program you can run from a remote non-ASCII CICS system using Distributed Program Link (DPL), and the program is passed a COMMAREA, you need to set up a conversion template for the COMMAREA. If such a template exists, set this attribute to yes, if not, to no. The default value is no. TransId (Transaction name on remote system for program) Species a transaction to attach on the server system when DPL is used. EXEC CICS LINK TRANSID overrides the value specied here. The default value is "". If the default value is taken, the CPMI transaction is used. UserExitNumber (User Exit number) Required if the program is a user exit program. You supply the number of the user exit for which this program is to be invoked. This number is the last three digits of the user exit name. You can omit any leading zeros in the number. For more details about user exit naming conventions, and for a table of user exit numbers, see Chapter 6. User exits on page 407. The default value is 0, meaning that this is not a user exit program.
Region Denitions (RD)

The RD contains both static and dynamic information required by the CICS region at startup; this is both control and initialization information. This section lists a basic set of RD attributes. The remainder, which supply the information required by SFS startup, are listed in Region Denitions (RD) for le server on page 54. ABDump (Should CICS system be dumped for ASRB abends?) You can set the ABDump attribute to yes or no. It determines whether a system dump or a transaction dump is taken if an ASRB abend occurs. IfABDump=yes, (SysDump=yes, and
32

TransDump=yesfor a transaction), a systems dump occurs. If ABDump=no (and TransDump=yes for the transaction), a transaction dump is taken. The default value is yes. AllowDebugging (Allow use of the application debugging tool) (CICS for AIX only) On CICS for AIX this attribute species whether or not the use of the application debugging tool is permitted. The possible values are no. The default value is no . AmendCounter (Number of updates) Reserved for CICS internal use. AuthenticationService (Userid authentication performed by DCE or CICS?) This attribute species whether authentication is performed by DCE or by CICS. The possible values are CICS . If the value is DCE a DCE authentication server is required in the cell. The default value is DCE. AutoDCELogin (CICS on Open Systems only) This attribute control whether the cicsnotify program, used to clean up resources after a non-normal shutdown of a region, should log into DCE automatically, using the password stored in /usr/local/systems/dce.cell_admin_pw. This enables it to clean up DCE resources for the region. AutoinstallMode (Mode for autoinstallation of terminals) This attribute is used to determine how terminals are autoinstalled. The possible values are old_style, default (the default) and no_netname_check. The old_style value matches the behavior of earlier versions of CICS on Open Systems. no_netname_check allows the region to install terminals more quickly than the default but disables all checks for the uniqueness of the netnames. CARPDelayHours (ATI purge interval (hours)) The value of this attribute controls how often, in hours, CICS schedules the transaction which deletes ATI requests that have been queued for more than the PurgeDelayPeriod or ProtectPurgeDelayPeriod. The default value is 8. CheckpointInterval This attribute controls the frequency with which CICS writes checkpoint information to the log. A small number means decreased performance but decreased recovery time following errors. A high number means the reverse. The number corresponds to the total writes made to each application server log le between checkpoints. The default value is 1000.
33

ClassMaxTasks (Maximum number of running transactions per class (10 entries)) This attribute denes the maximum number of tasks that can be run, at any one time, in each of the ten dened transaction classes. For a given class, when this number is reached, any new tasks are queued, up to the limit specied in ClassMaxTaskLim. The format of the attribute is: ClassMaxTasks=n1,n2,n3,n4,n5,n6,n7,n8,n9,n10 where n1 is the maximum number of tasks for class 1, n2 is the maximum number of tasks for class 2, n3 is the maximum number of tasks for class 3, and so on. The parameters are positional, so ten values, separated by commas and without spaces, must be specied. The default value is 1,1,1,1,1,1,1,1,1,1. This attribute is used in conjunction with the TD TClass attribute. For more information see the CICS Administration Guide. ClassMaxTaskLim (Purge threshold for transaction requests above ClassMaxTasks) This attribute denes the limit on the number of tasks in each of the ten dened transaction classes. For a given class, the value species the point at which tasks are no longer queued by the region waiting for a free server. The total number of transactions of a given class allowed in a region (running and queued) is (ClassMaxTasks + ClassMaxTaskLim) - 1. (The number is one less than the two attributes added together because, if a transaction request is received for a class that has reached its threshold, the request will be rejected.) A count will be kept of the number of times this limit is reached and this count will be recorded in CICS statistics. The format of the attribute is: ClassMaxTaskLim=n1,n2,n3,n4,n5,n6,n7,n8,n9,n10 where n1 is the limit on the number of tasks for class 1, n2 is the limit on the number of tasks for class 2, n3 is the limit on the number of tasks for class 3, and so on. The parameters are positional, so ten values, separated by commas and without spaces, must be expressed. The default value for all classes is 0, which means no limit.
34

ClassTableSize (Hash sizes CD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD, OD) This attribute contains a comma-separated list of numbers that CICS uses to control the size of the internal tables holding the resource denitions. The ordering of the list is as follows: CD, FD, PD, RD, TSD, WD, TD, TDD, XAD, UD, MD, JD, LD, GD, OD. You should always set the number for RD and MD to 1, and you should set JD to the maximum number of user journals that you expect your region to support. As a general rule, you should set the other numbers to twice the number of entries that you expect in that resource class. You can tune the values in this attribute by using statistical information. For further information about statistics, read the CICS Administration Guide. The default value is 5, 50, 50, 1, 50, 50, 50, 20, 5, 50, 1, 20, 5, 5, 20. CoreDumpName (Directory in which Core Dump output is written) You set this ASCII text attribute to the name of a subdirectory under DumpName. CICS uses this directory to write core images to in the event of a nonrecoverable CICS abnormal termination. DCE and Encina also use this directory if they produce a core dump. The default value is dir1. CUBSDelayMinutes (Rescheduling interval for blocked ATIs (mins)) As part of the auto start process following a normal shutdown, CICS attempts to recover Interval Control Elements (ICEs). If Temporary Storage (TS) is not available, the system cannot do this and so it makes periodic checks of TS, and recovers ICEs as soon as it nds that TS queues are available. CUBSDelayMinutes species the frequency of this check in minutes. The default value is 5. CWASize (Common Work Area Size) You set this attribute to the number of bytes to be allocated to the Common Work Area (CWA). This area is initially set to binary zeros, and is available to all programs. The maximum size for the work area is 3584 bytes. The default value is 512. DateForm (Format date for FORMATTIME) You set this attribute to the date format that you require for the EXEC CICS FORMATTIME command. The three possible values are: v mmddyy - the date in the form of month-day-year. v ddmmyy - the date in the form of day-month-year. v yymmdd - the date in the form of year-month-day. The default value is ddmmyy. DefaultUserId (Name of the default user identier) This attribute is used to specify the default userid for the region. The
35

default userid is used for tasks that are not associated with a signed-on userid. It is also used for tasks run by a user: v When an attempt to sign on using CESN fails. v When CRTE is used to route to another system, and CESF is used to log off, the default userid is used until CESN is used to log back on. For intersystem requests, the following attributes are used in conjunction with the DefaultUserId attribute: v The CD LinkUserId attribute, as well as the TSL and RSL keys dened in the UD entry for the userid specied with this attribute. v The CD RemoteSysSecurity attribute. v The CD TSLKeyMask and RSLKeyMask attributes. Read the CICS Intercommunication Guide for more information about how this attribute is used for intersystem requests. Note: You should provide a UD entry for the default userid. Otherwise, message ERZ045006W will occur each time that a user who is signed on as the default user invokes a transaction. Also, because remote users can be given this default userid, it is advised that you assign to it only the minimum required TSL and RSL keys for local users to run at the security level that is needed when the default userid is used. See the CICS Intercommunication Guide for more information about how remote users are assigned security keys. The default value is CICSUSER. DumpName (Directory in which dump output is written) You set this attribute to the name of the directory which contains the subdirectories where CICS dumps are written. The default value is dumps. CICS uses the available subdirectories in alphabetical order. By default, all CICS dumps are written to dumps/dir1, because CoreDumpName defaults to dir1. ECIPasswordCacheSeconds (Time DCE password is cached for use by ECI application (secs)) This attribute controls how long, in seconds, a password will be cached for userids using the External Call Interface (ECI) (either from a CICS for Open Systems client, or from an IBM CICS Client). If the password received in the call matches the cached one, it is not checked with DCE. This gives better performance. A high value for this attribute means calls to DCE are less frequent, but also means
36

users can carry on using passwords that have been changed through DCE. This attribute is used only if the region uses DCE as its authentication service. The default value is 28800, which is 8 hours. A value of 0 will prevent the password being cached at all. ESMLoad (Do you want to use an External Security Manager?) If you set this ag to yes, CICS loads the ESM program at startup. If you set this ag to no, CICS does not load the ESM program. The default value is no. For information about the ESM, read the CICS Administration Guide. ESMModule (Name of ESM Module) Set this ASCII text attribute to the ESM program path and name. The default value is "". For information about the ESM, read the CICS Administration Guide. ExternalTrace (External trace facility required?) On CICS for AIX and CICS for HP-UX only, you can set this attribute to specify whether or not CICS routes product trace to an external trace facility. The value can be yes or no, respectively. This is in addition to the normal trace destinations used by CICS. The default value is no. FileRSLCheck (Type of RSL checking for Files) This attribute indicates whether or not you require an External Security Manager (ESM) instead of CICS-provided resource security for les. Enter internal or external to dene the type of security checking required for les. If you require an ESM, you must also set RSLCheck=external in the required Transaction Denitions (TD) entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. FileSystemType (Type of le system) This attribute species the type of the le system to be used for CICS queues and les. The value must be either SFS or DB2. The default value is SFS. Groups (Startup groups) This attribute contains a list of group names used to cold start the region. The names are each up to eight-byte ASCII text attributes, and you are allowed to enter a maximum of 10 groups. Enter the groups as a comma-separated list. The default value is "" which results in all database entries with a default group of "" being installed. HTMLBrowser (HTML Browser for help text) (CICS for Windows NT only) This attribute species the fully qualied path name of the HTML browser to be used to view the help les for the CICS-supplied
37

transactions when using a cicslterm terminal. The location of the HTML les is specied by the environment variable CICS_CST_HTML. IntrospectInterval (Interval between region consistency checks (mins)) CICS provides you with the ability to periodically monitor the integrity of your region. You set this attribute to the time interval between these checks. To switch off this integrity checking, you set the value to zero. Note that frequent integrity checking decreases performance. You can specify any value in the range 0 to 1440. The default value is 10. IntrospectLevel (Level of checking to perform on region) In this release of CICS, this attribute has a xed value of minimal. IIOPObjrefsVersion The IIOP version level supported. The default is 1.1, which means IIOP version 1.1. This level is required for SSL support. The only other supported value is 1.0 for IIOP version 1.0. IIOPGroupUUID (IIOP Server group name) This parameter forms part of the object key and takes the place of the (server-specic) universal unique identier (UUID). This eld in the object key is used to validate incoming IIOP requests. For objects that are not congured for workload management, a check is made to determine whether the UUID in the request matches the UUID of the server. If the object is congured for workload management, the group UUIDs must match (the IIOP request can be handled by any server in the group). Set it to a suitable unique adminstration-dened name (for example, IIOPGroupUUID = Group1). The maximum length allowed for this name is 36 characters. IIOPGroupHost (IIOP Server group TCP/IP hostname) This parameter is the TCP/IP hostname for the server group, (for example, IIOPGroupHost = group1.cics.site.crp.com), which is inserted into the IORs for workload-managed objects. The dynamic DNS resolves this group name to a specic server decimal address. IIOPGroupPort (IIOP Server group TCP/IP port number) This parameter is the TCP/IP port number, which is inserted into the IORs for workload-managed objects (for example, IIOPGroupPort=9876). For a dynamic DNS conguration, this is the same port number as dened for the CICS IIOP listener. All CICS IIOP servers in the same server group must therefore use the same port number for the CICS IIOP listener. IIOPGroupSSLPort (IIOP Server group TCP/IP port number for SSL) This parameter is the TCP/IP port number, which is inserted into the IORs for objects that are SSL enabled and workload managed (for
38

example, IIOPGroupSSLPort=8765). If SSL support is required with workload management, the IIOPGroupSSLPort must be set. All servers in the group must have an IIOP SSL listener dened. IIOPRequestTimeout The number of seconds to wait for an IIOP response before raising an error. A value of 0 (zero) indicates an innite wait. The default is 100. ISCDelayMinutes (Retransmission interval for queued ATIs (mins)) The value of this attribute controls how often, in minutes, CICS attempts to send Automatic Transaction Initiation (ATI) requests, that have been locally queued due to the unavailability of the target system, to that system. The default value is 10. JournalRSLCheck (Type of RSL checking for Journals) This attribute indicates whether or not you require an ESM instead of CICS-provided resource security for journals. Enter internal or external to dene the type of security checking required for journals. If you require an ESM, you must also set RSLCheck=external in the required TD entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. LoadDataNumBuckets (Number of LOADed data Address Hash Buckets) This attribute controls access to maps and tables. CICS rounds up the value that you specify here, to the nearest power of two, with a minimum value of 1. The attribute controls the size of the hash table used by CICS to nd maps and tables in the task-shared pool, and the value you supply depends on the expected usage of your region. You trade off performance and storage size with this attribute. You can tune the value of this attribute by using statistical information. For further information about statistics, read the CICS Administration Guide. The default value is 512. LocalLUName (Local LU name) This is the default SNA Logical Unit (LU) name for your region. It is used as the local LU name for your region with local SNA support. It is also used as the local LU name for your region with SNA support via a PPC gateway if the Gateway Denitions (GD) entry for the PPC gateway has a null () GatewayLUName attribute. The LU name should be no more than eight characters long. The rst character must be an upper case alphabetic character (A-Z) and the subsequent characters must be either upper case alphabetic characters or numeric (0-9). For example, the following values are valid for the local LU name: A
39

CICS1 CICSUNIX MYLU and the following values are invalid. 9 (Begins with a number) 1CICS (Begins with a number) CICSunix (Contains lower case alphabetic characters) MY-LU (Contains the unsupported character -) If the LocalLUName is blank () then CICS will set it to the region name. The default value for LocalLUName is "". LocalNetworkName (Network name to which local region is attached) This ASCII text attribute contains the network name to which the local region is attached. It is up to eight ASCII characters long. The default value is "". LocalQProtection (Min protect level for locally queued ATIs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with nonrecoverable queue starts. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. LocalQProtectProtection (Min protect level for locally queued PROTECT ATIs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with recoverable queue starts. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS.
40

none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. LocalSysId (Region system identier (short name)) This attribute contains the short name of the CICS region (as used in the SYSID option of several CICS commands). It is up to four ASCII characters long with characters from the set A-Z, 0-9, dollar ($) and at sign (@). Lower case alphabetic characters will be converted to upper case characters. The default value is ISC0. LogicalTDQProtection (Min protect level for logical TDQs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the region and the SFS when dealing with logically recoverable TDQs. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. MaxConsoleSize (Maximum Console Size) MaxConsoleSize controls the size of the console.nnnnnn and the symrecs.nnnnnn les. nnnnnn is a number that is incremented every time a new console le is opened. A new console.nnnnnn le is written when a new CICS region is started or when the limit set in MaxConsoleSize has been reached. If you set MaxConsoleSize to zero, the console.nnnnnn and symrecs les continue to grow within the space allowed by your system. You should set MaxConsoleSize to a size greater than 100000 (10 KB). If you set it to be less than this, then during system initialization the value is automatically reset to 100000. When the upper limit is reached, two messages are issued, one explaining that the le is about to be closed and the second gives the name of the new le. It is
41

possible to tail the console le using the cicstail command. When the le changes cicstail switches to the new le. For automatic archiving, a program can from time to time check the contents of the console les and look for the message at the end indicating that the le has been closed. The default value for MaxConsoleSize is zero. MaxRegionPool (Region Pool Storage Size in bytes) This attribute controls the size of the region pool. This is a storage area used by CICS to hold CICS-private region information. The value depends on the number of resources in your region, the volatility of these resources, and the level of transactional activity. For example, the default value of 2097152 is enough to start a region with two application servers. To estimate an appropriate value, allow 1000 KB plus 50 KB for each application server (set in MaxServer). For example, if MaxServer is set to 5, the calculation is 1000 KB + (50 KB * 5) = 1250 KB. If you are running FEPI, add 500 KB to this gure. Check the statistics for region pool size. If the region pool size setting is close to the default setting, consider increasing the value for MaxRegionPool. The minimum value is 262144, the maximum value is 268435456, and the default value is 2097152. On CICS for HP-UX and CICS for Solaris, the value must not exceed the value of the kernel attribute SHMMAX. MaxTaskCPUAction (CICS on Open Systems) The values are abend or warning. When set to warning, a warning message is added to the console.nnnnnn when a tasks CPU usage exceeds the value of MaxTaskCPU. When set to abend, the task abends when its CPU usage exceeds the value of MaxTaskCPU. The default is warning. MaxTaskCPU (CICS on Open Systems) Sets the maximum time (in milliseconds) allowed for CPU use by all the transactions of a region. You can override this value for an individual transaction by setting the MaxTaskCPU attribute in the Transaction Denitions. If you set the value to 0, there is no region-wide control of CPU usage. You can override this if the MaxTaskCPU attribute for a particular transaction is dened in the Transaction Denitions. If the value is greater than zero, checks are made each time the transaction enters CICS through an EXEC CICS call command. The maximum value is 2**31 1 (approximately 24 days of User space per CPU). The default is 0. MaxServer (Maximum number of Application Servers to maintain) This attribute contains the maximum number of application servers that CICS uses to process transactions. The CICS Application
42

Programming Guide describes how to use MinServer and MaxServer to run CICS efficiently. The default value is 5. MaxTaskPrivatePool (Task-private Storage Size in bytes) This attribute controls the amount of memory allocated for each processs task-private pool. The value depends on the sizes of EXEC CICS GETMAIN areas and CICS transaction programs. To maximize performance, storage areas are aligned on appropriate boundaries, which can lead to more storage being allocated than used. When calculating this value, allow for this additional storage. The minimum value is 307200, the maximum value is 268435456, and the default value is 1048576. MaxTSHPool (Task-Shared Pool Storage Size in bytes) This attribute controls the size of the task-shared pool. This is a storage area used by CICS to hold information needed by two or more tasks, whether running in CICS code or in the user programs. The storage from this area is used for: v COMMAREAs v Common Work Area (CWA) v Terminal Input/Output Areas (TIOAs) v TCT User Areas (TCTUAs) v Main temporary storage v Maps and tables v Conversion templates v Temporary storage for unprotected STARTs The value depends on the size of CICS-provided shared areas such as the Terminal Control Table User Areas (TCTUAs), the size of EXEC CICS GETMAIN SHARED areas, the number of MAIN temporary storage requests, and the volatility and levels of Basic Mapping Support (BMS) requests. See the CICS Application Programming Guide for information about efficiency. The minimum value is 32768, the maximum value is 268435456, and the default value is 1048576. MinServer (Minimum number of Application Servers to maintain) This attribute contains the minimum number of application servers that CICS uses to process transactions. The CICS Application Programming Guidedescribes how you can use MinServer and MaxServer to run CICS efficiently. The default value is 1. Modiable (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to yes, you can amend or delete the entry. You can still amend or delete an
43

entry with Modiable=no by rst setting Modiable to yes. If you do amend the entry, you should set Modiable back to no afterwards. The default value is no. NameService (Use DCE Name Service (CDS) to locate CICS and Encina servers?) This attribute can be set to NONE to determine whether or not the DCE Name Service is to be used for name resolution. If the value is set to DCE, any SFS or PPC Gateway denition that is used must also have NameService=DCE. The default value is DCE. NonRecTDQProtection (Min protect level for nonrecoverable TDQs) If an SFS server is used this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with nonrecoverable TDQs. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. NonRecTSQProtection (Min protect level for nonrecoverable TSQs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with nonrecoverable TSQs. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. PCDump (Should CICS system be dumped for ASRA abends?) You can set the PCDump ag to yes or no. It determines whether a
44

system dump or a transaction dump is taken if an ASRA abend occurs. IfPCDump=yes, (SysDump=yes, and TransDump=yesfor a transaction), a systems dump occurs. If PCDump=no (and TransDump=yes for the transaction), a transaction dump is taken. The default value is yes. PhysicalTDQProtection (Min protect level for physical TDQs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with physically recoverable TDQs. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than, the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD for SFS. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. PostScanInterval (Timer that controls how frequently a search is initiated for completed WAIT EVENTs) This attribute species the interval in seconds that CICS waits between initiating scans to locate a completed WAIT EVENT. The default is set to zero (0). To be able to complete an event manually, this number must be greater than zero (0). ProgramCacheSize (Maximum number of C or IBM COBOL programs that can be cached) This attribute species the maximum number of C or IBM COBOL programs that can reside in one application servers program cache. A program is cached only if, when loading the program, the Program Denitions (PD) Resident attribute is set to yes and the number of cached programs in use has not reached the maximum number. Dening a program cache can improve performance because a resident program will not be loaded again until one of the following occurs: v A SET PROGRAM NEWCOPY command is issued. v The Resident attribute is changed to no. v The cache is full and the program is removed to make room for a new entry. In this case, the least recently used program is removed, leaving more frequently used programs in the cache.
45

Because programs that are being used are not removed from the cache, it is recommended that the cache size should allow programs at every logical level to be cached when using EXEC CICS LINK. The default value is 0 (zero). ProgramRSLCheck (Type of RSL checking for Programs) This attribute indicates whether or not you are using an ESM instead of CICS-provided resource security for programs. Enter internal or external to dene the type of security checking required for programs. If you require an ESM, you must also set RSLCheck=external in the required TD entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. ProtectPurgeDelayPeriod (Purge delay period for PROTECT requests (hours)) The value of this attribute controls the aging period, in hours, for locally queued ATI sends with the PROTECT option specied. Specify 0 to indicate that you do not wish CICS to perform this purge function. The default value is 8. PublicUserTraceFile (User Trace le or path for guest logins) You set this ASCII text attribute to the name of the user trace le where CICS places trace information for programs that use user trace but run without a user identier. For example, those run at startup. The default value is cicspubl. PurgeDelayPeriod (Purge delay period for no PROTECT requests (hours)) The value of this attribute controls the aging period, in hours, for locally queued ATI sends without the PROTECT option. Specify 0 to indicate that you do not wish CICS to perform this purge function. The default value is 8. RDBMSInstance (The RDBMS Instance name) If the region is congured for DB2 this attribute species the name of the instance of DB2 and is used to set the DB2 environment variable DB2INSTANCE. It is reset to the value of the -i parameter whenever the cicsdb2conf command is used. The default value is "". RecTSQProtection (Min protect level for recoverable TSQs) If an SFS server is used, this attribute controls the authentication level used for Remote Procedure Calls between the CICS region and the Structured File Server when dealing with recoverable TSQs. The possible settings are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. This attribute must be set to a value that is the same as, or greater than,
46

the ProtectionLevel set in the SSD for the SFS specied in the DefaultFileServer attribute in the RD. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. The default value is none. RegionPoolBase (Region Pool base register) (CICS for AIX and CICS for Windows NT only) This attribute species the address at which CICS should attach the segment it uses for its region pool. You may need to change this value if, in addition to CICS, you are running a utility or an application (such as a database) that also uses shared memory. By changing the value of this attribute, you can ensure that the CICS shared memory segments do not overlap with those of your application. If you use the cicsupdate command to change this value, you can specify it in either hexadecimal notation (for example, 0x70000000) or decimal notation (for example, 1879048192). If you use SMIT (CICS for AIX only) to change this value, enter it in decimal notation. On CICS for AIX, the value of the RegionPoolBase attribute must be within the range 0x30000000 to 0xC0000000, and must be a multiple of 0x10000000. The default value is 0xA0000000. On CICS for Windows NT, the value of the RegionPoolBase attribute must be less than 0x80000000. The size of the region pool is given by the MaxRegionPool attribute. The area of memory dened by these two attributes must not overlap with areas of any Dynamic Link Libraries (DLLs) already loaded. If it does, you must change the RegionPoolBase value to an area of memory not in use. The default value is 0x70000000. Do not specify the same value for this attribute as for the TaskSharedPoolBase attribute. RegionPoolThreshold (Threshold for Region Pool short on storage (%age)) You set this attribute to a percentage. When this percentage of the region pool is exceeded, CICS generates a warning message. The default value is 90. ReleaseNum (CICS Release Number) This four-byte attribute holds the current CICS release number. It is in the format XXXX, where the rst byte is a zero. This attribute is
47

provided for information purposes only. If you try to change the attribute by using an editor program or cicsupdate, the change is ignored at region startup. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The rst 17 characters of this text value are used in the Available CICS Regions panel when you run cicsterm (CICS for Windows NT) or cicsteld without a region name. Specifying this value allows you to give this panel more meaning, otherwise, the default value, Region Denition is used. RPCListenerThreads (Number of threads for RPC requests) This attribute species the number of threads used to listen for transaction and autoinstall requests, from terminals and from CICS EPI applications, by the RPC listener process cicsrl. An RPC listener thread is generally occupied by a request for the time it takes to complete a transaction or autoinstall. For further information on how this attribute can affect performance, see the CICS Administration Guide. The default value is 0 and the actual number of RPC listener threads is calculated as ten times the value of the MaxServer attribute. RuntimeProtection (Min protect level used when accepting RPCs) This attribute species the minimum level of Remote Procedure Call (RPC) protection which is requested by the CICS control process when sending an RPC. Possible values are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, see the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate, and this may affect performance. For communication over links whose Communications Denitions (CD) has a ConnectionType of ppc-tcp, settings of connect and call are treated as pkt. Note: In order to implement the authentication of RPC requests, all CICS on Open Systems connected to your region must be at a level of CICS that provides this ability. If any of these systems do not have the RuntimeProtection attribute included in the Region Denitions (RD), then those that do must have this attribute set to none. The default value is none.
48

SafetyLevel (Level of protection against user corruption) This attribute denes the degree of protection that CICS provides for programs running in this region. Possible values are none, normal, guard (CICS for Windows NT only). If you set SafetyLevel to none, both CICS and user transactions can access the region pool. If you set SafetyLevel to normal, on all operating systems except Solaris, only CICS transactions can access the region pool. (On CICS for Solaris systems, the SafetyLevel setting is ignored entirely, and user transactions can always access the region pool.) The guard setting is provided specically for use on the Windows NT operating system. On the Windows NT operating system, the normal SafetyLevel setting incurs signicant performance costs. To lessen these performance costs, set SafetyLevel to guard. In this case, only the rst and last pages of the region pool are protected. On CICS for AIX and CICS for HP-UX systems, the guard setting is treated the same as the normal setting. The default value is none. ServerIdleLimit (Time before Application Servers terminate (secs)) This attribute denes the time, in seconds, that idle application servers are allowed to exist before CICS terminates them. CICS always ensures that there are MinServer servers available at all times. The default value is 3600. ServerSideTran (Server side transactions only ?) This attribute can only be set to yes to indicate that the CICS system will be used for communicating with a single Encina SFS system. If the value is yes, the only intersystem communication that is supported is transaction routing; communication using XA may be slowed, or may cause errors. A message is issued at CICS startup indicating whether or not server-side transaction support is being used. The default value is no. ShutdownProgList1 (Programs to execute at phase 1 of shutdown) You set this ASCII text attribute to a comma-separated list of up to 10 programs which CICS runs automatically during the rst stage of the two-stage CICS shutdown process. Each program must have an entry in the Program Denitions (PD). The default value is "". ShutdownProgList2 (Programs to execute at phase 2 of shutdown) You set this ASCII text attribute to a comma-separated list of up to 10 programs which CICS runs automatically during the second stage of the two-stage CICS shutdown process. Each program must have an entry in the Program Denitions (PD). The default value is "". StartType (Startup type) This attribute determines the type of CICS system initialization that you require. If the startup is cold, CICS performs a cold start. If the startup is auto, CICS uses the restart information written by the
49

previous run of CICS to restart the region from the state in which it was last shut down. If no restart information exists, CICS performs a cold start. You can override this value only by explicitly stating it when using the startsrc command (on CICS for AIX) or the cicsstart command (on all other CICS on Open Systems platforms). StartupProgList (Programs to execute at startup) You set this ASCII text attribute to a comma-separated list of up to 10 programs which CICS runs automatically during CICS startup. Each program must have an entry in the Program Denitions (PD). Note: Resource security checking is not performed during startup program execution. The default value for StartupProgList is "". StatFile (File or path for statistics) You set this ASCII text attribute to the absolute path name of the le where CICS is to write statistical information. The default value is statsle. StatsRecord (Should stats be recorded at every interval?) Set this ag to yes or no to indicate whether CICS is to collect statistical information every interval. For further information about statistics, read the CICS Administration Guide. The default value is yes. SufficesSupported (Should map names be suffixed?) This ag indicates whether CICS uses terminal suffixing. You set this ag to yes or no. If you set the ag to yes, CICS uses terminal suffixing. The default value is yes. SysDump (System dump on shutdown, SNAP dumps, ASRx abends?) You can set the global SysDump ag to yes or no to indicate whether or not CICS records system dump information if an abnormal termination occurs. This ag also determines whether or not CICS produces a dump at shutdown. In addition, for transaction abnormal terminations ASRA and ASRB, if SysDump=yes, then a system dump may also occur as explained under PCDump and ABDump. The default value is no. SysTraceBufferSize (System trace buffer size) You set this attribute to the size, in bytes, of the buffer that is used for main memory tracing. When system trace is in effect, CICS writes all system trace entries to the main memory buffer. When the buffer is full, CICS starts again at the beginning of the buffer and overwrites the previous entries. The minimum acceptable size of this buffer is 16384 bytes. The default value is 163840.
50

TaskSharedPoolBase (Task-Shared Pool base register) (CICS for AIX and CICS for Windows NT only) This attribute species the address at which CICS should attach the segment it uses for its task-shared memory pool. You may need to change this value if, in addition to CICS, you are running a utility or an application (such as a database) that also uses shared memory. By changing the value of this attribute, you can ensure that the CICS shared memory segments do not overlap with those of your application. If you use the cicsupdate command to change this value, you can specify it in either hexadecimal notation (for example, 0x70000000) or decimal notation (for example, 1879048192). If you use SMIT (CICS for AIX only) to change this attribute, enter the value in decimal notation. On CICS for AIX, the value of the TaskSharedPoolBase attribute must be within the range 0x30000000 to 0xC0000000, and must be a multiple of 0x10000000. The default value is 0xB0000000. On CICS for Windows NT, the value of the TaskSharedPoolBase attribute must be less than 0x80000000. The size of the task-shared pool is given by the MaxTSHPool attribute. The area of memory dened by these two attributes must not overlap with areas of any Dynamic Loaded Libraries (DLLs) already loaded. If it does, you must change the TaskSharedPoolBase value to an area of memory not in use. The default value is 0x79C00000. Do not specify the same value for this attribute as for the RegionPoolBase attribute. TaskSHNumBuckets (Number of Task Shared Pool Address Hash Buckets) This attribute controls access to the task-shared pool. CICS rounds up the value that you specify here, to the nearest power of two, with a minimum value of 512. The attribute controls the size of the hash table used by CICS to nd items in this pool, and the value you supply depends on the expected usage of your region. You trade off performance and storage size with this attribute. You can tune the value of this attribute by using statistical information. For further information about statistics, read the CICS Administration Guide. The default value is 512. TaskShPoolThreshold (Threshold for TSH Pool short on storage (%age)) You set this attribute to percentage. When this percentage of the task shared pool is exceeded, CICS generates a warning message. The default value is 90. TDPurgeInterval (Interval for purges of read records in the transient data queues) You can control the frequency of purges to the transient data queues
51

by assigning a value to this attribute. This value indicates a time interval in minutes controlling how frequently the private transaction CTDP is activated. If the TDPurgeInterval attribute value is set to zero, then the CTDP transaction runs at startup and every midnight. If the TDPurgeInterval attribute value is set to any value other than zero, the CTDP transaction runs at startup and at every TDPurgeInterval minutes. TemporaryStorageRSLCheck (Type of RSL checking for TSQs) This attribute indicates whether or not you require an ESM instead of CICS-provided resource security for TS queues. Enter internal or external to dene the type of security checking required for TS queues. If you require an ESM, you must also set RSLCheck=external in the required TD entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. Trace (Modules to trace) You set this attribute to determine whether all, some, or none of the CICS modules produce trace when the product trace is switched on. You set the value to all, partial, or none, respectively. If you specify partial, you must also set the TraceModules attribute. If you specify all or none, the TraceModules attribute value is ignored. The default value is all. TraceFileA (File or path (A) for system trace) You set this ASCII text attribute to the name of the rst of the two les into which CICS writes system trace information. CEMT allows you to switch this le to TraceFileB. The default value is trace.a. TraceFileB (File or path (B) for system trace) You set this ASCII text attribute to the name of the second of the two les into which CICS writes system trace information. CEMT allows you to switch this le to TraceFileA. The default value is trace.b. TraceFileSize (Maximum system trace le size) You set this attribute to the maximum size, in bytes, of the trace les that CICS writes system trace entries to. The names of the les are specied by the attributes TraceFileA and TraceFileB. The minimum acceptable size for these les is ten times the size of the main memory buffer, whose size is specied by the SysTraceBufferSize attribute. The default value is 3276800. TraceModules (Module list for partial trace) You set this attribute to the module identiers of one or more CICS modules that you want to produce trace when trace is switched on. See the CICS Problem Determination Guide for a list of modules and
52

their identiers. Separate each module identied by a comma. This list of module identiers is used only if the Trace attribute is set to partial. The default value is 0. TransactionRSLCheck (Type of RSL checking for Transactions) This attribute indicates whether or not you require an ESM instead of CICS-provided resource security for transactions. Enter internal or external to dene the type of security checking required for transactions. If you require an ESM, you must also set RSLCheck=external in the required TD entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. TransientDataRSLCheck (Type of RSL checking for Transient Data queues) This attribute indicates whether or not you require an ESM instead of CICS-provided resource security for transient data queues. Enter internal or external to dene the type of security checking required for transient data queues. If you require an ESM, you must also set RSLCheck=external in the required TD entries. If you require external security checking, the ESMLoad and ESMModule attributes must be set to congure the ESM, otherwise only internal security checking occurs. The default value is external. TransDumpTrace (Transaction Dump Trace) This attribute implies that the contents of the main trace buffers will be included in the output of the transaction dumps produced by the region. It can be set to yes or no. The default is no TSQAgeLimit (Expiry limit for unaccessed TSQs (days)) You set this attribute to a period in days, with a value between 5 and 512, or a value of 0. CICS purges any TS queues that have not been accessed for a period longer than this value. Specify 0 to indicate that you do not wish CICS to perform this purge function. The default value is 20. UserTraceDirectory (User trace directory) You set this ASCII text attribute to the name of the directory under which CICS is to write user trace data. The default value is /tmp (ubcics;) or /var/cics_tmp (CICS for Windows NT). XPRecvTimeout (Provides timeout on ComSU_XPRecv calls) This attribute species the interval in seconds that CICS waits before timing out ComSU_XPRecv calls. It can be set from 0 (zero) to the value specied in the INT_MAX constant. (The value of INT_MAX is system-dependent. For 32-bit systems, the value is 2147483647 seconds.) The default value is 0 (zero), meaning that the region waits for callback indenitely.
53

Note: Do not change this setting unless you are using IBM CICS Clients on any platform in an earlier version than 2.0.2, and are experiencing CICS application server (cicsas) processes hanging as a result of a remote transaction abending. Setting this value to greater than 0 (zero) seconds can cause transactions that run for long periods of time (such as CEMT) to time out before completing.
Region Denitions (RD) for le server

The RD contains both static and dynamic information required for the startup of an SFS or DB2 le server; this is both control and initialization information. This information provides a partial list of the Region Denitions (RD) attributes. The remaining attributes are listed in Region Denitions (RD) on page 32. DefaultFileServer (SFS server or database storing CICS Queue Data) This attribute species the name of the Structured File Server or the DB2 database that is used to store CICS queue data. The default value is /.:/cics/sfs/%H. LocalQFile (SFS le for Locally-Queued Unprotected STARTs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicsnlqle. LocalQIndex (SFS Index for Locally-Queued Unprotected STARTs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicsnlqidx. LocalQMaxRecs (Maximum number of records for Local Qs) You set this attribute to the maximum number of records that can be held in LocalQFile. This attribute applies to SFS les only. The default value is 1000000. LocalQPrePages (Number of pages to preallocate for LocalQFile) You set this attribute to the number of pages preallocated from LocalQVol for the storage of LocalQFile. This attribute applies to SFS les only. The default value is 5. LocalQProtectFile (SFS le for Locally-Queued Protected STARTs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicsplqle. LocalQProtectIndex (SFS Index for Locally-Queued Protected STARTs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicsplqidx.
54

LocalQProtectMaxRecs (Maximum number of records for Locally-Queued Protected STARTs) You set this attribute to the maximum number of records that can be held in LocalQProtectFile. This attribute applies to SFS les only. The default value is 1000000. LocalQProtectPrePages (Number of pages to preallocate for LocalQProtectFile) You set this attribute to the number of pages preallocated from LocalQProtectVol for the storage of LocalQProtectFile. This attribute applies to SFS les only. The default value is 5. LocalQProtectVol (Locally-Queued Protected START Volume Name) You set this ASCII text attribute to the name of the volume that is to hold the local queue of ATI requests with the PROTECT option specied. The default value is sfs_%S. LocalQVol (Local Q Volume Name) You set this ASCII text attribute to the name of the volume that is to hold the local queue of ATI requests without the PROTECT option specied. The default value is sfs_%S. LogicalTDQFile (SFS le storing Logically Recoverable TDQs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicstdqlgle. LogicalTDQIndex (SFS Index for Logically Recoverable TDQs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicstdqlgidx. LogicalTDQMaxRecs (Maximum number of records for Logically Recoverable TDQs) You set this attribute to the maximum number of records that can be held in LogicalTDQFile. This attribute applies to SFS les only. The default value is 1000000. LogicalTDQPrePages (Number of pages to preallocate for LogicalTDQFile) You set this attribute to the number of pages preallocated from LogicalTDQVol for the storage of LogicalTDQFile. This attribute applies to SFS les only. The default value is 5. LogicalTDQVol (Logically Recoverable TDQ Volume Name) You set this ASCII text attribute to the name of the logical volume that is to contain logically-recoverable transient data queues. The default value is sfs_%S. NonRecTDQFile (SFS le storing Non-Recoverable TDQs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicstdqnole.
55

NonRecTDQIndex (SFS Index for Non-Recoverable TDQs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicstdqnoidx. NonRecTDQMaxRecs (Maximum number of records for Nonrecoverable TDQs) You set this attribute to the maximum number of records that can be held in NonRecTDQFile. This attribute applies to SFS les only. The default value is 1000000. NonRecTDQPrePages (Number of pages to preallocate for NonRecTDQFile) You set this attribute to the number of pages preallocated from NonRecTDQVol for the storage of NonRecTDQFile. This attribute applies to SFS les only. The default value is 5. NonRecTDQVol (Nonrecoverable TDQ Volume Name) You set this ASCII text attribute to the name of the volume that is to contain nonrecoverable transient data queues. The default value is sfs_%S. NonRecTSQFile (SFS le storing Non-Recoverable Auxiliary TSQs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicsnrectsql. NonRecTSQIndex (SFS Index for Non-Recoverable Auxiliary TSQs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicsnrectsqidx. NonRecTSQMaxRecs (Maximum number of records for Nonrecoverable TSQs) You set this attribute to the maximum number of records that can be held in NonRecTSQFile. This attribute applies to SFS les only. The default value is 1000000. NonRecTSQPrePages (Number of pages to preallocate for NonRecTSQFile) You set this attribute to the number of pages preallocated from NonRecTSQVol for the storage of NonRecTSQFile. This attribute applies to SFS les only. The default value is 5. NonRecTSQVol (Nonrecoverable TSQ Volume Name) You set this ASCII text attribute to the name of the volume that is to contain nonrecoverable temporary storage queues. The default value is sfs_%S. PhysicalTDQFile (SFS le storing Physically Recoverable TDQs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicstdqphle. PhysicalTDQIndex (SFS Index for Physically Recoverable TDQs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicstdqphidx.
56

PhysicalTDQMaxRecs (Maximum number of records for Physically Recoverable TDQs) You set this attribute to the maximum number of records that can be held in PhysicalTDQFile. This attribute applies to SFS les only. The default value is 1000000. PhysicalTDQPrePages (Number of pages to preallocate for PhysicalTDQFile) You set this attribute to the number of pages preallocated from PhysicalTDQVol for the storage of PhysicalTDQFile. This attribute applies to SFS les only. The default value is 5. PhysicalTDQVol (Physically Recoverable TDQ Volume Name) You set this ASCII text attribute to the name of the volume that is to contain physically-recoverable transient data queues. The default value is sfs_%S. RecTSQFile (SFS le storing Recoverable Auxiliary TSQs) This attribute is the name of the le within the DefaultFileServer. The default value is %Rcicsrectsqle. RecTSQIndex (SFS Index for Recoverable Auxiliary TSQs) This attribute is the name of the le index within the DefaultFileServer. The default value is cicsrectsqidx. RecTSQMaxRecs (Maximum number of records for Recoverable Auxiliary TSQs) You set this attribute to the maximum number of records that can be held in RecTSQFile. This attribute applies to SFS les only. The default value is 1000000. RecTSQPrePages (Number of pages to preallocate for RecTSQFile) You set this attribute to the number of pages preallocated from RecTSQVol for the storage of RecTSQFile. This attribute applies to SFS les only. The default value is 5. RecTSQVol (Recoverable Auxiliary TSQ Volume Name) You set this ASCII text attribute to the name of the volume that is to contain recoverable temporary storage queues. The default value is sfs_%S.
Schema File Denitions (SCD)

The Schema File Denitions (SCD) hold the details about the les and indexes of an SFS or DB2 table. There is no restriction on the number and location of schema les, and a schema le is independent of the server, so that you can use a schema le to build les and indexes on any server. <Key> This represents the SFS le name or DB2 table.
57

Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. AmendCounter (Number of updates) Reserved for CICS internal use. FieldLength1 (Field 1 - Length) This attribute species the length of a eld if it is a text eld. You can specify the lengths of up to twenty elds. The default value is 0. FieldLength20 (Field 20 - Length) This attribute species the length of the twentieth eld if it is a text eld. The default value is 0. FieldName1 (Field 1 - Name) This ASCII text attribute species the name of a eld in the le. You can specify up to twenty elds. You do not have to set up the details of every logical eld to dene it to CICS, but you must enter enough elds to dene the record length and keys. If the le has more than twenty elds, you must use the Encina command sfsadmin export le to export it from the SFS. The default value is ''. FieldName20 (Field 20 - Name) This ASCII text attribute species the name of the twentieth eld in the le. The default value is ''. FieldType1 (Field 1 - Type) This attribute species the type of a eld, for example unsignedInt16. For further information on eld types, refer to the Encina Administration Guide Volume 2: Server Administration. You can specify the types of up to twenty elds. The default value is none. FieldType20 (Field 20 - Type) This attribute species the type of the twentieth eld, for example unsignedInt16. The default value is none. FileType (CICS File Type) This attribute species what type of SFS le or DB2 database the schema le is. The le type can be clustered (KSDS), relative (RRDS), or sequential (ESDS). If the le type is not one of these record structures, you must use the Encina command sfsadmin export le to export it from the SFS. For further information on le types, refer to the Encina Administration Guide Volume 2: Server Administration. The default value is clustered. IndexFieldDescenders1 (Secondary Index 1 - Descending Fields) This ASCII text attribute species the list of eld names in an index that are sorted in descending order. You can specify this attribute for up to ten secondary indexes. The default value is ''.
58

IndexFieldDescenders10 (Secondary Index 10 - Descending Fields) This ASCII text attribute species the list of eld names in the tenth index that are sorted in descending order. The default value is ''. IndexFieldNames1 (Secondary Index 1 - Field Names) This ASCII text attribute species the list of eld names comprising an index. You can specify this attribute for up to ten secondary indexes. The default value is ''. IndexFieldNames10 (Secondary Index 10 - Field Names) This ASCII text attribute species the list of eld names comprising the tenth index. The default value is ''. IndexName1 (Secondary Index 1 - Name) This ASCII text attribute species the name of a secondary index on this le. You can specify up to ten secondary indexes. If the le has more than ten secondary indexes, you must use the Encina command sfsadmin export le to export it from the SFS. The default value is ''. IndexName10 (Secondary Index 10 - Name) This ASCII text attribute species the name of the tenth secondary index on this le. The default value is ''. IndexPreallocatePages1 (SFS ONLY: Secondary Index 1 - Preallocated Pages) This attribute species the number of pages to be preallocated for a secondary index. You can specify the preallocated pages for up to ten secondary indexes. The default value is 20. IndexPreallocatePages10 (SFS ONLY: Secondary Index 10 - Preallocated Pages) This attribute species the number of pages to be preallocated for the tenth secondary index. The default value is 20. IndexUnique1 (Secondary Index 1 - Is it Unique?) This attribute species whether or not a secondary index is unique. You can specify this attribute for up to ten secondary indexes. The default value is yes. IndexUnique10 (Secondary Index 10 - Is it Unique?) This attribute species whether or not the tenth secondary index is unique. The default value is yes. IndexVolumeName1 (SFS ONLY: Secondary Index 1 - Volume Name) This ASCII text attribute species the volume that a secondary index is, was, or will be stored on. You can specify the volume name for up to ten secondary indexes. The default value is ''. IndexVolumeName10 (SFS ONLY: Secondary Index 10 - Volume Name) This ASCII text attribute species the volume that the tenth secondary index is, was, or will be stored on. The default value is ''.
59

MaxRecords (SFS ONLY: Maximum Number of Records) This attribute species the maximum number of records for this le. The default value is 10000. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. PreallocatePages (SFS ONLY: Number of Pages to Preallocate) This attribute species the number of pages to preallocate for this le. The default value is 100. PrimaryIndexDescenders (Descending Field Names for Primary Index) This ASCII text attribute species the list of eld names in the primary index that are sorted in descending order. The default value is ''. PrimaryIndexFields (Field Names for Primary Index) This ASCII text attribute species the list of eld names that makes up the primary index. The default value is ''. PrimaryIndexName (Primary Index Name) This attribute species the primary index name. The default value is ''. PrimaryIndexUnique (Is Primary Index Unique?) This attribute species whether or not the primary index is unique. The default value is yes. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is SFS Schema File. VariableFieldLength (Variable Field - Length) This attribute species the maximum length of the one variable eld. The default value is 0. VariableFieldName (Variable Field - Name) This ASCII text attribute species the name of the one variable eld. The default value is ''. VariableFieldType (Variable Field - Type) This attribute species the type of the one variable eld. Valid values are none, varLenByteArray, or shortVarLenByteArray. For further information, refer to the Encina Administration Guide Volume 2: Server Administration. The default value is none.
60

VolumeName (SFS ONLY: Volume Name) This ASCII text attribute species the name of the Encina volume. The userid that the SFS runs under must have read and write access to this volume and its raw device. The default value is sfs_%S.
Structured File Server Denitions (SSD)

The SSD contain both static and dynamic information required by the SFS at startup. This is both control and initialization information. <Key> This represents the Cell Directory Service (CDS) name for this server. Local cell names do not have the /.:/ prex, so that they can be handled by SMIT on CICS for AIX and by SAM on CICS for HP-UX. AmendCounter (Number of updates) Reserved for CICS internal use. BufferPoolSize (Buffer pool size in KB) The SFS internal buffer pool size. The equivalent Encina sfs command option is -b. The default value is 1000. Checkpoint (Number of Log writes per checkpoint interval) This attribute controls the frequency with which SFS writes checkpoint information to the SFS log le. A small number means decreased performance but decreased recovery time following errors. A high number means the reverse. The number corresponds to the total log writes made to the log le between checkpoints. The equivalent Encina sfs command option is -i. The default value is 5000. CollatingLanguage (Collating language) The collating language used by the SFS for NLS string indexes. The equivalent Encina sfs command option is -c. The default value is C. DataVolume (logical volume for data) This attribute species the operating system logical volume that the SFS keeps its le data in. You must always specify an existing logical volume. The default value is sfs_%S. IdleTimeout (Idle timeout) The time, in seconds, after which any locks held by an SFS open le descriptor (OFD) can be overridden. The equivalent Encina sfs command option is -d. The default value is 300. LogFile (Log File Name) This attribute species the name of the le in which SFS keeps its log data. It will be created on the logical volume specied by LogVolume. The default value is logle. LogVolume (logical volume for logging) This attribute species the logical volume name on which SFS keeps
61

its log le data. You must specify a logical volume that you have already created. The default value is log_%S. MRAArchivingEnabled (Enable MRA Archiving?) This attribute species whether MRA archiving is turned on (yes) or off (no). If yes then, when the SFS runs short of space for writing records into the permanent volume on which the log le resides, it moves older log records for media recovery out of the permanent volume into one or more archive volumes. If no, the media archive les are not generated and any existing media archive les are destroyed. By default, MRA archiving is set to no. To disable MRA archiving, you must switch this value from yes to no, shut down the SFS, and then auto start the SFS. To enable MRA archiving, you must switch this value from no to yes, shut down the SFS, and then cold start the SFS. See the CICS Administration Guide for more details about enabling and disabling MRA archiving. NameService (Name Service for advertising server) This attribute species whether or not DCE is available to locate servers. The possible values are NONE. If the value is set to NONE there must be an entry in vardir/cics_servers/server_bindings for this server. The default value is DCE. OpThreadPoolSize (Number of threads devoted to normal operations) This attribute species the number of operational threads, and therefore the maximum number of SFS requests that can be processed concurrently by the SFS. The optimum number of threads depends on how heavily the server is used. A guideline is to set the number of threads in proportion to the maximum number of application servers congured to use the SFS. The equivalent Encina sfs command option is -P. The default value is 12. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. ProtectionLevel (Protection level) This attribute sets the minimum authentication level at which this SFS will receive and send Remote Procedure Calls. Possible values are none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default.
62

none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. default is the default DCE protection level. For more information about protection levels, refer to the DCE documentation. Remember that the higher the protection level, the more time is required to authenticate, and this may affect performance. If default is coded, an authentication level of pkt_integ will be used. If NameService is set to NONE, ProtectionLevel should be set to none. The default value is none. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is SFS Server Denition. ResThreadPoolSize (Number of threads devoted to resource operations) This attribute species the number of threads that are used by particular SFS calls to free resources. Normally the default value is adequate, but you might want to increase it if the SFS is heavily used. The equivalent Encina sfs command option is -P. The default value is 3. ShortName (Short name used for subsystem) Short name needed to provide an SRC entry (CICS on Open Systems) an SCM entry (CICS for Windows NT) of valid size (eight characters or less). The SRC subsystem name (CICS on Open Systems) or name of the subsystem (Windows NT service) is cicssfs.ShortName. You must ensure that each ShortName in the SSD is unique in the SSD. The short name can be mapped to various values, and is represented as %S. For example, when a server is created, its default rst volume is called sfs_%S. Therefore, you create an operating system volume name of sfs_ShortName. This convention simplies server conguration, but you must not name servers with preexisting volume names, because the names are unlikely to be in this form. The default value is S%H. StartType (Cold or auto start?) This attribute determines the type of CICS system initialization that you require. If the startup is cold, CICS performs a cold start. If the startup is auto, CICS uses the restart information written by the previous run of CICS to restart the server from the state in which it was last shut down. If no restart information exists, CICS performs a cold start. You can specify this value when using an Encina sfs command. The default value is auto. UserID (user ID for server) This attribute species the user identier for the SFS to use. The
63

UserID must be able to use any operating system resources required by the SFS, and read and write the logical volumes of the SFS. The default value is %S.
Temporary Storage Denitions (TSD)

Temporary Storage Denitions (TSD) describe the templates that CICS uses to determine the attributes given to temporary storage queues for this CICS region. When an application rst creates a temporary storage queue, CICS uses the attributes of the template with the longest matching template name that it can nd in the TSD. For further information on naming temporary storage queues and temporary storage queue templates, see the CICS Application Programming Guide. If no match is found, the queue automatically becomes a nonrecoverable, local queue with public access. <Key> This represents the unique temporary storage queue template name, and is the key for the TSD entry. Template names are not supported by National Language Support (NLS) and can be up to eight bytes long, taken from the ASCII values listed here. For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. CICS allows any bytes from 1 to 126 decimal except comma (,), single quote (), backslash (\), and colon (:) for permanent database temporary storage template keys, and 0 through 255 decimal for runtime database temporary storage keys. Binary queue names should not be used for remote queue names particularly if the remote queues are on either CICS/ESA or CICS/VSE. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start,
64

CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. RecoverFlag (Is queue recoverable?) This attribute determines whether the temporary storage queue is recoverable or not. You set this attribute to yes for recoverable queues, and no for nonrecoverable queues. All temporary storage queues held by DB2 are recoverable. If, when CICS intercommunication facilities are being used, a temporary storage queue could be remote and recoverable, CICS considers the queue to be remote. You can only specify recoverability in the region where the queue resides. Also, you can only make data on auxiliary storage recoverable. The default value is no. RemoteName (Remote Queue Name) If the temporary storage queue resides in a remote region, this attribute is the remote temporary storage queue template name, which can be up to eight ASCII characters long. CICS uses this name to replace the local template name or <Key> when a reference to the queue is transmitted to the remote region (see the CICS Application Programming Guide for an example). If you do not provide this attribute, then CICS sends the local identier to the remote region. If you do provide it, then the remote template name must be the same length as the <Key>. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". RemoteSysId (Remote System Identier) If the temporary storage queue resides in a remote region, you must enter the name of a Communications Denitions (CD) entry that denes a connection to the remote region. The default value is "" meaning that the terminal is connected to the local region. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Temporary Storage Denition. RSLKey (Resource Level Security Key) This attribute contains the resource security key for this temporary
65

storage queue, in the range 1 through 24. If the user, whose transaction issues this request, does not have this RSLKey value in the RSLKeylist attribute in their User Denitions (UD) entry, CICS raises the NOTAUTH condition. Alternatively, you can specify the value public or private. With public, any user may access the queue. With private, CICS only allows access to the queue from transactions which have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. The default value is private. For further information about resource security, see the CICS Administration Guide. TemplateDened (Is a user conversion template dened?) If this temporary storage queue can be accessed from a non-ASCII region, or if the queue contains binary or user-dened data, then you need to dene a conversion template that describes the temporary storage record. If such a template exists, you should set this attribute to yes, otherwise to no. The default value is no.
Terminal Denitions (WD)

Terminal Denitions (WD) dene the terminals available in this CICS region. Although you are supplied with predened terminal denitions for several terminal types, you can add, modify, or delete these as required. See Chapter 10. Terminal model denitions on page 501 for more information about the predened terminal denitions. <Key> This represents a unique identier for each terminal, and is the key for the WD entry. Terminal identiers are not supported by National Language Support (NLS) and can be up to four characters, taken from the ASCII characters listed here. For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. For terminals, CICS allows the characters A-Z, a-z, 0-9, and the following metacharacters; dollar ($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%), ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|), double quote (), comma (,), semicolon (;), less than (<), greater than (>). Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the
66

resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. CanStartATIs (Is terminal available for ATI requests?) You set this attribute to yes or no to indicate whether the terminal is available or unavailable to CICS as a target of an asynchronous EXEC CICS START request. The default value is no. CanStartTTIs (Can transactions be initiated from this terminal?) You set this attribute to yes or no to indicate whether the terminal is available or unavailable for use by users to initiate transactions. As transactions need to be requested from somewhere, you cannot set both ATI and TTI to unavailable, but you can set both ATI and TTI to available. The default value is yes. DevType (Device Type for model entry) This is used to select appropriate model entries for the terminal autoinstall program. The default value is "". See Chapter 10. Terminal model denitions on page 501 and Terminal autoinstall user program on page 390 for further information. ERRColor (Color for error messages) Some of the supplied transactions use this ag, indicating the color of the error messages. This option takes effect only if ERRLastLine is yes. The default value is no. Possible values are as follows: v no v v v v blue red pink green
v turquoise v yellow v neutral ERRHilight (Extended highlighting for error messages) Some of the supplied transactions use this ag, indicating the highlighting of the error messages. The default value is no. This option takes effect only if ERRLastLine is yes. Possible values are as follows: v no v blink v reverse
67

v underline ERRIntensify (Should error messages be intensied?) Some of the supplied transactions use this ag, indicating whether the transactions intensify error messages. This option takes effect only if ERRLastLine is yes. You can set the ag to yes or no. The default value is yes. ERRLastLine (Display error messages on the last line?) This ag is used by some of the supplied transactions, and indicates whether the transactions use the last line of the screen for error messages. You can set the ag to yes or no. The default value is yes. ExtDS (Is BMS to generate extended data streams?) Set this attribute to yes if the terminal supports extended data streams. Set this attribute to no otherwise. The default value is no. This attribute must be yes if any of the Highlight, Foreground, Outline, ProgramSymbols or SOSI attributes are set to yes. Foreground (Is foreground color supported?) You set this eld to yes to indicate that the terminal has color capability. Set it to no otherwise. The default value is no. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". Highlight (Does terminal support highlighting?) You set this eld to yes to indicate that the terminal supports extended highlighting. Set it to no otherwise. CICS terminals support extended highlighting, though terminals connected from inbound transaction routing may not. The default value is no. IsPrinter (Is this an output only device?) This attribute is set to yes to indicate that the denition is for a printer, or no if the denition is not. If the attribute is set to yes, you must also specify the NetName attribute, and set the values of NumColumns to 132 and NumLines to 64. The default value is no. IsShippable (Is terminal denition shippable?) You set this attribute to yes to indicate that this WD record can be shipped to a remote region. Set the ag to no otherwise. The default value is yes.
68

Katakana (Does terminal support Katakana?) This attribute is set to yes to indicate that the terminal supports Katakana characters. Otherwise this attribute is set to no. The default value is no. MapColumn This eld contains the column number of the origin of the latest map sent to the terminal. You cannot set this attribute directly, but you may access it through the EXEC CICS ASSIGN statement. MapHeight This eld contains the height of the latest map sent to the terminal. You cannot set this attribute directly, but you may access it through the EXEC CICS ASSIGN statement. MapLine This eld contains the line number of the origin of the latest map sent to the terminal. You cannot set this attribute directly, but you may access it through the EXEC CICS ASSIGN statement. MapWidth This eld contains the width of the latest map sent to the terminal. You cannot set this attribute directly, but you may access it through the EXEC CICS ASSIGN statement. ModelId (Autoinstall Model Identier) This attribute contains the autoinstall terminal model identier. You should set this attribute if the WD entry is a candidate model. Do not set this attribute if the IsPrinter attribute is set to yes, but set the NetName attribute instead. The default value is "". Read Terminal autoinstall user program on page 390 for a description of the terminal autoinstall user exit program. Note: Either ModelId or NetName must be specied (not allowed to take the default value), otherwise the terminal will not be loaded when the region starts and TermIderr will be returned when you try to use the terminal. NetName (NetName of the shell terminal) This attribute contains a unique ASCII eight-character identier for the terminal. This identier must be unique within the Terminal Denitions for this region. You must specify this attribute if the IsPrinter attribute is set to yes. The default value is "". Note: Either ModelId or NetName must be specied (not allowed to take the default value), otherwise the terminal will not be loaded when the region starts and TermIderr will be returned when you try to use the terminal.
69

NumColumns (Number of columns on terminal) This eld contains the number of columns on the terminal. CICS supports 80 and 132 columns for display terminals and 132 columns for printers. If the IsPrinter attribute is set to yes, you must set this attribute to 132. Specify a value other than these only when dening a terminal that resides in a remote region. This eld represents the standard size of the display, not the alternate size. A terminal which connects while the alternate size is in use, will be reset to the standard size when the rst ERASE is sent from CICS. The default value is 80. NumLines (Number of lines on terminal) This eld contains the number of lines on the terminal. CICS supports the following number of lines for display terminals: v 24 (with 80 columns) v 43 (with 80 columns) v 27 (with 132 columns). 64 lines are supported for printers. If the IsPrinter attribute is set to yes, you must set this attribute to 64. Specify a value other than these only when dening a terminal that resides in a remote region. This eld represents the standard size of the display, not the alternate size. A terminal which connects while the alternate size is in use, will be reset to the standard size when the rst ERASE is sent from CICS. The default value is 24. Outline (Does terminal support eld outlining?) Set to yes to indicate that the terminal supports the outlining feature. If it does not support the outlining feature, set to no. The default value is no. OutService (Set terminal out of service?) You can set this ag to yes or no to indicate whether or not this terminal is in service. The default value is no. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. Priority (Terminal priority) CICS uses this attribute, in the range 0 through 255, to establish the overall transaction processing priority. The transaction processing priority is equal to the sum of the terminal priority, transaction priority, and user priority; or 255, whichever is the smaller. The processing priority of a transaction determines how quickly CICS
70

schedules that transaction. The higher the summed number, the faster CICS schedules the task. The default value is 0. ProgramSymbols (Program Symbols) This attribute is set to yes to indicate that the terminal supports pure Multi-Byte Character Set display. Otherwise this attribute is set to no. The default value is no. RecoverTerminal (Recover terminal on region restart?) This attribute determines whether or not the terminal is recovered after a region failure. The possible values are yes and no. The default value in all the model terminal denitions provided with CICS is yes. If the value of this attribute is yes the terminal will be reinstalled automatically following a region failure. If the value is no, the terminal will not be reinstalled. If a terminal is not recoverable the time taken to install the terminal is slightly shorter and the time taken to restart the region will also be shorter. System administrators may choose to use recovery only for important classes of terminals. RemoteName (Terminal identier on remote system) If the terminal resides in a remote region, you enter the name by which the terminal is known on that region. If you do not provide this attribute, then CICS sends the local identier of this terminal to the remote region. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means %H. The default value is "". RemoteSysId (System to which terminal belongs) If the terminal resides in a remote region, you must enter the name of a Communications Denitions (CD) entry that denes a connection to the remote region. The default value is "" meaning that the terminal is connected to the local region. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Terminal Denition. RSLKeyList (Resource Level Security Key list) You should only specify RSLKeyList for all devices that are unable to sign on using CESN, for example, printers. This attribute contains the list of resource security keys, RSLKeys, for this terminal. CICS uses this to control access to resources when running transactions. You can specify up to 24 keys, each in the range 1 through 24, and separated by the | character. Only resources whose RSLKeys are included in the RSLKeyList can be accessed by any transactions running at this terminal. Therefore, you must include the security keys of all resources that can be accessed when running transactions on this terminal. The following
71

example of an RSLKeyList allows transactions to access resources with security keys of 1, 2, 8, and 23: 1|2|8|23 Note: You should be aware of the implications of resources marked as either public or private. With public, any terminal may access the resource. With private, CICS only allows access to the resource from transactions which have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. For further information, see the CICS Administration Guide. The default value is none, which gives access to public resources. SOSI (Does terminal support SOSI) This attribute is set to yes to indicate that the terminal supports Multi-Byte Character Set input. Otherwise this attribute is set to no. The default value is no. TCTUALen (Length of TCTUA) This attribute denes the length in bytes of the user area for this terminal. It can be in the range 0 through 255, but you should make it as small as possible. CICS initializes the user area to zeros at system initialization. The default value is 0. TerminalProtection (Protection level) If you are using DCE authentication this attribute sets the authentication level of the Remote Procedure Calls (RPC) between the region and the terminal. Possible settings are: none, connect, call, pkt, pkt_integ, pkt_privacy (only if you have installed DCE privacy support) and default. none means that DCE makes no attempt to authenticate the RPCs. connect, call, pkt and pkt_integ represent increasing levels of DCE authentication. The value default is the default DCE protection level. For more information about protection levels, refer to the DCE documentation. Be aware that the higher the protection level, the more time is required to authenticate and this may affect performance. The default value is none. TermSubType (Terminal subtype) This attribute is a qualication of TermType. These two attributes can get shipped in during transaction routing. CICS has a xed TermType and TermSubType. The default value is 10. TermType (Terminal type) This eld contains the terminal type for information purposes only. As CICS only has one type of terminal, changing the value does not mean that the emulation runs differently. The default value is 145.
72

TSLKeyList (Transaction Level Security Key list) You should only specify TSLKeyList for all devices that are unable to sign on using CESN, for example, printers. This attribute contains the list of transaction security keys, TSLKeys, for this terminal. CICS uses this to control access to transactions. You can specify up to 64 keys, each in the range 1 through 64, and separated by the | character. Only transactions whose TSLKeys are included in the TSLKeyList are allowed to run at this terminal. Therefore, you must include the security keys of all transactions allowed to run on this terminal. The following example of a TSLKeyList allows transactions with security keys of 1, 5, 13, and 52: 1|5|13|52 public transactions are transactions that allow any terminal to access them. For further information about transaction security, see the CICS Administration Guide. Read the CICS Intercommunication Guide for more information about how this attribute is used for intersystem requests. The default value for TSLKeyList is 1, which gives access to public transactions. UCTranFlag (Should terminal convert data to uppercase?) You set this attribute to yes or no to indicate whether or not CICS converts all lowercase data to uppercase on input. The default value is no. Validation (Does terminal support eld validation?) Field validation is where the terminal forces certain input elds to be completed before the user leaves the eld. You would set this attribute eld to yes to indicate that the terminal supports eld validation. Set it to no otherwise. cicsterm (CICS on Open Systems cicslterm (CICS for Windows NT) does not currently support eld validation. The default value is no.
Transaction Denitions (TD)

Transaction Denitions (TD) dene all the transactions that CICS can process in this region. Each entry within the TD contains control information used by CICS to identify and run a transaction. <Key> This represents a unique transaction code, and is the key for the TD entry. Transaction identiers are not supported by National Language Support (NLS), and must be made up from the ASCII characters listed here. Transaction identiers are between one and four ASCII characters long and must not include blank characters. For all the
73

permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. For transactions, CICS allows the characters A-Z (do not start with a C), a-z (do not start with a c), 0-9, and the following metacharacters; dollar ($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%), ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|), double quote (), comma (,), semicolon (;), less than (<), greater than (>). Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. Do not dene any transactions beginning with the letter C, as these are reserved for CICS internal use. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. DeadLockTimeout (Transaction deadlock timeout value (secs)) This attribute species, in seconds, how long CICS allows the transaction to wait when CICS has detected a possible deadlock. When that time expires, this transaction becomes a candidate for abnormal termination, and receives an abnormal termination code AKCS if CICS chooses it. You can specify a value of 0 to mean that the transaction never times out. The default value is 0. Dynamic (Can transaction be dynamically routed?) This attribute indicates whether or not the transaction can be routed to a remote system dynamically, using the CICS dynamic transaction routing facility. If this attribute is set to no a local or remote denition is created according to the RemoteSysId attribute. If this attribute is set to yes the dynamic transaction user exit program determines the local or remote destination when it is invoked. The ProgName, RemoteSysId and RemoteName attributes do not need to be set. If they are set they are passed to the user exit program as default parameter values. For programming information about the user exit, see Dynamic transaction routing user exit (UE014025) on page 413.
74

The default value is no. EnableStatus (Transaction enable status) You set this attribute to enabled if the transaction is available for use or to disabled if the transaction is unavailable for use. The default value is enabled. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". InDoubt (Effect of FORCEPURGE for InDoubt transactions) When this transaction is waiting in the rst phase of the two-phase commit process and a CEMT SET TASK FORCEPURGE is issued against the transaction, CICS uses this attribute to determine whether to commit or back out any changes made by the transaction before the wait. If you set this attribute to wait_commit, CICS commits any changes. If you set this attribute to wait_backout, CICS backs out any changes. The default value is wait_backout. InvocationMode (Contexts in which transaction can START) This attribute species several different contexts for running transactions, including facility values, valid start methods, and valid run states. Facility values (where the transaction can be started): no_facility allows the transaction to be run without being attached to a terminal or communications link. EXEC CICS START TRAN can be used; output_terminal allows the transaction to be STARTed on a printer; in_out_terminal allows the transaction to be STARTed on a terminal, or submitted by a user from a terminal; comms_link allows the transaction to be started on a communications link; any_facility enables the transaction to be run from anywhere. The default value is any_facility. Valid start methods: user_start enables a user to start the transaction; ATI_start allows the transaction to be started by ATI; internal_ATI_start allows the transaction to be started by ATI, only if submitted by internal CICS code and not by a user transaction EXEC CICS START call; triggered_start allows the transaction to be used as a triggered transaction for a TD Queue trigger; any_start allows the transaction to be started by any of these methods. The default value is any_start.
75

Valid run states: at_startup enables the transaction to be started at system startup. Only the CRAB and CAIN transactions should be set with this mode. at_normal_running allows the transaction to be started at any time during the normal runtime of the system (that is, after the Startup complete message and before shutdown starts). at_shutdown_start allows the transaction to be started during the rst phase of a normal shutdown; at_shutdown_end allows the transaction to be invoked after the rst phase of normal shutdown. Only the CRAB and CROW transactions should be set with this mode. at_immediate_shutdown allows the transaction to be invoked during immediate shutdown. Only the CROW transaction should have this mode. The default value is at_normal_running. IsBackEndDTP (Is back end of a DTP transaction?) You set this attribute to yes or no to indicate whether or not the transaction can be run as the back end of a distributed transaction processing (DTP) transaction. The default value is no. This attribute should be set to no if this transaction is intended to be the target of transaction routing. For further information, see the CICS Intercommunication Guide. LocalQ (Locally Queue ATI requests for this transaction?) If this attribute is set, and the remote region is out of service when another transaction issues an EXEC CICS START NOCHECK command for this transaction, CICS queues the API request locally until the remote region is back in service. Once the remote region is back in service, CICS ships all the outstanding requests to it. The default value is no. MaxTaskCPU (CICS on Open Systems) You can set the maximum time (in milliseconds) to be allowed for the use of the CPU by a transaction. If the value is greater than zero, checks are made each time the transaction enters CICS through an EXEC CICS call command. The maximum value is 2**31 1 (approximately 24 days of User space per CPU). The default is 0. See also the MaxTaskCPU and MaxTaskCPUAction attributes of the Region Denitions. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. Priority (Transaction Priority) CICS uses this attribute value, in the range 0 through 255, to establish
76

the overall transaction processing priority. The transaction processing priority is equal to the sum of the terminal priority, transaction priority, and user priority, or 255, whichever is the smaller. The processing priority of a transaction determines how quickly CICS schedules that transaction. The higher the summed number, the faster CICS schedules the task. The default value is 0. ProgName (First program name) This attribute can be up to eight ASCII characters long, and names the rst program that this transaction runs. You need to ensure that you include an entry in the Program Denitions (PD) for this ProgName. If the RemoteSysId attribute has a value, this attribute is not used. The default value is "". Purgeability (Transaction purgeability) If you set this attribute to purgeable, you can purge this transaction by running the CEMT PURGE TASK transaction. If you set this attribute to notpurgeable, then you cannot purge this transaction. The default value is purgeable. RemoteName (Remote Transaction Identier) If the transaction resides in a remote system, you enter the name by which the transaction is known in that system. If you do not provide this attribute, then CICS sends the local identier of this transaction to the remote system. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". RemoteSysId (Remote System Identier) If the transaction resides in a remote system, you must enter the name of a Communications Denitions (CD) entry that denes a connection to the remote region. If you specify a RemoteSysId, the Progname attribute is ignored. The default value is "" meaning that the transaction resides in the local region. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is Transaction Denition. RSLCheck (Type of RSL Checks) This attribute determines the type of resource security checking performed by CICS when running this transaction. Set this attribute to none for no resource security checking, to internal for CICS-provided resource security, or to external for CICS to use an External Security Manager (ESM) instead of CICS-provided resource security. If you require an ESM for a particular resource, you must set RSLCheck=external for that resource type, in the Region Denitions (RD). The default value is none.
77

RSLKey (Resource Level Security Key) This attribute contains the resource security key for this transaction, in the range 1 through 24. CICS applies transaction resource security checking only for the EXEC CICS START command. If the user, whose transaction issues this request, does not have this RSLKey value in the RSLKeyList attribute in his or her User Denitions (UD) entry, CICS raises the NOTAUTH condition. Alternatively, you can specify the value public or private. With public, any user may access the transaction. With private, CICS only allows access to the transaction from transactions that have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. The default value is private. For further information about resource security, see the CICS Administration Guide. SNAModeName (SNA modename for this transaction) This attribute is used to specify the mode name on an allocate request to a SNA-connected remote system. The mode species the characteristics of the conversation that is being allocated. A conversation may be allocated by this transaction in any of the following ways: v When the transaction issues an EXEC CICS ALLOCATE command without the PROFILE option to a SNA-connected system. (This attribute can be overwritten by specifying the PROFILE option on the EXEC CICS ALLOCATE command.) v When this transaction requests a resource that is on a SNA-connected remote system. v When this transaction itself is dened as remote on a SNA-connected system. The SNAModename value can be one of the mode names dened to SNA for the required SNA connection, or it can be "". If you do not specify a value for SNAModeName, the default mode name dened by the SNA software is used. Refer to the SNA booklet for your product for how to dene modenames to SNA. See the Concepts and Facilities. Syncpoint (Type of Syncpoint Flows) If prompt_nish is specied, EXEC CICS RETURN and EXEC CICS SYNCPOINT wait for the nish or forget ow from implicit and explicit sync points before moving on to the next LUW or returning to the application. If no_prompt_nish is specied, EXEC CICS RETURN and EXEC CICS SYNCPOINT may not wait for the nish or forget ow, but may return sooner, after receiving the commit ow.
78

Specifying no_prompt_nish can improve throughput of transactions because the nish or forget ow may be piggybacked onto the next ow. The only disadvantage of specifying no_prompt_nish is that during recovery (after all types of shutdown), more transactions will need to be reprepared because their nishes may not have occurred. Even after normal shutdowns, you may get recovery servers on restart which will be waiting for the nish ows to occur. TClass (The class of transaction) The transaction class is used by the Region Denitions (RD) ClassMaxTasks and MaxServer attributes to determine how many tasks can be run, at any given time, for this transaction. If the TClass attribute equals a value of 1 through 10, then the values specied with the RD ClassMaxTasks attribute are used. If TClass=none, then the value specied with the RD MaxServer attribute is used. The MaxServer attribute determines the maximum number of tasks the region can run simultaneously. The default value for TClass is none. See the CICS Administration Guide for more information. TemplateDened (Is a user conversion template dened?) If this transaction can be started with an EXEC CICS START command issued from a non-ASCII region, and expects to be sent data in the FROM option, then you need to dene a conversion template for the data. If such a template exists, set this attribute to yes, otherwise to no. The default value is no. Timeout (Conversational timeout value (mins)) This attribute species, in minutes, how long CICS waits for terminal input when running this transaction. When that time expires, this transaction abnormally terminates with code AKCT. You can specify a value of 0 to mean that the transaction never times out. Note that a Timeout value is not used for Intersystem requests including transactions started by IBM CICS Clients. The default value is 0. TPNSNAProle (SNA TPN prole for APPC listener program) This attribute is only relevant for requests to run transactions from remote System Network Architecture (SNA) systems. You specify here the TPN prole name of a prole that has been congured in SNA. The TPN prole contains elds that describe the characteristics of your transaction. The default value is "". Other than performance, this attribute has no effect on a TCP/IP connection. For performance reasons (at startup only), it is important that TPNSNAProle= is specied for transactions that do not need to be made available over the gateway. See the CICS Intercommunication Guide for more information. TransDump (Should transaction be dumped on an abend?) This attribute controls whether or not CICS produces a transaction
79

dump if the transaction abnormally terminates, and can be set to yes or no, respectively. If you set TransDump to no, CICS never produces a transaction dump. If you set TransDump to yes, CICS produces a transaction dump, and may also produce a system dump due to an ASRA or ASRB abnormal termination. For further information, see the PCDump and ABDump attributes in the Region Denitions (RD). The default value is no. TSLCheck (Type of TSL Checks) This attribute indicates whether or not you require an ESM instead of CICS-provided transaction security. Enter internal or external to dene whether you require CICS-provided transaction security or an ESM. The default value is internal. TSLKey (Transaction Level Security Key) This attribute contains the transaction security key for this transaction, in the range 1 through 64. If the user attempting to access this transaction does not have this TSLKey value in the TSLKeyList attribute in his or her User Denitions (UD) entry, CICS prevents access to the transaction. Alternatively, you can specify a value of public to allow any user to access the transaction. For further information about transaction security, read the CICS Administration Guide. The default value is 1. The TSLKey value for the CICS-supplied transactions should always be set to 1 to indicate a public transaction. This includes the CICS private transactions (marked (p) in Complete list of CICS-supplied transactions on page 278), although you may decide to have transaction level security checking on some sensitive transactions, such as CURD. If the TSLKey value is not 1 then unpredictable results due to TSL checking will occur during region start up, region shut down, or even in normal operation. TWASize (Transaction Work Area Size) The value of this attribute determines the size (in bytes) of the Transaction Work Area (TWA) which CICS acquires for this transaction. The maximum value is 32767. For a transaction that passes control between programs, you must specify a TWA size equal to or larger than the largest TWA size required by any of the programs in the transaction. The default value is 0. UCTranFlag (Should data be converted to uppercase?) If you set this attribute to yes, CICS converts all the data, sent as part of the transaction, to upper case. Otherwise, CICS does not convert the data. The default value is no.
80
Transient Data Denitions (TDD) Transient Data Denitions (TDD)

Transient Data Denitions (TDD) contain entries dening to CICS each of the symbolic destinations to or from which transient data is routed in this CICS region. The name of every transient data queue must be dened to CICS before the queue can be used by an application program. Unlike temporary storage queues, transient data queues cannot be dynamically created by an EXEC CICS WRITEQ command from an application. <Key> This represents the name of the transient data queue, and is the key for the TDD entry. CICS uses this name in the transient data operations to specify the destinations. Queue names are not supported by National Language Support (NLS) and can be up to four characters, taken from the ASCII characters listed here. For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. For transient data, CICS allows ASCII characters from ! to (33 to 126 decimal). The queue name should not start with the letter C or letters DFH, because these are reserved for dening the destinations required by some CICS facilities. Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied in the Groups attribute of Region Denitions (RD). The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. DestType (Type of Queue) This attribute species whether the transient data queue is intrapartition, extrapartition, indirect, or remote. See the CICS Administration Guide for further information. The default value is intrapartition. ExtrapartitionFile (Filename or path for EP queue data le) This ASCII text attribute denes the path name and le that corresponds to the extrapartition queue. The le must be owned by cics. The default value is "". FacilityId (System/Terminal for a triggered task) This ASCII text attribute denes the triggered transactions principal facility identier. It may be a system identier or terminal identier,
81
Transient Data Denitions (TDD)

depending upon the FacilityType. You do not specify this attribute if FacilityType=le. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". FacilityId attribute is applicable only to intrapartition queues. FacilityType (Type of facility allocated for triggered task) This attribute denes the type of facility allocated for a triggered task. You must enter either terminal, system, or le to determine the triggered transactions principal facility. Terminal means that the triggered transaction runs on the terminal specied by the FacilityId attribute. The terminal must exist for the transaction to run. System means that CICS allocates a Distributed Transaction Processing (DTP) conversation with the remote system specied by FacilityId before starting it up. File means that the triggered transaction runs as a nonfacility or background task, and does not have a terminal. The FacilityId attribute is ignored. The default value is le. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource denition belongs. You can specify that, for cold start, CICS copies resource denitions belonging to groups named in the Groups attribute of Region Denitions (RD) from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". IndirectQueueId (Indirect Queue Name) This ASCII text attribute provides an aliasing mechanism. The indirect destination does not point to an actual le, but to another destination. This may be extrapartition, intrapartition, or remote. It may even be another indirect destination. You enter this if an indirect queue is required. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". IOMode (Input/Output Mode of EP Queue) This attribute denes, for an extrapartition queue, whether it is read only, meaning that data is read from the queue, or write only, meaning that data is written to the queue. The possible settings are input and output, respectively. The default value is output. OpenMode (Open EP output les truncated or append) This attribute indicates whether CICS empties the output extrapartition transient data queue, or appends to the queue. The possible settings are: truncate, when the queue is emptied on startup or upon closing and reopening the queue, and append, when the queue is always appended to. The default value is truncate.
82

Note that CICS does not empty transient data queues that are set to append, and you will have to empty queues that grow too big. If CICS is offline, delete the le associated with the queue, shown in the ExtrapartitionFile attribute. If CICS is online, rst close and disable the queue using the transaction CEMT SET TDQUEUE or the CICS command EXEC CICS SET TDQUEUE, then delete the le associated with the queue, and nally open and re-enable the queue again using the transaction CEMT SET TDQUEUE or the command EXEC CICS SET TDQUEUE. See CEMT INQ/SET TDQUEUE on page 348 for information about the transaction CEMT SET TDQUEUE, or see the CICS Application Programming Referencefor information about the command EXEC CICS SET TDQUEUE. Permanent (Protect resource from modication?) This attribute species whether or not CICS permits you to amend or delete the permanent database entry. If you set the attribute to no, you can amend or delete the entry. You can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. RecordLen (Record length for xed length EP queue) This attribute denes the length of records in les used to store the extrapartition transient data queue and must be a numeric value. CICS ignores this value unless DestType=extrapartition and RecordType=xed_length. The default value is 1024. RecordTerminator (ASCII value of terminator for xed length queue) This attribute denes the record delimiter of transient data queue records and must be a three-digit character number. CICS ignores this value unless DestType=extrapartition and RecordType=byte_terminated. The default value is 0. RecordType (Record organization for EP queue data le) This attribute describes the format of the le used to store the extrapartition transient data queue. You enter one of the values: xed_length, variable_length, line_oriented, null_terminated, or byte_terminated. The default value is xed_length. RecoveryType (Recoverability type of IP queue) This attribute denes an intrapartition destination as logically recoverable, physically recoverable, or not recoverable. The possible settings are: logical, physical, and none. Logically recoverable destinations are restored (after individual transaction abnormal terminations and after region abnormal terminations) to the status they had at the end of the last completed Logical Unit of Work (LUW).
83

CICS restores physically recoverable destinations (after a region abnormal termination) to the status at the time when the abnormal termination occurred. CICS restores the last record read, enabling it to be read again if there is a possibility that the reader did not have a chance to process it. The default value is logical. RemoteName (Remote Queue Name) If the queue resides in a remote region, you enter the name by which the queue is known there. This attribute is four ASCII characters long. If you do not specify this attribute, CICS sends the local identier to the remote region. If more than one region has a destination with the same name, the local key allows the denition of an alias that routes a transient data request to a specic region. A transient data request using the alias, identies the remote name and the region to which the request is shipped. The shorthand notations %R, %H, and %S are not expanded for this attribute. For example, a value of %H really means the string %H. The default value is "". RemoteSysId (Remote System Identier) If the queue resides in a remote region, you must enter the name of a Communications Denitions (CD) entry that denes a connection to the remote region. The default value is "" meaning that the le queue resides on the local region. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing the resource. The default value is Transient Data Denition. RSLKey (Resource Level Security Key) This attribute contains the resource security key for this transient data queue, in the range 1 through 24. If the user, whose transaction issues a request to access this TDQ, does not have this RSLKey value in the RSLKeyList attribute in their User Denitions (UD) entry, CICS raises the NOTAUTH condition. Alternatively, you can specify the value public or private. With public, any user may access the queue. With private, CICS only allows access to the queue from transactions which have the attribute RSLCheck=none in their Transaction Denitions (TD) entries. The default value is private. For further information about resource security, see the CICS Administration Guide. TemplateDened (Is a user conversion template dened?) If this transient data queue can be accessed from a non-ASCII region, or if the queue contains binary or user-dened data, then you need to dene a conversion template that describes the transient data record. If such a template exists, you should set this attribute to yes, otherwise to no. The default value is no.
84

TriggeredTransId (Triggered Transaction Identier) This ASCII text attribute identies the transaction that is to be automatically initiated when the trigger level is reached. The purpose of transactions initiated in this way is to read records from the destination. If you do not specify this identier, or you enter a trigger level of zero, some other means must be used to schedule transactions to read records from the destination. This transaction may not reside in a remote CICS region. If it does, an abnormal termination occurs when an attempt is made to initiate it. The default value is "".TriggeredTransId attribute is applicable only to intrapartition queues. TriggerLevel (Trigger Level) This attribute denes the number of committed records to be accumulated before a task is automatically initiated to process them. The value must be in the range 0 through 32767. The default value is 0. TriggerLevel attribute is applicable only to intrapartition queues. WhenOpened (Time at which queue is to be opened) This attribute indicates whether CICS opens the transient data queue at startup, or on request. This condition applies to extrapartition queues only. The possible settings are: at_startup and on_request. The default value is at_startup. Note that you must use CEMT to open and close a TD queue. See CEMT INQ/SET TDQUEUE on page 348 for further information.
User Denitions (UD)

User Denitions (UD) identify users of a CICS region. A user not registered in the UD is still allowed access to the CICS region, but only has public access rights as the default userid. <Key> This represents a unique user identier, and is the key of the UD entry. User identiers are not supported by National Language Support (NLS) and can be up to eight characters, taken from the ASCII characters listed here. For all the permanent database operations, and on a runtime database insert operation, CICS performs class-specic validation of the bytes forming the database key. For users, CICS allows ASCII characters from exclamation (!) to tilde (), (33 to 126 decimal), excluding the characters '. \, #, and : . Refer to Restrictions on the use of characters on page 1 if you are using SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set this value.
85
User Denitions (UD)

Note that a user identier should not be the same as the region name, otherwise unpredictable results may occur. This is because the region name is treated as a special name by CICS security such that only TSL/RSL public access is granted. ActivateOnStartup (Activate the resource at cold start?) If you set this attribute to yes, CICS always copies the resource denition from the permanent database to the runtime database at cold start. If you set the attribute to no, CICS does not copy the resource denition, unless its group has been specied. The default value is yes. AmendCounter (Number of updates) Reserved for CICS internal use. CICSPassword (Encrypted password) This attribute contains an encrypted version of the password to be used to authenticate this user. This attribute can be set using the CICS RDO utilities or by using SMIT on CICS for AIX or SAM on CICS for HP-UX. The password is entered as plain text but is stored and displayed in its encrypted form. DCECell ((Obsolete) DCE cell name) This attribute is obsolete and has been replaced by Principal. It contained ASCII text which named the DCE cell to which this user belongs and was used by the CICS Signon (CESN) transaction as part of the authentication of a user identity. GroupName (Group to which resource belongs) This eight-byte ASCII text attribute assigns a group name to which this resource description entry belongs. You can specify that, for cold start, CICS copies resource denitions belonging to named groups from the permanent database to the runtime database, as well as copying denitions that have ActivateOnStartup=yes. The default value is "". OpID (Operator ID) A three-byte eld containing the operator identication to be associated with this user. This value is returned by the EXEC CICS ASSIGN OPID and EXEC CICS INQUIRE TERMINAL OPID commands. If your applications make use of this value, you should ensure that it is unique for all users who will access this region. The default values are: v AIX on CICS for AIX v HUX on CICS for HP-UX v SUN on CICS for Solaris v WNT on CICS for Windows NT
86
User Denitions (UD)

Permanent (Protect resource from modication?) This attribute species whether CICS permits this user to amend or delete the permanent database entry. If you set the attribute to no, this user can amend or delete the entry. The user can still amend or delete an entry with Permanent=yes by rst setting Permanent to no. If you do amend the entry, you should set Permanent back to yes afterwards. The default value is no. Principal (DCE principal of the user) This attribute contains the DCE principal for the user. You can enter either a fully qualied DCE principal name (for example /.../globalcellname/user1) or just the principal name (for example, user1). The principal name will be expanded to include the local cell name automatically. If you do not enter a principal, CICS uses the userid in the current cell (for example, if the CICS user is FRED, the principal will be /.:/FRED). If you are using DCE authentication all CICS users dened in the User Denitions must have a unique DCE principal. DCE principals cannot be shared among CICS users. The default value is "". Priority (User priority) CICS uses this attribute, in the range 0 through 255, to establish the overall transaction processing priority. The transaction processing priority is equal to the sum of the terminal priority, transaction priority, and user priority; or 255, whichever is the smaller. The processing priority of a transaction determines how quickly CICS schedules that transaction. The higher the summed value, the faster CICS schedules the task. The default value is 0. ResourceDescription (Resource description) A 30-byte ASCII text attribute describing this resource. The default value is User Denition. RSLKeyList (Resource Level Security Key List) This attribute contains the list of resource security keys for this user. CICS uses this to control access to resources when running transactions. You can specify up to 24 keys, each in the range 1 through 24, separated by the | character and enclosed in double quotation marks. Only resources whose RSLKeys are included in the RSLKeyList can be accessed by this user. Therefore, you must include the security keys of all resources needed by this user when running transactions. The following example of an RSLKeyList allows users to access resources with security keys of 1, 2, 8, and 23:
RSLKeyList="1|2|8|23"
87
User Denitions (UD)

public resources allow any user to access them. private resources prevent access from transactions which do not have the attribute RSLCheck=none in their Transaction Denitions (TD) entry. The default value is none. For further information about resource security, see the CICS Administration Guide. TSLKeyList (Transaction Level Security Key List) This attribute contains the list of transaction security keys for this user. CICS uses this to control access to transactions. You can specify up to 64 keys, each in the range 1 through 64, separated by the | character and enclosed in double quotation marks. Only transactions whose TSLKeys are included in the TSLKeyList are allowed for this user. Therefore, you must include the security keys of all transactions needed by this user. The following example of a TSLKeyList allows transactions with security keys of 1, 5, 13, and 52:
TSLKeyList="1|5|13|52"
public transactions allow any user to access them. For further information about transaction security, see the CICS Administration Guide. The default value is 1. TraceFile (User Trace lename) This ASCII text attribute contains the le name to which CICS writes user trace information. The le is located in the directory dened by the UserTraceDirectory attribute in the Region Denitions (RD). The default value is "".
88
Chapter 2. Resource denition commands and offline utilities

About the CICS commands
CICS commands can be used to congure and control your CICS system. For Windows NT, they are also used indirectly by the graphical user interface that is invoked by the command tscong. Several commands have prerequisite tasks or conditions that must be met before you can use the command. One of these conditions requires that you are logged on as a user with root (For Open Systems) or administrator (for Windows NT) privileges.
CICS on Open Systems only A user with root privileges is any userid that has system as the primary group. This userid needs to be a member of every group that root is in. (Processes can run with root privileges if the effective userid of the process is zero.) Even if a userid may meet the above criteria, but there are some commands that must be run by the native root userid.
CICS for Windows NT only For Windows NT, a user with administration privileges is any userid that is a member of the group Administrators. The following list describes how to use the CICS commands: Purpose Describes the purpose of the command. Syntax Shows the syntax of the command ags and parameters. Prerequisite Tasks or Conditions Where applicable, the command reference information lists tasks or conditions that must take place before the command can be used. Description Where necessary, provides a detailed description of how the command is used.
89
Resource denition commands

Options Describes the purpose of each ag and parameter used with the command. Returned Values Where applicable, lists each possible value returned and describes the meaning of it. Examples Provides examples of command usage and describes what the example is used for.
90
cicsadd cicsadd - Add CICS resource denitions

AIX X HP-UX X Sun Solaris X Windows NT X
Use this command to add new CICS resource denitions.
Syntax
cicsadd -c className [-r regionName] [-P | -B] [-f leName] [-m modelId] resourceName [attributeName=attributeValue ... ] cicsadd -?
Description
The Resource Denition Online (RDO) command cicsadd adds a resource denition of a given class to the permanent resources database, and can install a resource denition into the runtime database. All resource attributes are optional. If you do not set an attribute, its value is obtained from the resource denition dened by the -m parameter or from the default resource denition if you do not specify a model. You can use cicsupdate to modify the default denition. The cicsadd command initializes the data structures for the resource with default values from the reserved resource default, before overwriting them with your specied values. Stopping the command before completion can result in a damaged database. The command returns 0 if the run is successful, 1 otherwise.
Options
-c className determines the resource class to which the resource denition is to be added, and is one of these two- or three-character codes: cd fd gd gsd jd ld od Communication Files Gateways Gateway Servers Journals Listeners Objects (AIX only)
91
cicsadd
pd scd ssd td tdd tsd ud wd xad Programs SFS Schemas SFS Servers Transactions Transient Data Queues Temporary Storage Queues Users Terminals Products
-r regionName species the region to which the resource denition is added. If you do not specify a region name, CICS adds the resource denition to the region specied by the CICSREGION environment variable. The -r parameter is invalid if you specify scd, ssd, or gsd as the resource class, because these classes are associated with a collection of regions rather than with a specic one. -m modelId species the model used to supply the values for the denition that are not explicitly given in the attributeName=attributeValue pairs. If you do not specify a model, values for omitted attributes are obtained from the default denition. If the named model does not exist, an error is generated. -f leName species the le that contains the schema denitions. This ag is valid only when you specify scd (SFS schema denitions) as the resource class. -P instructs the command to add the resource denition to the permanent database, without installing it into the runtime database. This is the default option if you do not specify either the -P or -B options. instructs the command to add the resource denition to the permanent database and then to update the runtime database and install the resource denition in a running system. The -B ag is invalid if you specify gsd, scd, ssd, or xad as the resource class. If you are using DCE authentication, you must be authenticated as a DCE principal before running the command with this ag.
-B
92
cicsadd
resourceName is the name of the resource denition to be added. attributeName=attributeValue ... are the names and values of attributes for which you do not wish to use the default values or the values from the specied model. If you are using cicsadd from the command line and you want to use a metacharacter within an attribute value, you must use the shell escape mechanism. For example, to use a value of **, enter one of the following:
"**" \*\* '**'
You must use the pipe (|) character as the separator for multiple entries into Transaction Security Level (TSL) and Resource Security Level (RSL) key lists. Note: The term metacharacter refers to the following special characters: dollar ($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%), ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|), double quote (), comma (,), semicolon (;), less than (<), greater than (>), and decimal 170. The set of attributeName=attributeValue pairs depends on the class of the resource. -? causes the usage message to be displayed.
Examples
1. To add a denition for the le TEST in the region REGION1 in the permanent database only:
cicsadd -c fd -r REGION1 -P TEST ActivateOnStartup=yes
2. To add a denition for the program PROG1 in the region REGION2 in both the permanent and runtime databases:
cicsadd -c pd -r REGION2 -B PROG1 PathName=/var/cics_regions/REGION2/bin/prog1 \ ProgType=program ActivateOnStartup=yes
3. To add a denition for journal 03 to region rb in both the permanent and runtime databases (the command places the journal les in the same place as any extrapartition Transient Data Queues dened by the system):
cicsadd -c jd -r rb -B 03 RSLKey=public DiskA=j03a DiskB=j03b
93
cicscleandce cicscleandce - Remove DCE groups and CDS directories

cicscleandce removes the DCE groups and CDS directories created by the cicssetupdce command.
Syntax
cicscleandce [-I] [-v] cicscleandce -?
Description
v Unless you are migrating from a DCE cell environment to a non-DCE cell environment,you must destroy the regions and SFSs before using this command. v You must be logged on as a user with root or administrator privileges v You must be authenticated as a DCE principal (such as cell_admin) with sufficient privileges to remove a DCE group, directory or object. cicscleandce deletes the DCE groups and CDS directories listed below. Deleting the group cics_users automatically removes all accounts in this group. If one of these groups or directories does not exist, cicscleandce continues so you can use this command to clean up a partially successful execution of cicssetupdce. Errors, such as a failure to delete a CDS directory, forces cicscleandce to terminate abnormally unless the -I ag is used. The following DCE groups are deleted: v cics_admin v cics_sfs v cics_ppcgwy v cics_regions v cics_users The following CDS directories are deleted: v /.:/cics v /.:/cics/sfs v /.:/cics/ppc v /.:/cics/ppc/gateway v /.:/cics/trpc v /.:/cics/tmxa
94
cicscleandce
v /.:/cics/prole CAUTION: Do not use cicscleandce if you have any servers or regions congured or running.
Options
-I -v -? (Uppercase i) Ignores errors. Error messages are changed to warning messages and cicscleandce continues. (verbose) gives a detailed output while the command runs. displays help about the command.
Examples
To remove all DCE groups and CDS directories despite possible errors, rst log in as root or administrator and then authenticate as cell_admin, and then enter:
cicscleandce -I
95
cicscopystanza cicscopystanza command

Copies a complete stanza, or resource denition le, for a given class from one region database to another.
Syntax
cicscopystanza [[-w] -s sourceRegion] -t targetRegion -c className -k resourceName cicscopystanza -?
Description
The cicscopystanza command is used when an upgrade of CICS contains new default entries in the region database, for example, a new supplied transaction or a new model terminal. cicscopystanza adds appropriate default entries to the region database. The cicscopystanza commands are generated automatically and are included in the migration shell script which was created when you ran cicsmigrate. You can edit the cicscopystanza commands in the shell script, if, for example, you did not want to add a specic default entry to your region, or you do not want to add a new terminal.
Options
-s sourceRegion species the name of the region supplying the resource denition le. -t targetRegion species the name of the region receiving the resource denition le. -c className species the class of the resource denition le to copy. -k resourceName species the name of the resource denition le to copy. -? causes the usage message to be displayed
Examples
To copy a user denition for user1 from region1 to region2:
cicscopystanza -s region1 -t region2 -c ud -k user1
96
cicscp cicscp - CICS control program

Congures and administers COBOL, DCE, PPC Gateway servers, regions, SFS, SNA nodes, > SNA links, and telnet servers.
Syntax
cicscp [-I] [-l logFile] [-v] command objectType [options] cicscp -? cicscp
Description
The CICS control program (cicscp) is a conguration tool to congure CICS regions and associated servers. It provides an easy-to-use command line interface to a CICS conguration which supports a range of users from a new user, who will be able to congure a default region without any user input other than the region name, and to an experienced user who will be able to override any default value (where there is a purpose in overriding a default value) and use model denitions to simplify the creation of similar congurations. The commands automate as much as possible of the conguration of a machine to run a CICS region using default values where necessary and imposing some naming conventions. They also provide some exibility for customization within this framework, for example allowing the machine to be congured as a DCE client rather than a server. They support the use of an existing conguration for greater exibility, for example, allowing the use of an existing DCE conguration where a conguration such as a secondary CDS server is required. It is not intended that cicscp be the sole interface to the conguration of the underlying stack; rather that it can automate simple congurations. You should be aware of this and use the other CICS commands to create more complex congurations. This extends to the conguration of CICS itself, as cicscp does not have an update command, so an existing conguration must always be altered by the other commands. It is expected that you will begin by doing all the conguration necessary for CICS through cicscp until you need a sophisticated custom conguration.
97
cicscp
You must be logged on as a user with root or administrator privileges. Some tasks require you to be authenticated to DCE. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
-I (uppercase i) ignore errors. -l logFile produce a log of activity in logFile. -v (verbose) Show output of low-level commands used (see note 1).
command cicscp accepts the following commands: all cobol (for Open Systems) dce ppcgwy_server (for Open Systems) region sfs_server sna sna_link (for Open Systems) telnet_server -? is the ag which produces the usage message.
If no arguments are supplied to cicscp it enters an interactive mode in which you can enter a sequence of commands. Notes: 1. In normal operation, cicscp will only issue a single message indicating if the command worked or not. The effects of the -v ag are as follows: a. cicscp will send more messages to stderr identifying the step being performed, for example creating the DCE conguration. b. The standard output of the commands issued will be allowed through to the standard output of cicscp. c. When cicscp calls a CICS command that takes a -v option, cicscp will specify the -v option on the call.
98
cicscp
New users of cicscp commands should always use the -v and -l logFile options, in order to understand and keep a record of what is happening. 2. In the following pages the cicscp commands are grouped by object. For example, all the commands that affect the DCE (create, destroy, start, and stop) are together.
Examples
1. To create SFS sfs1 and ignore all errors, enter:
cicscp -I create sfs_server sfs1
2. To start SFS sfs1 and produce an activity log on mylog, enter:

cicscp -l mylog start sfs_server sfs1
99
cicscp - all cicscp - all options

Used with destroy, start and stop commands to apply them to all objects.
Syntax
cicscp destroy all cicscp start all cicscp stop all
Description
When the all option is used with the destroy, start or stop commands, the effect is to apply the particular command to all objects that cicscp can currently manage on the system. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails. Attention: Always be aware when using the all option that the command might destroy, start or stop the wrong objects.
Examples
To remove all CICS processes from the local system, enter
cicscp destroy all
This will stop all running objects and then destroy them, removing all trace of CICS processing from the local system. This includes destroying the DCE conguration, but does not include the removal of the SFS logical volumes or user identiers.
100
cicscp - COBOL commands cicscp - COBOL commands

AIX X HP-UX X Sun Solaris X Windows NT
Adds or removes Micro Focus COBOL libraries and objects.
Syntax
cicscp create cobol cicscp destroy cobol [-f]
Description
cicscp create cobol: The create command builds the default Micro Focus COBOL language method le cicsprCOBOL. If you want to include any special objects or libraries in cicsprCOBOL, you must use cicsmkcobol. cicscp destroy cobol: The destroy command destroys the Micro Focus COBOL language method le cicsprCOBOL. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
-f causes the command to execute without issuing prompts for conrmation. This only applies when using the cicscp destroy cobol command.
Examples
To create the default cicsprCOBOL, enter:
cicscp create cobol
101
cicscp - DCE commands cicscp - DCE commands

On Open Systems it creates, destroys, starts or stops DCE clients or servers. On Windows NT it creates DCE clients or servers.
Syntax
Syntax (for Open Systems): cicscp create dce { -R | [-n cellName [-s securityServer]] } cicscp destroy dce [-f] cicscp start dce cicscp stop dce Syntax (for Windows NT): cicscp create dce -R
Description
cicscp create dce: The create command creates the basic DCE conguration for either a server (a CDS server and a security server) or a client. -s parameter is supplied with either the name or the Internet Protocol (IP) address1 of the machine acting as the security server for the cell of which the client is to be part. This is not required if the DCE Security Server is on the local host. In addition to the basic DCE conguration, cicscp runs cicssetupdce (if necessary) and cicssetupclients to congure DCE for CICS. If a DCE conguration exists before cicscp is run, as long as it is a valid conguration cicscp will only create the necessary CICS conguration; it will not over-write the existing conguration. Thus, it is possible to congure a machine as only a CDS server using the DCE conguration tools and then use cicscp to do the CICS-related conguration. cicscp destroy dce:
1. Internet Protocol (IP) is the protocol that provides the packet delivery service for TCP, UDP, and ICMP.
102
cicscp - DCE commands

The destroy command stops DCE and destroys the DCE conguration of the machine. If you run the command on a client machine and the server is unavailable, cicscp will automatically remove the local conguration but the information held in the cell database regarding the machine will have to be removed manually. cicscp start dce: The start command starts the DCE on the machine, creating the default conguration rst if necessary. cicscp stop dce: On CICS on Open Systems, the stop command stops the DCE on the machine.
On CICS for Windows NT The create command congures your machine to run in RPC-only mode, that is without using DCE authentication or DCE name services. To create a DCE server conguration see related information in the CICS Administration Guide. To create a DCE client conguration see related information in the CICS Administration Guide. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
-R species that DCE is to be congured not to use DCE authentication or DCE name services.
-n cellName species the name of the cell to be created (with or without /.../). The default cell name is dce_cell.hostName.domainName. -s securityServer species the name or IP address of the security server. -f causes the command to execute without issuing prompts for conrmation.
103
cicscp - DCE commands Examples

1. To create DCE using the default cell name, enter:
cicscp create dce
2. To destroy DCE without prompts, enter:

cicscp destroy dce -f
3. To congure DCE for cell /.../test_cell.hursley.ibm.com, enter:

cicscp create dce -n /.../test_cell.hursley.ibm.com
104
cicscp - PPC Gateway server commands cicscp - PPC Gateway server commands
AIX X HP-UX X Sun Solaris Windows NT X
Creates, destroys, starts or stops PPC Gateway server servers.
Syntax
cicscp create ppcgwy_server gatewayServer [-m modelId] [attributeName=attributeValue ... ] cicscp destroy ppcgwy_server {gatewayServer | all} [-f] cicscp start ppcgwy_server {gatewayServer | all} [attributeName=attributeValue ... ] cicscp stop ppcgwy_server {gatewayServer | all} [-f]
Description
CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, refer to the Encina Administration Guide Volume 2: Server Administration manual for an alternative procedure. cicscp create ppcgwy_server: The create command creates a PPC Gateway server server on the machine. If necessary, cicsdefaultservers is run automatically. It is an error to attempt to create a server that is already dened - the old server denition must be removed rst. Each PPC Gateway server server must have a unique ShortName value in the Gateway Server Denitions (GSD), so if one is not supplied as an attribute override on the create command, cicscp chooses one which is of the form PbaseName where baseName is the rstpart of the server name, truncated to seven characters if necessary.No check is made that this name is unique, therefore the server name must be unique in the rst seven characters if the default ShortName is to be used. As an example, if the PPC Gateway server server ppcgwysrv1 were created, the default ShortName chosen would be Pppcgwys and an attempt to create ppcgwysrv2 would result in a duplicate ShortName being used and an error. If the UserID specied in the Gateway Server Denitions (GSD) for the server does not exist, cicscp will create it with the appropriate home directory.
105
cicscp - PPC Gateway server commands

If the DCE is not running, cicscp will start it, creating the default conguration if necessary. If the logical volume specied in the LogVolume attribute of the Gateway Server Denitions (GSD) does not exist, cicscp creates it. If it does exist and is owned by the correct user, cicscp issues a warning message. If it exists and is owned by a different user, cicscp issues an error message. The location and size of the logical volume are controlled by environment variables. The location is controlled by the environment variable CICS_PPCGWY_VG and the size is controlled by the environment variable CICS_PPCGWY_SIZE. There are default values coded into cicscp which means that neither environment variable needs to be set if the default values are acceptable. The default size of the logical volume created is 4MB. The default location depends on the platform. If SNA is not congured on the machine, cicscp issues a warning as the server will not be able to be started until SNA is congured and started. If the DCE name service is not being used for name resolution cicscp adds an entry for the server to /var/cics_servers/server_bindings. cicscp destroy ppcgwy_server: The destroy command stops the server if it is running and removes the server denition from CICS, but does NOT remove the user or the logical volume. If the reserved name all is used, all congured servers are destroyed. cicscp start ppcgwy_server: The start command starts the server. If necessary, it uses the create command to create a default server of the correct name. Note: Any attribute overrides specied on the start command do not affect the server created implicitly by the start command; they are only applied to the start of the server. Issuing a start command for a server that does not exist is equivalent to a create command for that server without any overrides, followed by the start command with the overrides. This means that there can in such situations be a mismatch between the attributes applied to the gateway by default, and the overrides provided with the start command, resulting in the command failing to complete successfully. If SNA is not congured the start command issues an error messages and the PPC Gateway server server is not started.
106

If the reserved name all is used, all congured servers are started and any attribute overrides specied are passed to each server. cicscp stop ppcgwy_server: The stop command stops the named PPC Gateway server, or all running servers if the reserved name all is used. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
gatewayServer is the name of the PPC Gateway server. A name that does not begin with the string /.:/cics/ppc/gateway/ will have that string added to the front of the name. -m modelId identies the existing entry on which the one to be created should be based. -f (on cicscp destroy ppcgwy_server) causes the command to execute without issuing prompts for conrmation. attributeName=attributeValue ... are overrides for Gateway Server Denitions (GSD) attributes. For more details, see the CICS Intercommunication Guide, which describes which attributes are suited to modication at startup. See also Gateway Server Denitions (GSD) on page 14. -f (on cicscp stop ppcgwy_server) forces the server to stop.
Examples
1. To create a gateway server named /.:/cics/ppc/gateway/GwyThree with attribute overrides, verbose messaging and a log le recording cicscp processing, enter:
cicscp -v -l /tmp/cicscp.log create ppcgwy_server /.:/cics/ppc/gateway/GwyThree ShortName=Gate3 ThreadPoolSize=15
Note: UserID defaults to ShortName, so cicscp will create and use the userid Gate3 for this gateway.
107

2. To start the previously created gateway with an attribute override, enter:
cicscp start ppcgwy_server GwyThree ProtectionLevel=pkt
Note: The simple name is not the same as the ShortName.
108
cicscp - region cicscp - region commands

Creates, destroys, starts or stops regions.
Syntax
cicscp create region regionName [-g groupId] [-i leName] [-l{m|o|c|r}] [-d] [-o instanceName -a aliasName [-u userName] [-n|-s] ] cicscp destroy region {regionName | all} [-f] [-s] cicscp start region {regionName | all} [-d distributedServers] [attributeName=attributeValue ... ] cicscp stop region {regionName | all} [-f|-c]
Description
cicscp create region: The create command creates the named CICS region. If the DCE is not running, cicscp starts it, creating the default conguration if necessary. If the -i option is specied then cicscp uses cicsimport, otherwise it uses cicsdefault. -d option is not specied, cicscp checks that the SFS dened as the default le server for the region is congured, creates a default conguration if it is not, and then starts the server if it is not already running. Finally cicscp congures the server for the region. Before using the region you have created, you may wish to consider using a mounted le system for the CICS log le as described in he Planning and Installation Guide. cicscp destroy region: The destroy command stops and then destroys the named region, or all congured regions if the reserved name all is used. If the -s option is specied with all it is applied to all regions. cicscp start region: The start command starts the named region, or all congured regions if the reserved name all is used. If a single region is started and it is not congured,
109
cicscp - region
a default region of the specied name is created. Any attribute overrides specied on the start command are not passed through to the create. Once the region has been created if necessary, cicscp checks that the necessary SFS and PPC Gateway servers are running, unless the type of server has been declared as remote with the -d option. If SFSs are not declared as remote, cicscp starts the default le server for the region and then browses each File Denition entry and examines the server specied for the le. If it is not running then cicscp starts it. Each of these starts could result in the implicit creation of the server if it does not already exist. If PPC Gateway servers are not declared as remote, cicscp browses the Gateway Denitions and starts each server if necessary. Each of these starts could result in the implicit creations of the server if it does not already exist. Once all the necessary servers have been started, the region itself is started. cicscp stop region: The stop command stops the named region, or all running regions if the reserved name all is used. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
regionName is the name of the region. -g groupId species the name of the group-id with which all les of the new region are created. -l{m|o|c|r} species the action that cicscp is to take if it cannot nd the target of a symbolic link. The default action is to terminate the restoration abnormally: -lm -lo Mandatory. cicscp abnormally terminates the restoration if it cannot nd the symbolic target. Optional. cicscp produces a warning message, creates the link
110
cicscp - region
and continues restoration if it cannot nd the symbolic target. This allows you to restore further regions that resolve the missing links. -lc -lr Continue. cicscp overrides any symbolic link requirements dened as part of the cicsexport command. Resolve. If cicscp cannot nd the symbolic target, it restores a physical copy of the missing denition, and produces a warning message.
-i leName species the le name of the archive copy of the resource denitions, in cpio format. If you do not specify the -i ag, the le is read from stdin. -d (on cicscp create region) indicates a distributed conguration. If this option is used, cicscp will not check for the presence of the SFS. It will assume that the SFS is dened on a different machine and that therefore its status cannot be checked. -o instanceName species the name of the instance of DB2. -a aliasName species the name of the DB2 database to be used as the le server. This name is stored in the DefaultFileServer attribute in the Region Denitions (RD). -u userName species the name to be used for explicit authentication. If this parameter is specied it will form part of the XAOpen string in the Product Denitions (XAD) entry. -n species the creation of a system-dened Product Denitions (XAD) entry specifying non-XA integration.
-s (on cicscp create region) suppresses the creation of a system-dened Product Denitions (XAD) entry all used with destroy, start or stop, causes cicscp to apply the command to all congured CICS regions.
-f (on cicscp destroy region) causes the command to execute without issuing prompts for conrmation. -f (on cicscp stop region) forces an immediate shutdown.
111
cicscp - region
-s (on cicscp destroy region) causes the deletion of le server denitions for TD, TS and local queues. -d distributedServers (on cicscp start region) indicates a distributed conguration. Valid values for distributedServers are: all sfs_server ppcgwy_server ppcgwy_server sfs_server -c forces a cancel shutdown. cicsnotify is run automatically.
attributeName=attributeValue ... are the overrides for Region Denitions (RD) attributes. See Region Denitions (RD) on page 32.
Examples
1. To create a region called REGION1, copying the denitions from a le called REGIONFILE enter:
cicscp create region REGION1 -i REGIONFILE
2. To start all regions, specifying a distributed SFS, enter:

cicscp start region all -d sfs_server
3. To start the region TestReg with verbose messaging and a log le recording cicscp processing, enter:
cicscp -v -l /tmp/cicscp.log start region TestReg
This will create the region TestReg (using cicsdefault) and will congure it for the default SFS. Additional processing will be done for SFS and DCE as necessary.
112
cicscp - SFS cicscp - SFS commands

Creates, destroys, starts or stops SFS.
Syntax
cicscp create sfs_server serverName [-m modelId] [attributeName=attributeValue ... ] cicscp destroy sfs_server {serverName | all} [-f] cicscp start sfs_server {serverName | all} [attributeName=attributeValue ... ] cicscp stop sfs_server {serverName | all} [-f]
Description
cicscp create sfs_server: The create command creates a SFS server on the machine. If necessary, cicsdefaultservers is run automatically. It is an error to attempt to create a server that is already dened - the old server denition must be removed rst. Each SFS server must have a unique ShortName value in the Structured File Server Denitions (SSD) so if one is not supplied as an attribute override on the create command, cicscp chooses one which is of the form SbaseName where baseName is the last part of the server name, truncated to the rst seven characters if necessary. No check is made that this name is unique, therefore the server name must be unique in the rst seven characters if the default ShortName is to be used. As an example, if the SFS server sfssrv1 were created, the default ShortName chosen would be Ssfssrv1 and an attempt to create sfssrv11 would result in a duplicate ShortName being used and an error. If the UserId specied for the server in the Structured File Server Denitions (SSD) does not exist, cicscp will create it with the appropriate home directory. If the DCE is not running, cicscp will start it, creating the default conguration if necessary (on Open Systems). On Windows NT cicscp starts it only if the DCE is already congured.
113
cicscp - SFS
There are two logical volumes associated with each SFS server: the logical volume for the le data, specied by the Structured File Server Denitions (SSD) attribute DataVolume, and the logical volume holding the recovery information, specied by the attribute LogVolume. If either logical volume specied does not exist, cicscp creates it. If either does exist and is owned by the correct user, cicscp issues a warning message. If either exists and is owned by a different user, cicscp issues an error message. The location and size of each logical volume are controlled by environment variables. There is a pair of environment variables that controls both logical volumes and there is also a separate pair for each logical volume, allowing each to be controlled separately. If one of the environment variables corresponding to a particular logical volume is set, it takes priority over the corresponding general environment variable. The location is controlled by the general environment variable CICS_SFS_VG and the separate environment variables CICS_SFS_DATA_VG and CICS_SFS_LOG_VG. The size is controlled by the general environment variable CICS_SFS_SIZE and the separate environment variables CICS_SFS_DATA_SIZE and CICS_SFS_LOG_SIZE. There are default values coded into cicscp which means that none of these environment variables needs to be set if the default values are acceptable. The default size of both the data and log logical volumes is 64MB. The default location depends on the platform, on CICS for AIX it is rootvg and on CICS for HP-UX it is vg00. If the DCE name service is not being used for name resolution cicscp adds an entry for the server to /var/cics_servers/server_bindings. cicscp destroy sfs_server: The destroy command stops the server if it is running and removes the server denition from CICS, but does not remove the user or the logical volumes. If the reserved name all is used, all congured servers are destroyed. cicscp start sfs_server: The start command starts the server, creating a default server of the correct name if necessary. Note: Any attribute overrides specied on the start command do not affect the server created implicitly by the start command; they are only applied to the start of the server. Issuing a start command for a server that does not exist is equivalent to a create command for that server without any overrides followed by the start command with the overrides. This means that there can in such situations be a mismatch
114
cicscp - SFS
between the attributes applied to the server by default, and the overrides provided with the start command, resulting in the command failing to complete successfully. If the reserved name all is used, all congured servers are started and any attribute overrides specied are passed to each server. cicscp stop sfs_server: The stop command stops the named SFS gateway server, or all running servers if the reserved name all is used. You must be logged on as a user with root or administrator privileges. If you are using DCE authentication, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
serverName is the name of the server. A simple name (one without a leading /.:/cics/sfs/ string) will have the string added to the front of the name. -m modelId identies the existing entry on which the one to be created should be based. If you do not specify a name, the server is modeled on the default Structured File Server Denitions (SSD). attributeName=attributeValue ... are the overrides for Structured File Server Denitions (SSD) attributes. See Structured File Server Denitions (SSD) on page 61. all used with destroy, start or stop, causes cicscp to apply the command to all congured or running servers.
-f (on cicscp destroy sfs_server) causes the command to execute without issuing prompts for conrmation. -f (on cicscp stop sfs_server) forces an immediate shutdown.
Examples
1. To create an SFS named /.:/cics/sfs/SrvOne with attribute overrides, verbose messaging and a log le recording cicscp processing, enter:
115
cicscp - SFS
cicscp -v -l /tmp/cicscp.log create sfs_server /.:/cics/sfs/SrvOne \ ShortName=Sfs1 BufferPoolSize=1250
2. To start server /.:/cics/sfs/SrvTwo with an attribute override, enter:

cicscp start sfs_server SrvTwo MRAArchivingEnabled=yes
Note: This example is doing an implicit create, so specifying ShortName=Sfs2 would not work because the ShortName default would have been used during the create. 3. To start all SFSs, assuming that they can all be autostarted, enter:
cicscp start sfs_server all
116
cicscp - SNA cicscp - SNA commands

AIX X HP-UX Sun Solaris Windows NT X
On Open systems this command creates, destroys, starts or stops SNA while on Windows NT it starts or stops SNA.
Syntax
cicscp create sna -d nodeName -w networkName -x XIDname -y stationType [-q stationName] [-s stationAddress] [-b localSecondaryStationAddress] cicscp destroy sna [-f] cicscp start sna cicscp stop sna
Description
On CICS on Open Systems the cicscp create sna command creates, activates and veries an SNA conguration. Following this command, the node is ready to operate as a node on an APPN network. On CICS for Windows NT the cicscp start/stop sna commands try to start or stop the IBM Communications Server. If this server is not found, the commands try to start or stop the Microsoft SNA Server. If you are using DCE authentication and the task you are performing requires you to be logged in as the DCE cell administrator, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails. For more information, see the CICS Intercommunication Guide.
Options
-d nodeName species the name of the SNA node. -w networkName species the control point name of the local SNA node.
117
cicscp - SNA
-x XIDname species the exchange identier associated with the control point name of the local SNA node. -y stationType species an initial link station type. For CICS for AIX, any type supported by SNA Services is valid. -q stationName species the name of the initial link station. If a dynamic listening link station is required this value can be omitted. This type of station is only supported over token ring and ethernet. -s stationAddress species the address of the local link station if this is a listening link, or of a remote link station if it is a calling link. -b localSecondaryStationAddress species the local secondary station address for SDLC link stations. -f causes the command to execute without issuing prompts for conrmation.
Examples
On CICS for AIX, to create an SNA node called AIX00005 using a token ring with a link station called LINKVTAM at address 400012345678, enter:
cicscp create sna -d AIX00005 -w MYSNANET -x 07101234 \ -y token_ring -q LINKVTAM -s 400012345678
118
cicscp - SNA link cicscp - SNA link commands

AIX X HP-UX Sun Solaris Windows NT
Creates or destroys SNA links.
Syntax
cicscp create sna_link stationName -y stationType [-s stationAddress] [-b localSecondaryStationAddress] cicscp destroy sna_link stationName -y stationType [-f] If you are using DCE authentication and the task you are performing requires you to be logged in as the DCE cell administrator, cicscp prompts you for a password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails. The cicscp create sna_link command creates and veries an SNA link.
Options
stationName is the name of the link station. -y stationType species an initial link station type. For CICS for AIX, any type supported by SNA Services is valid. -s stationAddress species the address of the local link station if this is a listening link, or of a remote link station if it is a calling link. -b localSecondaryStationAddress species the address of the local secondary station for SDLC link stations. -f causes the command to execute without issuing prompts for conrmation.
The environment variable XID_NODE_ID is required to be set. This identies the XID name of the PU concerned. Creation of token ring link stations (type LLC2) requires a token ring station TRN-O to be dened in the running Peer Server. Local SNA conguration le
119
cicscp - SNA link

creation will create this.
120
cicscp - telnet server cicscp - telnet server commands

Creates or destroys telnet servers.
Syntax
cicscp create telnet_server serverName [-P portName] [-c clientCodeset] [-e emulation] [-h hostList][-k keytabFile] [-l localeName] [-m modelId] [-n netName] [-p principalName] [-r regionName] [-s serverCodeset] [-t transId] cicscp destroy telnet_server {serverName | all} [-f]
Description
cicscp create telnet_server: The create command creates a telnet server conguration that can be used with inetd. On Windows Nt inetd runs as an NT Service. A shell script is automatically created in /var/cics_clients for each telnet server created by cicscp containing the arguments to the cicsteld command. -p option, it is added to the DCE group cics_users if it is not already in the group. If no keytab le is specied using the -k option, cicscp creates one in /var/cics_clients. If no principal is specied, no DCE principal or keytab le will be created. If you are not using DCE authentication or if you are using DCE authentication but you want to use the default keytab le created in /var/cics_clients by cicssetupclients, then you should not specify a principal. The -m ag allows all parameter values except netName (which must be unique) to be copied from the telnet server named with the -m parameter. It may not be possible for cicscp to retrieve the parameter values from the model server if the server was not created by cicscp, or the shell script has been edited after the server was created. cicscp destroy telnet_server: The destroy command destroys a telnet server conguration, but it does not remove the DCE principal. If you are using DCE authentication and the task you are performing requires you to be logged in as the DCE cell administrator, cicscp prompts you for a
121
cicscp - telnet server

password if you are running interactively, you have not set the cell_admin_pw environment variable, and the cell_admin password is not the default password (-dce-). If you are not running interactively, have not set the cell_admin_pw environment variable, and the password is not the default, the command fails.
Options
serverName is the name of the server. This name must be different from every other name used in the le /etc/services. cicscp create telnet_server will add an entry to /etc/services for the specied server and cicscp destroy telnet_server will delete the entry. -P portName species the port to be used. This port name must be unique, and will be chosen automatically if omitted. -c clientCodeset species the client codeset. -e emulation species the type of 3270 to emulate. -h hostList species a blank-delimited list of names or addresses of hosts to be searched for the specied region. If a list of host names is not specied, the contents of the environment variable CICS_HOSTS will be used. If the environment variable CICS_HOSTS is not set, the local machine will be searched. -k keytabFile species the name of the keytab le. -k option is not specied but the -p option is used, then cicscp will create a keytab le. -l localeName species the name of the locale. -m modelId species the model denition on which the one to be created should be based. -n netName species the network name. -p principalName species the name of the principal to be used for DCE authentication of this CICS telnet server. -r regionName species the region to connect to. If no region is specied, a menu of regions will be displayed.
122
cicscp - telnet server

-s serverCodeset species the server codeset. -t transId species the initial transaction. The default is CESN. -f causes the command to execute without issuing prompts for conrmation.
Examples
To create a telnet server called TELNX1 on port 9001 listening for a request to access REGION1, enter:
cicscp create telnet_server TELNX1 -P 9001 -r REGION1
123
cicscvt cicscvt - Create data conversion table

cicscvt is used to build conversion templates from DFHCNV macro conversion les.
Syntax
cicscvt leName cicscvt -?
Description
The cicscvt command is a utility that converts a macro source conversion table containing DFHCNV macros into a conversion template for each resource dened in the table. cicscvt creates a conversion template for each DFHCNV macro in the input le. The name of the conversion template created is resourceName.resourceType.cnv, where resourceName is the name coded as the RNAME parameter, and resourceType is the type coded as the RTYPE parameter. To use the template it must be moved or copied to
/var/cics_regions/regionName/database/resourceType/resourceName.cnv
Options
leName species the name of the le to be processed. -? causes the usage message to be displayed.
Returned Values
0 The table was successfully converted. non-zero The templates were not created successfully.
Examples
If le TESTCNV contains the macro:
DFHCNV TYPE=ENTRY,RTYPE=PC,RNAME=TEST
it can be converted and installed for region regionName by using the commands:
124
cicscvt
cicscvt TESTCNV mv TEST.PC.cnv /var/cics_regions/regionName/database/PC/TEST.cnv OR copy TEST.PC.cnv /var/cics_regions/regionName/database/PC/TEST.cnv
The mv command is used on UNIX platforms. The copy command is used on Windows NT.
125
cicsdb2conf cicsdb2conf - Congure DB2

You use this command to congure CICS resource denitions for DB2 and to congure DB2 to manage CICS queues and les.
Syntax
cicsdb2conf [-I] [-m] -r regionName [-l logFileName] { -C -i instanceName -a aliasName [-f] [-n|-s] [-u userName[,password]] [-g] | [ -S] |[ -N] |[ -D] |[ -P] |[ -T] |[ -L] |[ -Q ] ... } cicsdb2conf -?
Description
You must be logged in with DB2 sysadm authority. The command cicsdb2conf congures the resource denitions in the CICS region to meet the requirements of DB2 and adds the necessary tables to the DB2 database. You run cicsdb2conf from the operating system command line.
Options
-I -m causes non-critical errors to be ignored. species that cicsdb2conf should set the IndexName for each le dened in the File Denitions (FD) by appending 0 to its key.
-r regionName species the name of the CICS region for which you are conguring DB2. -l logFileName species the name of the le to be used for logging conguration messages. If this parameter is not specied the le regionName/data/cicsdb2conf.log will be used. -C species the complete conguration of DB2 for the region and the conguration of the region resources for DB2. The ags -i, -a, -n, -f, -s, -u and -l are valid when this option is specied.
-i instanceName species the name of the instance of DB2.
126
cicsdb2conf
-a aliasName species the name of the DB2 database to be used as the le server. This name is stored in the DefaultFileServer attribute in the Region Denitions (RD). -f By default, the Fileserver attribute for all File Denitions (FD) entries is set to NULL and the default specied by the DefaultFileServer attribute in the Region Denitions (RD) is used. If this option is specied the FileServer attributes are not set to NULL. species the creation of a system-dened Product Denitions (XAD) entry specifying integration through the DB2 single-phase commit optimization. If this ag is not specied cicsdb2conf will place a new default entry in the XAD that will allow the region to connect to the aliasName database through the XA interface. suppresses the creation of a system-dened Product Denitions (XAD) entry. An XAD entry is required in order to specify a DB2 database that will manage the CICS regions queues and les. If this ag is not specied cicsdb2conf will create a new default entry in the XAD that will allow the region to connect to the aliasName database. The use of this ag allows you to dene your own XAD entry for the aliasName database.
-n
-s
-u userName[,password] species the user name to be used for explicit authentication. If this parameter is specied, it forms part of the XAOpen string in the Product Denitions (XAD) entry. If the password is not specied, CICS prompts you to enter it. -g grant minimum privileges. If this ag is specied, cicsdb2conf will grant EXECUTE authority to allow the userid that CICS uses to connect to the database to execute the CICS le and queue management package. If this ag is not specied, cicsdb2conf will grant DBADM authority to the userid that CICS uses to connect to the database. -S species that a table for recoverable auxiliary TSQs is to be created. The name of the table will be regionNameREQTSQ#. The table will be recoverable. species that a table for non-recoverable auxiliary TSQs is to be created. The name of the table will be regionNameNREQTSQ#. The table will be recoverable since non-recovereable tables are not supported by DB2. species that a table for logically recoverable TDQs is to be created. The name of the table will be regionNameLOGTDQ#. The table will be recoverable.
-N
-D
127
cicsdb2conf
-P species that a table for physically recoverable TDQs is to be created. The name of the table will be regionNamePHTDQ#. The table will be logically recoverable since physically recoverable tables are not supported by DB2. species that a table for non-recoverable TDQs is to be created. The name of the table will be regionNameNREQTDQ#. The table will be recoverable since non-recoverable tables are not supported by DB2. species that a table for locally queued protected STARTs is to be created. The name of the table will be regionNameLQPROT#. The table will be recoverable. species that a table for locally queued unprotected STARTs is to be created. The name of the table will be regionNameLQUE#. The table will be recoverable. causes the usage message to be displayed.
-T
-L
-Q
-?
Returned Values
0 DB2 has been congured. non-zero The attempt to congure DB2 was unsuccessful.
Examples
1. To congure DB2 for REGION1 with default parameters, using alias CICSTEST for instance DB2USER:
cicsdb2conf -r REGION1 -C -i DB2USER -a CICSTEST -n
128
cicsdb2import cicsdb2import - Build metadata for DB2

Use this command to dene les to a DB2 database.
Syntax
cicsdb2import -i schemaFileName [-d databaseName] [-u userName [p passWord]] [-I] [-f leName [-x indexName] ... ] cicsdb2import -? v You must be logged on as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v You must have a running DB2 database available for connection. v You must be authorized to connect to the database. v You must have a schema le containing the necessary le denitions. A schema le can be created by using cicsadd -cscd ... or by using SMIT on CICS for AIX or SAM on CICS for HP-UX.
Description
The cicsdb2import command allows you to create les on a DB2 database based on the information provided in a schema le. You can specify which database a le is to be created on, and you can optionally select which les are created from those dened within the schema. You can also select which indexes are to be created from those dened for a particular le in the schema. You run cicsdb2import from the operating system command line.
Options
-I causes non-critical errors to be ignored. -i schemaFileName species the name of the le containing the schema denition. -d databaseName species the name of the database to which connection is required. If the name of the database is not specied, the name contained in the environment variable DB2DBDFT is used.
129
cicsdb2import
-u userName species the name of the user to be used for explicit authentication. If the user name is not specied, implicit authentication is used. -p passWord species the password to be used for explicit authentication. If the password is not specied, you will be prompted to enter the password. -f leName species the name of the le to be loaded from the schema. If no le name is specied, all les in the schema are loaded. -x indexName species the name of an index to be loaded. If no index name is specied, all indexes for the specied le are loaded. -? causes the usage message to be displayed.
Returned Values
0 The le or les were successfully loaded into the database. non-zero The import operation was unsuccessful.
130
cicsddt cicsddt - DB2 diagnostic tool

The CICS DB2 diagnostic tool (DDT) provides an interactive interface to DB2.
Syntax
cicsddt [-s databaseName] [-i inputFile] [-o outputFile] [-e] [-r] [-c DDTcommands ...] cicsddt -?
Description
v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v You must have a running DB2 database available for connection. v You must be authorized to connect to the database.
Options
Note: Except for -c, which must be the last parameter, the parameters can be in any order. -s databaseName species the name of the DB2 database. For example, cicstest. If this option is not specied, the server name in the environment variable CICS_XDT_SERVER or DB2DBDFTis used. -i inputFile species a text le containing DDT commands to be read and executed. The le can be created either by hand or by using the -o option. Each line of the input le is treated as if it were typed in interactive mode. The text from the input le is also displayed as it is processed by cicsddt. Comments can be included in the le by starting a line with /*. For example, if you create a le called create.input that contains the following lines:
/* /* This is a sample file to create a table called qsamtest /* create cics.qsamtest k fl char 10 f2
131
cicsddt
varchar 100 f1 a quit
Then execute cicsddt as follows:

cicsddt -s databaseName -i create.input
A new table called CICS.QSAMTEST is created on the specied database. -o outputFile causes commands entered in the DDT session to be written to the specied output le. This le can then be used as an input le using the -i option. -e requests DDT to terminate if an error occurs. If -e is specied and DDT is being driven from a shell script (-i) or the command line (-c), any error resulting from a command will exit DDT with a non-zero return code. activates DDT statistics. Statistics for DDT and DB2 calls are sent to a le called ddt.stats in the current directory. This is useful for monitoring performance.
-r
-c DDTcommands ... species a list of commands and text to be used in the DDT session. This is useful for calling DDT commands from a shell script. This parameter must be used last. Using the DDT commands: To issue commands in DDT, pass them to DDT using the -i or -c option, or type the command at the command prompt. DDT accepts command abbreviations. In the command syntax the minimum abbreviation is shown in parentheses; for example, (c)reate. Any command that requires a le name will default to the last name used if nothing is given at the prompt. DDT also recognizes any environment variables used at the command prompt. DDT commands - list (l)ist [(l)] searchString Lists all the tables on the database that DDT is accessing. l option is used,additional information is given for each table. Only tables owned by the user cics will be shown. A search string can also be given to list specic les. If a search string is used, DDT will look for all the
132
cicsddt
lenames that contain the string. There are no wild card characters, so the search string is taken as entered.
cicsddt -s cicstest -c li l jim Table Name ======================= CICS.JIM6CICSNLQFILE CICS.JIM6CICSNRECTSQFIL CICS.JIM6CICSPLQFILE CICS.JIM6CICSRECTSQFILE CICS.JIM6CICSTDQLGFILE CICS.JIM6CICSTDQNOFILE CICS.JIM6CICSTDQPHFILE Organisation ==================== Key-Sequenced (KSDS) Key-Sequenced (KSDS) Key-Sequenced (KSDS) Key-Sequenced (KSDS) Key-Sequenced (KSDS) Key-Sequenced (KSDS) Key-Sequenced (KSDS) Primary Index No. Records ============== =========== CICSNLQIDX (empty) CICSNRECTSQIDX (empty) CICSPLQIDX (empty) CICSRECTSQIDX 2 CICSTDQLGIDX 11 CICSTDQNOIDX (empty) CICSTDQPHIDX (empty)
DDT commands - create (c)reate tableName Creates a new DB2 table. All the table information is prompted for in turn. To aid usability and eliminate creation errors, DDT will validate as much as possible and default to sensible values where appropriate. One exception is the table column name and index column name that use an empty entry to indicate there are no more columns. If q! is entered at any prompt the create is cancelled.
cicsddt -s cicstest -c create cics.qsamtest [File Type [Ksds/Esds/Rrds] .: K[sds] [Column 01: Name ............: f1 [Column 01: Type ............: Error: Invalid column type. Type must be: char, varchar, long varchar or graphic. [Column 01: Type ............: char [Column 01: Size ............: 10 [Column 02: Name ............: f2 [Column 02: Type ............: varchar [Column 02: Size ............: 100 [Column 03: Name ............: [Primary Index Name .........: CICS.QSAMTEST0 [Index Part 01: Column Name .: f1 [Index Part 01: Ordering ....: a[scending] [Index Part 02: Column Name .:
DDT commands - read (r)ead tableName Reads rows from a CICS DB2 table. Rows can be read from the beginning of the table or from a specic key based on any existing index. Rows can also be read continuously or individually. When a key value is specied it is taken as a string unless it is in the format
133
cicsddt
#n, where n is a numeric value. The following format can be used for a hexadecimal representation of the key:
0x0a01 ...
If the read is not continuous you have the option to delete or update each row read. If nothing is entered for a column during an update the column is left unaltered, otherwise data entry is same as for the write command. The read command will only show up to 44 bytes of column data and should therefore not be used to check the data integrity of tables containing long columns. The dtof command is more suitable for this.
cicsddt -s cicstest -c r cics.qsamtest [Index To Use ...............: QSAMTEST0 [Read From Beginning ? [Y]/N : Y [Continuous Read ? Y/[N] ....: N [Read #00000001 [F1 ][KEY0001... [Hex][4B455930303031000000 [F2 ][Data providing information about KEY0001 [Hex][446174612070726F766964696E6720696E666F726D6174 [Read Another, Delete or Update ? [Y]/N/D/U n [1 Record(s) Read] ][000010] ] ][000040] ]
DDT commands - write (w)rite tableName Writes rows to a CICS DB2 table. Text or hexadecimal data can be entered in each column; these cannot be mixed. Hexadecimal is entered in the following form:
0x010203 ...
If the column is long and you need to enter a large amount of data, a shorthand method can be used. For example, to ll the remainder of a column with 33 A characters enter:
A>>32
or enter
0x20>>32
for 33 spaces.
134
cicsddt
You must enter something in at least one of the columns in the row for DDT to write a complete row; if all are left blank no row will be written. If A>>32 would exceed the column length the string A>>32 is taken literally.
cicsddt -s cicstest -c -w qsamtest [F1 ][ CHAR [KEY0000002 [F2 ][ VARCHAR [This the data that comes with KEY 2 [Another ? [Y]/N n [1] Record(s) Added OK. ][ Size:00010] ][ Size:00100]
DDT commands - empty (e)mpty tableName Empties a table of all committed rows.
cicsddt -s cicstest -c empty qsamtest [Empty Table "CICS.QSAMTEST" ? Y/[N] y
DDT commands - delete (d)elete tableName Deletes a table from the CICS DB2 database.
cicsddt -s cicstest -c delete qsamtest [Delete Table "CICS.QSAMTEST" ? Y/[N] y
DDT commands - addindex (a)ddindex tableName Adds a secondary index to the CICS DB2 table. Typing q! will cancel the command.
cicsddt -s cicstest -c a angus [Secondary Index Name........: index2 [Index Col. 01: Column Name .: f2 [Index Col. 01: Ordering ....: a[scending] [Index Col. 02: Column Name .:
DDT commands - delindex (deli)ndex tableName Deletes a secondary index from the CICS DB2 table.
cicsddt -s cicstest -c delindex angus [Secondary Index Name........: index2
135
cicsddt
DDT commands - info (i)nfo tableName Shows detailed information about the DB2 table.
cicsddt -s cicstest -c i angus [Information For Table: CICS.ANGUS ] -----------------------------------------------------------------[Table Organization ] Key-Sequenced (KSDS) [Primary Index Name ] ANGUS0 (Unique index) [Primary Index Column(s) ] F1 [Secondary Index Names ] (None defined) [Number Of Records In Table ] 0 [Number Of Columns Per Row ] 3 [Column 001: F1 ][CHAR ][Size: 5] [Column 002: F2 ][CHAR ][Size: 5] [Column 003: F3 ][CHAR ][Size: 5] ------------------------------------------------------------------
DDT commands - database (da)tabase databaseName Drops the current DDT database connection and attempts to connect to a new DB2 database. If the new connection fails DDT will reconnect to the old database.
cicsddt -s cicstest -c da sample ERZ037070I/0740: Contacting database ... ERZ037172I/0738: (Database OK)
DDT commands - user (u)ser userName,password Reconnects to the current DB2 database with the new user. If connection with the new user fails, DDT reconnects with the old user and password.
cicsddt -s cicstest -c u acooke,jg8wq9z ERZ037172I/0738: (Database OK)
DDT commands - qtod (qt)od QSAMleName Transfers and converts a QSAM table to a DB2 table.
cicsddt -s cicstest -c qtod qsam [Default Code Pages: EBCDIC (IBM-037) -> ASCII (ISO8859-1) ... [Transferring Records. Record No.][00000022]
DDT commands - dtof
136
cicsddt
(dt)of DB2tableName Transfers a CICS DB2 table to a at table. The format of the at le can either be DDT format or Asis (the table is transferred byte by byte as it is). In DDT format the at le starts with a header containing information on the structure of the table, followed by an end-of-header marker. The remainder of the at le contains the actual records that are in the format: a newline character, followed by an eight-byte ASCII number, followed by the actual data.The number is the length of the row excluding the number itself. If the table is transferred Asis, no extra information is contained in the at le. A single record or a range of records can be dumped. The record number corresponds to the position of the row using the primary index. To dump row 10 enter 10 at the [Dump Row(s)] prompt. Type 10- to dump rows from 10 onwards and type 10-12 to dump rows 10 to 12 inclusive.
cicsddt -s cicstest -c dtof CICS.RRDS [Flat Filename ..............: CICS.RRDS.ddt [Dump table Asis ? .... Y/[N]: N [Dump Row(s) ................: ALL [Dumping All Rows] [Dumping Row #][00000003]
DDT commands - ftof (f)tod DB2tableName Transfers a at table produced from the dtof command to a CICS DB2 table. If the at table is not in DDT format then dtof will still attempt to transfer the le as normal text or binary. If the DB2 table does not exist and the at le is in DDT format, DDT will ask you if you want the le to be created. DDT also reads and transfers at les created by cicssdt (in SDT format).
cicsddt -s cicstest -c f CICS.RRDS [Flat Filename ..............: CICS.RRDS.ddt [Loading Record #][00000003]
DDT commands - ! ! Escapes to a system command prompt. Exiting from the command prompt returns control to DDT.
cicsddt -s DB2name -c ! [Exit To Shell. Use <Ctrl-D> To Return .....
137
cicsddt
ls q* (Open Systems) dir q*.* /w (Windows NT) qsam qsam.dfh qsam.conv qsam.log qsam.def qsam.ddt.def
qsamTest qsamcsd qsamcsd.dfh
qsamcsd.ddt.def qsamcsd.ddt.log qtest
DDT commands - quit Exits DDT and returns control to the calling process. (q)uit
cicsddt -s cicstest -c q
DDT commands - help or ? (h)elp (or ?) commandName Gives general or specic online help for DDT commands.
cicsddt -s cicstest ? create
DDT commands - QSAM to DB2 le transfer The purpose of this section is to help you understand how to transfer QSAM les from a IBM mainframe-based CICS system to a CICS on Open Systems system (the target system). When a le is sent directly to a target system, record boundaries are lost when it is received. By capturing the le on TSO or CMS in netdata format and sending it as a binary le to the target system using the File Transfer Program (ftp), the original netdata format is preserved. The cicsnetdata program is used to read the le and re-construct the output records with the count preceding each record, as expected by the cicsddt qtod command. If a le is in netdata format, you will nd that control records INMR01, INMR02, INMR03 precede the data, and INMR06 follows the data; these names are in EBCDIC. All input (control records and data) is segmented. The rst byte of a segment contains the segment length, including itself. The second byte of the segment contains a ag byte. The ag settings are:
0x80 first segment 0x40 last segment 0x20 segment is part of a control record
To transmit a le from TSO: 1. Enter: TRANSMIT (nodeName/userId) DSN(data.le) OUTDSN(data.NETDATA) SEQ TRANSMIT can be abbreviated to XMIT.
138
cicsddt
nodeName/userId is required syntactically. Although it is not used when transmitting to a le, it is validated, so specify a known node and userid. DSN names the input to XMIT. OUTDSN names the output netdata le. The type NETDATA is suggested. If the input was a PDS member, then SEQ is required, or the le will not be usable on the target system. The name of utility function must be INMCOPY for correct results (see sample messages below). 2. Enter: ftp systemName where systemName is the name of the target system. Enter userid and password when prompted. 3. Enter: cd directoryName to change to the target directory if necessary. 4. Enter: binary to set the transmission type to I (image). 5. Enter: put data.NETDATA The target le name can also be specied, if different from the source. Make a note of the byte count, which should be the same for the le on the target system. The target system keeps the name in lower case, even though it was upper case in TSO. To transmit a le from CMS: 1. Enter: sendle dataFile TO * to send the le to your reader in netdata format. Do not RECEIVE it, because RECEIVE will decode the netdata. Use CP commands to ORDER it and CHANGE its CLASS to suit the reader. Dene a temporary disk if the le is large. 2. Enter: read data NETDATA A to read the le and preserve the netdata format. 3. Enter: ftp systemName systemName is the name of the target system. Enter userid and password when prompted. 4. Enter: cd directoryName to change to the target directory if necessary. 5. Enter: binary to set the transmission type to I (image). 6. Enter: put data.NETDATA The target le name can also be specied, if different from the source. Make a note of the byte count, which should be the same for the le on the target system. The target system keeps the name in lower case, even though it was upper case in CMS.
139
cicsddt
To run the cicsnetdata program:
cicsnetdata < data.netdata > outputFileName
Messages from a sample run of cicsnetdata (origin CMS)

... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... control record: INMR01 logical record length origin node name origin userid BAILEYM target node name target userid * origin time stamp no of files 1 control record: INMR02 file number 1 file size in bytes file organization logical record length name of utility function record format 8000 name of the file filemode number0 last change date control record: INMR03 file size in bytes file organization logical record length record format 0001 control record: INMR06 22 input records 4 control records 18 output records 80 WINVMB WINVMB 19931029164640000000
2048 4000 80 INMCOPY A DATA FILE 19920611095242000000 2048 4000 80
Denition les used by qtod: In addition to the QSAM data le produced by the cicsnetdata program there must be two other denition les for a successful conversion: v QSAMleName.ddt.def This le must be in the same directory as the QSAM data le. It contains the key and data information about each QSAM record. The sample le qsam.sdt.def, describes what each tag means. A sample data le can be found in prodDir/src/examples/sdt. The le must be renamed to qsam.ddt.def for qtod to pick it up. The tag SFSFile=qsamtest must also be changed to DB2File=CICS.QSAMTEST. v QSAMleName.dfh This le must also be in the same directory as the QSAM data le and is the DFHCNV template source for the QSAM records. DDT will not validate this le so it is recommended that the le is checked using the cicscvt program rst. DDT only understands the source, not the compiled output from cicscvt. The sample le qsam.dfh shows a typical template.
140
cicsddt
To run qtod: A sample QSAM data le qsam.netdata has been provided to demonstrate QSAM to DB2 conversion using the qtod command. The following describes the steps necessary to convert this example: 1. Convert qsam.netdata to DDT-readable format using the cicsnetdata program as follows:
cicsnetdata < qsam.netdata > qsam
to produce a le called qsam in the current directory. 2. Create a suitable DB2 table to receive the QSAM records. For this example, enter
cicsddt -s DB2name -c create qsamTest
3. Make sure you have the following les in a directory you can write to:
qsam qsam.dfh qsam.ddt.def
The default code pages for conversion are dened at the top of the table qsam.dfh; these may have to be changed, depending on your operating system. 4. Run cicsddt so that it is working with the database that has CICS.QSAMTEST on it, Enter:
cicsddt -s DB2name -c qtod qsam
The le qsam must be in the current directory. DDT will show a running count of the records being transferred. If an error occurs the table must be emptied before it is reloaded. 5. When the command has nished the DDT prompt should reappear and a log le will have been created in the current directory. The le will be called qsam.ddt.log in this example. Check this log le to make sure DDT picked up all the record types and there were no conversion errors.
141
cicsdefault cicsdefault - Create a copy of the default region

The purpose of the cicsdefault command is to allow you to restore an archive copy of the resource denitions from the default CICS region.
Syntax
cicsdefault -r regionName [-g groupId] [-v] [-S] [-F] cicsdefault -?
Description
v You must be logged on as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication you must have a DCE context that has sufficient authority to: Create a DCE principal and account Create a Server Key Table. Usually this is a DCE cell administrator. The cicsdefault command restores the resource denitions from the default CICS region to your new region. You run cicsdefault from the operating system command line. The resource denitions that cicsdefault restores are: v All conguration les except those dening the SFS. These will have to be recongured. v All resource denitions v Conversion templates v All programs v All maps v All Java classes v The contents of the regions data directory. The region environment and region properties les are not restored. You are prompted for your DCE password if you are using DCE authentication.
142
cicsdefault Options
-r region is the name of the new region. Do not use underscores or the word stanza in the region name. -g groupId is the name of the operating systems groupId with which all les of the new region are created. The default groupId is cics (Open Systems) or cicsgroup (Windows NT). -v -S (verbose) lists the les as they are restored. causes the new region to be set up without using DCE servers. The Region Denitions (RD) attributes NameService and AuthenticationService will be set to none and CICS respectively. forces the region to be overwritten if the region already exists, but does not recreate DCE and the entries in the operating mechanism used for starting and stopping long running processes if they already exist. causes the usage message to be displayed.
-F
-?
Examples
1. To create region REGION1:
cicsdefault -r REGION1
2. To overwrite the resource denitions of REGION2, when REGION2 already exists:

cicsdefault -r REGION2 -F
143
cicsdefaultservers cicsdefaultservers - Create default resource les for servers

Creates the default resource les for the SFS, SFS schemas and PPC gateway servers. (Open Systems) and for the SFS schemas (Windows NT).
Syntax
cicsdefaultservers [ -s | -c | -p ]
Description
cicsdefaultservers creates the following default resource les for the: SFS schema /var/cics_servers/SCD/SCD.stanza gateway /var/cics_servers/GSD/GSD.stanza These les are owned by cics and, on Open Systems, have the permissions -rw-rw----. If no ags are specied, les are created for the SFS, schemas and, on Open Systems, gateway servers. Run this command as root or administrator and once per machine after CICS has been installed for the rst time. /var/cics_servers/SSD/SSD.stanza
Options
-s -c -p creates the default SFS resource le (SSD.stanza). creates only the default schema resource le (SCD.stanza). creates only the default PPC gateway resource le (GSD.stanza).
Examples
To create the SFS and schema resource les on one machine, enter:
cicsdefaultservers -s -c
144
cicsdelete cicsdelete - Delete CICS resource denitions

Use this command to delete existing CICS resource denitions.
Syntax
cicsdelete -c className [-r regionName] [-P | -R | -B] [-f leName] resourceName [resourceName ... ] cicsdelete -?
Description
The Resource Denition Online (RDO) command cicsdelete deletes one or more resource denitions of a given class from the permanent resources database, and can delete them from the runtime database. CAUTION: Stopping the command before completion can result in a damaged database. After you delete a resource denition, you cannot recover it. Each resource deletion is atomic. For example, suppose you try to delete three resource denitions with a single command. The rst two resource denitions are deleted successfully, but the third resource denition deletion fails. The command abnormally terminates, but it has still successfully deleted the rst two resource denitions. These two denitions are not recovered. The command returns 0 if the command completes successfully, 1 otherwise.
Options
-c className determines the resource class from which the resource denition is to be deleted, and is one of these two- or three-character codes: cd fd gd gsd jd ld od Communication Files Gateways Gateway Servers Journals Listeners Objects
145
cicsdelete
pd scd ssd td tdd tsd ud wd xad Programs SFS Schemas SFS Servers Transactions Transient Data Queues Temporary Storage Queues Users Terminals Products
Resource classes rd (Region denition) and md (Monitoring denitions) cannot be deleted. -r regionName species the region from which the resource denition is deleted. If you do not specify a region name, CICS deletes the resource denitions from the region specied by the CICSREGION environment variable. The -r parameter is invalid if you specify gsd, scd, or ssd as the resource class, because these classes are associated with a collection of regions rather than with a specic one. -f leName species the name of the le that contains the schema denitions. This ag is valid only when you specify scd (SFS schema denitions) as the resource class. -P instructs the command to delete the resource denitions from the permanent database without uninstalling them from the runtime database. This is the default option if you do not specify either the -P, -R, or -B options. instructs the command to uninstall the resource denitions from the running system and delete them from the runtime database. If you are using DCE authentication, you must be authenticated as a DCE principal before running the command with this ag. The -R ag is invalid if you specify gsd, scd, or ssd as the resource class, because these classes are associated with a collection of regions rather than with a specic region. -B instructs the command to delete the resource denitions from the permanent database, uninstall them from the running system, and delete them from the runtime database. If you are using DCE
-R
146
cicsdelete
authentication, you must be authenticated as a DCE principal before running the command with this ag. The -B ag is invalid if you specify gsd, scd, or ssd as the resource class, because these classes are associated with a collection of regions rather than with a specic region. resourceName is the name of a resource denition to be deleted. -? causes the usage message to be displayed.
Examples
1. To remove terminals T001 and T002 from the runtime database only in region REGION5:
cicsdelete -c wd -r REGION5 -R T001 T002
2. To remove transient data queues TDQUEUE1 and TDQUEUE2 from the permanent and runtime databases in region REGION6:
cicsdelete -c tdd -r REGION6 -B TDQUEUE1 TDQUEUE2
147
cicsdestroy cicsdestroy - Destroy a CICS region

The purpose of the cicsdestroy command is to allow you to destroy an existing CICS region.
Syntax
cicsdestroy -r regionName [-s] [-I] cicsdestroy -?
Description
v You must be logged on as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication you must have a DCE context that has sufficient authority to: Create a DCE principal and account Create a Server Key Table Administer the le system for the region (if you want to use the -s ag) Usually this is a DCE cell administrator. The cicsdestroy command destroys the specied region in the following way: All operating system les associated with the region are destroyed. If you specify the -s option, the TSQ, TDQ, and local queue les for the region are deleted on the relevant le systems.The servers must be available and you must be logged in to DCE with sufficient authority to perform the deletions. cicssrcdestroy deletes the region used for managing CICS processes. However, if the directories and les of the CICS region have been deleted before the cicsdestroy command is issued, the SRC entries for the region are not removed. If you are using DCE authentication,you are logged in to DCE, and you have sufficient authority, the region principal, region account and CDS directories for the region are deleted. Note: Although cicsdestroy deletes the DCE principal and account for the region userid, it does not delete the DCE principals and accounts for
148
cicsdestroy
the users of this region. If these users are not required for other regions, the DCE principals and accounts may be deleted using DCE facilities. When you use cicsdestroy, you are prompted for your DCE password if you are using DCE authentication.
Options
-r regionName species the region to be destroyed. -s -I -? species that region-owned data inle system usedis also to be destroyed. ignore errors. causes the usage message to be displayed.
Examples
1. To destroy a region without destroying its file system data:
cicsdestroy -r REGION1
2. To destroy a region together with its file system data:

cicsdestroy -r REGION1 -s
149
cicsdfmt cicsdfmt - Dump formatter

Use this command to extract data from a dump le or les that CICS creates as part of a CICS dump sequence. The command formats the CICS dump into a form that can be written to the operating system standard output.
Syntax
cicsdfmt [ [-r regionName] [leName] | directoryName | leName | -p [-r regionName] [dumpFileName] ] cicsdfmt -?
Description
If you do not specify any parameters, the cicsdfmt command lists the dump les located beneath the default regions dump directory, and sends some explanatory text about how to use the command to the operating system standard error destination. If you specify a region and the name of a dump le, the cicsdfmt command generates the full path of the dump directory for the region, extracting a value for the dump directory from the Region Denitions (RD). It searches in the subdirectories of the dump directory for the named dump le. If you specify a lename alone, the cicsdfmt command searches the subdirectories of several locations, in the following order, to check whether the named dump le exists: 1. The current directory 2. The parent of the current directory 3. The default regions dump directory If the named dump le does not exist, the cicsdfmt command sends an error message to the standard error output. If the named dump le exists, it formats all dump les with this name to standard output. Note: If a dump produced by cicsdfmt contains lines greater than 2048 bytes, some text editors cannot be used. For example, on CICS on Open Systems, you cannot use the vi editor to examine such dumps, but you can use: v cat fileName | fold newName (This converts all the lines to 80 characters to allow normal use of vi.)
150
cicsdfmt
v more fileName v pg fileName v emacs, if available
Options
-r regionName species the region to use. The cicsdfmt command generates the full path of the dump directory for the region regionName, extracting a value for the dump directory name from the Region Denitions (RD). The cicsdfmt command checks that regionName is valid. If regionName is invalid, it sends an error message to the standard error stream. If you specify leName as well as regionName, the request formats the dump le leName for the specied region. If you do not specify leName, the request lists all the dump les for region regionName. If you do not specify a region name, CICS processes dumps for the region specied by the CICSREGION environment variable. leName species the base name of the le or set of les to be formatted to standard output. If you specify the leName and -r regionName options, the cicsdfmt command formats only the dump les contained in the specied region. You can specify lename with a relative or absolute path. A dump can be contained in more than one le, but the les all share the same base name; supply the base name to this command. Note: The suffix of the lename must not be entered. The format of the name of the dump le is aaaannnn, where nnnn is the dump sequence number that CICS increments each time a dump is performed, and aaaa is a prex to denote how the dump arose. The prex takes the following values: ASRA From an ASRA abnormal termination. ASRB From an ASRB abnormal termination. SYSA From a SYSA abnormal termination. SHUT From a shutdown request. SNAP From a CEMT PERFORM SNAP DUMP request. A four letter dumpcode From an EXEC CICS DUMP command.
151
cicsdfmt
A four letter abnormal termination code From an EXEC CICS ABEND command or from a transaction abnormal termination initiated by CICS. directoryName lists the dump les located in the subdirectories of a specied directory. You can specify directoryName as a full or relative pathname. -p [dumpFileName] removes all dump les specied by the dumpFileName parameters. The dumpFileName is the base name of the le or set of les that you want to remove. You can specify dumpFileName with a relative or absolute path. A dump can be contained in more than one le, but the les all share the same base name; supply the base name to this command. If you do not specify a dumpFileName parameter, the cicsdfmt command lists the specied les, requests conrmation that all the les are to be deleted, and, if conrmed, removes the les. If you specify -p with a dumpFileName parameter, the specied dump les are deleted without requesting conrmation. -? provides you with a help facility showing the correct syntax for the command. cicsdfmt also displays the correct syntax if you enter the command syntax incorrectly.
Examples
1. To list all dump les located in directory /u/dumpdir:
cicsdfmt /u/dumpdir
2. To list all dump les for region REGIONA:

cicsdfmt -r REGIONA
3. To format all dump les with a base name of shut001 that are located in the current directory, the parent of the current directory, or the default regions dump directory:
cicsdfmt shut001
4. To remove all dump les with a base name of shut001:

cicsdfmt -p shut001
5. To format a dump for a specic region:

cicsdfmt -r REGIONA shut001
6. To remove all of the dump les for a region:

cicsdfmt -r REGIONA -p
152
cicsexport cicsexport - Export CICS resource denitions

Use this command to make an archive copy of all the resource denitions in an existing CICS region. Using the cicsexport command with the cicsimport command lets you either create a new region as a copy of an existing region, or create an archive that you can unpack to create an arbitrarily named region. This process lets you transfer regions across machines, possibly on distinct networks. Attention: This command creates a copy of the region in the /var/cics_regions directory (for CICS on Open Systems) or in the \var\cics_regions directory (for CICS for Windows NT). Before you use this command, verify that you have enough space for the copy in the directory.
Syntax
cicsexport [-r regionName] [-o outFile] [-l className...] cicsexport -?
Description
The cicsexport command copies the resource denitions from an existing CICS region. To run cicsexport from the command line, you must be logged in as a user with root or administrator privileges and be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). The cicsexport command copies the following denitions: v All conguration les except those dening the SFS server. These have to be recongured. v All resource denitions v Conversion templates v All programs v All maps v All Java classes v The contents of the regions data directory. Note: If you install maintenance on CICS or a new version of CICS, the existing DEFAULT archive le is overwritten, including any alterations you made to it.
153
cicsexport
To migrate an exported region, you must import it, migrate it by using the cicsmigrate -r command, and then reexport it. The region can then be imported successfully as required.
Options
-r regionName species the existing region from which the cicsexport command copies resource denitions. If you do not specify a region name, CICS copies the resource denitions from the region specied by the CICSREGION environment variable. -l className (CICS on Open Systems only) permits the archive copy to be generated in a form that creates symbolic links for the specied resource denition les. The className can be one or more of the following: cd fd gd jd ld md pd od rd td tdd tsd ud wd xad Communication Files Gateways Journals Listeners Monitoring Programs Objects Regions Transactions Transient Data Queues Temporary Storage Queues Users Terminals Products
-o outFile species the output le to which the cicsexport command writes the archive copy of the resource denitions, in Copy In and Out (cpio) format. If you do not specify the -o ag, cicsexport writes the le to standard output. -? causes the usage message to be displayed.
154
cicsexport Examples
1. To export the region REGION1:
cicsexport -r REGION1
2. To export the region REGION2, placing symbolic links for the le and program denitions:
cicsexport -l fd pd -r REGION2
155
cicsget cicsget - Get CICS resource denition information

Use this command to inquire about existing CICS resource denitions.
Syntax
cicsget -c className [-r regionName] {-l | -s [resourceName] | [resourceName]} cicsget -c scd [-f leName] {-l | -s resourceName | resourceName} cicsget -?
Description
The Resource Denition Online (RDO) command cicsget retrieves resource attributes of a specied class from the permanent resources database so that you can query on their status. Output from cicsget is written to standard output. Do not specify the resourceName for the Region Denitions (RD) and the Monitoring Denitions (MD). However, you must specify it for all other resource types. The -l and -s options are mutually exclusive.
Options
-c className determines the resource class from which the resource denition is to be retrieved, and is one of these two- or three-character codes: cd fd gd gsd jd ld md od pd Communication Files Gateways Gateway Servers Journals Listeners Monitoring Objects Programs
156
cicsget
rd scd ssd td tdd tsd ud wd xad Regions Schema File Denitions SFS Servers Transactions Transient Data Queues Temporary Storage Queues Users Terminals Products
-r regionName species the region from which the command retrieves the resource attributes. If you do not specify a region name, CICS retrieves the resource attributes from the region specied by the CICSREGION environment variable. The -r parameter is invalid if you specify gsd, scd, or ssd as the resource class, because these classes relate to the servers rather than to the regions. -s causes a list of attribute names and attribute values to be written to standard output. The information is written as two lines of information. The rst line, which begins with a number sign (#), is a list of attribute names separated by colons (:). The second line contains all the corresponding attribute values, also separated by colons. The cicsget command appends the word region to the end of the rst line, and appends the region name to the end of the second line. Specify the resourceName for all classes except the region and monitoring classes. causes a list of all resources and their descriptions for a given class to be written to standard output.
-l
resourceName is the name of the resource denition to be retrieved. You must specify a resourceName for all classes except rd and md. To retrieve the attributes for the default denition, use as the value. This attribute without the -s ag results in a list of attributeName=attributeValue pairs being written to standard output. -f leName species the le containing the resource denitions. Use this attribute only when retrieving data for the Schema File Denitions (SCD). The class scd must be used when specifying the lename.
157
cicsget
-? causes the usage message to be displayed.
Examples
1. To inquire about the denition attributes for the temporary storage queue TSQUEUE1 in the region REGION7:
cicsget -c tsd -r REGION7 TSQUEUE1
2. To inquire about the users in the region REGION8 and write the details as a list to standard output:
cicsget -c ud -r REGION8 -l
158
cicsgetbindingstring cicsgetbindingstring - Get binding string for region or Encina server

The purpose of the cicsgetbindingstring command is to display the binding string used to contact a given CICS region or Encina SFS or PPC Gateway server when the DCE directory service is not being used.
Syntax
cicsgetbindingstring { regionName | serverName } cicsgetbindingstring -?
Description
The environment variable CICS_HOSTS must have the same value as it does when CICS components and Encina servers are started. Otherwise the results displayed may not correctly represent the endpoints used by CICS. This command searches the DCE RPC daemons for information about regions and servers. It will search the daemons on the machines that are specied by the environment variable CICS_HOSTS or those on the current machine if CICS_HOSTS is not set. If none of the daemons on the specied machines has information about the region or server, a nal check is made in the le /var/cics_servers/server_bindings for any binding that may have been entered there. Note that cicsgetbindingstring displaying a binding string does not guarantee that a region or server is currently active and available on the given endpoint. Rather it represents the endpoint that will be used by CICS processes when attempting to contact the region or server in the absence of the DCE directory service. Normally however this will indeed be an active process. In the case of Encina SFS and PPC Gateway servers the binding string returned by cicsgetbindingstring may be used in place of the server name when using Encina facilities for manipulating the servers. This is especially important when using tkadmin, sfsadmin or ppcadmin with servers operating without the DCE directory service. Specifying the server name in such cases will not enable Encina to locate the server concerned (unless the environment variable ENCINA_BINDING_FILE is set to the name of a le containing a mapping between the server name and a binding string, for example, the le /var/cics_servers/server_bindings). On the other hand the string binding may be freely used in place of the server name and Encina will then be able to locate the server.
159
cicsgetbindingstring Options
regionName is the name of a CICS region on one of the machines specied by the environment variable CICS_HOSTS or on the current machine if CICS_HOSTS is not set. serverName is the name of an Encina SFS or PPC Gateway server on one of the machines specied by the environment variable CICS_HOSTS or on the current machine if CICS_HOSTS is not set -? causes the usage message to be displayed.
Examples
1. To nd the binding string that will be used by CICS to contact the CICS region REGION1 running on machine BLUE, enter
export CICS_HOSTS=BLUE cicsgetbindingstring REGION1
2. To nd the binding string that will be used by CICS to contact the Encina SFS server /.:/cics/sfs/SERVER1 running on one of the machines RED, BLUE or GREEN, enter
export CICS_HOSTS="RED BLUE GREEN" cicsgetbindingstring /.:/cics/sfs/SERVER1
3. To get a list of les on the Encina SFS server /.:/cics/sfs/SERVER1 running on machine BLUE
export CICS_HOSTS=BLUE sfsadmin list files -server $(cicsgetbindingstring /.:/cics/sfs/SERVER1)
160
cicsgpid cicsgpid - Get region process identier

Use this command to determine the process identier of the main CICS process.
Syntax
cicsgpid [-r regionName] cicsgpid -?
Description
cicsgpid determines the process identier of the main CICS process.
Options
-r regionName species the region name. The cicsgpid command checks that regionName is valid. If regionName is invalid, cicsgpid writes an error message to the standard error stream. If you do not specify a region name, CICS determines the process identier for the region specied by the CICSREGION environment variable. -? provides you with a help facility showing the correct syntax for the cicsgpid command. If you enter the command syntax incorrectly, the correct syntax is displayed.
Examples
To determine the process identier for the CICS region REGIONB:
cicsgpid -r REGIONB
161
cicshpterm cicshpterm - 3270 terminal emulator

AIX HP-UX X Sun Solaris Windows NT
Invokes the CICS 3270 Terminal Emulator, from the operating system, so that you can connect to a CICS region. Note: The syntax for cicshpterm is identical to that of cicsterm (see cicsterm - Invoke the CICS 3270 terminal emulator on page 251). Once cicshpterm performs the conguration steps outlined under Description, it invokes cicsterm. All the description given for cicsterm is equally valid for cicshpterm.
Syntax
cicshpterm [-r regionName] [-n netName | -m modelId] [-t transId] [-A [animatorTTY] [-T animatorTERM] cicshpterm -?
Description
1. You need access to a terminal or window that can access a machine in the DCE cell in which the CICS region is dened. Your terminal must either be suitable for autoinstall, or have an entry in the NetName attribute in the Terminal Denitions (WD). 2. Your window must contain at least 12 lines, so that the terminal emulator can display a menu of region names when necessary. A menu of region names is displayed if you do not specify a region when you invoke the CICS 3270 Terminal Emulator. The 12 lines are needed to display various headers, PF key legends, blank space, and at least one region name so that you can scroll through the list of available regions. If the window contains less than 12 lines, there is an error message and the terminal emulator terminates abnormally. It is recommended that you use a window with 25 lines. 3. If you are using DCE authentication, you must be authenticated as a DCE principal, as explained under Description. A DCE ticket is allocated when the DCE principal authenticates with the DCE security service. Tickets have a limited lifetime; 10 hours by default. If a ticket expires while the client is active, the client is terminated and any in-ight transactions are terminated abnormally. DCE accounts may have their ticket lifetime changed. 4. You must be authorized to run the transactions that you specify. That is, the UD entry for the userid you are using must have the TSL and RSL
162
cicshpterm
keys listed in it that allow you to access the transactions that you want to run. This is described in the CICS Administration Guide. The cicshpterm command is an intelligent cicsterm wrapper that automatically examines your environment and congures cicsterm for the maximum functionality possible within your environment. If you use cicsterm alone, you are required to perform these conguration steps manually. cicsterm command, cicshpterm checks whether or not your environment is capable of displaying a window on a graphics terminal. If your environment is capable of displaying a window on a graphics terminal, cicshpterm creates an hpterm window that runs cicsterm. The cicsterm command is run using a high-function terminal model and a customized hpterm window that provides 24 programmed softkeys and full color capabilities. The characteristics of the hpterm window created by cicshpterm are dened in the X resources le /opt/cics/etc/cicshpterm.resources. The key mapping le applied is /opt/cics/etc/3270keys.hpterm. If your environment is not capable of displaying a window on a graphics terminal, cicshpterm determines whether you are running on a terminal or emulation that it supports. For the supported terminals and emulations, cicshpterm congures your environment for the maximum functionality possible. In these cases, cicsterm runs in monochrome mode with 8 or 16 programmed soft keys. The following table lists the terminal models recognized by cicshpterm and the 3270 key mapping le located in /opt/cics/etc that is applied for each model:
Terminal type supported HP 2392A, HP 2394A, HP 700/92, HP 700/94, HP 700/96, HP 700/98 hpterm terminal emulator (non-graphics mode) hpterm terminal emulator (graphics mode) VT100/ VT200 Associated keymap le 3270keys.hp 3270keys.hp 3270keys.hp 3270keys.hpterm 3270keys.vt100
If cicshpterm does not recognize your terminal/emulation, it makes no changes to your environment. The keymap le applied is /opt/cics/etc/3270keys.
163
cicshpterm
The cicshpterm command defaults the correct cicsterm model (-m) parameter for its supported terminals whenever the cicsterm netname (-n) parameter is not specied. You can override this default by specifying a terminal model using the -m parameter.
Options
-r regionName species the name of the CICS region to which you wish to attach. If you do not specify a regionName, CICS displays an interactive menu of available regions that you can select from. If there are no regions available, CICS displays an error message. You must conrm this message by pressing ENTER before CICS terminates the CICS 3270 Terminal Emulator. -t transId species the transaction identier of the transaction to run after Terminal Emulator initialization. -n netName species the name of the netName to use for installation. To install as a particular terminal, specify the netName of the required terminal. If you omit the netName, then cicshpterm autoinstalls, and a unique netName is generated in the region. -m modelId species the name of the DevType to use for autoinstallation. See Processing on page 254. -A animatorTTY species the name of the device for ANIMATOR stdin/stdout. If you specify the -A, option without a value, and you are using X Windows, cicshpterm will create a window for use as the ANIMATOR console. -T animatorTERM species the name of the TERM type of the ANIMATOR terminal. -? causes the usage message to be displayed.
Examples
1. To display the syntax for accessing CICS:
cicshpterm -?
2. To access CICS and log on to the region region1:

cicshpterm -r region1
3. To start a terminal with the NetName BlueTerm in its Terminal Denitions on region region1:
cicshpterm -n BlueTerm -r region1
164
cicshpterm
4. If you want to log on to a different userid after you have started cicshpterm:
cicshpterm -r region1 -t CESN
165
cicsimport cicsimport - Import CICS resource denitions

Use this command to restore an archive copy of the resource denitions from an existing CICS region. Using the cicsimport command with the cicsexport command lets you either create a new region as a copy of an existing region, or create an archive that you can unpack to create an arbitrarily named region. This process lets you transfer regions across machines, possibly on distinct networks.
Syntax
cicsimport -r regionName [-g groupName] [-i inFile] [-l{m|o}][-v] [-F] [-S|-D] [-o] cicsimport -?
Description
v You must be logged on as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication, you must have a DCE context that has sufficient authority to create a DCE principal, account, and server key table. Usually this requires identity as a DCE cell administrator. The cicsimport command restores the resource denitions from an existing region to your new region. You run cicsimport from the command line as long as you are logged in as a user with root or administrator privileges. The denitions that cicsimport restores are: v All conguration les except those dening the SFS. Even if SFS les already exist for an imported region, you should rerun cicssfsconf to reset the ACLs. v All resource denitions v Conversion templates v All programs v All maps v All Java classes v The contents of the regions data directory
166
cicsimport
If you are using DCE authentication and there are User Denitions (UD) in the region archive being imported that do not currently exist in the DCE cell, their DCE principals and accounts are created automatically with the following details: v The password is the same as that for the users id. v The group is cics_users. v The organization is none. v The home directory is /. v The shell is cicsterm. If you are using DCE authentication, all users, whether or not they exist already, are made members of the DCE group cics_users. If you are not using DCE authentication or name services, the option -S must be specied. If you install a new region, this command can be used to copy another region which already exists. If you want to migrate an exported region database, you must import using cicsmigrate -r, and then re-export it again. The region can then be imported successfully as required. If you are using SFS for CICS queues and les, after running cicsimport, run cicssfsconf to reset the Access Control Lists.
Options
-r regionName species the name of the region to restore. -g groupName species the name of the group with which all les of the new region are created. The default groupid is cics (CICS on Open Systems) and cicsgroup (CICS for Windows NT). -l{m|o} (CICS on Open Systems only) species the action that cicsimport is to take if it cannot nd the target of a symbolic link: -lm -lo Mandatory. cicsimport terminates the restoration immediately. Optional. cicsimport produces a warning message, creates the link, and continues restoration. This allows you to restore further regions that resolve the missing links.
The default action is to terminate the restoration.
167
cicsimport
-i inFile species the name of the archive copy of the resource denitions in Copy In and Out (cpio) format. If you do not specify the -i ag, the le is read from stdin. -v -F (verbose) lists les as they are created. forces an overwrite of the region if the region already exists, but does not recreate DCE and the entries in the database of the facility that starts and stops processes if they already exist. causes the new region to be set up without using DCE servers. It must be specied if the region from which the archive was created used DCE servers but the new region does not. The Region Denitions (RD) attributes NameService and AuthenticationService will be set to CICS respectively. forces DCE servers to be used when migrating a region that did not use DCE servers to a machine that does use them. The Region Denitions (RD) attributes NameService and DCE. Do not create DCE principals and accounts for the CICS users in the region. If not specied, each user denition in the region will have a DCE principal and account added to the DCE registry and the account will be added to the DCE group cics_users. produces the usage message.
-S
-D
-o
-?
Examples
1. To import region REGION1 from archive le /archive/region1:
cicsimport -r REGION1 -i /archive/region1
2. To import region REGION2 from archive le /archive/region2 producing warning messages if any symbolic link requirements dened as part of the cicsexport command cannot be found:
cicsimport -lo -r REGION2 -i /archive/region2
168
cicsinstall cicsinstall - Install CICS resource denitions

Use this command to install CICS resource denitions into the runtime database.
Syntax
cicsinstall [-v] [-r regionName] { -a | -g groupName [groupName ... ] } cicsinstall -?
Description
The Resource Denition Online (RDO) command cicsinstall installs resource denitions into the runtime database for the specied region. The -g and -a options are mutually exclusive. v You must be logged on as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication, you must have a DCE context that has sufficient authority to create a DCE principal and account and create a server key table. Usually, this requires an identity as a DCE cell administrator.
Options
-r regionName species the region to which the cicsinstall command is to install the resource denitions. If you do not specify a region name, CICS installs the resource denitions to the region specied by the CICSREGION environment variable. -g groupName ... species the names of the group or groups whose resource denitions the cicsinstall command is going to install. As many as ten group names can be specied. The -g ag must be the last ag specied on the cicsinstall command. -v requests that the cicsinstall command produce messages indicating which resources it has installed, as well as the total number of resources installed. If you do not specify this option, it produces a message only if an error occurs. requests the cicsinstall command to install into the CICS runtime
-a
169
cicsinstall
database all resource denitions from the permanent database that have the ActivateOnStartup ag set. -? causes the usage message to be displayed.
Examples
1. To install all resource denitions from the group GROUP1 in the region REGION9 into the runtime database:
cicsinstall -r REGION9 -g GROUP1
2. To install into the runtime database all denitions in the region REGION0 that have the ActivateOnStartup ag set, plus receive progress messages:
cicsinstall -r REGION0 -a -v
170
cicsivp cicsivp - Set up resource denitions for installation verication

Sets up the resource denitions required to run the Installation Verication Programs (IVPs).
Syntax
cicsivp -r regionName [-s serverName] [-v volumeName] [-l sampleLanguage] cicsivp -r regionName [-s databaseName][-l sampleLanguage]
Description
v On Open Systems you must be logged in as a member of the group cics. On Windows NT you must be logged in as a member of the group cicsgroup. v If you are using an SFS as a le server: You must be running an SFS. cicssfsconf must have been run to congure the SFS. You must have authority to create an SFS le. Usually this means that you must be logged in with the DCE principal, cell_admin. v If you are using DB2 as a le server: You must have a running DB2 database available for connection. You must be authorized to connect to the database. cicsdb2conf must have been run to congure the database.
You must have the authority to create a table. The IVPs are designed to run with a set of pre-dened resource denitions. The cicsivp command adds these resource denitions to the specied region database. After youve run cicsivp, you must cold start the region for the changes to take effect. Once the region is running, you can run cicsivp again to change the language in which the sample transactions are coded.
Options
-r regionName species the region to be amended. -s serverName species the name of the required SFS if the region is using an SFS le server(attribute FileSystemType=SFS in the Region Denition). If the
171
cicsivp
server is not specied then the default server is /.:/cics/sfs/hostName, where hostName is the name of the machine running CICS and can be found using the command uname -n. -s databaseName species the name of the required DB2 database if the region is using DB2 as a le server (attribute FileSystemType=DB2 in the Region Denition). If the name of the database is not specied then the value of the Region Denition attribute DefaultFileServer is used as the database name. -v volumeName species the name of the required SFS logical volume. If it is not specied, the default volume is DataVolume in the Structured File Server Denitions (SSD). -l sampleLanguage species the language of the sample transactions. The language can be one of: C the samples coded in C are to be used.
IBMCOB the samples coded in IBM COBOL are to be used (CICS for AIX only). COBOL the samples coded in Micro Focus COBOL are to be used.
Examples
1. To add the required resource denitions to a region called REGION1, using the default SFS and SFS logical volume, enter:
cicsivp -r REGION1
2. To add to required resource denitions to a region called REGION1, using the default SFS, which has an SFS logical volume called sfs_MINE, enter:
cicsivp -r REGION1 -v sfs_MINE
172
cicslssrc cicslssrc - Check subsystem status

AIX HP-UX X Sun Solaris X Windows NT
The cicslssrc command shows the status of CICS subsystems. By default, all subsystems are listed. Alternatively, a specic region or SFS may be listed.
Syntax
cicslssrc [ -a | -s subsystem | -g groupName ] cicslssrc -?
Description
You must be logged in as a member of the group cics. The following information is provided when the cicslssrc command is used: v The process ID (PID) of the subsystem if it is active or stopping. Otherwise, this eld is blank. v The current status of the subsystem. The statuses are: inoperative The subsystem is not currently running. active The subsystem is running as the process identied by the PID eld. stopping The subsystem is processing a shutdown request.
Options
-a display the status of all subsystems. This is the default parameter. -s subsystem display the status of the specied subsystem. A regions subsystem name is formed by appending the region name to cics.; for example cics.region2. An SFS subsystem name is similarly formed by appending the short name of the SFS to cicssfs.; for example, cicssfs.SHostA. -g groupName display the status of all subsystems in the specied group. -? causes the usage message to be displayed.
Examples
1. To list all CICS subsystems, use the following:
cicslssrc
173
cicslssrc
On a system with a region named region2 and an SFS named SHostA, something similar to the following is shown:
Subsystem cics.region2 cicssfs.SHostA PID 7444 605 Status active active
If the SFS were not running, then the following is shown:

Subsystem cics.region2 cicssfs.SHostA cicslsrrc cicssfs.SHostA PID 7444 Status active inoperative
2. To check the status of an SFS named SHostA, use the following:
174
cicslterm cicslterm - Invoke the local CICS client 3270 terminal emulator
AIX HP-UX Sun Solaris Windows NT X
Invokes the local CICS client 3270 terminal emulator so that you can connect to a region on the local machine.
Syntax
cicslterm [-s=serverName | -r=serverName] [-t=transId] [-k=keyFile] [-c=colorFile] [-m=modelId] [-n=netName] [-p=printCommand | -f=printFile] [-q | -w] cicslterm -?
Description
v You need to understand about the 3270 terminal subsystem before you use the cicslterm command. See the CICS Administration Guide for more information. v The window in which you start cicslterm must contain at least 12 lines. It is recommended that you use a window with 25 lines. v You must be authorized to run the transactions that you specify. That is, the UD entry for the userid you are using must have the TSL and RSL keys listed in it that allow you to access the transactions that you want to run. This is described in the CICS Administration Guide. After you are connected to the region, CICS leaves you with a blank screen that is running the IBM 3270 Information Display System emulation. You can then enter the transaction identier of the transaction you want to run. Alternatively, you can run a transaction immediately when cicslterm is initially invoked, by entering
cicslterm -t=transId
where transId is the transaction identier. The name of the pipe that is to be used for communication with the region is determined from le cicslcli.ini in directory prodDir/bin. The le cicslcli.ini must contain a stanza of the form
Server=serverName Protocol=LOCALCLI NamedPipeName=pipeName ...
where serverName is the name of the server specied on the cicslterm command. and pipeName is the 6-character name of the pipe to be used. The
175
cicslterm
last two characters of the name of the pipe must be unique on the machine. The pipe name must match the attribute NamedPipeName (local Named Pipe name) of an entry in the Listener Denitions (LD) for the region. If you change the le cicslcli.ini, you must use the Stop All Local Terminals icon to stop all CICS local terminals and the cicslcli client before using cicslterm to restart a CICS local terminal to pick up the change. For a full description of the format of the client initialization le, see CICS Clients: Administration. The CICS 3270 Terminal Emulator is associated with a particular region for the lifetime of the cicslterm process. If the region terminates, the cicslterm process is left running to wait for any current scheduled protected transactions for the given terminal when the region is restarted. Otherwise, the cicslterm process terminates.
Options
-s=serverName or -r=serverName species the name of the CICS server you wish to use. -t=transId species the identier of the transaction to run after the terminal emulator has initialized. -k=keyFile species the name of the keyboard mapping le to be used by the emulator. If this parameter is omitted, the environment variable CICSKEY is used to identify the key mapping le. If CICSKEY is not dened, it is assumed that a le called cicskey.ini in the current directory contains the keyboard mapping. -c=colorFile species the name of a color mapping le to be used by the emulator. If this parameter is omitted, the environment variable CICSCOL is used to identify the color mapping e. If CICSCOL is not dened, it is assumed that a le called cicscol.ini in the current directory contains the color mapping. -m=modelId species the name of a model terminal denition, dened in the regions Terminal Denitions (WD), that is to be used to dene the characteristics of the window in which transactions are to be run. If neither of the -m or -n parameters is specied, then any ModelTerm value from the client initialization le is used. If no ModelTerm value has been specied in the initialization le, or if the -m parameter is specied without a value, the servers default terminal denition is used.
176
cicslterm
-n=netName species the name of a particular terminal denition as dened in the regions Terminal Denitions (WD). -p=printCommand species a Windows NT command used to process the temporary print le generated when requests are received by the terminal emulator. The temporary print le is processed by executing the command obtained by appending the name of the le to the specied command. CICS does not delete the temporary print le. The command that is executed is responsible for deleting the temporary print le, if that is appropriate. If the command contains embedded blanks, then it must be surrounded by double quotation marks ("). Any double quotation marks within the command must be entered as backslash double quote (\"). If neither of the -f or -p parameters is specied, the PrintCommand or PrintFile parameter in the client initialization le denes the command or le to be used for print requests. -f=printFile species the name of a le to which the output of print requests is appended. If the name of the le contains embedded blanks, it must be enclosed in double quotation marks ("). Any double quotation marks within the name of the le must be entered as backslash double quote (\"). If neither of the -f or -p parameters is specied, the PrintCommand or PrintFile parameter in the client initialization le denes the command or le to be used for print requests. -q -w (quiet) suppresses the display of any messages generated by the command. (wait) prompts the user to press the Enter key before the command completes, to conrm that messages generated by the command have been read. causes the usage message to be displayed.
-?
Examples
1. To log on to the server server1 and run transaction CEMT:
cicslterm -s=server1 -t=CEMT
177
cicsmakelv cicsmakelv - Create a logical volume

The cicsmakelv command creates a logical volume for use by an Encina server.
Syntax
cicsmakelv [-I] -v volumeName -s volumeSize -p dataPath cicsmakelv -?
Description
You must be logged on as a user who has administrative privileges The cicsmakelv command is used to create an operating system le, at the location specied by dataPath, that will be used as an Encina logical volume by an Encina server. A volume created using cicsmakelv should only be removed using the cicsremovelv command since cicsmakelv also adds information to the NT Registry concerning the location of the logical volume. Removing the volume by other means could result in incorrect information being left in the NT Registry.
Options
-I Ignore errors. If an Encina Logical Volume previously existed with this name but was only partially removed, then this ag may be specied to force the redenition of the volume.
-v volumeName species the name of the logical volume as it is to be referenced by the Encina Server. -s volumeSize species the size of the logical volume in bytes. -p dataPath species the location of the logical volume.
Examples
1. To create a logical volume for server sfs_Server1 of size 16384 Kbytes at D:\var\volumes\sfs_Server1:
cicsmakelv -v sfs_Server1 -s 16384000 -p D:\var\volumes\sfs_Server1
178
cicsmfmt cicsmfmt - Monitoring data formatter

Use cicsmfmt to extract data from a monitoring transient data queue that CICS creates as part of a CICS monitoring sequence. cicsmfmt formats the CICS monitoring data into a form that can easily be written to standard operating system output. You can replace cicsmfmt with your own customized program. This information describes the version delivered with CICS and may not correspond to the version running on your system.
Syntax
cicsmfmt leName cicsmfmt -?
Description
If you specify too few or too many parameters, or enter the -? option, cicsmfmt sends some explanatory text to the standard error destination, on how to use the command. Otherwise, cicsmfmt checks that the le exists, and formats the le records. cicsmfmt formats several elds for each transient data queue record: v the transaction name v the terminal name v the start and end time stamps for the task v the time spent waiting for le input and output, and the number of times CICS started and stopped the clock v the program name v the total number of le requests v the data segment memory occupancy v the rst abnormal termination code, if set. cicsmfmt is a sample program generated from the sample source le cicsmfmt.c. It can be built with the sample makele in the directory prodDir/src/samples/mfmt using the command make -e -f Makele (on Open Systems) or nmake -e -f Makele (on Windows NT). If you want to replace cicsmfmt with your own program, you must change the sample makele accordingly.
179
cicsmfmt
The following les make up the monitoring data formatter:
Table 3. Monitoring data formatter les
File Type Contents The executable monitoring formatter program Sample monitoring formatter program source Sample makele that builds and installs the monitoring formatter Library containing the functions for reading and processing a Monitoring Data le Denitions used by the sample monitoring formatter English messages used by the sample monitoring formatter Message catalog for cicsmfmt produced by gencat. Only required by formatter programs compiled with CICS release 2.1.1 or earlier.
prodDir/bin/cicsmfmt (CICS on Open Systems) executable c:\opt\bin\cicsmfmt.exe (CICS for Windows NT) prodDir/src/samples/mfmt/cicsmfmt.c prodDir/src/samples/mfmt/Makele prodDir/lib/libcicsmfmtsa.a (CICS on Open Systems) prodDir/lib/libcicsmfmtsa.lib (CICS for Windows NT) prodDir/include/cicsmfmt.h prodDir/include/cicsmfmt_msg.h prodDir/msg/en_US/cicsmfmt.cat (CICS for AIX and Solaris) prodDir/msg/en_US.iso88591/cicsmfmt.cat (CICS for HP-UX) source makele object library
include include message text
Options
leName an operating system le corresponding to a CICS extrapartition transient data queue containing monitoring data from a previous run. Note that the transient data queue must have a variable length record. -? provides you with a help facility, showing the correct syntax for the command. cicsmfmt also displays this if you enter the command syntax incorrectly.
Examples
1. To list le shut001:
cicsmfmt shut001
2. To obtain help:
cicsmfmt -?
180
cicsmigrate cicsmigrate - Create migration script

Creates a shell script (On Open Systems) or a command le (Windows NT) which updates, or migrates, databases and DCE principal names to accommodate the changes required by a Program Temporary Fix (PTF) or a new release.
Syntax
On Open Systems: cicsmigrate [-r regionName | -s | -c | -p | -m] -g leName -o outputLog cicsmigrate -? On Windows NT: cicsmigrate regionName
Description
Use the cicsmigrate command after installing a PTF or a new release. cicsmigrate creates a migration shell script (On Open Systems) or a command le (Windows NT) which you can run to update resource databases and DCE principal names to provide for the changes required by the PTF or new release. This shell script (On Open Systems) or a command le (Windows NT) can: v Add new attributes v v v v Delete old attributes Add new resource classes Change the names for SFS Change an attributes value, for example, the minimum value, or the default v Add new resource denitions, for example a new model terminal or supplied transaction. The shell script (On Open Systems) or a command le (Windows NT) incorporates the cicsmigrateclass, cicsupdateclass, and cicscopystanza commands which make the appropriate changes. Although typically, in a standard installation, you do not normally need to make any modications, if you want to make any specic changes to the databases, such as changing the
181
cicsmigrate
default value of a new attribute, edit the migration shell script (On Open Systems) or a command le (Windows NT) before running it. The shell script (On Open Systems) or a command le (Windows NT) updates the permanent and auto-start images of the databases. To run the shell script (On Open Systems) or a command le (Windows NT) generated by the cicsmigrate command, you must be logged in as root or administrator and authenticated as cell_admin.
Options
-r regionName builds a migration shell script (On Open Systems) or a command le (Windows NT) which migrates only the named region (affects all the les in /var/cics_regions/region/database). Note: For Windows NT, regionName is sufficient; you do not need the -r option. regionName species the CICS region to be migrated. If regionName is not specied, the command only migrates the SFS resource denitions. Note: Note: -s -c builds a migration shell script (On Open Systems) which migrates only the SFS resource database builds a migration shell script (On Open Systems) which migrates only the default schema database (affects only the /var/cics_servers/SCD/SCD.stanza le). builds a migration shell script (On Open Systems) which migrates only the GSD resource database (affects only the les in /var/cics_servers/GSD). builds a migration shell script (On Open Systems) that migrates all the regions, SFS, schema and PPC gateway les on the host machine (affects all the les in /var/cics_servers/SSD). Once this migration script has been built and run for a new release, it should not be rebuilt for that release. Instead, either rerun the original script or migrate items individually.
-p
-m
-g leName species the name of the migration shell script (On Open Systems) to be created. -o outputLog species the name of the log le which will contain all the changes
182
cicsmigrate
made to the system when the shell script (On Open Systems) is run. outputLog is empty until the shell script (On Open Systems) is run. -? displays the usage message.
Examples
On Open Systems: 1. To create a shell script called migratescript that upgrades only the region database in region1, enter:
cicsmigrate -g /homes/mine/migratescript -o /tmp/logfile -r region1
To run the shell script:

ksh migratescript
/tmp/logfile is empty until you run the shell script migratescript. 2. To create a shell script called migratesfsscript that upgrades only the SFS resource database, enter:
cicsmigrate -g /homes/mine/migratesfsscript -o /tmp/logfile -s
3. To create a shell script called migrateallscript that upgrades all the regions and SFS on a machine, enter:
cicsmigrate -g /homes/mine/migrateallscript -o /tmp/logfile -m
On Windows NT: 1. To create a command le called migratescript that upgrades only the region database in region1, enter:
cicsmigrate region1
183
cicsmigrateclass cicsmigrateclass - Add and delete resource attributes

Adds new attributes and deletes old attributes from the resource denition le for a given class.
Syntax
cicsmigrateclass [-r regionName] [-w] -c className [-a attributeName {n defaultValue | -d | -u newAttributeName} ] [-f leName] cicsmigrateclass -?
Description
The cicsmigrateclass command adds, updates, or deletes the appropriate attributes in a resource denition le that needs to be changed because of an upgrade to CICS. The cicsmigrateclass commands are generated automatically and are included in the migration shell script which was created when you ran cicsmigrate. The updates to the attributes are mandatory. You can specify a new value using the cicsmigrate commands -n parameter, but you must not delete, or change cicsmigrateclass commands within the migration shell script. The syntax is described here so you can understand the shell script that cicsmigrate generates. In a migration shell script created by cicsmigrate, all cicsmigrateclass commands automatically include the -w ag.
Options
-r regionName species the name of the region database being modied. For most classes, you must specify the regionName parameter. It is optional only for the ssd, scd, and gsd classes. -w updates the autostart images.
-c className species the name of the class being modied. Valid classes are: cd fd gd gsd jd ld Communication denitions File denitions Gateway denitions Gateway server denitions Journal denitions Listener denitions
184
cicsmigrateclass
md od pd rd ssd scd td tdd tsd ud wd xad Monitoring denitions Object denitions Program denitions Region denitions Structured le server denitions Schema le denitions. Must be used with -f leName. Transaction denitions Transient data denitions Temporary storage denitions User denitions Terminal denitions Product denitions.
-a attributeName species the name of the attribute to add, modify, or delete. -f leName species the path and lename of the schema resource le. This option is valid only if -c scd is specied. -n defaultValue species the default value of a new attribute to add. -d deletes the attribute.
-u newAttributeName species the new name of the attribute. -? causes the usage message to be displayed.
Examples
1. To add the new attribute Salutation, with the value greetings, to every entry, including the default entry, in the User denitions for region1, enter:
cicsmigrateclass -r region1 -w -c ud -a Salutation -n "greetings"
2. To change the name of the attribute Salutation in the User denitions for region1 to Farewell, enter:
cicsmigrateclass -r region1 -w -c ud -a Salutation -u Farewell
3. To delete the attribute Farewell from every entry in the le for the User denitions in region1, enter:
cicsmigrateclass -r region1 -w -c ud -a Farewell -d
185
cicsmigrateclients cicsmigrateclients - Recongure DCE

AIX X HP-UX X Sun Solaris Windows NT
Recongures DCE for each host running a CICS client or region. Use this command only if you have changed your DCE principal names.
Syntax
cicsmigrateclients [ -I] [ -v] cicsmigrateclients [-?]
Description
This command creates a new DCE principal and account for the client and deletes the old principal and account. It sets new passwords for the account in the keytab le in the /var/cics_clients directory. If you are using DCE authentication you must be logged in as root or administrator and authenticated as cell_admin. Run this command on all hosts which run CICS clients or regions.
Options
-I -v -? (Uppercase letter i) Ignores errors. gives a detailed output while the command runs. causes the usage message to be displayed.
Examples
To recongure a DCE client after a patch has been installed, rst log in as root or administrator and authenticate as cell_admin, then enter:
cicsmigrateclients
186
cicsmkcobol cicsmkcobol - Create the cicsprCOBOL le

Syntax
cicsmkcobol [-o outFileName] [-L libraryPathName] ... [objectFileNames] [libraryNames]
Description
Creates the COBOL language method le and the COBOL runtime library. The cicsmkcobol command must be run whenever one of the following is installed: v A new version or release of Micro Focus COBOL v A new version or release of CICS applicable to your operating system v A new version or release of any supported database product cicsmkcobol creates the COBOL language method le and the CICS runtime library for Micro Focus COBOL support. It combines the object les containing the CICS COBOL-support routines with the COBOL runtime system to create a loadable and executable le, and a shared library containing the COBOL runtime support. The language method le is placed in the current directory as cicsprCOBOL unless another path and lename are specied using the -o option. The CICS COBOL runtime library is placed in prodDir/lib as libcicscobrtsrt.so libcicscobrtsrt.sl on CICS for HP-UX). Note: On Windows NT there is no specic action required to provide a language environment for CICS. The COBOL language method le cicsprCBFNT is provided in the c:\opt\cics\bin directory
Processing
To be used by CICS: v The COBOL language method le must be placed either in prodDir/bin or in /var/cics_regions/regionName/bin with the name cicsprCOBOL. Versions of the le placed in /var/cics_regions/regionName/bin take precedence over the le placed in prodDir/bin. This allows you to have different COBOL language method les for each region. v The CICS COBOL runtime library must be placed in a directory that is included in your library search path specied by the appropriate environment variable. On CICS for AIX the environment variable is LIBPATH; on CICS for HP-UX it is SHLIB_PATH. The sequential order in which the directories appear in the environment variable determines which
187
cicsmkcobol
libcicscobrtsrt.so le is used by CICS. This allows you to have different COBOL runtime libraries for each region. To run cicsmkcobol, v Log in as root or administrator. v Make prodDir/bin the current directory if you want to create a cicsprCOBOL le for use by all regions, or make /var/cics_regions/regionName/bin the current directory if you want to create a cicsprCOBOL le for use by region regionName. v Set the environment variable LD_LIBRARY_PATH to contain /opt/lib/cobol/coblib (or /opt/cobol/cobdir/coblib on CICS for HP-UX) to ensure correct linkage to the COBOL libraries. v Ensure that the PATH environment variable allows cicsmkcobol to nd: COBOL executable les.
For CICS for AIX, CICS for HP-UX only If COBOL is not installed in the standard directory, set the environment variables COBDIR and COBLIB to the directory where the COBOL executables are held. In the PATH environment variable, the executables directory (for example, $COBDIR/bin) must be before the COBOL driver directory (for example, /usr/bin). Operating system commands (such as echo, sed, and grep) The executable les for CICS on your operating system.
Options
-o outFileName (on CICS for AIX, and CICS for HP-UX only) species the name of the generated le. If the command is run without the -o parameter (and always on and CICS for Solaris), the le is named cicsprCOBOL and is placed in the directory prodDir/bin. -L libraryPathName species a directory you want to add to the library path used by cicsprCOBOL. This is useful where you want to include shared libraries. objectFileNames are the names of the object les you want to use (for example, C functions). Ths object les should be put into the $CICS/lib directory. libraryNames are the names of the libraries you want to use.
188
cicsmkcobol Examples
To create a cicsprCOBOL le in the current directory, enter:
cicsmkcobol
To create a cicsprCOBOL le in the bin directory of a region named regionA, enter:

cicsmkcobol -o /var/cics_regions/regionA/bin/cicsprCOBOL
189
cicsnotify cicsnotify - Deallocate resources

Use the cicsnotify command to deallocate resources left allocated when the region is no longer running.
Syntax
cicsnotify subsystemName
Description
This command is used to release resources and delete the region lock le when, due to a non-normal shutdown, resources are left allocated after the region is no longer running. Note: This command should only be used after a stopsrc (on CICS for AIX) or cicsstop (on all other CICS on Open Systems platforms) command has been used with the -c option, or when the region has failed to complete a shutdown in a logical manner.
Options
subsystemName is the subsystem name used by the region. This is normally in the form cics.regionName.
Examples
To deallocate resources in a specic CICS region called REGION1:
cicsnotify cics.REGION1
The CICS Administration Guide contains additional information on shutdown procedures.
190
cicsppcgwy cicsppcgwy - Start a PPC Gateway server

The purpose of the cicsppcgwy command is to start and initialize an Encina PPC Gateway server.
Syntax
cicsppcgwy [-I] [-t component:traceMask [:component:traceMask] ... ] [[-T traceClass [=traceClass ... ] = [modier,modier]outputClass:destination]...] [serverName] [attributeName=attributeValue ... ] cicsppcgwy -?
Description
v You must be logged in as a user who can run the startsrc (CICS for AIX) or cicsstart (all other CICS on Open Systems platforms) command. v The logical volume and userid for the PPC Gateway server must have been created by the user before this command is run. v If you are not using DCE servers, you must add an entry to /var/cics_servers/server_bindings after running cicsppcgwycreate. v CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, then refer to the Encina Administration Guide Volume 2: Server Administration for descriptions of alternative procedures. The cicsppcgwy command starts and initializes an Encina PPC gateway server. If for any reason cicsppcgwy encounters a problem, it leaves the PPC Gateway server as it is, to allow investigation of the problem. cicsppcgwyshut can then be used to shut down the PPC Gateway server when required. The servers details are retrieved from the stanza entry in /var/cics_servers/GSD/GSD.stanza (on cold starts), or /var/cics_servers/GSD/AUTO.stanza (on auto starts), and then the server is started using an operating system command. On CICS for AIX this is the startsrc command. Stanza attributes can be overridden by supplying one (or more) pairs of attributeName=attributeValue assignments. Note that the specication of a StartType override (cold or auto) determines whether the details are retrieved
191
cicsppcgwy
from the server database or its recovery-image. On CICS for AIX only, if the command is called from the SMIT panels cicscstartgsd or cicsastartgsd, this override is explicitly added. The -t and -T options are provided to allow the PPC gateway to be traced using the Encina trace facilities. It is expected that these options will only be used under the direction of your support organization, so they are not documented here in detail. See the CICS Intercommunication Guide for more information.
Options
-I -t ... -T ... causes errors to be ignored. species Encina trace masks. species Encina trace output classes. -T can be used more than once.
serverName is the full name of the server, such as /.:/cics/ppc/gateway/servername. If a server name is not given cicsppcgwy will use contents of the environment variable CICS_PPCGWY_SERVER. attributeName=attributeValue ... are overrides for database values. -? causes the usage message to be displayed.
Examples
1. To start and initialize the PPC Gateway server GATESERV1 with a StartType of cold, enter
cicsppcgwy /.:/cics/ppc/gateway/GATESERV1 StartType=cold
2. To autostart the PPC Gateway server GATESERV1, enter

cicsppcgwy /.:/cics/ppc/gateway/GATESERV1
192
cicsppcgwycreate cicsppcgwycreate - Create a PPC Gateway server server

The purpose of the cicsppcgwycreate command is to create an Encina PPC Gateway server.
Syntax
cicsppcgwycreate [-v] [-I] [-S] serverName [-m modelName] [attributeName=attributeValue ... ] cicsppcgwycreate -?
Description
v You must be logged in as root or administrator because cicsppcgwycreate adds a new SRC subsystem. v If you are using DCE authentication you must be logged in to DCE, with sufficient authority to create a DCE principal, account and keytab - usually the DCE cell administrator. v The userid, which is to be used as the gateway ShortName, must have been created. It should be dened with a primary group of cics and a home directory of /var/cics_servers/GSD/cics/ppc/gateway/userId. You will nd how to create a userid in the CICS Intercommunication Guide. v You must create a logical volume for the userid, called log_userId. v CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, then refer to the Encina Administration Guide Volume 2: Server Administration manual for descriptions of alternative procedures. cicsppcgwycreate cannot be used to create an Encina PPC Gateway server on a remote machine because the underlying startsrc (CICS for AIX) or cicsstart (all other CICS on Open Systems platforms) command has no host parameter. A remote Encina PPC Gateway server must be created manually on the remote machine. The cicsppcgwycreate command is used to add a PPC Gateway server server into the server database. It also adds an SRC entry, the CDS entry, and registry and keytab entries. An invalid option will result in an error message being displayed. With no options specied cicsppcgwycreate will display the usage message for this command.
193
cicsppcgwycreate
If you are not using DCE servers you must add an entry to /var/cics_servers/server_bindings after running cicsppcgwycreate.
Options
-v -I -S (verbose) Messages describing the progress of the server creation are displayed. causes errors to be ignored. causes the PPC Gateway server server to be created without using DCE servers.
serverName is the name of the PPC Gateway server server (GSD.stanza key). -m modelName species the name of a model server. attributeName=attributeValue ... overrides for database values. -? causes the usage message to be displayed.
Examples
1. To create the PPC Gateway server server GATESERV1 using the model server MODELGATE, enter
cicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 \ -m /.:/cics/ppc/gateway/MODELGATE
2. To create the PPC Gateway server server GATESERV1 with a short name of GATESERV1, enter
cicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 ShortName=GATESERV1
194
cicsppcgwydestroy cicsppcgwydestroy - Destroy a PPC Gateway server

The purpose of the cicsppcgwydestroy command is to destroy an Encina PPC Gateway server.
Syntax
cicsppcgwydestroy [-v] [-S] serverName cicsppcgwydestroy -?
Description
v You must be logged in as root or administrator. v If you are using DCE authentication you must have the DCE credentials to delete the principal/account for the principal. v CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, then refer to the Encina Administration Guide Volume 2: Server Administration manual for descriptions of alternative procedures. The cicsppcgwydestroy command is used to destroy a PPC Gateway server, by removing the log restart les, all details about the server from the /var/cics_servers directory, and the relevant DCE entries. The SRC entry for the server is also removed. Note: Use this command with care because, although a PPC gateway can be recreated, data associated with the gateway is lost.
Options
-v -S (verbose) Messages describing the progress of the destruction of the server are displayed. causes the PPC Gateway server server to be destroyed without using DCE servers.
serverName is the name of the PPC Gateway server. -? causes the usage message to be displayed.
195
cicsppcgwydestroy Examples
To destroy the PPC Gateway server GATESERV1, enter
cicsppcgwydestroy /.:/cics/ppc/gateway/GATESERV1
196
cicsppcgwylock cicsppcgwylock - Lock or unlock a PPC Gateway server

The purpose of the cicsppcgwylock command is to take or release an Encina PPC Gateway server lock.
Syntax
cicsppcgwylock { -l | -u | -t } serverName cicsppcgwylock -? CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, then refer to the Encina Administration Guide Volume 2: Server Administration manual for descriptions of alternative procedures. The cicsppcgwylock command either takes or releases a lock for a specied PPC Gateway server. It is used to serialize the create, start, stop, and destroy phases of a PPC Gateway server. Each PPC Gateway server (/.:/cics/ppc/gateway/serverName) has a lock le called /var/cics_servers/GSD/cics/ppc/gateway/serverName/lock.
Options
-l -u -t cicsppcgwylock to wait until the PPC Gateway server that owns the lock le is no longer running and then takes the lock. causes the lock le for the PPC Gateway server to be released unconditionally. cicsppcgwylock to try to take the lock le but to return immediately if it is unsuccessful.
serverName is the name of the PPC Gateway server for which the lock is to be taken or released. -? causes the usage message to be displayed.
Returned Values
0 1 Successful Unsuccessful
197
cicsppcgwylock Examples
1. To take the lock on the PPC Gateway server GATESERV1 and return error if it is not free, enter
cicsppcgwylock -t cicsppcgwylock -u /.:/cics/ppc/gateway/GATESERV1 /.:/cics/ppc/gateway/GATESERV1
2. To release the lock on the PPC Gateway server GATESERV1, enter
198
cicsppcgwyshut cicsppcgwyshut - Shut down a PPC Gateway server

The purpose of the cicsppcgwyshut command is to shut down an Encina PPC Gateway server.
Syntax
cicsppcgwyshut [-f] [-c] serverName cicsppcgwyshut -?
Description
v You must be logged in as a user who can run the stopsrc (on CICS for AIX) or cicsstop (on all other CICS for Open Systems platforms) command. v If you are using DCE authentication, you must be logged in to DCE. v CICS must be installed on the same machine as the PPC Gateway server. If CICS is not installed on the same machine as the PPC Gateway server, then refer to the Encina Administration Guide Volume 2: Server Administration manual for descriptions of alternative procedures. The cicsppcgwyshut command shuts down a PPC Gateway server for a CICS region. It also removes the lock on the server after a successful shutdown.
Options
-f -c forces a shutdown of the PPC Gateway server. cancels the SRC subsystem in which the PPC Gateway server is running.
serverName is the name of the PPC Gateway server. -? causes the usage message to be displayed.
Examples
To force a shutdown of the PPC Gateway server GATESERV1, enter
cicsppcgwyshut -f /.:/cics/ppc/gateway/GATESERV1
199
cicsremovelv cicsremovelv - Remove a logical volume

The cicsremovelv command removes a logical volume that was created by cicsmakelv.
Syntax
cicsremovelv -v volumeName cicsremovelv -?
Description
You must be logged on as a user who has administrative privileges The cicsremovelv command deletes a logical volume and removes the NT Registry information for the volume. This command destroys all data on the logical volume; the data cannot be recovered at a later time.
Options
-v volumeName species the name of the logical volume that is to be deleted.
Examples
1. To delete the logical volume known as sfs_Server1:
cicsremovelv -v sfs_Server1
200
cicsrlck cicsrlck - Remove old region lock les

Use this command to remove any lock les for a region left by a CICS process that terminated in an uncontrolled manner.
Syntax
cicsrlck [-f] { -a | -r regionName} cicsrlck -?
Description
The cicsrlock command removes any CICS lock les left by a CICS process that terminated in an uncontrolled manner. You must use this command with great care because the -a and -f ags enable you to override CICS locking mechanisms, allowing you to run multiple CICS processes in the same region. The cicsrlck command writes a message to the system log for each lock le that it removes.
Options
-f -a removes a single lock le from the region whose owning CICS process is still running. unconditionally removes the lock les from all regions. If the region or regions are still running, the locks are removed regardless of whether or not the -f ag is specied.
-r regionName species the region name when removing a single lock le. The cicsrlck command checks that regionName is valid. If regionName is invalid, cicsrlck writes an error message to standard error. If you do not specify a region name, CICS removes the lock les for the region specied by the CICSREGION environment variable. -? displays the usage message that shows the correct syntax for the cicsrlck command. If you enter the command syntax incorrectly, the correct usage is displayed.
Examples
1. To remove all CICS lock les:
cicsrlck -a
2. To remove the CICS lock le for the CICS region REGIONB:
201
cicsrlck
cicsrlck -r REGIONB
202
cicssdt cicssdt - SFS diagnostic tool

The CICS SFS Diagnostic Tool (SDT) provides an interactive interface to the SFS.
Syntax
cicssdt [-s SFSname] [-i inputFile] [-o outputFile] [-e] [-r] [-c SDTcommands ...] cicssdt -?
Description
v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v You must have an active SFS. v If you are using DCE authentication you must have a DCE context that has sufficient authority to: Create a DCE principal and account. Create a Server Key Table. Usually this is a DCE cell administrator. v If you are not using DCE authentication, you must have the environment variable ENCINA_BINDING_FILE set.
Options
Note: Except for -c, which must be the last parameter, the parameters can be in any order. -s SFSname species the name of the SFS. For example, /.:/cics/sfs/SFS1. If this option is not specied, the server name in the environment variable CICS_XDT_SERVER is used. CICS_XDT_SERVER overrides CICS_SFS_SERVER. -i inputFile species a text le containing SDT commands to be read and executed. The le can be created either by hand or by using the -o option. Each line of the input le is treated as if it were typed in interactive mode. The text from the input le is also displayed as it is processed by cicssdt. Comments can be included in the le by starting a line with /*.
203
cicssdt
For example, if you create an input le called create.input that contains the following lines:
/* /* This is a sample file to create a SFS file called qsamTest /* create qsamTest b fl byteArray 10 f2 varLenByteArray 100 f1 y f1 a 1 quit
then execute cicssdt as follows:

cicssdt -s SFSname -i create.input
A new le called qsamTest is created on the specied SFS. -o outputFile causes commands entered in the SDT session to be written to the specied output le. This le can then be used as an input le using the -i option. -e requests SDT to terminate if an error occurs. If -e is specied and SDT is being driven from a shell script (-i) or the command line (-c), any error resulting from a command will exit SDT with a non-zero return code. activates SDT statistics. Statistics for SDT and SFS calls are sent to a le called sdt.stats in the current directory. This is useful for monitoring performance.
-r
-c SDTcommands ... species a list of commands and text to be used in the SDT session. This is useful for calling SDT commands from a shell script. This parameter must be used last. Using the SDT commands: To issue commands in SDT, pass them to SDT using the -i or -c option, or type the command at the command prompt. SDT accepts command abbreviations. In the command syntax the minimum abbreviation is shown in parentheses; for example, (s)etopen. Any command
204
cicssdt
that requires a le name will default to the last name used if nothing is given at the prompt. SDT also recognizes any environment variables used at the command prompt. SDT commands - setopen (s)etopen Denes the characteristics of any open calls used in other SDT commands. Non-transactional opens are used by default. If the open is transactional, SDT will manage the client transaction for you. This command also lets you dene the locking mode used during a read, (the default is no lock or a dirty read). If a value of zero is specied for the OFD operation timeout this effectively denes no timeout, such as wait forever. Error Isolation can only be inactive for transactional OFDs.
cicssdt -s SFSname -c setopen [Type In New Letter To Change Value. Just <ENTER> To Leave Asis ... [Access Mode - [S]hared/[E]xclusive - (SharedAccess): [Timeout For OFD Operations (In Seconds) - (60 ): [Consistency - [T]ransactional/[N]on-Trans - (Non-Transactional): t [Turn Error Isolation Off ? .............................. Y/[N]: y [Lock Mode - [R]ead/[W]rite/[B]racket/[N]one - (No Lock):
SDT commands - list (l)ist [(l)] searchString Lists all the les on the server that SDT is accessing. If the l option is used, additional information is given for each le. If SDT cannot open a le to obtain long information, processing continues with the next le. A search string can also be given to list specic les. If a search string is used, SDT will look for all the lenames that contain the string. There are no wild card characters, so the search string is taken as entered.
cicssdt -s SFSname -c li l AC1cics File Name ================== AC1cicsnlqfile AC1cicsnrectsqfil AC1cicsplqfile AC1cicsrectsqfile AC1cicstdqlgfile Organisation ===================== btreeClustered (KSDS) btreeClustered (KSDS) btreeClustered (KSDS) btreeClustered (KSDS) btreeClustered (KSDS) Primary Index No. Records =============== =========== cicsnlqidx (empty) cicsnrectsqidx (empty) cicsplqidx (empty) cicsrectsqidx (empty) cicstdqlgidx (empty)
SDT commands - create (c)reate leName Creates a new SFS le. All the le information is prompted for in turn. To aid usability and eliminate creation errors, SDT will make
205
cicssdt
sure everything entered is valid and default to sensible values if nothing is entered. One exception is the record Field Name and index Field Name that use an empty entry to indicate there are no more elds. Also, some elds may not be able to determine a default entry and reprompt for input after displaying some help. If q! is entered at any prompt the create is cancelled.
cicssdt -s SFSname -c create qsamTest [SFS Server Volume Name .....: sfs_SFS_SERV [File Organisation [E/R/B] ..: B[treeClustered] [Field 01: Name .............: f1 [Field 01: Type .............: Error: Invalid field type. Type must be: unsignedInt16, signedInt16, unsignedInt32, signedInt32, unsignedInt64, signedInt64, float, double, string, nlsString, byteArray, varLenByteArray, shortVarLenByteArray, timestamp or decimal. [Field 01: Type .............: byteArray [Field 01: Size .............: 10 [Field 02: Name .............: f2 [Field 02: Type .............: varLenByteArray [Field 02: Size .............: 100 [Field 03: Name .............: [Maximum Number Of Records ..: SFS_NATURAL_RECORD_LIMIT [Primary Index Name .........: f1 [Is Index Unique ? [Y]/N ....: Y [Index Field 01: Field Name .: f1 [Index Field 01: Ordering ...: a[scending] [Index Field 02: Field Name .: [Number Of Pages To Allocate : 1
SDT commands - read (r)ead leName Reads records from a le on the SFS. Records can be read from the beginning of the le or from a specic key based on any active index. Records can also be read continuously or individually. When a key value is specied it is taken as a string unless it is in the format #n, where n is a numeric value. The following format can be used for a hexadecimal representation of the key:
0x0a01 ...
A key that corresponds to a string eld must be entered in the form:

$string
If the read is not continuous you have the option to delete or update each record read. If the record is to be updated the primary index cannot be changed. If nothing is entered for a eld during an update the eld is left unaltered, otherwise data entry is same as for the write
206
cicssdt
command. This command will not handle , nor will it handle reads using the Entry Sequence Number for sequential les. It will, however, handle alternate index reads, that is, reads using the SFS secondary index. The read command will only show up to 44 bytes of eld data and should therefore not be used to check the data integrity of records containing long elds. The stof command is more suitable for this.
cicssdt -s SFSname -c r qsamTest [Index To Use ...............: f1 [Read From Beginning ? [Y]/N : Y [Continuous Read ? Y/[N] ....: N [Read #00000001 [f1 ][........@@ ][000010] [Hex][01C3D7E2E2C4D4F14040 ] [f2 ][@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@.............][000126] [Hex][4040404040404040404040404040404040404040404040 ] [Read Another, Delete or Update ? [Y]/N/D/U n [1 Record(s) Read]
SDT commands - write (w)rite leName Writes records to a le on the SFS. Text or hexadecimal data can be entered in each eld; these cannot be mixed. Hexadecimal is entered in the following form:
0x010203 ...
If the eld is long and you need to enter a large amount of data, a shorthand method can be used. For example, to ll the remainder of a eld with 33 A characters enter
A>>32
or enter
0x20>>32
for 33 spaces. You must enter something in at least one of the elds in the record for SDT to write it; if all are left blank no record will be written. Partly lled xed-length elds are not automatically padded with spaces. If A>>32 would exceed the eld length the string A>>32 is taken literally. Automatic writes can be achieved by specifying #N followed
207
cicssdt
by the number of writes in an unsignedInt32 eld. For example, use #N10 to add 10 records automatically. If #N or #N0 is specied, writes will continue until an error occurs.
cicssdt -s SFSname -c w recover [skey1 [001 [srecord1 [Some text [Another ? [Y]/N n [1] Record(s) Added OK. ][ byteArray ][ byteArray ] [Size:00008] ] [Size:00042]
SDT commands - empty (e)mpty leName Empties a le of all committed records. SDT provides two types of record emptying; an exclusive empty and a shared empty. An exclusive empty will attempt to get exclusive access to the le to issue an empty call. If a shared empty is requested SDT will delete as many records as it can, leaving the ones that are locked. The exclusive empty is recommended as this guarantees an empty le.
cicssdt -s SFSname -c empty recover [Exclusive Empty ? [Y]/N ....: Y [Empty File "recover" ? Y/[N] y
SDT commands - delete (d)elete leName Deletes a le from the SFS. This command will time out and fail if the le is still in use.
cicssdt -s SFSname -c delete recover [Delete File "recover" ? Y/[N] y
SDT commands - free (fr)ee leName Destroys all the Open File Descriptors (OFDs) associated with a particular le. This command should only be used if the le is not in use. SDT will tell you the transaction identiers related to each OFD it destroys. The transaction identiers will not necessarily disappear with the OFD. Use tkadmin commands to check the status of the transaction identiers if the le still remains locked. For details of tkadmin commands, see the Encina Administration Guide Volume 1: Basic Administration.
208
cicssdt
cicssdt -s SFSname -c free recover [Are You Sure You Want To Close All OFDS On This File ? Y/[N] y [Closing All OFDs on File: recover... --------------------------------------------------------[OFD 00000307:(TIDS 03211413) ..... Closed. ---------------------------------------------------------
SDT commands - addindex (a)ddindex leName Adds a secondary index to the SFS le. Exclusive access is required for this command, so the le should not be in use. The secondary index will be added and made active automatically. Typing q! will cancel the command.
cicssdt -s SFSname -c a Angus [Filename ...................: [Secondary Index Name........: [Is Index Unique ? [Y]/N ....: [Alternate Rec. Spec. ? Y/[N]: [Index Field 01: Field Name .: [Index Field 01: Ordering ...: [Index Field 02: Field Name .: Angus index2 n N f2 d[escending]
SDT commands - delindex (deli)ndex leName Deletes a secondary index from the SFS le. Exclusive access is required for this command, so the le should not be in use.
cicssdt -s SFSname -c delindex Angus [Secondary Index Name........: index2
SDT commands - info (i)nfo leName Shows detailed information about the SFS le. This command will list all the active Open File Descriptors (OFDs) and locks held on the le. This is particularly useful to see if a le is still in use or has unresolved transactions using it.
cicssdt -s SFSname -c i Angus [Information For File: Angus ] ---------------------------------------------------------------[File Organisation ] btreeClustered (KSDS) [Primary Index Name ] f1 (Unique index) [Primary Index Field(s) ] f1 [Secondary Index Names ] (None Defined) [Number Of Records In File ] 4
209
cicssdt
[Number Of Fields Per Record] 2 [Field 001: f1 ][byteArray] [Size:10 ] [Field 002: f2 ][unsignedInt32] [Size: 4 ] ---------------------------------------------------------------[OFD: 0000052 DCE Owner: (Not defined) Access: Shared Mode] Type: Transactional TID: (n/a) RPC Count: 00000002 Isolation: Cursor Stability Op. Timeout: 60 (Secs) Open TID: 65669 Idle Timeout: 300 (Secs) Label: (null) Open Time: Tue Aug 23 11:16:52 1994 [OFD: 0000055 DCE Owner: (Not defined) Access: Shared Mode] Type: Transactional TID: 65681 RPC Count: 00000002 Isolation: Cursor Stability Op. Timeout: 60 (Secs) Open TID: 65649 Idle Timeout: 300 (Secs) Label: (null) Open Time: Tue Aug 23 11:17:26 1994 [Locks Held Against TID: 65681] Lock 01: File (Null Lock) Lock 02: Record Write Intent Lock Lock 03: Record Write Lock held on index f1 ----------------------------------------------------------------
SDT commands - server (ser)ver serverName Changes the current SDT server to the new one specied. The complete server name must be given. If the new server cannot be contacted the old server remains current.
cicssdt -s SFSname -c ser /.:/cics/sfs/jim [Contacting new server... (Server OK)]
SDT commands - qtos (qt)os QSAMleName Transfers and converts a QSAM le to an SFS le.
cicssdt -s SFSname -c qtos qsam [Default Code Pages: EBCDIC (IBM-037) -> ASCII (ISO8859-1) ... [Transferring Records. Record No.][00000022]
SDT commands - stof (st)of SFSleName Transfers an SFS le to a at le. The format of the at le can either be SDT format or Asis (the le is transferred byte by byte as it is). In SDT format the at le will start with a header containing information on the structure of the le, followed by a newline character and an eight-byte number. The number is the length of the record excluding the number itself. If the le is transferred Asis, no extra information is contained in the at le. A single record or a range of records can be
210
cicssdt
dumped. The record number corresponds to the position of the record using the primary index. To dump record 10, enter 10 at the [Dump Record(s) prompt. Type 10- to dump records from 10 onwards and type 10-12 to dump records 10 to 12 inclusive.
cicssdt -s SFSname -c stof Angus [Flat Filename ..............: Angus.sdt [Dump file Asis ? ..... Y/[N]: N [Dump Record(s) .............: ALL [File "Angus.sdt" Already Exists. Overwrite ? [N]/Y y [Dumping All Records] [Dumping Record #][00000010]
SDT commands - ftos (f)tos SFSleName Transfers a at le produced from the stof command to an SFS le. The SFS le must already exist, but does not have to be the le used to create the at le. In fact, ftos will transfer anything that will t into the specied SFS le. See the stof command for the expected at le format. If the SFS le does not exist and the at le is in SDT format, SDT will ask if you want the le to be created. If the at le is not in a recognised format produced using the stof command, ftos will read the at le as it is and will attempt to t the data into the SFS le.
cicssdt -s SFSname -c f Angus [Filename ...................: Angus [Flat Filename ..............: Angus.sdt [Loading Record #][00000010]
SDT commands - ! Escapes to a system command prompt. Exiting the command prompt returns control to SDT.
cicssdt -s SFSname -c ! [Exit To Shell. Use <Ctrl-D> To Return ..... ls q* (Open Systems) or dir q*.* /w (Windows NT) qsam qsam.dfh qsam.conv qsam.log qsam.def qsam.sdt.def |D
qsamTest qsamcsd qsamcsd.dfh
qsamcsd.sdt.def qsamcsd.sdt.log qtest
SDT commands - quit
211
cicssdt
(q)uit Exits SDT and returns control to the calling process.
cicssdt -s SFSname -c q
SDT commands - help or ? (h)elp (or ?) commandName Gives general or specic online help for SDT commands.
cicssdt -s SFSname ? create
QSAM to SFS le transfer: The purpose of this section is to help you understand how to transfer QSAM les from a host system to a target system running a CICS for Open Systems product. When a le is sent directly to a target system, record boundaries are lost when it is received. By capturing the le on TSO or CMS in netdata format and sending it as a binary le to the target system using the File Transfer Program (ftp), the original netdata format is preserved. The cicsnetdata program is used to read the le and re-construct the output records with the count preceding each record, as expected by the cicssdt qtos command. If a le is in netdata format, you will nd that control records INMR01, INMR02, INMR03 precede the data, and INMR06 follows the data; these names are in EBCDIC. All input (control records and data) is segmented. The rst byte of a segment contains the segment length, including itself. The second byte of the segment contains a ag byte. The ag settings are:
0x80 first segment 0x40 last segment 0x20 segment is part of a control record
To transmit a le from TSO: 1. Enter: transmit (nodeName/userId) DSN (data.le) OUTDSN(data.NETDATA) SEQ TRANSMIT can be abbreviated to XMIT. nodeName/userId is required syntactically. Although it is not used when transmitting to a le, it is validated, so specify a known node and userid. DSN names the input to XMIT. OUTDSN names the output netdata le. The type NETDATA is suggested. If the input was a PDS member, then SEQ is required, or the le will not be usable on the target system. The name of utility function must be INMCOPY for correct results (see sample messages below). 2. Enter: ftp systemName
212
cicssdt
where systemName is the name of the target system. Enter userid and password when prompted. 3. Enter: cd directoryName to change to the target directory if necessary. 4. Enter: binary to set the transmission type to I (image). 5. Enter: put data.NETDATA The target le name can also be specied, if different from the source. Make a note of the byte count, which should be the same for the le on the target system. The target system keeps the name in lower case, even though it was upper case in TSO. To transmit a le from CMS: 1. Enter: sendle dataFile TO * to send the le to your reader in netdata format. Do not receive it because receive will decode the netdata. Use CP commands to order it and change its class to suit the reader. Dene a temporary disk if the le is large. 2. Enter: read data NETDATA A to read the le and preserve the netdata format. 3. Enter: ftp systemName where systemName is the name of the target system. Enter userid and password when prompted. 4. Enter: cd directoryName to change to the target directory if necessary. 5. Enter: binary to set the transmission type to I (image). 6. Enter: put data.NETDATA The target le name can also be specied, if different from the source. Make a note of the byte count, which should be the same for the le on the target system. The target system keeps the name in lower case, even though it was upper case in CMS. To run the cicsnetdata program: cicsnetdata < data.netdata > outputle Messages are sent to the operating system le stream stderr. Messages from a sample run of cicsnetdata (origin CMS):
213
cicssdt
... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... control record: INMR01 logical record length origin node name origin userid BAILEYM target node name target userid * origin time stamp no of files 1 control record: INMR02 file number 1 file size in bytes file organisation logical record length name of utility function record format 8000 name of the file filemode number0 last change date control record: INMR03 file size in bytes file organisation logical record length record format 0001 control record: INMR06 22 input records 4 control records 18 output records 80 WINVMB WINVMB 19931029164640000000
2048 4000 80 INMCOPY A DATA FILE 19920611095242000000 2048 4000 80
Denition les used by qtos: In addition to the QSAM data le produced by the cicsnetdata program there must be two other denition les for a successful conversion: v QSAMlename.sdt.def This le must be in the same directory as the QSAM data le. It contains the key and data information about each QSAM record. The sample le qsam.sdt.def, describes what each tag means. A sample data le can be found in prodDir/src/examples/sdt. v QSAMlename.dfh This le must also be in the same directory as the QSAM data le and is the DFHCNV template source for the QSAM records. SDT will not validate this le so it is recommended that the le is checked using the cicscvt program rst. SDT only understands the source, not the compiled output from cicscvt. The sample le qsam.dfh shows a typical template. To run qtos: A sample QSAM data le qsam.netdata has been provided to demonstrate QSAM to SFS conversion using the qtos command. The following describes the steps necessary to convert this example:
214
cicssdt
1. Convert qsam.netdata to SDT-readable format using the cicsnetdata program as follows:
cicsnetdata < qsam.netdata > qsam
to produce a le called qsam in the current directory. 2. Create a suitable SFS le to receive the QSAM records. For this example, enter
cicssdt -s SFSname -c create qsamTest
3. Make sure you have the following les in a directory you can write to:
qsam qsam.dfh qsam.sdt.def
The default code pages for conversion are dened at the top of the le qsam.dfh; these may have to be changed, depending on your operating system. 4. Run cicssdt so that it is working with the server which has qsamTest on it. Enter
cicssdt -s SFSname -c qtos qsam
The le qsam must be in the current directory. SDT will show a running count of the records being transferred. If an error occurs the le must be emptied before it is reloaded, unless the setopen command has been previously used to give a transactional load. 5. When the command has nished the SDT prompt should reappear and a log le will have been created in the current directory. The le will be called qsam.sdt.log in this example. Check this log le to make sure SDT picked up all the record types and there were no conversion errors.
215
cicssetupclients cicssetupclients - Congure DCE for the CICS clients

If you are using DCE authentication the command cicssetupclients is used to congure a DCE client for a CICS client or region. On CICS for AIX only, it is also used to install the AIX kernel extensions used by the CICS terminal emulator. You must run this command once for each host before you run a terminal or region. You may also need to use this command if you add or change a network card in your client machine since the card number is used to generate the principal name for the client.
Syntax
cicssetupclients [-I] [-v] [-m] [-d] cicssetupclients -?
Description
v You must be logged in as a user with root or administrator privileges. v You must be authenticated as a DCE principal with authority to create other principals (cell_admin, for example). If you are using DCE authentication use this command to congure a DCE client for a CICS client.This command creates a keytab le containing the clients principal and account. The keytab le is placed in the directory /var/cics_clients. Run this command on all hosts which will run CICS clients or regions. On CICS for AIX only, use this command to install the AIX kernel extensions used by the CICS terminal emulator. If you are not using DCE authentication and you are not running CICS for AIX you do not need to use this command at all.
Options
-I -v -m (Uppercase letter i) Ignores errors. gives a detailed output while the command runs. installs the kernel extensions on CICS for AIX only without conguring DCE.
216
cicssetupclients
-d -? congures DCE but does not install the kernel extensions on CICS for AIX only. displays the usage message.
Examples
To congure DCE for a newly installed CICS client, rst log in as root or administrator and authenticate your DCE principal, then enter:
cicssetupclients
217
cicssetupdce cicssetupdce - Create directories and groups within a DCE cell

Creates directories and groups for CICS within DCEs Cell Directory Service.
Syntax
cicssetupdce [-v] [-C | -I [-a | -o]]
Description
cicssetupdce adds the following directories and groups to DCEs Cell Directory Service. The directories will eventually contain entries for SFS and regions: Directories: /.:/cics CDS directory /.:/cics/ppc CDS directory /.:/cics/ppc/gateway CDS directory /.:/cics/trpc CDS directory /.:/cics/tmxa CDS directory /.:/cics/prole CDS prole /.:/cics/sfs CDS directory Groups: cics_users contains principals for CICS processes cics_admin contains principals for CICS administrators cics_sfs contains principals for SFS cics_ppcgwy contains principals for PPC group
218
cicssetupdce
cics_regions contains principals for CICS regions You need to run cicssetupdce only once per DCE cell, during the conguration of a newly installed CICS system. To run it, you must be authenticated as a DCE principal (such as cell_admin) with sufficient privileges to create or view a DCE group, directory or object and to set the necessary Access Control Lists (ACLs). ACLs control the security of directories. Use cicssetupdce to set the ACLs for each newly created directory so that the members of the appropriate group, the principal that is executing the command, the CDS groups subsys/dce/cds-admin and subsys/dce/cds-server have access to the directory and its objects. Members of the other groups are granted more restrictive access to these directories based on their needs. cicssetupdce also sets the initial container and initial object ACLs. cicssetupdce rst searches to see if the groups and directories it is about to create currently exist. If you specify the -l ag when you invoke cicssetupdce, it overwrites any existing groups or directories with new ones. You can use the -a or -o option to control how cicssetupdce changes the ACLs of existing directories or groups. If neither of these ags is specied, then the ACLs for pre-existing directories are left unchanged because to alter these ACLs may compromise security. If the -l ag wasnt used, cicssetupdce stops with an error code when it encounters a pre-existing group or directory. Note: Make sure that your /etc/hosts le contains a valid host name and that its permissions are set correctly.
Options
-I (Uppercase i) Ignores error messages about pre-existing entries. Error messages are changed to warning messages and cicssetupdce continues, overwriting existing directories and groups with new ones. Use this ag if a DCE cell has already been partially pre-congured, possibly by a previous invocation of the command that was interrupted. ACLs dening how the groups access the CDS directories are added to the ACLs for the existing CDS directories. ACLs dening how any other principals or groups access these directories are not changed. If you use this option, check that the resulting ACLs meet your security needs. Use this with the -l ag ACLs dening how the groups access the CDS directories override the ACLs for the existing CDS directories. Any pre-existing ACLs for other principals or groups are removed. This ag can be used only in
-a
-o
219
cicssetupdce
a cell whose CDS server principals are members of group subsys/dce/cds-server. Use this with the -l ag. -C removes any existing CICS groups and CDS directories prior to recreating them. Accounts that are members of these groups are also deleted. Using this ag is equivalent to executing cicscleandce before running cicssetupdce. Use this parameter only if you know that none of the entities selected for removal are required. gives a detailed output while the command runs.
-v
Examples
1. If you want to permit access to CICS directories by CICS groups without revoking other groups access, enter:
cicssetupdce -I -a
This creates the required groups and directories. If pre-existing directories are discovered, cicssetupdce adds to their ACLs, the ACLs dening the access privileges for the CICS groups. 2. If you want cicssetupdce to display what it is doing while it creates the required groups and directories and to fail if it discovers pre-existing groups or directories, enter:
cicssetupdce -v
Because you have not specied the -l ag, cicssetupdce stops with an error code if it discovers a pre-existing group or directory.
220
cicssfmt cicssfmt - Statistics formatter

To extract data from a statistics le or les that CICS creates as part of a CICS statistics sequence.
Syntax
cicssfmt [-c categoryNames] [-s startTime] [-e endTime] [-l pageLength] [-w pageWidth] [-h] [-i] leName1 ... leNamen cicssfmt [-?]
Description
cicssfmt formats the CICS statistics data into a form that can easily be written to operating system standard output. cicssfmt is requested from the operating system shell, and can be replaced with your own customized version. This information describes the version delivered with CICS and this may not correspond to the version running on your system. If you specify too few or too many parameters, or enter the -? option, cicssfmt sends some explanatory text on how to use the command to the operating system standard error output. If the named statistics le does not exist, cicssfmt outputs an error to the standard error output. If the named statistics le exists, cicssfmt formats all statistics records to standard output. cicssfmt is a sample program generated from the source le cicssfmt.c. It can be built with the sample makele in the directory prodDir/src/samples/sfmt using the command make -e -f Makele (on Open Systems) or nmake -e -f Makele (on Windows NT). If you want to replace cicssfmt with your own program, you must change the sample makele accordingly. The following les make up the statistics data formatter:
Table 4. Statistics data formatter les
File prodDir/bin/cicssfmt (CICS on Open Systems) or prodDir/bin/cicssfmt.exe (CICS for Windows NT) Type executable Contents The executable statistics formatter program
221
cicssfmt
Table 4. Statistics data formatter les (continued)
File Type Contents Sample statistics formatter program source
prodDir/src/samples/sfmt/cicssfmt.c, source prodDir/src/samples/sfmt/cicssf_delta.c, prodDir/src/samples/sfmt/cicssf_summ.c, prodDir/src/samples/sfmt/cicssf_supp.c prodDir/src/samples/sfmt/Makele makele
Sample makele that builds and installs the statistics formatter Library containing the functions for reading and processing a statistics data le Denitions used by the sample statistics formatter English messages used by the sample statistics formatter Message catalog for cicssfmt produced by gencat. Only required by formatter programs compiled with CICS release 2.1.1 or earlier.
prodDir/lib/libcicssfmtsa.a (CICS on Open Systems), prodDir/lib/libcicssfmtsa.lib (CICS for Windows NT) prodDir/include/cicssfmt.h prodDir/include/cicssfmt_msg.h
object library
include include
/msg/en_US.iso8859/cicssfmt.cat (CICS for HP-UX) prodDir/msg/en_US/cicssfmt.cat (CICS for AIX and Solaris)
message text
Options
-c categoryNames species a comma-separated list of categories to be formatted. If the -c option is not specied, all categories are formatted. The categories are as follows: DUMP Dump statistics FILE File statistics
ISCM Intersystem Communication Management statistics JOUR Journal statistics LUWM Logical Unit of Work Management statistics PROG Program statistics RTDB Runtime Database statistics STOR Region Storage statistics
222
cicssfmt
STOT Task Storage statistics TASK Task statistics TERM Terminal statistics TDQU Transient Data Queue statistics (summary statistics only) TRAN Transaction statistics TSQU Temporary Storage Queue statistics (summary statistics only) Note: CICS does not collect summary statistics for the TRAN category. However, it does collect details, so to obtain transaction statistics, you must specify the TRAN category with the -i option. -s startTime species the start time for the report to be produced. You should specify the time in the format yymmddhhmmss. The default starting time is the timestamp on the rst record in the le. -e endTime species the end time for the report to be produced. You should specify the time in the format yymmddhhmmss. The default ending time is the timestamp on the last record in the le. -l pageLength species the length, in lines, of each page of the report. The default value is 24 lines on each page. -w pageWidth species the width, in columns, of each page of the report. The default value is 80 columns. -h -i suppresses the printing of page headers. The default is to print page headers. indicates that detailed statistics are required. The default is to produce summary statistics.
leName1 ... leNamen species the les containing the CICS-generated statistics. -? causes the usage message to be displayed. cicssfmt also displays the usage message if you enter the command syntax incorrectly.
Examples
1. To list statistics le shut001:
cicssfmt shut001
223
cicssfmt
2. To list transaction interval statistics produced from 9 a.m. on January 1st, 1995 onwards, from le shut001 with no page headers:
cicssfmt -c TRAN -s 950101090000 -h -i shut001
3. To list le summary statistics produced up to 6 p.m. on January 1st, 1995, from le shut001 with no page headers:
cicssfmt -c FILE -e 950101180000 -h shut001
4. To list statistics le shut001 with a report page width of 70:

cicssfmt -w 70 shut001
See the CICS Administration Guide for additional information.
224
cicssfs cicssfs - Start a CICS SFS

You use this command to start an SFS that CICS uses.
Syntax
Syntax (CICS on Open Systems) cicssfs [serverName] [attributeName=attributeValue ... ] [-a] [-I] [-t component:traceMask [:component:traceMask] ... ] [[-T traceClass [=traceClass ... ] = [modier,modier]outputClass:destination]...] [-v] cicssfs -?
Syntax (CICS for Windows NT) cicssfs [serverName] [attributeName=attributeValue ... ] [-a|-nlv] [-I] [-t component:traceMask [:component:traceMask] ... ] [[-T traceClass [=traceClass ... ] = [modier,modier]outputClass:destination]...] [-v] cicssfs -?
Description
v You must create the following logical volumes for the SFS: The logical volume used for journal data written by the SFS, as specied by the LogVolume attribute for the SFS. The default is log_shortName, where shortName is the server short name. The logical volume used for the SFS le data, as specied by the DataVolume attribute for the SFS. The default is sfs_shortName, where shortName is the server short name. v When an SFS is created with the cicssfscreate command an operating system userid is associated with the server. This userid must have read and write access to the logical volumes and associated raw devices. v You must be logged on to a userid with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication you must have a DCE context that has the authority to read and test the Cell Directory Service (CDS) directory where the CDS object representing the SFS will be created, and to read the object itself.
225
cicssfs
For example, to start a server named /.:/cics/sfs/SFSserver1, you need read and test permission for directory /.:/cics/sfs, and you need read permission for /.:/cics/sfs/SFSserver1. Usually, you must be a DCE cell administrator or a member of the DCE group cics_users. v If you are not using DCE servers, an entry must be added to /var/cics_servers/server_bindings after running cicssfscreate. v If you are restarting the SFS because your machine crashed or terminated abnormally, the lock le of the server might not be cleaned up. You must use the cicssfslock command to remove the lock le, which is:
/var/cics_servers/SSD/cics/sfs/modifiedCDSname/lock
Refer to cicssfslock - Release an SFS lock le on page 237 for more information. The command cicssfs starts an SFS that CICS uses and waits for it to initialize before returning. You run cicssfs from the operating system command line. The output of the SFS is directed to the le whose path is constructed from the Cell Directory Service (CDS) name of the server. CICS removes the /.: or /... from the front of this name, and substitutes the modied CDS name into:
/var/cics_servers/SSD/cics/sfs/modifiedCDSname/msg
If you are warm starting the SFS, the restart string is held in the same directory as the output le of the server, for example:
/var/cics_servers/SSD/cics/sfs/modifiedCDSname/res
You can specify the type of start that you require by specifying the attribute value StartType=cold, or StartType=auto. If you do not specify the start type, the SFS is started as if StartType=auto had been used. The -t and -T options are provided to allow the SFS to be traced using the Encina trace facilities. It is expected that these options will only be used under the direction of your support organization, so they are not documented here in detail. For more information about problem determination for SNA products see the relevant SNA booklet: v Using IBM Communications Server for AIX with CICS v Using IBM Communications Server for Windows NT with CICS v Using Microsoft SNA Server with CICS v Using SNAP-IX for Solaris with CICS v Using HP-UX SNAplus2 with CICS
226
cicssfs Options
serverName is the name of the SFS to be started.If the server is being cold-started the name of the server must be specied. If the server is not being cold-started and the name of the server is not specied, then the name of the sever is obtained from the environment variable CICS_SFS_SERVER. attributeName=attributeValue is the value or values that override those in the CICS permanent database for the server. -a starts the SFS in administrative mode. You cannot cold start an SFS in administrative mode, so this ag is ignored for a cold start.
-nlv (CICS for Windows NT only) starts the SFS in administrative mode and with no logical volumes. This can be used when logical volumes need to be extended after lling up. -I -t ... -T ... -v -? 0 causes errors to be ignored. species Encina trace masks. species Encina trace output classes. -T can be used more than once. requests verbose output. is the ag which produces the usage message. SFS started.
non-zero Unsuccessful attempt to start SFS. To start an SFS SERVER1:

cicssfs /.:/cics/sfs/SERVER1
Additional information is contained in the CICS Administration Guide and the CICS Administration Guide.
227
cicssfsconf cicssfsconf - Congure a CICS SFS

You use this command to congure an SFS to be used by CICS.
Syntax
cicssfsconf [-I] [-q] wc regionName cicssfsconf [-I] [-q] {ra | na | lr | pr | nr | lqp | lqu} regionName [attributeName=attributeValue ... ] cicssfsconf [-I] [-q] -R wc regionName DefaultFileServer=serverName cicssfsconf -?
Description
The SFS must be running. You must be logged in as root or administrator on the machine that is running the region. The command cicssfsconf congures the SFS to meet the CICS region requirements. You run cicssfsconf from the operating system command line. If the region is not using DCE servers the cicssfsconf command will assume that the SFS is also not using DCE servers and that the SFS will be found on one of the machines specied by the environment variable CICS_HOSTS. Note: You can congure all queues (this is the default) at a time for each use of cicssfsconf or, if only one queue is specied, only that queue is congured.
Options
-I -q wc causes non-critical errors to be ignored. is used to request quiet processing. If -q is specied, no information messages will be displayed. congures the SFS without changing any Region Denition values.
regionName species the name of the CICS region for which you are conguring the SFS.
228
cicssfsconf
ra na lr pr nr lqp lqu congures the SFS for recoverable auxiliary TS queues. congures the SFS for non-recoverable auxiliary TS queues. congures the SFS for logically recoverable TD queues. congures the SFS for physically recoverable TD queues. congures the SFS for non-recoverable TD queues. congures the SFS for locally-queued protected STARTs. congures the SFS for locally-queued unprotected STARTs.
attributeName=attributeValue ... specify attribute names and values to override those in the Region Denitions (RD). -R (CICS for AIX and CICS for Solaris only) resets the region to use Structured File Server (SFS) instead of DB2. DefaultFileServer=serverName species the name of the Structured File Server (SFS) to be used. The name of the server will be stored in the DefaultFileServer attribute in the Region Denitions (RD). -? causes the usage message to be displayed.
Returned Values
0 SFS congured non-zero Unsuccessful attempt to congure SFS.
Examples
1. To congure the SFS for REGION1 without changing any attributes of the Region Denition:
cicssfsconf wc REGION1
2. To congure the SFS for REGION1 for recoverable auxiliary TS queues, logically recoverable TD queues, and protected STARTs:
cicssfsconf ra REGION1 cicssfsconf lr REGION1 cicssfsconf lqp REGION1
3. To congure the SFS for REGION1 and change the maximum number of records that can be held in LocalQFile to 500000:
cicssfsconf lqu REGION1 LocalQMaxRecs=500000
4. To reset region REGION2 to work with Structured File Server (SFS), using server SERVER1:
cicssfsconf -R wc REGION2 DefaultFileServer=/.:/cics/sfs/SERVER1
229
cicssfscreate cicssfscreate - Create a CICS SFS

You use this command to create an SFS to be used by CICS.
Syntax
cicssfscreate [-v] [-I] [-S] [-m modelName] serverName [attributeName=attributeValue ... ] cicssfscreate -? v You must be logged in as a user with root or administrator privileges. v You must create a user for the SFS, specifying its home directory as
/var/cics_servers/SSD/cics/sfs/ServerName
and setting its primary group as cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). For example, on CICS for AIX:
mkuser pgrp=cics home=/var/cics_servers/SSD/cics/sfs/ServerName Userid
The SFS userid must have permission to read and write the SFS logical volumes and their associated raw devices. Either make the SFS userid the owner of the volumes, or add the SFS userid to the group that can read and write the volumes, so that volumes can be shared. The user for the SFS must be set up as a local user on the machine. The user denitions must not come from the Network Information Service (NIS). v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v You must have a DCE context that has sufficient authority to: Create a DCE principal and account. Create a Server Key Table. Usually, you must be a DCE cell administrator. The command cicssfscreate creates an SFS and the data necessary to allow CICS to use it. You run cicssfscreate from the operating system command line. cicssfscreate adds: v An SFS into the CICS server database.
230
cicssfscreate
v Its entry for the operating system mechanism which is used to start and stop long running processes. v If you are using DCE authentication, its DCE principal, its DCE account and its DCE keytab entry. You must set the ShortName attribute override to a unique ShortName within all SFS that CICS uses in this DCE cell. On CICS for AIX you can get a list of all the current SFS ShortNames used by CICS by entering the following shell commands:
for i in cicsget -c ssd -l | cut -d' ' -f1 do cicsget -c ssd $i | grep ShortName done
You must set the UserID attribute in the SSD to the userid for the SFS. If you are not using DCE servers you must add an entry to /var/cics_servers/server_bindings after running cicssfscreate. Note: cicssfscreate cannot be used to create an SFS on a remote machine. You must create the remote SFS while logged on to the remote machine.
Options
-v -I -S produces verbose informational output. continues processing on non-critical errors causes the SFS to be created without using DCE servers.
-m modelName species the name of the SFS to model this server on. If you do not specify a name, the server is modeled on the default SSD entry. serverName species the name of the SFS, SSD key, to be created. attributeName=attributeValue ... specify attribute names and values to override those in the model or default server. -? produces the usage message.
Returned Values
0 SFS created. non-zero Unsuccessful attempt to create SFS.
231
cicssfscreate Examples
To create an SFS named SERVER1, with a ShortName of SERVER1 and an SFS userid of SFSSERVER:
cicssfscreate /.:/cics/sfs/SERVER1 ShortName=SERVER1 UserID=SFSSERVER
232
cicssfscreate cicssfsdestroy - Destroy a CICS SFS

You use this command to destroy an SFS that CICS uses.
Syntax
cicssfsdestroy [-v] [-S][-I]serverName cicssfsdestroy -? v Ensure that the SFS is not running before you destroy it. v You must be logged in as a user with root or administrator privileges. v If you are using DCE authentication you must have a DCE context that has sufficient authority to: Delete a DCE principal and account. Delete a Server Key Table. Normally you must be a DCE cell administrator. v You must also destroy the logical volumes of the SFS separately using operating system facilities. (You can do this before or after you destroy the SFS.) The command cicssfsdestroy destroys an SFS that CICS uses. You run cicssfsdestroy from the command line. cicssfsdestroy deletes: v An SFS from the CICS server database. v Its entry in the operating system mechanism used for starting and stopping long running processes. v If you are using DCE authentication, its DCE principal, its DCE account, and its DCE keytab entry. On Windows NT use the home directory of the SFS userid, if you have the authority to do so. The output of the SFS is directed to the le whose path is constructed from the CDS name of the server. CICS removes the /.: or /... from the front of this name, and substitutes the modied CDS name into:
/var/cics_servers/SSD/cics/sfs/modifiedCDSname/msg
For example, output from SFS /.:/cics/sfs/myserver goes to the le:

/var/cics_servers/SSD/cics/sfs/myserver/msg
233
cicssfscreate
After you have run cicssfsdestroy, it is useful to also carry out the following operations: v Remove the operating system user id specied by the UserID attribute in the SSD. (Use the operating system to do this.) v Remove the SFS directory:
/var/cics_servers/SSD/cics/sfs/serverName
v Remove the logical volume specied in the DataVolume attribute in the SSD. (Use the operating system to do this.) v If you are using DCE authentication, reauthenticate the DCE tickets for any dce_login contexts that have accessed the server, either by logging in to the DCE again or by using the DCE command kinit. This will remove any cached tickets for the old server, and so avoid problems if a new SFS is created using the same name as the one just destroyed.
Options
-v -S -I produces verbose informational output. causes the SFS to be destroyed without using DCE servers. causes errors to be ignored.
serverName is the name of the SFS to be destroyed. -? is the ag that produces the usage message.
Note: cicssfsdestroy cannot be used to destroy an SFS on a remote machine. You must destroy the remote SFS on the remote machine itself.
Returned Values
0 SFS destroyed. non-zero Unsuccessful attempt to destroy SFS.
Examples
To destroy an SFS SERVER1:
cicssfsdestroy /.:/cics/sfs/SERVER1
The CICS Administration Guide and the Planning and Installation Guide contain additional information.
234
cicssfsimport cicssfsimport - Build an SFSs metadata

You use this command to build an SFSs metadata using one or more entries in a schema le.
Syntax
cicssfsimport -i schemaFileName -s serverName [-I] [-f leName] [[-x indexName] ... ]
Description
v You must be logged in as a user with root or administrator privileges. v The userid must have read/write permission for the schema le as dened explicitly by the le permissions. v You must have sufficient privileges to create SFS les (CICS on Open Systems). You must be a member of the group cicsgroup (CICS for Windows NT). v If you are using DCE authentication you must be logged in to DCE. v You must create logical volumes of the same name as those referenced in the schema le before you use cicssfsimport. v The userid that the SFS runs under must have read and write access to these volumes and their raw devices. v If the SFS has been set up to accept only authenticated RPCs, then to apply a Schema File Denitions (SCD) to SFS, you need to be a member of the group cics_admin. The cicssfsimport command creates one or more les on an SFS. It builds the SFSs metadata using one or more entries in a Schema File Denitions (SCD). The server does not need to be present in the Structured File Server Denitions (SSD), so you can build arbitrary SFSs without the overhead of entering their details into the system. All the les are created before secondary indexes are created. A le that is named in the list must exist at index creation time. If a le or index named in the lists does not exist in the schema le, there will be a warning message, but the import continues.
235
cicssfsimport Options
-i schemaFileName is the relative or absolute path to the schema le. The relative path is in relation to the working directory. -I is a ag to force the command to ignore errors. This is useful if a previous cicssfsimport did not complete, for example after a machine crash, but some les have been created. If the -I ag is set, you can run cicssfsimport again, and any le exists errors generated are ignored.
-s serverName is the Cell Directory Service (CDS) name of the SFS on which the les and indexes are to be built. -f leName is a le from the schema to be created. To specify a list of les, specify each le with a separate -f ag. If you do not specify the -f option, then all les and indexes in the named schema le are created. If you specify the -f option, but do not specify a -x option, then all the indexes for that le are created. -x indexName species an index from the preceding le to add. To specify a list of indexes, specify each index with a separate -x ag. If a set of indexes associated with a le does not include the primary index, a primary index is created. If you specify the -f option, but do not specify a -x option, then all the indexes for that le are created.
Examples
1. To create two les, FILE1 and FILE2 on a server SERVER1, using the entries from schema le SCHEMA1. FILE1 has indexes INDEX1, INDEX2, and INDEX3, and FILE2 has indexes INDEX4 and INDEX5:
cicssfsimport -i SCHEMA1 -s /.:/cics/sfs/SERVER1 -f FILE1 \ -x INDEX1 -x INDEX2 -x INDEX3 -f FILE2 -x INDEX4 -x INDEX5
2. To create a le FILE3 and all its indexes on a server SERVER1, using the entries from schema le SCHEMA1:
cicssfsimport -i SCHEMA1 -s /.:/cics/sfs/SERVER1 -f FILE3
3. To create all les and indexes from a schema le SCHEMA2 on SERVER1, ignoring errors:
cicssfsimport -i SCHEMA2 -s /.:/cics/sfs/SERVER1 -I
236
cicssfslock cicssfslock - Release an SFS lock le

Use this command to release an SFS lock le that may have been left when an SFS terminated in an uncontrolled manner.
Syntax
cicssfslock {-l | -u | -t} serverName cicssfslock -?
Description
cicssfslock takes or releases a lock for a particular SFS. The lock is used to serialize the create, start, stop and destroy phases of an SFS. The lock le is in:
/var/cics_servers/SSD/cics/sfs/serverName/lock
Options
-l -u -t cicssfslock to wait until the SFS that owns the lock le is no longer running and then takes the lock. causes the lock le for the SFS to be released unconditionally. cicssfslock to try to take the lock le but to return immediately if it is unsuccessful.
serverName species the name of the SFS. -? causes the usage message to be displayed. cicssfslock also displays the usage message if you enter the command incorrectly.
Returned Values
0 1 Successful Unsuccessful
Examples
To release the lock for SFS sfs_SFS_SERV:
cicssfslock -u /.:/cics/sfs/sfs_SFS_SERV
237
cicssfsshut cicssfsshut - Shut Down a CICS SFS

You use this command to shut down an SFS that CICS uses.
Syntax
cicssfsshut [-f] [-c] serverName cicssfsshut -?
Description
v You must be logged in as a user with root or administrator privileges. v You must be a member of the group cics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). v If you are using DCE authentication you must have a DCE context that has the authority to read and test the Cell Directory Service (CDS) directory containing the CDS object representing the SFS, and to read the object itself. For example, to shut down the server named /.:/cics/sfs/sfs_SFS_SERV, you need read and test permission on the directory /.:/cics/sfs, and you need read permission for directory . Usually, you must be a DCE cell administrator or a member of the DCE group cics_users. v If the SFS is not using DCE authentication (that is, if NameService=none in the SSD) you must not be logged into DCE. The command cicssfsshut shuts down an SFS that CICS uses. You run cicssfsshut from the operating system command line. The output of the SFS is directed to the le whose path is constructed from the Cell Directory Service (CDS) name of the server. CICS removes the /.: or /... from the front of this name, and substitutes the modied CDS name into:
/var/cics_servers/SSD/modifiedCDSname/msg
For example, output from SFS /.:/cics/sfs/sfs_SFS_SERV goes to the le:

/var/cics_servers/SSD/cics/sfs/sfs_SFS_SERV/msg
Returned Values
-f -c forces an abnormal shutdown of an SFS. Do not use this ag unless you cannot shut the SFS down without it. Cancel the SRC subsystem in which the SFS is running. Do not use this ag unless you need to terminate the server abnormally.
238
cicssfsshut
serverName is the name of the SFS to shut down. -? is the ag that produces the usage message.
Returned Values
0 SFS is shut down. non-zero Unsuccessful attempt to shut down SFS.
Examples
To shut down an SFS SERVER1:
cicssfsshut /.:/cics/sfs/SERVER1
See the CICS Administration Guide for related information.
239
cicsstart cicsstart - Start a CICS region

AIX HP-UX X Sun Solaris X Windows NT X
You use this command to start a CICS on Open Systems region.
Syntax
cicsstart [-c] [-a] [-o attributeName=attributeValue ... ] [regionName]
Description
You must be logged on as a user with root or administrator privileges. The cicsstart command causes a CICS region to start. Once CICS successfully starts and runs post-initialization programs, CICS allows transaction processing. It fails if the region is locked, in which case cicsstop should be used to ensure that the region is shutdown. By default cicsstart performs an AUTO start of cics. This normally involves clearing SFS. You can run the cicsstart command directly from the command line. You can override multiple RD parameters on the same command line. To make permanent changes to the RD, use the CICS resource management commands. For more information, see the CICS Administration Guide.
Options
-c -a -o forces cicsstart to perform a cold start of CICS. forces cicsstart to perform an automatic start of CICS. is used to override Region Denitions (RD) for this region startup.
attributeName=attributeValue is an attribute and its value to be used in this startup. Multiple attributeName=attributeValue pairs can be specied in the -o option. Use double quotes to delimit values containing spaces.
240
cicsstart
regionName is the name of the region to be started. If you do not specify a region name, CICS starts the region specied by the environment variable CICSREGION.
Examples
To cold start the region named REGION1:
cicsstart -c REGION1
241
cicsstop cicsstop - Stop a CICS region

AIX HP-UX X Sun Solaris X Windows NT X
You use this command to stop a CICS on Open Systems region.
Syntax
cicsstop [-f] [-k] [regionName]
Description
You must be logged on as a user with root or administrator privileges. The cicsstop command shuts down a CICS region. A normal shutdown (without the -f or -k options) completes all current processing and releases resources before shutting the region down. If the -f (force) option is used, cicsstop releases the resources, but does not wait for processes to stop before shutting down the region. If the -k (kill) option is used, cicsstop does not attempt to release resources, nor does it wait for processes to complete before shutting down the region. You can run the cicsstop command directly from the command line.
Options
-f -k forces cicsstop to shut the region down after releasing resources. forces cicsstop to shut the region down immediately, killing all CICS processes, removing lock les, and cleaning up shared memory.
regionName species the name of the region to be stopped. If you do not specify a region name, CICS stops the region specied by the CICSREGION environment variable.
Examples
To shut down the region named REGION1 immediately:
cicsstop -k REGION1
For more information about the shutdown process, see the CICS Administration Guide.
242
cicstail cicstail - Display the end of a le

Use this command to display the console.nnnnnn and CSMT.out les for a specied CICS region, or to display a user-specied le.
Syntax
cicstail [-r regionName] | [-f leName] [-b numBytes] cicstail -?
Description
The cicstail command displays the current console.nnnnnn and CSMT.out le for a CICS region and displays new lines as they are added to these les. Alternatively, if the name of a le is specied, the output displays that le and any new lines that are added to the le. New lines are displayed as they are added to the le or les until the command is interrupted when CTRL-C is pressed.
Options
-r regionName species the name of the CICS region whose les are to be displayed. The cicstail command displays the contents of the regions console.nnnnnn and CSMT.out les in a single output stream. If neither the -r or -f options are specied, cicstail displays the les for the region whose name is set in the environment variable CICSREGION. -f leName (CICS for Windows NT only) species the name of a le to be displayed. The name can be absolute or relative to the current directory. -b numBytes (CICS for Windows NT only) species that the display of the le (or les) start numBytes before the end of the le. If the -b option is omitted, the display starts 2,000 bytes before the end of the le. -? causes the usage message to be displayed.
Examples
1. To display les for the region REGION1:
cicstail -r REGION1
243
cicstail
2. To display the le \tmp\file1:
cicstail -f c:\tmp\file1
244
cicstcpnetname cicstcpnetname - Display NETNAME for CICS family TCP/IP connection

cicstcpnetname displays the 1-8 character NETNAME which is used by a CICS region on a CICS family TCP/IP connection. This NETNAME is derived from the Internet Protocol (IP) address and port used by the region.
Syntax
cicstcpnetname -a [ IPaddress | hostName] -p portNumber cicstcpnetname -?
Description
This command displays the NETNAME (Logical Unit (LU) name) for a CICS region using CICS family TCP/IP connections. A CICS regions NETNAME used for these types of connections is derived from the Internet Protocol (IP) address and port on which the CICS region is listening for connection requests.
Options
-a [ IPaddress | hostName ] species the name or address of the network adapter used by the region to accept CICS family TCP/IP connections. The address can be in one of the following forms: v The Internet Protocol (IP) address in dotted decimal notation. For example, 1.23.45.67. v The IP address in dotted hexadecimal notation. For example 0x01.0x17.0x2D.0x43. v The host name dened in the Internet name service. For example aix5.cicsland.com. -p portNumber species the Internet port number used by the region to accept CICS family TCP/IP connections. -? causes the usage message to be displayed.
Returned Values
0 NETNAME returned non-zero Unable to convert the value passed on the -a ag into an Internet Protocol (IP) address.
245
cicstcpnetname Examples
1. To print the NETNAME for network adapter 1.23.45.67 on port 1435:
cicstcpnetname -a 1.23.45.67 -p 1435
The NETNAME will be sent to stdout. 2. To use cicstcpnetname in a shell script:

# # Set up variables # LISTENER="CICSTCP" REMOTE_PORT=1435 REMOTE_ADDRESS="1.23.45.67" REMOTE_NETNAME=$(cicstcpnetname -a $REMOTE_ADDRESS -p $REMOTE_PORT) # # Create Communications Definition (CD) entry. # cicsadd -c cd -r $CICSREGION TCP1 \ ConnectionType=cics_tcp \ RemoteTCPAddress=$REMOTE_ADDRESS \ RemoteTCPPort=$REMOTE_PORT \ ListenerName=$LISTENER \ RemoteLUName=$REMOTE_NETNAME
For related information, see the CICS Intercommunication Guide.
246
cicsteld cicsteld - Connect telnet clients to regions

You use the cicsteld command to interface telnet clients to regions.
Syntax
cicsteld [-r regionName] [-p principalName] [-P portNumber] [-l locale] [-e emulation] [-t initialTransaction] [-c clientCodePage] [-s serverCodePage] [-n netName] [-k keytabFile][-h hostList] [-v] cicsteld -?
Description
You must have run cicssetupclients if you are using DCE authentication. You can run the cicsteld command either as a normal operating system process, or as a child of the inetd daemon that is supplied by the operating system. If you want to register more than ve parameters (including the program name) with inetd, create an operating system shell script or command le which contains the actual call and parameters for cicsteld, then register the shell script or command le with inetd. For more about setting up the cicsteld server (CICS Telnet server), including registering cicsteld with inetd, see the CICS Administration Guide.
Options
-p principalName species the DCE principal that cicsteld is to use for authentication, if DCE authentication is being used. -P portNumber species the numeric Transmission Control Protocol (TCP) port number that cicsteld listens on for incoming telnet client requests. If you do not specify a port number, cicsteld takes the port number from service name entry of cicsteld in the le /etc/services. If you specify a port number that already exists in /etc/services, cicsteld will comment out the existing entry and add a new one. If the port number is not valid, cicsteld issues an explanation message. If the inetd daemon has started cicsteld, cicsteld ignores this parameter because the connection to the telnet client is already established.
247
cicsteld
-n netName species the network name that is used by the CICS autoinstall program to create the terminal identier of the terminal. If you specify a network name, it must exist in the Terminal Denitions (WD) of the region. If no network name is specied, the CICS region generates a network name when the terminal autoinstalls. If you specify a netName of longer than eight characters, cicsteld truncates the netName to eight characters, and logs a message. -r regionName species the region for cicsteld to connect with. If you do not specify a region, when the user connects to the port, cicsteld presents a menu of available regions and allows the user to select one. -t initialTransaction species the transaction to be run at initial connection time after autoinstall. This could be the CESN transaction, to force users to sign on. -e emulation Use this option to override the model type that is selected by cicsteld. When a region is connected for a telnet client, cicsteld checks if the telnet client is using a valid terminal. If the terminal is valid, cicsteld selects a model type for that terminal. To override this selection, use the -e option to specify a user dened model type or a CICS supplied model type. The preferred CICS model types that can be used for cicsteld are: v hft and mft for terminals with extended data stream v lft for terminals that do not have extended data stream. See the CICS Administration Guide for more information about model types and Chapter 10. Terminal model denitions on page 501 for the denitions of the autoinstall models. -l locale species the National Language Support (NLS) locale to use for this instance of cicsteld. If you do not specify this option, On CICS on Open Systems: cicsteld uses the locale that is named in the environment variable LANG. On CICS for Windows NT: cicsteld uses the locale determined by the Language setting in the International section of the Control Panel. -c clientCodePage cicsteld client (for example, the telnet daemon). The client of cicsteld
248
cicsteld
is a 3270 emulator that uses an EBCDIC character set, so this must be an EBCDIC code page. If you do not supply this option, cicsteld uses the code page with shortcode 037. This option corresponds to the CLINTCP option of the DFHCNV macro. See the table under the -s option. -s serverCodePage species the code page of the cicsteld server. This requires an ASCII code page that matches the code page of cicsteld. If you do not supply this option, cicsteld uses the code page with shortcode 8859-1. This option corresponds to the SRVERCP option of the DFHCNV macro. You can supply the code page for the -c and -s options as a shortcode which is recognized and converted by cicsteld as follows:
Table 5. Shortcode and code pages (Open Systems)
Code page Shortcode 037 850 930 932 EUCJP 8859-1 CICS for AIX and CICS for Solaris IBM-037 IBM-850 IBM-930 IBM-932 IBM-eucJP ISO8859-1 CICS for HP-UX american_e roman8 japanese_e japanese japanese.euc iso8859_1
Table 6. Shortcode and code pages (Windows NT) Shortcode Code page
037 850 930 932 EUCJP 8859-1 IBM-037 IBM-850 IBM-930 IBM-932 IBM-eucJP ISO8859-1
If you specify a code page option that does not belong to this set, cicsteld does not alter it. For example, the command cicsteld -c ISO8859-7 uses ISO8859-7 as the name of the client codepage. -k keytabFile species the keytab le that cicsteld uses as the servertab le. If you do not specify this parameter, cicsteld attempts to use the le varDir/cics_clients/krb5/v5srvtab.
249
cicsteld
-h hostList species a blank-delimited list of names or addresses of hosts to be searched for the specied region. If a list of host names is not specied, the contents of the environment variable CICS_HOSTS will be used. If the environment variable CICS_HOSTS is not set, the local machine will be searched. -v -? (verbose) causes all informational messages to be displayed during startup. displays a short help message.
Examples
1. To specify that cicsteld listen on port 9001 for a request to access region REGION1 and run transaction CESN:
cicsteld -P 9001 -r REGION1 -t CESN & (Open Systems) start cicsteld -P 9001 -r REGION1 -t CESN (Windows NT)
2. To attach a telnet client to that port:

telnet hostname 9001
3. To specify the cisteld listen on port 9002 for a request to access REGION2 which is to be found on system BLUE, GREEN, or RED:
cicsteld -P 9002 -r REGION2 -h "BLUE GREEN RED" & (Open Systems) start cicsteld -P 9002 -r REGION2 -h "BLUE GREEN RED" (Windows NT)
250
cicsterm cicsterm - Invoke the CICS 3270 terminal emulator

Invokes the CICS 3270 Terminal Emulator, from the operating system, so that you can connect to a CICS region.
Syntax
cicsterm [-r regionName] [-n netName] [-m modelId] [-t transId] [-A [animatorTTY] [-T animatorTERM]] [-h hostList] cicsterm -?
Description
v You need to understand about the 3270 terminal subsystem before you use the cicsterm command. v You need access to a terminal or window that can access a machine in the DCE cell in which the CICS region is dened. Your terminal must either be suitable for autoinstall (see Terminal autoinstall user program on page 390), or have an entry in the attribute NetName in the Terminal Denitions (WD). v Your window must contain at least 12 lines, so that the terminal emulator can display a menu of region names when necessary. A menu of region names is displayed if you do not specify a region when you invoke the CICS 3270 Terminal Emulator. The 12 lines are needed to display various headers, PF key legends, blank space, and at least one region name so that you can scroll through the list of available regions. If the window contains less than 12 lines, there is an error message, and the terminal emulator terminates abnormally. It is recommended that you use a window with 25 lines. v If you are using DCE authentication and you are connecting to a region that has the attribute none, then you must run dce_login successfully before using cicsterm. This causes a DCE ticket to be allocated by the DCE security service. Tickets have a limited lifetime; 10 hours by default. If a ticket expires while the client is active, the client is terminated. DCE accounts may have their ticket lifetime changed. v If you are not using DCE authentication then either you should not have run dce_login before using the cicsterm command, or you must have run cicssetupclients with the -d option on the host to which you are connecting in order to create a keytab le in directory /var/cics_clients. v You must be authorized to run the transactions that you specify. That is, the UD entry for the userid you are using must have the TSL and RSL keys
251
cicsterm
listed in it that allow you to access the transactions that you want to run. This is described in the CICS Administration Guide. If you do not specify a region with the -r option, a list of regions is displayed so that you can select one. Your selection is veried before you are connected to the region. When you use the -r option to specify a region, you are not shown the list and cicsterm connects you to the region you specied. CICS veries that your request is valid by checking that the DCE principal maps to a User Denitions (UD) entry for the selected region. (The DCE principal is specied in a UD entry with the attribute Principal.) v If a UD entry exists for the DCE principal, you are connected to the CICS region using the key to the UD entry as the userid. You are given access to those transactions and resources with TSL and RSL keys that match those listed in the attributes TSLKeyList and RSLKeyList for that UD entry. v If a UD entry does not exist for the DCE principal, you are connected to the region as the regions default userid. You are given access to those transactions and resources with TSL and RSL keys that match those listed in the TSLKeyList and RSLKeyList in the UD entry for the regions default userid. If a UD entry is not dened for the regions default userid, then you are given access only to public transactions and resources. Note: The regions default userid is specied with the attribute DefaultUserId in the Region Denitions (RD), as described in Region Denitions (RD) on page 32. After you are connected to the region, CICS leaves you with a blank screen that is running the IBM 3270 Information Display System emulation. You can enter the transaction identier of the transaction you want to run. Alternatively, you can run a transaction immediately when cicsterm is initially invoked, by entering
cicsterm -r regionName -t transId
where regionName is the region name, and transId is the transaction identier. The CICS 3270 Terminal Emulator is associated with a particular region for the lifetime of the cicsterm process. If the region terminates, the cicsterm process is left running to wait for any current scheduled protected transactions for the given terminal when the region is restarted. Otherwise, the cicsterm process terminates. When cicsterm receives a user interrupt signal SIGINT, it terminates immediately. If a transaction is running, it is purged. The purge happens only at the start or end of an EXEC CICS call, so the transaction does not terminate
252
cicsterm
if it is waiting for a resource, or if it is in a loop that does not involve EXEC CICS calls. If a transaction in this situation needs to terminate, the systems administrator must purge it. Refer to the FORCEPURGE parameter description in CEMT INQ/SET TASK on page 344. You can specify a particular terminal to install by using the -n option with the NetName of the terminal from its Terminal Denitions (WD). You can explicitly specify a model type to autoinstall by using the -m option, as described below. See Processing on page 254.
Options
-r regionName species the name of the CICS region to which you want to attach. If you do not specify a regionName, CICS displays an interactive menu of available regions that are available for you to select. If there are no regions available, CICS displays an error message. -t transId species the identier of the transaction to run after Terminal Emulator initialization. -n netName species the netName to use for installation. To install as a particular terminal, specify the netName of the required terminal. If you omit the netName, cicsterm autoinstalls, and a unique netName is generated in the region. -m modelId species the name of the model device type (DevType) to use for autoinstallation. See Processing on page 254. -A animatorTTY species the name of the device for ANIMATOR stdin/stdout. If you specify the -A option without a value, and you are using X Windows, cicsterm will create a window for use as the ANIMATOR console. -T animatorTERM species the name of the TERM type of the ANIMATOR terminal. -h hostList species a blank-delimited list of names or addresses of hosts to be searched for the specied region. If a list of host names is not specied, the contents of the environment variable CICS_HOSTS is used. If the environment variable CICS_HOSTS is not set, the Cell Directory Service (CDS) is searched for a region with the specied name. If there is no CDS the local machine is searched. -? causes the usage message to be displayed.
253
cicsterm Examples
1. To display the syntax for accessing CICS:
cicsterm -?
2. To access CICS and log on to the region region1:

cicsterm -r region1
3. To start a terminal using the denition for a high function terminal with multi-byte character support on a region region1:
cicsterm -m hft-mb -r region1
4. To start a terminal with the NetName BlueTerm in its Terminal Denitions on region region1:
cicsterm -n BlueTerm -r region1
5. If you want to log on to a different userid after you have started cicsterm:
cicsterm -r region1 -t CESN
6. To get a list of regions or set of machines:

cicsterm -h"red green blue"
Processing
Suggested Setup: Instead of running cicsterm interactively at the command line, you can set up cicsterm to run as part of the /etc/passwd conguration for a particular user authentication or from a prole or shell script. This is helpful when you always connect to the same region, and you always invoke the same transaction when you are connected to it. Selecting Suitable Autoinstall Models: The autoinstall program is passed a number of model entries in the Terminal Denitions (WD). The models that are selected are: 1. The models with a DevType that matches the model parameter specied in the -m option. For example, when -m hft is specied, the denitions in the WD stanza that has DevType=hft are used. 2. If the -m option is not specied, the models selected are those with a DevType that matches the environment variable CICSTERM. 3. If CICSTERM is not set, the models selected are those with a DevType that matches the environment variable TERM. The default autoinstall program will select the rst of the models that are passed to it. See the CICS Administration Guide for descriptions of autoinstall models that are supplied with CICS. How cicsterm selects the Locale: cicsterm uses the locale that is held in the environment variable LANG. The value of LANG is passed from cicsterm to the region. Therefore, denitions for the locale that is specied in LANG must exist in the system on which the region resides.
254
cicstermp cicstermp - Printer emulation

The cicstermp command performs a xed-size printer emulation of 64 lines by 132 columns and ignores print attributes such as highlight, underline, high intensity and color.
Syntax
cicstermp -n netName -r regionName [-h hostList] [-t transId] [-P printCommand] [-S][-p printerType [-f font] [-M paperType] [-s fontSize] [-R]] cicstermp -?
Description
v If you are using DCE authentication you must be authenticated as a DCE principal to run this command. A DCE ticket is given when the DCE principal authenticates with the DCE security service. Tickets have a limited lifetime, and the default lifetime is 10 hours. If a ticket expires while the client is active, the client is terminated and any in-ight transactions are abended. DCE accounts can have their ticket lifetime changed. v Printers cannot be autoinstalled, so there must be an entry in the Terminal Denitions (WD) whose attribute NetName matches the netName specied on the command before a printer can be attached to a region. v You need to understand about the 3270 terminal subsystem before using the cicstermp command. CICS 3270 Terminal Emulators associated with printer devices are identical to normal user CICS 3270 Terminal Emulators, except that printer CICS 3270 Terminal Emulators are not connected to an interactive device, so they can never receive keyboard input. Either CICS must create these printer CICS 3270 Terminal Emulators when the region starts up, using the Terminal Denitions (WD), or you can enter cicstermp with the -P printCommand option. The -P option or its default, is used to process the data when a print control is detected in the data stream sent to the terminal. The data is placed in a temporary le and the print command is issued with the name of the temporary le appended as a parameter. The temporary le is then erased. Note that there is no requirement for the print command actually to print the data. It could, for example, copy the data so that it can be incorporated into documentation. Also, note that, since the temporary le is immediately erased, the print command must nish processing the le before returning. This
255
cicstermp
precludes the use of a command such as the AIX qprt command (without the -c option) that simply records the name of the le for later processing. Those parameters that are only associated with a PostScript printer type (-f, -M, -s and -R), must have valid values. If not, incorrect printer output may occur. If any of these parameters are used when PostScript printer type isnot used, an error message will be sent and cicstermp will terminate.
Options
-n netName species the network name, which is mandatory. The network name determines which printer terminal emulator is selected from the Terminal Denitions. -r regionName species the name of the CICS region to which you wish to attach. -h hostList species a blank-separated list of names or addresses of hosts to be searched for the specied region. If a list of host names is not specied, the contents of the environment variable CICS_HOSTS will be used. If CICS_HOSTS is not set, the local machine will be searched. -t transId species the transaction identier of the transaction to run after printer CICS 3270 Terminal Emulator initialization. -P printCommand species the command used by CICS to process the data sent to the terminal. The command is appended with the name of the temporary le before it is issued. The default is the operating system lp -c command, which in turn uses the default print destination. -S suppresses the insertion of a blank character between single- and double-byte characters.
-p printerType species the type of printer. The valid printer types are postscript and ps55. These types are valid in either upper or lower case. -f font species the default font. The default values are:
Courier (for single-byte characters) GothicBBB-Medium-RKSJ-H (for Ja_JP) GothicBBB-Medium-EUC-H (for ja_JP)
This option is valid only if the printer type is postscript. -M paperType species the paper size. Valid paper types are:
256
cicstermp
LETTER, FOLIO, EXECUTIVE, LEGAL, LEDGER, TABLOID, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9 and B10.
The default value is A4. This option is valid only if the printer type is postscript. -s fontSize species the default font size. The default value is 11. This option is valid only if the printer type is postscript. -R -? rotates the printed output through 90 degrees. This option is valid only if the printer type is postscript. causes the usage message to be displayed.
Examples
1. To display the syntax:
cicstermp -?
2. To use the default printer for CICS region wessex and netname Printer1:
cicstermp -r wessex -n Printer1
3. To use a specic printer (lp0) on CICS region wessex and netname Printer1:
cicstermp -r wessex -n Printer1 -P "lp -ddest lp0"
4. To print DBCS data with outlines onto PS/55 printers whose queue name is dbcs on CICS region wessex and netname DBCSPRT with codepage 932 (LANG=Ja_JP):
cicstermp -r wessex -n DBCSPRT -p ps55 -P "qprt -c \ -Pdbcs -l0 -x2 -L! -XIBM-932"
257
cicstfmt cicstfmt - Trace formatter

Use this command to create a trace report from the trace data generated by the CICS trace facility. This trace report is written either to standard operating system output or to an operating system le if you provide a lename.
Syntax
cicstfmt [-h [!]hookIdList] [-m [!]moduleIdList] [-o outFile] [-f leName] [-r regionName] [-s {a | b}] [-u userId] [-n traceSeqNo | -p [traceSeqNos]] cicstfmt -?
Description
The CICS trace facility generates trace data in a compact form. The CICS trace formatter, cicstfmt, reads this trace data and generates readable trace output of the form described in the CICS Problem Determination Guide. The cicstfmt command can be used to: v Format a regions auxiliary trace le v Format a user trace le v List a users trace les v Delete all of a users trace les v Delete some of a users trace les v Format a specic le If you enter the command syntax incorrectly or specify invalid parameters, the cicstfmt command writes a message to standard error. It does not produce an error message if a trace le contains invalid data. The cicstfmt command formats trace les that contain only CICS trace. On AIX, you can format trace les that contain non-CICS trace by using the operating system trace formatting utility trcrpt.
Options
-h [!]hookIdList species a list of hook identiers (separated by spaces or commas) of those trace entries that are to be formatted or, if an exclamation point (!) is specied, that are to be ignored. Each hook identier must be a hexadecimal number between 000 and FFF. A range of hook identiers can be specied by using the hyphen () character. If the list contains spaces, the list must be enclosed in quotes. If this option is not
258
cicstfmt
specied, the cicstfmt command formats the trace data for all the CICS trace hook identiers, subject to the effect of the -m parameter. The hook identiers used by CICS are listed in the CICS Problem Determination Guide. -m [!]moduleIdList species a list of module names or identiers (separated by spaces or commas) of those trace entries that are to be formatted or, if an exclamation point (!) is specied, that are to be ignored. An asterisk (*) can be used as a wild character in a module name. If the list contains spaces, the list must be enclosed in quotes. Each CICS module has a ve-character name and a numeric identier. The names and identiers are listed in the CICS Problem Determination Guide. -o outFile species a lename for the trace report. If you do not specify this option, the cicstfmt command uses the standard output. -f leName species the pathname and lename of the trace le you wish to format. -r regionName species the region name. This option is required only if formatting an auxiliary or user trace le, otherwise, it is ignored. The cicstfmt command checks that regionName is valid. If regionName is invalid, the cicstfmt command writes an error message to standard error. If you do not specify a region name, CICS formats trace les for the region specied by the CICSREGION environment variable. -s {a | b} species that cicstfmt formats one of the auxiliary trace les. The options a or b specify which auxiliary trace le to format. For example, specifying -s a formats the trace le specied in the Region Denitions (RD) TraceFileA attribute. If you do not specify a or b, cicstfmt writes an error message to the standard error stream. -u userId species that the cicstfmt command format a user trace le for user userId. If you do not specify this option, the command uses the userid specied by the environment variable LOGNAME. -n traceSeqNo species the sequence number of a user trace le. The cicstfmt command uses the userId (specied by the -u parameter) to look up the trace lename in the TraceFile attribute of User Denitions. It then uses this value and the traceSeqNo to generate the lename of the user trace le. For example, if the TraceFile attribute is set to MyTracefile
259
cicstfmt
and the traceSeqNo is 001, then the user trace le is called MyTracefile.001. Only one sequence number can be specied after -n. -p [traceSeqNos] species that you wish to delete some or all of a users trace les. If you specify any trace le sequence numbers, the cicstfmt command removes all trace les associated with the specied traceSeqNos. If traceSeqNos is not specied, all the users trace les are removed. The cicstfmt command requests conrmation before it deletes all les. More than one sequence number can be specied after the -p option. -? causes the usage message to be displayed.
Examples
1. To format all trace data in auxiliary trace le A for the region REGIONA to the le auxa:
cicstfmt -o auxa -r REGIONA -s a
2. To format trace hooks 584 and 582 from the user trace le 001 for the user USER1 in the region REGIONB:
cicstfmt -h "584 582" -r REGIONB -u USER1 -n 001
3. To list all of the user trace les for the user USER1 in the region REGIONB:
cicstfmt -r REGIONB -u USER1
4. To delete all of the user trace les for user USER1 in the region REGIONB:
cicstfmt -r REGIONB -u USER1 -p
5. To delete the user trace le 001 for the user USER1 in the region REGIONB:
cicstfmt -r REGIONB -u USER1 -p 001
6. To format trace entries made by the storage modules in the trace data le TraceFile in the current directory to a le called TraceOutput:
cicstfmt -msto* -o TraceOutput -f TraceFile
See the CICS Administration Guide and CICS Application Programming Guide for related information.
260
cicstracelter cicstracelter - Trace lter

The cicstracelter command lters a CICS trace le to select or remove specied trace entries. The trace entries to be selected or removed can be specied by hook identier or by CICS module identier or both. On CICS for AIX only, this command may also be used to lter an AIX EPTF-format le.
Syntax
cicstracelter [-h [!]hookIdList] [-m [!]moduleIdList] cicstracelter -?
Description
cicstracelter reads standard input, which is assumed to be in the format of a CICS trace le. Each trace entry is echoed to standard output or is discarded depending on the values of the -h and -m options. The output from cicstracelter is also in the format of a CICS trace le and can be formatted using the CICS program cicstfmt. using the CICS program cicstfmt or, on AIX only, using the AIX program trcrpt.
Options
-h [!]hookIdList species a comma-separated list of hook identiers of those trace entries that are to be echoed to standard output or, if ! is specied, the entries that are to be discarded. Each hook identier must be a hexadecimal number between 000 and FFF. A range of hook identiers can be specied by using a character. The hook identiers used by CICS are listed in the CICS Problem Determination Guide. -m [!]moduleIdList species a comma-separated list of names or identiers of modules whose trace entries are to be echoed to standard output or, if ! is specied, whose entries that are to be discarded. An asterisk can be used as a wild character in a module name. Each CICS module has a ve-character name and a numeric identier. The names and identiers are listed in the CICS Problem Determination Guide. -? causes the usage message to be displayed.
261
cicstracelter Examples
1. To select only hook entries for identiers 581 to 583 and 586 the CICS trace entries not made by modules StoTA or StoRE in the trace le trace1 placing the output in le filteredtrace, enter:
cicstracefilter -h581-583,586 -m!stota,store <trace1 >filteredtrace
2. To remove EXEC CICS interface entry and exit traces from the trace le trace2, enter:
cicstracefilter -h!582,583 <trace2
262
cicsupdate cicsupdate - Modify CICS resource denitions

Use this command to modify existing CICS resource denitions.
Syntax
cicsupdate -c className [-r regionName] [-P | -R | -B] [-f leName] [resourceName] [attributeName=attributeValue ... ] cicsupdate -?
Description
The Resource Denition Online (RDO) command cicsupdate updates a resource denition of a specied class in the permanent resources database, or installs the resource denition into the runtime database, or both. The cicsupdate command initializes the data structures for the resource with the current values before overwriting them with your specied values. Stopping the command before completion can result in a damaged database. The command returns 0 if the command runs successfully, 1 otherwise. You can use the cicsupdate command to update the reserved resource default associated with each resource class.
Options
-c className determines the resource class to which the resource denition is to be updated, and is one of these two- or three-character codes: cd fd gd gsd jd ld md od pd Communication Files Gateways Gateway Servers Journals Listeners Monitoring Objects Programs
263
cicsupdate
rd scd ssd td tdd tsd ud wd xad Regions SFS Schemas SFS Servers Transactions Transient Data Queues Temporary Storage Queues Users Terminals Products
-r regionName species the region whose resource denition is to be updated. If you do not specify a region name, CICS updates the resource denition in the region specied by the CICSREGION environment variable. The -r parameter is invalid if you specify gsd, scd, or ssd as the resource class, because these classes are associated with a collection of regions rather than with a specic one. -f leName species the le that contains the schema denitions. Use this ag only when you specify scd (SFS schema denitions) as the resource class. -P instructs the command to update the resource denition in the permanent database without installing it into the runtime database. This is the default option if you do not specify the -P, -R, or -B options. instructs the command to update the runtime database and install the resource denition in a running system. If you are using DCE authentication, you must be authenticated as a DCE principal before running the command with this ag. The -R ag is invalid if you specify rd or md as the resource class because these classes cannot be updated in a running system, or if you specify gsd, scd, or ssd as the resource class, since these classes are not associated with a specic region. -B instructs the command to update the resource denition in the permanent database, update the runtime database, and install the resource denition in a running system. The second part of this operation fails if there is already an entry in the runtime database, so you must use cicsdelete -R to delete any existing entry rst. If you are
-R
264
cicsupdate
using DCE authentication, you must be authenticated as a DCE principal before running the command with this ag. The -B ag is invalid if you specify rd or md as the resource class because these classes cannot be updated in a running system, or if you specify gsd, scd, or ssd as the resource class since these classes are not associated with a specic region. resourceName is the name of the resource denition to be updated. You must enter a resourceName for all classes except rd and md. To update the reserved default resource denition, enter resourceName as two double quotation marks (). attributeName=attributeValue ... are the names and values of attributes belonging to the class className that you wish to change. If you are using cicsupdate from the command line and you want to use a metacharacter such as double asterisks (**), backslash (\), or pipe (|) within an attribute value, you must use a shell escape mechanism. For example, if you want to use ** as a value, you must enter one of the following:
"**" \*\* '**'
You must use the pipe (|) character as the separator for multiple entries into Transaction Security Level (TSL) and Resource Security Level (RSL) key lists. Note: The term metacharacter refers to the following special characters: dollar ($), at sign (@), period (.), slash (/), dash (-), underscore (_), percent (%), ampersand (&), question mark (?), exclamation (!), vertical bar or pipe (|), double quotation (), comma (,), semicolon (;), less than (<), greater than (>). The set of attributeName=attributeValue pairs depends on the class of the resource. -? causes the usage message to be displayed.
Examples
1. To update the program name for the transaction TEST in the region REGION3 in the permanent database only:
cicsupdate -c td -r REGION3 -P TEST ProgName=PROG2
2. To update the path name for the program PROG1 in the region REGION4 in the permanent database and install it in the runtime database:
265
cicsupdate
cicsupdate -c pd -r REGION4 -B PROG1 \ PathName=/var/cics_regions/REGION4/bin/prog1
266
cicsupdateclass cicsupdateclass command

Selectively changes the value of an attribute for a given class.
Syntax
cicsupdateclass [-r regionName] [ -w ] -c className -a attributeName {-n newValue | -b fromAttribute} [ [ -lt | -gt | -eq ] oldValue ] [ -k key ] [ -f lename ] cicsupdateclass -?
Description
The cicsupdateclass command is used when an upgrade of CICS on Open Systems causes a change to the value of an attribute in the default resource denition le, for example, the default value, or a change in the range of values that the attribute can take. cicsupdateclass globally modies the value of each specied attribute for all the resource denition les in that class. These commands are generated automatically and are included in the migration shell script which was created when you ran cicsmigrate. If you ran cicsmigrate to update the warm start region images, the cicsupdateclass commands are generated with a -w ag. You can edit the cicsupdateclass commands in the shell script, for example, if you wanted to change the default value of an attribute for your system. You can explicitly specify the new value using the -n parameter, or you can copy a new value from an existing attribute using the -b parameter. You can also specify that the attribute value changes only under certain conditions. For example, you can specify that a change occurs only if the current value is less than, or greater than, a numerical value that you specify. If you use the condition that the attribute value changes only if the current value is equal to a specied value, you can specify either a numerical value, or a valid character value. You can also specify that a change occurs only for a certain stanza by naming its key.
Options
-r regionName species the name of the region being modied. It is optional only for the following resources: ssd, gsd, and scd. -w updates the warm start region images.
267
cicsupdateclass
-c className species the name of the class being modied. Valid classes are: cd fd gd gsd jd ld md od pd rd scd ssd td tdd tsd ud wd xad Communication denitions File denitions Gateway denitions Gateway server denitions Journal denitions Listener denitions Monitoring denitions Object denitions Program denitions Region denitions Schema le denitions Structured le server denitions Transaction denitions Transient data denitions Temporary storage denitions User denitions Terminal denitions Product denitions.
-a attributeName species the name of the attribute being modied. -n newValue species the new value for the attribute. -b fromAttribute species the name of an attribute whose value is used as the new value for the attribute being modied. -lt oldValue changes the value of the attribute only if its current value is less than a numerical value, oldValue, that you specify. -gt oldValue changes the value of the attribute only if its current value is greater than a numerical value, oldValue, that you specify.
268
cicsupdateclass
-eq oldValue changes the value of the attribute only if its current value is equal to a value, oldValue, that you specify. The value you specify can be numerical or valid characters. -k key changes the value of the stanza only with the key specied. -f lename species the path and lename of the schema resource le. This option is valid only if -c scd is specied. -? causes the usage message to be displayed.
Examples
1. To change the value of the Priority attribute to 99 for every user in region1:
cicsupdateclass -r region1 -c ud -a Priority -n 99 -w
2. To change the value of the InDoubt attribute to wait_commit if it previously had the value wait_backout for every entry in the Transaction Denitions (TD) in region2:
cicsupdateclass -r region2 -c td -a InDoubt -n wait_commit \ -eq wait_backout -w
3. To change the value of the RegionPoolSize attribute in the Region Denitions (RD) for region3 to 24679 if the existing value is less than 2050:
cicsupdateclass -r region3 -c rd -a RegionPoolSize -n 24679 \ -lt 2050 -w
4. To change the value of the TSLCheck attribute to the value of the RSLCheck attribute for every transaction in the Transaction Denitions (TD) in region4:
cicsupdateclass -r region4 -c td -a TSLCheck -f RSLCheck -w
5. To set the attribute NameService to NONE for a specied Structured File Service Denition (SSD) entry:
cicsupdateclass -w -c ssd -a NameService -n NONE \ -k "/.;/cics/sfs/serverName"
269
cicsusedceservers cicsusedceservers - Migrate CICS regions and Encina servers to use DCE
The purpose of the cicsusedceservers command is to migrate CICS regions and Encina SFS and PPC Gateway servers to make use of the DCE CDS and Security services after originally being created not to use these services.
Syntax
cicsusedceservers { -A [-I] | -R regionName | -S serverName | -G gatewayName } [-v] cicsusedceservers -?
Description
The DCE directory and security services must have been installed on the machine. You must be logged in to DCE with credentials to create DCE principals and accounts. This command will migrate CICS regions and Encina servers from operating without the use of the DCE directory and security services to operate using these service. It is intended to ease the migration to a more complex conguration or to one that requires the use of DCE security. The command may be used to migrate all regions and servers on the machine at once or to migrate individual regions and servers. All Encina servers should be migrated before attempting to use any migrated regions that make use of their facilities. cicsusedceservers will create the necessary DCE principals and keytab les which are normally created by cicsdefault or by cicsimport, cicssfscreate and cicsppcgwycreate (CICS on Open Systems only) when those commands are used in the presence of the DCE servers. It will also change the settings of the NameService and AuthenticationService attributes for the regions and servers to DCE. The various attributes specifying RPC protection levels will all be left set to none, however, so, if higher protection levels are required, it will be necessary to use SMIT (on CICS for AIX), SAM (on CICS for HP-UX) or cicsupdate and cicsupdateclass to change these settings after you have run cicsusedceservers.
270
cicsusedceservers Options
-A -I causes cicsusedceservers to migrate all CICS regions and all Encina servers dened on the local machine. causes cicsusedceservers -A to continue migration of other CICS regions and Encina servers if a failure is encountered in migrating one of them.
-R regionName species the name of a single region on the local machine that is to be migrated. -S serverName species the name of a single Encina SFS server to be migrated. -G gatewayName species the name of a single Encina PPC gateway server to be migrated. -v -? causes cicsusedceservers to display more information about the progress of the migration. causes the usage message to be displayed.
Examples
1. To migrate all CICS regions and Encina servers on the local machine even if an error is encountered with one or more of them, enter
cicsusedceservers -AI
2. To migrate region Region1 on the local machine, enter

cicsusedceservers -R Region1
3. To migrate SFS server /.:/cics/sfs/SERVER1 on the local machine, enter

cicsusedceservers -S /.:/cics/sfs/SERVER1
271
cicsusedceservers
272
Chapter 3. CICS-supplied transactions

This chapter describes the CICS-supplied transactions and tells you how to invoke them.
Overview of the CICS-supplied transactions

CICS-supplied transactions are provided to perform CICS associated tasks, such as logging on to CICS and browsing the contents of a temporary storage queue. The CICS-supplied transactions are referred to by their four-character transaction identier (or tranid) and always start with the letter C, as in CEMT. Data Conversion (CALF) This transaction is used to convert VSAM-based data to the structured le services (SFS) format used in CICS on Open Systems. This is done during migration of applications from IBM mainframe-based CICS to CICS on Open Systems. Application Diagnosis Conguration (CDCN) This transaction is used to turn on and off the IBM Application Debugging Program. Temporary Storage Browse (CEBR) This transaction is used to browse temporary storage queues and transient data queues. Command Level Interpreter (CECI) This transaction allows you to check the syntax of, interpret, and run EXEC CICS commands. Syntax Checker (CECS) This transaction allows you to check the syntax of EXEC CICS commands. Execution Diagnostic Facility (CEDF) The CEDF transaction allows you to use the Execution Diagnostic Facility (EDF) that enables you to debug an application program that has been preprocessed with the CICS translator command (cicstran -e). Runtime Resource Management (CEMT) This transaction allows you to inquire about CICS resources in the runtime environment and to change their control parameters dynamically. Signoff (CESF) This transaction is used to sign off from CICS. It has the same effect as CSSF.
273
Signon (CESN) This transaction is used to sign on to CICS. CJDB Java application diagnosis conguration Console Message Log Viewer (CMLV) This transaction can be used to browse through the console message log, console.nnnnnn. Routing Transaction (CRTE) This transaction is used to route to another system so that you can sign on to CICS on that system. Signoff (CSSF) This transaction is used to sign off from CICS. It has the same effect as CESF. Statistics (CSTD) This transaction is used to display statistics information. CICS uses the tranid to identify the application programs that handle the specied transactions and to establish a task to run them. Note: CEDF and CRTE are private transactions. They do not have a program name in the Transaction Denitions (TD) so you cannot change their names or copy them. For more information, see Chapter 3. CICS-supplied transactions on page 273. For information about how user-written as well as CICS-supplied transactions are dened to CICS, see Transaction Denitions (TD) on page 73.
How to invoke the CICS-supplied transactions

You invoke CICS-supplied transactions by entering the transaction identier (tranid) at the command line. Several CICS-supplied transactions accept additional information, such as keywords or values. For example, if you want to inquire about the status of PROG1 using the CEMT transaction, you would enter:
CEMT INQ PROGRAM(PROG1)
where CEMT is the tranid of the Runtime Resource Management transaction, the INQ keyword species that you want to make an inquiry, PROGRAM states the resource type, and PROG1 is the specic name of the program.
274
The transaction starts a full screen session. When you end the session, the following message is generated:
STATUS: SESSION ENDED
Prompts, issued from the transaction, are displayed if required keywords or values are missing or incorrect. Note: If the upper case translation ag for your terminal is set to yes, you can enter the tranid at your terminal in either uppercase or lowercase characters, although they are all shown here in uppercase.
Syntax notation used in the descriptions

Conventional syntax rules are used to show how to specify keywords and their values. When starting a transaction: v Enter upper case items exactly as shown. v Replace lower case items with the actual information. v Enter all items that are not enclosed in brackets ([ and ]) as they are not optional. Items enclosed in brackets are optional. v Select one item from a list of items when they are enclosed in braces ({ and }) or brackets separated by vertical bars (|). For example, the following indicates that either INQ or SET can be used.
Example of using vertical bars {INQ | SET} v An item in bold type indicates the default that is used if you do not select an item from an item list. For example, the following indicates that if neither EXIT nor GOODNIGHT are selected, the transaction is executed as if EXIT were specied.
Example of showing the default CESF [EXIT | GOODNIGHT] v Enter parentheses exactly as shown, unless indicated otherwise, as they act as delimiters. v When an ellipsis (...) is shown in a list, repeat as many items, or group of items, as needed. The following example of CEMT transaction syntax demonstrates that: 1. Either INQ or SET must be specied.
275
2. TRANSACTION must also be specied, but because there are brackets around (tranid), you do not need to provide it. 3. The brackets around ALL, PRIORITY(value), and ENABLED | DISABLED indicate that these are optional. 4. When PRIORITY is specied, you must provide a value.
Example of showing when a value must be provided CEMT {INQ | SET} TRANSACTION[(tranId)] [ALL] [PRIORITY(value)] [ENABLED | DISABLED] To set the maximum permitted number of servers to 5, you enter:
Example of providing a value CEMT SET TCLASS MAXSERVERS(5) Syntax notation on screen displays The syntax notation displayed on screen, and in gures showing example screens, differs slightly from the syntax notation used in this book: v Square brackets [ ] are replaced by the less than (<) and greater than (>) symbols. v Braces ({ and }) are not used. If a mandatory option is left out, CICS displays an error message and does not continue performing the command until you specify the option. v Parentheses are used to indicate that an option requires a value or data eld, but you have not specied one.
Minimum abbreviation of keywords

In general, the CICS-supplied transactions accept an abbreviation for each keyword, provided that the abbreviation uniquely identies the keyword within the request. In this way you can enter the keyword TASK as TAS or TA, but you cannot use T, because it can be confused with TERMINAL, TRANSACTION, or TRACE, among others. In the syntax displayed on your screen, you see the minimum permitted abbreviation in uppercase characters, the remainder in lowercase. See How to invoke CEMT on page 323 for an example of this. If you enter an ambiguous abbreviation, CICS issues a warning message, but assumes and uses the rst possible keyword.
276
Default security settings

Transaction security is handled at two levels: v The rst level is to determine whether or not a user can start the transaction. This is referred to as transaction security level or TSL checking. v The second level is to determine whether or not a user can access resources using that transaction. This is referred to as resource security level or RSL checking. TSL and RSL security checking can be handled by the CICS internal security checking mechanism or by an External Security Manager (ESM). Internal or external security checking is specied with the Transaction Denitions (TD) TSLCheck and RSLCheck attributes for each transaction. The default settings for the CICS-supplied transactions are shown in Table 7. The settings are either internal (use CICS internal security checking) or none (no security checking).
Table 7. Default security settings for the CICS-supplied transactions
Tranid CALF CDCN CEBR CECS CECI CEDF CEMT CESF CSSF CESN CMLV CRTE CSTD TSLCheck internal internal internal internal internal internal internal internal internal internal internal internal internal RSLCheck internal internal internal internal internal internal none none none none none none none
For internal security checking, each transaction is assigned a TSL key value and an RSL key value. This value is either a number or public. CICS users are assigned a list of TSL and RSL key numbers in the User Denitions (UD). These numbers indicate which transactions they are
277
permitted to use. If a number in the user list matches a transaction key number, then the user has permission to use that transaction. In other words, if a transaction has a TSL key of 10 and an RSL key of 20, then users must have 10 in their TSL key list if they need to start the transaction and they must have 20 in their RSL key list if they need to be able to access resources with that transaction. The CICS-supplied transactions are initially shipped with these TSL and RSL keys set to public so that all CICS users can use them. However, this may have been changed by your local administrator. For example, it may not be desirable for all users to be able to use CEMT as this gives them the ability to change CICS resource denitions in the runtime environment. If you are responsible for setting up security checking for the CICS-supplied transactions, and you need more information about this, see the CICS Administration Guide.
Complete list of CICS-supplied transactions

This information lists all the transactions that are supplied with CICS on Open Systems, except for those that are part of CICS-supplied sample programs. The transactions that have operator interfaces, and that therefore are listed in this book, are marked with an asterisk (*). Transactions followed by a (p) are private transactions. They do not have a program name in the Transaction Denitions (TD) so you cannot change their names or copy them. Changing any attributes of a private transaction may have unpredictable results and is not supported.
CAGE (p) CAIN (p) CALF * CARP (p) CATS (p) CAUT (p) CCIN (p) CDCN CEBR * CECI * Temporary storage queue aging Region initialization Data conversion ATI request/queue purge Asynchronous transaction sender Automatic statistics transmission Autoinstall CICS Communications Denitions (CD) entries Debugging Conguration Temporary storage queue browse Command interpreter
278
CECS * CEDF *(p) CEMT * CESF * CESN * CFTS (p) CGWY CHAT (p) CICE (p) CLAM (p) CMLV * CPMI (p) CRAB (p) CROW (p) CRSR (p) CRTE *(p) CSMI (p) CSM1 (p) CSM2 (p) CSM3 (p) CSM5 (p) CSSF * CSTD * CST0 - CST9, CSTA, CSTB, CSTZ (p) CTDP (p) CTIN (p) CUBS (p) CURD (p) CVMI (p)
Command syntax check Execution diagnostic facility Master terminal Signoff transaction Signon transaction Delete surrogate terminals Gateway transaction. For information about this transaction, see the CICS Intercommunication Guide. Autoinstall terminals Interval control element expiry transaction Monitors internal data consistency Browses the console log Function shipping mirror transaction Run program list Region shutdown Remote scheduling Routing transaction Function shipping mirror transaction SYSMSG model Scheduler model Queue model DL/I model Signoff transaction Statistics display transaction Statistics display transactions Purges read reacords from the Transient Data Queues Autoinstall CICS Client terminals Update blocked starts Update runtime database Function shipping mirror transaction
Interface descriptions for the CICS-supplied transactions

For each CICS-supplied transaction that has an operator interface, the following information is provided:
279
v A synopsis of the transaction including a brief description of its purpose, the layout of the syntax, descriptions of the parameters, and examples. v A comprehensive description of the transaction. v Information about how the transaction is started and how it ends. v If applicable, detailed information about how to use the screens associated with the transaction. v Additional information as required.
280
CALF CALF (Data Conversion)

Converts data from VSAM format to structured le services (SFS) format.
Syntax
CALF
Description
CALF is a CICS-supplied transaction that performs data conversion so that existing VSAM-based applications can be migrated to the CICS structured le server (SFS) environment used in . CALF accepts the following three le types: v Key sequenced data set (KSDS) v Entry sequenced data set (ESDS) v Relative record data set (RRDS) The transaction copies records from a source le to a destination le. You enter control data in the data entry elds to control the transaction, and use the PF keys to run the transaction. Starting and ending CALF: You start the CALF transaction directly by entering the tranid CALF. You end the transaction by pressing PF3. Using the CALF screens: CALF displays the following screen:
281
CALF
CICS FILE IMPORT FACILITY SYNCPOINT : (0000) DUPREC : (Y) REMOTE SYSTEM :
SOURCE FILE : ( REMOTE NAME : FILE NAME : FILE SERVER : INDEX NAME : FILE TYPE : DESTINATION FILE : ( FILE NAME : FILE SERVER : INDEX NAME : FILE TYPE :
PAD : (Y)
RECORD LENGTH : KEY LENGTH : ) COPIED :
RECORD FORMAT : KEY POSITION : DUPLICATES : RECOVERABLE (Y)
RECORD LENGTH : KEY LENGTH : 5 OPEN
RECORD FORMAT : KEY POSITION : 9 IMPORT
PF 1 HELP 2 CLEAR 3 END
The CALF screen area contains several distinct areas: v Data Entry Fields (the second and ninth lines of text on the screen). v Information (lines three to eight, and lines nine to fourteen of the text on the screen). v Status information (the line above the PF keys. This line is blank until there is status information to display). v PF Key Values (last line of text on the screen). There is a second CALF screen, which is generated only if the import request does not complete (see The Calf error screen on page 283). The transaction ends, and the screen displays an error message, the number of records that were copied, and information about the last record that was copied. The information about the last record copied depends upon the letype. For a KSDS le, the screen displays 255 bytes containing the key in hexadecimal. For an ESDS le, it displays the relative byte address (RBA), and for an RRDS le, it displays the relative record number (RRN).
282
CALF
CICS FILE IMPORT FACILITY COPIED ( ) RECORDS.
KEY OF LAST RECORD COPIED: ( ( ( ( ( ( ( ( RRN/RBA: ( ) ) ) ) ) ) ) ) )
The CALF error screen area has two areas: v Error message (the second line of the screen) v Information (the remaining lines of the screen) Data entry elds: These are the elds on the second and ninth lines of text on the screen, indicated by brackets, where you can enter the source le name, the destination le name, and transaction control data. SOURCE FILE is the le that the transaction copies records from. The le can be local or remote. The le types, record lengths, and record formats of the source le must be consistent with the destination le. If the le is local, you can check this in the information elds after you press PF5. If the le is remote, when you press PF5, only the information elds REMOTE NAME and REMOTE SYSTEM contain meaningful data, so you cannot check letype, record length, or record format consistency. There might be record length conicts during the copy process, with the following results: v If a source record is not long enough to contain the key of the destination record, the transaction terminates abnormally. v If a source record is longer than the length of a xed length le, a LENGERR error condition occurs and the transaction terminates abnormally.
283
CALF
v If a source record is shorter than the length of a xed length le, the outcome depends upon the setting of the PAD data entry eld (see the PAD description below). v If records are of variable length, an attempt to write a record might cause an INVREQ or a LENGERR error condition, and the transaction terminates abnormally. If the source le is an ESDS le, the transaction maintains the record order, but the structured le server (SFS) allocates its own relative byte addresses (RBAs). SYNCPOINT controls how often a SYNCPOINT is issued if the destination eld is recoverable. The value of the eld species the number of records that are written in each logical unit of work (LUW). The default is 0. DUPREC controls whether or not to ignore DUPREC conditions. The DUPREC condition occurs if an attempt is made to add a record to a data set when the same key already exists in the data set. You can set the eld to Y or N. If you set the eld to Y, the transaction ignores the DUPREC conditions and you can resubmit a partially completed copy operation. The default is Y. PAD controls whether or not to pad a record with nulls when the source record length is less than the record length of a xed length le. This type of record length conict can occur when you import a remote le. If the eld is set to Y, the record is padded with nulls to the required length and a record is written. If the eld is set to N, the transaction terminates abnormally. The default is Y. DESTINATION FILE is the le that the transaction copies records to. The destination le must be local, so after you press PF5, there is always data in the FILE TYPE, RECORD LENGTH, and RECORD FORMAT information elds. The destination le must be congured with the correct information about all indexes, because the transaction only has information about the index it uses for access. Information: REMOTE NAME displays the name of the le if the letype is remote. REMOTE SYSTEM displays the name of the system if the letype is remote.
284
CALF
FILE NAME displays the Structured File Server (SFS) name for the le. FILE SERVER displays the name of the SFS le system where this le resides. INDEX NAME displays the name of the SFS index associated with this path to the le. FILE TYPE displays the type of le if the le is local. File types can be KSDS, ESDS, or RRDS. RECORD LENGTH displays the record length if the le is local. RECORD FORMAT displays the record format if the le is local. The record format can be xed or variable. KEY LENGTH displays the length of the key in the underlying SFS le if the le is local, or the value recorded in the File Denitions (FD) if the le is remote. KEY POSITION displays the key position in the underlying SFS le if the le is local, or the value recorded in the File Denitions (FD) if the le is remote. COPIED is a eld that is periodically updated, depending on the SYNCPOINT, as the transaction carries out the copy procedure. DUPLICATES is a eld that is periodically updated as the transaction carries out the copy procedure. RECOVERABLE displays whether a le is recoverable or not. It can be Y or N, respectively. Status information: This is the line above the PF keys on the screen. It is blank until there is status information to display. Information can be error messages or messages about the transaction status. Program function (PF) key values: PF1 displays help. PF2 clears all elds.
285
CALF
PF3 exits from CALF. PF5 opens the les specied in the data entry elds, and displays information about the les. PF9 initiates copying records from the source le to the destination le. You must open the les rst.
286
CDCN CDCN (Application Diagnosis Conguration) (CICS for AIX)

Turns the IBM Application Debugging Program on and off.
Syntax
CDCN [TERMID=termId] [SYSID=sysId] [TRANSID=transId] [PROGRAM=programName] [DISPLAY=display] [ ON | OFF ]
Description
CDCN is a CICS-supplied transaction that turns the IBM Application Debugging Program on and off. The IBM Application Debugging Program can be used to diagnose errors in a transaction identied by naming a resource in one of the following classes: v v v v Terminal (identied by its termid) System (identied by its sysid) Transaction (identied by its transid) Program (identied by its program name)
When a transaction meets one (or more) of the criteria set by CDCN, the IBM Application Debugging Program starts an X-window session on the specied display.
Options
TERMID=termId species the four-character identier of the terminal on which the transaction to be tested will be run. This may or may not be the terminal on which CDCN is invoked. If no other resources are specied termId defaults to the identier of the current terminal. This terminal must be dened in the Terminal Denitions (WD), unless it is generated from a terminal autoinstall. The terminal must be a terminal in the same region as the current terminal. To nd the identier of an autoinstalled terminal, you can run the CEMT INQ TERMINAL transaction, which lists all the terminals logged on to the CICS region. Alternatively, you can look at the autoinstall message in the CSMT log, in the le /var/cics_regions/regionName/data/CSMT.out. SYSID=sysId species the four-character identier of the remote region where the transaction to be diagnosed will originate. This region must be dened in the Communications Denitions (CD).
287
CDCN
TRANSID=transId species the identier of the transaction to be diagnosed. This transaction must be dened in the Transaction Denitions (TD). PROGRAM=programName species the name of the program to be diagnosed. This program must be dened in the Program Denitions (PD). -a option of the cicstcl command and its source must be in the directories specied by the xldb.sourceSearchPath resource in your .Xdefaults le. See the CICS Application Programming Guidefor more information. DISPLAY=display species the name of the X-display on which the IBM Application Debugging Program will display its panels. If this parameter is not specied, the name of the display is obtained from the le specied by the environment variable CICSDEBUGENV. The name of the display must be specied in the format XserverName:displayNumber. ON species that the IBM Application Debugging Program is to be turned on for the named resources. This is the default if neither ON nor OFF is specied. species that the IBM Application Debugging Program is to be turned off for the named resources.
OFF
Using the CDCN screen: If you enter CDCN without specifying the DISPLAY parameter or if the command line is invalid or incomplete, the following screen is displayed:
288
CDCN
CDCN DISPLAY :( CICS Debugging Configuration Transaction ) DEBUG : ON ) ) ) )
To configure for a terminal specify the TERMID To configure for a system specify the SYSID To configure for a transaction specify the TRANSID To configure for a program specify the PROGRAM
TERMID : ( SYSID : (
TRANSID: ( PROGRAM: (
ENTER: COMMIT SELECTION PF1 : HELP PF2 : PF4 : MESSAGES PF5 : PF7 : UNDEFINED PF8 : PF10: UNDEFINED PF11:
DEBUG ON/OFF UNDEFINED UNDEFINED UNDEFINED
PF3 : PF6 : PF9 : PF12:
EXIT UNDEFINED UNDEFINED UNDEFINED
The data entry elds, indicated by parentheses, are where you can enter data corresponding to the parameters. After you have lled in the elds you want, press ENTER from the main screen. Program Function Keys: The program function keys have the following functions: PF1 PF2 PF3 PF4 displays help toggles the IBM Application Debugging Program on and off exits from CDCN messages
Using CDCN: When you use CDCN to turn the IBM Application Debugging Program on for a named resource, it does not cause the IBM Application Debugging Program to start immediately. If you satisfy the security checks, and you are able both to run the CDCN transaction and to access the region database entries to turn on the IBM Application Debugging Program for the resource, the resource you name acts as a trigger. Startup of the IBM Application Debugging Program is triggered later, depending on the type of resource involved:
289
CDCN
Resource termid sysid transid program Startup of the IBM Application Debugging Program triggered by The next transaction run on that terminal The next transaction run as a result of a request from that system The next invocation of that transaction The next invocation of that program
When the IBM Application Debugging Program is rst started, it remains attached to the CICS application server (cicsas) process, debugging one or more programs, until the end of the transaction (even when it has been triggered to debug a program), or until you choose to quit from the IBM Application Debugging Program. The IBM Application Debugging Program is attached when it is attached to the cicsas process (that is, actually debugging one or more programs); the IBM Application Debugging Program is detached when it is no longer attached to the cicsas process (that is, when it has nished debugging a transaction and is waiting to be triggered again). Once the IBM Application Debugging Program has started, it can only be terminated in one of two ways: v When the IBM Application Debugging Program is attached, using the quit facility of the IBM Application Debugging Program itself. v When the IBM Application Debugging Program is detached, using CDCN. Each trigger resource can have just one session of the IBM Application Debugging Program started for it, and there is an implied order of precedence of: 1. termid 2. sysid 3. transaction 4. program This means, for example, that, if you turn on debugging both for a terminal with identier AR01 and for a transaction with identier ALAN, and you run transaction ALAN on terminal AR01, only one session of the IBM Application Debugging Program will be started (that associated with terminal AR01) because two debug sessions cannot debug the same physical copy of the code and the terminal trigger takes precedence over the transaction trigger. A second invocation of ALAN run from a different terminal, however, will also start a session of the IBM Application Debugging Program (that associated with transaction ALAN). It is thus possible to have multiple copies of the same program code being debugged at the same time. Note that only programs compiled for debug will produce symbolic output from the IBM Application Debugging Program when run under control of the IBM Application Debugging Program. If the IBM Application Debugging
290
CDCN
Program is triggered for a program that has not been compiled for debug, the IBM Application Debugging Program displays the program as assembler statements.
291
CEBR (Temporary Storage Browse) CEBR (Temporary Storage Browse)

Used to browse the contents of temporary storage queues.
Syntax
CEBR [queueName]
Options
queueName is the name of the temporary storage queue that you wish to browse. If you do not specify a queue name, the CEBR transaction generates one for you. The generated queue name is CEBRtermId, where termId is your terminal identier.
Examples
To browse temporary storage queue TSQ1:
CEBR TSQ1
Description
Temporary Storage Browse (CEBR) is a debugging aid that you can use to browse (read without changing) and manipulate the contents of CICS temporary storage queues. You can also use it to transfer a transient data queue to or from a temporary storage queue. The CEBR facility allows you to answer the following questions: v Did the record go to the correct queue? v Are the correct number of records in the queue? v Exactly what data is held in the temporary storage queue? v What is the current content of the transient data queue to which this application program has just written? v Do the transient data records contain the correct information? Starting and ending CEBR: You start the CEBR transaction directly by entering the tranid CEBR, and, optionally, a queue name. You end the transaction by pressing PF3. Using the CEBR screens: CEBR begins by generating the CEBR screen area, as shown in the following gure. In this gure, no queue name is supplied, and the terminal invoking the CEBR transaction has a terminal identier of TERM.
292
CEBR (Temporary Storage Browse)

CEBR TS QUEUE ENTER COMMAND ===> CEBRTERM RECORD 1 OF 0 COL 1 OF 0
TEMPORARY STORAGE QUEUE CEBRTERM PF1 : HELP PF2 : SWITCH HEX/CHAR PF4 : VIEW TOP PF5 : VIEW BOTTOM PF7 : SCROLL BACK HALF PF8 : SCROLL FORWARD HALF PF10: SCROLL BACK FULL PF11: SCROLL FORWARD FULL
PF3 : PF6 : PF9 : PF12:
TERMINATE BROWSE REPEAT LAST FIND UNDEFINED UNDEFINED
The CEBR screen contains three distinct areas. These are: v Command Input (the second line of the screen) v Information (18 lines on a 24 x 80 screen) v PF Key Values (the last four lines of the screen) Command input: This is the second line of the screen. You use this line to enter any of the following CEBR commands: BOTTOM shows the last page of the current queue. COLUMN nnnn moves the displayed area to this column of the queue. FIND /string nds the next occurrence of the specied string after the current line, making the line containing the string the second on the display page. The slash (/) is a delimiting character. The delimiting character does not have to be slash. However, it must not be a character that appears in the search argument. If there are blank characters in the string, you must terminate that string with the delimiting character that started it. For example, to nd the rst occurrence of the string QUEUE TSQ1, enter:
FIND /QUEUE TSQ1/
If you use a slash as the delimiter, you can omit the keyword FIND. FIND does not nd a specied string if it is on the rst line or on the current line. GET TDqueueName moves the data from a named transient data queue to the temporary storage queue that is being browsed. This allows you to browse the
293

contents of the named transient data queue. TDqueueName must be the four-character name either of an intrapartition transient data queue, or of an extrapartition transient data queue that has been opened for input. If the transient data queue is logically recoverable, the GET command places a READ lock on the queue for the duration of the CEBR session. This means that a queue cannot be read by two concurrent CEBR sessions. Also, if the queue contains uncommitted records (from an EXEC CICS WRITEQ TD or a CEBR PUT which has not completed) CEBR GET will wait for the WRITE lock to be released (when the transaction writing the records reaches completion or syncpoint) before reading the records into the temporary storage queue for display. LINE nnnn makes the specied line the second line on the screen. PURGE erases the contents of the queue being browsed. PUT TDqueueName copies the data from the temporary storage queue being browsed to the named transient data queue. You can use this command to prepare data for printing, or to return data to a transient data queue after you have browsed through it. TDqueueName must be the four-character name either of an intrapartition transient data queue, or of an extrapartition transient data queue that has been opened for output. If the transient data queue is logically recoverable CEBR PUT places a WRITE lock on the queue for the duration of the CEBR session. This will, for instance, prevent the new records in the queue being read by GET TDqueueName in another CEBR session until this CEBR session has ended. QUEUE TSqueueName species the eight-character name of a temporary storage queue that you want to become the current queue. The value that you specify can be in hexadecimal, for example:
QUEUE X'4142'
CEBR responds by displaying the data held in the named queue. You can also change the current queue by overtyping the queue name, displayed in the TS QUEUE eld on the top of the screen, and pressing the ENTER key. TERMINAL termId changes the name of the queue. CEBR takes the rst four characters of the
294

current queue name and adds the four characters represented by termId (the terminal identier) to the end, so that they become the last four characters of the new queue name. TOP shows the rst page of the current queue. Information: This area consists of the remainder of the screen between the command input area at the top, and PF key values at the bottom of the screen. CICS uses this area to display the temporary storage queue. When CEBR displays an argument in character format, some of the characters may not be displayable (including lowercase characters). CEBR replaces each nondisplayable character by a period, so you must be aware that periods indicate either a valid period character, or storage containing other nondisplayable data. Data display does not take into account the locale the user is using, and any byte in the data stream that is displayable is displayed in its character form. In a single-byte environment, nondisplayable bytes are displayed as a period (.). In a multi-byte environment, nondisplayable bytes should be displayed as a period, but some nondisplayable data might be displayed as characters. Binary data might also be displayed as characters. Note: The term locale is used to refer to a subset of a users environment that denes conventions for a specied culture, such as time formatting, numeric formatting, monetary formatting, and character classication, conversion, and collation. Refer to your operating system documentation for more information about locales and how they are used. Program function (PF) key values: The four lines at the bottom of the CEBR screen provide a menu indicating the effect of the PF keys for this screen. If the terminal does not have PF keys, you can obtain the same effect by positioning the cursor under the required instruction on the screen and pressing the ENTER key. You can use the tab keys to position the cursor correctly. The following list explains the meaning of each PF key. PF1 displays help.
295

PF2 toggles between displaying data in character and hexadecimal formats. CICS maintains the state of the toggle when you select a new TS queue. PF3 exits from CEBR. PF4 displays the rst page of data (equivalent to the TOP command). PF5 displays the last 14 lines of data (equivalent to the BOTTOM command). PF6 repeats the last FIND command. PF7 scrolls back half a page (eight lines or less if the top of queue is encountered). PF8 scrolls forward half a page (eight lines or less if the bottom of queue is encountered). PF9 is an undened PF key, unless any lines for the current queue are too long to display. If this happens, PF9 permits you to view off-screen data. The PF9 key scrolls to the right each time you press it until the last column is reached. If you press the PF9 key again, it scrolls to the left until column one is reached. You can repeat this cycle indenitely. CICS scrolls horizontally in units of up to 60 columns (30 if the screen is in hexadecimal format), until CICS reaches the end of the data. The PF key legend for this key is updated to indicate the current assignment of this key. The possible legends are VIEW RIGHT, VIEW LEFT, and UNDEFINED. PF10 scrolls back one page. PF11 scrolls forward one page. PF12 is an undened function key. Running CEBR: You use CEBR commands or the PF keys to process the queue. You can also use CEBR to copy transient data queues to temporary storage (although you cannot read an output extrapartition transient data queue) and to copy
296

temporary storage to transient data queues (although you cannot write an input extrapartition transient data queue). Note: The term extrapartition transient data is used to describe a CICS facility that temporarily saves data in the form of queues, called destinations. Extrapartition destinations are used for data that is either coming from a source outside the region, or is being directed from a source within the region to a destination outside the region. The CEBR transaction allows users to browse or copy data on queues. You might want to restrict access to the transaction so that unauthorized personnel cannot browse the data. To restrict access to the transaction, you should employ transaction level security. To restrict access to the queues, you should employ resource level security. See the CICS Administration Guide for related information.
297
CECI and CECS CECI (Command Level Interpreter) and CECS (Syntax Checker)
To check the syntax of, interpret, and run EXEC CICS commands.
Syntax
{CECI | CECS} [commandName]
Options
commandName is the name of the CICS API command whose syntax you wish to check, or that you wish to interpret.
Examples
To read a record with key 009000 from le FILEA:
CECI READ FILE('FILEA') RIDFLD('009000')
Description
CECI allows you to check the syntax of, interpret, and run EXEC CICS commands. CECS allows you to check the syntax of EXEC CICS commands, but does not allow you to invoke them. The CECI and CECS transactions perform a dual role in the operation of a CICS system. v When writing application programs, you can check the syntax of the whole CICS command level application programming interface. If you are using CECI, you can carry through most of the commands to invocation, and you can request to see the results of the invocation. v Using CECI provides a means of interaction with the system. For example, you can correct a le control record that has been overwritten with invalid data, create or delete a temporary storage queue, and so on. CECI provides a useful extension to the facilities provided by the runtime resource management transaction, CEMT. Starting and ending CECI or CECS: You start the CECI or CECS transaction directly by entering the transaction identier CECI or CECS, respectively and, optionally, a CICS command. You end the transaction by pressing PF3. Using the CECI and CECS screens: The command checker and interpreter divides the screen into four areas. These are:
298
CECI and CECS

v v v v Command Input (the rst line of the screen) Status (the second line of the screen) Information (21 lines on a 24 x 80 screen) PF Key Values (the last line of the screen)
Command input: This is the rst line of the screen. You use this line to enter the command whose syntax is to be checked, or that is to be performed, either in the normal format, or in an abbreviated or condensed form that reduces the number of keystrokes involved. The condensed form of the command is obtained because: v The keywords EXEC CICS are optional. v You can abbreviate the options of a command to the minimum number of characters needed to make each option unique. Valid abbreviations are shown in uppercase characters in the syntax displayed on screen. v The quotes around character strings are optional, and all strings of characters are treated as character-string constants unless they are preceded by an ampersand (&), when they are treated as variables. v Command options receiving a value from CICS at runtime are called receivers, and do not have to be specied. The value received from CICS is included in the syntax screen after CICS performs the command. The following example shows the condensed form of a command. You can enter the le control command:
EXEC CICS READ FILE('FILEA') RIDFLD('009000') INTO(data area)
on the command input line, as:

READ FIL(FILEA) RID(009000)
or at a minimum, as:
READ F(FILEA) R(009000)
In this example, the INTO option is a receiver (as dened previously), and you can leave it out. Status: This is the second line of the screen. It contains one of the following messages:
COMMAND SYNTAX CHECK ABOUT TO EXECUTE COMMAND COMMAND EXECUTION COMPLETE (or COMMAND NOT EXECUTED)
299
CECI and CECS

EXEC INTERFACE BLOCK VARIABLES SYNTAX MESSAGES EXPANSION OF
The status message describes the type of information in the information area of the screen. The COMMAND SYNTAX CHECK status message indicates that CICS has checked the syntax of the entered command, but is not about to perform the command. This is always the status for CECS, and for CECI with a question mark before the command. It is also the status when the syntax check of the command gives severe error messages and for those commands that can not be run (for example, HANDLE CONDITION and HANDLE AID). The ABOUT TO EXECUTE COMMAND status message appears when none of the reasons for stopping at COMMAND SYNTAX CHECK apply. The COMMAND EXECUTION COMPLETE status message appears in response to the ENTER key after an ABOUT TO EXECUTE COMMAND. CICS performs the command and displays the results on the screen. The EXEC INTERFACE BLOCK status message appears when you press PF4. The VARIABLES status message appears when you press PF5. The SYNTAX MESSAGES status message appears when you press PF9. The EXPANSION OF status message appears when you position the cursor at an option value or a variable, and press ENTER. Information: This area consists of the remainder of the screen between the command input and status areas at the top, and PF key values at the bottom of the screen. CICS uses this area to display the syntax of the entered command, error message information, the response to the run, and any other information that can be obtained by using the PF keys or the cursor. A line at the bottom of this area is reserved for messages describing errors in the conversation with you (for example, INVALID PACKED DECIMAL). CICS highlights these messages to attract attention. The content of the information area varies, depending on which message is in the status area. The information area of the screen for COMMAND SYNTAX
300
CECI and CECS

CHECK, ABOUT TO EXECUTE COMMAND, and COMMAND EXECUTION COMPLETE contains information common to all three screens. Command syntax check: CICS displays the full syntax of the command and error information at the bottom of the screen. CICS intensies options in the syntax panel to show those specied on the command input line, those assumed by default, and any receivers. You can modify the command on the command input line at any time by overtyping and pressing the ENTER key. When an argument is to be displayed in character format, some of the characters may not be displayable. CECI replaces each nondisplayable character by a period (.). You must be aware that periods can indicate either a valid period character, or storage containing data other than a period. You cannot overtype characters with a period in character format. To overtype a character with a period, you must use PF2 to switch the screen to hexadecimal format and type hexadecimal 2E. If the command has more options than can be held in one screen, a plus sign (+) appears to the left side of the last option on the current screen to indicate that there are more. You can view these by using one of the scrolling PF keys. The syntax on screen differs slightly from the syntax notation used in this book in the following ways: v Square brackets ([ ]) are replaced by the less than (<) and greater than (>) symbols. v Braces { } are not used. If a mandatory option is left out, CICS displays an error message and does not continue performing the command until you specify the option. v Parentheses ( ) are used to indicate that an option requires a value or data eld, but you have not specied one. The error information consists either of a single error message, or an indication of the number and severity of the messages generated. About to execute command: The information area of this screen is similar to that of COMMAND SYNTAX CHECK, but there is no error information. You can modify option values by overtyping them in the syntax information.
301
CECI and CECS

This modication is a temporary modication for the duration of the command and does not affect the command input line. It is similar to the modication of option values that is possible with the Execution Diagnostic Facility (EDF) when debugging an application program. Command execution complete: The information area of this screen is similar to that of COMMAND SYNTAX CHECK, but it displays the results after CICS has performed the command. CICS displays any receivers as intensied, whether they were specied or not, together with their CICS-supplied values. If the value of an option is too long for the line, CICS only displays characters to the end of the line followed by ... to indicate there is more. To produce an expanded display of the whole option value, position the cursor, using the tab key, at the start of the option value and pressing the ENTER key. CICS displays the appropriate response code (for example, NORMAL) together with the contents of the EIBRESP eld of the Exec Interface Block (EIB) at the bottom of the information area. Note: CECI returns exceptional conditions for some commands, even if the selected options are correct, because CECI checks every option of the command, whether or not you specied the options. You may not have specied an option because you did not need it. Alternatively, you may not have specied certain options because they are mutually exclusive. For example, the ASSIGN command always returns the exceptional condition INVREQ when you check it using CECI. Because CECI is an interactive transaction, CICS processes all commands running under its control as if the NOHANDLE option were active, thus forcing all responses back to CECI when the command has completed. EXEC interface block: The information area shows, in response to pressing the PF4 key, the exec interface block. See the CICS Application Programming Reference for further information. Variables: The information area shows, in response to pressing the PF5 key, all the variables associated with the current interpreter session, showing the name, length, and value of each one. Normally, the value supplied for an option in the command input area is taken as a character string constant. However, sometimes this value must be
302
CECI and CECS

represented by a variable. The command interpreter recognizes a value as a variable only if it is preceded by an ampersand (&). You can specify a variable when connecting two associated commands through the values supplied in their options, for example, READ INTO (data-area), UPDATE, and REWRITE FROM (data-area). You can use a variable to make the data area in the FROM option the same as that in the INTO option. A variable is also useful when the values of options cause the command to exceed the line length of the command input area. The commands can be used by creating variables with the required values and specifying the variable names in the command. You can also use variables to contain commands, and you can enter variable names in a command input line that contains complete or partial commands. CICS deletes variables at the end of a command interpreter session unless you take action to save them, for example, in temporary storage. You can use one of the following methods to create variables, which can be of data type character, 32-bit binary, 16-bit binary, or packed decimal: v By naming the variable in a receiver. CICS creates the variable when performing the command. The data type is implied by the type of receiver. v By adding one or more new entries to the list of variables already dened. You request this list by pressing key PF5. The screen shows all dened variables giving, for each, its name, length in bytes, and its value. CICS displays the value in character form, but you can use PF2 to switch from character to hexadecimal. You obtain an expanded display of each variable by positioning the cursor under the ampersand (&) of the name and pressing the ENTER key. To create a new character variable, enter its name and its length and press ENTER. CECI initializes the variable to blanks, which you can then overtype. Enter F (32-bit binary), H (16-bit binary) or P (packed decimal) in the length eld. CECI initializes these elds to zero. You can modify variable names, lengths, and their values, by overtyping. You can delete variables by positioning the cursor under the ampersand (&) of the name and pressing ERASE EOF. You can copy variables by obtaining the expanded display of the variable and overtyping the name eld. v By associating a variable name with the value of an option. Positioning the cursor, using the tab key, at the start of the line of the syntax display and pressing ENTER produces an expanded display of the whole option value. You can now assign a variable name to the displayed data. v By entering a name in the NAME= eld of the syntax display on screen. This creates a variable containing the current command.
303
CECI and CECS

Note: When variables are displayed in hexadecimal, those character variables which contain numerical values are displayed in the byte order of the machine, whereas variables of type F, H, or P are displayed with the most signicant byte to the left, irrespective of the byte order of the machine. Three variables are provided initially: &DFHC is a sample. &DFHW contains a temporary storage EXEC CICS WRITEQ command. &DFHR contains an EXEC CICS READQ command. You can write a command to temporary storage by entering &DFHC in the NAME= eld of the syntax display on the screen, entering &DFHW in the command input line, and performing the EXEC CICS WRITEQ command. In this way, you can request a list of commands to be written. The command list can be read and performed by alternately entering &DFHR and &DFHC in the command input line. For example:
CECI WRITEQ TS QUEUE(QUEUE1) FROM (&DFHC)
Syntax messages: The information area shows, in response to pressing the PF9 key, any syntax messages associated with the entered command. Each message has an associated severity, which is displayed as a single character and a colon preceding the error message. An example is an error message, which is preceded by E:. If there is more than one message generated for a command, the number of messages is also displayed. Expansion of screen area: The whole of the information area of the screen is used to display an area selected by means of the cursor. You can position the cursor at the start of the value of an option on a syntax screen, or under the ampersand of a variable in a variables screen. Press ENTER to get the expanded area screen. You can use the scrolling keys to display all the information if it exceeds a full screen. Program function (PF) key values:
304
CECI and CECS

The single line at the bottom of the screen provides a menu indicating the effect of the PF keys for the display. If your terminal has no PF keys, you can obtain the same effect by positioning the cursor under the required item in the menu by means of the tab keys, and pressing ENTER. The following PF keys are available: PF1 displays help on using the command interpreter or syntax checker and on the meanings of the PF keys. PF2 toggles between displaying data in character and hexadecimal forms. All further screens stay in the chosen mode until the next time you press the PF2 key. PF3 exits from CECI or CECS, so ends the current session of the interpreter or syntax checker. PF4 shows the contents of the EXEC interface block (EIB). This key is not available in the EIB display. PF5 shows all the variables associated with the current command interpreter session, giving for each its name, length, and value. This key is not available in the variables display. PF6 shows what you would see if the terminal had been running a transaction which contained the screen access commands which have been run using the interpreter. This key is not available from CECS or when you are viewing the user display. PF7 scrolls half a page backward. PF8 scrolls half a page forward. PF9 shows all the messages generated during the syntax check of a command. This key is not available in the syntax messages display. PF10 scrolls a page backward. PF11 scrolls a page forward.
305
CECI and CECS

PF12 is undened. CECI and CECS begin by generating the CECI or CECS screen area, shown in CECI or CECS screen. In this example, a user entered CECI READ FILE(FILEA) RIDFLD(009000).
READ FILE('FILEA') RIDFLD('009000') STATUS: ABOUT TO EXECUTE COMMAND EXEC CICS READ Dataset() | File(FILEA ) SEt() | Into() <Length()> RIdfld(009000) <Keylength() <GEneric> | RBa | RRn> <SYsid()> <GTeq | Equal> <Update> NAME=
PF 1 HELP 2 HEX 3 END 4 EIB 5 VAR 6 USER 7 SBH 8 SFH 9 MSG 10 SB 11 SF
Running CECI or CECS: To run the command interpreter and syntax checker, you must have a transaction security key (TSL) that matches the transaction security key dened in the Transaction Denitions (TD). The TD entry for the CECI transaction species, by default, that resource level security checking is required for any resources referenced with the interpreter. This checking applies to les, transient data queues, temporary storage queues, programs, transaction identiers of the EXEC CICS START command, and journal le identiers. If the resource security level (RSL) specied in the appropriate resource denitionsuch as the File Denitions (FD) for a leis not matched by RSL keys of the user that is signed on, the resource security check fails, and the response to the command is the NOTAUTH condition. This response is given on the command execution complete screen. The following example gives the screen shown in CECI screen after command syntax error on page 307.
CECI READ FILE('FILEA')
Note: CICS displays an error message (indicated by E:) near the bottom of the screen. If there is more than one error message, the screen displays a message to press PF9 to see them.
306
CECI and CECS

READ FILE('FILEA') STATUS: COMMAND SYNTAX CHECK EXEC CICS READ Dataset() | File(FILEA ) SEt() | Into() <Length( +00020)> RIdfld() <Keylength() <GEneric> | RBa | RRn> <SYsid()> <GTeq | Equal> <Update> E: Command requires the option: 'RIDFLD'
NAME=
Modifying the command input to:

READ FILE('FILEA') RIDFLD('009000')
gives the screen shown in CECI screen after the correct command input. The error message has disappeared because you have supplied the requested record identication eld.
READ FILE('FILEA') RIDFLD('009000') STATUS: ABOUT TO EXECUTE COMMAND EXEC CICS READ Dataset() | File(FILEA ) SEt() | Into() <Length()> RIdfld(009000) <Keylength() <GEneric> | RBa | RRn> <SYsid()> <GTeq | Equal> <Update> NAME=
The command is now ready to be run, and you achieve this by pressing the ENTER key. CICS displays the screen shown in CECI screen after command has been executed on page 308, showing the result of performing the command.
307
CECI and CECS

READ FILE('FILEA') RIDFLD('009000') STATUS: COMMAND EXECUTION COMPLETE EXEC CICS READ Dataset() | File(FILEA ) SEt() | Into( 'HDGDJH KDFKSJDF KSDJ') <Length( +00020)> RIdfld(009000) <Keylength() <GEneric> | RBa | RRn> <SYsid()> <GTeq | Equal> <Update> RESPONSE: NORMAL EIBRESP=+000000000 PF 1 HELP 2 HEX 3 END 4 EIB 5 VAR 6 USER 7 SBH 8 SFH 9 MSG 10 SB 11 SF
A question mark (?) before the command gives the command syntax check screen and prevents CICS performing the command. The use of CECS forces a question mark before the command. This gives the command syntax check screen and prevents CICS performing the command. In a system where security is important, you can make CECS more widely available than CECI. See the CICS Application Programming Reference and the CICS Administration Guide for related information.
308
CEDF CEDF (Execution Diagnostic Facility)

To control the Execution Diagnostic Facility (EDF).
Syntax
CEDF { termId | sysId } [,ON | ,OFF ]
Options
termId is the four-character identier of the terminal on which the transaction to be tested is being run. This identier must be dened in the Terminal Denitions (WD), unless it is generated from a terminal autoinstall. The terminal must be another terminal in the same region as the current terminal. The WD entry species what type the terminal is, for example a physical terminal or a window. To nd the terminal identier of an autoinstalled terminal, you can run the CEMT INQ TERMINAL transaction, which lists all the terminals logged on to the CICS region. Alternatively, you can look at the autoinstall message in the CSMT log, which is in the following le:
/var/cics_regions/regionName/data/CSMT.out
sysId is the four-character identier of the remote region (sysid) when you want to test inbound transactions from a different region. This identier must be dened in the Communications Denitions (CD). ON species that the EDF session is to be started. This is the default. OFF species that the EDF session is to be ended. Examples: 1. To start an EDF session to debug an application running on a terminal with a termid of TRM1:
CEDF TRM1
2. To end the EDF session started in the previous example:

CEDF TRM1,OFF
Description
CEDF is the transaction identier used to start or stop an Execution Diagnostic Facility (EDF) session on a terminal or a region. EDF enables you to test, online, an application program that has been preprocessed using the -e option of the CICS translator (cicstran), without modifying the program. If the
309
CEDF
-d option of the cicstran command is also used, the translator source listing also has line numbers that EDF can use. CICS passes control to EDF at specic interception points. EDF displays the state of the application program at the interception point, and allows you to interact with EDF screens to both view additional information about the program, and overtype certain areas of the screen to test the execution of the program, before returning control to the application code. In CICS on Open Systems or CICS for Windows NT, you can use EDF in either single or dual screen mode. In single screen mode the CEDF transaction and the application being debugged run on the same terminal and PF6 is used to switch between them. In dual screen mode two different terminals are used, one for the CEDF transaction and one for the application, though these may be two logical terminals (windows) on one physical terminal. You can use EDF only from a terminal that has a screen width of 80 columns or more, and a screen depth of 24 lines or more. When you run CEDF to debug a transaction, the transaction runs, sets a ag, and exits, all in a very short time. Therefore, CEDF is not running in the system as you run your transaction (in a similar way that a pseudo-conversational transaction is not running and most of the time does not appear on INQ TASK displays). On CICS on Open Systems of CICS for Windows NT, both terminals are under the control of a single task (the user task), which is effectively debugging itself and sending the output to the terminal running under CEDF. You can use EDF to test user transactions (application programs) and the function shipping mirror transaction supplied by CICS. You must rst translate any applications for use by EDF using cicstran or cicstcl. You cannot use EDF for any other transaction provided by CICS. Starting and ending CEDF: You start the CEDF transaction by entering the transaction identier CEDF and, for dual screen mode, either a terminal id or a sysid. The ON parameter is not required as ON is the default. You end the transaction by entering CEDF OFF. Using the CEDF screen: The execution diagnostic facility divides the screen into four areas. These are: v Program information (the rst line of the screen) v Status (the second line of the screen) v Information (18 lines on a 24 x 80 screen) v PF Key Values (the last four lines of the screen)
310
CEDF
The following gure shows a typical EDF screen.
TRANSACTION: ABCD PROGRAM: ABCDPROG STATUS: COMMAND EXECUTION COMPLETE EXEC CICS READQ TS QUEUE ('AC011111') INTO (' ........') LENGTH (12) ITEM (1) TASK NUMBER: 0000000059 DISPLAY: 00
LINE: RESPONSE:
NORMAL PF2 : PF5 : PF8 : PF11:
EIBFN=X'0A04' EIBRESP=0 SWITCH HEX/CHAR WORKING STORAGE SCROLL FORWARD UNDEFINED PF3 : PF6 : PF9 : PF12: END EDF SESSION USER DISPLAY STOP CONDITIONS ABEND USER TASK
ENTER: CONTINUE PF1 : HELP PF4 : SUPPRESS DISPLAYS PF7 : SCROLL BACK PF10: UNDEFINED
If you press the ENTER key while the cursor is not positioned within the PF key denition area, EDF performs the function specied for the ENTER key. EDF uses the line immediately above the PF key menu to display messages to you. You can request argument values to be displayed in character or hexadecimal format. If you request character format, EDF shows numeric arguments in numeric character format, with a sign if the number is negative. Each argument value is restricted to one line of the screen. If the value is too long, EDF only displays characters to the end of the line, followed by ... to indicate that the value is incomplete. If EDF displays the argument in hexadecimal format, EDF also displays the address of the argument. You can overtype any screen area where the cursor stops when you press the tab keys. For example, you can move the cursor to the response eld and change the response from NORMAL to ERROR, to test the programs error handling at this point in the program. You can overtype any screen area where the cursor stops when you press the tab keys. For example, you can move the cursor to the response eld and change the response from NORMAL to ERROR, to test the programs error handling at this point in the program. The response of EDF to your user request is in the following order of priority: 1. If you use the CLEAR key, EDF redisplays the screen and ignores any changes.
311
CEDF
2. If you make invalid changes, EDF redisplays the screen with a diagnostic message for the invalid changes, but accepts any valid changes. 3. If you use a PF key or the ENTER key when the cursor is in the PF key denition area, EDF accepts any changes and performs the action requested by the PF key. 4. If you use the ENTER key while the cursor is not in the PF key denition area, and have not modied the screen (other than the REPLY eld), then EDF performs one of the following functions, corresponding to the ENTER key: CONTINUE causes your user transaction to continue, unless you have modied the screen. If you have modied the screen, EDF redisplays the screen with changes incorporated. CURRENT DISPLAY displays the screen displayed before you started examining other screens, such as EIB, unless you have modied the screen. If you have modied the screen, EDF redisplays the screen with changes incorporated. Program information: The rst line of a CEDF screen displays information about the application program being debugged. It displays the transaction identier, the program identier, and the task number. It also shows the current display number (xed at 00 for this release of CICS). Status: This is the second line of the screen. It contains one of the following:
PROGRAM INITIATION ABOUT TO EXECUTE COMMAND COMMAND EXECUTION COMPLETE (or COMMAND NOT EXECUTED) PROGRAM TERMINATION TASK TERMINATION AN ABEND HAS OCCURRED ABNORMAL TASK TERMINATION EXECUTION INTERFACE BLOCK DISPLAY ON CONDITIONS
This status line describes the type of information in the immediately following information area. Information:
312
CEDF
This area consists of the remainder of the screen between the status area at the top, and the PF key values at the bottom of the screen. CEDF uses this area to display the syntax of the command being performed, error message information, the response to the run, and any other information that can be obtained by using the PF keys or the cursor. Program function (PF) key values: The four lines at the bottom of the CEDF screen provide a menu indicating the effect of the PF keys for that particular screen. Although the menu changes from one screen to another, the PF keys stay in the same place on each screen. If your keyboard does not have PF keys, you can position the cursor, using the tab keys, under the required instruction on the screen, and press the ENTER key. PF1 : HELP displays help. PF2 : SWITCH HEX/CHAR toggles the display between hexadecimal and character representation. CICS maintains further screen displays in the chosen mode until the next time you press the PF2 key, or you exit from CEDF. PF3 : END EDF SESSION exits from CEDF. The debugging session ends, so the terminal comes out of EDF mode. The user transaction continues. PF4 : EIB DISPLAY displays the value of elds in EIB and COMMAREA (if any). PF4 : SUPPRESS DISPLAYS suppresses all EDF displays until the next stop condition occurs. PF5 : WORKING STORAGE displays the current working storage section of a COBOL user program. The information corresponding to this section is shown in both hexadecimal and character representations, similar to a dump listing. You cannot view your own main storage area (acquired by the use of the EXEC CICS GETMAIN command), but you can view the COMMAREA storage. PF5 : DATA AREA displays the current data area of a C user program. The information corresponding to this section is shown in both hexadecimal and character representations, similar to a dump listing. You cannot view your own main storage area (acquired by the use of the EXEC CICS GETMAIN command), but you can view the COMMAREA storage. If the stack frame of the C user program is available, you can use PF9 to switch between the current data area and the current stack frame.
313
CEDF
PF5 : STACK FRAME displays the current stack frame of a C user program. This is available only from the About to Execute Command, Command Execution Complete, and Command Not Executed screens. The information corresponding to this section is shown in both hexadecimal and character representations, similar to a dump listing. You can use PF9 to switch between the current data area and the current stack frame. PF6 : USER DISPLAY is used in single screen mode to switch from the CDEF display to the application display. Once in the application pressing any key switches back to the CEDF display. PF7 : SCROLL BACK scrolls a command or EIB display backwards. A plus sign (+) against the rst option or eld indicates there are more options or elds preceding. PF7 : SCROLL BACK HALF scrolls a working storage display half a screen backwards, displaying lower addresses. PF8 : SCROLL FORWARD HALF scrolls a working storage display half a screen forward, displaying higher addresses. PF9 : DATA AREA switches the stack frame display for a C user program to the data area display. You use this in conjunction with PF5. PF9 : STACK FRAME switches the data area display for a C user program to the stack frame display. You use this in conjunction with PF5. PF9 : STOP CONDITIONS switches to a display that allows you to determine the conditions under which CEDF will interrupt the program being tested. PF10: SCROLL BACK FULL scrolls a working storage display a full screen backwards, displaying lower addresses. PF11: SCROLL FORWARD scrolls a command or EIB display forward. A plus sign (+) against the last option or eld indicates there are more options or elds following. PF11: SCROLL FORWARD FULL scrolls a working storage display a full screen forward, displaying higher addresses. PF12: ABEND USER TASK terminates the user task. EDF asks you to conrm this action by
314
CEDF
displaying the message ENTER ABEND CODE AND REQUEST ABEND AGAIN. To abnormally terminate the task with a transaction dump identied by a specied abend code, enter the code at the cursor position and request the PF12 function again. If you enter NO, CICS abnormally terminates the task without a dump. Abnormal termination codes beginning with the character A are reserved for use by CICS. If you use a CICS abnormal termination code you might cause unpredictable results. You cannot use this function if an abnormal termination is already in progress or the task is terminating. PFxx: UNDEFINED means that this function is not available from this screen. Overtyping EDF displays: You can overtype certain areas of an EDF screen. These areas are the elds that the cursor stops at when you move it using the tab keys. You also use the tab keys to move the cursor within the PF key menu, but you cannot change the menu elds. v You can overtype any EXEC CICS command with blanks, NOP, or NOOP before running. This prevents CICS performing the command. v You can overtype any argument value, but not the keyword of the argument. You cannot remove an optional argument, nor can you add or delete an option. When EDF displays an argument in hexadecimal format, EDF also displays the address of the argument location. v Numeric values always have a sign eld that you can overtype only with a minus or a blank. v You can overtype the response eld in the information area with the name of any exceptional condition, including ERROR, that can occur for the current function, or with the word NORMAL. When EDF continues, the program takes the prescribed action for the specied response. v The EIBRESP eld can be overtyped with any desired decimal value that is valid for this eld when it is displayed as part of the EXEC interface block (EIB). This does not apply when this eld is part of a command display. When you overtype a eld representing a data area of a program, EDF places the entered value directly into the application programs storage. However, before performing a command, when you overtype a eld representing a data value (which may be a constant), EDF uses a copy of the eld. Therefore, the change does not affect other parts of the program using the same constant for an unrelated purpose.
315
CEDF
For example, you might overtype the map name before running an EXEC CICS SEND MAP command. The map used temporarily is the map name you entered, but the map name displayed on response is the original map name. When EDF displays an argument in character format, some of the characters may not be displayable (including lowercase characters). EDF replaces each nondisplayable character by a period. When overtyping a period, you must be aware that periods indicate either a valid period character, or storage containing other nondisplayable data. You cannot overtype characters with a period in character format, because EDF ignores the change, and does not issue any diagnostic message. Similarly, when EDF displays a value in hexadecimal format, EDF ignores overtyping with a blank character, and does not issue any diagnostic message. To overtype a character with a period, use PF2 to switch the screen to hexadecimal format and type X2E. When EDF displays storage in both character and hexadecimal format, if you change both and the changes conict, the value of the hexadecimal eld takes precedence. EDF does not issue any diagnostic message. Data display does not take into account the locale the user is using, and any byte in the data stream that is displayable is displayed in its character form. In a single-byte environment, nondisplayable bytes are displayed as a period (.). In a multi-byte environment, nondisplayable bytes should be displayed as a period, but some nondisplayable data might be displayed as characters. Binary data might also be displayed as characters. Note: The term locale is used to refer to a subset of a users environment that denes conventions for a specied culture, such as time formatting, numeric formatting, monetary formatting, and character classication, conversion, and collation. Refer to your operating system documentation for more information about locales and how they are used. If you enter invalid data, regardless of the action you requested, EDF ignores the invalid data and displays a diagnostic message. Interception points: When running a user transaction in debug mode, EDF intercepts the running of the application program at the following points, to allow you to interact with EDF before returning control to the application: 1. At program initiation:
316
CEDF
After initialization of the EIB, but before giving control to the application program. Immediately before performing each EXEC CICS command: After making the initial trace entry, but before performing the requested action. Immediately after performing each EXEC CICS command (except ABEND, XCTL, and RETURN): After performing the requested action, but before invoking the EXEC CICS HANDLE CONDITION mechanism, and before making the response trace entry. At program termination, task termination, and abnormal task termination. When an ABEND occurs.
2.
3.
4. 5.
At all the above points of interception, EDF displays the current status by identifying the cause of interception. In addition: v At point 1, EDF displays the contents of the elds in the EIB. v At point 2, EDF displays the command, including keywords, options, and argument values. The command is identied by transaction identier, program name, and, if the program has been translated using the cicstran command with the -d option, the line number of the command as given in the translator source listing. You can modify any argument value, or suppress the running of the command, but you cannot add or delete options. v At point 3, EDF displays the same as at point 2, plus the response from command running. You can modify certain argument values and the response code. v At points 6 and 7, EDF displays the values of the elds in the EIB and the abnormal termination code. You can interact with EDF in the following ways: v Display the values of the elds in the EIB associated with the program. v Modify most elds of the EIB. (See the CICS Application Programming Referencefor a complete list of elds). You cannot modify the following elds: EIBTASKN EIBFN EIBRCODE EIBRSRCE EIBSYNC
EIBFREE EIBRECV EIBSYNRB

317
CEDF
v v v v Display the programs working storage in hexadecimal and character form. Switch off debug mode and continue running the application normally. Force an ABEND. Request that command displays are suppressed until one or more of a set of specic conditions is fullled. These conditions are: EDF encounters a specic named command. EDF encounters any error condition for which the system action is to abnormally terminate the task. EDF encounters a specic exceptional condition. EDF encounters the command at a specic line number (assuming the program had been translated using the cicstran command with the -d option). EDF encounters an abnormal termination. The task terminates normally. The task terminates abnormally. Stopping the application run: When you request stop conditions, the Execution Diagnostic Facility (EDF) displays a skeleton menu, as shown in the following gure. After you have suppressed displays with the SUPPRESS DISPLAYS function, you can use this menu to specify one or more conditions that cause EDF to stop your transaction and start redisplaying commands.
TRANSACTION: ABCD PROGRAM: ABCDPROG TASK DISPLAY: 00 STATUS: DISPLAY ON CONDITIONS COMMAND: EXEC CICS LINE NUMBER: CICS EXCEPTIONAL CONDITION: ANY CICS ERROR CONDITION YES TRANSACTION ABEND YES NORMAL TASK TERMINATION YES ABNORMAL TASK TERMINATION YES ENTER: CURRENT DISPLAY PF1 : HELP PF2 : UNDEFINED PF4 : SUPPRESS DISPLAYS PF5 : WORKING STORAGE PF7 : UNDEFINED PF8 : UNDEFINED PF10: UNDEFINED PF11: UNDEFINED NUMBER: 0000000098
PF3 : PF6 : PF9 : PF12:
END EDF SESSION USER DISPLAY UNDEFINED UNDEFINED
EDF uses the functions in this menu to reduce the amount that you need to intervene when you check a partly working program. You can stop the transaction: v When a specied command is encountered v When a specied exceptional condition occurs while performing a command
318
CEDF
v v v v When any error condition occurs while performing a command When a transaction abend occurs while performing a command At normal task termination At abnormal task termination
You can also stop the transaction on a specied line. You can only do this if you specied the -d ag when you used the cicstran or cicstcl command to translate the program. Note: If you have link-edited two or more objects to form one CICS program, and each has been translated with the -d ag, there may be several source les with CICS statements at the line you specify. EDF stops at the rst line that you specied that has a CICS statement, which might not be the source le that you intended. In this situation, continue to use the same stop condition until EDF stops at the specied line in the source le you wanted. While you are debugging a transaction originating from a remote system, the transaction has its own set of stop conditions that apply only to that transaction. However, when a transaction ends and you choose to continue the EDF session, typically when debugging a pseudoconversational sequence of transactions, CICS maintains the current stop conditions against the Communications Denitions (CD) entry for the remote system. Any subsequent transaction originating from the remote region inherits these stop conditions. This continues until CICS maintains a new set of stop conditions against the same CD entry. The new set of stop conditions overwrites the previous ones. For example, two users are running EDF to debug two transactions, A and B, originating from the same remote system. Transaction A ends, and the rst EDF user chooses to continue the EDF session. CICS maintains the stop conditions that were in force for transaction A against the CD entry for the remote system. Then transaction B terminates, and the second EDF user chooses to continue the EDF session. CICS maintains the stop conditions that were in force for transaction B against the same CD entry for the remote system. These stop conditions replace those from transaction A (which CICS loses). Any further transactions originating from the remote system begin with the stop conditions from transaction B. Running CEDF: You must specify the same TSLCheck value in the Transaction Denitions (TD) entry for the CEDF transaction as that specied for the user transaction. Therefore, to use internal security, both must be set to internal, or to use an External Security Manager (ESM), both must be set to external.
319
CEDF
To invoke EDF, you must have a TSLKey that matches the TSLKey dened for the CEDF transaction in the TD. In addition, to test a particular transaction, you must have a TSLKey that matches the TSLKey for that transaction. If this condition is not satised, CICS terminates the EDF session immediately and the following message is displayed:
Security violation: Security check does not allow debug access
By default, CICS makes resource level security checks when running the transaction under test, unless you redene the CEDF transaction as not requiring these checks. To redene the CEDF transaction, edit the TD for CEDF. If a transaction has no resource level security checks, and you do not redene the CEDF transaction, the default resource level security checks will cause a security violation, the CEDF transaction will fail, and an error message is written to CSMT. If security checks indicate that you are not allowed access to the resource, your transaction raises the NOTAUTH condition. Unless you choose to handle this condition, CICS abnormally terminates your transaction. If a transaction that can be run under EDF is already running on the specied terminal or is inbound from the system, EDF associates itself with that transaction. Otherwise, EDF associates itself with the next transaction that can be run under EDF. When an application program running under EDF ends, the following message is displayed on screen:
Continue this EDF session?: YES/NO?
If you choose no, the EDF session on the terminal ends. If you choose yes, EDF associates itself with the next possible transaction on the specied terminal. Note that, if you are running an EDF session on a terminal and another user tries to run an EDF session on the same terminal, the EDF session transfers to the new user for the next transaction, even though you can request to continue the EDF session and will get the conrmation message:
EDF SESSION CONTINUED
You run EDF on a different physical terminal, or window, to the transaction to be tested. See the CICS Application Programming Guide for related information.
320
CEMT CEMT (Runtime Resource Management)

The Runtime Resource Management (CEMT) transaction allows you to examine and alter, while the region is running, the CICS system resource denitions that were initiated at startup. This transaction affects only the runtime environment. Any changes made to resource denitions using CEMT apply to the current session of CICS they are not saved but are replaced with the permanent resource denitions on the next restart, whether cold or auto. CEMT allows a user to inquire on and to amend resource denitions, but not to insert new denitions or to delete existing ones. To insert new denitions, or delete existing ones, you can use the resource denition online (RDO) commands cicsadd and cicsdelete. (See cicsdelete Delete CICS resource denitions on page 145.)
An overview of the CEMT parameters

The initial CEMT parameters are PERFORM SNAP (obtain a dump) INQUIRE (inquire about a CICS resource) and SET (set a value for a CICS resource). INQUIRE and SET have extended parameters. Some can be used with both INQUIRE and SET, while others are used with INQUIRE only. Refer to the following tables:
Table 8. The CEMT extended parameters used with INQUIRE and SET
Extended parameter AUTOINSTALL AUXTRACE DUMP DUMPOPTIONS Description of extended parameter Inquire upon and set the name of the terminal autoinstall program. See CEMT INQ/SET AUTOINSTALL on page 331 for complete details. Inquire upon and set whether auxiliary trace is on or off, See CEMT INQ/SET AUXTRACE on page 332 for complete details. Inquire upon and set the system dump ag. See CEMT INQ/SET DUMP on page 333 for complete details. Inquire upon and set whether a system dump is required following an abnormal termination with code ASRA or ASRB. See CEMT INQ/SET DUMPOPTIONS on page 334 for complete details. Inquire upon and set certain le attributes in the runtime database. See CEMT INQ/SET FILE on page 335 for complete details. Inquire upon and set whether a journal is open for output or closed. See CEMT INQ/SET JOURNAL on page 338 for complete details. Inquire upon and set whether performance monitoring is on or off. See CEMT INQ/SET MONITOR on page 339 for complete details.
FILE JOURNAL MONITOR
321
CEMT
Table 8. The CEMT extended parameters used with INQUIRE and SET (continued)
Extended parameter NETNAME(netname) Description of extended parameter Inquire upon certain network name attributes. Network name attributes cannot be SET. See CEMT INQ/SET NETNAME on page 340 for complete details. Inquire upon and set certain program and map attributes in the runtime database. See CEMT INQ/SET PROGRAM on page 342 for complete details. Inquire upon and set runtime task attributes. See CEMT INQ/SET TASK on page 344 for complete details. Inquire upon and set runtime task class attributes. See CEMT INQ/SET TCLASS on page 347 for complete details. Inquire upon and set certain transient data queue attributes in the runtime database. See CEMT INQ/SET TDQUEUE on page 348 for complete details. Inquire upon and set runtime terminal attributes. See CEMT INQ SET TERMINAL on page 351 for complete details. Inquire upon and set whether the trace facility is on or off. See CEMT INQ/SET TRACE on page 353 for complete details. Inquire upon and set runtime transaction attributes. See CEMT INQ/SET TRANSACTION on page 354 for complete details.
PROGRAM
TASK[(number)] TCLASS TDQUEUE
TERMINAL TRACE TRANSACTION
Read also Concepts of Inquire and Set Operations on page 328. INQUIRE As described in Inquiring upon CICS system parameters using CEMT on page 355, you can inquire about the following system parameters:
Table 9. The CEMT extended parameters used with INQUIRE only
Extended parameter AKP APPLID DATEFORM INTROINTVL LOCALE Description of extended parameter How often CICS writes checkpoint records. The eight-character name that identies the CICS region. The date format used by the EXEC CICS FORMATTIME command. The number of minutes between invocations of the CICS private transaction that checks the integrity of the region. The value of the region-wide locale. The term locale is used to refer to a subset of a users environment that denes conventions for a specied culture, such as time formatting, numeric formatting, monetary formatting, and character classication, conversion, and collation. Refer to your operating system documentation for more information about locales and how they are used.
322
CEMT
Table 9. The CEMT extended parameters used with INQUIRE only (continued)
Extended parameter MAXREGIONPOOL MAXTASKSHPOOL OPREL OPSYS REGIONTHRESH RELEASE SYSID TASKSHTHRESH Description of extended parameter The maximum region pool size required by CICS. The maximum task shared pool size required by CICS. The operating system release number. A one-character abbreviation of the operating system. When CICS should report that it is running out of Region Pool storage. The CICS release level. The four-character CICS region identier. When CICS should report that it is running out of Task Pool storage.
How to invoke CEMT

To invoke CEMT, your transaction security key (TSL) must match the transaction security key dened for CEMT in the Transaction Denitions (TD). The default region settings do not carry out resource level security checking for CEMT, but you can alter this in the TD if you want to. You can construct a CEMT request in stages, or you can enter a complete request. The CEMT transaction checks the syntax of requests and diagnoses errors. If your request is syntactically correct, CICS performs it immediately. If CICS cannot satisfy your request because of syntax errors, CICS displays the full syntax of your request. Once you start the CEMT transaction, you do not have to type CEMT for further requests, because the identier is implied at the beginning of each further request until you exit from CEMT. To exit from CEMT, press PF3. 1. Type CEMT on the command line of your screen, as follows: CEMT Press the ENTER key. CICS displays the following:
STATUS: ENTER ONE OF THE FOLLOWING Inquire Perform Set
2. If you want to inquire about a resource, enter INQUIRE (or a suitable abbreviation) on the command line. If you want to perform a function that is not concerned with resource status, enter PERFORM (or a suitable abbreviation) on the command line. The only function available in CICS is PERFORM SNAP. If you want to set, or change, the value of a resource, enter SET (or a suitable abbreviation) on the command line.
323
CEMT
Entering any of the three keywords cause CICS to display a screen detailing the options available with the command. Each option is displayed with its minimum permitted abbreviation in uppercase characters and the remainder in lowercase. For example, if you enter INQ, you get the following screen:
I STATUS:
ENTER ONE OF THE FOLLOWING OR HIT ENTER FOR SYSTEM PARAMETERS
AUTInstmode TClass AUXtrace TRACe DUMP TRANsaction DUMPOptions FEConnection FENode FEPOol FEPRopset FETarget FIle TDqueue TErminal Netname Program TAsk APPLID=region7 PF 1 HELP 3 END 9 MSG
Figure 1. CEMT INQ
You can inquire upon any of the displayed options by typing its keyword after INQ on the command line. For example,
CEMT INQ PROGRAM
tells you the name of each program, what language it is written in, and whether it is enabled or disabled. System parameters The CICS system parameters are a subset of the attributes that are dened in the Region Denitions (RD). You can use CEMT to nd out the values of these parameters. For further information, see Inquiring upon CICS system parameters using CEMT on page 355. See the CICS Administration Guide for information about the CICS resource level security checking mechanism.
Using the CEMT screen

The CEMT screen contains three distinct areas. These are: v Command Input (the rst line of the screen)
324
CEMT
v Information (19 lines on a 24 x 80 screen) v PF Key Values (the last line of the screen). Command input This is the rst line of the screen. You use this line to enter any of the CEMT commands described in Concepts of Inquire and Set Operations on page 328 and CEMT PERFORM SNAP on page 330, for example:
INQ FILE(*)
Information This is the main area of the screen between the command input area at the top and PF key values at the bottom of the screen. CICS uses this area to display options that you can use in the current command context, or information that you have requested about a set of resources. Program function (PF) key values The following list explains the meanings of the program function (PF) keys, which appear on the bottom line of the CEMT screen. If your keyboard does not have PF keys, you can position the cursor under the required instruction on the screen using the tab keys, and press the ENTER key. PF1 PF3 displays help. exits from CEMT, so requests that CICS terminates your CEMT transaction and ends the session. However, if you use this key when modifying your screen, for example, by keying in a new command, or by overtyping an old command, CICS ignores the request and does not end your session. scrolls back half a page. scrolls forward half a page. expands messages. If CICS generates more than one message in response to your request, CICS displays a message near the bottom of the screen telling you how many messages have been generated. The PF9 key allows you to display all the messages on a separate screen. To go back to your original screen, press the ENTER key. scrolls back a whole page. scrolls forward a whole page.
PF7 PF8 PF9
PF10 PF11
325
CEMT
Scrolling symbol (+ sign) A plus (+) sign on the rst or last line of a screen tells you that there is more data preceding or following the current screen. Scrolling backward reveals data above, and scrolling forward reveals data below. All parameter Many of the request formats contain the ALL parameter. For INQ this is a default which CEMT assumes if you do not specify an alternative. For example: INQ TERMINAL shows the attributes of all terminals (default is ALL). INQ TERMINAL ALL shows the attributes of all terminals. SET TERMINAL PRI(4) is an invalid command (default is not ALL). SET TERMINAL ALL PRI(4) sets the priority of all terminals to 4. Family of resources (using asterisk and plus symbols) You can use the symbols asterisk (*) and plus (+) as part of an identier to specify a family of resources. * represents any number of characters (including none), and + represents a single character. For example: v A* species all identiers beginning with A. v TERM00+ species all seven-character identiers beginning with TERM00. Subdening resource groups When you make an inquiry, you can subdene a resource group by specifying one or more attributes of the group, for example:
INQ TERMINAL ALL INSERVICE
displays the status of all terminals that are in service. You cannot subdene a resource group by specifying the attributes of a group by using SET. For example:
SET TERMINAL ALL INSERVICE PRIORITY(4)
puts all terminals in service and sets the priority to 4. However, you can manage such groups of resources by specifying INQ, and modifying the screen produced.
326
CEMT
Inquiry When you make an inquiry, you get a screen that consists of at least one line of status information for each resource in the specied group. CICS displays the status information as a list of abbreviated keywords. Overtyping You can move the cursor to any alterable eld in a line and change its contents by overtyping. When you press the ENTER key again, CICS reads the contents of all elds that you have changed, and performs any valid operations implied by the changes. If you make an invalid change, CICS displays an error message and does not change the eld. The values for each eld are not case sensitive, so you can overtype elds with lowercase or uppercase characters. CEMT accepts an abbreviation in elds that allow only certain values, such as the READABLE and NOTREADABLE eld. Examples: 1. If you overtype the READABLE and NOTREADABLE eld with the character R (in uppercase or lowercase) followed by any other character (or no character at all), CEMT allocates the value READABLE to the eld. 2. If you overtype the READABLE and NOTREADABLE eld with the character N (in uppercase or lowercase) followed by any other character (or no character at all), CEMT allocates the value NOTREADABLE to the eld. 3. If you overtype the ON and OFF eld with the characters OF (in uppercase or lowercase), CEMT allocates the value OFF to the eld. If the eld allows the values "value" and "NOTvalue" and you overtype the eld with spaces, CEMT allocates the default value to the eld. If the original value of the eld is "NOTvalue", CEMT displays the eld as a blank eld. For example, if you overtype the READABLE and NOTREADABLE eld with spaces, CEMT allocates the value NOTREADABLE to the eld. Whenever you overtype a screen, CICS takes that particular action and also refreshes all the status information. You can avoid the associated overheads either by using the SET command, or by limiting your inquiry to a specic number of resources.
327
CEMT
Tab key The elds you can change are different in each screen, but you can detect them by pressing the Tab key repeatedly. This moves the cursor from one eld to the next, and you can then overtype the eld with the appropriate information. Although you can move to the PF key elds at the bottom of the screen by pressing the Tab key, overtyping these elds has no effect. If you press the Enter key when you are in one of these elds, the result is the action of that PF key. Blank elds Some screens contain blank elds that allow you to specify parameters, such as NEWCOPY and PURGE, that are not part of the status of a resource. A status, such as NOREAD, that begins with NO is also represented by a blank eld. You can use the Tab key to detect these elds.
Concepts of Inquire and Set Operations

You can use the CEMT transaction to inquire upon (INQ), or set (SET) the status of a resource (such as a terminal), a group of resources (such as a class of terminals), or a list of resources. For INQUIRE, CICS displays the status of specied resources. For SET, CICS makes the changes specied and displays the new status of the resources. However, CICS does not make the change if it nds any error in the syntax of the command. For INQUIRE, you use the syntax to specify which resources to inquire upon, for example, to inquire upon all les that are remote and enabled, you type: CEMT INQUIRE FILE REMOTE ENABLED The CEMT screen displays each le that is remote and enabled, together with all the attributes (the status) of those les. The attributes are set in the region denitions for the resource that you are enquiring upon, so in this example, the File Denitions (FD). CICS displays the status of the resource in the order shown in the syntax for each resource. If an attribute is one of several options, the valid option for that resource is displayed, with the valid options for any other attributes, as a list across the screen, using the rst three letters of each option. If a parameter requires a value, for example an index name, CICS displays each parameter and its value on a separate line. For example, the command INQ FILE(le1) produces a screen with the following layout:
328
CEMT
STATUS: RESULTS - OVERTYPE TO MODIFY fil(file1 ) Sfs Clo Ena Rea Upd Add Bro Del bas( sfs2 ) idx( index2 ) fsc( /.:/cics/sfs/server1 )
Figure 2. CEMT status screen
For SET, you must specify a resource identier as an argument, a generic argument, or ALL. ALL is not a default. For example: SET TERMINAL INSERVICE produces an error because there is no resource identier. SET TERMINAL(TRM1) INSERVICE sets TRM1 in service. SET TERMINAL(TRM*) INSERVICE sets all terminals in service whose identiers start with TRM. SET TERMINAL ALL INSERVICE sets all terminals in service. You can specify a list of resource identiers, rather than a single one. Separate the items in the list by blanks. If you do not specify a parameter, for example, inservice, the resource takes the default attributes that have been set in the region denitions for that resource. In the preceding example, this is the Terminal Denitions (WD).
329
CEMT PERFORM SNAP CEMT PERFORM SNAP

To obtain a dump and continue running CICS. Syntax
CEMT PERFORM SNAP [DUMP]
Options DUMP species that CICS produce a dump. DUMP is the default, so you do not have to specify this parameter. To obtain a dump and continue running CICS, use the PERFORM SNAP command. In effect, you obtain a snapshot of the CICS region. CICS always returns a response code 0 (NORMAL), whether or not the dump is successful. Note: The use of CEMT PERFORM SNAP prevents all other tasks from running, so other terminal users can experience long delays in response. On CICS for AIX only: A CICS SNAP DUMP cannot be taken when the IBM Application Debugging Program is active. If you do take a dump with IBM Application Debugging Program switched on, the dump does not complete. To turn the IBM Application Debugging Program on and off, use Application Diagnosis Conguration (CDCN).
330
CEMT INQ/SET AUTOINSTALL CEMT INQ/SET AUTOINSTALL

To inquire upon and set the name of the terminal autoinstall program. Syntax
CEMT {INQ | SET} AUTOINSTALL [PROGRAM(programName)]
Options PROGRAM(programName) is used to specify the name of the autoinstall user program. A default program is supplied. You use this transaction to inquire upon and set the name of the terminal autoinstall program. For guidance information about the automatic installation of terminals (autoinstall), see Terminal autoinstall user program on page 390. Examples To set the name of the autoinstall program to AUTOINST:
CEMT SET AUTOINSTALL PROGRAM(AUTOINST)
331
CEMT INQ/SET AUXTRACE CEMT INQ/SET AUXTRACE

To inquire upon and set whether auxiliary trace is on or off, and which auxiliary trace le is active. Syntax
CEMT {INQ | SET} AUXTRACE CEMT SET AUXTRACE {ON | OFF | SWITCH}
Options OFF stops recording entries in the auxiliary trace le and closes the le. ON opens the auxiliary trace le if it was not previously opened, and starts recording entries in that le. CICS does not record auxiliary trace entries, however, unless internal trace is active at the same time. In this way, you can control auxiliary tracing by activating and deactivating internal trace. SWITCH closes the current auxiliary trace le, then opens the alternate trace le. The status of auxiliary trace (on or off) remains as it was before the switch request, unless the second le cannot be opened. If the second le cannot be opened, CICS turns off auxiliary trace. CICS writes trace entries to the auxiliary trace le if both internal tracing and auxiliary tracing are in effect. Internal tracing can be started and stopped using the CEMT SET TRACE command. This transaction allows you to inquire whether auxiliary tracing is on or off, set auxiliary tracing on or off, and inquire which auxiliary trace le is active. See the CICS Application Programming Guide for related information.
332
CEMT INQ/SET DUMP CEMT INQ/SET DUMP

To inquire upon and set the system dump ag. Syntax
CEMT {INQ | SET} DUMP CEMT SET DUMP {ON | OFF}
Options OFF sets the system dump ag off. ON sets the system dump ag on. This transaction allows you to inquire upon and set the system dump ag. This ag controls whether a system dump is produced or suppressed. The default setting is obtained from the SysDump attribute in the Region Denitions (RD). Examples To set the system dump ag on:
CEMT SET DUMP ON
See the CICS Application Programming Guide for related information.
333
CEMT INQ/SET DUMPOPTIONS CEMT INQ/SET DUMPOPTIONS

To inquire upon and set whether a system dump is required following an abnormal termination with code ASRA or ASRB. Syntax
CEMT {INQ | SET} DUMPOPTIONS [PCDUMP | NOPCDUMP] [ABDUMP | NOABDUMP]
Options ABDUMP selects a CICS system dump if a transaction abnormally terminates with code ASRB (system call abnormal termination). This is the default. NOABDUMP selects no CICS system dump for ASRB transaction abnormal terminations. A transaction dump might still be produced, depending on the TransDump attribute in the Transaction Denitions (TD). NOPCDUMP selects no CICS system dump if a transaction abnormally terminates with code ASRA (signal or exception). A transaction dump might still be produced, depending on the TransDump attribute in the Transaction Denitions (TD). PCDUMP selects a CICS system dump for ASRA transaction abnormal terminations. This is the default. This command allows you to select whether a system dump is required in some situations. This command updates the ABDump, or PCDump attributes, or both, in the runtime Region Denitions (RD). PCDump and ABDump take effect only if the system dump ag is set to yes in the runtime RD. The system dump ag is the SysDump attribute in the RD. Examples To request a CICS system dump if a transaction abnormally terminates with code ASRB, but no CICS system dump if a transaction abnormally terminates with code ASRA:
CEMT SET DUMPOPTIONS ABDUMP NOPCDUMP
See the CICS Application Programming Guide for related information.
334
CEMT INQ/SET FILE CEMT INQ/SET FILE

To inquire upon and set certain le attributes in the runtime database. Syntax
CEMT {INQ | SET} FILE[(fileName)] [ALL] [OPEN | CLOSED] [ENABLED | DISABLED] [READ | NOREAD] [UPDATE | NOUPDATE] [ADD | NOADD] [BROWSE | NOBROWSE] [DELETE | NODELETE] [BASENAME(baseName)] [INDEXNAME(indexName)] [FILESERVER(serverName)]
CEMT INQ FILE[(leName)] [SFS | REMOTE ] [UNENABLED] where: Options ADD means records can be added to the le. BASENAME (baseName) species the Structured File Server Denitions (SSD) name for the le. BROWSE means records in the le can be browsed. CLOSED means the le is closed; the access method does not allow accesses to the data until the le is opened. The le may be opened either explicitly by you, or, if the le has the ENABLED attribute, implicitly by CICS on the next reference to the data. When used with SET, the le is closed and also disabled. (The le is disabled to prevent access requests from implicitly opening the le again.) The close is effected at the time of the command only if there are no tasks currently accessing the le. If there are current users, the screen indicates CLOSE requested. This means that when the last user completes his use of the le, it effects the close. Note that a le that has been disabled by means of a SET CLOSED command becomes enabled again by a subsequent SET OPEN command. To distinguish between a le that is disabled in this way from one that is disabled by means of a SET DISABLED command, CICS displays the former with the UNENABLED attribute.
335
CEMT INQ/SET FILE

A le with the DISABLED attribute can be enabled only by a SET ENABLED command. A le with the UNENABLED attribute can be enabled by a SET ENABLED command or SET OPEN command. DELETE means records can be deleted from the le. DISABLED means the le is not available for use by applications except for those which are currently using it. If there are any such users, CICS also displays DISABLING. When used with SET, this command has no effect on existing users; it simply prevents new users accessing the le. The le can be re-enabled by SET ENABLED. (See UNENABLED.) ENABLED means the le is available for use by applications and, if closed, it is opened in the rst request. FILESERVER (serverName) species the name of the Structured File Server (SFS) le system where this le resides. INDEXNAME (indexName) species the name of the SFS index associated with the path to the le. NOADD means records cannot be added to the le. NOBROWSE means records in the le cannot be browsed. NODELETE means records cannot be deleted from the le. NOREAD means records in the le cannot be read. NOUPDATE means records in the le cannot be updated. OPEN means the le is open. If the le is OPEN ENABLED it is available for data accesses by CICS transactions. If it is OPEN DISABLED, it must rst be enabled before it is available. When used with SET, if the le is disabled only implicitly by a previous SET CLOSED command as opposed to explicitly by SET DISABLED, the SET OPEN re-enables the le implicitly. READ means records in the le can be read.
336
CEMT INQ/SET FILE

REMOTE means the le is dened as remote. You cannot use CEMT SET for remote les. SFS means the le is owned by the Structured File Server (SFS). UNENABLED means the le is not available for use by applications except for those which are currently using it. If there are applications using the le, CICS also displays DISABLING. The UNENABLED status is the same as DISABLED. The difference is that the le status becomes UNENABLED implicitly when a SET CLOSE is requested, and a SET OPEN request implicitly sets the status to ENABLED. UPDATE records in the le can be updated. This command allows you to inquire upon and set certain le attributes in the runtime database. Unless the leName contains the special * and + characters, it must be dened in the File Denitions (FD). The syntax shows the order in which the parameters are displayed after an INQUIRE command. See Concepts of Inquire and Set Operations on page 328 for an example of the screen layout. After a SET command, the parameters requiring a name are displayed before the parameters that are one of a set of options. If a le is UPDATABLE or BROWSABLE, it is implicitly readable.For example: v If you set the le to NOTREADABLE when it is either UPDATABLEor BROWSABLE, the response is NORMAL but the le remains READABLE. v If you set a le to UPDATABLE or BROWSABLE when it is NOTREADABLE, it implicitly becomes READABLE. v If you set a le to both NOTUPDATABLE and NOTBROWSABLE,it does not implicitly become NOTREADABLE. Examples 1. To inquire upon all SFS les with read and update permission:
CEMT INQUIRE FILE SFS READ UPDATE
2. To set le FILE1 to have read and write permission, but no update permission:
CEMT SET FILE(FILE1) READ ADD NOUPDATE
337
CEMT INQ/SET JOURNAL CEMT INQ/SET JOURNAL

To inquire upon and set whether a journal is open for output or closed. Options
CEMT {INQ|SET} JOURNAL[(journalNumber)] [ALL] CEMT SET JOURNAL[(journalNumber)] [OUTPUT | CLOSED | SWITCH] CEMT INQ JOURNAL[(journalNumber)] [DATASET(suffix)]
Options journalNumber is the journal number. This number can be in the range 1 to 99. CLOSED closes the journal. The journal can now be read by an offline program. DATASET(suffix) shows the status of the disk le associated with the journal. suffix can be A or B, and species the disk le DISKA or DISKB. The status can be CURRENT, showing that the specied disk le is currently active, or READY, showing that the specied disk le is not active. OUTPUT opens the journal for output. The journal must be closed before it can be read by an offline program. SWITCH switches between the two disk les, DISKA or DISKB, associated with each journal. This transaction allows you to inquire upon and set whether the journal can be read by an offline program. You can switch a journal between disk les, so it remains available to CICS, but its contents are moved offline for further processing, for example, archiving or deleting. Examples 1. To inquire about the status of all journals:
CEMT INQUIRE JOURNAL ALL
2. To close journal 21:

CEMT SET JOURNAL(21) CLOSED
338
CEMT INQ/SET MONITOR CEMT INQ/SET MONITOR

To inquire upon and set whether performance monitoring is on or off. Syntax
CEMT {INQ|SET} MONITOR CEMT SET MONITOR {ON | OFF}
Options OFF switches monitoring off. ON switches monitoring on. Examples To switch performance monitoring off:
CEMT SET MONITOR OFF
This transaction allows you to inquire upon and set whether performance monitoring is on or off. See the CICS Administration Guide for related information.
339
CEMT INQ/SET NETNAME CEMT INQ/SET NETNAME

To inquire upon certain network name attributes. Syntax
CEMT INQ NETNAME(netName) [TERMINAL(termId)] [TRANSACTION(transId)] [PRIORITY(value)] [INSERVICE | OUTSERVICE] [ATI | NOATI] [TTI | NOTTI]
Options netName is the name by which a terminal is known to the network. Wildcards are not accepted for this command. The remaining parameters are identical to those for INQ TERMINAL. ATI means the terminal is available for use by transactions that are initiated automatically from within CICS. INSERVICE means the terminal is available for use. NOATI means the terminal is not available for use by transactions that are initiated automatically from within CICS. You cannot specify both NOATI and NOTTI. NOTTI means the terminal is not available for use by transactions that are initiated from this terminal. You cannot specify both NOTTI and NOATI. OUTSERVICE means the terminal is not available for use. PRIORITY(value) is the priority of a terminal relative to other terminals. The priority of a task is the sum of the transaction priority, the terminal priority, and the user priority. The value is in the range from 0 to 255, where 255 is the highest priority. TERMINAL(termId) is the name by which the terminal is dened in the Terminal Denitions (WD). TRANSACTION(transId) is the name of the transaction currently running with this terminal as its principal facility.
340
CEMT INQ/SET NETNAME

TTI means the terminal is available for use by transactions that are initiated from this terminal. This transaction allows you to inquire upon and set certain attributes relating to network names. If you are familiar with network names, you may prefer to use this command as an alternative to CEMT INQ SET TERMINAL on page 351. Examples To inquire upon the terminal whose network name is NET16 whether it is available for use by transactions initiated from the terminal:
CEMT INQUIRE NETNAME(NET16)
If the response screen shows TTI, the terminal is available for use by transactions initiated from the terminal.
341
CEMT INQ/SET PROGRAM CEMT INQ/SET PROGRAM

To inquire upon and set certain program and map attributes in the runtime database. Syntax
CEMT {INQ | SET} PROGRAM[(programName)] [ALL] [ENABLED | DISABLED] CEMT INQ PROGRAM[(programName)] {COBOL | C} CEMT SET PROGRAM[(programName)] NEWCOPY
Options where: C means the program is written in C.
COBOL means the program is written in COBOL. DISABLED means the program is not available for use. You cannot disable programs whose names begin with DFH, because these are reserved for use by CICS. ENABLED means the program is available for use. NEWCOPY allows you to get an updated version of a program or a map, or to restore a map that has been overwritten in main storage. When NEWCOPY is not used, CICS will only recognize new versions of programs when they are not in a program cache or in Micro Focus COBOL runtime memory. If this is the case, use NEWCOPY to get the updated version. The loading of Micro Focus COBOL programs is controlled by the environment variable COBSW. The new version of the program may not be available immediately after NEWCOPY is issued: v In the case of a C program, the new version will not be loaded while the version in the application servers C program cache is still being used. v In the case of a COBOL program, the new version will not be loaded while any COBOL application programs are still being used, as the COBOL runtime must be reloaded to remove the old version of the program. Reloading the runtime will then cause all COBOL programs to be refreshed.
342
CEMT INQ/SET PROGRAM

Examples 1. To inquire upon all disabled programs:
CEMT INQUIRE PROGRAM DISABLED
2. To enable program PROG1:

CEMT SET PROGRAM(PROG1) ENABLED
343
CEMT INQ/SET TASK CEMT INQ/SET TASK

To inquire upon and set runtime task attributes. Options
CEMT INQ TASK[(taskNumber)] [TCLASS() | ALL] [TRANID(transId)] [FACILITY(facilityId)] [RUNNING | DISPATCHABLE | SUSPENDED] [INFLIGHT | INDOUBT | WAITFORGET] [TASK | TERM | DEST] [USERID(userId)] [PROCESSID(processId)] CEMT SET TASK[(taskNumber)] {PURGE | FORCEPURGE}
Options taskNumber is the CICS-generated task number. You cannot use an asterisk (*), or a plus sign (+). If you do not specify a task number, the command applies to all tasks.You cannot display or change system task attributes. System tasks are those tasks started (and used internally) by CICS, not as a result of a user transaction. DEST means the task has been initiated by a transient data queue trigger level. DISPATCHABLE means the task is ready to run. FACILITY(facilityId) returns a four-character string representing the name of the facility associated with the named task. If the task was initiated from a terminal (FACILITYTYPE of TERM), FACILITY returns the name of the terminal. If the task was initiated by a destination trigger level as dened in the Transient Data Denitions (TDD) (FACILITYTYPE of DEST), FACILITY returns the name of the associated transient data queue. Otherwise, a null value (blanks) is returned. INDOUBT means that the task is in the in doubt state during syncpoint processing. INFLIGHT means that CICS has initiated the task, but no attempt has yet been made to commit any changes that may have been made to recoverable resources during the current unit of work. PROCESSID(processId) the process id of the process running the transaction associated with the task. PURGE | FORCEPURGE means CICS abnormally terminates the task:
344
CEMT INQ/SET TASK

PURGE species that the task is to be abnormally terminated, but only when CICS can maintain system and data integrity. A task is not purged if its associated Transaction Denitions (TD) entry has the notpurgeable. FORCEPURGE species that the task is to be abnormally terminated immediately. If a task has already been marked for FORCEPURGE, a further FORCEPURGE request for the task will be rejected. As the use of FORCEPURGE can lead to unpredictable results, it should only be used in exceptional conditions. We do not recommend the use of FORCEPURGE because it could cause the region to terminate, rather than the task, depending upon what the chosen task is doing. A task running in an XA-registered CICS application server cannot be force purged since this would cause an XA error from the database and would result in a region abend. If it is essential to do so, a transaction could be purged at the database end with the risk of an error causing a region abend. When a task is marked for PURGE or FORCEPURGE, CICS checks for these during processing of EXEC CICS commands on behalf of the user program. When the check indicates that the task is to be purged or forcepurged, abnormal task termination is triggered. ENQ locks issued by the task will be released; resources such as terminals, queues, and les locked for use by the task will be released; outstanding Logical Unit of Work will be backed out; and recoverable ATI requests will be requeued. If the user program keeps control without issuing any EXEC CICS commands, for example, if the program is looping, then the check for PURGE or FORCEPURGE cannot be made and the PURGE request will have no effect. Similarly, if the user program is waiting for a resource within the execution of an EXEC CICS command the check for PURGE will not occur until the resource is released. If this does not occur, the PURGE request will have no effect. If FORCEPURGE was requested, then, if after giving the task an opportunity to be checked for this attribute and CICS was unable to do this (possibly for one of the above reasons), CICS will force abnormal termination of the task. CICS may be able to terminate the task tidily, or may need to terminate the application server, or may cause region abnormal termination, depending on what the task was doing at the time of the request. RUNNING means the task is running.
345
CEMT INQ/SET TASK

SUSPENDED is only included for consistency with other CICS family members. If you specify INQ TASK SUSPENDED, CICS displays a zero length list. TASK means the task has been initiated from another task. TCLASS(classId) identies the task class to which the task belongs. TERM means the task has been initiated from a terminal. TRANID(transId) is the transaction name of the task. USERID(userId) is the name of the user who initiated the task. WAITFORGET means that the task is in the wait forget state during syncpoint processing. Examples To inquire upon all INDOUBT tasks:
CEMT INQUIRE TASK INDOUBT
See the CICS Intercommunication Guide for related information.
346
CEMT INQ/SET TCLASS CEMT INQ/SET TCLASS

To inquire upon and set runtime task class attributes. Syntax
CEMT {INQ|SET} TCLASS[(classId)] [ALL] [MINSERVERS(numServers)] [MAXSERVERS(numServers)]
Options classId identies the class to which the task belongs. In CICS on Open Systems or CICS for Windows NT, this value can only be 1.If you specify the special characters + or *, the value is set to 1. MAXSERVERS (numServers) is the maximum number of application servers permitted to implement tasks for the classId specied in TCLASS. MINSERVERS (numServers) is the minimum number of application servers required to implement tasks for the classId specied in TCLASS. Note: If you increase MAXSERVERS to a number greater than the number of actual application servers running, the extra servers will be started automatically. Similarly, if you decrease MINSERVERS below the actual number running, the extra servers will be stopped. Examples 1. To inquire upon all runtime task classes with a maximum number of servers set at 10:
CEMT INQ TCLASS MAXSERVERS(10)
2. To set the maximum number of servers for class 1 to 15:

CEMT SET TCLASS(1) MAXSERVERS(15)
347
CEMT INQ/SET TDQUEUE CEMT INQ/SET TDQUEUE

To inquire upon and set certain transient data queue attributes in the runtime database. Syntax
CEMT {INQ | SET} TDQUEUE[(TDQname)] [ALL] [TRIGGERLEVEL(number)] [ENABLED | DISABLED] [OPEN | CLOSED] CEMT INQ TDQUEUE[(TDQname)] [NAMEIND(indirectTDQname) [INDIRECT | EXTRA | INTRA | REMOTE] [TRANID(transId)] [TERMID(termId)]
Options TDQname is a four-character name dened in the TDD. On a SET, the destId cannot relate to a REMOTE or INDIRECT queue. CLOSED means the TD queue is closed. The access method does not allow accesses to the data until the queue is opened. The queue must be opened explicitly by you using CEMT. When used with SET, the queue is closed and also disabled. (The queue is disabled to prevent access requests from implicitly opening the queue again.) The close occurs at the time of the command only if there are no tasks currently accessing the queue. If there are current users, the screen shows CLOSING. This means that when the last user no longer requires the queue, CEMT effects the close. DISABLED means the queue is not available for use by applications except for those that are already using it. If there are any such users, CICS also displays DISABLING. When used with SET, this command has no effect on existing users, but it prevents new users accessing the queue. The queue can be re-enabled by SET ENABLED. ENABLED means the queue is available for use by applications and, if closed, it is opened in the rst request. EXTRA means the queue is dened as extrapartition. Note: The term extrapartition transient data is used to describe a CICS facility that temporarily saves data in the form of queues, called destinations. Extrapartition destinations are used for data that is
348
CEMT INQ/SET TDQUEUE

either coming from a source outside the region, or is being directed from a source within the region to a destination outside the region. INDIRECT means the queue is dened as indirect. INTRA means the queue is dened as intrapartition. Note: The term intrapartition transient data is used to describe a CICS facility that temporarily saves data in the form of queues, called destinations. Data is written to the queue by a user task and can be subsequently used as input data by other tasks with the region. NAMEIND(indirectTDQname) is available only for indirect queues. The indirectTDQname is the name of the queue for which the specied TDQname is an indirect name. OPEN indicates that the queue is open. If the queue is OPEN ENABLED, it is available for data accesses by CICS transactions. If it is OPEN DISABLED, it must rst be enabled before it is available. If you use the SET command when the queue is disabled implicitly by a previous SET CLOSED operation, as opposed to disabled explicitly by SET DISABLED, the SET OPEN enables the queue again implicitly. REMOTE means the queue is dened as remote. TERMID(termId) is available only for intrapartition queues. The dest is the name of the terminal to be associated with the queue when automatic transaction initiation (ATI) occurs. TRANID(transId) is available only for intrapartition queues. The transId is the name of the transaction that is to be initiated automatically when the queue trigger level is reached. TRIGGERLEVEL(number) is available only for intrapartition queues. The number is the number of requests for output to the queue that there must be before ATI occurs. This value must be in the range from 0 to 32767. This command allows you to inquire upon and set certain transient data queue attributes in the runtime database. Unless the TDQname contains the special * and + characters, it must be dened in the Transient Data Denitions (TDD).
349
CEMT INQ/SET TDQUEUE

Examples 1. To inquire upon all enabled extrapartition queues:
CEMT INQUIRE TDQUEUE ENABLED EXTRA
2. To disable and close queue Q1:

CEMT SET TDQUEUE(Q1) CLOSED DISABLED
350
CEMT INQ SET TERMINAL CEMT INQ SET TERMINAL

To inquire upon and set runtime terminal attributes. Options
CEMT {INQ | SET} TERMINAL[(termId)] [ALL] [PRIORITY(value)] [INSERVICE | OUTSERVICE] [ATI | NOATI] [TTI | NOTTI] CEMT INQ TERMINAL[(termId)] [NETNAME(netName)] [TRANSACTION(transId)] CEMT SET TERMINAL[(termId)] PURGE
If you are familiar with network names, you may prefer to use CEMT INQ/SET NETNAME on page 340, which uses these names. Options termId is the four-character identier. ATI means the terminal is available for use by transactions that are initiated automatically from within CICS. INSERVICE means the terminal is available for use. NETNAME(netName) is the name by which the terminal is known to the network. NOATI means the terminal is not available for use by transactions that are initiated automatically from within CICS. You cannot specify both NOATI and NOTTI. NOTTI means the terminal is not available for use by transactions that are initiated from this terminal. You cannot specify both NOTTI and NOATI. OUTSERVICE means the terminal is not available for use. If you set a terminal to OUTSERVICE, transactions can no longer use the terminal and CICS releases the terminal and signs the user off, either immediately or when the current transaction terminates. If you also specify PURGE, CICS abnormally terminates any transaction using the terminal. If you do not specify PURGE, CICS allows the transaction to terminate normally, but does not allow further transactions to use the terminal.
351
CEMT INQ SET TERMINAL

PRIORITY(value) is the priority of a terminal relative to other terminals. The priority of a task is the sum of the transaction priority, the terminal priority, and the operator priority. The value must be in the range from 0 to 255, where 255 is the highest priority. PURGE means CICS abnormally terminates the task, but only when CICS can maintain system integrity, data integrity, or both. TRANSACTION(transId) is the name of the transaction currently running with this terminal as its principal facility. TTI means the terminal is available for use by transactions that are initiated from this terminal. Examples 1. To inquire upon all terminals that are available for use by transactions initiated from the terminal:
CEMT INQUIRE TERMINAL TTI
2. To set the terminal named TRM6 out of service, and abnormally terminate any transactions currently using the terminal:
CEMT SET TERMINAL(TRM6) OUTSERVICE PURGE
This transaction allows you to inquire upon and set runtime terminal attributes. Unless the termId contains the special * and + characters, it must be dened in the Transaction Denitions (TD).
352
CEMT INQ/SET TRACE CEMT INQ/SET TRACE

To inquire upon and set whether the trace facility is on or off. Syntax
CEMT {INQ|SET} TRACE CEMT SET TRACE {ON | OFF}
Options OFF switches trace off. ON switches trace on. Note: You must set this facility ON if you want to use auxiliary trace. Examples To switch trace off:
CEMT SET TRACE OFF
353
CEMT INQ/SET TRANSACTION CEMT INQ/SET TRANSACTION

To inquire upon and set runtime transaction attributes. Syntax
CEMT {INQ | SET} TRANSACTION[(transId)] [ALL] [PRIORITY(value)] [ENABLED | DISABLED]
Options where: transId is the four-character transaction identier. DISABLED means the transaction is not available for use. You cannot disable transactions that have identiers beginning with C because these are reserved for use by CICS. ENABLED means the transaction is available for use. PRIORITY (value) is the priority of a transaction relative to other transactions. When a transaction is running as a CICS task, the priority of a task is the sum of the transaction priority, the terminal priority, and the operator priority. The value must be in the range from 0 to 255, where 255 is the highest priority. Note: Unless the transId contains the special * and + characters, it must be dened in the Transaction Denitions (TD). Examples 1. To inquire upon all disabled transactions:
CEMT INQUIRE TRANSACTION DISABLED
2. To enable transaction TRN1:

CEMT SET TRANSACTION(TRN1) ENABLED
354
Inquiring upon CICS system parameters using CEMT Inquiring upon CICS system parameters using CEMT
To inquire upon CICS runtime system parameters. Syntax
CEMT INQUIRE
Description To inquire upon CICS runtime system parameters, type CEMT INQ. When the panel shown in Figure 1 on page 324 is displayed press ENTER again to display the system parameters. The meaning of these parameters is as follows: Options AKP is how often CICS writes checkpoint records. The value is the cumulative number of writes to the log made across all CICS application servers in the region. APPLID is the eight-character name that identies the CICS region uniquely across all CICS regions. DATEFORM is the date format used by the EXEC CICS FORMATTIME command. The three possible values are: mmddyy is the date in the form month-day-year. ddmmyy is the date in the form day-month-year. yymmdd is the date in the form year-month-day. INTROINTVL is the number of minutes between invocations of the CICS private transaction that checks the integrity of the region. LOCALE is the value of the region-wide locale. Note: The term locale is used to refer to a subset of a users environment that denes conventions for a specied culture, such as time formatting, numeric formatting, monetary formatting, and character classication, conversion, and collation. Refer to your operating system documentation for more information about locales and how they are used.
355
Inquiring upon CICS system parameters using CEMT

MAXREGIONPOOL is the maximum region pool size, in bytes, required by CICS. MAXTASKSHPOOL is the maximum task shared pool size, in bytes, required by CICS. MAXSERVERS (numServers) is the maximum number of application servers permitted to implement tasks for the classId specied in TCLASS. MINSERVERS (numServers) is the minimum number of application servers required to implement tasks for the classId specied in TCLASS. OPREL is the operating system release number. OPSYS is a one-character abbreviation of the operating system. CICS returns the following values: A AIX
H HP/UX L Sun Solaris
N Windows NT REGIONTHRESH is when CICS should report that it is running out of Region Pool storage. The threshold is a percentage value of the total allocation. RELEASE is the CICS release level. For example, the value 0210 indicates version 2, release 1, modication level 0. SYSID is the four-character CICS region identier. TASKSHTHRESH is when CICS should report that it is running out of Task Pool storage. The threshold is a percentage value of the total allocation. You can view, but not modify, CICS runtime system parameters. Type CEMT INQ (without a keyword), press the ENTER key twice, and follow the screen prompts. CICS displays a screen showing a subset of the system parameters, dened and managed using the CICS resource denition online (RDO) facility.
356
CESF and CSSF CESF (Signoff) and CSSF (Signoff)

To sign off from the CICS local or remote CICS region. Note: You can use either CESF or CSSF. They are the same transaction. CSSF is an early version of the transaction retained for compatibility.
Syntax
CSSF [EXIT | GOODNIGHT] CESF [EXIT | GOODNIGHT]
Description
When you run CESF or CSSF the following occurs: v If you are attached to a local region (not as a part of a transaction routing session), the connection between you and CICS is broken and a signoff message is written to the terminal. v If you are attached to a remote region through the CICS 3270 Terminal Emulator, cicsterm, you are returned to the parent process. v If you are attached to a remote region through transaction routing (CRTE), you remain attached to the remote region, but your userid becomes the default user of the remote region. (Refer to CRTE (Routing Transaction) on page 364). v If you used CESN to change your userid on the local region, the connection between you and CICS is broken, but you remain logged in to the same DCE userid as you were in before entering CICS. Note: The TSLKey should not be changed in the Transaction Denitions (TD) entries for either CESF or the CSSF as they should always have public access. Starting and ending CESF and CSSF: You start the CESF or CSSF transaction directly by entering the tranid CESF or CSSF. The transaction ends when you are logged off.
Options
EXIT causes CICS to sign you off the terminal, but does not set the terminal out of service. This is the default option. GOODNIGHT causes CICS to sign you off the terminal and sets the terminal out of service (disabled) and unavailable for further CICS use. This option is ignored when the terminal is remote or when the terminal is
357
CESF and CSSF

autoinstalled. Use the GOODNIGHT option when you dont want the terminal used until it is put back in service.
Examples
v To sign off and leave the terminal in service:
CSSF
v To sign off and set the terminal out of service (for local terminals that are not autoinstalled):
CSSF GOODNIGHT
See the CICS Intercommunication Guide for related information.
358
CESN CESN (Signon) Syntax

CESN
Description
CESN is the CICS signon transaction. When you use the CESN transaction, the following is displayed:
CESN - CICS SIGNON APPLID applId Type your userid and password, then press ENTER: Userid . . . . ________ Password . . . ________ New Password . . . ________ Please type your userid. F3=Exit
When you see this screen: 1. Enter a userid. If you are using DCE authentication, CICS establishes a corresponding DCE principal from this userid. If a User Denitions (UD) entry exists for this userid, the DCE principal is specied in the UD entry with the Principal attribute. If no UD entry corresponds to this userid, or if no value is specied with the Principal attribute of the UD entry, then the userid is passed to DCE as the DCE principal. If you are not using DCE authentication, the userid and password must match those stored in a User Denition. 2. Enter the password corresponding to the DCE principal established in Step 1. The password cannot be more than eight characters, nor can it be all blanks or spaces. 3. (optional) Enter a new password to replace the one entered in Step 2. You will be prompted to enter the new password a second time for verication. If you want to exit the signon panel immediately, press F3. If verication of the DCE principal and password succeed, you are logged in as the CICS userid that you entered. (If no UD key exists for that userid, you will become the regions default userid.) If DCE does not verify the principal and password (if no DCE principal exists or if the password is not correct), the terminal session defaults to the regions
359
CESN
default userid and you are given access to those transactions and resources with TSL and RSL keys that match those listed in the UD entry for the regions default userid. You may use CESN to change the userid you are signed on as. For example, if you are signed on as BERT, you may use CESN to sign on as ERNIE. However, CICS signons are not nested. If the signon as ERNIE fails, or if you sign off using CESF while using CRTE, your userid reverts to the regions default userid rather than BERT. When you use CESN to sign on as a different user from a CICS client (for example, on Open Systems use cicsterm, and for Windows NT use cicslterm, the DCE context of the client is not affected. This means that CICS does not change the ticket limit and ticket expiry refresh limit account information for the CICS client that you are using. For example, if user BERT (who has a ticket of one hour) accesses CICS using cicsterm, and uses CESN to sign on as ERNIE (who has a ticket of eight hours), the original ticket being used by cicsterm remains unchanged. BERTs ticket expires after its one hour life and his network authentication expires and the user can no longer access the region even though CESN was used to use ERNIEs userid. All that really changes when you use CESN to change your userid is the specics dened for the UD entry, such as the transactions and resources you are given access to. To regain the original userid after having changed it with CESN (whether or not you were able to log on to a valid CICS userid) either sign on again using CESN, or use the sign off transaction, CSSF, and restart your terminal session. The same userid can be signed on at more than one terminal concurrently. CICS does not check to see if a particular userid and password have been used in a previous signon request. CICS writes messages to CSMT as a record of your signon. The CESN transaction is pseudo-conversational. You should never change the TSLKey attribute of the Transaction Denition for CESN. Starting and ending CESN: You start the CESN transaction directly by entering the tranid CESN. The transaction ends when you have successfully logged on or when the logon is rejected.
360
CESN
See the CICS Intercommunication Guide for information about the security considerations when signing on to a CICS system during transaction routing.
361
CMLV CMLV (Console Message Log Viewer)

Browses the console log.
Syntax
CMLV
Description
CMLV is a CICS-supplied transaction that seamlessly browses the console.nnnnnn les for the region in which it is running. It can be used to browse the console message log for another region by running it remotely using CRTE. The name of the region for which the console message log is being displayed is shown in the top left hand corner of the CMLV map in the APPLID eld. When CMLV is invoked it makes a copy of the console log and browses the copy. Any changes to the original le cannot be seen unless the refresh function (PF9) is used. CMLV displays 160 characters per logical line. Any messages that exceed this length are split onto 2 or more lines. In order to maximise the number of messages displayed, only 80 characters of each line are displayed at any one time. Scrolling functions are available to scroll to the end of a line. Using CMLV: The program function keys have the following functions: PF1 PF3 PF4 PF5 PF7 PF8 PF9 displays the help information for the console message log viewer transaction. exits from the log viewer and clears the screen. displays the rst page of the le. displays the last page of the le. scrolls backwards. scrolls forwards. closes the le and reopens it. This allows any changes since CMLV was invoked to be displayed. The refresh operation returns the display to the start of the le. scrolls the display left by 40 characters. scrolls the display right by 40 characters.
PF11 PF12
362
CMLV
CLEAR exits from the log viewer and clears the screen.
363
CRTE CRTE (Routing Transaction)

To run transactions owned by a connected CICS region.
Syntax
CRTE SYSID{=sysId | (sysId) }
Options
sysId is the four-character key of the Communications Denitions (CD) entry that denes the remote region where the transaction is to run. Example: To route to the remote region whose local CD denition is called REG1:
CRTE SYSID=REG1
Description
You can use CRTE to run transactions that reside on a connected remote CICS system, instead of dening these transactions as remote in the local system. CRTE is particularly useful for infrequently used transactions, or for transactions such as CEMT that reside on all systems. It avoids the necessity of dening the remote CEMT in the local system with a different name. The transactions run can include pseudoconversational transactions as well as CRTE itself. The terminal through which CRTE is run must be dened on the remote system (the application-owning region) or it must be shipped from the local region (the terminal-owning region). See the CICS Intercommunication Guide for additional information. The routing transaction veries that the specied remote region is known and is available. If it is, a message displays conrming that a routing session to the required region is started. You can then clear the screen and enter the transaction code for the transaction to be run on that system, and you enter input of the form: yyyyzzzzzz... where yyyy is the name by which the required remote transaction is known on the remote region, and zzzzzz... is the initial input to that transaction. Subsequently, you can use the remote transaction as if you have dened it
364
CRTE
locally and run it in the ordinary way. In fact, you use the terminal as if it were connected directly to the remote region. When using CRTE, security checking on the remote system is not affected by the userid you used to sign on to the local system. Instead, security checking depends on whether or not you sign on using CESN while using CRTE. v If you do not sign on (if you do not use CESN), you are given the remote regions default userid. When a transaction is run, the security checks are carried out against this default user. A check is also done against the link userid to see whether the remote system itself has authority to access the resource. Thus, access is granted to those resources dened for the default userid that are also dened for the link userid. If a link userid is not specied, then access is granted to those resources dened for the default userid that are also dened in the Communications Denitions (CD) entry TSLKeyMask and RSLKeyMask attributes. v If you do sign on to the remote region while running CRTE (using CESN), access is granted to those resources dened for the signed on userid that are also dened for the link userid. If a link userid is not specied, then access is granted to those resources dened for the default userid that are also dened in the Communications Denitions (CD) entry TSLKeyMask and RSLKeyMask attributes. You end a routing session by entering the CANCEL keyword. This keyword automatically signs you off from the connected region (assuming you were signed on in that region). When a routing session is ended, CICS displays the message:
ROUTING SESSION TO SYSTEM sysId TERMINATED
If you have used CRTE to route transactions through more than one system, you must enter CANCEL the same number of times as you entered CRTE to end the routing session. Note: In a chain of CRTE sessions, different systems may be in different locales. The term locale is used to refer to a subset of a users environment that denes conventions for a specied culture, such as time formatting, numeric formatting, monetary formatting, and character classication, conversion, and collation. Refer to your operating system documentation for more information about locales and how they are used. Although the routing transaction is implemented as a pseudoconversational transaction, CICS holds the terminal from which the transaction is run until CICS terminates the routing session.
365
CRTE
While a terminal is in a routing session with another region (that is, during the period between entering CRTE and CANCEL) the terminal cannot receive messages delivered by automatic transaction initiation (ATI). Starting and ending CRTE: You start the CRTE transaction directly by entering the tranid CRTE. The transaction ends when the CANCEL keyword is used. See CESN (Signon) on page 359 for information about what userid is used and what level of security you are given when using CRTE to change userids after you have used CRTE. See also the CICS Intercommunication Guide for related information.
366
CSTD CSTD (Statistics)

Displays statistics information.
Syntax
CSTD
Description
CSTD is a CICS-supplied transaction that displays statistics information for: v Temporary storage and transient data v Storage pools v Tasks v Intersystem communication v Files v Terminals v Transactions v Programs To gather these statistics, CSTD uses the EXEC CICS COLLECT STATISTICS command (see the CICS Application Programming Reference for information on this command). Using CSTD: When you enter CSTD the following screen is displayed:
CSTD 01/17/96 11:02:09 CICS Statistics Display Option ===> 1 3 5 7 9 11 TS and TD Statistics Miscellaneous Statistics File Statistics Program Statistics Class Max Task Statistics Transaction/Program Rates 2 4 6 8 10 12 Pool Storage Statistics ISC Details Statistics Terminal Statistics Transaction Statistics ISC Summary Statistics Set/Display Statistics
Enter option and press enter PF1=Help Enter=Refresh PF3=Exit
Select the statistics you want by entering the relevant number and pressing Enter. Program function (PF) key values:
367
CSTD
The program function keys have the following functions: Enter Clear PF3 PF5 PF6 refreshes the display exits from CSTD Returns to the main CSTD menu Stop auto update Start auto update
PF7 (when displayed) moves to the next screen of statistics PF8 (when displayed) moves to the previous screen of statistics Running CSTD: Choose the statistics you want to see by entering CSTD and selecting a category as shown in The CSTD screen on page 367. The statistics are then displayed. Setting Display inactive les to N causes CSTD not to display les that have zero values. Placing characters in the Start display with le: eld causes the display to start with the indicated characters. The terminal on which CSTD is running should be set to ATI. See the CICS Administration Guide for related information.
368
Chapter 4. Operator control of FEPI

Two CICS-supplied transactions, CEMT and CETR, provide operator control of FEPI: you can use the CEMT INQUIRE, SET, and DISCARD commands to control FEPI resources such as nodes, targets, and pools; and the CETR transaction to control FEPI trace.
CICS/ESA only You can also use VTAM commands to manage communication with target systems. FEPI application programs, and the CICS resources they use, are controlled just like other CICS applications and resources.
CEMTmaster terminal transaction

The CEMT transaction has a range of commands that support FEPI. These commands, which are described below, work exactly like the CEMT commands.
369
CEMT DISCARD CEMT DISCARD

DISCARD removes targets, nodes, pools, or property sets completely from FEPI.
Syntax
Press the Clear key to clear the screen. Type CEMT DISCARD (the minimum abbreviation is CEMT D), followed by any one of: FENODE(nodename) FEPOOL(poolname) FEPROPSET(propsetname) FETARGET(targetname). For example, cemt d fen(fepnode1) removes the node fepnode1 from FEPI. Typing ? at the beginning of either the rst or second line gives a syntax prompt.
CEMT DISCARD
CEMT Discard FENode(nodename) FEPOol(poolname) FEPRopset(propsetname) FETarget(targetname)
Options
FENode(nodename) The name of the FEPI node to be discarded. FEPOol(poolname) The name of the FEPI pool to be discarded. FEPRopset(propsetname) The name of the FEPI property set to be discarded. FETarget(targetname) The name of the FEPI target to be discarded.
370
CEMT INQUIRE FECONNECTION CEMT INQUIRE FECONNECTION

Display information about FEPI connections.
Context
INQUIRE FECONNECTION displays information about the state of FEPI connections. A connection is identied by specifying the target and node. The results are given in order of target within the node. Family selection can be used for TARGET and NODE, but list selection cannot be used.
Syntax
Press the Clear key to clear the screen. There are two ways of commencing this transaction: v Type CEMT INQUIRE FECONNECTION (the minimum abbreviation is CEMT I FEC). You get a display that lists the current status. v Type CEMT INQUIRE FECONNECTION (CEMT I FEC) followed by as many of the other attributes as are necessary to limit the range of information that you require. For example, if you enter cemt i fec p(pool5) acq, the resulting display will show you the details of all FEPI connections in pool5 on which sessions are bound. You can tab to the highlighted elds and overtype them with new values. CICS/ESA only:
CEMT INQUIRE FECONNECTION
ALl CEMT Inquire FEConnection NODe(nodename) Target(targetname)
Pool(poolname)
INSTalled NOTinstalled
INSErvice Outservice
ACquired Released
State(value)
Waitconvnum(value)
Lacqcode(value)
CICS for Windows NT:

371

ALl CEMT Inquire FEConnection NODe(nodename) Target(targetname)
Pool(poolname)
INSTalled NOTinstalled
INSErvice Outservice GOINgout
ACquired Released OBTAining FREEing
State(value)
Waitconvnum(value)
Lacqcode(value)
Options
ALl is the default. Information about all connections is given, unless you specify a selection. NODe(nodename) is the 8-character name of a node. Information is restricted to connections of which this node forms part. Target(targetname) is the 8-character name of a target. Information is restricted to connections of which this target forms part.
Examples
CEMT IN FEC STATUS: RESULTS - OVERTYPE TO MODIFY Node(NODE1 ) Targ(TARGETA ) Pool(POOL5 ) Inst Inse Rele Stat(NOCONV ) Wait(00000) Lacq(X'08570002') Node(NODE1 ) Targ(TARGETB ) Pool(POOL5 ) Inst Inse Rele Stat(NOCONV ) Wait(00000) Lacq(X'08570002') Node(NODE1 ) Targ(TARGET3 ) Pool(POOL3 ) Inst Inse Rele Stat(NOCONV ) Wait(00000) Lacq(X'08570002')
Figure 3. CEMT INQUIRE FECONNECTION screen
Options
Node(value) displays the 8-character name of a node identifying a connection. Target(value) displays the 8-character name of a target identifying a connection.
372

Pool(poolname) displays the 8-character name of a pool of connections. Installed|Notinstalled displays a value identifying the install state of the connection. The values are: Installed The connection is in a pool that has been dened by INSTALL and is available for use. Notinstalled The connection is in a pool, or involves a node or target that is being discarded, but is still in use. Inservice|Outservice|Goingout displays a value identifying the service state of the connection. The values are: Inservice The connection is in service and can be used in a conversation.
CICS/ESA only If OUTSERVICE state has been requested but has not yet completed, a GOING OUT message is shown. Outservice The connection is out of service and cannot be used for any conversation. Goingout
CICS for OS/2 and CICS for Windows NT The connection is being put out of service. Acquired|Released|Obtaining|Freeing displays a value identifying whether a session on the connection is bound. The values are: Acquired A session is bound on the connection.
CICS/ESA only If RELEASED state has been requested but has not yet completed, a BEING RELEASED message is shown.
373

Released No session is bound on the connection. If ACQUIRED state has been requested but has not yet completed, a BEING ACQUIRED message is shown. Obtaining
CICS for OS/2 and CICS for Windows NT A session is being bound on the connection. The connection remains in the OBTAINING state until all the criteria for ACQUIRED have been met. Freeing
CICS for OS/2 and CICS for Windows NT The session involving the connection is being unbound. State(value) displays a 12-character value identifying the state of the conversation using the connection. The values are: APPLICATION A normal application task owns the conversation BEGINSESSION A begin-session handling task owns the conversation FREE An end-session handling task owns the conversation, following a FEPI FREE command
NOCONV No conversation is active on the connection PENDBEGIN A begin-session handling task has been scheduled PENDDATA FEPI is waiting for inbound data, following a FEPI START command PENDFREE An end-session handling task has been scheduled, following a FEPI FREE command PENDPASS The conversation is unowned, following a FEPI FREE PASS command
374

PENDRELEASE An end-session handling task has been scheduled, following an unbind request PENDSTART Inbound data having arrived, a task specied by FEPI START has been scheduled PENDSTSN An STSN-handling task has been scheduled PENDUNSOL An unsolicited-data handling task has been scheduled RELEASE An end-session handling task owns the conversation, following an unbind request STSN An STSN-handling task owns the conversation UNSOLDATA An unsolicited-data handling task owns the conversation. The pending states indicate the conversation is unowned, pending the event or task indicated. If a pending state persists, it is likely that the application has failed in some way; you should consider resetting the connection by issuing a CEMT SET FECONNECTION RELEASED command. Waitconvnum(value) displays a value identifying the number of conversations that are waiting to start using a connection. (If a conversation could use any one of several connections, it is counted as waiting on each one.) Lacqcode(value)
CICS/ESA only displays a hexadecimal value indicating the result of the last acquire request for the node; that is, the sense code from the last VTAM REQSESS, a zero indicating success. For information about VTAM sense codes, see either the VTAM Messages and Codes or the SNA Formats manual.
375
CICS for OS/2 and CICS for Windows NT displays a hexadecimal value indicating the result of the last acquire request for the node; zero indicating success. For information about sense codes, see either the Conventional LUA Programming Reference manual or the SNA Formats manual.
376
CEMT INQUIRE FENODE CEMT INQUIRE FENODE

Display information about a FEPI node.
Syntax
Press the Clear key to clear the screen. There are two ways of commencing this transaction: v Type CEMT INQUIRE FENODE (the minimum abbreviation is CEMT I FEN). You get a display that lists the current status. v Type CEMT INQUIRE FENODE (CEMT I FEN) followed by as many of the other attributes as are necessary to limit the range of information that you require. For example, if you enter cemt i fen inst, the resulting display will show you the details of all FEPI nodes that have been installed and are ready for use. You can tab to the highlighted elds and overtype them with new values. CICS/ESA only:
CEMT INQUIRE FENODE
ALl CEMT Inquire FENode (nodename) INSTalled Notinstalled INSErvice Outservice
ACquired Released
Lacqcode(value)

CEMT INQUIRE FENODE
ALl CEMT Inquire FENode (nodename) INSTalled Notinstalled INSErvice Outservice GOINgout
ACquired Released OBTAining FREEing
Lacqcode(value)
377
CEMT INQUIRE FENODE Options

ALl is the default. Information about all nodes is given, unless you specify a node. nodename is the 8-character name of the node to be queried.
Examples
CEMT IN FEN STATUS: RESULTS - OVERTYPE TO Feno(NODE1 ) Inst Inse Acqu Feno(NODE2 ) Inst Inse Acqu Feno(NODE3 ) Inst Inse Acqu Feno(NODE4 ) Inst Inse Acqu
MODIFY Lacq(X'00000000') Lacq(X'00000000') Lacq(X'00000000') Lacq(X'00000000')
Figure 4. CEMT INQUIRE FENODE screen
Options
Feno indicates that this panel relates to an FENODE inquiry. (value) displays the 8-character name of a node. Installed|Notinstalled displays a value identifying the install state of the node. The values are: Installed The node has been dened by INSTALL and is available for use. Notinstalled The node is being discarded, but is still in use. Inservice|Outservice|Goingout displays a value identifying the service state of the node. The values are: Inservice The node is in service and can be used in a conversation.
CICS/ESA only If OUTSERVICE state has been requested but has not yet completed, a GOING OUT message is shown.
378
CEMT INQUIRE FENODE

Outservice The node is out of service and cannot be used for any conversation. Goingout
CICS for OS/2 and CICS for Windows NT The node is being put out of service. Acquired|Released|Obtaihp0.ining|Freeing displays a value identifying the acquire state of the node. The values are: Acquired
CICS/ESA only The VTAM ACB for the node is open and the VTAM set logon start command has completed. If RELEASED state has been requested but has not yet completed, a BEING RELEASED message is shown. If this persists, you might need to use VTAM commands to recover the node.
CICS for OS/2 and CICS for Windows NT The node is acquired and, if in service, can be used in a conversation. Released
CICS/ESA only The VTAM ACB is closed. If ACQUIRED state has been requested but has not yet completed, a BEING ACQUIRED message is shown. If this persists, you might need to use VTAM commands to recover the node.
CICS for Windows NT The node is released and can not be used for any conversation. OBTAining
379
CEMT INQUIRE FENODE
CICS for Windows NT The node is being acquired. The node remains in the OBTAINING state until all the criteria for ACQUIRED have been met. FREEing
CICS for Windows NT The node is being released. Lacqcode(value)
CICS/ESA only displays a hexadecimal value indicating the result of the last acquire request for the node; that is, the sense code from the last VTAM OPEN ACB, a zero indicating success. For information about VTAM sense codes, see either the VTAM Messages and Codes or the SNA Formats manual.
CICS for Windows NT displays a hexadecimal value indicating the result of the last acquire request for the node; zero indicating success. For information about IBM Communications Servers sense codes, see either the Conventional LUA Programming Reference manual or the SNA Formats manual.
380
CEMT INQUIRE FEPOOL CEMT INQUIRE FEPOOL

Display information about the state of FEPI pools of connections.
Syntax
Press the Clear key to clear the screen. There are two ways of commencing this transaction: v Type CEMT INQUIRE FEPOOL (the minimum abbreviation is CEMT I FEPO). You get a display that lists the current status. v Type CEMT INQUIRE FEPOOL (CEMT I FEPO) followed by as many of the other attributes as are necessary to limit the range of information that you require. For example, if you enter cemt i fepo inse, the resulting display will show you the details of all FEPI pools that are in service and can be used by conversations. You can tab to the highlighted service state eld and overtype it with a new value. CICS/ESA only:
CEMT Inquire FEPOol
All CEMT Inquire FEPOol (poolname) INSTalled Notinstalled INSErvice Outservice
Device(value)
Waitconvnum(value)

CEMT Inquire FEPOol
All CEMT Inquire FEPOol (poolname) INSTalled Notinstalled INSErvice Outservice GOINgout
Device(value)
Waitconvnum(value)
381
CEMT INQUIRE FEPOOL Options

All is the default. Information about all pools is given, unless you specify a pool to be queried. poolname species the name of a pool of connections.
Examples
CEMT IN FEPO STATUS: RESULTS - OVERTYPE TO MODIFY Fepo(POOL3 ) Inst Inse Devi(T3278M4 ) Wait(00000) Fepo(POOL5 ) Inst Inse Devi(T3278M2 ) Wait(00000)
Figure 5. CEMT INQUIRE FEPOOL screen
Options
Fepo indicates that this panel relates to an FEPOOL inquiry. (value) displays the 8-character name of a pool of connections. Installed|Notinstalled displays a value identifying the install state of the pool. The values are: Installed The pool has been dened by INSTALL and is available for use. Notinstalled The pool is being discarded, but is still in use. Inservice|Outservice|Goingout displays a value identifying the service state of the pool. The values are: Inservice The pool is in service and can be used in a conversation.
CICS/ESA only If OUTSERVICE state has been requested but has not yet completed, a GOING OUT message is shown.
382
CEMT INQUIRE FEPOOL

Outservice The pool is out of service and cannot be used for any conversation. Goingout
CICS for Windows NT The pool is being out put of service. Device(value) displays a value identifying the mode of conversation and the type of device. The values are: T3278M2 SLU2 mode, 3278 Model 2 T3278M3 SLU2 mode, 3278 Model 3 T3278M4 SLU2 mode, 3278 Model 4 T3278M5 SLU2 mode, 3278 Model 5 T3279M2 SLU2 mode, 3279 Model 2B T3279M3 SLU2 mode, 3279 Model 3B T3279M4 SLU2 mode, 3279 Model 4B T3279M5 SLU2 mode, 3279 Model 5B TPS55M2 SLU2 mode, PS/55, 24 lines TPS55M3 SLU2 mode, PS/55, 32 lines TPS55M4 SLU2 mode, PS/55, 43 lines LUP SLU P mode, all cases
Waitconvnum(value) displays a value identifying the number of conversations that are waiting to start using a connection in the pool.
383
CEMT INQUIRE FEPROPSET CEMT INQUIRE FEPROPSET

Display information about a set of FEPI properties. Press the Clear key to clear the screen. There are two ways of commencing this transaction: v Type CEMT INQUIRE FEPROPSET (the minimum abbreviation is CEMT I FEPR). You get a display that lists all FEPI property sets that are currently installed. v Type CEMT INQUIRE FEPROPSET (CEMT I FEPR) followed by the name of a particular property set. For example, if you enter cemt i fepr (feprop1), the resulting display will show you whether or not the FEPI property set feprop1 is installed. (If it is not installed, you get a 'NOT FOUND' response.)
Syntax
CEMT INQUIRE FEPROPSET
All CEMT Inquire FEPRopset (propsetname)
Options
All is the default. Information about all property sets is given, unless you specify a particular one. propsetname is the name of the property set to be queried.
Examples
CEMT IN FEPR STATUS: RESULTS Fepr(PROP1 ) Fepr(PROP2 ) Fepr(PROP3 ) Fepr(PROP4 )
Figure 6. CEMT INQUIRE FEPROPSET screen
Options
Fepr indicates that this panel relates to an FEPROPSET inquiry.
384
CEMT INQUIRE FEPROPSET

(value) displays the 8-character name identifying a property set.
385
CEMT INQUIRE FETARGET CEMT INQUIRE FETARGET

Display information about the state of FEPI targets.
Syntax
Press the Clear key to clear the screen. There are two ways of commencing this transaction: v Type CEMT INQUIRE FETARGET (the minimum abbreviation is CEMT I FET). You get a display that lists the current status. v Type CEMT INQUIRE FETARGET (CEMT I FET) followed by as many of the other attributes as are necessary to limit the range of information that you require. For example, if you enter cemt i fet inse, the resulting display will show you the details of all FEPI targets that are in service. You can tab to the highlighted service state eld and overtype it with a new value. CICS/ESA only:
CEMT INQUIRE FETARGET
ALl CEMT Inquire FETarget (targetname) APpl(applname) INSTalled Notinstalled
INSErvice Outservice

ALl CEMT Inquire FETarget (targetname) APpl(applname) INSTalled Notinstalled
INSErvice Outservice GOINgout
386
CEMT INQUIRE FETARGET Syntax

ALl is the default. Information about all targets is given, unless you specify the target to be queried. targetname is the name of the target to be queried.
Examples
CEMT IN FET STATUS: RESULTS - OVERTYPE Feta(TARGETA ) Appl(APPL5 Feta(TARGETB ) Appl(APPL6 Feta(TARGET1 ) Appl(APPL1 Feta(TARGET2 ) Appl(APPL2 Feta(TARGET3 ) Appl(APPL3 Feta(TARGET4 ) Appl(APPL4
TO ) ) ) ) ) )
MODIFY Inst Inse Inst Inse Inst Inse Inst Inse Inst Inse Inst Inse
Figure 7. CEMT INQUIRE FETARGET screen
Options
Feta indicates that this panel relates to an FETARGET inquiry. (value) displays the 8-character name identifying a target. Appl(applname) displays the 8-character VTAM application name of the back-end system that the target represents. Installed|Notinstalled displays a value identifying the install state of the target. The values are: Installed The target has been dened by INSTALL and is available for use. Notinstalled The target is being discarded, but is still in use. Inservice|Outservice|Goingout displays a value identifying the service state of the target. The values are: Inservice The target is in service and can be used in a conversation.
387
CICS/ESA only If OUTSERVICE state has been requested but has not yet completed, a GOING OUT message is shown. Outservice The target is out of service and cannot be used for any conversation. Goingout
CICS for Windows NT The target is being put out of service.
388
Chapter 5. CICS-supplied programs

CICS-supplied programs make it possible for you to modify the system without changing any of its standard user interfaces. These programs can be customized or replaced to suit the requirements of your installation. The six supplied programs are: External Security Manager (ESM) CICS calls the ESM (cicsesm) to carry out resource and transaction security checking in place of CICS-provided security checking. This is described in External Security Manager user program on page 395. Terminal Autoinstall Program CICS calls Terminal Autoinstall (DFHCHATX) to control the automatic installation of terminals which are not dened to CICS at start-up. The automatic installation of these terminals takes place when they request connection to a CICS system. This is described in Terminal autoinstall user program on page 390. Communications Denitions (CD) entry Autoinstall Program The CD entry autoinstall program (DFHCCINX) is called from the CCIN transaction. CCIN runs whenever an IBM CICS client connects to the region, or if a remote CICS server requests an autoinstall of a CD entry. DFHCCINX is responsible for determining whether to allow the autoinstall of the CD entry and, if the autoinstall is to proceed, it can specify values for some of the attributes in a newly installed CD entry. DFHCCINX is described in the CICS Intercommunication Guide. Performance monitoring program CICS calls the Performance Monitoring User Program (cicsemp) to perform the processing at user Event Monitoring Points taking the form of EXEC CICS ENTER API commands. This is described in Performance monitoring user program on page 395. Function Shipping User Conversion Program CICS calls the Function Shipping User Conversion Program (DFHUCNV) to perform non-standard data conversion when function shipping. This is described in the CICS Intercommunication Guide. Transaction Routing User Conversion Program CICS calls the Transaction Routing User Conversion Program (DFHTRUC) to perform non-standard data conversion when transaction routing. This is described in the CICS Intercommunication Guide.
389
CICS-supplied programs Terminal autoinstall user program

Terminals are dened to CICS using Terminal Denitions (WD). Only some terminals entries are stored permanently in the WD; most terminals do not have a permanent entry. When these terminals request a CICS session, CICS has to create a WD entry automatically, so that CICS can recognize the terminal. CICS does this by selecting a model name from a list of models. Each model has an entry in the WD. It is this entry that is used to create a runtime WD entry for the terminal. These autoinstalled terminals are dened in the runtime WD only while they are connected to CICS. When you terminate the connection, CICS automatically removes the WD entry. A particular advantage of autoinstall is that you do not have to create and maintain a large permanent WD. Any terminal or pseudo-terminal that does not have an entry in the WD for the region, is autoinstallable. CICS can use the terminal autoinstall user program to control the process of adding entries to the runtime WD whenever terminals, not already dened to CICS, request connection to CICS. The supplied user program selects the rst in a list of suitable models to derive the terminal identier. You may customize the program to carry out any processing that you require. For example, you may wish to count and limit the total number of logged on terminals, or keep utilization information about the terminal. The user program is also called when the terminal is uninstalled and removed from the WD. This can be used, for example, to update any statistics set up on autoinstall.
Terminal model denition

If you have a commonly used terminal type, you can add it to the terminal denitions. If the terminal is to be a model terminal, you must set the ModelId and DevType attributes. If the terminal is a real terminal, you must set the NetName attribute instead.
The supplied terminal autoinstall program

The user terminal autoinstall program takes responsibility for deciding to allow or disallow the connection of a new terminal resource to the CICS system. This decision may be based on a number of site-dependent factors, for example security, or the total number of connected terminals. CICS takes no part in either the decision, or checking the factors. You decide whether
390
CICS-supplied programs
checking takes place, and how it is done. The user terminal autoinstall program provides you with the means of implementing your decision. An autoinstall model is a terminal denition that you use as a model when you attempt to invoke a session and dene your autoinstallable terminal to your CICS system. The default terminal autoinstall program, DFHCHATX, is a C program supplied to you as part of CICS. The sample source code, cics_aut.ccs is in prodDir/src/samples/install, together with a makele makefile. You also need the le cics_aut.h, which is in the header les. You can install DFHCHATX in its unmodied form, or you can customize it to meet the particular requirements of your organization. Before you change DFHCHATX, try the default autoinstall program rst. If you decide to alter the functionality of the default autoinstall program, take a backup copy of the program source rst, in case you encounter problems and need to revert to the original version. After modication, you must place the generated executable load module into the required directory so that it is available for use by your CICS system. For information about the CICS directory structure, see the Planning and Installation Guide book. You can write the program in either C or COBOL, and you can use EXEC CICS commands. You must dene the program in the Program Denitions (PD). You can customize the default terminal autoinstall program to carry out any processing required by your installation. Here are some customization suggestions. Your user terminal autoinstall program could: v Control the allocation of terminal identiers. v Count and limit the total number of logged on terminals. v Count and limit the number of autoinstalled terminals. v Keep utilization information about autoinstalled terminals. v Assign the terminal name. v Carry out general logging. v Handle special cases, for example, always allow certain terminals to log on. v Exercise network wide control over autoinstall. A network wide, global user terminal autoinstall program may reside on one CICS system. When a user terminal autoinstall program on a remote CICS system receives an
391
autoinstall request, the request may involve the global user terminal autoinstall program, and data can be transferred from one user terminal autoinstall program to another. Each time the terminal autoinstall program is invoked, CICS passes a parameter list to the program using the COMMAREA mechanism of the EXEC CICS LINK command. The contents of the parameter list dene which function to perform (INSTALL or UNINSTALL) and provide data relevant to the particular event. If the user terminal autoinstall program decides that the autoinstall request can proceed, the program must return the name of the autoinstall model to CICS , together with an associated terminal identier, by storing the required values in the COMMAREA return information eld. Subsequently, CICS uses the returned values to install the terminal in the WD. In addition, the user terminal autoinstall program must indicate in the returned status byte whether or not the event is to proceed. If the autoinstall is to proceed, it sets the status eld set to binary zeros. The model name is selected from the array of model names passed to the autoinstall program in the parameter list. CICS uses this model so that it can recognize the terminal. CICS selects the autoinstall models in the array from the complete list of terminal models according to their compatibility with the system information describing the resource. The default user terminal autoinstall program selects the rst model from the list. CICS uses this model to build the Terminal Denitions (WD) entry and determine the CICS attributes of the automatically installed terminal. The default user terminal autoinstall program generates the terminal identier from the rst two and the last two characters of the name by which the terminal is known to the network. CICS passes this netname to the default program, using the COMMAREA. If the user terminal autoinstall program returns a model name that is not in the list passed to the user terminal autoinstall program, CICS generates an ABEND and will not install the terminal. If the user terminal autoinstall program decides that the autoinstall request is to be rejected, it must set the status byte in the COMMAREA to be not equal to binary zeros. When processing is complete, the user terminal autoinstall program must return to CICS by issuing an EXEC CICS RETURN command. When you write the user terminal autoinstall program, the processing required for the UNINSTALL function does not depend upon whether the
392
program received control because a previously autoinstalled resource is no longer required, or because a previous INSTALL process failed for some reason. The processing you need to perform may be considered identical for the two events; there is no difference in the environment or in the actions that your program needs to perform. Invoking the user terminal autoinstall program to perform the UNINSTALL function enables you to reverse the processes carried out at the INSTALL event. For example, if your user terminal autoinstall program increments a count of the total number of automatically installed resources at INSTALL time, your program can decrement the count at UNINSTALL time.
Terminal autoinstall program parameters

When CICS runs the user terminal autoinstall program, the following parameters are passed through the COMMAREA: Parameter 1 This is a four-byte eld. The rst byte indicates the request type, INSTALL being 0 and UNINSTALL being 1. The remaining three bytes are reserved by CICS. Parameter 2 This is a pointer to the identier structure. The identier structure consists of a two-byte length eld, followed by the eight-byte NETNAME of the resource requesting a CICS session. The NETNAME is the name which identies the terminal to the network. CICS generates the NETNAME by combining the hostname on which the CICS 3270 Terminal Emulator is running with the name of the operating system tty device that is being controlled. This string is then converted to uppercase. For example, on CICS for AIX a tty of /dev/pts/27 on a host called eagle would have a NETNAME of EAGLS027, and on all other CICS on Open Systems platforms a tty of /dev/pty/ttyvc (or /dev/pts/ttyvc on Sun Solaris) on a host called eagle would have a NETNAME of EAGLTYVC. For a cicsteld terminal, the process identier of the cicsteld process is used instead of the tty device identier. To produce a unique terminal name, CICS places the rst two characters of the supplied NETNAME in front of the last two characters of the NETNAME (EA27 in the example above). If necessary, the NETNAME formed from this combination is transformed until a unique terminal name is produced. Parameter 3 This is a pointer to a structure containing an array of names of eligible autoinstall models. The structure contains a two-byte eld dening
393
the number of elements in the array; followed by the array containing eight-byte name elements. If the array is empty, the number eld is set to zero. Parameter 4 This is a pointer to the 21-byte return information eld, set to blanks on input. You can use it to return the following information to the calling program. The rst eight bytes contain the autoinstall model name, the next four-bytes contain the terminal name, the next eight bytes are blank, and the last byte is a status-byte used to indicate whether or not the terminal installation event is to proceed. Parameter 5 This area is not relevant to CICS and is set to zero. The parameters which CICS passes in the COMMAREA to the user terminal autoinstall program when reversing the autoinstall process are: Parameter 1 This is a four-byte eld. The rst byte is set to 1 to indicate an UNINSTALL request. Parameter 2 This is a pointer to a four-byte eld containing the terminal identier of the deleted resource.
When the terminal autoinstall program is accessed

When the CICS 3270 Terminal Emulator (or a replacement) connects to a region for the rst time, CICS calls a transaction called CHAT. This transaction is responsible for performing the autoinstall operation for terminals which are not already dened to the Terminal Denitions (WD). CHAT calls the user-supplied autoinstall program if the terminal is to be autoinstalled. You are permitted to control the autoinstall program name by using the CEMT SET AUTOINSTALL command. CICS also calls the autoinstall program when an autoinstalled denition is deleted, permitting you to reverse whatever actions were performed at install time. Deletion of an autoinstalled denition occurs automatically when you run the CSSF transaction. The autoinstall program is also called when a terminal is connected or removed on a CICS Client connected to the region. In this case, the transaction that is running is called CCIN. It passes the same parameters to the exit, and calls it at the same stages as CHAT does. See the CICS Intercommunication Guidefor more information. CICS passes control to the user program when: v An autoinstall INSTALL request is being processed v An autoinstall INSTALL request has failed
394
v An autoinstall UNINSTALL request is being processed. The user program receives control automatically at INSTALL when: v A logon request is received from a resource that does not supply a NetName, and v Autoinstall processing has completed to a point where information (a terminal identier and autoinstall model name) from the user program is required in order to proceed. To provide symmetry of user control over the autoinstall process, the user program also receives control automatically when a session with a previously automatically installed terminal has ended, or an autoinstall request was previously accepted by the user program but the subsequent INSTALL process failed for some reason.
External Security Manager user program

The default External Security Manager (ESM) program, cicsesm, is supplied to you as part of CICS. You can implement it in its unmodied form, or you can customize it to meet the particular requirements of your site. Note that in its unmodied form, the ESM will simply return CICS_ESM_RETURN_OK to every security check, indicating that authorized access has been granted to the transaction or resource. The initial conguration of a CICS region sets external security off, using the ESMLoad attribute in the Region Denitions (RD). CICS performs internal security checking when ESMLoad is off. If you wish to override internal security checking, then you must modify the ESM program to carry out the security checks that you require. After modication, you must place the generated executable load module into the required load library, so that it is available for use by the CICS system. You must then set the ESM attributes in the RD to make your program available to the region.
Performance monitoring user program

This section describes in detail the Performance Monitoring User Program.
Setting up CICS to call performance monitoring

You specify whether or not you require Performance Monitoring by using the Resource Denition Online (RDO) facility to set the MonitorStatus attribute in the permanent Monitoring Denitions (MD). You can also use the CEMT SET
395
MONITOR transaction to set the MonitorStatus attribute. You use the RDO facility to specify the name of the Performance Monitoring user program in the UserMonitorModule attribute in the Monitoring Denitions (MD). CICS calls the program: v During task startup v During task exit v To process the EXEC CICS ENTER command v To stop the user clocks and return the user data to be written to the monitoring transient data queue v To restart the user clocks v At the end of a task, to clean up the user data. You can customize the default program to carry out any processing that you require. See the CICS Administration Guide for related information.
The Supplied Performance Monitoring User Program

The default performance monitoring user program, cics_emp (CICS for AIX) or cics_emp.c (CICS for HP-UX and CICS for Solaris), is supplied to you as part of CICS. You should customize the default performance monitoring user program to meet the particular requirements of your installation. After modication, you must place the generated executable load module into the required directory, so that the executable is available for use by the CICS system. You must customize the program using C, but you cannot use EXEC CICS commands. You must dene the program in the Monitoring Denitions (MD). The default performance monitoring user program is an example program, provided to illustrate how performance monitoring interfaces with CICS. The program consists of four separate functions: 1. Initialization This function returns the address of the other three interface functions to the caller plus the address of the programs private data area (for subsequent use by the other user functions because the user program cannot use static data). If the function encounters an error, an error code is returned for CICS to write as part of a message. The default Initialization function uses the algorithm:
396
Allocate task's data area space (malloc) IF the malloc fails Return CICS_EMP_RETURN_FAIL to disable user program ELSE Set up the return values Return CICS_EMP_RETURN_OK END-IF.
2. EnterAPI This function processes the EXEC CICS ENTER command. CICS passes the information from the EXEC CICS ENTER command parameters. The functionality of the function is entirely user-dened. The function processes the request and returns instructions to CICS on what to perform next at completion. If the function encounters an error, an error code is returned for CICS to write as part of a message. The default EnterAPI function uses the algorithm:
IF the data area (from Initialization) is invalid Return CICS_EMP_RETURN_FAIL to disable user program END-IF. Switch on the TRACEID from the EXEC CICS ENTER API CASE 1: Return CICS_EMP_RETURN_WRITE to Write a monitoring record. CASE 2: IF ENTRYNAME is START Start clock 1 Mark clock 1 active ELSE IF ENTRYNAME is STOP Stop clock 1 Mark clock 1 inactive ELSE No action taken END-IF END-IF. Return CICS_EMP_RETURN_OK. CASE 3: Add DATA1 to counter 1 Return CICS_EMP_RETURN_OK. CASE 4: Set counter 2 to DATA2 Return CICS_EMP_RETURN_OK. CASE 5: Increment counter 3 Return CICS_EMP_RETURN_OK. CASE 6: Disable all monitoring for this task Release data space (free) Return CICS_EMP_RETURN_DISABLE. CASE 7: Time a write to the monitoring TD Queue Start clock 2 Return CICS_EMP_RETURN_WRITE
397
CASE 8: Disable the user program for this task Release data space (free) Return CICS_EMP_RETURN_FAIL. DEFAULT: Return CICS_EMP_RETURN_OK.
3. WriteRecord This function returns the address of the User Data buffer which CICS appends to a monitoring record. If the address of the buffer is NULL or the length is zero, CICS does not append any user monitoring data to the system information. The functionality of this function is entirely user-dened, it should however, stop clocks if appropriate. If the function encounters an error, an error code is returned for CICS to write as part of a message. The default WriteRecord function uses the algorithm:
IF record type NOT ULM Requested or End of Task Disable all monitoring for this task Release data space (free) Return CICS_EMP_RETURN_DISABLE ELSE IF Operator ID is zero OR Data area (from Initialization) invalid Disable user program for task Release data space (free) Return CICS_EMP_RETURN_FAIL END-IF END-IF Stop clock 1 Move counters and times into target record Return the record address and length.
4. Restart This function releases any resources acquired by the Initialization function. CICS passes the address of the user programs private data. If the function encounters an error, an error code is returned for CICS to write as part of a message. The default Restart function uses the algorithm:
IF the data area (from Initialization) is invalid Return CICS_EMP_RETURN_FAIL to disable user program END-IF. Switch on the action request from CICS CASE CICS_EMP_FINISH_RESTART: Reset all 3 counters Stop clock 2 IF clock 1 is marked as active Start clock 1 END_IF Return CICS_EMP_RETURN_OK.
398
CASE CICS_EMP_FINISH_CLEANUP: Release data space (free) IF memory freed successfully Return CICS_EMP_RETURN_OK ELSE Return CICS_EMP_RETURN_FAIL END-IF
Functions Available to the User Program Four CICS functions are available to the user program: 1. CICS_EMP_StartClock Provides you with the necessary functionality to start monitoring clocks. Synopsis
CICS_EMP_ClockReturn_t CICS_EMP_StartClock(CICS_EMP_EventTime_t *Timer, enum CICS_EMP_ClockType ClockType);
Your program must pass one of the following clock type values to the function: CICS_EMP_CLOCK_TYPE_ELAPSED Record elapsed time. CICS_EMP_CLOCK_TYPE_SYSTEM Record system time. CICS_EMP_CLOCK_TYPE_USER Record user time. CICS_EMP_CLOCK_TYPE_BOTH Record both system and user time. The function returns one of the following return values to your program: CICS_EMP_CLOCK_RETURN_OK The clock started successfully. CICS_EMP_CLOCK_RETURN_PHASE The clock started out of phase. CICS_EMP_CLOCK_RETURN_INVALID The clock type is invalid. CICS_EMP_CLOCK_RETURN_FAILURE Cannot obtain system or user times. If the function returns CICS_EMP_CLOCK_RETURN_OK, the function also updates the Timer parameter. 2. CICS_EMP_StopClock
399
Provides you with the necessary functionality to stop monitoring clocks, and accumulate the time recorded by that clock, passed in the Timer data area. Note: The Timer data area must be initially set to nulls, because this is where the timer functions CICS_EMP_StartClock and CICS_EMP_StopClock accumulate clock information. Synopsis
CICS_EMP_ClockReturn_t CICS_EMP_StopClock(CICS_EMP_EventTime_t *Timer);
The function returns one of the following return values to your program: CICS_EMP_CLOCK_RETURN_OK The clock stopped successfully. CICS_EMP_CLOCK_RETURN_PHASE The clock stopped out of phase. CICS_EMP_CLOCK_RETURN_INVALID The clock type is invalid. CICS_EMP_CLOCK_RETURN_FAILURE Cannot obtain system or user times. If the function returns CICS_EMP_CLOCK_RETURN_OK, the function also updates the Timer parameter. 3. CICS_EMP_GetTime Provides you with the necessary functionality to get the current time in a CICS_EMP_Time_t data area. Synopsis
void CICS_EMP_GetTime(CICS_EMP_Time_t *CurrentTime);
4. CICS_EMP_SubtractTime Provides you with the necessary functionality to calculate the difference between two times of type CICS_EMP_Time_t. Synopsis
void CICS_EMP_SubtractTime(CICS_EMP_Time_t *Time1, CICS_EMP_Time_t *Time2, CICS_EMP_Time_t *Result);
Performance monitoring user program parameters

The parameters passed to the Performance Monitoring User Program depend upon which of the four functions CICS is about to perform.
400
1. The initialization function Function prototype
#include <cics_emp.h> CICS_EMP_Return_t CICS_EMP_Init (IN struct CICS_EMP_RegionData ,INOUT struct CICS_EMP_Functions ,INOUT void ,INOUT int ,IN struct CICS_EMP_PerformanceClass ,IN struct cics_eib ,IN const struct CICS_EMP_Map ); *RegionData *Functions **SaveSpace *ErrorCode *SystemData *EIB *Dictionary
The parameter passed by CICS to this function is: RegionData This is a pointer to data describing the CICS region. The parameters contained within this data are: Region_Id The eight-character name of the region. ReleaseId The four-character release number. Transaction Id The four-character transaction identier. The parameters returned by this function are: Return_Code This is the return code returned by the function. It is one of: CICS_EMP_RETURN_OK The initialization completed successfully. CICS_EMP_RETURN_FAIL The initialization detected an error. CICS disables user EMPs for this region. CICS_EMP_RETURN_DISABLE The initialization completed successfully, but CICS is to disable monitoring for this task. Functions If the Return_Code=CICS_EMP_RETURN_OK, this is a pointer to a buffer that contains the Event Monitoring Point (EMP) function addresses. The addresses contained in the buffer are: EnterAPI Process the EXEC CICS ENTER command.
401
WriteRecord Return user data to write to the performance le. ReStart Allow the user to restart any clocks following the write of a monitoring record. SaveSpace This is the address of the user programs private data for the task. ErrorCode If the Return_Code is not CICS_EMP_RETURN_OK, this is a pointer to an error code which CICS writes as part of a message. SystemData This is a pointer to the performance class monitoring structure. The address of the SystemData is constant for the life of the transaction. The Monitor Field Table details this. EIB The Execution Interface Block for the transaction.
Dictionary This contains information on how to interpret the SystemData. The address of the Dictionary is constant for the life of the CICS region. The mask denitions used to extract data from the Dictionary CICS_EMP_Map structure are: v CICS_EMP_CLOCK_TYPE_MASK v CICS_EMP_GROUP_MASK v CICS_EMP_TDQ_DETAIL_TYPE_MASK v CICS_EMP_FID_MASK Note: Dictionary, EIB, and SystemData must be treated as read-only by the user exit functions. 2. The enter API function Function prototype
#include <cics_emp.h> CICS_EMP_Return_t CICS_EMP_EnterAPI (IN struct CICS_EMP_ENTER_API_Data *EnterData ,INOUT void **SaveSpace ,INOUT int *ErrorCode );
The parameters passed by CICS to this function are:
402
SaveSpace This is the address of the user programs private data for the task. EnterData This is a pointer to the information from the EXEC CICS ENTER command. The information is: ID The 16-bit EMP identication number in the range 0 through 255.
EntryName The eight-character ENTRYNAME parameter of the EXEC CICS ENTER command. Data1 The DATA1 eld from the EXEC CICS ENTER command. This is the most signicant 32 bits from the FROM parameter. Data2 The DATA1 eld from the EXEC CICS ENTER command. This is the least signicant 32 bits from the FROM parameter. The parameters returned by this function are: Error Code If the Return_Code is not CICS_EMP_RETURN_OK or CICS_EMP_RETURN_WRITE, this is a pointer to an error code which CICS writes as part of a message. Return_Code This is the return code returned by the function. It is one of: CICS_EMP_RETURN_OK The function completed successfully. CICS_EMP_RETURN_FAIL The function detected an error. CICS will disable user EMPs for this region. CICS_EMP_RETURN_DISABLE The function completed successfully but CICS will disable monitoring for this task. CICS_EMP_RETURN_WRITE The function completed successfully. CICS writes a monitoring record at this point. This return value causes CICS to call WriteRecord to obtain the user data record. 3. The writerecord function Function prototype
#include <cics_emp.h> CICS_EMP_Return_t CICS_EMP_WriteRecord ( OUT void **UserData, OUT short *UserDataLength, IN struct CICS_EMP_PerformanceClass *SystemData,
403
IN INOUT OUT IN ); int *UnSupportedFlds, void **SaveSpace, int *ErrorCode, const struct CICS_EMP_Map *Dictionary
The parameters passed by CICS to this function are: SystemData This is a pointer to the performance class monitoring structure. The address of the SystemData is constant for the life of the transaction. The Monitor Field Table details this. SaveSpace This is the address of the user programs private data for the task. The parameters returned by this function are: Return_Code This is the return code returned by the function. It is one of: CICS_EMP_RETURN_OK The function completed successfully. CICS_EMP_RETURN_FAIL The function detected an error. CICS will disable user EMPs for this region. CICS_EMP_RETURN_DISABLE The function completed successfully but CICS will disable monitoring for this task. UserData If the function returns CICS_EMP_RETURN_OK, this parameter contains a pointer to the User Data record which CICS writes to the monitoring Transient Data (TD) Queue. If this parameter is null, CICS writes only the system monitoring data to the TD Queue. UserDataLength If the function returns CICS_EMP_RETURN_OK, this 16-bit parameter contains the length of the User Data record which CICS writes to the monitoring TD Queue. If this parameter is null, CICS only writes the system monitoring data to the TD Queue. Error Code If the Return_Code is not CICS_EMP_RETURN_OK, this is a pointer to an error code which CICS writes as part of a message.
404
Dictionary This contains information on how to interpret the SystemData. The address of the Dictionary is constant for the life of the CICS region. The mask denitions used to extract data from the Dictionary CICS_EMP_Map structure are: v CICS_EMP_CLOCK_TYPE_MASK v CICS_EMP_GROUP_MASK v CICS_EMP_TDQ_DETAIL_TYPE_MASK v CICS_EMP_FID_MASK Note: Dictionary, SystemData, and UnsupportedFlds must be treated as read only by the user exit functions. 4. The restart function Function prototype
#include <cics_emp.h> CICS_EMP_Return_t CICS_EMP_Restart (IN enum CICS_EMP_Finish Action ,INOUT void **SaveSpace ,INOUT int *ErrorCode );
The parameters passed by CICS to this function are: SaveSpace This is the address of the user programs private data for the task. FinishAction CICS passes one of two possible values to the function to indicate the functionality required: CICS_EMP_FINISH_RESTART Restart any clocks or counters stopped by the preceding WriteRecord call. CICS_EMP_FINISH_CLEANUP Perform any cleanup functions required to terminate the task. The parameters returned by this function are: Error Code If the Return_Code is not CICS_EMP_RETURN_OK, this is a pointer to an error code which CICS writes as part of a message. Return_Code This is the return code returned by the function. It is one of:
405
CICS_EMP_RETURN_OK The function completed successfully. CICS_EMP_RETURN_FAIL The function detected an error. CICS will disable user EMPs for this region. CICS_EMP_RETURN_DISABLE The function completed successfully but CICS will disable monitoring for this task. See the CICS Administration Guide for related information.
When the performance monitoring program is accessed

CICS calls the Initialization function within the Performance Monitoring user program at the start of each transaction, so that the user program can perform any Event Monitoring Point (EMP) specic initialization. CICS calls the Performance Monitoring user program during the execution of a task under each of four conditions: v The user application issues an EXEC CICS ENTER command. CICS calls the EnterAPI function within the Performance Monitoring user program. One of the return conditions from this function causes CICS to write a Monitoring Record. v At the end of the task. After preparing the Performance part of the Monitoring record, CICS calls the WriteRecord function within the user program, to retrieve the user data. On completion of the write to the Transient Data Queue (TD Queue), CICS calls the Restart function within the user program to release any resources it has acquired. v The user program requests that CICS write a monitoring record. The EnterAPI function within the user program, returns a request to write a Monitoring record. CICS builds a record from user-selected Performance Monitoring information and calls the WriteRecord function within the user program. On completion of the write to the TD Queue, CICS calls the Restart function within the user program to restart or reset any information stopped by the write request. v The CICS event monitoring function detects an error. If CICS disables the Performance Monitoring in response to an error condition it detects, it also calls the Restart function within the user program to release any resources it has acquired. See the CICS Administration Guide for related information.
406
Chapter 6. User exits

A user exit point (normally referred to as a user exit) is a place in a CICS module at which CICS can transfer control to a program that you have written (a user exit program), and at which CICS can resume control when your exit program has nished its work. You do not have to use any of the user exits, but you can use them to extend and customize the function of your CICS system according to your own requirements. For example, you may wish to log the completion of each task or take some action if a task completes abnormally. To do this you write a user exit program to be invoked at the task termination user exit and you set the UserExitNumber attribute in the Program Denition of the program to 15, the number that identies the task termination user exit. Each user exit has a unique number and name and is normally referred to by its user exit number which forms the last three characters of its name. The format of a user exit name is:
UEcccnnn
where ccc is the module identier of the CICS component that invokes the user exit program and nnn is the user exit number, padded to a length of three characters with leading zeroes. The following table shows the numbers and names of the user exits:
User Exit Number 15 17 25 50 51 52 53 31 User Exit Name UE014015 UE052017 UE014025 UE015050 UE016051 UE115052 UE115053 UEI09031 Description Task termination Dump request Dynamic transaction routing Dynamic distributed program link Syncpoint IIOP security exit IIOP certicate exit FEPI data conversion
For more information on how to make use of user exits, and the rules governing the writing of user exit programs, see the CICS Administration Guide. For information about the IIOP user exits, see the CICS IIOP ORB Programming Guide.
407
User exits Standard denitions and data types

The supplied cicstype.h le must be used when dening parameters in the header and specic parameter lists.
Constants
The following constants are dened for user exits
#define #define #define #define #define #define #define #define #define cics_UE_NAME_MAX 8 /* max length of UE name */ cics_UE_TRAN_MAX 4 /* transaction name max length */ cics_UE_USER_MAX 8 /* userid max length */ cics_UE_TERM_MAX 4 /* termid max length */ cics_UE_PROG_MAX 8 /* application program name max length */ cics_UE_SYSID_MAX 4 /* Max length of a sysid */ cics_UE_APPL_MAX 8 /* Max length of a region name */ cics_UE_HEADER_VERSION 1 /* all version number start at 1 */ cics_UE_WORKAREA_SIZE 128 /* fixed size for this version */
The return code from all user exit functions is

cics_UE_Return_t;
The denition of each user exit species which return codes are supported and the subsequent behavior for each. The following values are provided for cics_UE_Return_t
#define #define #define #define #define #define #define #define #define UE_Normal UE_Bypass UE_Abend UE_Shortonstorage UE_Term_Abend UE_Terminate UE_ProgramNotKnown UE_HeaderVersion UE_SpecificVersion (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) (cics_UE_Return_t) 0 1 2 3 4 5 6 7 8
typedef enum UE_YesNo { UE_Yes, UE_No } cics_UE_YesNo_t;
Standard header structure

The following standard header structure is passed to all user exits to provide information, which is standard for all user exits, in a consistent manner across the product. These are all input-only parameters.
typedef struct { cics_ushort_t cics_ulong_t UE_Version; UE_ProcessId;
408
User exits
cics_ulong_t cics_ushort_t cics_char_t cics_char_t cics_ulong_t cics_char_t cics_ushort_t cics_UE_YesNo_t cics_char_t cics_UE_Header_t; UE_Thread; UE_Number; UE_Name[cics_UE_NAME_MAX+1]; UE_TransId[cics_UE_TRAN_MAX+1]; UE_TaskNo; UE_Workarea; UE_WorkareaSize; UE_TraceOnExit; UE_RegionName[cics_UE_APPL_MAX+1];
The elds in cics_UE_Header_t are dened as follows: UE_Version is the version number for this structure and takes the value dened in cics_UE_HEADER_VERSION. It is advisable to check this in user exit programs to ensure that the version number passed when the user exit is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then contents of elds are unpredictable and the UE program should be regenerated using the correct version of cicsue.h. UE_ProcessId is the id of the process which has invoked the user exit. UE_Thread is the id of the thread in which the user exit is invoked. UE_Number is a number which uniquely identies the user exit which has been invoked. Refer to the denition for that user exit in order to determine the name of the exit-specic structure which is passed to the user exit and the name of the function which the associated user exit program must contain. UE_Name is the name of the user exit as it appears in dumps, traces, and the exit-specic structure. UE_Transid is the transaction which was active when the user exit was invoked. All user exits have an associated transaction. UE_TaskNo provides a unique number for the task associated with the user exit. All user exits have an associated task number. UE_Workarea is a pointer to the workarea associated with user exits for this task. It can be used to pass information between user exits for the same task and is also useful when debugging user exit programs. The workarea is located in storage immediately after the cics_UE_header storage;
409
User exits
both areas are traced when an A15Z abend is issued, if trace is active for the component which called the user exit at which the A15Z was caught. It can also be traced based on the setting of UE_TraceOnExit. All user exits have an associated task. The workarea will be reinitialized between tasks. You must control the usage of this workarea between user exits. It can be used creatively when debugging user exit programs. UE_WorkareaSize is the size of the user exit workarea. This is a xed length of 128 bytes. UE_TraceOnExit On entry to a user exit this eld is set to UE_No. It can be altered by the user exit program to UE_Yes, which will cause the header and specic parameter lists to be traced on exit (if product trace is active). UE_RegionName The name of the CICS region.
Task termination user exit (UE014015)

The task termination user exit is invoked at normal and abnormal task termination (after any syncpoint has been taken). You should ensure that no recoverable work is done in the user exit program.
Function prototype
cics_UE_return_t UE014015( /*IN*/ cics_UE_Header_t *cics_UE_Header, /*IN*/ cics_UE014015_t *cics_UE_Specific );
Exit-specic constants
#define cics_UE014015_VERSION 2 /* all version numbers start at 2 */ typedef enum { UE_Normaltermination, UE_Abnormaltermination } cics_UE_Terminationtype_t;
Exit-specic structure
typedef struct { cics_ushort_t UE_Version; cics_UE_Terminationtype_t UE_Terminationtype; } cics_UE014015_t;
410
Task termination user exit (15) Fields in exit-specic structure

UE_Version is the version number for this structure and takes the value dened in cics_UE014015_VERSION. It is advisable to check this in user exit programs to ensure that the version number passed when the user exit program is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then contents of elds are unpredictable and the user exit program should be regenerated using the correct version of cicsue.h. UE_Terminationtype is the type of task termination. It can take the values of UE_Normaltermination the task ended in a controlled manner. This may include a task abnormal termination. UE_Abnormaltermination an error occurred during task termination.
Return codes
UE_Normal Continue processing. other Continue processing; this cannot be guaranteed in future releases.
Dump request user exit (UE052017)

The dump request user exit is invoked immediately before a system or transaction dump is taken.
Function prototype
cics_UE_Return_t UE052017 ( ); /*IN*/ cics_UE_Header_t *cics_UE_Header, /*IN*/ cics_UE052017_t *cics_UE_Specific
#define cics_UE_DUMP_MAX 4 /* max length of dump code name */ #define cics_UE052017_VERSION 1 /* all version numbers start at 1 */ typedef enum UE_DumpReason { UE_DUMP_USER, /* UE_DUMP_ABEN, /* UE_DUMP_ASRA, /* UE_DUMP_ASRB, /*
EXEC CICS DUMP issued Transaction abend occurred Transaction abend ASRA occurred not issued currently
*/ */ */ */
411
Dump request user exit (17)

UE_DUMP_SNAP, /* CEMT PERF SNAP requested UE_DUMP_SHUT, /* Shutdown dump UE_DUMP_SYSA /* System abend occurred } cics_UE_DumpReason_t; */ */ */
typedef struct { cics_ushort_t UE_Version; cics_char_t UE_User[cics_UE_USER_MAX+1]; cics_char_t UE_Term[cics_UE_TERM_MAX+1]; cics_char_t UE_Prog[cics_UE_PROG_MAX+1]; cics_char_t UE_Dumpcode[cics_UE_DUMP_MAX+1]; cics_UE_DumpReason_t UE_DumpReason; cics_char_t *UE_CWA; cics_ushort_t UE_CWALEN; cics_char_t *UE_TCATWA; cics_ushort_t UE_TCATWA_LEN; cics_UE_YesNo_t UE_TransDump; } cics_UE052017_t;
Fields in exit-specic structure

UE_Version Is the version number for this structure and takes the value dened in cics_UE052017_VERSION. It is advisable to check this in user exit programs to ensure that the version number passed when the user exit is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then the contents of elds are unpredictable and the user exit program should be regenerated using the correct version of cicsue.h. UE_User User ID. UE_Term Terminal ID. This parameter is only valid for terminal attached tasks, being set to otherwise. UE_Prog Name of the application program. This parameter may not be valid for system dumps, when it will be set to . UE_Dumpcode Dump code. UE_DumpReason Dump reason, as dened for UE_Dump_reason. *UE_CWA Pointer to CWA.
412
Dump request user exit (17)

UE_CWALEN Length of CWA. *UE_TCATWA Pointer to TWA. UE_TCATWA_LEN Length of TWA. UE_TransDump This parameter only has meaning for transaction dumps. It is extracted from the TransDump attribute of the Transaction Denition. This parameter cannot be altered within a user exit program.
Return codes
UE_normal Continue processing. UE_bypass Suppress dump. other Continue processing; this cannot be guaranteed for future releases.
Dynamic transaction routing user exit (UE014025)

The dynamic transaction routing user exit is invoked for four different cases: v Just prior to a transaction dened as dynamic in its Transaction Denition being run either locally or remotely. v After a failed attempt to route a dynamic transaction to a remote system. v After a successful invocation of a dynamic transaction (remotely or locally) but transaction failure is detected. v After successful execution of a dynamic transaction.
Function Prototype
cics_UE_return_t UE014025 ( ); /*IN*/ UE_header_t /*INOUT*/ UE014025_t *UE_header, *UE_specific
Constants used in declaring the exit-specic structure:
#define cics_UE_ABND_MAX 4 /* Max length of an abend code */ #define cics_UE_USERAREA_SIZE 128 /* User Exit user area size */ #define cics_UE014025_VERSION 1 /* All version numbers start at 1 */
Constants indicating why UE014025 was invoked:
413
Dynamic transaction routing user exit (25)

typedef enum cics_UE_Func { UE_ROUTESEL, /* UE_RTESELERR, /* UE_ROUTETERM, /* UE_RTERESVD, /* UE_RTEABEND /* * * } cics_UE_Func_t;
Route selection */ Error in route selection */ Successful end of dynamic route */ Not used */ The transaction has abended locally, or some failure occurred during the routing of the transaction to a remote system */
Constants indicating the reason for connection failure:

typedef enum cics_UE_Error { UE_SYSID_UNKNOWN, UE_SYSID_OUT_SRV, UE_CON_FAILURE, UE_NO_ERROR } cics_UE_Error_t; /* /* /* /* System identifier was not found */ System was out-of-service */ Unable to connect or connection failure */ No route selection error has occurred */
typedef struct { cics_ushort_t cics_UE_Func_t cics_ushort_t cics_char_t cics_ubyte_t cics_ushort_t cics_char_t cics_ushort_t cics_char_t cics_char_t cics_UE_YesNo_t cics_UE_YesNo_t cics_UE_Error_t cics_char_t cics_char_t cics_char_t cics_char_t cics_ushort_t cics_char_t cics_ushort_t } cics_UE014025_t; UE_Version; UE_Dyrfunc; UE_Dyrcount; UE_Dyrsysid[cics_UE_SYSID_MAX+1]; *UE_Dyrtptr; UE_Dyrtlgth; *UE_Dyrcwaptr; UE_Dyrcwalgth; UE_Dyrlclsys[cics_UE_SYSID_MAX+1]; UE_Dyrlclapl[cics_UE_APPL_MAX+1]; UE_Dyropter; UE_Dyrretry; UE_Dyrerror; UE_Dyrtran[cics_UE_TRAN_MAX+1]; UE_Dyrprog[cics_UE_PROG_MAX+1]; UE_Dyrabcde[cics_UE_ABND_MAX+1]; *UE_Dyruser; UE_Dyrusersize; *UE_Dyrcomptr; UE_Dyrcomlgth;

UE_version (Input parameter only) is the version number for this structure and takes the value dened in cics_UE014025_VERSION. It is advisable to check this in user exit programs to ensure that the version number passed when the user exit is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then
414

the contents of elds are unpredictable and the user exit program should be regenerated against the correct version of cicsue.h. UE_Dyrfunc (Input parameter only) tells you the reason for this invocation of the dynamic transaction routing program. The possible values are: UE_ROUTESEL Invoked for transaction routing. UE_RTESELERR Invoked because an error occurred in route selection. UE_ROUTETERM Invoked because a previously routed transaction has terminated. UE_RTEABEND Invoked because the routed transaction abended. UE_Dyrcount (Input parameter only) is a count of the times the dynamic transaction routing program has been invoked for routing purposes for this transaction with UE_Dyrfunc set to UE_ROUTESEL, UE_RTEABEND or UE_RTESELERR. This option is provided to allow you to limit the number of retry requests. UE_Dyrsysid identies a CICS system. The exact meaning of this parameter depends on the value for UE_Dyrfunc: v When UE_Dyrfunc is set to UE_ROUTESEL, UE_Dyrsysid contains: The remote CICS system identier as specied on the RemoteSysId attribute of the installed transaction denition, or, The system identier of the local CICS system if RemoteSysId is not specied. The dynamic transaction routing program can accept this value or change it before returning to CICS. If the system identier you return to CICS is the same as the local system identier, CICS runs the transaction in the local system. v When UE_Dyrfunc is set to UE_RTESELERR, UE_Dyrsysid contains the CICS system identier returned to CICS by the dynamic transaction routing program on its previous invocation, and the system identier is found to be in error. The action that your dynamic transaction routing program can take when UE_Dyrfunc is UE_RTESELERR depends on the UE_Dyrerror parameter setting: If UE_Dyrerror is set to UE_SYSID_UNKNOWN (unknown system identier) or to UE_SYSID_OUT_SRV (CICS system out-of-service)
415

and you want CICS to retry transaction routing, you must change UE_Dyrsysid before returning to CICS. If UE_Dyrerror is set to UE_CON_FAILURE (connection failure) you can retry the same system identier or you can change the value in UE_Dyrsysid. The transaction can be routed locally, by changing UE_Dyrsysid to be null or the identier of the local system. v When UE_Dyrfunc is set to UE_RTEABEND, UE_Dyrsysid contains the name of the CICS system on which the transaction abended. The transaction cannot be retried. v When UE_Dyrfunc is set to UE_ROUTETERM, UE_Dyrsysid contains the name of the CICS system on which the completed transaction executed. UE_Dyrtptr (Input parameter only) is a pointer to the TCTUA. UE_Dyrtlgth (Input parameter only) is the length of the TCTUA. UE_Dyrcwaptr (Input parameter only) is a pointer to the CWA. UE_Dyrcwalgth (Input parameter only) is the length of the CWA. UE_Dyrlclsys (Input parameter only) is the system identier of the local system. UE_Dyrlclapl (Input parameter only) is the applid name of the local system. UE_Dyropter species whether the dynamic transaction routing program is to be reinvoked when the routed transaction terminates either successfully or because of a transaction abend. The possible values are: UE_No The dynamic transaction routing program is not to be reinvoked. This is the default.
UE_Yes The dynamic transaction routing program is to be reinvoked. If you wish UE014025 to be reinvoked then UE_Dyropter must be set to UE_Yes on the initial invocation of the user exit. UE_Dyrretry indicates whether the dynamic transaction routing program should be reinvoked if a route selection error occurs. The possible values are:
416

UE_No The dynamic transaction routing program is not to be reinvoked. This is the default.
UE_Yes The dynamic transaction routing program is to be reinvoked. UE_Dyrerror (Input parameter only) is relevant only when UE_Dyrfunc is set to UE_RTESELERR. It indicates the type of error that occurred during the last attempt to route a transaction. The possible values are: UE_SYSID_UNKNOWN The selected system is unknown. UE_SYSID_OUT_SRV The selected system is out-of-service. UE_CON_FAILURE Unable to connect to remote system, or connection failure. UE_NO_ERROR No connection failure has occurred. UE_Dyrtran contains the remote transaction name. When UE_Dyrfunc is set to UE_ROUTESEL, UE_Dyrtran contains the remote transaction name specied in the RemoteName attribute of the installed Transaction Denition. Your dynamic transaction routing program can accept this remote transaction name, or supply a different transaction name for forwarding to the remote CICS system. You can change UE_Dyrtran on any call to the dynamic transaction routing program, though it is effective only when UE_Dyrfunc is set to UE_ROUTESEL, or UE_RTESELERR. If the transaction is to be routed to a remote system, and UE_Dyrtran is set to a null string, then the local transaction name is used as the remote transaction name. UE_Dyrprog is the name of the initial program associated with the transaction for which the dynamic transaction routing program is invoked, if the transaction is dened for dynamic routing. You can use this eld to specify the name of an alternative program to be run if the transaction is routed locally. For example, if all remote CICS systems are unavailable, and the transaction cannot be routed, you may want to run a program in the local system to send an appropriate message to the user. This defaults to the ProgName attribute dened in the Transaction Denition for the transaction. Note: UE_Dyrprog should never be returned containing a null string. If a null string is found when the parameter list is passed back to CICS then an abend and message will be issued.
417

UE_Dyrabcde (Input parameter only) if the transaction was routed locally, this eld contains the abend code of that transaction. If the transaction was routed remotely, this eld contains the abend code of the transaction routing session. UE_Dyruser is a pointer to a user area with a length of UE_Dyrusersize. CICS initializes this user area to zeroes before invoking the dynamic transaction routing program for a given task. This user area can be modied by the dynamic transaction routing program, returned to CICS, and is passed to subsequent invocations of the dynamic transaction routing program for a given transaction instance. If the user exit is traced then the user area itself is shown in the trace. UE_Dyrusersize (Input parameter only) This is the length of the user area. Initially this will be 128 bytes. UE_Dyrcomptr is a pointer to the transactions COMMAREA. UE_Dyrcomlgth is the length of the transactions COMMAREA.
Return Codes
UE_Normal Continue processing with parameters returned from the user exit program. UE_Terminate Terminate the dynamic transaction routing request. UE_Term_Abend Terminate the routing request with an abend and a message.
Dynamic distributed program link user exit (UE015050)

The dynamic distributed program link user exit is invoked for four different cases: v When CICS is about to link to a program. v When CICS is about to link to a program which does not have a Program Denition (PD). v After a succesful attempt to link to a program and the initial user exit program invocation requests re-invocation. v After a failed attempt to link to a program, if the initial user exit program invocation requests re-invocation.
418
Dynamic distributed program link user exit (50)

Notes: 1. dynamic distributed program link is abbreviated to dynamic DPL in this denition. 2. The application program which issues the EXEC CICS LINK command is called the linking program. 3. The application program which is linked to is called the linked-to program.
Function prototype
cics_UE_return_t UE015050 ( ); /*IN*/ UE_header_t /*INOUT*/ UE015050_t *UE_header, *UE_specific
#define cics_UE_DPLAREA_SIZE 128 /* User Exit user area size */ #define cics_UE015050_VERSION 1 /* All version numbers start at 1 */

typedef enum cics_UE_LinkFunc { UE_LINKSEL, UE_LINKUNKNOWN, UE_LINKTERM, UE_LINKABEND } cics_UE_LinkFunc_t;
Denitions: UE_LINKSEL Indicates that this is the initial invocation of the user exit program. The user exit program can make decisions about which system or program to link to. UE_LINKUNKNOWN Indicates that this is the initial invocation of the user exit program for a program to link to which does not have a Program Denition (PD). The user exit program can make decisions about which system or program to link to. UE_LINKTERM Indicates that the linked-to program completed successfully. UE_LINKABEND Indicates that the linked-to program did not complete successfully.
typedef struct { cics_ushort_t UE_Version;
419

cics_UE_LinkFunc_t cics_char_t cics_ubyte_t cics_ushort_t cics_char_t cics_ushort_t cics_char_t cics_char_t cics_UE_YesNo_t cics_char_t cics_char_t cics_char_t cics_ushort_t cics_ushort_t cics_char_t cics_ushort_t cics_char_t cics_char_t } cics_UE015050_t; UE_Dplfunc; UE_Dplsysid[cics_UE_SYSID_MAX+1]; *UE_Dpltptr; UE_Dpltlgth; *UE_Dplcwaptr; UE_Dplcwalgth; UE_Dpllclsys[cics_UE_SYSID_MAX+1]; UE_Dpllclapl[cics_UE_APPL_MAX+1]; UE_Dplopter; UE_Dplmirtran[cics_UE_TRAN_MAX+1]; UE_Dplprog[cics_UE_PROG_MAX+1]; *UE_Dplcomptr; UE_Dplcomlgth; UE_Dpldatlgth; *UE_Dpluser; UE_Dplusersize; UE_Dplinvokingpgm[cics_UE_PROG_MAX+1]; UE_Dpluserid[cics_UE_USER_MAX+1];

UE_Version (Input parameter only) is the version number for this structure and takes the value dened in cics_UE015050_VERSION. It is advisable to check this in the user exit program to ensure that the version number passed when the user exit is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then contents of elds are unpredictable and the user exit program should be regenerated using the correct version of cicsue.h. UE_Dplfunc(Input parameter only) tells you the reason for this invocation of the DPL user exit program. The possible values are: UE_LINKSEL Invoked for selection of link destination. UE_LINKUNKNOWN Invoked for selection of link destination for an undened program. UE_LINKTERM Invoked after successful return from a linked-to program. UE_LINKABEND Invoked after an unsuccessful return from a linked-to program. UE_Dplsysid identies the system identier of a CICS system to which to route the link request.
420

UE_Dpltptr (Input parameter only) is a pointer to the TCTUA. UE_Dpltlgth (Input parameter only) is the length of the TCTUA. UE_Dplcwaptr (Input parameter only) is a pointer to the CWA. UE_Dplcwalgth (Input parameter only) is the length of the CWA. UE_Dpllclsys (Input parameter only) is the system identier of the local system. UE_Dpllclapl (Input parameter only) is the applid name of the local system. UE_Dplopter species whether the dynamic DPL user exit program is to be reinvoked when the linked-to program terminates either successfully or unsuccessfully. The possible values are: UE_No The user exit program is not to be reinvoked. This is the default.
UE_Yes The user exit program is to be reinvoked. If you wish UE15050 to be reinvoked then UE_Dplopter must be set to UE_Yes on the initial invocation of the user exit program. UE_Dplmirtran contains the name of the mirror transaction on the remote system. See the CICS Administration Guide for a full description of this parameter. UE_Dplprog is the name of the program to be started by the EXEC CICS LINK. This eld can be used to change the name of the program on the local or the remote system. UE_Dplcomptr (Input parameter only) is a pointer to the COMMAREA. UE_Dplcomlgth (Input parameter only) is the length of the COMMAREA. UE_Dpluser is a pointer to a user area of length UE_Dplusersize. CICS initializes this user area to zeros before invoking the dynamic DPL user exit program for a given DPL request. This user area can be modied by the user exit program. It is then passed to the nal invocation of the user exit program for a given DPL request.
421

UE_Dplusersize (Input parameter only) This is the length of the user area. Initially this will be 128 bytes. UE_Dplinvokingpgm The name of the program that issued the EXEC CICS LINK command. After the LINK command has been shipped once this eld will contain the name of the mirror program. UE_Dpluserid The userid executing the EXEC CICS LINK command. If the request is to a remote system and the request is not already part of an existing logical unit of work to that system, this eld can be modied to execute the request under a different userid. See CICS Administration Guide for a full description of this parameter.
Return codes
UE_Normal Continue processing with parameters returned from the user exit program. UE_ProgramNotKnown Indicates that the program name passed to the user exit program is not valid and the linking program must be abended with an APCT abend. This will be most useful when the user exit program is called as CICS is about to link to a program which does not have a Program Denition (PD), and the user exit program cannot determine which program or system to link to.
Syncpoint user exit (UE016051)

The syncpoint user exit is invoked following an EXEC CICS SYNCPOINT command. The result of the EXEC CICS SYNCPOINT command is made available in this user exit program. It is not possible to alter the outcome of the EXEC CICS SYNCPOINT command in this user exit program.
Function prototype
cics_UE_return_t UE016051 ( /*IN*/ UE_header_t /*INOUT*/ UE016051_t ); *UE_header, *UE_specific
Constants used in declaring the user exit specic structure:
#define cics_UE016051_VERSION 1 /* All version numbers start at 1 */
422
Syncpoint user exit (51)

typedef enum UE_SyncType { UE_USER_SYNCPOINT } cics_UE_SyncType_t; /* Reason for UE invocation */
Constants indicating the result of the last syncpoint/rollback command.

typedef enum UE_SyncResp { UE_COMMITTED, UE_ROLLEDBACK, UE_ABEND } cics_UE_SyncResp_t;
Constants indicating the value of the Syncpoint attribute in the transactions Transaction Denition.
typedef enum UE_SyncTRPrompt { UE_PROMPT_FINISH, UE_NO_PROMPT_FINISH } cics_UE_SyncTRPrompt_t;
typedef struct { cics_ushort_t cics_UE_SyncType_t cics_UE_SyncResp_t cics_UE_SyncTRPrompt_t } cics_UE016051_t; UE_Version; UE_SyncType; UE_SyncResp; UE_SyncTRPrompt;

UE_Version (Input parameter only) is the version number for this structure and takes the value dened in cics_UE016051_VERSION. It is advisable to check this in the user exit program to ensure that the version number passed when the user exit is called is the same as that contained in the version of cicsue.h used when the program was generated. If a mismatch is detected then contents of elds are unpredictable and the user exit program should be regenerated using the correct version of cicsue.h. UE_SyncType (Input parameter only) tells you the reason for this invocation of the syncpoint user exit program. The possible values are: UE_USER_SYNCPOINT Invoked for an EXEC CICS SYNCPOINT command. UE_SyncResp (Input parameter only) contains the result of the last syncpoint/rollback API command. The possible values are:
423
Syncpoint user exit (51)

UE_COMMITTED The last syncpoint was committed. UE_ROLLEDBACK The last syncpoint was a Rollback. UE_ABEND The last syncpoint failed, so therefore investigate the circumstances of this failure. UE_SyncTRPrompt (Input parameter only) contains the Syncpoint attribute from the transactions Transaction Denitions (TD) entry. The possible values are: UE_PROMPT_FINISH The syncpoint has been completed on all distributed systems. UE_NO_PROMPT_FINISH The syncpoint may not yet have completed on all distributed systems.
Return codes
UE_Normal Continue processing.
424
Chapter 7. The CICS monitoring data formatter offline utilities

This topic describes functions for reading and processing monitoring and statistics les.
Monitoring data formatter functions

The object library, prodDir/ lib/ libcicsmfmtsa.a, contains the functions used by cicsmfmt for reading and processing a Monitoring Data le. The following functions are provided: CICS_MFMT_OpenMonitorFile Opens a Monitoring Data le stream. CICS_MFMT_ReadNext Reads the next record from a Monitoring Data le. CICS_MFMT_FindField Finds the detail sub-record for a specied eld in a record. CICS_MFMT_CloseMonitorFile Closes a Monitoring Data stream. CICS_MFMT_GetMessage Gets the message text from the cicsmfmt message catalog. CICS_MFMT_FreeMessage Frees the memory allocated for a message text obtained from CICS_MFMT_GetMessage. CICS_MFMT_ReleaseCatalogue Closes the cicsmfmt message catalog opened by a previous CICS_MFMT_GetMessage call. See the CICS Administration Guide for related information.
425
CICS_MFMT_OpenMonitorFile and CICS_MFMT_CloseMonitorFile CICS_MFMT_OpenMonitorFile and CICS_MFMT_CloseMonitorFile
Syntax
#include <cicsmfmt.h> CICS_MFMT_Stream_t * CICS_MFMT_OpenMonitorFile(cics_char_t *FileName, enum CICS_MFMT_Status *Status); int CICS_MFMT_CloseMonitorFile (CICS_MFMT_Stream_t *Stream);
CICS_MFMT_OpenMonitorFile opens the Monitoring Data le, FileName, and reads in the rst record. It returns a pointer to identify the Monitoring File Stream in subsequent operations (see CICS_MFMT_ReadNext on page 427). If CICS_MFMT_OpenMonitorFile cannot open the le specied or the le does not contain monitoring data, it returns NULL and the Status parameter is set to indicate the cause of the failure. If this eld is set to CICS_MFMT_STATUS_SYS_ERROR, the environment variable errno contains the error code returned by the operating system. Note that variable length records written by CICS to an extrapartition Transient Data Queue have the record length in the rst four bytes. This is in addition to the record length and signature which start the Monitoring record, as dened by CICS_EMP_MonitoringRecord. CICS_MFMT_CloseMonitorFile closes the Monitoring Data le stream identied by Stream and releases any memory buffers associated with the stream.
Return codes
Upon successful completion, CICS_MFMT_OpenMonitorFile returns a pointer to a CICS_MFMT_Stream_t object, which is used to access the le via the CICS_MFMT_ReadNext and CICS_MFMT_FindField functions. CICS_MFMT_OpenMonitorFile returns a value of NULL if an error is detected or the le does not contain monitoring data. The Status parameter indicates the cause of the failure to open the le: CICS_MFMT_STATUS_SYS_ERROR CICS_MFMT_OpenMonitor File detected an error and the global variable errno contains the operating system error code.
426
CICS_MFMT_OpenMonitorFile and CICS_MFMT_CloseMonitorFile

CICS_MFMT_STATUS_FILE_EOF CICS_MFMT_OpenMonitorFile detected an unexpected EOF. CICS_MFMT_STATUS_FILE_ERROR CICS_MFMT_OpenMonitorFile detected an invalid Monitoring record. CICS_MFMT_CloseMonitorFile returns 0 if the monitor le is closed successfully, otherwise a value of -1 is returned and the global variable errno contains the operating system error code. See the CICS Administration Guide for related information.
CICS_MFMT_ReadNext
Syntax
#include <cicsmfmt.h> enum CICS_MFMT_Status CICS_MFMT_ReadNext (CICS_MFMT_Stream_t *Stream);
CICS_MFMT_ReadNext reads the next record from the Monitoring Data le specied by Stream into the FileBuffer member of the structure.
Return codes
CICS_MFMT_STATUS_OK The read succeeded. CICS_MFMT_STATUS_EOF The end of the le was reached. CICS_MFMT_STATUS_SYS_ERROR CICS_MFMT_ReadNext detected an error and the global variable errno contains the operating system error code. CICS_MFMT_STATUS_FILE_EOF CICS_MFMT_ReadNext detected an unexpected EOF. CICS_MFMT_STATUS_FILE_ERROR A corrupt Monitoring record was detected. See the CICS Administration Guide for related information.
427
CICS_MFMT_FindField CICS_MFMT_FindField
Syntax
#include <cicsmfmt.h> CICS_EMP_TDQ_RecordDetails_t * CICS_MFMT_FindField (cics_ulong_t FieldID ,CICS_MFMT_Stream_t *Stream );
CICS_MFMT_FindField searches the Monitoring record given by the Monitoring File Stream (Stream) for the detail sub-record whose ID matches that specied by FieldID.
Return codes
Upon successful completion, CICS_MFMT_FindField returns a pointer to the CICS_EMP_TDQ_RecordDetails_t object containing the data for the specied eld ID. A value of NULL is returned if no eld matching the specied ID is found in the record. See the CICS Administration Guide for related information.
CICS_MFMT_GetMessage, CICS_MFMT_FreeMessage, and CICS_MFMT_ReleaseCatalogue
Syntax
#include <cicsmfmt.h> char void void *CICS_MFMT_GetMessage (int MessageNumber, int SetNumber); CICS_MFMT_FreeMessage (char *Message); CICS_MFMT_ReleaseCatalogue (void);
These functions support the message catalog for cicsmfmt. CICS_MFMT_GetMessage retrieves a message from the cicsmfmt message catalog and returns a copy of the message text in a string allocated by the malloc command. MessageNumber gives the message number and SetNumber gives the message set number. If the function cannot nd one of the InfEV error messages, a copy of the US English message is returned.
428
CICS_MFMT_GetMessage, FreeMessage, and ReleaseCatalogue

CICS_MFMT_FreeMessage releases the space acquired for a message obtained by a previous CICS_MFMT_GetMessage call. The parameter Message gives the messages space to release. CICS_MFMT_ReleaseCatalogue closes any message catalogue opened by a previous CICS_MFMT_GetMessage call. Note that the buffer allocated by CICS_MFMT_GetMessage for the message text should be released via CICS_MFMT_FreeMessage when it is no longer required.
Return codes
Upon successful completion, CICS_MFMT_GetMessage returns a pointer to the malloced space containing the text of the message. If CICS_MFMT_GetMessage cannot open the message catalogue, cannot allocate space using the malloc command for the message, or cannot nd the message, it returns NULL. There is no return value from CICS_MFMT_ReleaseCatalogue. See the CICS Administration Guide for related information.
Statistics formatter functions

The object library, prodDir/ lib/ libcicssfmtsa.a (CICS on Open Systems), prodDir/ lib/ libcicssfmtsa.lib (CICS for Windows NT), contains the functions used by cicssfmt for reading and processing a statistics le. The following functions are provided: CICS_SFMT_OpenStatsFile Opens the statistics le and initializes the Record eld to zero. CICS_SFMT_FindRecord Finds the record given a specied eld. CICS_SFMT_CloseStatsFile Closes the statistics le. CICS_SFMT_ReadRecord Reads the next specied record from the Statistics le. CICS_SFMT_Msg2Int Obtains the message number and message set.
429
CICS_SFMT_OpenStatsFile and CICS_SFMT_CloseStatsFile

CICS_SFMT_OpenStatsFile and CICS_SFMT_CloseStatsFile
Syntax
#include <cicssfmt.h> enum CICS_SFMT_Status CICS_SFMT_OpenStatsFile (cics_char_t *FileName ,CICS_SFMT_File_t *StatsFileRecord ); enum CICS_SFMT_Status CICS_SFMT_CloseStatsFile (CICS_SFMT_File_t *StatsFileRecord);
CICS_SFMT_OpenStatsFile opens the statistics le, FileName sets the FileHandle and initializes the Record eld of the StatsFileRecord structure to zero if successful, or NULL if the open failed. CICS_SFMT_CloseStatsFile closes the statistics le, using the FileHandle from the StatsFileRecord.
Return codes
CICS_SFMT_STATUS_OK CICS_SFMT_OpenStatsFile opened the statistics le successfully. CICS_SFMT_FILE_ERR CICS_SFMT_OpenStatsFile detected an error attempting to open the statistics le. The global variable errno contains the operating system error code. CICS_SFMT_STATUS_OK CICS_SFMT_CloseStatsFile closed the statistics le successfully. CICS_SFMT_FILE_ERR CICS_SFMT_CloseStatsFile detected an error attempting to close the statistics le. The global variable errno contains the operating system error code.
430
CICS_SFMT_FindRecord CICS_SFMT_FindRecord
Syntax
#include <cicssfmt.h> enum CICS_SFMT_Status CICS_SFMT_FindRecord (time_t StartTime ,time_t EndTime ,CICS_SFMT_File_t *StatsFileRecord );
CICS_SFMT_FindRecord searches the statistics le specied by the FileHandle in the StatsFileRecord structure, to obtain the record that indicates the start of statistics collection in the time interval specied by StartTime and EndTime. It uses CICS_SFMT_ReadRecord to read records from the statistics le.
Return codes
CICS_SFMT_STATUS_OK CICS_SFMT_FindRecord has located the statistics record successfully. CICS_SFMT_FILE_ERR CICS_SFMT_FindRecord detected an invalid statistics record. CICS_SFMT_FILE_SHORT_READ CICS_SFMT_FindRecord detected an unexpected EOF. CICS_SFMT_REC_NOT_FOUND CICS_SFMT_FindRecord was unable to nd the specied record in the le.
CICS_SFMT_ReadRecord
Syntax
#include <cicssfmt.h> enum CICS_SFMT_Status CICS_SFMT_ReadRecord (CICS_SFMT_File_t *StatsFileRecord);
CICS_SFMT_ReadRecord reads the next record from the Statistics le specied by the FileHandle member of the StatsFileRecord into the Record member of the structure.
431
CICS_SFMT_ReadRecord Return codes

CICS_SFMT_STATUS_OK CICS_SFMT_ReadRecord read the statistics record successfully. CICS_SFMT_FILE_ERR CICS_SFMT_ReadRecord detected a read error, and the global variable errno contains the operating system error code. CICS_SFMT_FILE_SHORT_READ CICS_SFMT_ReadRecord encountered EOF before a complete record could be read. This is indicative of an inconsistent statistics le. CICS_SFMT_FILE_ZERO_READ CICS_SFMT_ReadRecord did not read any data, because EOF was detected.
CICS_SFMT_Msg2Int
Syntax
#include <cicssfmt.h> void CICS_SFMT_Msg2Int(CICSSTAT_Mesg_t MsgIndex ,int MsgNumber ,int MsgSet );
CICS_SFMT_Msg2Int obtains the NLS format of MsgNumber and the MsgSet based on the MsgIndex, for example, the Category or the Description elds of the CICS_SFMT_StatsRecord_t structure.
Return codes
None.
432
Chapter 8. The statistics records

This chapter describes the collected statistics records. See the CICS Administration Guide for information about how to collect statistic and to format a report.
About the statistics records

The tables in this section contain the following information: Statistic ID The statistic ID is a unique identier describing the instance of statistical data. It can be used for manipulating the statistic data returned from the EXEC CICS COLLECT STATISTIC API call, as described in the CICS Application Programming Reference. It may also be used in a statistics formatting program. This is demonstrated in the cicssfmt sample program (see cicssfmt - Statistics formatter on page 221). C and COBOL The C and COBOL language names are the unique identiers used to access the statistics information from the respective high level languages. In each case the name corresponds to the unique statistic ID. Use of the C name is demonstrated in the cicssfmt sample program. Category Used in general statistics, this detail shows the statistic category. The categories are: v Dump v File v Intersystem communication v Journal v Logical unit of work (LUW) v Program v Runtime database v v v v v
Storage Task Transient data Terminal Transaction
433
v Temporary storage Message The statistic message is a default message from the main CICS message catalog, which a statistics formatter can use to describe the contents of the statistic. The sample program cicssfmt provides its own message catalog containing statistic messages, accessed with the statistic ID, but the default can be used if another catalog cannot be found. The message is detail is not used for general statistics. Explanation Explains what this statistic is used for.
General statistics
Table 10 lists the general statistic categories. Table 11 on page 438 lists the statistic types.
Table 10. Statistic categories
Statistic ID 010000 High-level language names, statistic category, explanation C COBOL CS-CATID-DUMP Category Dump Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the dump category. See Dump statistics on page 441. 020000 C COBOL CS-CATID-FILE Category File Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the le category. See File statistics on page 442. CICSSTAT_CATID_FILE CICSSTAT_CATID_DUMP
434
Table 10. Statistic categories (continued)

Statistic ID 030000 High-level language names, statistic category, explanation C COBOL CS-CATID-ISCM Category Intersystem communications management Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the intersystem category. See Intersystem communication (ISC) statistics on page 445. 040000 C COBOL CS-CATID-JOUR Category Journal Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the journal category. See Journal statistics on page 454. 050000 C COBOL CS-CATID-LUWM Category Logical units of work Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the logical units of work category. See Logical unit of work (LUW) statistics on page 457. 060000 C COBOL CS-CATID-PROG Category Runtime program Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the program category. See Program statistics on page 458. CICSSTAT_CATID_PROG CICSSTAT_CATID_LUWM CICSSTAT_CATID_JOUR CICSSTAT_CATID_ISCM
435

Statistic ID 070000 High-level language names, statistic category, explanation C COBOL CS-CATID-RTDB Category Runtime database Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the runtime database category. See Runtime database statistics on page 459. 080000 C COBOL CS-CATID-STOR Category Region storage Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the region and task shared aspect of the storage category. See Storage statistics on page 464. 090000 C COBOL CS-CATID-STOT Category Task private storage Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the task private aspect of the storage category. See Task statistics on page 473. 0A0000 C COBOL CS-CATID-TASK Category Task Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the task category. See Task statistics on page 473. CICSSTAT_CATID_TASK CICSSTAT_CATID_STOT CICSSTAT_CATID_STOR CICSSTAT_CATID_RTDB
436

Statistic ID 0B0000 High-level language names, statistic category, explanation C COBOL CS-CATID-TERM Category Terminal Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the terminal category. See Terminal statistics on page 476. 0C0000 C COBOL CS-CATID-TDQU Category Transient data queue Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the transient data queue category. See Transient data statistics on page 480. 0D0000 C COBOL CS-CATID-TRAN Category Transaction Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the transaction category. See Transaction statistics on page 483. 0E0000 C COBOL CS-CATID-TSQU Category Temporary storage queue Explanation: This is used as part of a statistics record to indicate that the record contains the statistics for the temporary storage queue category. See Temporary storage statistics on page 485. CICSSTAT_CATID_TSQU CICSSTAT_CATID_TRAN CICSSTAT_CATID_TDQU CICSSTAT_CATID_TERM
437
Table 11. Statistic types

Statistic ID 0F0000 High-level language names, statistic category, explanation C COBOL CS-CATID-INTERVAL Category Interval statistics collection Explanation: This is used as part of a statistics record to indicate the start of a interval statistics collection. 100000 C COBOL CS-CATID-ENDOFDAY Category End of day statistics collection Explanation: This is used as part of a statistics record to indicate the start of an end of day statistics collection. 110000 C COBOL CS-CATID-UNSOLICITED Category Unsolicited statistics collection Explanation: This is used as part of a statistics record to indicate the start of an unsolicited statistics collection. 120000 C COBOL CS-CATID-REQUESTED-RESET Category Requested statistics collection (counters reset) Explanation: This is used as part of a statistics record to indicate the start of a user-requested statistics collection that resets all of the statistics counters. CICSSTAT_CATID_REQUESTED_RESET CICSSTAT_CATID_UNSOLICITED CICSSTAT_CATID_ENDOFDAY CICSSTAT_CATID_INTERVAL
438
Table 11. Statistic types (continued)

Statistic ID 130000 High-level language names, statistic category, explanation C COBOL CS-CATID-REQUESTED Category Requested statistics collection Explanation: This is used as part of a statistics record to indicate the start of a user-requested statistics collection. 140000 C COBOL CS-CATID-ENDOFREGION Category Last end of day statistics collection Explanation: This is used as part of a statistics record to indicate the start of the end of day statistics collection that is taken at region shutdown. 150000 C COBOL CS-CATID-END Category End of the statistics collection Explanation: This is used as part of a statistics record to indicate the end of the statistics collection. 160000 C COBOL CS-CATID-TIME-NA Category Time unavailable Explanation: This is used as part of a statistics record to indicate that the time was unavailable when a start or stop label was generated. CICSSTAT_CATID_TIME_NA CICSSTAT_CATID_END CICSSTAT_CATID_ENDOFREGION CICSSTAT_CATID_REQUESTED
439

Statistic ID 170000 High-level language names, statistic category, explanation C COBOL CS-CATID-TIME-START Category Time started: Explanation: This is used as part of a statistics record to indicate the time that the statistics collection was started. 180000 C COBOL CS-CATID-TIME-STOP Category Time stopped: Explanation: This is used as part of a statistics record to indicate the time that the statistics was stopped. 190000 C COBOL CS-CATID-SUMMARY Category Summary record: Explanation: This is used as part of a statistics record to indicate that the following records in the statistics collection, are summary statistics. 1A0000 C COBOL CS-CATID-ALL-DETAILS Category All of the detail records: Explanation: This is used as part of a statistics record to indicate that the following records in the statistics collection, are detail statistics for individual resources. CICSSTAT_CATID_ALL_DETAILS CICSSTAT_CATID_SUMMARY CICSSTAT_CATID_TIME_STOP CICSSTAT_CATID_TIME_START
440

Statistic ID 1B0000 High-level language names, statistic category, explanation C COBOL CS-CATID-ONE-DETAIL Category One detail record: Explanation: This is used as part of a statistics record to indicate that the following records in the statistics collection, are detail statistics for a specic resource. CICSSTAT_CATID_ONE_DETAIL
Dump statistics
Dump statistics records number of dumps written and number of dump directory write errors.
Table 12. Dump statistics
Statistic ID 010000 High-level language names, statistic message, explanation C COBOL CS-DUMP-DUMPS-WRITTEN Message Number of dumps written Explanation: This is used in the statistics record to indicate the number of dumps that were written. 010001 C COBOL CS-DUMP-WRITE-ERRORS Message Number of dump directory write errors Explanation: Used in the statistics record to indicate the number of write errors that occurred while dumps were being taken. CICSSTAT_DUMP_WRITE_ERRORS CICSSTAT_DUMP_DUMPS_WRITTEN
441
File statistics
You can use le statistics to monitor input and output activity of application requests against your les. File statistics indicate the number of service requests that CICS processes against each le. If CICS totals the number of requests on every CICS invocation, you can monitor any changes that occur in the input and output activity for each le. Because these le statistics might have been reset during the day, see the summary report to obtain a gure of total activity against a particular le during the day. The statistics do not tell you directly how many input and output accesses CICS has performed for each transaction. You require a single-transaction measurement for this. Nevertheless, by regularly totalling the service requests against individual les, you can anticipate le problems that might occur when input and output activity increases. The statistical information provided by CICS for les lists the number of service requests processed against each le dened in the File Denitions (FD). The information is dependent on the types of request allowed on the le.
Table 13. File statistics
Statistic ID 020000 High-level language names, statistic message, explanation C COBOL CS-FILE-NOREADS Message Number of le control reads Explanation: This is used in the statistic record label to indicate the number of reads performed by le control. 020001 C COBOL CS-FILE-NOWRITES Message Number of le control writes Explanation: This is used in the statistic record label to indicate the number of writes performed by le control. CICSSTAT_FILE_NOWRITES CICSSTAT_FILE_NOREADS
442
Table 13. File statistics (continued)

Statistic ID 020002 High-level language names, statistic message, explanation C COBOL CS-FILE-NOBROWSES Message Number of le control browses Explanation: This is used in the statistic record label to indicate the number of browse operations performed by le control. It includes the number of READNEXT and READPREV requests only. It does not include the number of STARTBR, ENDBR, or RESETBR requests. 020003 C COBOL CS-FILE-NODELETES Message Number of le control deletes Explanation: This is used in the statistic record label to indicate the number of deletes performed by le control. 020004 C COBOL CS-FILE-NOUPDATES Message Number of le control updates Explanation: This is used in the statistic record label to indicate the number of updates performed by le control. 020005 C COBOL CS-FILE-NOOPENS Message Number of le control opens Explanation: This is used in the statistic record label to indicate the number of opens performed by le control. CICSSTAT_FILE_NOOPENS CICSSTAT_FILE_NOUPDATES CICSSTAT_FILE_NODELETES CICSSTAT_FILE_NOBROWSES
443

Statistic ID 020006 High-level language names, statistic message, explanation C COBOL CS-FILE-NOCLOSES Message Number of le control closes Explanation: This is used in the statistic record label to indicate the number of closes performed by le control. 020007 C COBOL CS-FILE-NOREADS-TOTAL Message Total number of le control reads Explanation: This is used in the statistic record label to indicate the number of reads performed by le control. 020008 C COBOL CS-FILE-NOWRITES-TOTAL Message Total number of le control writes Explanation: This is used in the statistic record label to indicate the total number of writes performed by le control. 020009 C COBOL CS-FILE-NOBROWSES-TOTAL Message Total number of le control browses Explanation: This is used in the statistic record label to indicate the total number of browses performed by le control. CICSSTAT_FILE_NOBROWSES_TOTAL CICSSTAT_FILE_NOWRITES_TOTAL CICSSTAT_FILE_NOREADS_TOTAL CICSSTAT_FILE_NOCLOSES
444

Statistic ID 02000A High-level language names, statistic message, explanation C COBOL CS-FILE-NODELETES-TOTAL Message Total number of le control deletes Explanation: This is used in the statistic record label to indicate the total number of deletes performed by le control. 02000B C COBOL CS-FILE-NOUPDATES-TOTAL Message Total number of le control updates Explanation: This is used in the statistic record label to indicate the total number of updates performed by le control. 02000C C COBOL CS-FILE-NOOPENS-TOTAL Message Total number of le control opens Explanation: This is used in the statistic record label to indicate the total number of opens performed by le control. 02000D C COBOL CS-FILE-NOCLOSES-TOTAL Message Total number of le control closes Explanation: This is used in the statistic record label to indicate the total number of closes performed by le control. CICSSTAT_FILE_NOCLOSES_TOTAL CICSSTAT_FILE_NOOPENS_TOTAL CICSSTAT_FILE_NOUPDATES_TOTAL CICSSTAT_FILE_NODELETES_TOTAL
Intersystem communication (ISC) statistics

Intersystem communication (ISC) statistics record both intersystem and intersession communication statistics. CICS provides statistics for each system entry dened in the Communications Denitions (CD).
445
Table 14. ISC statistics

Statistic ID 030000 High-level language names, statistic message, explanation C COBOL CS-ISCM-MAXNUMLQSR Message Maximum number of locally queued outbound function shipping requests Explanation: This is used in the statistic record to indicate the maximum number of function shipping requests that were locally queued. 030001 C COBOL CS-ISCM-NUMLQSR Message Number of locally queued outbound function shipping requests Explanation: This is used in the statistic record to indicate the number of function shipping requests that are currently queued. 030002 C COBOL CS-ISCM-NUMXMITLQSR Message Number of locally queued outbound function shipping requests transmitted Explanation: This is used in the statistic record to indicate the number of function shipping requests that have been sent to the remote systems. 030003 C COBOL CS-ISCM-PURGEDLQSR Message Number of locally queued outbound function shipping requests purged Explanation: This is used in the statistic record to indicate the number of locally queued function shipping requests that have been purged from the queue. CICSSTAT_ISCM_PURGEDLQSR CICSSTAT_ISCM_NUMXMITLQSR CICSSTAT_ISCM_NUMLQSR CICSSTAT_ISCM_MAXNUMLQSR
446
Table 14. ISC statistics (continued)

Statistic ID 030004 High-level language names, statistic message, explanation C COBOL CS-ISCM-NUMATTEMPTS Message Number of attempts to function ship a locally queued request to remote system Explanation: This is used in the statistic record to indicate the number of times a locally queued function ship request has been made to the remote system. 03000B C COBOL CS-ISCM-NUMALLOC Message Number of Distributed Transaction Processing (DTP) conversations allocated Explanation: This is used in the statistic record, to indicate the number of Distributed Transaction Processing (DTP) conversations that have been allocated. 03000C C COBOL CS-ISCM-NUMICES Message Number of Interval Control Elements in the chain Explanation: This is a statistic value which gives the current number of Interval Control Elements in the internal chain. 03000D C COBOL CS-ISCM-NUMENQRES Message Number of resources enqueued to date Explanation: This is a statistic value which gives the number total number of distinct resources that have been enqueued with EXEC CICS ENQ to date. CICSSTAT_ISCM_NUMENQRES CICSSTAT_ISCM_NUMICES CICSSTAT_ISCM_NUMALLOC CICSSTAT_ISCM_NUMATTEMPTS
447

Statistic ID 03000E High-level language names, statistic message, explanation C COBOL CS-ISCM-MAXICES Message Maximum number of Interval Control Elements in the chain Explanation: This is a statistic value which gives the maximum number of Interval Control Elements which have existed in the chain to date. 03000F C COBOL CS-ISCM-ENQWAIT Message Number of ENQ requests that waited for a resource Explanation: This is a statistic value which gives the number of EXEC CICS ENQ requests that waited until the specied resource was available. 030010 C COBOL CS-ISCM-LOCKWAIT Message Number of LOCK requests that waited for a resource Explanation: This is a statistic value which gives the number of internal lock requests that waited until the specied resource was available. 030011 C COBOL CS-ISCM-NFCIN Message Number of inbound function shipping File Control (FC) requests Explanation: This is used in the statistic record to indicate the number of File Control (FC) function shipping requests that were received from remote systems. CICSSTAT_ISCM_NFCIN CICSSTAT_ISCM_LOCKWAIT CICSSTAT_ISCM_ENQWAIT CICSSTAT_ISCM_MAXICES
448

Statistic ID 030012 High-level language names, statistic message, explanation C COBOL CS-ISCM-NFCOUT Message Number of outbound function shipping File Control (FC) requests Explanation: This is used in the statistic record to indicate the number of File Control (FC) function shipping requests that were sent to remote systems. 030013 C COBOL CS-ISCM-NFCXFR Message Number of forwarded function shipping File Control (FC) requests Explanation: This is used in the statistic record to indicate the number of File Control (FC) function shipping requests that were received from remote systems and forwarded on to others for processing. 030014 C COBOL CS-ISCM-NTDIN Message Number of inbound function shipping Transient Data (TD) queue requests Explanation: This is used in the statistic record to indicate the number of Transient Data (TD) queue function shipping requests that were received from remote systems. 030015 C COBOL CS-ISCM-NTDOUT Message Number of outbound function shipping Transient Data (TD) queue requests Explanation: This is used in the statistic record to indicate the number of Transient Data (TD) queue function shipping requests that were sent to remote systems. CICSSTAT_ISCM_NTDOUT CICSSTAT_ISCM_NTDIN CICSSTAT_ISCM_NFCXFR CICSSTAT_ISCM_NFCOUT
449

Statistic ID 030016 High-level language names, statistic message, explanation C COBOL CS-ISCM-NTDXFR Message Number of forwarded function shipping Transient Data (TD) queue requests Explanation: This is used in the statistic record to indicate the number of Transient Data (TD) queue function shipping requests that were received from remote systems and forwarded on to others for processing. 030017 C COBOL CS-ISCM-NTSIN Message Number of inbound function shipping Temporary Storage (TS) queue requests Explanation: This is used in the statistic record to indicate the number of Temporary Storage (TS) queue function shipping requests that were received from remote systems. 030018 C COBOL CS-ISCM-NTSOUT Message Number of outbound function shipping Temporary Storage (TS) queue requests Explanation: This is used in the statistic record to indicate the number of Temporary Storage (TS) queue function shipping requests that were sent to remote systems. 030019 C COBOL CS-ISCM-NTSXFR Message Number of forwarded function shipping Temporary Storage (TS) queue requests Explanation: This is used in the statistic record to indicate the number of Temporary Storage (TS) queue function shipping requests that were received from remote systems and forwarded on to others for processing. CICSSTAT_ISCM_NTSXFR CICSSTAT_ISCM_NTSOUT CICSSTAT_ISCM_NTSIN CICSSTAT_ISCM_NTDXFR
450

Statistic ID 03001A High-level language names, statistic message, explanation C COBOL CS-ISCM-NATIIN Message Number of inbound function shipping Interval Control (IC) requests Explanation: This is used in the statistic record to indicate the number of Interval Control (IC) function shipping requests that were received from remote systems. 03001B C COBOL CS-ISCM-NATIOUT Message Number of outbound function shipping Interval Control (IC) requests Explanation: This is used in the statistic record to indicate the number of Interval Control (IC) function shipping requests that were sent to remote systems. 03001C C COBOL CS-ISCM-NATIXFR Message Number of forwarded function shipping Interval Control (IC) requests Explanation: This is used in the statistic record to indicate the number of Interval Control (IC) function shipping requests that were received from remote systems and forwarded on to others for processing. 03001D C COBOL CS-ISCM-NDPLIN Message Number of inbound function shipping Distributed Program Link (DPL) requests Explanation: This is used in the statistic record to indicate the number of Distributed Program Link (DPL) function shipping requests that were received from remote systems. CICSSTAT_ISCM_NDPLIN CICSSTAT_ISCM_NATIXFR CICSSTAT_ISCM_NATIOUT CICSSTAT_ISCM_NATIIN
451

Statistic ID 03001E High-level language names, statistic message, explanation C COBOL CS-ISCM-NDPLOUT Message Number of outbound function shipping Distributed Program Link (DPL) requests Explanation: This is used in the statistic record to indicate the number of Distributed Program Link (DPL) function shipping requests that were sent to remote systems. 03001F C COBOL CS-ISCM-NDPLXFR Message Number of forwarded function shipping Distributed Program Link (DPL) requests Explanation: This is used in the statistic record to indicate the number of Distributed Program Link (DPL) function shipping requests that were received from remote systems and forwarded on to others for processing. 030020 C COBOL CS-ISCM-NDL1IN Message Number of inbound function shipping DL/1 requests Explanation: This is used in the statistic record to indicate the number of DL/1 function shipping requests that were received from remote systems and then rejected because DL/1 is not supported by CICS. 030021 C COBOL CS-ISCM-OUTTRREQ Message Number of outbound transaction routing requests that were sent Explanation: This is used in the statistic record, to indicate the number of Transaction Routing requests that were sent to the application owning region (AOR). CICSSTAT_ISCM_OUTTRREQ CICSSTAT_ISCM_NDL1IN CICSSTAT_ISCM_NDPLXFR CICSSTAT_ISCM_NDPLOUT
452

Statistic ID 030022 High-level language names, statistic message, explanation C COBOL CS-ISCM-INTRREQ Message Number of inbound transaction routing requests that were received Explanation: This is used in the statistic record, to indicate the number of Transaction Routing requests that were received from the Terminal Owning Region (TOR). 030023 C COBOL CS-ISCM-BPSDEFSENT Message Number of terminal denitions that were sent Explanation: This is used in the statistic record, to indicate the number of terminal denitions that were sent to the application owning region (AOR). 030024 C COBOL CS-ISCM-BPSDEFRECEIVED Message Number of terminal denitions that were received Explanation: This is used in the statistic record, to indicate the number of terminal denitions that were received from the Terminal Owning Region (TOR). 030025 C COBOL CS-ISCM-FORWARD Message Number of transaction routing requests that were forwarded Explanation: This is used in the statistic record, to indicate the number of transaction routing requests that have been forwarded to another, remote application owning region (AOR). CICSSTAT_ISCM_FORWARD CICSSTAT_ISCM_BPSDEFRECEIVED CICSSTAT_ISCM_BPSDEFSENT CICSSTAT_ISCM_INTRREQ
453
Journal statistics
CICS produces statistical information for every journal dened to a CICS region.
Table 15. Journal statistics
Statistic ID 040000 High-level language names, statistic message, explanation C COBOL CS-JOUR-CALLBACK-COUNT Message Number of requests to perform system log archive management Explanation: This is used in the statistic record to indicate the number of times the Log Service has called CICS with an archive management request during the selected period. 040001 C COBOL CS-JOUR-NOSPACE-TOTAL Message Number of journal NOSPACE conditions Explanation: This is used in the statistic record to indicate the total number of journal NOSPACE conditions arising during the selected period. These conditions arise when CICS is unable to write to a user journal because there is insufficient space available in the relevant le system. 040002 C COBOL CS-JOUR-NOSPACE-ITERATIONS-TTL Message Number of journal write retries attempted Explanation: This is used in the statistic record to indicate the number of unsuccessful attempts to write a record to a user journal due to NOSPACE conditions during the selected period. When a journal write fails because of a NOSPACE condition, the write is retried at intervals until space becomes available. CICSSTAT_JOUR_NOSPACE_ITERATIONS_TOTAL CICSSTAT_JOUR_NOSPACE_TOTAL CICSSTAT_JOUR_CALLBACK_COUNT
454
Table 15. Journal statistics (continued)

Statistic ID 040003 High-level language names, statistic message, explanation C COBOL CS-JOUR-CHECKPOINT-COUNT Message Number of CICS checkpoints written to the system log Explanation: This is used in the statistic record to indicate the number of CICS checkpoint operations (called activity keypoints in CICS/MVS terminology) performed during the selected period. 040004 C COBOL CS-JOUR-SYS-JRNL-PUTS-COUNT Message Number of records written to the system log Explanation: This is used in the statistic record to indicate the number of records written to the system log during the specied period. 040005 C COBOL CS-JOUR-BUFFERED-WRITES-TOTAL Message Number of buffered write requests to user journals Explanation: This is used in the statistic record to indicate the total number of records written in buffered mode (written by EXEC CICS JOURNAL commands without the WAIT option) to user journals during the specied period. 040006 C COBOL CS-JOUR-FLUSHED-WRITES-TOTAL Message Number of ushed write requests to user journals Explanation: This is used in the statistic record to indicate the total number of records written and ushed to user journals during the specied period. This gure is the sum of the number of records written by EXEC CICS JOURNAL commands specifying the WAIT option and the number of EXEC CICS WAIT JOURNAL commands which forced at least one buffered record to a journal. CICSSTAT_JOUR_FLUSHED_WRITES_TOTAL CICSSTAT_JOUR_BUFFERED_WRITES_TOTAL CICSSTAT_JOUR_SYS_JRNL_PUTS_COUNT CICSSTAT_JOUR_CHECKPOINT_COUNT
455

Statistic ID 040007 High-level language names, statistic message, explanation C COBOL CS-JOUR-IOERRORS-TOTAL Message Number of journal IOERR conditions Explanation: This is used in the statistic record to indicate the total number of user journal requests which were unsuccessful due to IOERR conditions during the specied period. 040008 C COBOL CS-JOUR-NOTAUTH-ATTEMPTS-TOTAL Message Number of unauthorized access attempts on journals Explanation: This is used in the statistic record to indicate the total number of user journal requests which were unsuccessful due to NOTAUTH conditions during the specied period. 040009 C COBOL CS-JOUR-BUFFERED-WRITES Message Number of buffered write requests to user journals Explanation: This is used in the statistic record to indicate the total number of records written in buffered mode (written by EXEC CICS JOURNAL commands without the WAIT option) to user journals during the specied period. 04000A C COBOL CS-JOUR-FLUSHED-WRITES Message Number of ushed write requests to user journals Explanation: This is used in the statistic record to indicate the total number of records written and ushed to user journals during the specied period. This gure is a summation of the number of records written by EXEC CICS JOURNAL commands specifying the WAIT option and the number of EXEC CICS WAIT JOURNAL commands which forced at least one buffered record to a journal. CICSSTAT_JOUR_FLUSHED_WRITES CICSSTAT_JOUR_BUFFERED_WRITES CICSSTAT_JOUR_NOTAUTH_ATTEMPTS_TOTAL CICSSTAT_JOUR_IOERRORS_TOTAL
456

Statistic ID 04000B High-level language names, statistic message, explanation C COBOL CS-JOUR-IOERRORS Message Number of journal IOERR conditions Explanation: This is used in the statistic record to indicate the total number of user journal requests which were unsuccessful due to IOERR conditions during the specied period. 04000C C COBOL CS-JOUR-NOTAUTH-ACCESSES Message Number of unauthorized access attempts Explanation: This is used in the statistic record to indicate the number of requests for a particular user journal which were unsuccessful due to NOTAUTH conditions during the specied period. 04000D C COBOL CS-JOUR-NOSPACE-CONDITIONS Message Number of NOSPACE conditions Explanation: This is used in the statistic record to indicate the number of unsuccessful attempts to write a record to a particular user journal, due to NOSPACE conditions during the selected period. CICSSTAT_JOUR_NOSPACE_CONDITIONS CICSSTAT_JOUR_NOTAUTH_ACCESSES CICSSTAT_JOUR_IOERRORS
Logical unit of work (LUW) statistics

CICS produces accumulated statistical information relating to all LUWs.
457
Table 16. Logical unit of work statistics

Statistic ID 050001 High-level language names, statistic message, explanation C COBOL CS-LUWM-NUM-ABORTED Message Number of Logical Units of Work which aborted Explanation: This is used in the statistic record, to indicate the number of Logical Units of Work which aborted during the selected period. 050003 C COBOL CS-LUWM-NUM-HITS Message Number of hashing algorithm hits Explanation: This is used in the statistic record to indicate the number of times that a hash table entry has been used to nd a transaction identier during the selected period. 050004 C COBOL CS-LUWM-MAX-CHAIN-LENGTH Message Maximum hash table chain length Explanation: This is used in the statistic record, to indicate the maximum number of active transaction identiers which have mapped to the same hash value during the selected period. After a hash table lookup, the chain of matching transaction identiers is searched by CICS using a linear search algorithm. This statistic therefore indicates how many lookups may be needed (worst case) to nd the required transaction identier in the table. CICSSTAT_LUWM_MAX_CHAIN_LENGTH CICSSTAT_LUWM_NUM_HITS CICSSTAT_LUWM_NUM_ABORTED
Program statistics
CICS produces statistical information for all programs dened in the Program Denitions (PD). You can use these statistics to assist in tuning the system and for accounting purposes. You can also use them to calculate the average interval between uses of a program by dividing the statistics interval time by the number of times a program is used.
458
Table 17. Program statistics

Statistic ID 060000 High-level language names, statistic message, explanation C COBOL CS-PROG-TOTAL-PROGS-RUN Message Total number of programs run Explanation: This is used in the statistic record to indicate the total number of programs run in the region so far. 060001 C COBOL CS-PROG-NUM-TIMES-USED Message Number of times program run Explanation: This is used in the statistic record to indicate the number of times a particular program has been run in the region. CICSSTAT_PROG_NUM_TIMES_USED CICSSTAT_PROG_TOTAL_PROGS_RUN
Runtime database statistics

CICS gathers statistics on the usage of the runtime database and the collision characteristics of the supporting hash table. The structure of each statistic is held in the individual hash table entry. CICS accumulates statistics from the hash entries for both a single class or all classes, and collects incremental statistics to count the calls to several functions within the CICS database class module.
Table 18. Runtime database statistics
Statistic ID 070000 High-level language names, statistic message, explanation C COBOL CS-RTDB-ADD Message Number of requests to add a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to add an entry into the runtime database class. CICSSTAT_RTDB_ADD
459
Table 18. Runtime database statistics (continued)

Statistic ID 070001 High-level language names, statistic message, explanation C COBOL CS-RTDB-GET Message Number of requests to read a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to read an entry from the runtime database class. 070002 C COBOL CS-RTDB-GETP Message Number of requests to obtain a pointer to a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to obtain a pointer to an entry from the runtime database class. 070003 C COBOL CS-RTDB-DELTA Message Number of requests to amend a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to amend an entry in the runtime database class. 070004 C COBOL CS-RTDB-DELETE Message Number of requests to delete a runtime database entry. Explanation: This is used in the statistic record, to indicate the number of delete requests. CICSSTAT_RTDB_DELETE CICSSTAT_RTDB_DELTA CICSSTAT_RTDB_GETP CICSSTAT_RTDB_GET
460

Statistic ID 070005 High-level language names, statistic message, explanation C COBOL CS-RTDB-BROWSE Message Number of requests to browse the runtime database class Explanation: This is used in the statistic record, to indicate the total number of requests to browse the runtime database class. 070006 C COBOL CS-RTDB-NEXT Message Number of requests to read next in a runtime database class Explanation: This is used in the statistic record, to indicate the total number of requests to read the next entry in the runtime database class. 070007 C COBOL CS-RTDB-CHAIN Message Length of chain of database records Explanation: This is not used in the statistic record, but is reserved by CICS for internal use. 070008 C COBOL CS-RTDB-CHAINHI Message High water mark length of chain of database records Explanation: This is not used in the statistic record, but is reserved by CICS for internal use. CICSSTAT_RTDB_CHAINHI CICSSTAT_RTDB_CHAIN CICSSTAT_RTDB_NEXT CICSSTAT_RTDB_BROWSE
461

Statistic ID 070009 High-level language names, statistic message, explanation C COBOL CS-RTDB-DELTAUSE Message Number of requests to delta and use a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to delta an entry in the runtime database class, while retaining use of it. 07000A C COBOL CS-RTDB-USE Message Number of requests to use a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to use an entry in the runtime database class. 07000B C COBOL CS-RTDB-ENDUSE Message Number of requests to end use of a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to end use of an entry in the runtime database class. 07000C C COBOL CS-RTDB-EXCLUSIVE Message Number of exclusive requests for a runtime database entry Explanation: This is used in the statistic record, to indicate the total number of requests to obtain exclusive access to an entry in the runtime database class. CICSSTAT_RTDB_EXCLUSIVE CICSSTAT_RTDB_ENDUSE CICSSTAT_RTDB_USE CICSSTAT_RTDB_DELTAUSE
462

Statistic ID 07000D High-level language names, statistic message, explanation C COBOL CS-RTDB-RECORDS Message Number of entries in database class Explanation: This is used in the statistic record, to indicate the total number of entries in the runtime database class for this region. 07000E C COBOL CS-RTDB-COLLISIONS Message Number of collisions in database classs hash chains Explanation: This is used in the statistic record, to indicate the current total number of hash chain collisions in the runtime database class. 07000F C COBOL CS-RTDB-CHAINMAX Message Maximum number of entries in a hash chain Explanation: This is used in the statistic record, to indicate the number of entries in the currently longest hash chain for the runtime database class. 070010 C COBOL CS-RTDB-CHAINHIMAX Message Maximum of highest historical hash chain length Explanation: This is used in the statistic record, to indicate the number of entries in the longest hash chain that has occurred for the runtime database class. CICSSTAT_RTDB_CHAINHIMAX CICSSTAT_RTDB_CHAINMAX CICSSTAT_RTDB_COLLISIONS CICSSTAT_RTDB_RECORDS
463
Storage statistics
CICS provides statistical information relating to three distinct storage areas: v Region pool v Task-shared pool v Task-private pool Task-private pool statistics are also included in the CICS Administration Guide.
Table 19. Region pool statistics
Statistic ID 080000 High-level language names, statistic message, explanation C COBOL CS-STOR-RPOOL-SIZE Message The region pool size (in bytes) Explanation: This statistic records the congured size of the region storage pool as taken from the Region Denition or start up parameters for the region. 080001 C COBOL CS-STOR-RPOOL-THRESH Message The region pool storage stress threshold Explanation: This statistic records the percentage of the region pool which must be allocated from the region pool before it is considered to be under stress. The storage stress threshold is set as a warning marker to highlight that some transactions and CICS processes may start to abnormally terminate because there is not enough region pool storage to satisfy requests for control blocks. 080002 C COBOL CS-STOR-RBYTES-USED Message The number of bytes allocated from region pool Explanation: This statistic records the number of bytes currently allocated from the region pool during the selected period. This value reects activity in the region pool since the last statistics collection run. CICSSTAT_STOR_RBYTES_USED CICSSTAT_STOR_RPOOL_THRESH CICSSTAT_STOR_RPOOL_SIZE
464
Table 19. Region pool statistics (continued)

Statistic ID 080003 High-level language names, statistic message, explanation C COBOL CS-STOR-RALLOCS-SUCCEEDED Message The number of successful region pool storage allocations Explanation: This statistic indicates the number of successful allocations of region pool storage which have occurred during the selected period. 080004 C COBOL CS-STOR-RALLOCS-FAILED Message The number of unsuccessful region pool storage allocations Explanation: This statistic indicates the number of failed allocations of region pool storage which have occurred during the selected period. A nonzero number in this eld indicates that CICS is using up too much region-pool storage and that the region pool size is congured with a size that cannot sustain the activity in the region. 080005 C COBOL CS-STOR-RFREES-SUCCEEDED Message The number of successful region pool storage deallocations Explanation: This statistic indicates the number of successful deallocations of region pool storage which have occurred during the selected period. 080006 C COBOL CS-STOR-RFREES-FAILED Message The number of unsuccessful region pool storage deallocations Explanation: This statistic indicates the number of failed deallocations of region pool storage which have occurred during the selected period. A nonzero number in this eld indicates that there are problems within the CICS software. This should be reected by messages on console.nnnnnn CICSSTAT_STOR_RFREES_FAILED CICSSTAT_STOR_RFREES_SUCCEEDED CICSSTAT_STOR_RALLOCS_FAILED CICSSTAT_STOR_RALLOCS_SUCCEEDED
465
Table 19. Region pool statistics (continued)

Statistic ID 080007 High-level language names, statistic message, explanation C COBOL CS-STOR-RSOS-OCCURRENCE Message The number of times the region pool became short of storage Explanation: This statistic indicates how many times the region pool storage stress threshold was breached. If this number is not zero, it indicates either that the threshold is set too low or that the region pool size may be under-congured for the amount of region pool storage activity in the region. 080008 C COBOL CS-STOR-RHASH-MAXLEN Message Largest address hash bucket in region pool is: NOT USED Explanation: Not used for Region Pool. (place holder) CICSSTAT_STOR_RHASH_MAXLEN CICSSTAT_STOR_RSOS_OCCURRENCE
Table 20. Task-shared pool statistics

Statistic ID 080009 High-level language names, statistic message, explanation C COBOL CS-STOR-TPOOL-SIZE Message The task-shared pool size (in bytes) Explanation: This statistic records the congured size of the task-shared storage pool as taken from the Region Denition or start up parameters for the region. CICSSTAT_STOR_TPOOL_SIZE
466
Table 20. Task-shared pool statistics (continued)

Statistic ID 08000A High-level language names, statistic message, explanation C COBOL CS-STOR-TPOOL-THRESH Message The task-shared pool storage stress threshold Explanation: This statistic records the percentage of the task-shared pool which must be allocated from the task-shared pool before it is considered to be under stress. The storage stress threshold is set as a warning marker to highlight that some transactions and CICS processes may start to abnormally terminate because there is not enough task-shared pool storage to satisfy requests for GETMAIN SHARED, BMS map or application table storage. 08000B C COBOL CS-STOR-TBYTES-USED Message The number of bytes allocated from task-shared pool Explanation: This statistic records the number of bytes currently allocated from the task-shared pool during the selected period. This value reects activity in the task-shared pool since the last statistics collection run. 08000C C COBOL CS-STOR-TALLOCS-SUCCEEDED Message The number of successful task-shared pool storage allocations Explanation: This statistic indicates the number of successful allocations of task-shared pool storage which have occurred during the selected period. CICSSTAT_STOR_TALLOCS_SUCCEEDED CICSSTAT_STOR_TBYTES_USED CICSSTAT_STOR_TPOOL_THRESH
467

Statistic ID 08000D High-level language names, statistic message, explanation C COBOL CS-STOR-TALLOCS-FAILED Message The number of unsuccessful task-shared pool storage allocations Explanation: This statistic indicates the number of failed allocations of task-shared pool storage which have occurred during the selected period. A nonzero number in this eld indicates that transactions are using up too much task-shared pool storage and that the task-shared pool size is congured with a size that cannot sustain the activity in the region. 08000E C COBOL CS-STOR-TFREES-SUCCEEDED Message The number of successful task-shared pool storage deallocations Explanation: This statistic indicates the number of successful deallocations of task-shared pool storage which have occurred during the selected period. 08000F C COBOL CS-STOR-TFREES-FAILED Message The number of unsuccessful task-shared pool storage deallocations Explanation: This statistic indicates the number of failed deallocations of task-shared pool storage which have occurred during the selected period. A nonzero number in this eld indicates that there are problems within transactions or the CICS software. This should be reected by messages on console.nnnnnn. 080010 C COBOL CS-STOR-TSOS-OCCURRENCE Message The number of times the task-shared pool became short of storage Explanation: This statistic indicates how many times the task-shared pool storage stress threshold was breached. If this number is nonzero it indicates either that the threshold is set too low or that the task-shared pool size may be under-congured for the amount of task-shared pool storage activity in the region. CICSSTAT_STOR_TSOS_OCCURRENCE CICSSTAT_STOR_TFREES_FAILED CICSSTAT_STOR_TFREES_SUCCEEDED CICSSTAT_STOR_TALLOCS_FAILED
468

Statistic ID 080011 High-level language names, statistic message, explanation C COBOL CS-STOR-THASH-MAXLEN Message The number of elements in the longest task-shared pool address hash bucket Explanation: Access to task-shared pool allocations is by a hash table. This statistic indicates how many elements were in the longest address hash bucket within the hash table. A high number in this statistic indicates that the hash table is too small for the level of activity in the task-shared pool and that a number of task-shared pool allocations are being accessed with one or more hash buckets. The size of the hash table should be increased if the number is greater than 5. See also the descriptions of the LoadDataNumBlocks and TaskSHNumBlocks attributes in CICS Administration Reference. 080012 C COBOL CS-STOR-RHASH-BUCKET Message Worst Hash Bucket currently recorded in Region Pool is: NOT USED Explanation: Not used for Region Pool. (place holder) 080013 C COBOL CS-STOR-THASH-BUCKET Message Longest task-shared pool address hash bucket Explanation: This statistic identies the hash-bucket number of the hash bucket which has the largest number of elements. 080014 C COBOL CS-STOR-RBYTES-HIGHWATER Message The highest number of bytes which have been allocated from region pool Explanation: This statistic records the largest number of bytes allocated from the region pool since the start of the region. The highwater mark allocation can be taken as a peak measure of region pool allocation activity. CICSSTAT_STOR_RBYTES_HIGHWATER CICSSTAT_STOR_THASH_BUCKET CICSSTAT_STOR_RHASH_BUCKET CICSSTAT_STOR_THASH_MAXLEN
469

Statistic ID 080015 High-level language names, statistic message, explanation C COBOL CS-STOR-TBYTES-HIGHWATER Message The highest number of bytes which have been allocated from task-shared pool Explanation: This statistic records the largest number of bytes allocated from the task-shared pool during the selected period. The highwater mark allocation can be taken as a peak measure of task-shared pool activity. 080016 C COBOL CS-STOR-RBYTES-ALLOCSTART Message The total number of bytes currently allocated from region pool Explanation: This statistic records the number of bytes currently allocated from the region pool as recorded from the start of the region. This value reects the overall activity in the region pool since the region began operation. 080017 C COBOL CS-STOR-TBYTES-ALLOCSTART Message The total number of bytes currently allocated from task-shared pool Explanation: This statistic records the number of bytes currently allocated from the task-shared pool as recorded from the start of the region. This value reects the overall activity in the task-shared pool since the region began operation. 080018 C COBOL CS-STOR-RBYTES-FREED Message The number of bytes released back into the region pool Explanation: This statistic records the number of bytes currently deallocated back into the region pool during the selected period. This value reects activity in the region pool since the last statistics collection run. CICSSTAT_STOR_RBYTES_FREED CICSSTAT_STOR_TBYTES_ALLOCSTART CICSSTAT_STOR_RBYTES_ALLOCSTART CICSSTAT_STOR_TBYTES_HIGHWATER
470

Statistic ID 080019 High-level language names, statistic message, explanation C COBOL CS-STOR-TBYTES-FREED Message The number of bytes released back into the task-shared pool Explanation: This statistic records the number of bytes currently deallocated back into the task-shared pool during the selected period. This value reects activity in the task-shared pool since the last statistics collection run. CICSSTAT_STOR_TBYTES_FREED
Table 21. Task-private pool statistics

Statistic ID 090000 High-level language names, statistic message, explanation C COBOL CS-STOT-ALLOCS-SUCCEEDED Message The number of successful task-private storage allocations Explanation: This statistic indicates the number of successful allocations of task-private storage which have occurred during the selected period. 090001 C COBOL CS-STOT-DEALLOCS-SUCCEEDED Message The number of successful task-private storage deallocations Explanation: This statistic indicates the number of successful deallocations of task-private storage which have occurred during the selected period. 090002 C COBOL CS-STOT-ALLOCS-FAILED Message The number of unsuccessful task-private storage allocations Explanation: This statistic indicates the number of failed allocations of task-private storage which have occurred during the selected period. A nonzero number in this eld indicates that some transactions are using up too much task-private storage. CICSSTAT_STOT_ALLOCS_FAILED CICSSTAT_STOT_DEALLOCS_SUCCEEDED CICSSTAT_STOT_ALLOCS_SUCCEEDED
471
Table 21. Task-private pool statistics (continued)

Statistic ID 090003 High-level language names, statistic message, explanation C COBOL CS-STOT-DEALLOCS-FAILED Message The number of unsuccessful task-private storage deallocations Explanation: This statistic indicates the number of failed deallocations of task-private storage which have occurred during the selected period. A nonzero number in this eld indicates that some transactions are raising error and abend conditions while freeing task-private storage. 090004 C COBOL CS-STOT-ABEND-OCCURRENCE Message The number of task-private storage abends Explanation: This statistic indicates how many task-private storage abend conditions have been raised during the selected period. A nonzero number in this eld indicates that some transactions are causing storage errors. The storage statistics for transactions show how many task-private storage abends have been raised against particular transactions. 090005 C COBOL CS-STOT-NUMBER-OF-TASKS Message The number of tasks using task-private storage Explanation: This statistic indicates how many CICS tasks were using task-private storage during the selected period. 090006 C COBOL CS-STOT-TRANS-ABENDS Message The number of task-private storage abends for transaction Explanation: This statistic is gathered for each CICS transaction. It records how many task private storage abends have been raised against a transaction. CICSSTAT_STOT_TRANS_ABENDS CICSSTAT_STOT_NUMBER_OF_TASKS CICSSTAT_STOT_ABEND_OCCURRENCE CICSSTAT_STOT_DEALLOCS_FAILED
472
Task statistics
CICS produces accumulated statistical information relating to all tasks.
Table 22. Task statistics
Statistic ID 0A0000 High-level language names, statistic message, explanation C COBOL CS-TASK-NUM-TRANS Message Total number of transactions started Explanation: This is used in the statistic record, to indicate the total number of transactions run in the region during the selected period. 0A0001 C COBOL CS-TASK-NUM-TRANS-ABENDED Message Total number of transactions which abnormally terminated Explanation: This is used in the statistic record, to indicate the total number of transactions abnormally terminated in the region during the selected period. 0A0002 C COBOL CS-TASK-NUM-INVALID-ADDRESS Message Total number of exceptions raised due to invalid memory addresses Explanation: This is used in the statistic record, to indicate the total number of exceptions raised in the region, due to invalid memory addresses, during the selected period. 0A0003 C COBOL CS-TASK-NUM-PROT-VIOLATION Message Total number of exceptions raised due to protection violations Explanation: This is used in the statistic record, to indicate the total number of exceptions raised in the region, due to protection violations, during the selected period. CICSSTAT_TASK_NUM_PROT_VIOLATION CICSSTAT_TASK_NUM_INVALID_ADDRESS CICSSTAT_TASK_NUM_TRANS_ABENDED CICSSTAT_TASK_NUM_TRANS
473
Table 22. Task statistics (continued)

Statistic ID 0A0004 High-level language names, statistic message, explanation C COBOL CS-TASK-NUM-SYSTEM-ERROR Message Total number of exceptions raised by operating system detected errors Explanation: This is used in the statistic record, to indicate the total number of exceptions raised in the region, due to operating system detected errors, during the selected period. 0A0005 C COBOL CS-TASK-NUM-EXCEPTIONS Message Total number of transactions abnormally terminated due to exceptions Explanation: This is used in the statistic record, to indicate the total number of transactions, for the region, which are abnormally terminated due to exceptions, during the selected period. 0A0006 C COBOL CS-TASK-NUM-TRANNONS Message Total number of transactions which CICS was unable to start Explanation: This is used in the statistic record, to indicate the total number of transactions, for the region, which CICS was unable to start, during the selected period. 0A0007 C COBOL CS-TASK-NUM-APP-SERVERS-FULL Message Total number of times the number of active transactions reached the maximum number of application servers Explanation: This is used in the statistic record, to indicate the total number of times the number of active transactions reached the maximum number of application servers for the region, during the selected period. CICSSTAT_TASK_NUM_APP_SERVERS_FULL CICSSTAT_TASK_NUM_TRANNONS CICSSTAT_TASK_NUM_EXCEPTIONS CICSSTAT_TASK_NUM_SYSTEM_ERROR
474

Statistic ID 0A0008 High-level language names, statistic message, explanation C COBOL CS-TASK-PEAK-TASKS Message Peak number of tasks Explanation: This is used in the statistics record to indicate the maximum number of task requests that the region was processing at any one moment in time, during the selected interval. This includes both queued and running tasks requests. 0A0009 C COBOL CS-TASK-CLASS1-MAXVAL Message Maximum number of running Class 1 tasks allowed Explanation: This is used in the statistics record to indicate the value dened in the ClassMaxTasks attribute of the Region Denition le for Class 1. 0A000A C COBOL CS-TASK-CLASS1-CURRENT Message Current number of tasks (running and queued) for Class 1 Explanation: This is used in the statistics record to indicate the total number of Class 1 tasks in the region at the time the statistics were written. This includes both queued and running tasks. 0A000B C COBOL CS-TASK-CLASS1-MAX-TIMES-HIT Message The number of times Class 1 running tasks reached the maximum Explanation: This is used in the statistics record to indicate the number of times the starting of a new task resulted in the number of Class 1 running tasks in the region reaching the maximum value, during the selected interval. The maximum value is dened by the ClassMaxTasks attribute of the of the Region Denition le. CICSSTAT_TASK__CLASS1_MAX_TIMES_HIT CICSSTAT_TASK__CLASS1_CURRENT CICSSTAT_TASK__CLASS1_MAXVAL CICSSTAT_TASK_PEAK_TASKS
475

Statistic ID 0A000C High-level language names, statistic message, explanation C COBOL CS-TASK-CLASS1-PEAK-TASKS Message Peak number of tasks for Class 1 Explanation: This is used in the statistics record to indicate the maximum number of task requests for Class 1 that the region was processing at any one moment in time, during the selected interval. This includes both queued and running tasks requests. CICSSTAT_TASK__CLASS1_PEAK_TASKS
Terminal statistics
Terminal statistics are important for performance analysis for several reasons. The number of inputs and outputs can show the loading of the system by end-users. The statistics also show transmission faults. Both these factors have a negative inuence on system performance. The number of messages received and sent by a terminal represents the amount of message activity for that terminal. These numbers represent the message traffic between CICS and terminals. Input traffic is the result of user initiated input, which is initial transaction input or input as a result of a conversational read to the terminal. Output messages are written by the application program or sent by CICS. These messages can vary because of differences in the application programs being used on different terminals. Transactions initiated by automatic task initiation (ATI) usually do not have terminal input but can generate one, or many, output messages. CICS provides global statistical information relating to all terminals that are dened in the Terminal Denitions (WD). CICS also provides statistics information for each individual terminal.
476
Table 23. Terminal statistics

Statistic ID 0B0000 High-level language names, statistic message, explanation C COBOL CS-TERM-INPUTS Message Number of input messages received from CICS terminals Explanation: This is used in the statistics record to indicate the number of messages received by CICS from CICS terminals. 0B0001 C COBOL CS-TERM-OUTPUTS Message Number of output messages sent to cics terminals Explanation: This is used in the statistics record to indicate the number of messages sent by CICS to cics terminals. 0B0002 C COBOL CS-TERM-XMITERRS Message Number of terminal transmission errors Explanation: This is used in the statistics record to indicate the number of transmission failures between CICS and cics terminals. 0B0003 C COBOL CS-TERM-TRANS Message The number of transactions. Explanation: This is used in the statistics record to indicate the number of (TTI) transactions submitted against the terminal. CICSSTAT_TERM_TRANS CICSSTAT_TERM_XMITERRS CICSSTAT_TERM_OUTPUTS CICSSTAT_TERM_INPUTS
477
Table 23. Terminal statistics (continued)

Statistic ID 0B0004 High-level language names, statistic message, explanation C COBOL CS-TERM-TRANERRS Message Number of transaction errors Explanation: This is used in the statistics record to indicate the number of (TTI) transactions which were unsuccessfully submitted against the terminal. 0B0005 C COBOL CS-TERM-TOTAL-AUTOINSTALLS Message Number of terminals which have autoinstalled Explanation: This is used in the statistics record to indicate the number of terminals which have autoinstalled onto CICS. 0B0006 C COBOL CS-TERM-TOTAL-AUTOFAILS Message Number of unsuccessful terminal autoinstalls Explanation: This is used in the statistics record to indicate the number of terminals which have not succeeded in autoinstalling onto CICS. 0B0007 C COBOL CS-TERM-TOTAL-AUTODISCONNECTS Message Number of autoinstalled terminal which have disconnected Explanation: This is used in the statistics record to indicate the number of autoinstalled terminals which have uninstalled from CICS. CICSSTAT_TERM_TOTAL_AUTODISCONNECTS CICSSTAT_TERM_TOTAL_AUTOFAILS CICSSTAT_TERM_TOTAL_AUTOINSTALLS CICSSTAT_TERM_TRANERRS
478

Statistic ID 0B0008 High-level language names, statistic message, explanation C COBOL CS-TERM-SCHDL-LIMIT Message The times the synchronous scheduling limit has been hit Explanation: This is used in the statistics record to indicate the number of times the synchronous scheduling limit has been reached. 0B0009 C COBOL CS-TERM-SYNC-COUNT Message The number of synchronous threads currently running Explanation: This is used in the statistics record to indicate the number of synchronous threads currently running. 0B000A C COBOL CS-TERM-ASYNC-COUNT Message The number of asynchronous threads currently running Explanation: This is used in the statistics record to indicate the number of synchronous threads currently running. 0B000B C COBOL CS-TERM-THREAD-HWM Message The high water mark for the number of threads Explanation: This is used in the statistics record to indicate the high water mark for the number of threads. CICSSTAT_TERM_THREAD_HWM CICSSTAT_TERM_ASYNC_COUNT CICSSTAT_TERM_SYNC_COUNT CICSSTAT_TERM_SCHDL_LIMIT
479

Statistic ID 0B000C High-level language names, statistic message, explanation C COBOL CS-TERM-THREAD-LIMIT Message The number of times the thread limit has been hit Explanation: This is used in the statistics record to indicate the number of times the maximum number of threads has been in use. 0B000D C COBOL CS-TERM-RPC-REQUESTS Message The number of remote procedure call requests Explanation: This is used in the statistics record to indicate the number of remote procedure call requests. 0B000E C COBOL CS-TERM-RPC-ERRORS Message The number of remote procedure calls which returned in error Explanation: This is used in the statistics record to indicate the number of remote procedure calls which returned in error. CICSSTAT_TERM_RPC_ERRORS CICSSTAT_TERM_RPC_REQUESTS CICSSTAT_TERM_THREAD_LIMIT
Transient data statistics

CICS provides global statistical information relating to transient data queues dened to CICS in the Transient Data Denitions (TDD). CICS accumulates these statistics for all TD requests on the region since region start-up. CICS also provides statistical information relating to each individual TD queue dened to CICS in the TDD.
480
Table 24. Transient data statistics

Statistic ID 0C0000 High-level language names, statistic message, explanation C COBOL CS-TDQU-STAT-EP-READS Message Number of extrapartition transient data queue reads Explanation: This text is used as the label for the TDQ global statistics count of extrapartition queue reads. 0C0001 C COBOL CS-TDQU-STAT-EP-WRITES Message Number of extrapartition transient data queue writes Explanation: This text is used as the label for the TDQ global statistics count of extrapartition queue writes. 0C0002 C COBOL CS-TDQU-STAT-IP-READS Message Number of intrapartition transient data queue reads Explanation: This text is used as the label for the TDQ global statistics count of intrapartition queue reads. This includes queues dened with a trigger level. 0C0003 C COBOL CS-TDQU-STAT-IP-WRITES Message Number of intrapartition transient data queue writes Explanation: This text is used as the label for the TDQ global statistics count of intrapartition queue writes. This includes queues dened with a trigger level. CICSSTAT_TDQU_STAT_IP_WRITES CICSSTAT_TDQU_STAT_IP_READS CICSSTAT_TDQU_STAT_EP_WRITES CICSSTAT_TDQU_STAT_EP_READS
481
Table 24. Transient data statistics (continued)

Statistic ID 0C0004 High-level language names, statistic message, explanation C COBOL CS-TDQU-STAT-RMT-READS Message Number of remote transient data queue reads Explanation: This text is used as the label for the TDQ global statistics count of remote queue reads. 0C0005 C COBOL CS-TDQU-STAT-RMT-WRITES Message Number of remote transient data queue writes Explanation: This text is used as the label for the TDQ global statistics count of remote queue writes. 0C0006 C COBOL CS-TDQU-STAT-TRIG-READS Message Number of times a triggerable transient data queue was emptied by a TD queue read Explanation: This text is used as the label for the TD queue global statistics count of the number of TD queue reads which emptied a triggerable intrapartition TD queue, starting a new automatic transaction initiation cycle for that TD queue. 0C0007 C COBOL CS-TDQU-STAT-TRIG-WRITES Message Number of times the trigger level of transient data queue was reached by a TD queue write Explanation: This text is used as the label for the TD queue global statistics count of the number of TD queue writes which resulted in the number of items on a triggerable intrapartition TD queue reaching the dened trigger level, resulting in a request to initiate the triggered transaction. CICSSTAT_TDQU_STAT_TRIG_WRITES CICSSTAT_TDQU_STAT_TRIG_READS CICSSTAT_TDQU_STAT_RMT_WRITES CICSSTAT_TDQU_STAT_RMT_READS
482
Table 24. Transient data statistics (continued)

Statistic ID 0C0008 High-level language names, statistic message, explanation C COBOL CS-TDQU-STAT-LABEL-READS Message Number of transient data queue reads Explanation: This text is used as the label for the read count statistic stored in each TDQ. 0C0009 C COBOL CS-TDQU-STAT-LABEL-WRITES Message Number of transient data queue writes Explanation: This text is used as the label for the write count statistic stored in each TDQ. CICSSTAT_TDQU_STAT_LABEL_WRITES CICSSTAT_TDQU_STAT_LABEL_READS
Transaction statistics
CICS provides statistical information for all transactions dened in the Transaction Denitions (TD).
Table 25. Transaction statistics
Statistic ID 0D0000 High-level language names, statistic message, explanation C COBOL CS-TRAN-TRAN-STARTS Message Total number of times transaction started Explanation: Statistic record label. CICSSTAT_TRAN_TRAN_STARTS
483
Table 25. Transaction statistics (continued)

Statistic ID 0D0001 High-level language names, statistic message, explanation C COBOL CS-TRAN-TRANS-ABENDS Message The number of task private storage abends for transaction Explanation: This statistic is gathered for each CICS transaction. It records how many task private storage abends have been raised against a transaction. 0D0002 C COBOL CS-TRAN-DYNAMIC-RETRY-COUNT Message The total number of times that the destination system of a dynamic transaction had to be retried before the transaction was successfully routed. Explanation: This statistic can be used to nd out how effective the dynamic transaction routing user exit was when attempting to route this transaction. If a dynamic transaction had to be retried multiple times before it was routed to a valid and available system, then there may be a problem with the dynamic transaction routing user exit. If the transaction is not dynamic then this statistic will always be zero. 0D0004 C COBOL CS-TRAN-DYNAMIC-REMOTE Message This is the number of times the dynamic transaction routing exit has chosen to run this transaction on the local system. Explanation: This statistic is used to count the number of times that a particular transaction, which is dened as dynamic, has been routed locally by the dynamic transaction routing user exit. If the transaction is not dynamic then this statistic will always be zero. CICSSTAT_TRAN_DYNAMIC_REMOTE CICSSTAT_TRAN_DYNAMIC_RETRY_COUNT CICSSTAT_TRAN_TRANS_ABENDS
484
Table 25. Transaction statistics (continued)

Statistic ID 0D0005 High-level language names, statistic message, explanation C COBOL CS-TRAN-DYNAMIC-LOCAL Message This is the number of times the dynamic transaction routing exit has chosen to run this transaction on a remote system. Explanation: This statistic is used to count the number of times that a particular transaction, which is dened as dynamic, has been routed to a remote system by the dynamic transaction routing user exit. If the transaction is not dynamic then this statistic will always be zero. CICSSTAT_TRAN_DYNAMIC_LOCAL
Temporary storage statistics

CICS provides global statistical information relating to temporary storage queues that are dened in the Temporary Storage Denitions (TSD).
Table 26. Temporary storage statistics
Statistic ID 0E0000 High-level language names, statistic message, explanation C COBOL CS-TSQU-READ-MAIN Message Number of MAIN Temporary Storage (TS) queue read requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) read requests from MAIN queues. 0E0001 C COBOL CS-TSQU-WRITE-MAIN Message Number of MAIN Temporary Storage (TS) queue write requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) write requests to MAIN queues. CICSSTAT_TSQU_WRITE_MAIN CICSSTAT_TSQU_READ_MAIN
485
Table 26. Temporary storage statistics (continued)

Statistic ID 0E0002 High-level language names, statistic message, explanation C COBOL CS-TSQU-DELETE-MAIN Message Number of MAIN Temporary Storage (TS) queue delete requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) MAIN queue delete requests. 0E0003 C COBOL CS-TSQU-READ-AUX Message Number of AUXILIARY Temporary Storage (TS) queue read requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) read requests from AUXILIARY queues. 0E0004 C COBOL CS-TSQU-WRITE-AUX Message Number of AUXILIARY Temporary Storage (TS) queue write requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) write requests to AUXILIARY queues. 0E0005 C COBOL CS-TSQU-DELETE-AUX Message Number of AUXILIARY Temporary Storage (TS) queue delete requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) AUXILIARY queue delete requests. CICSSTAT_TSQU_DELETE_AUX CICSSTAT_TSQU_WRITE_AUX CICSSTAT_TSQU_READ_AUX CICSSTAT_TSQU_DELETE_MAIN
486

Statistic ID 0E0006 High-level language names, statistic message, explanation C COBOL CS-TSQU-CHECKPOINT Message Number of CICS checkpoints written to the system log Explanation: This is used in the statistic record, to indicate the number of CICS checkpoint operations (called activity keypoints in CICS/MVS terminology) performed during the selected period. 0E0007 C COBOL CS-TSQU-ABORT Message Number of Temporary Storage (TS) aborts Explanation: This is used in the statistic record, to indicate the number of transaction abort requests received by Temporary Storage (TS). 0E0008 C COBOL CS-TSQU-COMMIT Message Number of Temporary Storage (TS) commits Explanation: This is used in the statistic record, to indicate the number of transaction commit requests received by Temporary Storage (TS). 0E0009 C COBOL CS-TSQU-EXHAUSTED Message Number of times NOSPACE condition has arisen on Temporary Storage (TS) Explanation: This is used in the statistic record, to indicate the number of times Temporary Storage (TS) has encountered a NOSPACE condition. CICSSTAT_TSQU_EXHAUSTED CICSSTAT_TSQU_COMMIT CICSSTAT_TSQU_ABORT CICSSTAT_TSQU_CHECKPOINT
487

Statistic ID 0E000A High-level language names, statistic message, explanation C COBOL CS-TSQU-PEAK-QS Message Peak number of Temporary Storage (TS) queues existing Explanation: This is used in the statistic record, to indicate the largest concurrent number of Temporary Storage (TS) queues existing. 0E000B C COBOL CS-TSQU-CURRENT-QS Message Current number of Temporary Storage (TS) queues existing Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) queues existing in the region at this instance. 0E000C C COBOL CS-TSQU-MOST-ITEMS Message Most items in a Temporary Storage (TS) queue Explanation: This is used in the statistic record, to indicate the largest number of items that has existed in any Temporary Storage (TS) queue. 0E000D C COBOL CS-TSQU-IO-ERRORS Message Number of Temporary Storage (TS) queue IOERRs Explanation: This is used in the statistic record, to indicate the number of times Temporary Storage (TS) has encountered the IOERR condition. CICSSTAT_TSQU_IO_ERRORS CICSSTAT_TSQU_MOST_ITEMS CICSSTAT_TSQU_CURRENT_QS CICSSTAT_TSQU_PEAK_QS
488

Statistic ID 0E000E High-level language names, statistic message, explanation C COBOL CS-TSQU-AUTH-FAILURES Message Number of Temporary Storage (TS) queue authorization failures Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) queue requests that have been made without sufficient authority to operate on the TS queue. 0E000F C COBOL CS-TSQU-QS-PURGED Message Number of Temporary Storage (TS) queues purged by the CICS _private Temporary Storage Queue Aging transaction (CAGE) Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) queues that have been deleted by the CICS _private Temporary Storage Queue Aging transaction (CAGE). The time elapsed since they were last accessed was greater than the TS queue aging limit. 0E0010 C COBOL CS-TSQU-CAGE-RUNS Message Number of times CICS_private Temporary Storage Queue Aging transaction (CAGE) has run. Explanation: This is used in the statistic record, to indicate the number of times that the CICS_private Temporary Storage Queue Aging transaction (CAGE) has been run. 0E0011 C COBOL CS-TSQU-DELETE-WAITS Message Number of Temporary Storage (TS) queue delete usage conicts. Explanation: This is used in the statistic record, to indicate the number of times that a Temporary Storage (TS) has encountered another user of a queue when deleting it and has had to wait before retrying. CICSSTAT_TSQU_DELETE_WAITS CICSSTAT_TSQU_CAGE_RUNS CICSSTAT_TSQU_QS_PURGED CICSSTAT_TSQU_AUTH_FAILURES
489

Statistic ID 0E0012 High-level language names, statistic message, explanation C COBOL CS-TSQU-REMOTE-REQS Message Number of REMOTE Temporary Storage (TS) queue requests Explanation: This is used in the statistic record, to indicate the number of Temporary Storage (TS) requests to queues on remote CICS regions. CICSSTAT_TSQU_REMOTE_REQS
490
Chapter 9. Environment variables used by CICS

CICS uses the environment variables listed in the following tables.
CICS and Encina Environment Variables

Table 27. CICS and Encina Environment Variables
Variable CCFLAGS Description For CICS on Open Systems platforms, it sets both compile and link options. For Windows NT this species the compile and link options for the C compiler. Contains the DCE password of the DCE cell administrator. Species the name of the default color mapping le to be used by the cicslterm command. Species the DB2 UDB user ID for use by the cicsddt and cicsdb2conf commands. Species the DB2 UDB password for use by the cicsddt and cicsdb2conf commands. Species the DB2 UDB password for use by the command cicsdb2conf. Species the location of the le that contains default values for the IBM Application Debugging Program. On the Windows NT platform, set this variable equal to t:TranID f:FileName to allow the diagnostic data to be directed to a different le than the memory dump. Species a blank-separated list of TTYs on which terminals installed by ECI commands are to be animated. This variable applies to the environment in which the ECI program executes, not to the CICS environment. See the CICS Family: Client/Server Programming manual. Species a blank-separated list of TTYs on which terminals installed by EPI commands are to be animated. This variable applies to the environment in which the EPI program executes, not to the CICS environment. See the CICS Family: Client/Server Programming manual.
cell_admin_pw CICSCOL CICSDB2CONF_CONNECT_USER CICSDB2CONF_CONNECT_USING CICSDB2PASSWORD CICSDEBUGENV
CICS_DUMP_STORAGE_CHAIN (CICS for Windows NT)
CICSECIANIMATE
CICSEPIANIMATE
491
Environment variables used by CICS

Table 27. CICS and Encina Environment Variables (continued)
Variable CICSEPIMAXTERMINALS Description Controls the number of threads created by an application. This variable can be set to any value from 1 through 500. The default value is 100. Causes CICS clients and offline utilities to write to an external (operating system) event performance trace facility if set to a value other than null. Species the name of the default key mapping le to be used by the cicslterm command. Species the root directory for the CICS product. For Open Systems the default value is /opt/cics. For AIX the default value is /usr/lpp/cics. For Windows NT the default value is d:\opt\cics. This environment variable must not be changed. Sets the default working region. If set in the current environment, CICSTERM is used instead of TERM. If set, causes tracing to be started during CICS initialization. For CICS clients or utilities, CICSTRACE contains the name of the le to which trace entries are written. Species the number of 4KB pages required for the browse cache. Contains a blank-separated list of hostnames to be searched for regions when starting a CICS terminal. Species pathname of the directory where the HTML help les for the CICS-supplied transactions can be found. For Windows NT this species user-dened ags to be passed to the compile and link stages by the cicstcl command when compiling a C program using the IBM C++ compiler. Species user-dened ags to be passed to the compile and link stages by the cicstcl command when compiling a COBOL program using the IBM COBOL compiler. Species user-dened ags to be passed to the compile and link stages by the cicstcl command when compiling a PL/I program using the IBM PL/I compiler.
CICSEXTERNALTRACE
CICSKEY CICSPATH
CICSREGION CICSTERM CICSTRACE
CICS_BROWSE_CACHE CICS_HOSTS
CICS_CST_HTML
CICS_IBMC_FLAGS
CICS_IBMCOB_FLAGS
CICS_IBMPLI_FLAGS
492

Variable CICS_MSC_FLAGS Description For Windows NT only, this species user-dened ags to be passed to the compile and link stages by the cicstcl command when compiling a C program using the Microsoft C++ compiler. Species the name of a PPC gateway server. Used by cicsppcgwy command if the server name is not supplied with the command. Species the size (in MB) of the PPC gateway logical volume. Species the logical volume group for the PPC gateway logical volume. Sets the default working schema le. Species the size (in MB) of the data logical volume for the SFS. This overrides the environment variable CICS_SFS_SIZE. For Open systems, this species the logical volume group for, and for Windows NT, the location of, the data logical volume for the SFS. This overrides the environment variable CICS_SFS_VG. Species the size (in MB) of the log logical volume for the SFS. This overrides the environment variable CICS_SFS_SIZE. For Open Systems, this species the logical volume group for, and for Windows NT, the location of, the log logical volume for the SFS. This overrides the environment variable CICS_SFS_VG. Sets the default working SFS. This overrides the environment variable ENCINA_SFS_SERVER. Species the sizes (in MB) of both the data and the log logical volumes for the SFS. For Open Systems, this species the logical volume group for, and for Windows NT, the location of, both the data and the log logical volumes for the SFS. Prevents the XA OPEN string from printing in the CICS console le when a region attempts to connect to an XA-compliant database.
CICS_PPCGWY_SERVER
CICS_PPCGWY_SIZE CICS_PPCGWY_VG CICS_SCHEMA CICS_SFS_DATA_SIZE
CICS_SFS_DATA_VG
CICS_SFS_LOG_SIZE
CICS_SFS_LOG_VG
CICS_SFS_SERVER CICS_SFS_SIZE CICS_SFS_VG
CICS_SUPPRESS_XAOPEN_STRING
493

Variable CICS_XDT_SERVER Description Species the default database for CICS. This overrides the environment variable CICS_SFS_SERVER. Denes the name of the DB2 database to be used by the external le handler. If the variable is not set, the default DB2 database is used. If the external le handler is running in non-transactional mode (the environment variable CICS_XFH_TRANMODE is not set or is set to N) the environment variable CICS_XFH_COMMITINTERVAL species the number of recoverable operations that will be performed on the database before they are committed. If CICS_XFH_COMMITINTERVAL is not set the changes will be committed after every operation. On the Windows NT platform where CICS is using DB2 for its le manager, set this variable equal to 1, if the user wants an external le of line sequential type to be handled by MF COBOL, instead of DB2. On the Windows NT platform where CICS is using DB2 for its le manager, set this variable equal to 1, if the user wants an external le of sequential type to be handled by MF COBOL, instead of DB2.
CICS_XFH_DBNAME
CICS_XFH_ COMMITINTERVAL
CICS_XFH_LOCAL_LINE_SEQ (CICS for Windows NT)
CICS_XFH_LOCAL_ SEQ (CICS for Windows NT)
CICS_XFH_LOCAL_ INDEXED (CICS for Windows On the Windows NT platform where CICS is NT) using DB2 for its le manager, set this variable equal to 1, if the user wants an external le of indexed type to be handled by MF COBOL, instead of DB2. CICS_XFH_LOCAL_RELATIVE (CICS for Windows On the Windows NT platform where CICS is NT) using DB2 for its le manager, set this variable equal to 1, if the user wants an external le of relative type to be handled by MF COBOL, instead of DB2.
494

Variable CICS_XFH_LOGFILE Description Denes the path name to an alternate log for the external le handler. Normally this environment variable is not set and the external le handler appends to a le in tmp directory called xfh.LogFile. If this le does not exist, then it is created. Multiple concurrent external le handler applications can use the same le. If you dont want to keep a log le, set this environment variable to NONE. When this is done, errors are reported to stderr. Denes transactional T or non-transactional access to the database. The default operation is non-transactional access. For more information on the differences between the access modes and how they are implemented, see the CICS Application Programming Guide. Denes the user name used to connect to the database. If this is not set, then the userid that was logged in when the application started is used to access the database. Denes the user password used to connect to the database. If this is not set, then the userid that was logged in when the application started is used to access the database. Set, if Micro Focus COBOL or Micro Focus Net Express is not installed in the standard directory. (Standard directory depends on version of COBOL.)This species the COBOL directory for Micro Focus COBOL or Net Express. Species the shared library for COBOL for Micro Focus COBOL or Net Express. Sets COBOL compile and link options for Micro Focus COBOL or Net Express.
CICS_XFH_TRANMODE
CICS_XFH_USERNAME
CICS_XFH_USERPASS
COBDIR
COBLIB COBOPTS
495

Variable COBSW Description COBOL run-time switches. Refer to the Micro Focus COBOL or Micro Focus Net Express documentation for further details. By default, Micro Focus COBOL and Net Express cache COBOL programs. Caching can be disabled by setting the -l (lowercase L) memory switch to zero in the environment le in the region directory (for example, COBSW=-l0) before you start the region. If you disable the caching, a new copy of the COBOL program is loaded whenever the program is run. Contains the name of the default DB2 database. CICS requires that this variable must not be set. Denes the DCE protection level that an Encina client or server uses when it sends an RPC to an Encina Server. Denes whether an Encina server checks the authorization of any client that sends an RPC request against the access control lists (ACLs) dened for the server. Authorization checks take place if ENCINA_AUTHZ=1 and do not if ENCINA_AUTHZ=0. Species the location of the le of binding translations used when not using DCE servers. For CICS this must always be set to either VarDir/var/cics_servers/server_bindings or VarDir\var\cics_servers\server_bindings. The name of a DCE cell directory service (CDS) directory under which all your Encina servers register their names. Each type of server registers in a different subdirectory under the name dened in ENCINA_CDS_ROOT. The default gateway server name; used when the -server option for Encina administrative commands is not used. The le, known as the keytab le, containing the password of a DCE principal that is used by an Encina server.
DB2DBDFT ENCINA_AUTHN
ENCINA_AUTHZ
ENCINA_BINDING_FILE
ENCINA_CDS_ROOT
ENCINA_GWY_SERVER
ENCINA_KEY_FILE
496

Variable ENCINA_MIN_AUTHN Description Denes the minimum DCE protection level that an Encina server accepts on RPC requests it receives. It can be in the range 0-6. If ENCINA_MIN_AUTHN=1, the server cannot perform authorization checks on the RPC, so ENCINA_AUTHZ should be 0. The name of the DCE principal to be used by an Encina server, such as the SFS. Sets the default SFS server used by Encina sfsadmin command. Sets the default server used by Encina tkadmin command. Species which components in an Encina server are to produce trace. For example, to get the tran component of the Encina toolkit to produce trace, specify: export ENCINA_TRACE=tran:0x1f This variable sets the locale in which CICS runs. The regions locale can be set by the standard LANG variable (for example LANG=en_US or LANG=C) or it can be overridden in the regions environment le. The client side (for example, cicsterm) uses the locale from the current environment. For use On Open Systems only. If you are using Micro Focus COBOL level 3.2.27 or later LIBPATH should be set to $COBDIR/coblib (by cicsmkcobol). Otherwise it should not be set. When a Microsoft SQL Server encounters a transaction deadlock, it terminates the transaction and invalidates the XAID. This causes the XA_ROLLBACK to return RMER_NOTA (-4). CICS treats the negative return as fatal and abends the region (U8030) unless the environment variable MSQL_DEAD is set to 1. If the environment variable MSQL_DEAD is set to 1 CICS will instead abend only the application server. To enable this option MSQL_DEAD=1 must be dened in the regions environment le.
ENCINA_PRINCIPAL ENCINA_SFS_SERVER ENCINA_TK_SERVER ENCINA_TRACE
LANG
LIBPATH (CICS for AIX)
MSQL_DEAD (CICS for Windows NT)
497

Variable PATH Description This includes the bin directory for CICS, Encina and DCE. The default value is $CICSPATH/bin:$OPT/encina/bin:$OPT/dce/bin ($OPT/dcelocal/bin for CICS for HP-UX) where $OPT is /usr/lpp for CICS for AIX and /opt for other CICS on Open Systems platforms. driveLetter:\opt. SHLIB_PATH (CICS for HP-UX) For use On Open Systems only.If you are using Micro Focus COBOL level 3.2.27 or later SHLIB_PATH should be set to $COBDIR/coblib (by cicsmkcobol). Otherwise it should not be set. Determines the type of terminal used when a terminal is autoinstalled. Can be set in the users environment.
TERM
CICS does not allow you to use absolute or relative paths when specifying locale names. Locale names must not be larger than 32 bytes in length.
Environment variables for Micro Focus COBOL and Net Express compiler options
Table 28. Environment variables for Micro Focus COBOL compiler options
Option VSC2 OSVS ANS85 IBMCOMP NOALTER NOTRUNC NOBOUND WARNING=2 ANIM DEFAULTBYTE=0 Note Required for COBOL II (CICS for AIX) or HP COBOL/HPUX (CICS for HP-UX). The default value is NOVSC2. Recommended. The default value is NOOSVS. The default value is ANS85. Recommended. The default value is NOIBMCOMP. Recommended. The default value is ALTER. Recommended USAGE COMP truncation behavior. The default value is TRUNC=ANSI. Recommended no check on OCCURS limits at runtime. The default value is NOBOUND. Default gives informational messages. The default value is WARNING=3. Required for ANIMATOR debugging. The default value is NOANIM. Recommended initializes data division entries to low-values instead of spaces. The default value is DEFAULTBYTE=32.
498

User-dened environment variables for CICS are dened in the environment le, located in the region directory. The le has the same format as the le /etc/environment:
# System-wide environment file. This file should only contain # 1. comment lines which have a # in the first column, # 2. blank lines, and # 3. lines in the form name=value. # # WARNING: This file is only for establishing environment # variables. Execution of commands from this file # or any lines other than specified above may # cause failure of the initialization process.
See the Planning and Installation Guide for related information.
499
500
Chapter 10. Terminal model denitions

Table 29. Road map for terminal model denitions
If you want to... See the IBM CICS Client model. See the IBM CICS ECI model. See the example vt100 model. See the example aixterm model. See the example aixterm-m model. See the example ibm3151 model. See the example ibm3161 model. See the example ibm3164 model. See the high-function multibyte color model. See the high-function singlebyte color model. See the high-function multibyte mono model. See the high-function singlebyte mono model. See the low-function multibyte mono model. See the low-function singlebyte mono model. See the example HP terminal denition model. See the hpterm model denition model. See the example xterm model. See the 327x-x-E for cicsteld model. See the 327x-x for cicsteld model. See the example vt220 model. See the example dxterm (vt300) model. See the example dtterm model. See the example 327x-3-E model for cicsteld See the example 327x-3 model for cicsteld See the example 327x-4-E model for cicsteld See the example 327x-4 model for cicsteld See the example 327x-5-E model for cicsteld See the example 327x-5 model for cicsteld See the example 97801 model Refer to... Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 30 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 31 on page 502. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 32 on page 503. Table 33 on page 504. Table 33 on page 504. Table 33 on page 504. Table 33 on page 504. Table 33 on page 504.
501
Table 29. Road map for terminal model denitions (continued)

If you want to... Refer to...
See the example model for Sun command tool and Table 33 on page 504. shell tool
Table 30. Terminal MD05 and MD06 Attribute Permanent ModelId DevType
Denition attributes for autoinstall models MDCL, MDCI, MD01, MD02, MD03, MD04,
MDCI yes cicseci ibmcics-eci no yes no 0 no no none none yes 145 10 0 no no no no no no no no no no no no 24 80 none yes MD01 yes vt100 vt100 MD02 yes aixterm aixterm MD03 MD04 yes yes aix-m ibm3151 aixterm-m ibm3151 MD05 yes ibm3161 ibm3161 MD06 yes ibm3164 ibm3164
MDCL yes cicscli ibmcicsclient CanStartATIs yes CanStartTTIs yes UCTranFlag no TCTUALen 0 Katakana no IsPrinter no TSLKeyList none RSLKeyList none IsShippable yes TermType 145 TermSubType 10 Priority 0 ErrLastLine yes ERRIntensify yes ErrColor no ERRHilight no OutService no Highlight yes Foreground yes ProgramSymbols no SOSI no Outline no Validation no ExtDS yes NumLines 24 NumColumns 80 TerminalProtection none RecoverTerminal yes
yes yes no 0 no no none none yes 145 10 0 yes yes no no no yes no no no no no yes 24 80 none yes
yes yes no 0 no no none none yes 145 10 0 yes yes red no no yes yes no no no no yes 24 80 none yes
Table 31. Terminal Denition attributes for autoinstall models MD07, MD08, MD09, MD10, MD11, MD12, MD13 and MD14 Attribute MD07 MD08 MD09 MD10 MD11 MD12 MD13 MD14 Permanent yes yes yes yes yes yes yes yes
502
Table 31. Terminal Denition attributes for autoinstall models MD07, MD08, MD09, MD10, MD11, MD12, MD13 and MD14 (continued) Attribute MD07 MD08 MD09 MD10 MD11 MD12 MD13 MD14 ModelId hft-mb hft mft-mb mft lft-mb lft hp hpterm DevType hft-mb hft mft-mb mft lft-mb lft hp hpterm CanStartATIs yes yes yes yes yes yes yes yes CanStartTTIs yes yes yes yes yes yes yes yes UCTranFlag no no no no no no no no TCTUALen 0 0 0 0 0 0 0 0 Katakana no no no no no no no no IsPrinter no no no no no no no no TSLKeyList none none none none none none none none RSLKeyList none none none none none none none none IsShippable yes yes yes yes yes yes yes yes TermType 145 145 145 145 145 145 145 145 TermSubType 10 10 10 10 10 10 10 10 Priority 0 0 0 0 0 0 0 0 ERRLastLine yes yes yes yes yes yes yes yes ERRIntensify yes yes yes yes yes yes yes yes ERRCOlor red red no no no no no no ERRHilight no no no no no no no reverse OutService no no no no no no no no Highlight yes yes yes yes no no no yes Foreground yes yes no no no no no no ProgramSymbols yes no yes no yes no no no SOSI yes no yes no yes no no no Outline yes no yes no no no no no Validation no no no no no no no no ExtDS yes yes yes yes yes no no yes NumLines 24 24 24 24 24 24 24 24 NumColumns 80 80 80 80 80 80 80 80 TerminalProtection none none none none none none none none RecoverTerminal yes yes yes yes yes yes yes yes Table 32. Terminal MD21 and MD22 Attribute Permanent ModelId DevType CanStartATIs CanStartTTIs UCTranFlag TCTUALen Katakana IsPrinter Denition attributes for autoinstall models MD15, MD16, MD17, MD18, MD19, MD20,
MD15 yes xterm xterm yes yes no 0 no no MD16 yes 3270C 3270C yes yes no 0 no no MD17 yes 3270M 3270M yes yes no 0 no no MD18 yes vt220 vt220 yes yes no 0 no no MD19 yes vt300 vt300 yes yes no 0 no no MD20 yes dtterm dtterm yes yes no 0 no no MD21 yes 3270C-3 3270C-3 yes yes no 0 no no MD22 yes 3270M-3 3270M-3 yes yes no 0 no no
503
Table 32. Terminal Denition attributes for autoinstall models MD15, MD16, MD17, MD18, MD19, MD20, MD21 and MD22 (continued) Attribute MD15 MD16 MD17 MD18 MD19 MD20 MD21 MD22 TSLKeyList none none none none none none none none RSLKeyList none none none none none none none none IsShippable yes yes yes yes yes yes yes yes TermType 145 145 145 145 145 145 145 145 TermSubType 10 10 10 10 10 10 10 10 Priority 0 0 0 0 0 0 0 0 ERRLastLine yes yes yes yes yes yes yes yes ERRIntensify yes yes yes yes yes yes yes yes ERRCOlor red red no no red red red no ERRHilight no no no no no no no no OutService no no no no no no no no Highlight yes yes no yes yes yes yes no Foreground yes yes no no yes yes yes no ProgramSymbols no no no no no no no no SOSI no no no no no no no no Outline no no no no no no no no Validation no no no no no no no no ExtDS yes yes no yes yes yes yes no NumLines 24 24 24 24 24 24 32 32 NumColumns 80 80 80 80 80 80 80 80 TerminalProtection none none none none none none none none RecoverTerminal yes yes yes yes yes yes yes yes Table 33. Terminal MD28 Attribute Permanent ModelId
DevType CanStartATIs CanStartTTIs UCTranFlag TCTUALen Katakana IsPrinter TSLKeyList RSLKeyList IsShippable TermType TermSubType Priority
Denition attributes for autoinstall models MD23, MD24, MD25, MD26, MD27 and
MD23 MD24 MD25 MD26 MD27 yes yes yes yes yes 3270C-4 3270M-4 3270C-5 3270M-5 97801 3270C-4 3270M-4 3270C-5 3270M-5 97801 yes yes no 0 no no none none yes 145 10 0 yes yes no 0 no no none none yes 145 10 0 yes yes no 0 no no none none yes 145 10 0 yes yes no 0 no no none none yes 145 10 0 yes yes no 0 no no none none yes 145 10 0 MD28 yes suncmd suncmd yes yes no 0 no no none none yes 145 10 0
504
Table 33. Terminal Denition attributes for autoinstall models MD23, MD24, MD25, MD26, MD27 and MD28 (continued) Attribute MD23 MD24 MD25 MD26 MD27 MD28 ERRLastLine yes yes yes yes yes yes ERRIntensify yes yes yes yes yes yes ERRCOlor red no red no red red ERRHilight no no no no no no OutService no no no no no no Highlight yes no yes no yes yes Foreground yes no yes no yes yes ProgramSymbols no no no no no no SOSI no no no no no no Outline no no no no no no Validation no no no no no no ExtDS yes no yes no yes yes NumLines 43 43 27 27 24 24 NumColumns 80 80 132 132 80 80 TerminalProtection none none none none none none RecoverTerminal yes yes yes yes yes yes
505
506
Chapter 11. Index of CICS resource attributes

If you are using CICS for AIX you can use the System Management Interface Tool (SMIT), rather than CICS commands, to congure CICS resources. The tables in this chapter cross reference the descriptions of resource attributes as they appear in SMIT panels with the attribute names used in RDO commands.
Table 34. Communications Denitions (CD) Attribute description
Group to which resource belongs Activate the resource at cold start? Resource description Number of updates Protect resource from modication? Connection type Name of remote system SNA network name for the remote system SNA prole describing the remote system Default modename for a SNA connection Gateway Denition (GD) entry name Listener Denition (LD) entry name TCP address for the remote system TCP port number for the remote system DCE cell name of remote system Timeout on allocate (in seconds) Code page for transaction routing Set connection in service? Send userids on outbound requests? Security level for inbound requests UserId for inbound requests Transaction Security Level (TSL) Key Mask Resource Security Level (RSL) Key Mask Transmission encryption level Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent ConnectionType RemoteLUName RemoteNetworkName SNAConnectName DefaultSNAModeName GatewayName ListenerName RemoteTCPAddress RemoteTCPPort DCECell AllocateTimeout RemoteCodePageTR InService OutboundUserIds RemoteSysSecurity LinkUserId TSLKeyMask RSLKeyMask RemoteSysEncrypt Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent EnableStatus
Table 35. File Denitions (FD) Attribute description

Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modication? File enable status
507
Resource attribute cross-reference

Table 35. File Denitions (FD) (continued) Attribute description
Remote System Name Remote lename Resource Level Security Key Protection level per OFD Error isolation File open status Read access status Update access status Browse access status Add access status Delete access status Empty status for rst le open Server lename File Server Server Index Name Recoverability status Is a user conversion template dened Key length to use with remote requests Record length to use with remote requests Number of pages to preallocate Attribute name RemoteSysId RemoteName RSLKey FileProtection ErrorIsolation OpenStatus ReadOpt UpdateOpt BrowseOpt AddOpt DeleteOpt EmptyOpt BaseName FileServer IndexName RecoverStatus TemplateDened KeyLen RecordSize PrePages Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent DCECell GatewayCDSName GatewayLUName GatewayPrincipal Attribute name ResourceDescription AmendCounter Permanent StartType ProtectionLevel ThreadPoolSize ShortName UserID
Table 36. Gateway Denitions (GD) Attribute description

Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modication? DCE cell name of the gateway CDS path name of the gateway SNA LU name of the gateway DCE principal under which this gateway runs
Table 37. Gateway Server Denitions (GSD) Attribute description

Resource description Number of updates Protect resource from modication? Cold or auto start? Protection level Number of threads for RPC requests Short name used for SRC AIX user ID for server
508

Table 37. Gateway Server Denitions (GSD) (continued) Attribute description
AIX logical volume for logging SNA default mode name (HP only) Name Service for advertising server Attribute name LogVolume SNADefaultModeName NameService Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent RSLKey DiskA DiskB DiskAStatus DiskBStatus CrucialFlag InitialOpenFlag Attribute name NamedPipeName GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent Protocol TCPAddress TCPService SNAServerNodeName Attribute name ResourceDescription AmendCounter Modiable Conversational MonitorStatus TDQ Exclude Include UserMonitorModule
Table 38. Journal Denitions (JD) Attribute description

Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modication? Resource Level Security Key File or path A holding the journal File or path B holding the journal Disk A Status Disk B Status Abort region if journal is inaccessible? Open journal on region startup?
Table 39. Listener Denitions (LD) Attribute description

local Named Pipe name (CICS for Windows NT) Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modication? Protocol type TCP adapter address TCP service name local SNA Node Name
Table 40. Monitoring Denitions (MD) Attribute description

Resource description Number of updates Protect the resource from modication? Write separate records for conversational tasks? Set monitoring on? TDQ to hold monitoring information Monitoring identiers to be excluded Monitoring identiers to be included File or path of user monitoring program
509

Table 41. Product Denitions (XAD) Attribute description
Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modication? Switch Load File Path Name Resource Manager Initialization String Resource Manager Termination String Resource Manager Serialization Attribute Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent SwitchLoadFile XAOpen XAClose XASerialize Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent EnableStatus RemoteSysId RemoteName TransId RSLKey PathName ProgType UserExitNumber TemplateDened Resident Attribute name ResourceDescription AmendCounter Modiable StartType Groups StartupProgList ShutdownProgList1 ShutdownProgList2 TDPurgeInterval DefaultUserId FileSystemType RDBMSInstance
Table 42. Program Denitions (PD) Attribute description

Group to which resource belongs Activate resource at cold start? Resource description Number of updates Protect resource from modications? Program enable status Remote system on which to run program Name to use for program on remote system Transaction name on remote system for program Resource Level Security Key Program path name Program type User Exit number Is a user conversion template dened? Is this a program that should be cached?
Table 43. Region Denitions (RD) Attribute description

Resource description Number of updates Protect resource from modication? Startup type Startup groups Programs to execute at startup Programs to execute at phase 1 of shutdown Programs to execute at phase 2 of shutdown Interval value controlling frequency of purging of the read records from the transient data queues Name of the default user identier Type of le system The RDBMS Instance name
510

Table 43. Region Denitions (RD) (continued) Attribute description
Type of RSL checking for Files Type of RSL checking for TDQs Type of RSL checking for TSQs Type of RSL checking for Journals Type of RSL checking for Programs Type of RSL checking for Transactions Do you want to use an External Security Manager? Name of ESM Module Min protect level used when accepting RPCs Min protect level for logical TDQs Min protect level for physical TDQs Min protect level for non-recoverable TDQs Min protect level for recoverable TSQs Min protect level for non-recoverable TSQs Min protect level for locally queued PROTECT ATIs Min protect level for locally queued ATIs CICS Release Number Region system identier (short name) Network name to which local region is attached Common Work Area Size Minimum number of Application Servers to maintain Maximum number of Application Servers to maintain Maximum number of running transactions per class (10 entries) Purge threshold for transaction requests above ClassMaxTasks Time before Application Servers terminate (secs) Level of protection against user corruption Number of threads for RPC requests Format date for FORMATTIME Hash sizes CD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD Region Pool Storage Size (bytes) Task-private Storage Size (bytes) Task Shared Pool Storage Size (bytes) Threshold for Region Pool short on storage (%age) Threshold for TSH Pool short on storage (%age) Number of Task Shared Pool Address Hash Buckets Number of LOADed data Address Hash Buckets System dump on shutdown, SNAP dumps, ASRx abends? Should CICS system be dumped for ASRA abends? Should CICS system be dumped for ASRB abends? Directory in which dump output is written Directory in which Core Dump output is written Modules to trace Module list for partial trace Attribute name FileRSLCheck TransientDataRSLCheck TemporaryStorageRSLCheck JournalRSLCheck ProgramRSLCheck TransactionRSLCheck ESMLoad ESMModule RuntimeProtection LogicalTDQProtection PhysicalTDQProtection NonRecTDQProtection RecTSQProtection NonRecTSQProtection LocalQProtectProtection LocalQProtection ReleaseNum LocalSysId LocalNetworkName CWASize MinServer MaxServer ClassMaxTasks ClassMaxTaskLim ServerIdleLimit SafetyLevel RPCListenerThreads DateForm ClassTableSize MaxRegionPool MaxTaskPrivatePool MaxTSHPool RegionPoolThreshold TaskShPoolThreshold TaskSHNumBuckets LoadDataNumBuckets SysDump PCDump ABDump DumpName CoreDumpName Trace TraceModules
511

External trace facility required? File or path (A) for system trace File or path (B) for system trace Maximum system trace le size System trace buffer size User trace directory User Trace le or path for guest logins Interval between region consistency checks (mins) Level of checking to perform on region Retransmission interval for queued ATIs (mins) Rescheduling interval for blocked ATIs (mins) ATI purge interval (hours) Purge delay period for PROTECT requests (hours) Purge delay period for no PROTECT requests (hours) Should stats be recorded at every interval? File or path for statistics Should map names be suffixed? Number of records logged between checkpoints SFS server or database storing CICS Queue Data SFS le storing Recoverable Auxiliary TSQs SFS Index for Recoverable Auxiliary TSQs Recoverable Auxiliary TSQ Volume Name Number of pages to preallocate for RecTSQFile Maximum number of records for Recoverable Auxiliary TSQs SFS le storing Non-Recoverable Auxiliary TSQs SFS Index for Non-Recoverable Auxiliary TSQs Non-recoverable TSQ Volume Name Number of pages to preallocate for NonRecTSQFile Maximum number of records for Non-recoverable TSQs SFS le storing Logically Recoverable TDQs SFS Index for Logically Recoverable TDQs Logically Recoverable TDQ Volume Name Number of pages to preallocate for LogicalTDQFile Maximum number of records for Logically Recoverable TDQs SFS le storing Physically Recoverable TDQs SFS Index for Physically Recoverable TDQs Physically Recoverable TDQ Volume Name Number of pages to preallocate for PhysicalTDQFile Maximum number of records for Physically Recoverable TDQs SFS le storing Non-Recoverable TDQs SFS Index for Non-Recoverable TDQs Non-recoverable TDQ Volume Name Number of pages to preallocate for NonRecTDQFile Attribute name ExternalTrace TraceFileA TraceFileB TraceFileSize SysTraceBufferSize UserTraceDirectory PublicUserTraceFile IntrospectInterval IntrospectLevel ISCDelayMinutes CUBSDelayMinutes CARPDelayHours ProtectPurgeDelayPeriod PurgeDelayPeriod StatsRecord StatFile SufficesSupported CheckpointInterval DefaultFileServer RecTSQFile RecTSQIndex RecTSQVol RecTSQPrePages RecTSQMaxRecs NonRecTSQFile NonRecTSQIndex NonRecTSQVol NonRecTSQPrePages NonRecTSQMaxRecs LogicalTDQFile LogicalTDQIndex LogicalTDQVol LogicalTDQPrePages LogicalTDQMaxRecs PhysicalTDQFile PhysicalTDQIndex PhysicalTDQVol PhysicalTDQPrePages PhysicalTDQMaxRecs NonRecTDQFile NonRecTDQIndex NonRecTDQVol NonRecTDQPrePages
512

Maximum number of records for Non-recoverable TDQs SFS le for Locally-Queued Protected STARTs SFS Index for Locally-Queued Protected STARTs Locally-Queued Protected START Volume Name Number of pages to preallocate for LocalQProtectFile Maximum number of records for Locally-Queued Protected STARTs SFS le for Locally-Queued Unprotected STARTs SFS Index for Locally-Queued Unprotected STARTs Local Q Volume Name Number of pages to preallocate for LocalQFile Maximum number of records for Local Qs Expiry limit for unaccessed TSQs (days) Maximum number of C or IBM COBOL programs that can be cached Local LU name Region Pool base register Task Shared Pool base register Server side transactions only ? Userid authentication performed by DCE or CICS? Use DCE Name Service (CDS) to locate CICS and Encina servers? Allow use of the application debugging tool Time DCE password is cached for use by ECI application (secs) HTML Browser for help text Mode for autoinstallation of Terminals Attribute name NonRecTDQMaxRecs LocalQProtectFile LocalQProtectIndex LocalQProtectVol LocalQProtectPrePages LocalQProtectMaxRecs LocalQFile LocalQIndex LocalQVol LocalQPrePages LocalQMaxRecs TSQAgeLimit ProgramCacheSize LocalLUName RegionPoolBase TaskSharedPoolBase ServerSideTran AuthenticationService NameService AllowDebugging ECIPasswordCacheSeconds HTMLBrowser(Windows NT) AutoInstallMode MaxTaskCPUAction(CICS on Open Systems) MaxTaskCPU(CICS on Open Systems) MaxConsoleSize TransDumpTrace Attribute name ResourceDescription AmendCounter Permanent FileType VolumeName PreallocatePages MaxRecords PrimaryIndexName PrimaryIndexUnique PrimaryIndexFields
Maximum Console Size Transaction Dump Trace
Table 44. Schema File Denitions (SCD) Attribute description

Resource description Number of updates Protect resource from modication? CICS File Type SFS ONLY: Volume Name SFS ONLY: Number of Pages to Preallocate SFS ONLY: Maximum Number of Records Primary Index Name Is Primary Index Unique? Field Names for Primary Index
513

Table 44. Schema File Denitions (SCD) (continued) Attribute description
Descending Field Names for Primary Index Field 1 - Name Field 1 - Type Field 1 - Length Field 20 - Name Field 20 - Type Field 20 - Length Variable Field - Name Variable Field - Type Variable Field - Length Secondary Index 1 - Name SFS ONLY: Secondary Index 1 - Volume Name SFS ONLY: Secondary Index 1 - Preallocated Pages Secondary Index 1 - Is it Unique? Secondary Index 1 - Field Names Secondary Index 1 - Descending Fields Secondary Index 10 - Name SFS ONLY: Secondary Index 10 - Volume Name SFS ONLY: Secondary Index 10 - Preallocated Pages Secondary Index 10 - Is it Unique? Secondary Index 10 - Field Names Secondary Index 10 - Descending Fields Attribute name PrimaryIndexDescenders FieldName1 FieldType1 FieldLength1 FieldName20 FieldType20 FieldLength20 VariableFieldName VariableFieldType VariableFieldLength IndexName1 IndexVolumeName1 IndexPreallocatePages1 IndexUnique1 IndexFieldNames1 IndexFieldDescenders1 IndexName10 IndexVolumeName10 IndexPreallocatePages10 IndexUnique10 IndexFieldNames10 IndexFieldDescenders10 Attribute name ResourceDescription AmendCounter Permanent StartType ProtectionLevel MRAArchivingEnabled BufferPoolSize IdleTimeout Checkpoint OpThreadPoolSize ResThreadPoolSize CollatingLanguage ShortName UserID DataVolume LogVolume LogFile NameService
Table 45. Structured File Server Denitions (SSD) Attribute description

Resource description Number of updates Protect resource from modication? Cold or auto start? Protection level Enable MRA Archiving? Buffer pool size in Kbytes Idle timeout Number of Log writes per checkpoint interval Number of threads devoted to normal operations Number of threads devoted to resource operations Collating language Short name used for SRC AIX user ID for server AIX logical volume for data AIX logical volume for logging Log File Name Name Service for advertising server
514

Table 46. Temporary Storage Denitions (TSD) Attribute description
Group to which resource belongs Activate the resource at cold start? Resource description Number of updates Protect resource from modication? Remote System Identier Remote Queue Name Resource Level Security Key Is queue recoverable? Is a user conversion template dened? Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent RemoteSysId RemoteName RSLKey RecoverFlag TemplateDened Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent OutService RemoteSysId RemoteName TSLKeyList RSLKeyList ModelId NumLines NumColumns CanStartATIs CanStartTTIs UCTranFlag TCTUALen NetName Katakana IsPrinter IsShippable TermType TermSubType Priority Validation Highlight Foreground ExtDS ProgramSymbols Outline
Table 47. Terminal Denitions (WD) Attribute description

Group to which resource belongs Activate the resource at cold start? Resource description Number of updates Protect resource from modication? Set terminal out of service? System to which terminal belongs Terminal identier on remote system Transaction Level Security Key list Resource Level Security Key list Autoinstall Model Identier Number of lines on terminal Number of columns on terminal Is terminal available for ATI requests? Can transactions be initiated from this terminal? Should terminal convert data to uppercase? Length of TCTUA NetName of the shell terminal Does terminal support Katakana? Is this an output only device? Is terminal denition shippable? Terminal type Terminal subtype Terminal priority Does terminal support eld validation? Does terminal support highlighting? Is foreground color supported? Is BMS to generate extended data streams? Program Symbols Does terminal support eld outlining?
515

Table 47. Terminal Denitions (WD) (continued) Attribute description
Does terminal support SOSI Display error messages on the last line? Should error messages be intensied? Color for error messages Extended highlighting for error messages Device Type for model entry Protection level Attribute name SOSI ERRLastLine ERRIntensify ERRColor ERRHilight DevType TerminalProtection Attribute name GroupName ActivateOnStartup ResourceDescription TClass AmendCounter Permanent EnableStatus Dynamic RemoteSysId RemoteName RSLKey TSLKey RSLCheck TSLCheck TransDump ProgName TPNSNAProle TemplateDened IsBackEndDTP TWASize Priority Purgeability Syncpoint DeadLockTimeout InDoubt UCTranFlag SNAModeName LocalQ Timeout InvocationMode MaxTaskCPUAction(CICS on Open Systems)
Table 48. Transaction Denitions (TD) Attribute description

Group to which resource belongs Activate the resource at cold start? Resource description The class of transaction Number of updates Protect resource from modication? Transaction enable status Can transaction be dynamically routed? Remote System Identier Remote Transaction Identier Resource Level Security Key Transaction Level Security Key Type of RSL Checks Type of TSL Checks Should transaction be dumped on an abend? First program name SNA TPN prole for APPC listener program Is a user conversion template dened? Is back end of a DTP transaction? Transaction Work Area Size Transaction Priority Transaction purgeability Type of Syncpoint Flows Transaction deadlock timeout value (secs) Effect of FORCEPURGE for InDoubt transactions Should data be converted to uppercase? SNA modename for this transaction Locally Queue ATI requests for this transaction? Conversational timeout value (mins) Contexts in which transaction can START
516

Table 48. Transaction Denitions (TD) (continued) Attribute description
Attribute name MaxTaskCPU(CICS on Open Systems)
Table 49. Transient Data Denitions (TDD) Attribute description

Group to which resource belongs Activate the resource at cold start? Resource description Number of updates Protect resource from modication? Remote System Identier Remote Queue Name Resource Level Security Key Type of Queue Input/Output Mode of EP Queue Filename or path for EP queue data le Time at which queue is to be opened Open EP output les truncated or append Record organization for EP queue data le Record length for xed length EP queue ASCII value of terminator for xed length queue Indirect Queue Name Type of facility allocated for triggered task Recoverability type of IP queue Triggered Transaction Identier Trigger Level System/Terminal for a triggered task Is a user conversion template dened?
Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent RemoteSysId RemoteName RSLKey DestType IOMode ExtrapartitionFile WhenOpened OpenMode RecordType RecordLen RecordTerminator IndirectQueueId FacilityType RecoveryType TriggeredTransId TriggerLevel FacilityId TemplateDened Attribute name GroupName ActivateOnStartup ResourceDescription AmendCounter Permanent TSLKeyList RSLKeyList Principal Priority TraceFile OpID DCECell
Table 50. User Denitions (UD) Attribute description

Group to which resource belongs Activate the resource at cold start? Resource description Number of updates Protect resource from modication? Transaction Level Security Key List Resource Level Security Key List DCE principal of the user User priority User Trace lename Operator ID (Obsolete) DCE cell name
517

Table 50. User Denitions (UD) (continued) Attribute description
Encrypted password Attribute name CICSPassword
Table 51. Alphabetic cross-reference of attribute names to attribute descriptions

Attribute name ABDump ActivateOnStartup Class RD FD, GD, JD, LD, PD, XAD Attribute description Should CICS system be dumped for ASRB abends? Activate resource at cold start?
CD, TD, Activate the resource at cold start? TDD, TSD, UD, WD AddOpt AllocateTimeout AllowDebugging AmendCounter FD CD RD Add access status Timeout on allocate (in seconds) Allow use of the application debugging tool
Number of updates CD, FD, GD, GSD, JD, LD, MD, PD, RD, SCD, SSD, TD, TDD, TSD, UD, WD, XAD RD RD RD FD FD SSD WD WD RD SSD RD UD Userid authentication performed by DCE or CICS? CICS on Open Systems Mode for autoinstallation of terminals Server lename Browse access status Buffer pool size in Kbytes Is terminal available for ATI requests? Can transactions be initiated from this terminal? ATI purge interval (hours) Number of Log writes per checkpoint interval Number of records logged between checkpoints Encrypted password
AuthenticationService AutoDCELogin AutoInstallMode BaseName BrowseOpt BufferPoolSize CanStartATIs CanStartTTIs CARPDelayHours Checkpoint CheckpointInterval CICSPassword
518

Table 51. Alphabetic cross-reference of attribute names to attribute descriptions (continued)
Attribute name ClassMaxTaskLim ClassMaxTasks ClassTableSize CollatingLanguage ConnectionType Conversational CoreDumpName CrucialFlag CUBSDelayMinutes CWASize DataVolume DateForm DCECell Class RD RD RD SSD CD MD RD JD RD RD SSD RD UD CD GD DeadLockTimeout DefaultFileServer DefaultSNAModeName DefaultUserId DeleteOpt DestType DevType DiskA DiskAStatus DiskB DiskBStatus DumpName Dynamic ECIPasswordCacheSeconds TD RD CD RD FD TDD WD JD JD JD JD RD TD RD Attribute description Purge threshold for transaction requests above ClassMaxTasks Maximum number of running transactions per class (10 entries) Hash sizes CD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD Collating language Connection type Write separate records for conversational tasks? Directory in which Core Dump output is written Abort region if journal is inaccessible? Rescheduling interval for blocked ATIs (mins) Common Work Area Size AIX logical volume for data Format date for FORMATTIME (Obsolete) DCE cell name DCE cell name of remote system DCE cell name of the gateway Transaction deadlock timeout value (secs) SFS server or database storing CICS Queue Data Default modename for a SNA connection Name of the default user identier Delete access status Type of Queue Device Type for model entry File or path A holding the journal Disk A Status File or path B holding the journal Disk B Status Directory in which dump output is written Can transaction be dynamically routed? Time DCE password is cached for use by ECI application (secs)
519

Attribute name EmptyOpt EnableStatus Class FD FD PD TD ERRColor ERRHilight ERRIntensify ERRLastLine ErrorIsolation ESMLoad ESMModule Exclude ExtDS ExternalTrace ExtrapartitionFile FacilityId FacilityType FieldLength1 FieldLength20 FieldName1 FieldName20 FieldType1 FieldType20 FileProtection FileRSLCheck FileServer FileSystemType FileType Foreground GatewayCDSName GatewayLUName GatewayName WD WD WD WD FD RD RD MD WD RD TDD TDD TDD SCD SCD SCD SCD SCD SCD FD RD FD RD SCD WD GD GD CD Attribute description Empty status for rst le open File enable status Program enable status Transaction enable status Color for error messages Extended highlighting for error messages Should error messages be intensied? Display error messages on the last line? Error isolation Do you want to use an External Security Manager? Name of ESM Module Monitoring identiers to be excluded Is BMS to generate extended data streams? External trace facility required? Filename or path for EP queue data le System/Terminal for a triggered task Type of facility allocated for triggered task Field 1 - Length Field 20 - Length Field 1 - Name Field 20 - Name Field 1 - Type Field 20 - Type Protection level per OFD Type of RSL checking for Files File Server Type of le system CICS File Type Is foreground color supported? CDS path name of the gateway SNA LU name of the gateway Gateway Denition (GD) entry name
520

Attribute name GatewayPrincipal GroupName Class GD Attribute description DCE principal under which this gateway runs
CD, FD, Group to which resource belongs GD, JD, LD, PD, TD, TDD, TSD, UD, WD, XAD RD WD RD SSD MD SCD SCD SCD SCD FD SCD SCD SCD SCD SCD SCD SCD SCD TDD TD JD CD RD RD TD TDD Startup groups Does terminal support highlighting? HTML Browser for help text Idle timeout Monitoring identiers to be included Secondary Index 1 - Descending Fields Secondary Index 10 - Descending Fields Secondary Index 1 - Field Names Secondary Index 10 - Field Names Server Index Name Secondary Index 1 - Name Secondary Index 10 - Name SFS ONLY: Secondary Index 1 - Preallocated Pages SFS ONLY: Secondary Index 10 - Preallocated Pages Secondary Index 1 - Is it Unique? Secondary Index 10 - Is it Unique? SFS ONLY: Secondary Index 1 - Volume Name SFS ONLY: Secondary Index 10 - Volume Name Indirect Queue Name Effect of FORCEPURGE for InDoubt transactions Open journal on region startup? Set connection in service? Interval between region consistency checks (mins) Level of checking to perform on region Contexts in which transaction can START Input/Output Mode of EP Queue
Groups Highlight HTMLBrowser IdleTimeout Include IndexFieldDescenders1 IndexFieldDescenders10 IndexFieldNames1 IndexFieldNames10 IndexName IndexName1 IndexName10 IndexPreallocatePages1 IndexPreallocatePages10 IndexUnique1 IndexUnique10 IndexVolumeName1 IndexVolumeName10 IndirectQueueId InDoubt InitialOpenFlag InService IntrospectInterval IntrospectLevel InvocationMode IOMode
521

Attribute name IsBackEndDTP ISCDelayMinutes IsPrinter IsShippable JournalRSLCheck Katakana KeyLen LinkUserId ListenerName LoadDataNumBuckets LocalLUName LocalNetworkName LocalQ LocalQFile LocalQIndex LocalQMaxRecs LocalQPrePages LocalQProtectFile LocalQProtectIndex LocalQProtection LocalQProtectMaxRecs LocalQProtectPrePages LocalQProtectProtection LocalQProtectVol LocalQVol LocalSysId LogFile LogicalTDQFile LogicalTDQIndex LogicalTDQMaxRecs LogicalTDQPrePages Class TD RD WD WD RD WD FD CD CD RD RD RD TD RD RD RD RD RD RD RD RD RD RD RD RD RD SSD RD RD RD RD Attribute description Is back end of a DTP transaction? Retransmission interval for queued ATIs (mins) Is this an output only device? Is terminal denition shippable? Type of RSL checking for Journals Does terminal support Katakana? Key length to use with remote requests UserId for inbound requests Listener Denition (LD) entry name Number of LOADed data Address Hash Buckets Local LU name Network name to which local region is attached Locally Queue ATI requests for this transaction? SFS le for Locally-Queued Unprotected STARTs SFS Index for Locally-Queued Unprotected STARTs Maximum number of records for Local Qs Number of pages to preallocate for LocalQFile SFS le for Locally-Queued Protected STARTs SFS Index for Locally-Queued Protected STARTs Min protect level for locally queued ATIs Maximum number of records for Locally-Queued Protected STARTs Number of pages to preallocate for LocalQProtectFile Min protect level for locally queued PROTECT ATIs Locally-Queued Protected START Volume Name Local Q Volume Name Region system identier (short name) Log File Name SFS le storing Logically Recoverable TDQs SFS Index for Logically Recoverable TDQs Maximum number of records for Logically Recoverable TDQs Number of pages to preallocate for LogicalTDQFile
522

Attribute name LogicalTDQProtection LogicalTDQVol LogVolume MaxConsoleSize MaxRecords MaxRegionPool MaxServer MaxTaskCPUAction MaxTaskCPU MaxTaskPrivatePool MaxTSHPool MinServer ModelId Modiable Class RD RD Attribute description Min protect level for logical TDQs Logically Recoverable TDQ Volume Name
GSD, SSD AIX logical volume for logging RD SCD RD RD RD TD RD TD RD RD RD WD RD MD Maximum Console size SFS ONLY: Maximum Number of Records Region Pool Storage Size (bytes) Maximum number of Application Servers to maintain CICS on Open Systems CICS on Open Systems Task-private Storage Size (bytes) Task Shared Pool Storage Size (bytes) Minimum number of Application Servers to maintain Autoinstall Model Identier Protect resource from modication? Protect the resource from modication? Set monitoring on? Enable MRA Archiving? local Named Pipe name
MonitorStatus MRAArchivingEnabled NamedPipeName (CICS for Windows NT) NameService
MD SSD LD
GSD, SSD Name Service for advertising server RD Use DCE Name Service (CDS) to locate CICS and Encina servers? NetName of the shell terminal SFS le storing Non-Recoverable TDQs SFS Index for Non-Recoverable TDQs Maximum number of records for Non-recoverable TDQs Number of pages to preallocate for NonRecTDQFile Min protect level for non-recoverable TDQs Non-recoverable TDQ Volume Name SFS le storing Non-Recoverable Auxiliary TSQs SFS Index for Non-Recoverable Auxiliary TSQs Maximum number of records for Non-recoverable TSQs Number of pages to preallocate for NonRecTSQFile
NetName NonRecTDQFile NonRecTDQIndex NonRecTDQMaxRecs NonRecTDQPrePages NonRecTDQProtection NonRecTDQVol NonRecTSQFile NonRecTSQIndex NonRecTSQMaxRecs NonRecTSQPrePages
WD RD RD RD RD RD RD RD RD RD RD
523

Attribute name NonRecTSQProtection NonRecTSQVol NumColumns NumLines OpenMode OpenStatus OpID OpThreadPoolSize OutboundUserIds Outline OutService PathName PCDump Permanent Class RD RD WD WD TDD FD UD SSD CD WD WD PD RD Attribute description Min protect level for non-recoverable TSQs Non-recoverable TSQ Volume Name Number of columns on terminal Number of lines on terminal Open EP output les truncated or append File open status Operator ID Number of threads devoted to normal operations Send userids on outbound requests? Does terminal support eld outlining? Set terminal out of service? Program path name Should CICS system be dumped for ASRA abends?
Protect resource from modication? CD, FD, GD, GSD, JD, LD, PD, SCD, SSD, TD, TDD, TSD, UD, WD, XAD
PhysicalTDQFile PhysicalTDQIndex PhysicalTDQMaxRecs PhysicalTDQPrePages PhysicalTDQProtection PhysicalTDQVol PreallocatePages PrePages PrimaryIndexDescenders PrimaryIndexFields PrimaryIndexName
RD RD RD RD RD RD SCD FD SCD SCD SCD
SFS le storing Physically Recoverable TDQs SFS Index for Physically Recoverable TDQs Maximum number of records for Physically Recoverable TDQs Number of pages to preallocate for PhysicalTDQFile Min protect level for physical TDQs Physically Recoverable TDQ Volume Name SFS ONLY: Number of Pages to Preallocate Number of pages to preallocate Descending Field Names for Primary Index Field Names for Primary Index Primary Index Name
524

Attribute name PrimaryIndexUnique Principal Priority Class SCD UD WD TD UD ProgName ProgramCacheSize ProgramRSLCheck ProgramSymbols ProgType ProtectionLevel ProtectPurgeDelayPeriod Protocol PublicUserTraceFile Purgeability PurgeDelayPeriod RDBMSInstance ReadOpt RecordLen RecordSize RecordTerminator RecordType RecoverFlag RecoverStatus RecoveryType RecTSQFile RecTSQIndex RecTSQMaxRecs RecTSQPrePages RecTSQProtection RecTSQVol TD RD RD WD PD Attribute description Is Primary Index Unique? DCE principal of the user Terminal priority Transaction Priority User priority First program name Maximum number of C or IBM COBOL programs that can be cached Type of RSL checking for Programs Program Symbols Program type
GSD, SSD Protection level RD LD RD TD RD RD FD TDD FD TDD TDD TSD FD TDD RD RD RD RD RD RD Purge delay period for PROTECT requests (hours) Protocol type User Trace le or path for guest logins Transaction purgeability Purge delay period for no PROTECT requests (hours) The RDBMS Instance name Read access status Record length for xed length EP queue Record length to use with remote requests ASCII value of terminator for xed length queue Record organization for EP queue data le Is queue recoverable? Recoverability status Recoverability type of IP queue SFS le storing Recoverable Auxiliary TSQs SFS Index for Recoverable Auxiliary TSQs Maximum number of records for Recoverable Auxiliary TSQs Number of pages to preallocate for RecTSQFile Min protect level for recoverable TSQs Recoverable Auxiliary TSQ Volume Name
525

Attribute name RegionPoolBase RegionPoolThreshold ReleaseNum RemoteCodePageTR RemoteLUName RemoteName Class RD RD RD CD CD PD FD TDD, TSD TD WD RemoteNetworkName RemoteSysEncrypt RemoteSysId CD CD Attribute description Region Pool base register Threshold for Region Pool short on storage (%age) CICS Release Number Code page for transaction routing Name of remote system Name to use for program on remote system Remote lename Remote Queue Name Remote Transaction Identier Terminal identier on remote system SNA network name for the remote system Transmission encryption level
TD, TDD, Remote System Identier TSD FD PD WD Remote System Name Remote system on which to run program System to which terminal belongs Security level for inbound requests TCP address for the remote system TCP port number for the remote system Is this a program that should be cached?
RemoteSysSecurity RemoteTCPAddress RemoteTCPPort Resident ResourceDescription
CD CD CD PD
Resource description CD, FD, GD, GSD, JD, LD, MD, PD, RD, SCD, SSD, TD, TDD, TSD, UD, WD, XAD SSD RD TD Number of threads devoted to resource operations Number of threads for RPC requests Type of RSL Checks
ResThreadPoolSize RPCListenerThreads RSLCheck
526

Attribute name RSLKey Class FD, JD, PD, TD, TDD, TSD UD, WD Attribute description Resource Level Security Key
RSLKeyList
Resource Level Security Key List
RSLKeyMask RuntimeProtection SafetyLevel ServerIdleLimit ServerSideTran ShortName ShutdownProgList1 ShutdownProgList2 SNAConnectName SNADefaultModeName SNAModeName SNAServerNodeName SOSI StartType
CD RD RD RD RD
Resource Security Level (RSL) Key Mask Min protect level used when accepting RPCs Level of protection against user corruption Time before Application Servers terminate (secs) Server side transactions only ?
GSD, SSD Short name used for SRC RD RD CD GSD TD LD WD Programs to execute at phase 1 of shutdown Programs to execute at phase 2 of shutdown SNA prole describing the remote system SNA default mode name (HP only) SNA modename for this transaction local SNA Node Name Does terminal support SOSI
GSD, SSD Cold or auto start? RD Startup type Programs to execute at startup File or path for statistics Should stats be recorded at every interval? Should map names be suffixed? Switch Load File Path Name Type of Syncpoint Flows System dump on shutdown, SNAP dumps, ASRx abends? System trace buffer size Task Shared Pool base register Number of Task Shared Pool Address Hash Buckets Threshold for TSH Pool short on storage (%age) The class of transaction
StartupProgList StatFile StatsRecord SufficesSupported SwitchLoadFile Syncpoint SysDump SysTraceBufferSize TaskSharedPoolBase TaskSHNumBuckets TaskShPoolThreshold TClass
RD RD RD RD XAD TD RD RD RD RD RD TD
527

Attribute name TCPAddress TCPService TCTUALen TDPurgeInterval Class LD LD WD RD Attribute description TCP adapter address TCP service name Length of TCTUA Interval, in minutes, indicating the time between purging of read records in the transient data queues by the CICS-private transaction CTDP TDQ to hold monitoring information
TDQ TemplateDened
MD
FD, PD, Is a user conversion template dened? TD, TDD, TSD
TemporaryStorageRSLCheck TerminalProtection TermSubType TermType ThreadPoolSize Timeout TPNSNAProle Trace TraceFile TraceFileA TraceFileB TraceFileSize TraceModules TransactionRSLCheck TransDump TransDumpTrace TransId TransientDataRSLCheck TriggeredTransId TriggerLevel TSLCheck TSLKey
RD WD WD WD GSD TD TD RD UD RD RD RD RD RD TD RD PD RD TDD TDD TD TD
Type of RSL checking for TSQs Protection level Terminal subtype Terminal type Number of threads for RPC requests Conversational timeout value (mins) SNA TPN prole for APPC listener program Modules to trace User Trace lename File or path (A) for system trace File or path (B) for system trace Maximum system trace le size Module list for partial trace Type of RSL checking for Transactions Should transaction be dumped on an abend? Transaction Dump Trace Transaction name on remote system for program Type of RSL checking for TDQs Triggered Transaction Identier Trigger Level Type of TSL Checks Transaction Level Security Key
528

Attribute name TSLKeyList Class UD, WD Attribute description Transaction Level Security Key List
TSLKeyMask TSQAgeLimit TWASize UCTranFlag
CD RD TD TD WD
Transaction Security Level (TSL) Key Mask Expiry limit for unaccessed TSQs (days) Transaction Work Area Size Should data be converted to uppercase? Should terminal convert data to uppercase? Update access status User Exit number
UpdateOpt UserExitNumber UserID UserMonitorModule UserTraceDirectory Validation VariableFieldLength VariableFieldName VariableFieldType VolumeName WhenOpened XAClose XAOpen XASerialize
FD PD
GSD, SSD AIX user ID for server MD RD WD SCD SCD SCD SCD TDD XAD XAD XAD File or path of user monitoring program User trace directory Does terminal support eld validation? Variable Field - Length Variable Field - Name Variable Field - Type SFS ONLY: Volume Name Time at which queue is to be opened Resource Manager Termination String Resource Manager Initialization String Resource Manager Serialization Attribute
529
530
Bibliography
v CICS Administration Guide v CICS Intercommunication Guide, SC09-4462 v CICS Application Programming Guide, SC09-4460 v CICS Problem Determination Guide, SC09-4465 v Encina Administration Guide Volume 2: Server Administration, SC09-4474 v Concepts and Facilities, SC09-4455 v CICS Application Programming Reference, SC09-4461 v Planning and Installation Guide v CICS Clients: Administration, SC33-1792 v Encina Administration Guide Volume 1: Basic Administration, SC09-4473 v Using IBM Communications Server for AIX with CICS, SC09-4469 v Using IBM Communications Server for Windows NT with CICS, SC09-4470 v Using Microsoft SNA Server with CICS, SC09-4471 v Using SNAP-IX for Solaris with CICS, SC09-4472 v Using HP-UX SNAplus2 with CICS v VTAM Messages and Codes v SNA Formats v v v v v v v Conventional LUA Programming Reference SNA Formats VTAM Messages and Codes SNA Formats Conventional LUA Programming Reference SNA Formats CICS IIOP ORB Programming Guide, SC09-4467 v CICS Administration Reference, SC09-4459 v CICS Family: Client/Server Programming, SC33-1435
531
532
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the users responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS DOCUMENT AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the document. IBM may make
533
improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: For Component Broker: IBM Corporation Department LZKS 11400 Burnet Road Austin, TX 78758 U.S.A. For TXSeries: IBM Corporation ATTN: Software Licensing 11 Stanwix Street Pittsburgh, PA 15222 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary signicantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specic environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available
534
sources. IBM has not tested those products and cannot conrm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples may include the names of individuals, companies, brands, and products. All of these names are ctitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. If you are viewing this information softcopy, the photographs and color illustrations may not appear.
Trademarks and service marks

The following terms are trademarks or registered trademarks of the IBM Corporation in the United States, other countries, or both:
AFS AIX AS/400 CICS CICS OS/2 CICS/400 CICS/6000 CICS/ESA CICS/MVS CICS/VSE CICSPlex DB2 DCE Encina Lightweight Client DFS Encina IBM IMS MQSeries MVS/ESA OS/2 OS/390 OS/400 PowerPC RISC System/6000 RS/6000 S/390 Transarc TXSeries VSE/ESA VTAM VisualAge WebSphere
Microsoft, Windows, Windows NT, and the Windows 95 logo are trademarks of Microsoft Corporation in the United States and/or other countries. Oracle and Oracle8 are registered trademarks of the Oracle Corporation in the United States and/or other countries.
Notices
535
UNIX is a registered trademark of The Open Group in the United States and/or other countries licensed exclusively through X/Open Company Limited. OSF and Open Software Foundation are registered trademarks of the Open Software Foundation, Inc. * HP-UX is a Hewlett-Packard branded product. HP, Hewlett-Packard, and HP-UX are registered trademarks of Hewlett-Packard Company. Orbix is a registered trademark and OrbixWeb is a trademark of IONA Technologies Ltd. Sun, SunLink, Solaris, SunOS, Java, all Java-based trademarks and logos, NFS, and Sun Microsystems are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and/or other countries. Some of this documentation is based on material from Object Management Group bearing the following copyright notices: Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright 1995, 1996 AT&T/NCR 1995, 1996 BNR Europe Ltd. 1991, 1992, 1995, 1996 by Digital Equipment Corporation 1996 Gradient Technologies, Inc. 1995, 1996 Groupe Bull 1995, 1996 Expersoft Corporation 1996 FUJITSU LIMITED 1996 Genesis Development Corporation 1989, 1990, 1991, 1992, 1995, 1996 by Hewlett-Packard Company 1991, 1992, 1995, 1996 by HyperDesk Corporation 1995, 1996 IBM Corporation 1995, 1996 ICL, plc 1995, 1996 Ing. C. Olivetti &C.Sp 1997 International Computers Limited 1995, 1996 IONA Technologies, Ltd. 1995, 1996 Itasca Systems, Inc. 1991, 1992, 1995, 1996 by NCR Corporation 1997 Netscape Communications Corporation 1997 Northern Telecom Limited 1995, 1996 Novell USG 1995, 1996 02 Technolgies 1991, 1992, 1995, 1996 by Object Design, Inc. 1991, 1992, 1995, 1996 Object Management Group, Inc. 1995, 1996 Objectivity, Inc. 1995, 1996 Oracle Corporation 1995, 1996 Persistence Software
536
Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright Copyright
1995, 1996 Servio, Corp. 1996 Siemens Nixdorf Informationssysteme AG 1991, 1992, 1995, 1996 by Sun Microsystems, Inc. 1995, 1996 SunSoft, Inc. 1996 Sybase, Inc. 1996 Taligent, Inc. 1995, 1996 Tandem Computers, Inc. 1995, 1996 Teknekron Software Systems, Inc. 1995, 1996 Tivoli Systems, Inc. 1995, 1996 Transarc Corporation 1995, 1996 Versant Object Technology Corporation 1997 Visigenic Software, Inc. 1996 Visual Edge Software, Ltd.
Each of the copyright holders listed above has agreed that no person shall be deemed to have infringed the copyright in the included material of any such copyright holder by reason of having used the specication set forth herein or having conformed any computer software to the specication. WHILE THE INFORMATION IN THIS PUBLICATION IS BELIEVED TO BE ACCURATE, THE OBJECT MANAGEMENT GROUP, AND THE COMPANIES LISTED ABOVE MAKE NO WARRANTY OF ANY KIND WITH REGARDS TO THIS MATERIAL INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. The Object Management Group and the companies listed above shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.
This software contains RSA encryption code.
Other company, product, and service names may be trademarks or service marks of others.
Notices
537
538
Index
Special Characters
? (CECI) 308 & (CECI) 302 ? (CEMT) 323 ! (DDT command) 137 ? (DDT command) 138 ! (SDT command) 211 ? (SDT command) 212 + character (CEMT) 326 <Key> restrictions on use of characters 1 Acquired (continued) CEMT INQUIRE FENODE 379 ActivateOnStartup attribute communications denitions 2 le denitions 9 gateway denitions 12 journal denitions 16 listener denitions 19 object denitions 24 product denitions 25 program denitions 27 temporary storage denitions 64 terminal denitions 66 transaction denitions 74 transient data denitions 81 user denitions 86 ADD parameter CEMT inquire/set le 335 addindex (DDT command) 135 addindex (SDT command) 209 AddOpt attribute le denitions 9 aixterm autoinstall model 502 aixterm-m autoinstall model 502 AKP parameter CEMT inquire 355 ALL parameter CEMT 326 CEMT inquire/set le 335 CEMT inquire/set journal 338 CEMT inquire/set monitor 339 CEMT inquire/set program 342 CEMT inquire/set task 344 CEMT inquire/set tclass 347 CEMT inquire/set tdqueue 348 CEMT inquire/set terminal 351 CEMT inquire/set transaction 354 AllocateTimeout attribute communications denitions 2 AllowDebugging region denitions 33 AmendCounter attribute le denitions 9 gateway denitions 13 gateway server denitions 15 journal denitions 17 listener denitions 19 monitoring denitions 22 AmendCounter attribute (continued) object denitions 24 product denitions 25 program denitions 27 region denitions 33 schema le denitions 58 SFS denitions 61 temporary storage denitions 64 terminal denitions 67 transaction denitions 74 transient data denitions 81 user denitions 86 ampersand (CECI) 302 Appl CEMT INQUIRE FETARGET 387 Application Diagnosis Conguration (CDCN) data entry elds 289 description of 287 overview 273 PF (program function) key values 289 reference 287 screen layout 288 syntax 287 APPLID parameter CEMT inquire 355 archive copying resource denitions 153 restoring resource denitions 166 ASCII multi-byte monochrome autoinstall model 503 ASCII single-byte monochrome autoinstall model 503 ASRA dump 334 ASRB dump 334 asterisk character (CEMT) 326 ATI parameter CEMT inquire netname 340 CEMT inquire/set terminal 351 attribute name attribute description cross-reference 507 AuthenticationService attribute region denitions 33 AutoDCELogin attribute region denitions 33
Numerics
327x-3 autoinstall model for cicsteld 504 327x-3-E autoinstall model for cicsteld 504 327x-4 autoinstall model for cicsteld 507 327x-4-E autoinstall model for cicsteld 507 327x-5 autoinstall model for cicsteld 507 327x-5-E autoinstall model for cicsteld 507 327x-x-E for cicsteld autoinstall model 504 327x-x for cicsteld autoinstall model 504 97801 autoinstall model 507
A
abbreviations for keywords 276 ABDump attribute region denitions 32 ABDUMP parameter CEMT inquire/set dumpoptions 334 abnormal termination dump 334 abnormally terminate user task (EDF) 315 about to execute command CECI or CECS information 301 ACL set for CICS directories and groups 219 Acquired CEMT INQUIRE FECONNECTION 373 Copyright IBM Corp. 1999
539
autoinstall autoinstall program parameters 393 terminal Autoinstall user program 390 the supplied program 390 when the program is accessed 394 autoinstall models 501 327x-3-E for cicsteld 504 327x-3 for cicsteld 504 327x-4-E for cicsteld 507 327x-4 for cicsteld 507 327x-5-E for cicsteld 507 327x-5 for cicsteld 507 327x-x-E for cicsteld 504 327x-x for cicsteld 504 97801 507 aixterm 502 aixterm-m 502 ASCII multi-byte monochrome 503 ASCII single-byte monochrome 503 dtterm 504 dxterm (vt300) 504 hp terminal denition 503 hpterm denition 503 IBM CICS Client 502 IBM CICS ECI 502 ibm3151 502 ibm3161 502 ibm3164 502 Sun command tool and shell tool 507 vt100 502 vt220 504 Windowed multi-byte color 503 Windowed multi-byte monochrome 503 Windowed single-byte color 503 Windowed single-byte monochrome 503 xterm 504 AUTOINSTALL parameter CEMT inquire/set 331 AutoinstallMode attribute region denitions 33 automatic transaction initiation restriction with routing transaction 365 Automatic Transaction Initiation (ATI) 340, 351 auxiliary trace CEMT inquire/set 332, 353
AUXTRACE parameter CEMT inquire/set 332
B
BaseName attribute le denitions 9 BASENAME parameter CEMT FILE 335 binding strings 159 blank elds in a screen CEMT 328 BROWSE parameter CEMT inquire/set le BrowseOpt attribute le denitions 9 BufferPoolSize attribute SFS denitions 61
335
C
C programs caches 31, 45 Cached attribute object denitions 25 CALF transaction data entry elds 283 description of 281 error screen layout 282 information elds 284 overview 273 PF (program function) key values 285 reference 281 screen layout 281, 282, 289 status information 285 syntax 281 CanStartATIs attribute terminal denitions 67 CanStartTTIs attribute terminal denitions 67 CARPDelayHours attribute region denitions 33 CD (Communications Denitions) CDCN transaction data entry elds 289 description of 287 overview 273 PF (program function) key values 289 reference 287 screen layout 288 syntax 287 CEBR transaction command input area 293 description of 292 information area 295
CEBR transaction (continued) overview 273 PF(program function) key values 295 reference 292 screen layout 293 syntax 292 using the transaction 292 CECI transaction command input 299 description of 298 information area 300 invoking 306 overview 273 PF (program function) key values 304 reference 298 screen layout 299, 306, 307 security rules 298 status area 299 syntax 298 CECS 298 CECS transaction command input 299 description of 298 information area 300 invoking 306 overview 273 PF (program function) key values 304 reference 298 screen layout 299, 306 security rules 298 status area 299 syntax 298 CEDF transaction 310 description of 309 information area 312 interception points 316 invoking EDF 310 overtyping 315 overview 273 parameters 309 PF (program function) key values 313 reference 309 screen layout 310, 318 security 310 status area 312 stopping the application run 318 syntax 309 cell_admin_pw environment variable 98, 100, 101, 103, 107, 110, 115, 117, 119, 122
540
Cell Directory Service congure for CICS 218 directories for CICS 218 CEMT INQUIRE 328 CEMT SET 329 CEMT transaction 369 ? character 323 + character 326 AKP parameter 355 APPLID parameter 355 AUTOINSTALL parameter 331 auxiliary trace 353 AUXTRACE parameter 332 blank elds in a screen 328 command line request 323 DATEFORM parameter 355 description of 321 DISCARD 370 DUMP parameter 333 DUMPOPTIONS parameter 334 FILE parameter 335 INQUIRE 323 INQUIRE FECONNECTION 371 INQUIRE FENODE 377 INQUIRE FEPOOL 381 INQUIRE FEPROPSET 384 INQUIRE FETARGET 386 inquire/set overview 328 inquiring about a resource 327 INTROINTVL parameter 355 invoking 323 JOURNAL parameter 338 LOCALE parameter 355 MAXREGIONPOOL parameter 356 MAXTASKSHPOOL parameter 356 MONITOR parameter 339 NETNAME parameter 340 OPREL parameter 356 OPSYS parameter 356 overtyping a screen 327 overview 273 parameters, overview of 321 PERFORM 323 PERFORM SNAP 330 PF (program function) key values 325 PROGRAM parameter 342 prompting for options 323 reference 321 REGIONTHRESH parameter 356 RELEASE parameter 356
CEMT transaction 369 (continued) request formats 324 screen layout 324 scrolling a screen 326 SET 323 syntax 321 SYSID parameter 356 system parameters 355 tab key 328 TASK parameter 344 TASKTHRESH parameter 356 TCLASS parameter 347 TDQUEUE parameter 348 TERMINAL parameter 351 TRACE parameter 353 TRANSACTION parameter 354 using with CRTE 366 CESF transaction 357 description of 357 overview 273 reference 357 syntax 357 CESN transaction description of 359 overview 274 reference 359 security 359 syntax 359 use as initial transaction 248 character restrictions 1 Checkpoint attribute SFS denitions 61 CheckpointInterval attribute region denitions 33 CICS (Customer Information Control System) CICS-supplied transactions 369 CICS client cicsmigrateclients command 186 cicssetupclients command 216 CICS Client Autoinstall 389 CICS control program cicscp command 97 CICS_HOSTS environment variable 122, 159, 228, 250, 253, 256 CICS_PPCGWY_SERVER environment variable 192 CICS_PPCGWY_SIZE environment variable 106 CICS_PPCGWY_VG environment variable 106 CICS_SFS_DATA_SIZE environment variable 114
CICS_SFS_DATA_VG environment variable 114 CICS_SFS_LOG_SIZE environment variable 114 CICS_SFS_LOG_VG environment variable 114 CICS_SFS_SERVER environment variable 203, 227, 494 CICS_SFS_SIZE environment variable 114, 493 CICS_SFS_VG environment variable 114, 493 CICS-supplied programs CICS Client Autoinstall 389 External Security Manager (ESM) 389 function shipping 389 Overview 389 performance monitoring user program 389 Terminal Autoinstall 389 transaction routing 389 user conversion programs 389 CICS-supplied transactions complete list 278 CICS_SUPPRESS_XAOPEN_STRING environment variable 26, 493 cics_UE_Return_t 408 cics_UE014015_t 411 cics_UE052017_t 411 CICS_XDT_SERVER environment variable 131, 203 cicsadd command 91 cicscleandce command 94 CICSCOL environment variable 176 cicscopystanza command 96 cicscp all options 100 cicscp COBOL commands 101 cicscp command 97 cicscp commands all option 100 COBOL commands 101 DCE commands 102 PPC Gateway server commands 105 region commands 109 sfs_server commands 113 SNA commands 117 SNA link commands 119 telnet server commands 121 cicscp DCE commands 102 cicscp PPC Gateway server commands 105 cicscp region commands 109 cicscp sfs_server commands 113 Index
541
cicscp SNA commands 117 cicsmfmt functions 425 (continued) cicsstart command 240 cicscp SNA link commands 119 CICS_MFMT_ReleaseCatalogue 428 cicsstop command 242 cicscp telnet server commands 121 cicsmigrate command 181 cicstail command 243 cicscvt command 124 cicsmigrateclass command 184 cicstcpnetname command 245 cicsdb2conf command 46, 126 cicsmigrateclients command 186 cicsteld command 247 CICSDB2CONF_CONNECT_USER cicsmkcobol 187 cicsterm command 251 environment variable 491 cicsnetdata program 138, 212 CICSTERM environment CICSDB2CONF_CONNECT_USING running 140, 213 variable 254 environment variable 491 cicsnotify 190 cicstermp command 255 cicsdb2import command 129 cicsnotify command 190 cicstfmt 258 cicsddt command 131 CICSPassword attribute cicstracelter 261 cicsddt commands user denitions 86 cicsupdate command 263 ! 137 cicsppcgwy command 191 cicsupdateclass command 267 addindex 135 cicsppcgwycreate command 193 cicsusedceservers command 270 create 133 cicsppcgwydestroy command 195 CICSUserId attribute database 136 cicsppcgwylock command 197 listener denitions 19 delete 135 cicsppcgwyshut command 199 ClassMaxTaskLim attribute delindex 135 cicsprCOBOL 187 region denitions 34 dtof 137 CICSREGION environment ClassMaxTasks attribute empty 135 variable 92, 146, 151, 154, 157, region denitions 34 ftod 137 161, 169, 201, 241, 242, 259, 264 ClassTableSize attribute help (?) 138 cicsremovelv command 200 region denitions 35 info 136 cicsrlck 201 CLINTCP option on DFHCNV list 132 cicssdt command 203 macro 249 qtod 136 cicssdt commands CLOSED parameter quit 138 CEMT inquire/set le 335 ! 211 read 133 CEMT inquire/set journal 338 addindex 209 user 136 CEMT inquire/set tdqueue 348 create 205 write 134 CMLV transaction delete 208 cicsdefault command 142 delindex 209 description of 362 cicsdefaultservers 144 empty 208 overview 274 cicsdelete command 145 free 208 PF (program function) key cicsdestroy command 148 ftos 211 values 362 cicsdfmt 150 help (?) 212 reference 362 cicsexport command 153 info 209 syntax 362 cicsget command 156 list 205 COBDIR environment variable 188 cicsgetbindingstring command 159 qtos 210 COBLIB environment variable 188 cicsgpid 161 quit 212 COBOL read 206 cicshpterm command 162 setting up for Micro Focus server 210 cicsimport command 166 COBOL 187 setopen 205 cicsimportl 167 COBSW environment variable 342 stof 210 cicsinstall command 169 code page, specifying 247 write 207 cicsivp command 171 CollatingLanguage attribute cicssetupclients command 216 CICSKEY environment variable 176 SFS denitions 61 cicssetupdce command 218 cicslssrc command 173 command execution complete cicssfmt 221 cicslterm command 175 CECI or CECS information 302 cicssfmt functions 429 cicsmakelv command 178 Command Level Interpreter (CECI) cicssfs command 225 cicsmfmt 179 command input 299 cicssfsconf command 228 cicsmfmt functions 425 description of 298 CICS_MFMT_CloseMonitorFile 426 cicssfscreate command 230 information area 300 cicssfsdestroy command 233 CICS_MFMT_FindField 428 invoking 306 cicssfsimport command 235 CICS_MFMT_FreeMessage 428 overview 273 cicssfslock 237 CICS_MFMT_GetMessage 428 PF (program function) key CICS_MFMT_OpenMonitorFile 426 cicssfsshut command 238 values 304 CICS_MFMT_ReadNext 427 cicssrcdestroy command 148 reference 298
542
Command Level Interpreter (CECI) (continued) screen layout 299, 306, 307 security rules 298 status area 299 syntax 298 command syntax check CECI or CECS information 301 commandName parameter CECI and CECS transactions 298 commands 3270 terminal emulation 175, 251 CEMT DISCARD 370 cicsadd 91 cicscleandce 94 cicscp 97 cicscp all 100 cicscp COBOL 101 cicscp DCE 102 cicscp PPC Gateway server 105 cicscp region 109 cicscp sfs_server 113 cicscp SNA 117 cicscp SNA link 119 cicscp telnet server 121 cicscvt 124 cicsdb2conf 126 cicsdb2import 129 cicsddt 131 cicsdefault 142 cicsdelete 145 cicsdestroy 148 cicsdfmt 150 cicsexport 153 cicsget 156 cicsgetbindingstring 159 cicsgpid 161 cicsimport 166 cicsinstall 169 cicsivp 171 cicslssrc 173 cicslterm 175 cicsmakelv 178 cicsmfmt 179 cicsmkcobol 187 cicsnotify 190 cicsppcgwy 191 cicsppcgwycreate 193 cicsppcgwydestroy 195 cicsppcgwyshut 199 cicsremovelv 200 cicssdt 203 cicssetupdce 218
commands (continued) cicssfmt 221 cicssfs 225 cicssfsconf 228 cicssfscreate 230 cicssfsdestroy 233 cicssfsimport 235 cicssfslock 237 cicssfsshut 238 cicsstart 240 cicsstop 242 cicstail 243 cicstcpnetname 245 cicsteld 247 cicsterm 251 cicstfmt 258 cicstracelter 261 cicsupdate 263 cicsusedceservers 270 Commands 3270 terminal emulation 162 cicshpterm 162 cicsppcgwylock 197 Communications Denitions (CD) 1 conguring DB2 cicsdb2conf command 126 conguring SFS cicssfsconf command 228 ConnectionType attribute communications denitions 2 Console Message Log Viewer (CMLV) description of 362 overview 274 reference 362 syntax 362 constants for user exits 408 Control Panel Language setting 248 Conversational attribute monitoring denitions 22 copying a region 153 CoreDumpName attribute region denitions 35 create (DDT command) 133 create (SDT command) 205 CRTE transaction automatic transaction initiation 365 description of 364 overview 274 reference 364 syntax 364 SYSID parameter 364 using with CEMT 366
CrucialFlag attribute journal denitions 17 CSSF 357 CSSF transaction 357 description of 357 overview 274 reference 357 syntax 357 CSTD transaction description of 367 overview 274 PF (program function) key values 368 reference 367 screen layout 367 syntax 367 CUBSDelayMinutes attribute region denitions 35 CWASize attribute region denitions 35
D
Data Conversion (CALF) data entry elds 283 description of 281 error screen layout 282 information elds 284 overview 273 PF (program function) key values 285 reference 281 screen layout 281, 282, 289 status information 285 syntax 281 database (DDT command) 136 DATASET parameter CEMT inquire/set journal 338 DataVolume attribute SFS denitions 61 DateForm attribute region denitions 35 DATEFORM parameter CEMT inquire 355 DB2 Diagnostic Tool cicsddt command 131 DB2DBDFT environment variable 129, 131 DB2INSTANCE environment variable 46 DCE CDS 270 congure for CICS 218 DCE client 186 deleting CICS directories and groups 94 Index
543
DCE (continued) directory service 159 security services 270 DCECell attribute communications denitions 3 gateway denitions 13 user denitions 86 DDT commands ! 137 addindex 135 create 133 database 136 delete 135 delindex 135 dtof 137 empty 135 ftod 137 help (?) 138 info 136 list 132 QSAM to DB2 le transfer 138 qtod 136 quit 138 read 133 user 136 write 134 DeadLockTimeout attribute transaction denitions 74 deallocating resources 190 debugging a remote transaction 310 debugging tool EDF 309 default region copying 142 dump directory 150 DefaultFileServer attribute region denitions 54 DefaultSNAModeName communications denitions 3 DefaultUserId attribute region denitions 35 dening and managing resources Communications Denitions (CD) 1 File Denitions (FD) 8 Gateway Denitions (GD) 12 Gateway Server Denitions (GSD) 14 Journal Denitions (JD) 16 Listener Denitions (LD) 19 Monitoring Denitions (MD) 21 object denitions 24 Product Denitions (XAD) 25 Program Denitions (PD) 27 Region Denitions (RD) 32
dening and managing resources (continued) Region Denitions for le server (RD) 54 Temporary Storage Denitions (TSD) 64 Terminal Denitions (WD) 66 Transaction Denitions (TD) 73 Transient Data Denitions (TDD) 81 User Denitions (UD) 85 denition les used by qtod 140 denition les used by qtos 214 delete (DDT command) 135 delete (SDT command) 208 DELETE parameter CEMT inquire/set le 336 DeleteOpt attribute le denitions 9 delindex (DDT command) 135 delindex (SDT command) 209 DEST parameter CEMT inquire/set task 344 destid parameter CEMT inquire/set tdqueue 348 DestType attribute transient data denitions 81 Device CEMT INQUIRE FEPOOL 383 DevType attribute terminal denitions 67 DFHCHATX, terminal autoinstall program 391 DFHCNV macro CLINTCP option 249 conversion by cicscvt 124 SRVERCP option 249 DISABLED parameter CEMT inquire/set le 336 CEMT inquire/set tdqueue 348 CEMT inquire/set transaction 354 DiskA attribute journal denitions 17 DiskAStatus attribute journal denitions 17 DiskB attribute journal denitions 17 DiskBStatus attribute journal denitions 18 DISPATCHABLE parameter CEMT inquire/set task 344 dtof (DDT command) 137 dtterm autoinstall model 504 dual screen mode (EDF) 320
dump CEMT 334 CEMT requests 330 dump formatter command 150 DUMP parameter CEMT 330 CEMT inquire/set 333 dump request user exit (17) 411 dump statistics 441 DumpName attribute region denitions 36 DUMPOPTIONS parameter CEMT inquire/set 334 dxterm (vt300) autoinstall model 504 Dynamic attribute transaction denitions 74 dynamic distributed program link user exit (50) 418 dynamic transaction routing user exit (25) 413
E
ECIPasswordCacheSeconds region denitions 36 EDF 309, 310 dual screen mode 320 information area 312 interception points 316 invoking 310 overtyping 315 parameters 309 PF (program function) key values 313 screen layout 310, 318 security 310 status area 312 stopping the application run 318 empty (DDT command) 135 empty (SDT command) 208 emptying journals 17 emptying transient data queues 83 EmptyOpt attribute le denitions 9 ENABLED parameter CEMT inquire/set le 336 CEMT inquire/set tdqueue 348 CEMT inquire/set transaction 354 EnableStatus attribute le denitions 9 program denitions 28 transaction denitions 75 ENCINA_BINDING_FILE environment variable 159, 203
544
Encina SFS 159, 270 ErrorIsolation attribute le denitions 9 ENCINA_SFS_SERVER environment variable 493 ESM (External Security Manager) 389 encryption 5 ESMLoad attribute environment variables 491 region denitions 37 cell_admin_pw 98, 100, 101, 103, ESMModule attribute 107, 110, 115, 117, 119, 122 region denitions 37 CICS_HOSTS 122, 159, 228, 250, Exclude attribute 253, 256 monitoring denitions 22 CICS_PPCGWY_SERVER 192 CICS_PPCGWY_SIZE 106 exec interface block CICS_PPCGWY_VG 106 CECI or CECS information 302 CICS_SFS_DATA_SIZE 114 Execution Diagnostic Facility (CEDF) CICS_SFS_DATA_VG 114 description of 309 CICS_SFS_LOG_SIZE 114 information area 312 CICS_SFS_LOG_VG 114 interception points 316 CICS_SFS_SERVER 203, 227, 494 invoking EDF 310 CICS_SFS_SIZE 114, 493 overtyping 315 CICS_SFS_VG 114, 493 overview 273 CICS_SUPPRESS_XAOPEN_STRING 26, parameters 309 493 PF (program function) key CICS_XDT_SERVER 131, 203 values 313 CICSCOL 176 reference 309 CICSDB2CONF_CONNECT_USER 491 screen layout 310, 318 CICSDB2CONF_CONNECT_USING 491 security 310 CICSKEY 176 status area 312 CICSREGION 92, 146, 151, 154, stopping the application 157, 161, 169, 201, 241, 242, 259, run 318 264 syntax 309 CICSTERM 254 Execution Diagnostic Facility (EDF) COBDIR 188 dual screen mode 320 COBLIB 188 information area 312 COBSW 342 interception points 316 DB2DBDFT 129, 131 invoking 310 DB2INSTANCE 46 overtyping 315 ENCINA_BINDING_FILE 159, parameters 309 203 PF (program function) key ENCINA_SFS_SERVER 493 values 313 LANG 248, 254 screen layout 310, 318 LD_LIBRARY_PATH 188 security 310 LIBPATH 188 security rules 310 LOGNAME 259 status area 312 PATH 188 stopping the application SHLIB_PATH 188 run 318 TERM 254 EXIT parameter 357 XID_NODE_ID 119 expansion of ERRColor attribute CECI or CECS information 304 terminal denitions 67 ExtDS attribute ERRHilight attribute terminal denitions 68 terminal denitions 67 External Security Manager ERRIntensify attribute (ESM) 389 terminal denitions 68 The supplied program 395 ERRLastLine attribute ExternalTrace attribute terminal denitions 68 region denitions 37
EXTRA parameter CEMT inquire/set tdqueue 348 ExtrapartitionFile attribute transient data denitions 81
F
FACILITY parameter CEMT inquire/set task 344 FacilityId attribute transient data denitions 81 FacilityType attribute transient data denitions 82 FD (File Denitions) 8 Feno CEMT INQUIRE FENODE 378 FENODE option CEMT DISCARD command 370 FEPI CICS-supplied transactions 369 operator control 369 Fepo CEMT INQUIRE FEPOOL 382 FEPOOL option CEMT DISCARD 370 Fepr CEMT INQUIRE FEPROPSET 384 FEPROPSET option CEMT DISCARD 370 CEMT INQUIRE FEPROPSET 385 Feta CEMT INQUIRE FETARGET 387 FETARGET option CEMT DISCARD 370 FieldLength1 attribute schema le denitions 58 FieldName1 attribute schema le denitions 58 FieldType1 attribute schema le denitions 58 le statistics 442 File Denitions (FD) 8 FILE parameter CEMT inquire/set 335 lename parameter CEMT FILE 335 FileProtection attribute le denitions 10 FileRSLCheck attribute region denitions 37 les CEMT inquire/set 335 Index
545
FileServer attribute le denitions 10 FILESERVER parameter CEMT inquire/set le 336 FileSystemType attribute region denitions 37 FileType attribute schema le denitions 58 FORCEPURGE parameter CEMT inquire/set task 345 Foreground attribute terminal denitions 68 free (SDT command) 208 Freeing CEMT INQUIRE FECONNECTION 374 CEMT INQUIRE FENODE 380 ftod (DDT command) 137 ftos (SDT command) 211
Groups attribute region denitions 37 GSD (Gateway Server Denitions) 14
H
help (DDT command) 138 help (SDT command) 212 Highlight attribute terminal denitions 68 hp terminal denition autoinstall model 503 hpterm denition autoinstall model 503 HTMLBrowser attribute region denitions 37
I
IBM CICS Client autoinstall model 502 IBM CICS ECI autoinstall model 502 IBM COBOL programs caches 31, 45 ibm3151 autoinstall model 502 ibm3161 autoinstall model 502 ibm3164 autoinstall model 502 IdleTimeout attribute SFS denitions 61 IIOP resource denitions 24 IIOPGroupHost attribute region denitions 38 IIOPGroupPort attribute region denitions 38 IIOPGroupSSLPort attribute region denitions 38 IIOPGroupUUID attribute region denitions 38 IIOPObjrefsVersion attribute region denitions 38 IIOPRequestTimeout attribute region denitions 39 ImplementationLanguage attribute object denitions 25 importing DB2 cicsdb2import command 129 Include attribute monitoring denitions 22 IndexFieldDescenders1 attribute schema le denitions 58 IndexFieldNames1 attribute schema le denitions 59 IndexName attribute le denitions 10 INDEXNAME parameter CEMT inquire/set le 336
G
Gateway Denitions (GD) 12 Gateway Server Denitions (GSD) 14 GatewayCDSName attribute gateway denitions 13 GatewayLUName attribute gateway denitions 13 GatewayName attribute communications denitions 3 GatewayPrincipal attribute gateway denitions 14 GD (Gateway Denitions) 12 Goingout CEMT INQUIRE FECONNECTION 373 CEMT INQUIRE FENODE 379 CEMT INQUIRE FEPOOL 383 CEMT INQUIRE FETARGET 388 GOODNIGHT parameter 357 GroupName attribute communications denitions 3 le denitions 10 gateway denitions 14 journal denitions 18 listener denitions 19 object denitions 24 product denitions 25 program denitions 28 temporary storage denitions 64 terminal denitions 68 transaction denitions 75 transient data denitions 82 user denitions 86
IndexName1 attribute schema le denitions 59 IndexPreallocatePages attribute schema le denitions 59 IndexUnique1 attribute schema le denitions 59 INDIRECT parameter CEMT inquire/set tdqueue 349 IndirectQueueId attribute transient data denitions 82 InDoubt attribute transaction denitions 75 INDOUBT parameter CEMT inquire/set task 344 INFLIGHT parameter CEMT inquire/set task 344 info (DDT command) 136 info (SDT command) 209 InitialOpenFlag attribute journal denitions 18 INQUIRE, CEMT FECONNECTION 371 FENODE 377 FEPOOL 381 FEPROPSET 384 FETARGET 386 INQUIRE (CEMT transaction) 328 AUTOINSTALL parameter 331 AUXTRACE parameter 332 DUMP parameter 333 DUMPOPTIONS parameter 334 FILE parameter 335 JOURNAL parameter 338 MONITOR parameter 339 NETNAME parameter 340 overview 321 PROGRAM parameter 342 system parameters 355 task parameter 344 TCLASS parameter 347 TDQUEUE parameter 348 TERMINAL parameter 351 TRACE parameter 353 TRANSACTION parameter 354 inquire about resource 323 INQUIRE keyword, CEMT 323 Inservice CEMT INQUIRE FECONNECTION 373 CEMT INQUIRE FENODE 378 CEMT INQUIRE FEPOOL 382 CEMT INQUIRE FETARGET 387
546
InService attribute communications denitions 3 INSERVICE parameter CEMT inquire netname 340 CEMT inquire/set terminal 351 installation verication program cicsivp command 171 Installed CEMT INQUIRE FECONNECTION 373 CEMT INQUIRE FENODE 378 CEMT INQUIRE FEPOOL 382 CEMT INQUIRE FETARGET 387 intercepting a transaction 316 Interface attribute object denitions 24 intersystem communication (CRTE) 364 intersystem communication (ISC) statistics 445 INTRA parameter CEMT inquire/set tdqueue 349 INTROINTVL parameter CEMT inquire 355 IntrospectInterval attribute region denitions 38 IntrospectLevel attribute region denitions 38 InvocationMode attribute transaction denitions 75 invoking CEMT 323 invoking a supplied transaction 274 invoking a transaction 274 IOMode attribute transient data denitions 82 IsBackEndDTP attribute transaction denitions 76 ISCDelayMinutes attribute region denitions 39 IsPrinter attribute terminal denitions 68 IsShippable attribute terminal denitions 68
journals 17 (continued) CEMT inquire/set 338
K
Katakana attribute terminal denitions key, tab CEMT 328 KeyLen attribute le denitions 11 keytab le 186, 251 keyword, minimum abbreviation 276 69
L
Lacqcode CEMT INQUIRE FECONNECTION 375 CEMT INQUIRE FENODE 380 LANG environment variable 248, 254 Language setting 248 LD (Listener Denitions) 19 LD_LIBRARY_PATH environment variable 188 LIBPATH environment variable 188 link security 6 LinkUserId attribute communications denitions 3 list (DDT command) 132 list (SDT command) 205 Listener Denitions (LD) 19 ListenerName attribute communications denitions 4 LoadDataNumBuckets attribute region denitions 39 locale, specifying 247 LOCALE parameter CEMT inquire 355 LocalLUName attribute region denitions 39 LocalNetworkName attribute region denitions 40 LocalQ attribute transaction denitions 76 LocalQFile attribute region denitions 54 LocalQIndex attribute region denitions 54 LocalQMaxRecs attribute region denitions 54 LocalQPrePages attribute region denitions 54 LocalQProtectFile attribute region denitions 54
LocalQProtectIndex attribute region denitions 54 LocalQProtection attribute region denitions 40 LocalQProtectMaxRecs attribute region denitions 55 LocalQProtectPrePages attribute region denitions 55 LocalQProtectProtection attribute region denitions 40 LocalQProtectVol attribute region denitions 55 LocalQVol attribute region denitions 55 LocalSysId attribute region denitions 41 LogFile attribute SFS denitions 61 Logical Unit name 245 LogicalTDQFile attribute region denitions 55 LogicalTDQIndex attribute region denitions 55 LogicalTDQMaxRecs attribute region denitions 55 LogicalTDQPrePages attribute region denitions 55 LogicalTDQProtection attribute region denitions 41 LogicalTDQVol attribute region denitions 55 LOGNAME environment variable 259 LogVolume attribute gateway server denitions 15 SFS denitions 61 LU name 245 LUW statistics 457
M
makele 179 Managed attribute object denitions 24 managing DB2 databases Schema File Denitions (SCD) 57 managing le servers Region Denitions for le server (RD) 54 managing resources using RDO cicsadd command 91 cicsdefault command 142 cicsdestroy command 148 cicsexport command 153 cicsget command 156 cicsimport command 166 Index
J
JD (Journal Denitions) 16 Journal Denitions (JD) 16 JOURNAL parameter CEMT inquire/set 338 journal statistics 454 JournalRSLCheck attribute region denitions 39 journals 17
547
managing resources using RDO (continued) cicsinstall command 169 cicsupdate command 263 Managing resources using RDO cicsdelete command 145 cicsppcgwy command 191 managing SFS cicssfscreate command 230 cicssfsdestroy command 233 cicssfsimport command 235 Structured File Server Denitions (SSD) 61 Managing SFSs cicssfsshut command 238 MapColumn attribute terminal denitions 69 MapHeight attribute terminal denitions 69 MapLine attribute terminal denitions 69 MapWidth attribute terminal denitions 69 master terminal operator CEMT transaction 324 MaxConsoleSize attribute region denitions 41 MaxRecords attribute schema le denitions 60 MaxRegionPool attribute region denitions 42 MAXREGIONPOOL parameter CEMT inquire 356 MaxServer attribute region denitions 42 MAXSERVERS parameter CEMT inquire/set system 356 CEMT inquire/set tclass 347 MaxTaskCPU attribute region denitions 42 transaction denitions 76 MaxTaskCPUAction attribute region denitions 42 MaxTaskPrivatePool attribute region denitions 43 MAXTASKSHPOOL parameter CEMT inquire 356 MaxTSHPool attribute region denitions 43 MD (Monitoring Denitions) 21 Micro Focus COBOL versions supported by CICS 187 migrating a region 184, 267 migrating a region database 181 migrating a server database 181
MinServer attribute region denitions 43 MINSERVERS parameter CEMT inquire/set system 356 CEMT inquire/set tclass 347 model type, specifying 247 ModelId attribute terminal denitions 69 Modiable attribute monitoring denitions 23 region denitions 43 Module attribute object denitions 24 MONITOR parameter 339 CEMT inquire/set 339 monitoring data formatter 179 Monitoring Denitions (MD) 21 MonitorStatus attribute monitoring denitions 23 MRAArchivingEnabled attribute SFS denitions 62
N
NamedPipeName attribute listener denitions 19 NAMEIND parameter CEMT inquire/set tdqueue 349 NameService attribute region denitions 44 SFS denitions 15, 62 netdata format records 138, 212 NETNAME 245 NetName attribute terminal denitions 69 NETNAME parameter CEMT inquire 340 CEMT inquire/set terminal 351 network CEMT inquire 340 NOABDUMP parameter CEMT inquire/set dumpoptions 334 NOADD parameter CEMT inquire/set le 336 NOATI parameter CEMT inquire netname 340 CEMT inquire/set terminal 351 NOBROWSE parameter CEMT inquire/set le 336 Node CEMT INQUIRE FECONNECTION 372 CEMT INQUIRE FENODE 378 NODELETE parameter CEMT inquire/set le 336
NonRecTDQFile attribute region denitions 55 NonRecTDQIndex attribute region denitions 56 NonRecTDQMaxRecs attribute region denitions 56 NonRecTDQPrePages attribute region denitions 56 NonRecTDQProtection attribute region denitions 44 NonRecTDQVol attribute region denitions 56 NonRecTSQFile attribute region denitions 56 NonRecTSQIndex attribute region denitions 56 NonRecTSQMaxRecs attribute region denitions 56 NonRecTSQPrePages attribute region denitions 56 NonRecTSQProtection attribute region denitions 44 NonRecTSQVol attribute region denitions 56 NOPCDUMP parameter CEMT inquire/set dumpoptions 334 NOREAD parameter CEMT inquire/set le 336 Notinstalled CEMT INQUIRE FECONNECTION 373 CEMT INQUIRE FENODE 378 CEMT INQUIRE FEPOOL 382 CEMT INQUIRE FETARGET 387 NOTTI parameter CEMT inquire netname 340 CEMT inquire/set terminal 351 NOUPDATE parameter CEMT inquire/set le 336 NumColumns attribute terminal denitions 70 NumLines attribute terminal denitions 70
O
Object denitions CICS IIOP ORB resource denition 24 Obtaining CEMT INQUIRE FECONNECTION 374 CEMT INQUIRE FENODE
379
548
OFF parameter CEDF 309 CEMT inquire/set AUXTRACE 332 CEMT inquire/set dump 333 CEMT inquire/set monitor 339 CEMT inquire/set trace 353 offline utilities cicsdfmt 150 cicsgpid 161 cicsmfmt 179 cicsrlck 201 cicssfmt 221 cicssfslock 237 cicstfmt 258 cicstracelter 261 ON parameter CEDF 309 CEMT inquire/set AUXTRACE 332 CEMT inquire/set dump 333 CEMT inquire/set monitor 339 CEMT inquire/set trace 353 OPEN parameter CEMT inquire/set le 336 CEMT inquire/set tdqueue 349 open string suppressing 26 OpenMode attribute transient data denitions 82 OpenStatus attribute le denitions 11 Operation attribute object denitions 24 operator control commands 369 OpID attribute user denitions 86 OPREL parameter CEMT inquire 356 OPSYS parameter CEMT inquire 356 OpThreadPoolSize attribute SFS denitions 62 OrbAdapterDllName attribute object denitions 24 OutboundUserIds attribute communications denitions 4 Outline attribute terminal denitions 70 OUTPUT parameter CEMT inquire/set journal 338 Outservice CEMT INQUIRE FECONNECTION 373
Outservice (continued) CEMT INQUIRE FENODE 379 CEMT INQUIRE FEPOOL 383 CEMT INQUIRE FETARGET 388 OutService attribute terminal denitions 70 OUTSERVICE parameter CEMT inquire netname 340 CEMT inquire/set terminal 351 overtyping CEDF screen 315 CEMT screen 327 EDF screen 315
P
PATH environment variable 188 PathName attribute program denitions 28 PCDump attribute region denitions 44 PCDUMP parameter CEMT inquire/set dumpoptions 334 PD (Program Denitions) 27 PERFORM SNAP CEMT 330 performance monitoring user program 389 default performance monitoring user program 396 overview 395 program parameters 400 when the program is accessed 406 Permanent attribute communications denitions 4 le denitions 11 gateway denitions 14 gateway server denitions 15 journal denitions 18 listener denitions 19 object denitions 24 product denitions 25 program denitions 30 schema le denitions 60 SFS denitions 62 temporary storage denitions 65 terminal denitions 70 transaction denitions 76 transient data denitions 83 user denitions 87 PF (program function) key values CALF 285 CDCN 289
PF (program function) key values (continued) CEBR 295 CECI 304 CECS 304 CEDF 313 CEMT 325 CMLV 362 CSTD 368 EDF 313 PhysicalTDQFile attribute region denitions 56 PhysicalTDQIndex attribute region denitions 56 PhysicalTDQMaxRecs attribute region denitions 57 PhysicalTDQPrePages attribute region denitions 57 PhysicalTDQProtection attribute region denitions 45 PhysicalTDQVol attribute region denitions 57 plus character (CEMT) 326 Pool CEMT INQUIRE FECONNECTION 373 CEMT INQUIRE FEPOOL 382 PostScanInterval attribute region denitions 45 PPC Gateway 159, 270 PreallocatePages attribute schema le denitions 60 PrePages attribute le denitions 11 PrimaryIndexDescenders attribute schema le denitions 60 PrimaryIndexFields attribute schema le denitions 60 PrimaryIndexName attribute schema le denitions 60 PrimaryIndexUnique attribute schema le denitions 60 Principal attribute user denitions 87 Printer CICS 3270 Terminal Emulator 255 Priority attribute terminal denitions 70 transaction denitions 76 user denitions 87 PRIORITY parameter CEMT inquire netname 340 CEMT inquire/set terminal 352 CEMT inquire/set transaction 354 Index
549
process identier 161 PROCESSID parameter CEMT inquire/set task 344 Product Denitions (XAD) 25 ProgName attribute transaction denitions 77 Program Denitions (PD) 27 PROGRAM parameter CEMT inquire/set 342 program statistics 458 program testing EDF 309 ProgramCacheSize attribute region denitions 45 ProgramRSLCheck attribute region denitions 46 programs CEMT inquire/set 342 ProgramSymbols attribute terminal denitions 71 ProgType attribute program denitions 31 ProtectionLevel attribute gateway server denitions 15 SFS denitions 62 ProtectPurgeDelayPeriod attribute region denitions 46 Protocol attribute listener denitions 20 PublicUserTraceFile attribute region denitions 46 PURGE parameter CEMT inquire/set task 345 CEMT inquire/set terminal 352 Purgeability attribute transaction denitions 77 PurgeDelayPeriod attribute region denitions 46
Q
QSAM to DB2 le transfer 138 QSAM to SFS le transfer 212 qtod (DDT command) 136 denition les 140 running 141 qtos (SDT command) 210 denition les 214 running 214 question mark (CECI) 308 question mark (CEMT) 323 quit (DDT command) 138 quit (SDT command) 212
R
RD (Region Denitions) 32
RDBMSInstance attribute region denitions 46 read (DDT command) 133 read (SDT command) 206 READ parameter CEMT inquire/set le 336 ReadOpt attribute le denitions 11 RecordLen attribute transient data denitions 83 RecordSize attribute le denitions 11 RecordTerminator attribute transient data denitions 83 RecordType attribute transient data denitions 83 RecoverFlag attribute temporary storage denitions 65 RecoverStatus attribute le denitions 11 RecoverTerminal attribute terminal denitions 71 RecoveryType attribute transient data denitions 83 RecTSQFile attribute region denitions 57 RecTSQIndex attribute region denitions 57 RecTSQMaxRecs attribute region denitions 57 RecTSQPrePages attribute region denitions 57 RecTSQProtection attribute region denitions 46 RecTSQVol attribute region denitions 57 reference section operator commands 369 region copying the default region 142 destroying 148 migrating 184 process identier 161 Region Denitions (RD) 32 RegionPoolBase attribute region denitions 47 RegionPoolThreshold attribute region denitions 47 REGIONTHRESH parameter CEMT inquire 356 RELEASE parameter CEMT inquire 356 Released CEMT INQUIRE FECONNECTION 374
Released (continued) CEMT INQUIRE FENODE 379 ReleaseNum attribute region denitions 47 Reloadable attribute object denitions 25 REMOTE parameter CEMT inquire/set le 337 CEMT inquire/set tdqueue 349 RemoteCodePageTR attribute communications denitions 5 RemoteLUName attribute communications 5 RemoteName attribute le denitions 11 program denitions 31 temporary storage denition 65 terminal denitions 71 transaction denitions 77 transient data denitions 84 RemoteNetworkName attribute communications denitions 5 RemoteSysEncrypt attribute communications denitions 5 RemoteSysId attribute le denitions 11 program denitions 31 temporary storage denition 65 terminal denitions 71 transaction denitions 77 transient data denitions 84 RemoteSysSecurity attribute communications denitions 6 link security 6 user security 6 RemoteTCPAddress attribute communications denitions 6 RemoteTCPPort attribute communications denitions 7 Resident attribute program denitions 31 resource deallocation 190 resource attributes name description cross-reference 507 resource denitions shorthand notation 1 resource les creating default 144 ResourceDescription attribute communications denitions 7 le denitions 12 gateway denitions 14 gateway server denitions 15
550
ResourceDescription attribute (continued) journal denitions 18 listener denitions 20 monitoring denitions 23 object denitions 24 product denitions 26 program denitions 31 region denitions 48 schema le denitions 60 SFS denitions 63 temporary storage denitions 65 terminal denitions 71 transaction denitions 77 transient data denitions 84 user denitions 87 ResThreadPoolSize attribute SFS denitions 63 restoring a region 166 restrictions on use of characters for <Key> 1 Routing Transaction (CRTE) automatic transaction initiation 365 description of 364 overview 274 reference 364 syntax 364 using with CEMT 366 RPCListenerThreads attribute region denitions 48 RSLCheck attribute transaction denitions 77 RSLKey attribute le denitions 12 journal denitions 18 program denitions 31 temporary storage denition 65 transaction denitions 78 transient data denitions 84 RSLKeyList attribute terminal denitions 71 user denitions 87 RSLKeyMask attribute communications denitions 7 running cicsnetdata 140, 213 RUNNING parameter CEMT inquire/set task 345 running programs Micro Focus COBOL 187 running qtod 141 running qtos 214 runtime database statistics 459
runtime resource management (CEMT) ? character 323 + character 326 blank elds in a screen 328 command line request 323 INQUIRE 323 inquire/set overview 328 inquiring about a resource 327 invoking 323 overtyping a screen 327 PERFORM 323 PF (program function) key values 325 prompting for options 323 request formats 324 screen layout 324 scrolling a screen 326 SET 323 tab key 328 Runtime Resource Management (CEMT) AKP parameter 355 APPLID parameter 355 AUTOINSTALL parameter 331 auxiliary trace 353 AUXTRACE parameter 332 DATEFORM parameter 355 description of 321 DUMP parameter 333 DUMPOPTIONS parameter 334 FILE parameter 335 INTROINTVL parameter 355 JOURNAL parameter 338 LOCALE parameter 355 MAXREGIONPOOL parameter 356 MAXTASKSHPOOL parameter 356 MONITOR parameter 339 NETNAME parameter 340 OPREL parameter 356 OPSYS parameter 356 overview 273 parameters, overview of 321 PERFORM SNAP 330 PROGRAM parameter 342 reference 321 REGIONTHRESH parameter 356 RELEASE parameter 356 syntax 321 SYSID parameter 356 system parameters 355 TASK parameter 344
Runtime Resource Management (CEMT) (continued) TASKTHRESH parameter 356 TCLASS parameter 347 TDQUEUE parameter 348 TERMINAL parameter 351 TRACE parameter 353 TRANSACTION parameter 354 using with CRTE 366 runtime terminal attributes CEMT inquire/set 351 RuntimeProtection attribute region denitions 48
S
SafetyLevel attribute region denitions 49 SCD (Schema File Denitions) 57 Schema File Denitions (SCD) 57 screen layout CALF 281, 282 CDCN 288 CEBR 292, 293 CECI 299, 306, 307 CECS 299, 306 CEDF 311, 318 CEMT 324 CEMT inquire 328 CSTD 367 EDF 311, 318 syntax notation 276 scrolling a screen CEMT 326 SDT command 203 SDT commands ! 211 addindex 209 create 205 delete 208 delindex 209 empty 208 free 208 ftos 211 help (?) 212 info 209 list 205 QSAM to SFS le transfer 212 qtos 210 quit 212 read 206 server 210 setopen 205 stof 210 write 207 Index
551
security CESN 359 external 389 signon 359 security rules CECI 298 CECS 298 EDF 310 server (SDT command) 210 server status cicslssrc command 173 cicsmakelv command 178 cicsremovelv command 200 cicstail command 243 ServerIdleLimit attribute region denitions 49 ServerSideTran attribute region denitions 49 SET (CEMT transaction) 329 AUTOINSTALL parameter 331 AUXTRACE parameter 332 DUMP parameter 333 DUMPOPTIONS parameter 334 FILE parameter 335 JOURNAL parameter 338 MONITOR parameter 339 overview 321 PROGRAM parameter 342 TASK parameter 344 TCLASS parameter 347 TDQUEUE parameter 348 TERMINAL parameter 351 TRACE parameter 353 TRANSACTION parameter 354 setopen (SDT command) 205 SFS cicssfs command 225 SFS diagnostic tool cicssdt command 203 SFS parameter CEMT inquire/set le 337 SHLIB_PATH environment variable 188 shorthand notation 1 ShortName attribute gateway server denitions 15 SFS denitions 63 shutdown 190 cicsnotify command 190 ShutdownProgList1 attribute region denitions 49 ShutdownProgList2 attribute region denitions 49 Signoff (CESF) description of 357
Signoff (CESF) (continued) overview 273 reference 357 syntax 357 Signoff (CSSF) description of 357 overview 274 reference 357 syntax 357 signoff transactions (CESF and CSSF) 357 Signon (CESN) description of 359 overview 274 reference 359 security 359 syntax 359 SMIT CICS resource cross reference 507 SNAConnectName attribute communications denitions 7 SNADefaultModeName attribute gateway server denitions 16 SNAModeName attribute transaction denitions 78 SNAP CEMT PERFORM 330 SNAServerNodeName attribute (CICS for Solaris only) listener denitions 20 SOSI attribute terminal denitions 72 SRVERCP option on DFHCNV macro 249 SSD (Structured File Server Denitions) 61 SSLAuthentication attribute listener denitions 20 SSLCerticate attribute listener denitions 21 SSLEncryption attribute listener denitions 20 SSLKeyFile attribute listener denitions 20 SSLKeyPassword attribute listener denitions 20 SSLSession attribute listener denitions 21 standard data types for user exits 408 standard header structure for user exits 408 StartType attribute gateway server denitions 16 region denitions 49
StartType attribute (continued) SFS denitions 63 StartupProgList attribute region denitions 50 State CEMT INQUIRE FECONNECTION 374 StatFile attribute region denitions 50 statistics dump statistics 441 le statistics 442 general 434 intersystem communication (ISC) statistics 445 journal statistics 454 LUW statistics 457 monitoring 339 program statistics 458 runtime database statistics 459 storage statistics 464 task statistics 473 temporary storage statistics 485 terminal statistics 476 transaction statistics 483 transient data statistics 480 Statistics (CSTD) description of 367 overview 274 reference 367 syntax 367 StatsRecord attribute region denitions 50 stof (SDT command) 210 stop conditions, EDF 318 storage statistics 464 Structured File Server Denitions (SSD) 61 SufficesSupported attribute region denitions 50 Sun command tool and shell tool autoinstall model 507 supplied programs CICS Client Autoinstall 389 External Security Manager (ESM) 389 function shipping 389 performance monitoring user program 389 Terminal Autoinstall 389 transaction routing 389 user conversion programs 389 SUSPENDED parameter CEMT inquire/set task 346
552
SWITCH parameter CEMT inquire/set AUXTRACE 332 CEMT inquire/set journal 338 SwitchLoadFile attribute product denitions 26 symbols used in manual 275 symbols used on screen displays 276 Syncpoint attribute transaction denitions 78 syncpoint user exit (51) 422 Syntax Checker (CECS) command input 299 description of 298 information area 300 invoking 306 overview 273 PF (program function) key values 304 reference 298 screen layout 299, 306 security rules 298 status area 299 syntax 298 syntax messages CECI or CECS information 304 syntax notation 275 syntax notation on screen displays 276 SysDump attribute region denitions 50 sysid parameter 364 CEDF 287, 309 SYSID parameter CEMT inquire 356 CRTE transaction 364 system dump ag 333 system parameters CEMT inquire 355 SysTraceBufferSize attribute region denitions 50
T
tab key CEMT 328 Target CEMT INQUIRE FECONNECTION 372 task classes CEMT inquire/set 347 task monitoring 339 TASK parameter CEMT inquire/set 344 CEMT inquire/set task 346
task statistics 473 task termination user exit (15) 410 tasks CEMT inquire/set 344 TaskSharedPoolBase attribute region denitions 51 TaskSHNumBuckets attribute region denitions 51 TaskShPoolThreshold attribute region denitions 51 TASKSHTHRESH parameter CEMT inquire 356 TClass attribute transaction denitions 79 TCLASS parameter CEMT inquire/set 347 CEMT inquire/set task 346 TCPAddress attribute listener denitions 21 TCPService attribute listener denitions 21 TCTUALen attribute terminal denitions 72 TD (Transaction Denitions) 73 TD queues CEMT inquire/set 348 TDD (Transient Data Denitions) 81 TDPurgeInterval attribute region denitions 51 TDQ attribute monitoring denitions 23 TDQUEUE parameter CEMT inquire/set 348 telnet cicsteld command 247 code page, specifying 247 locale, specifying 247 model type, specifying 247 terminal type, specifying 247 TemplateDened attribute le denitions 12 program denitions 32 temporary storage denitions 66 transaction denitions 79 transient data denitions 84 Temporary Storage Browse (CEBR) command input area 293 description of 292 information area 295 overview 273 PF (program function) key values 295 reference 292 screen layout 293
Temporary Storage Browse (CEBR) (continued) syntax 292 using the transaction 292 Temporary Storage Denitions (TSD) 64 temporary storage statistics 485 TemporaryStorageRSLCheck attribute region denitions 52 TERM environment variable 254 TERM parameter CEMT inquire/set task 346 termid parameter CDCN 287 CEDF 309 TERMID parameter CEMT inquire/set tdqueue 349 Terminal Autoinstall 389 terminal autoinstall program CEMT inquire/set 331 terminal autoinstall user exit when the program is accessed 394 terminal autoinstall user program DFHCHATX 391 overview 390 program parameters 393 the supplied program 390 Terminal Denitions (WD) 66 TERMINAL parameter CEMT inquire netname 340 CEMT inquire/set 351 terminal statistics 476 terminal type, specifying 247 TerminalProtection attribute terminal denitions 72 terminals CEMT inquire/set 351 TermSubType attribute terminal denitions 72 TermType attribute terminal denitions 72 ThreadPoolSize attribute gateway server denitions 16 timeout DeadlockTimeout attribute 74 Timeout attribute transaction denitions 79 TPNSNAProle attribute transaction denitions 79 Trace attribute region denitions 52 trace facility CEMT inquire/set 353 Index
553
TRACE parameter CEMT inquire/set 353 TraceFile attribute user denitions 88 TraceFileA attribute region denitions 52 TraceFileB attribute region denitions 52 TraceFileSize attribute region denitions 52 TraceModules attribute region denitions 52 TRANID parameter CEMT inquire/set task 346 CEMT inquire/set tdqueue 349 Transaction Denitions (TD) 73 TRANSACTION parameter CEMT inquire netname 340 CEMT inquire/set 354 CEMT inquire/set terminal 352 CEMT TRANSACTION 354 transaction statistics 483 TransactionRSLCheck attribute region denitions 53 transactions CALF 281 CDCN 287 CEBR 292 CECI 298 CECS 298 CEDF 309, 310 CEMT inquire/set 354 CESF 357 CESN 359 CMLV 362 CRTE 364 CSSF 357 CSTD 367 invocation of 274 routing 364 TransDump attribute transaction denitions 79 TransDumpTrace attribute region denitions 53 TransId attribute object denitions 24 program denitions 32 Transient Data Denitions (TDD) 81 transient data queues CEMT inquire/set 348 emptying 83 extracting data from 179 transient data statistics 480
TransientDataRSLCheck attribute region denitions 53 transmit a le from CMS 139, 213 transmit a le from TSO 138, 212 TriggeredTransId attribute transient data denitions 85 TriggerLevel attribute transient data denitions 85 TRIGGERLEVEL parameter CEMT inquire/set tdqueue 349 TSD (Temporary Storage Denitions) 64 TSLCheck attribute transaction denitions 80 TSLKey attribute transaction denitions 80 TSLKeyList attribute terminal denitions 73 user denitions 88 TSLKeyMask attribute communications denitions 8 TSQAgeLimit attribute region denitions 53 TTI parameter CEMT inquire netname 341 CEMT inquire/set terminal 352 TWASize attribute transaction denitions 80
U
UCTranFlag attribute terminal denitions 73 transaction denitions 80 UD (User Denitions) 85 UE014015 (task termination user exit) 410 UE014025 (dynamic transaction routing user exit) 413 UE015050 (dynamic distributed program link user exit) 418 UE016051 (syncpoint user exit) 422 UE052017 (dump request user exit) 411 UNENABLED parameter CEMT inquire/set le 337 UPDATE parameter CEMT inquire/set le 337 UpdateOpt attribute le denitions 12 user (DDT command) 136 user conversion programs function Shipping 389 transaction routing 389 User Denitions (UD) 85 user exit numbers 407
user exits 15 - task termination 410 17 - dump request 411 25 - dynamic transaction routing 413 50 - dynamic distributed program link 418 51 - syncpoint 422 constants 408 External Security Manager (ESM) 395 standard data types 408 standard header structure 408 user exit numbers 407 what is a user exit? 407 user programs terminal autoinstall 390 user security 6 UserExitNumber attribute program denitions 32 UserID attribute gateway server denitions 16 SFS denitions 63 USERID parameter CEMT inquire/set task 346 UserMonitorModule attribute monitoring denitions 23 UserTraceDirectory attribute region denitions 53
V
Validation attribute terminal denitions 73 VariableFieldLength attribute schema le denitions 60 VariableFieldName attribute schema le denitions 60 VariableFieldType attribute schema le denitions 60 variables CECI or CECS information VolumeName attribute schema le denitions 61 vt100 autoinstall model 502 vt220 autoinstall model 504
302
W
Waitconvnum CEMT INQUIRE FECONNECTION 375 CEMT INQUIRE FEPOOL 383 WAITFORGET parameter CEMT inquire/set task 346 WD (Terminal Denitions) 66 WhenOpened attribute transient data denitions 85
554
Windowed multi-byte color autoinstall model 503 Windowed multi-byte monochrome autoinstall model 503 Windowed single-byte color autoinstall model 503 Windowed single-byte monochrome autoinstall model 503 write (DDT command) write (SDT command) 134 207
X
XAClose attribute product denitions XAOpen attribute product denitions XASerialize attribute product denitions 26 XID_NODE_ID environment variable 119 XPRecvTimeout attribute region denitions 53 504 xterm autoinstall model 26 26 25 XAD (Product Denitions)
Index
555
556
557
Program Number: 5765-E27 5639-I07 5765-E28 5765-E29 5639-I09 5639-I11 5765-E31 5765-E30
Printed in the United States of America on recycled paper containing 10% recovered post-consumer ber.
SC09-4459-00
Spine information:
WebSphere
Version 3.0

CICS Administration Reference

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

CICS Administration Reference

Hochgeladen von

Copyright:

Verfügbare Formate

WebSphere Application Server Enterprise Edition TXSeries