CICS Administration Reference

WebSphere Application Server Enterprise EditionTXSeries

CICS Administration ReferenceVersion 3.0

SC09-4459-00

WebSphere Application Server Enterprise EditionTXSeries

CICS Administration ReferenceVersion 3.0

SC09-4459-00

NoteBefore 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 5765–E27VisualAge Component Development for WebSphere Application Server Version 3.0, Enterprise Edition forWindows NT, program number 5639–I07WebSphere Application Server Version 3.0, Enterprise Edition for AIX, program number 5765–E28WebSphere Application Server Version 3.0, Enterprise Edition for Solaris, program number 5765–E29WebSphere Application Server Version 3.0, Enterprise Edition for Windows NT, program number 5639–I09WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for Windows NT, programnumber 5639–I11WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for AIX, program number5765–E31WebSphere Application Server Version 3.0, Enterprise Edition Development Runtime for Solaris, program number5765–E30

and to all subsequent versions, releases, and modifications until otherwise indicated in new editions. Consult thelatest 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 Contractwith IBM Corp.

Contents

Figures . . . . . . . . . . . . . vii

Tables . . . . . . . . . . . . . ix

About this book . . . . . . . . . . xiWho should read this book . . . . . . xiDocument organization . . . . . . . xiConventions used in this book . . . . . xiiHow to send your comments. . . . . . xiii

Chapter 1. Resource definitions . . . . 1Restrictions on the use of characters . . . 1Shorthand notation for resource definitions 1Communications Definitions (CD) . . . . 1File Definitions (FD). . . . . . . . . 8Gateway Definitions (GD) . . . . . . . 12Gateway Server Definitions (GSD) . . . . 14Journal Definitions (JD) . . . . . . . 16Listener Definitions (LD) . . . . . . . 19Monitoring Definitions (MD) . . . . . . 21Object definitions (OD). . . . . . . . 24Product Definitions (XAD) . . . . . . 25Program Definitions (PD) . . . . . . . 27Region Definitions (RD) . . . . . . . 32Region Definitions (RD) for file server. . . 54Schema File Definitions (SCD) . . . . . 57Structured File Server Definitions (SSD) 61Temporary Storage Definitions (TSD) . . . 64Terminal Definitions (WD) . . . . . . 66Transaction Definitions (TD) . . . . . . 73Transient Data Definitions (TDD) . . . . 81User Definitions (UD) . . . . . . . . 85

Chapter 2. Resource definitioncommands and offline utilities . . . . 89About the CICS commands . . . . . . 89cicsadd - Add CICS resource definitions 91cicscleandce - Remove DCE groups andCDS directories . . . . . . . . . . 94cicscopystanza command . . . . . . . 96cicscp - CICS control program . . . . . 97cicscp - all options . . . . . . . . . 100cicscp - COBOL commands . . . . . . 101cicscp - DCE commands . . . . . . . 102cicscp - PPC Gateway server commands 105

cicscp - region commands . . . . . . . 109cicscp - SFS commands. . . . . . . . 113cicscp - SNA commands . . . . . . . 117cicscp - SNA link commands . . . . . . 119cicscp - telnet server commands . . . . . 121cicscvt - Create data conversion table . . . 124cicsdb2conf - Configure DB2 . . . . . . 126cicsdb2import - Build metadata for DB2 129cicsddt - DB2 diagnostic tool . . . . . . 131cicsdefault - Create a copy of the defaultregion . . . . . . . . . . . . . 142cicsdefaultservers - Create default resourcefiles for servers . . . . . . . . . . 144cicsdelete - Delete CICS resource definitions 145cicsdestroy - Destroy a CICS region . . . 148cicsdfmt - Dump formatter . . . . . . 150cicsexport - Export CICS resourcedefinitions . . . . . . . . . . . . 153cicsget - Get CICS resource definitioninformation . . . . . . . . . . . 156cicsgetbindingstring - Get binding string forregion or Encina server. . . . . . . . 159cicsgpid - Get region process identifier . . 161cicshpterm - 3270 terminal emulator . . . 162cicsimport - Import CICS resourcedefinitions . . . . . . . . . . . . 166cicsinstall - Install CICS resource definitions 169cicsivp - Set up resource definitions forinstallation verification . . . . . . . . 171cicslssrc - Check subsystem status . . . . 173cicslterm - Invoke the local CICS client 3270terminal emulator . . . . . . . . . 175cicsmakelv - Create a logical volume . . . 178cicsmfmt - Monitoring data formatter . . . 179cicsmigrate - Create migration script . . . 181cicsmigrateclass - Add and delete resourceattributes . . . . . . . . . . . . 184cicsmigrateclients - Reconfigure DCE . . . 186cicsmkcobol - Create the cicsprCOBOL file 187cicsnotify - Deallocate resources . . . . . 190cicsppcgwy - Start a PPC Gateway server 191cicsppcgwycreate - Create a PPC Gatewayserver server . . . . . . . . . . . 193cicsppcgwydestroy - Destroy a PPCGateway server . . . . . . . . . . 195

cicsppcgwylock - Lock or unlock a PPCGateway server . . . . . . . . . . 197cicsppcgwyshut - Shut down a PPCGateway server . . . . . . . . . . 199cicsremovelv - Remove a logical volume 200cicsrlck - Remove old region lock files. . . 201cicssdt - SFS diagnostic tool . . . . . . 203cicssetupclients - Configure DCE for theCICS clients . . . . . . . . . . . 216cicssetupdce - Create directories and groupswithin a DCE cell . . . . . . . . . 218cicssfmt - Statistics formatter . . . . . . 221cicssfs - Start a CICS SFS . . . . . . . 225cicssfsconf - Configure a CICS SFS . . . . 228cicssfscreate - Create a CICS SFS . . . . 230cicssfsdestroy - Destroy a CICS SFS . . . 233cicssfsimport - Build an SFS’s metadata 235cicssfslock - Release an SFS lock file . . . 237cicssfsshut - Shut Down a CICS SFS . . . 238cicsstart - Start a CICS region . . . . . 240cicsstop - Stop a CICS region. . . . . . 242cicstail - Display the end of a file . . . . 243cicstcpnetname - Display NETNAME forCICS family TCP/IP connection . . . . . 245cicsteld - Connect telnet clients to regions 247cicsterm - Invoke the CICS 3270 terminalemulator . . . . . . . . . . . . 251cicstermp - Printer emulation. . . . . . 255cicstfmt - Trace formatter . . . . . . . 258cicstracefilter - Trace filter . . . . . . . 261cicsupdate - Modify CICS resourcedefinitions . . . . . . . . . . . . 263cicsupdateclass command . . . . . . . 267cicsusedceservers - Migrate CICS regionsand Encina servers to use DCE . . . . . 270

Chapter 3. CICS-supplied transactions 273Overview of the CICS-supplied transactions 273How to invoke the CICS-suppliedtransactions . . . . . . . . . . . 274

Syntax notation used in the descriptions 275Minimum abbreviation of keywords 276Default security settings . . . . . . 277

Complete list of CICS-supplied transactions 278Interface descriptions for the CICS-suppliedtransactions . . . . . . . . . . . 279CALF (Data Conversion) . . . . . . . 281CDCN (Application DiagnosisConfiguration) (CICS for AIX) . . . . . 287CEBR (Temporary Storage Browse) . . . . 292

CECI (Command Level Interpreter) andCECS (Syntax Checker) . . . . . . . 298CEDF (Execution Diagnostic Facility) . . . 309CEMT (Runtime Resource Management) 321

An overview of the CEMT parameters 321How to invoke CEMT . . . . . . . 323Using the CEMT screen . . . . . . 324Concepts of Inquire and Set Operations 328CEMT PERFORM SNAP . . . . . . 330CEMT INQ/SET AUTOINSTALL . . . 331CEMT INQ/SET AUXTRACE . . . . 332CEMT INQ/SET DUMP . . . . . . 333CEMT INQ/SET DUMPOPTIONS . . . 334CEMT INQ/SET FILE . . . . . . . 335CEMT INQ/SET JOURNAL . . . . . 338CEMT INQ/SET MONITOR . . . . . 339CEMT INQ/SET NETNAME. . . . . 340CEMT INQ/SET PROGRAM . . . . . 342CEMT INQ/SET TASK. . . . . . . 344CEMT INQ/SET TCLASS . . . . . . 347CEMT INQ/SET TDQUEUE . . . . . 348CEMT INQ SET TERMINAL . . . . . 351CEMT INQ/SET TRACE . . . . . . 353CEMT INQ/SET TRANSACTION . . . 354Inquiring upon CICS system parametersusing CEMT . . . . . . . . . . 355

CESF (Signoff) and CSSF (Signoff) . . . . 357CESN (Signon) . . . . . . . . . . 359CMLV (Console Message Log Viewer). . . 362CRTE (Routing Transaction) . . . . . . 364CSTD (Statistics) . . . . . . . . . . 367

Chapter 4. Operator control of FEPI . . . 369CEMT—master terminal transaction . . . 369CEMT DISCARD. . . . . . . . . . 370CEMT INQUIRE FECONNECTION . . . 371CEMT INQUIRE FENODE . . . . . . 377CEMT INQUIRE FEPOOL. . . . . . . 381CEMT INQUIRE FEPROPSET . . . . . 384CEMT INQUIRE FETARGET . . . . . . 386

Chapter 5. CICS-supplied programs . . . 389Terminal autoinstall user program . . . . 390

Terminal model definition . . . . . . 390The supplied terminal autoinstallprogram. . . . . . . . . . . . 390Terminal autoinstall program parameters 393When the terminal autoinstall program isaccessed. . . . . . . . . . . . 394

External Security Manager user program 395

iv WebSphere: CICS Administration Reference

Performance monitoring user program . . 395Setting up CICS to call performancemonitoring . . . . . . . . . . . 395The Supplied Performance MonitoringUser Program . . . . . . . . . . 396Performance monitoring user programparameters . . . . . . . . . . . 400When the performance monitoringprogram is accessed . . . . . . . . 406

Chapter 6. User exits . . . . . . . . 407Standard definitions and data types . . . 408

Constants . . . . . . . . . . . 408Standard header structure . . . . . . 408

Task termination user exit (UE014015). . . 410Function prototype . . . . . . . . 410Exit-specific constants . . . . . . . 410Exit-specific structure . . . . . . . 410Fields in exit-specific structure . . . . 411Return codes . . . . . . . . . . 411

Dump request user exit (UE052017) . . . 411Function prototype . . . . . . . . 411Exit-specific constants . . . . . . . 411Exit-specific structure . . . . . . . 412Fields in exit-specific structure . . . . 412Return codes . . . . . . . . . . 413

Dynamic transaction routing user exit(UE014025) . . . . . . . . . . . . 413

Function Prototype . . . . . . . . 413Exit-specific constants . . . . . . . 413Exit-specific structure . . . . . . . 414Fields in exit-specific structure . . . . 414Return Codes . . . . . . . . . . 418

Dynamic distributed program link user exit(UE015050) . . . . . . . . . . . . 418

Function prototype . . . . . . . . 419Exit-specific constants . . . . . . . 419Exit-specific structure . . . . . . . 419Fields in exit-specific structure . . . . 420Return codes . . . . . . . . . . 422

Syncpoint user exit (UE016051) . . . . . 422Function prototype . . . . . . . . 422Exit-specific constants . . . . . . . 422Exit-specific structure . . . . . . . 423Fields in exit-specific structure . . . . 423Return codes . . . . . . . . . . 424

Chapter 7. The CICS monitoring dataformatter offline utilities . . . . . . . 425Monitoring data formatter functions . . . 425

CICS_MFMT_OpenMonitorFile andCICS_MFMT_CloseMonitorFile . . . . . 426

Return codes . . . . . . . . . . 426CICS_MFMT_ReadNext . . . . . . . 427

Return codes . . . . . . . . . . 427CICS_MFMT_FindField . . . . . . . 428

Return codes . . . . . . . . . . 428CICS_MFMT_GetMessage,CICS_MFMT_FreeMessage, andCICS_MFMT_ReleaseCatalogue . . . . . 428

Return codes . . . . . . . . . . 429Statistics formatter functions . . . . . . 429CICS_SFMT_OpenStatsFile andCICS_SFMT_CloseStatsFile . . . . . . 430

Return codes . . . . . . . . . . 430CICS_SFMT_FindRecord . . . . . . . 431

Return codes . . . . . . . . . . 431CICS_SFMT_ReadRecord . . . . . . . 431

Return codes . . . . . . . . . . 432CICS_SFMT_Msg2Int . . . . . . . . 432

Return codes . . . . . . . . . . 432

Chapter 8. The statistics records . . . . 433About the statistics records . . . . . . 433General statistics . . . . . . . . . . 434Dump statistics . . . . . . . . . . 441File statistics . . . . . . . . . . . 442Intersystem communication (ISC) statistics 445Journal statistics . . . . . . . . . . 454Logical unit of work (LUW) statistics . . . 457Program statistics . . . . . . . . . 458Runtime database statistics . . . . . . 459Storage statistics . . . . . . . . . . 464Task statistics . . . . . . . . . . . 473Terminal statistics . . . . . . . . . 476Transient data statistics. . . . . . . . 480Transaction statistics . . . . . . . . 483Temporary storage statistics . . . . . . 485

Chapter 9. Environment variables usedby CICS . . . . . . . . . . . . 491CICS and Encina Environment Variables 491Environment variables for Micro FocusCOBOL and Net Express compiler options 498

Chapter 10. Terminal model definitions 501

Chapter 11. Index of CICS resourceattributes . . . . . . . . . . . . 507

Contents v

Bibliography . . . . . . . . . . . 531

Notices . . . . . . . . . . . . . 533

Trademarks and service marks . . . . . 535

Index . . . . . . . . . . . . . 539

vi WebSphere: CICS Administration Reference

Figures

1. CEMT INQ . . . . . . . . . . 3242. CEMT status screen . . . . . . . 3293. CEMT INQUIRE FECONNECTION

screen . . . . . . . . . . . . 372

4. CEMT INQUIRE FENODE screen 3785. CEMT INQUIRE FEPOOL screen 3826. CEMT INQUIRE FEPROPSET screen 3847. CEMT INQUIRE FETARGET screen 387

viii WebSphere: CICS Administration Reference

Tables

1. Road map for the CICS AdministrationReference book . . . . . . . . . xi

2. Conventions used in this book xii3. Monitoring data formatter files 1804. Statistics data formatter files . . . . 2215. Shortcode and code pages (Open

Systems) . . . . . . . . . . . 2496. Shortcode and code pages

(Windows NT) . . . . . . . . . 2497. Default security settings for the

CICS-supplied transactions . . . . . 2778. The CEMT extended parameters used

with INQUIRE and SET . . . . . . 3219. The CEMT extended parameters used

with INQUIRE only . . . . . . . 32210. Statistic categories. . . . . . . . 43411. Statistic types . . . . . . . . . 43812. Dump statistics. . . . . . . . . 44113. File statistics . . . . . . . . . 44214. ISC statistics . . . . . . . . . 44615. Journal statistics . . . . . . . . 45416. Logical unit of work statistics 45817. Program statistics . . . . . . . . 45918. Runtime database statistics . . . . . 45919. Region pool statistics. . . . . . . 46420. Task-shared pool statistics . . . . . 46621. Task-private pool statistics . . . . . 47122. Task statistics . . . . . . . . . 47323. Terminal statistics . . . . . . . . 47724. Transient data statistics . . . . . . 48125. Transaction statistics . . . . . . . 48326. Temporary storage statistics . . . . 48527. CICS and Encina Environment

Variables . . . . . . . . . . . 49128. Environment variables for Micro Focus

COBOL compiler options . . . . . 498

29. Road map for terminal modeldefinitions . . . . . . . . . . 501

30. Terminal Definition attributes forautoinstall models MDCL, MDCI,MD01, MD02, MD03, MD04, MD05and MD06 . . . . . . . . . . 502

31. Terminal Definition attributes forautoinstall models MD07, MD08,MD09, MD10, MD11, MD12, MD13and MD14 . . . . . . . . . . 502

32. Terminal Definition attributes forautoinstall models MD15, MD16,MD17, MD18, MD19, MD20, MD21and MD22 . . . . . . . . . . 503

33. Terminal Definition attributes forautoinstall models MD23, MD24,MD25, MD26, MD27 and MD28 . . . 504

34. Communications Definitions (CD) 50735. File Definitions (FD) . . . . . . . 50736. Gateway Definitions (GD) . . . . . 50837. Gateway Server Definitions (GSD) 50838. Journal Definitions (JD) . . . . . . 50939. Listener Definitions (LD) . . . . . 50940. Monitoring Definitions (MD) . . . . 50941. Product Definitions (XAD) . . . . . 51042. Program Definitions (PD) . . . . . 51043. Region Definitions (RD) . . . . . . 51044. Schema File Definitions (SCD) 51345. Structured File Server Definitions (SSD) 51446. Temporary Storage Definitions (TSD) 51547. Terminal Definitions (WD) . . . . . 51548. Transaction Definitions (TD) . . . . 51649. Transient Data Definitions (TDD) 51750. User Definitions (UD) . . . . . . 51751. Alphabetic cross-reference of attribute

names to attribute descriptions . . . 518

x WebSphere: CICS Administration Reference

About this book

This book contains the reference material required to administer a CICSsystem. 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 finddetails of commands and definitions.

As this book is mostly reference material with little text to guide you on theuse of commands and references, it is expected that you will have read theappropriate chapters in the CICS Administration Guidebefore attempting to usethis 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 natureof the task, you will use this book to find the details of the commands,definitions, 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 ... Refer to ...

Resource attributes “Chapter 1. Resource definitions” on page 1

Resource definition commands and offline utilities “Chapter 2. Resource definition commands andoffline utilities” on page 89

CICS-supplied transactions “Chapter 3. CICS-supplied transactions” onpage 273

CICS-supplied programs “Chapter 5. CICS-supplied programs” on page 389

User exits “Chapter 6. User exits” on page 407

Formatting functions for monitor and statisticsdata

“Chapter 7. The CICS monitoring data formatteroffline utilities” on page 425

Statistics tables “Chapter 8. The statistics records” on page 433

Environment variables used by CICS, Encina andthe Micro Focus COBOL compiler

“Chapter 9. Environment variables used by CICS”on page 491

Table 1. Road map for the CICS Administration Reference book (continued)

If you want information about ... Refer to ...

Resource attribute name to descriptioncross-reference

“Chapter 11. Index of CICS resource attributes” onpage 507

The conventions used in this book. xii.

Conventions used in this book

WebSphere Application Server Enterprise Edition documentation uses thefollowing typographical and keying conventions.

Table 2. Conventions used in this book

Convention Meaning

Bold Indicates values you must use literally, such as commands, functions, andresource definition attributes and their values. When referring to graphicaluser interfaces (GUIs), bold also indicates menus, menu items, labels,buttons, icons, and folders.

Monospace Indicates text you must enter at a command prompt. Monospace alsoindicates screen text and code examples.

Italics Indicates variable values you must provide (for example, you supply thename of a file for fileName). Italics also indicates emphasis and the titles ofbooks.

< > Enclose the names of keys on the keyboard.

<Ctrl-x> Where x is the name of a key, indicates a control-character sequence. Forexample, <Ctrl-c> means hold down the Ctrl key while you press the c key.

<Return> Refers to the key labeled with the word Return, the word Enter, or the leftarrow.

% Represents the UNIX command-shell prompt for a command that does notrequire root privileges.

# Represents the UNIX command-shell prompt for a command that requiresroot privileges.

C:\> Represents the Windows NT®

command prompt.

> When used to describe a menu, shows a series of menu selections. Forexample, ″Select File > New″ means ″From the File menu, select the Newcommand.″

Entering commands When instructed to “enter” or “issue” a command, type the command andthen 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.

xii WebSphere: CICS Administration Reference

Table 2. Conventions used in this book (continued)

Convention Meaning

| Separates items in a list of choices enclosed in { } (braces) in syntaxdescriptions.

... Ellipses in syntax descriptions indicate that you can repeat the precedingitem one or more times. Ellipses in examples indicate that information wasomitted from the example for the sake of brevity.

IN In function descriptions, indicates parameters whose values are used to passdata to the function. These parameters are not used to return modified datato the calling routine. (Do not include the IN declaration in your code.)

OUT In function descriptions, indicates parameters whose values are used toreturn modified data to the calling routine. These parameters are not used topass data to the function. (Do not include the OUT declaration in your code.)

INOUT In function descriptions, indicates parameters whose values are passed to thefunction, modified by the function, and returned to the calling routine. Theseparameters serve as both IN and OUT parameters. (Do not include theINOUT declaration in your code.)

$CICS 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 environmentvariable named CICS is set to the product pathname, you can use theexamples exactly as shown; otherwise, you must replace all instances of$CICS with the CICS product pathname.

CICS on Open Systems Refers collectively to the CICS product for all supported UNIX platforms.

TXSeries CICS Refers collectively to the CICS for AIX, CICS for Solaris, and CICS forWindows NT products.

CICS Refers generically to the CICS on Open Systems and CICS for Windows NTproducts. References to a specific version of a CICS on Open Systemsproduct are used to highlight differences between CICS on Open Systemsproducts. Other CICS products in the CICS Family are distinguished by theiroperating system (for example, CICS for OS/2 or IBM mainframe-based CICSfor the ESA, MVS, and VSE platforms).

How to send your comments

Your feedback is important in helping to provide the most accurate andhighest quality information. If you have any comments about this book or anyother WebSphere Application Server Enterprise Edition documentation, sendyour comments by e-mail to waseedoc@us.ibm.com. Be sure to include thename of the book, the document number of the book, the version ofWebSphere Application Server Enterprise Edition, and, if applicable, thespecific location of the information you are commenting on (for example, apage number or table number).

About this book xiii

xiv WebSphere: CICS Administration Reference

Chapter 1. Resource definitions

Restrictions on the use of characters

Some of the resource definitions in this chapter have a <Key> field. For thesefields there are some restrictions on the use of metacharacters for names if youare using SMIT (CICS for AIX), or SAM (CICS for HP-UX), or a similaroperating system facility, because these facilities cannot handle them. Tospecify a name containing a metacharacter, use the RDO command-linefacility.

Shorthand notation for resource definitions

The following symbols can be used when specifying the value of resourceattributes:

%R or %rexpands to the current region name.

%H or %hexpands to the current host name (the name of the machine on whichCICS is running).

%S or %sexpands to the ShortName of the current file server, Structured FileServer or Gateway Server, provided that the server is on the localmachine. If the server is not on the local machine, the ShortNamecannot be determined so %S cannot be resolved.

CICS expands the shorthand notation when the resource definition is readfrom the permanent database.

If you need to use a percent sign (%) as a literal, you must use twoconsecutive percent signs.

Communications Definitions (CD)

Communications Definitions (CD) define the remote systems with which thisregion can communicate. The communication may use Transmission ControlProtocol/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 Monitorv a SNA Logical Unit (LU) type 6.2 system

CD entries are also created dynamically (autoinstalled) when an IBM CICSClient attaches to the region or when a CICS family TCP/IP connection isacquired.

<Key> This is the local name for a remote system with which the CICSregion can communicate, and is the key of the CD. This is referred toas the SYSID by application programs. This key is not affected byNational Language Support (NLS) and can be up to four characters,from the character set A-Z, 0-9, dollar ($), and at sign (@). For all thepermanent database operations, and on a runtime database insertoperation, CICS performs class-specific validation of the bytes formingthe database key.

Refer to “Restrictions on the use of characters” on page 1 if you areusing SMIT (CICS for AIX) or SAM (CICS for HP-UX) to set thisvalue.

ActivateOnStartup (Activate the resource at cold start?)If you set this attribute to yes, CICS always copies the resourcedefinition from the permanent database to the runtime database atstartup. If you set the attribute to no, CICS does not copy the resourcedefinition, unless its group has been specified in the Groups attributeof Region Definitions (RD). The default value is yes.

AllocateTimeout (Timeout on allocate (in seconds))This attribute describes how many seconds a front end transactionwaits for a backend transaction to be started over a communicationslink. The default value is 60. This attribute is applicable only toEncina PPC TCP/IP connections (ConnectionType=ppc_tcp) and toconnections 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 remotesystem. The values local_sna and ppc_gateway are for connectionsacross SNA networks. The values cics_tcp and ppc_tcp are forconnections using TCP/IP. See the CICS Intercommunication Guide formore information on the types of connections supported by CICS. Thedefault value is ppc_tcp.

2 WebSphere: CICS Administration Reference

DCECell (DCE cell name of remote system)This attribute specifies the ASCII text name of the cell in which theremote system is registered in the Cell Directory Service. The defaultvalue is “/.:/”.

DefaultSNAModeName (Default modename for a SNA connection)If the ConnectionType is local_sna or ppc_gateway, set this attributeto the name of the SNA mode group that most of your intersystemrequests use. This means that when an intersystem request is made onthis connection by a transaction that does not specify an SNAmodename in either the PROFILE option of the EXEC CICSALLOCATE command or the SNAModeName attribute of theTransactions Definition (TD) entry, CICS requests the modenamespecified in DefaultSNAModeName.

The default value of DefaultSNAModeName is ″″, meaning that themodename used will depend on the configuration for your SNAproduct. See the CICS Intercommunication Guide for more informationon configuring modenames.

This attribute is ignored if the ConnectionType is cics_tcp or ppc_tcp.

GatewayName (Gateway Definition (GD) entry name)This attribute specifies the name of the Gateway Definitions (GD)entry that describes the PPC gateway to be used for this connection.GatewayName is required only if ConnectionType=ppc_gateway. Thedefault value is "".

GroupName (Group to which resource belongs)This eight-byte ASCII text attribute assigns a group name to whichthis resource definition belongs. You can specify that, for cold start,CICS copies resource definitions belonging to groups named in theGroups attribute of Region Definitions (RD) from the permanentdatabase to the runtime database, as well as copying definitions thathave ActivateOnStartup=yes. The default value is "".

InService (Set connection in service?)This attribute specifies whether or not CICS should allow intersystemrequests to be sent to, or received from, the remote system. Set theattribute to no if communication with the remote system is not to beallowed initially. The connection can later be set in service usingEXEC CICS SET CONNECTION.The default value is yes.

LinkUserId (UserId for inbound requests)This attribute is used to identify a locally defined userid that can beassociated with inbound requests.

Other attributes that are used in conjunction with the LinkUserIdattribute are:v The CD RemoteSysSecurity attribute.

Chapter 1. Resource definitions 3

v The RD DefaultUserId attribute, as well as the TSL and RSL keysdefined in the UD entry for the userid specified with this attribute.

If a link userid is not specified, the CD TSLKeyMask andRSLKeyMask attributes are used to determine authorization.

Note: It is recommended that a UD entry is defined for the linkuserid specified with the LinkUserId attribute. See the CICSIntercommunication Guide for more information about how thisattribute is used for intersystem requests.

The default value is "".

ListenerName (Listener Definition (LD) entry name)This attribute specifies the name of an LD entry that has attributeProtocol=TCP. The Internet Protocol (IP) address and port numberspecified by this LD entry will be used by the remote system tocontact the local region. ListenerName is required only ifConnectionType=cics_tcp and, in this case, it must be specified evenif the connection is only to be used for outbound requests. The defaultvalue is "".

OutboundUserIds (Send userids on outbound requests?)Set this attribute to

sent to send userids on outbound requests for this connection

not_sentto prevent userids from being sent on outbound requests forthis connection

sent_only_with_pswdto send the userid with its password. If the password is notavailable, do not send the userid.

sent_maybe_with_pswdto send the userid with its password. If the password is notavailable, send the userid “already-verified”.

The default value is sent.

Permanent (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to no,you can amend or delete the entry. You can still amend or delete anentry with Permanent=yes by first setting Permanent to no. If you doamend the entry, you should set Permanent back to yes afterwards.The default value is no.

RemoteCodePageTR (Code page for transaction routing)This attribute specifies the code page for transaction routing dataflowing between your CICS system and the remote system. If thiscode page is different from your system’s code page, CICS willconvert transaction routing data between the local code page and thecode page specified by RemoteCodePageTR when sending orreceiving data.

The code page specified in RemoteCodePageTR must be either thesame as the local code page or one of the code pages that is able toconvert 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 DefaultCICS for AIX ISO8859-1CICS for Windows NT IBM-850CICS for HP-UX ISO8859-1CICS for Solaris ISO8859-1

See the CICS Intercommunication Guide for more information.

RemoteLUName (Name of remote system)This attribute specifies the name of the remote system and the valuerequired depends on the attribute ConnectionType. IfConnectionType=ppc_tcp , set RemoteLUName to the APPLID(region name) of the remote system. If ConnectionType=local_sna orConnectionType=ppc_gateway, set RemoteLUName to the LogicalUnit (LU) name of the remote system. If ConnectionType=cics_tcp ,RemoteLUName to the APPLID of the remote system unless theremote system is CICS for OS/2 in which case set it to the NETNAMEreturnedcicstcpnetname command. The default value is "".

RemoteNetworkName (SNA network name for the remote system)This attribute specifies the name of the network to which the remotesystem is attached. The name can be up to eight characters long. If theremote system is connected using SNA, the value of this attributemust be the SNA network name of the remote system. If the remotesystem is connected using TCP/IP, the value of this attribute must bethe network name, if any, defined in the remote system. On CICS onOpen Systems the network name of the system is specified in theattribute LocalNetworkName in the Region Definitions (RD).Thedefault value is "".

RemoteSysEncrypt (Transmission encryption level)This attribute specifies 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 notcurrently supported.

RemoteSysSecurity (Security level for inbound requests)This attribute specifies how CICS is to process security information,such as userids and passwords, received with an inbound request. Itcan have one of three values.v local means discard all security information received and assign the

userid specified in the LinkUserId attribute to the request. (IfLinkUserId=″″ the userid from the Region Definition (RD) entryattribute DefaultUserId is used instead.)

v verify means that only userids received with a valid password canbe assigned to the inbound request. If the password is missing, orincorrect, or no userid was sent, then the userid specified by the RDentry attribute DefaultUserId is to be used.

v trusted allows userids received with or without a password to beassigned to the request. If no userid is sent, the userid specified inthe RD entry attribute DefaultUserId is to be used.

Once the userid is assigned, the Transaction Security Level (TSL) andResource Security Level (RSL) keys are calculated for the request. Therequest is given the keys that are specified in both the User Definition(UD) entry for the assigned userid and in the UD entry for the useridspecified in the LinkUserId attribute. If the LinkUserId=″″ then thekeys from attributes RSLKeyMask and TSLKeyMask are usedinstead of the LinkUserId keys. The CICS Intercommunication Guideprovides more information on when to use the differentRemoteSysSecurity options and how it is affected by your networkconfiguration. The default value for RemoteSysSecurity is local.

RemoteTCPAddress (TCP address for the remote system)This attribute specifies the name or address of the network adapter forthe remote system. It can be specified 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 defined in the Internet name service. For example

aix5.cicsland.com. This host name must refer to only one IPaddress.

The RemoteTCPAddress is required only if ConnectionType=cics_tcp.The default value is "".

RemoteTCPPort (TCP port number for the remote system)This attribute specifies the number of the Transmission ControlProtocol/Internet Protocol (TCP/IP) port on which the remote systemis listening for requests. RemoteTCPPort is required only ifConnectionType=cics_tcp. The default value is 1435, the portregistered for CICS with the Internet Assigned Number Authority(IANA).

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is Communications Definition.

RSLKeyMask (Resource Security Level (RSL) Key Mask)This attribute contains the list of resource link security keys that CICSuses to control access to resources from transactions. These keys areonly used when a LinkUserId is not specified, as described in theCICS Intercommunication Guide.

You can specify up to 24 keys, each in the range 1 through 24 andseparated by the | character. The following example shows thatresources 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 allthe transactions.

CICS takes the values that are common to the RSLKeyMask and theRSLKeylist attribute defined in the User Definitions (UD) entry forthe user. The result of this operation specifies the actual resourcesecurity keys employed for validation.

Note: You should be aware of the implications of resources marked aseither public or private. With public, any user may access theresource. With private, CICS only allows access to the resourcefrom transactions which have the attribute RSLCheck=none intheir Transaction Definitions (TD) entry. For furtherinformation, see the CICS Administration Guide.

The CICS Intercommunication Guide also contains more informationabout how this attribute is used for intersystem requests.

The default value for RSLKeyMask is none, which gives access topublic transactions.

SNAConnectName (SNA profile describing the remote system)This attribute is used only for SNA connections. It specifies the nameof the partner LU alias defined in your SNA product and is required

only if the partner LU alias is different from the LU name of theremote system. Do not code this field if the partner LU alias is thesame as the RemoteLUName. See the CICS Intercommunication Guidefor the different requirements of each operating system. The defaultvalue is "".

TSLKeyMask (Transaction Security Level (TSL) Key Mask)This attribute contains the list of transaction link security keys thatCICS uses to control access to transactions. These keys are only usedwhen a LinkUserId is not specified, as described in the CICSIntercommunication Guide.

You can specify up to 64 keys, each in the range 1 through 64 andseparated by the | character. The following example shows thattransactions 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 allthe transactions.

CICS takes the values that are common to the TSLKeyMask and theTSLKeyList attribute defined in the UD entry for the user. The resultof this operation specifies the actual transaction security keysemployed for validation.

Read the CICS Intercommunication Guide for more information abouthow this attribute is used for intersystem requests and for furtherinformation about transaction security.

The default value for TSLKeyMask is none.

File Definitions (FD)

File Definitions (FD) identify and describe files available for use by CICSapplication programs and CICS itself (for example, for monitoring) in thisCICS region.

<Key> This represents a unique name that identifies the file to CICS, and isthe key for the FD entry. Filenames are not supported by NationalLanguage Support (NLS) and can be up to eight characters, takenfrom the ASCII characters listed here. For all the permanent databaseoperations, and on a runtime database insert operation, CICSperforms class-specific validation of the bytes forming the databasekey. For files, CICS allows ASCII characters from exclamation (!) totilde (˜), (33 to 126 decimal).

ActivateOnStartup (Activate resource at cold start?)If you set this attribute to yes, CICS always copies the resourcedefinition from the permanent database to the runtime database atcold start. If you set the attribute to no, CICS does not copy theresource definition, unless its group has been specified in the Groupsattribute of Region Definitions (RD). The default value is yes.

AddOpt (Add access status)This attribute defines whether or not add operations are allowed onthe file. The possible settings are: addable and notaddable. Thedefault value is addable.

BaseName (Server filename)This ASCII text attribute specifies the name of the file as known bythe file server. You should set this only for a local file. The defaultvalue is "".

BrowseOpt (Browse access status)This attribute defines whether or not browse operations are allowedon the file. The possible settings are browsable and notbrowsable.The default value is browsable.

DeleteOpt (Delete access status)This attribute defines whether or not delete operations are allowed onthe file. The possible settings are deletable and notdeletable. Thedefault value is deletable.

EmptyOpt (Empty status for first file open)This attribute defines whether or not CICS must empty the file whenit is opened. The possible settings are empty and do_not_empty. Thedefault value is do_not_empty.

EnableStatus (File enable status)This attribute defines whether the file is enabled, disabled, unenabled,or in the process of being disabled. The possible settings are enabled,disabled, unenabled, and disabling. When defining the file, you mayonly specify enabled or disabled. The default value is enabled.

ErrorIsolation (Error isolation)This attribute indicates if SFS Error Isolation is to be used withrecoverable OFDs opened on the file. The attribute is ignored fornonrecoverable files. If set to on, all SFS errors are passed on to theapplication. If set to off, certain SFS errors are not passed on to the

application and, if an error occurs, the transaction is forced to abend.Performance improves slightly if you set this attribute to off becausethe 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 ProcedureCalls (RPC) between the region and the SFS when it deals with thisfile. Possible values are none, connect, call, pkt, pkt_integ,pkt_privacy (only if you have installed DCE privacy support) anddefault.

none means that DCE makes no attempt to authenticate the RPCs.connect, call, pkt and pkt_integ represent increasing levels of DCEauthentication.

This attribute should be used in conjunction with theRuntimeProtection attribute in the Region Definitions (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

specified in FileProtection is used.v If FileProtection is set to none, the value specified in

RuntimeProtection is used.

The value default is the default DCE protection level. For moreinformation about protection levels, see the DCE documentation. Beaware that the higher the protection level, the more time is required toauthenticate and this might affect performance. The default value isnone.

FileServer (File Server)This ASCII text attribute defines the name of the SFS server for a localfile. For a remote file or for a DB2 file, it should be blank. The defaultvalue is "".

IndexName (Server Index Name)This ASCII text attribute defines the server index name. You shouldset this only for a local file. The default value is "".

KeyLen (Key length to use with remote requests)This attribute specifies the key length to be used with requests toremote Key Sequenced Data Set (KSDS) files. The default value is 0.

OpenStatus (File open status)This attribute defines whether the file is open, closed, in the process ofopening, in the process of closing, or has had a close request issuedfor it. The possible settings are: open, closed, opening, closing, andcloserequest. When defining the file, you may only specify open orclosed. The default value is closed.

PrePages (Number of pages to preallocate)this attribute specifies the number of pages to be preallocated for a filethat has the attribute EmptyOpt=emptywhen it is opened. The defaultvalue is 1.

ReadOpt (Read access status)This attribute defines whether or not read operations are allowed onthe file. The possible settings are readable and notreadable. Thedefault value is readable.

RecordSize (Record length to use with remote requests)This attribute specifies the record length to be used with requests toremote files. The default value is 0.

RecoverStatus (Recoverability status)This attribute specifies whether the file is recoverable ornonrecoverable. The possible settings are recoverable andnotrecoverable. The default value is recoverable.

RemoteName (Remote filename)If the file resides in a remote region or system, you must enter thename by which the file is known there. If you do not provide thisASCII text attribute, CICS sends the local identifier of this file to theremote region. The shorthand notations %R, %H, and %S are notexpanded for this attribute. For example, a value of “%H” reallymeans the string “%H”. The default value is "".

RemoteSysId (Remote System Name)If the file resides in a remote region, you must enter the name of a

Communications Definitions (CD) entry that defines a connection tothe remote region. The default value is "" meaning that the file residesin the local region.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “File Definition”.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for this file, in therange 1 through 24. If the user, whose transaction issues this request,does not have this RSLKey value in the RSLKeylist attribute in theUser Definitions (UD), CICS raises the NOTAUTH condition.Alternatively, you can specify the value public or private. Withpublic, any user may access the file. With private, CICS only allowsaccess to the file from transactions which have the attributeRSLCheck=none. in their Transaction Definitions (TD) entry. Thedefault value is private.

For further information about resource security, read the CICSAdministration Guide.

TemplateDefined (Is a user conversion template defined)If this file can be accessed from a non-ASCII region, or if it containsbinary or user-defined data, then you need to define a conversiontemplate for the file. If such a template exists, you should set thisattribute to yes, otherwise to no. The default value is no.

UpdateOpt (Update access status)This attributes defines whether or not update operations are allowedon the file. The possible settings are updatable and notupdatable. Thedefault value is updatable.

Gateway Definitions (GD)

Gateway Definitions (GD) define the PPC gateways to other systems withwhich this region can communicate.

<Key> This represents the identifier for a particular GD entry. It may bebetween one and four characters long. CICS allows the ASCIIcharacters A-Z, 0-9, dollar ($), at sign (@) and number sign (#).

ActivateOnStartup (Activate resource at cold start?)This attribute can be set to either yes or no. If you set this attribute toyes, the GD entry will be installed automatically at CICS start up,

irrespective of whether the RDO group, if any, specified in theGroupName attribute is listed to be installed at start up or not. If youset the attribute to no, CICS does not copy the resource definition,unless its group has been specified in the Groups attribute of RegionDefinitions (RD). The default value is yes.

DCECell (DCE cell name of the gateway)This attribute specifies the ASCII text name of the DCE cell in whichthe 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 gatewayregisters with the DCE Cell Directory Services (CDS). This attributecan take either the full path name of the PPC gateway (for example/.:/cics/ppc/gateway/CICSOPEN) or a partial name (for exampleCICSOPEN). CICS will prefix a partial name with the string/.:/cics/ppc/gateway/. For example, if you specified the partial nameGatewayCDSName=CICSOPEN the full path used by CICS would be/.:/cics/ppc/gateway/CICSOPEN.

GatewayLUName (SNA LU name of the gateway)This is the SNA Logical Unit (LU) name that the PPC gateway is touse as your region’s local LU name. The LU name should be no morethan eight characters long. The first character must be an upper casealphabetic character (A-Z) and the subsequent characters must beeither 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 theLocalLUName in the Region Definition (RD) entry.

GatewayPrincipal (DCE principal under which this gateway runs)This ASCII text attribute specifies the name of the DCE principal usedby the PPC gateway. If GatewayPrincipal=″″ CICS will use a value forGatewayPrincipal based on the GatewayCDSName. For example, ifGatewayCDSName=/.:/cics/ppc/gateway/CICSOPEN orGatewayCDSName=CICSOPEN CICS would useGatewayPrincipal=cics/ppc/gateway/CICSOPEN. TheGatewayPrincipal attribute is ignored if the Region Definition (RD)attribute RuntimeProtection is set to none. If RuntimeProtection isset to anything other than none the region will check that requestscoming from the PPC gateway are authenticated using this DCEprincipal. If the value of GatewayPrincipal is not the same as theDCE principal used by the PPC gateway all requests from the PPCgateway will be rejected by CICS. The default value forGatewayPrincipal is "".

GroupName (Group to which resource belongs)This eight-byte ASCII text attribute assigns a group name to whichthis resource description entry belongs. You can specify that, for coldstart, CICS copies resource definitions belonging to groups named inthe Groups attribute of Region Definitions (RD) from the permanentdatabase to the runtime database, as well as copying definitions thathave ActivateOnStartup=yes. The default value is "", which does notassign the GD entry to any RDO group.

Permanent (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to no,you can amend or delete the entry. You can still amend or delete anentry with Permanent=yes by first setting Permanent to no. If you doamend the entry, you should set Permanent back to yes afterwards.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this GD entry. The defaultvalue is “Gateway Definition”.

Gateway Server Definitions (GSD)

Gateway Server Definitions (GSD) define the characteristics required to startand stop the PPC gateway. A GSD entry is created by the cicsppcgwycreatecommand and removed by the cicsppcgwydestroy command. The GSD is notused by CICS for Solaris.

Your CICS region does not access the Gateway Server Definitions (GSD).Instead, it uses a Gateway Definition (GD) which is described in “GatewayDefinitions (GD)” on page 12.

<Key> This is the server name of the PPC gateway. It is of the form/.:/cics/ppc/gateway/gatewayname.

LogVolume (Logical volume for logging)This is the name of the logical volume used by the PPC gateway tostore its configuration and transaction data. The default value forLogVolume is log_%S, where %S expands to the value in theShortName attribute.

NameService (Name Service for advertising server)This attribute determines whether or not the DCE Name Service is tobe used to resolve server names. The possible values are DCE andNONE. The default value is DCE. If NONE is specified, one entry foreach server will be required in the file/var/cics_servers/server_bindings (for Open Systems) or\var\cics_servers\server_bindings (for Windows NT). See the CICSAdministration Guide for more information.

Permanent (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to no,you can amend or delete the entry. You can still amend or delete anentry with Permanent=yes by first setting Permanent to no. If you doamend the entry, you should set Permanent back to yes afterwards.

ProtectionLevel (Protection level)This attribute sets the minimum authentication level that the PPCgateway uses to send and receive Remote Procedure Calls (RPCs) toand from your CICS regions. The possible values are none, connect,call, pkt, pkt_integ, pkt_privacy (only if you have installed DCEprivacy support) and default, and the value used must be the same asthe RuntimeProtection level set in the Region Definition (RD) entryfor each of the CICS regions that use the PPC gateway. If NameService is set to NONE, ProtectionLevel should be set to none. Thedefault value is none.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “PPC Gateway Server Definition”.

ShortName (Short name used for subsystem)This is a one to eight character name for the PPC gateway. This valueis referenced by other attributes using %S. It is also used to generate

default names in other attributes in the GSD entry. Each PPC gatewaymust 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 defaultmodename to a PPC gateway that is using HP SNAplus2. Thismodename is used on all intersystem requests that do not specify amodename. The default value is "".

StartType (Cold or auto start?)This attribute determines the type of initialization that the PPCgateway should perform. It may be set to cold or auto. IfStartType=cold then the PPC gateway is started as if it has neverbeen run before. This means all of the CICS configuration andtransaction data it has stored is lost. If StartType=auto then the PPCgateway is started using the information, if any, saved from the lasttime it ran.

The default value is auto. You should only use StartType=cold thefirst time the PPC gateway is started.

ThreadPoolSize (Number of threads for RPC requests)This attribute is the number of Remote Procedure Calls (RPCs) thatthe PPC gateway can receive at once. The default value is 10. As anRPC to the PPC gateway is very fast this default value should beadequate for most PPC gateways.

UserID (User ID for server)This is the operating system userid that the PPC gateway will usewhen it is running. The default value is %S, which means the value inthe ShortName attribute.

Journal Definitions (JD)

The JD controls destinations for journaling output from the CICS region.

<Key> This represents a unique user journal identifier, and is the key for theJD entry. Journal identifiers are in the range 1 to 99. However, 1 isreserved on other CICS systems for the system journal and it isinadvisable to use journal 1 on CICS on Open Systems for migrationreasons.

ActivateOnStartup (Activate resource at cold start?)If you set this attribute to yes, CICS copies the resource definitionfrom the permanent database to the runtime database at cold start. Ifyou set the attribute to no, CICS does not copy the resourcedefinition, unless its group has been specified in the Groups attributeof Region Definitions (RD). The default value is yes.

CrucialFlag (Abort region if journal is inaccessible?)If this attribute is set to yes, and an unrecoverable output I/O erroroccurs, CICS abnormally terminates the region. Typically, journalswith this attribute set are used for audit purposes. The default valueis no.

DiskA (File or path A holding the journal)This ASCII text attribute specifies the file name that CICS uses to holdthe journal in /var/cics_regions/regionName/data. The file must bewriteable, and must have a name that is different from the one onDiskB. You can request to switch between DiskA and the alternativefile in DiskB, using EXEC CICS SET JOURNAL, or CEMT SETJOURNALNUM. If you do not specify a file name, CICS creates a userjournal with the name CjrnlxxA in/var/cics_regions/regionName/data, where xx is the journal id. Thejournal definitions are not updated to include this name, so it remainsas "". The default value is "".

CICS does not empty user journals, so you must clear them whenthey are no longer required. If CICS is offline, delete the two operatingsystem files that are defined as DiskA and DiskB attributes. If CICS isonline, see the CICS Administration Guide for further information aboutclearing journals. On CICS for Windows NT, if CICS is online, use theCEMT transaction to close the journal before deleting it.

DiskAStatus (Disk A Status)This attribute specifies the status of DiskA. Set the attribute to currentif you want to use DiskA for journaling output; or set it to ready andset DiskBStatus to current if you want to use DiskB for journalingoutput. The default value is current.

DiskB (File or path B holding the journal)This ASCII text attribute specifies the file name that CICS uses to holdthe journal in regionName/data. The file must be writeable, and musthave a name that is different from the one on DiskA. You can requestto switch between DiskB and the alternative file in DiskA, usingEXEC CICS SET JOURNAL, or CEMT SET JOURNALNUM. If you donot specify a file name, CICS creates a user journal with the nameCjrnlxxB in /var/cics_regions/regionName/data, where xx is thejournal id. The journal definitions are not updated to include thisname, so it remains as ″″. The default value is "".

CICS does not empty user journals, so you must clear them whenthey are no longer required. If CICS is offline, delete the two operatingsystem files that are defined as DiskA and DiskB attributes. If CICS isonline, see the CICS Administration Guide for further information about

clearing journals. On CICS for Windows NT if CICS is online, use theCEMT transaction to close the journal before deleting it.

DiskBStatus (Disk B Status)This attribute specifies the status of DiskB. Set the attribute to currentif you want to use DiskB for journaling output; or set it to ready andset DiskAStatus to current if you want to use DiskA for journalingoutput. The default value is ready.

InitialOpenFlag (Open journal on region startup?)This attribute is set to yes or no to indicate whether or not the journalis available for use. The default value is yes.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “Journal Definition”.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for this journal, in therange 1 through 24. If a transaction issues a request to write to thisjournal, and the user of the transaction does not have this RSLKeyvalue in the RSLKeyList attribute in their User Definitions (UD) entry,CICS raises the NOTAUTH condition. Alternatively, you can specifythe value public or private. With public, any user may access thejournal. With private, CICS only allows access to the journal fromtransactions that have the attribute RSLCheck=none in theirTransaction Definitions (TD) entry. The default value is private.

Listener Definitions (LD)

A standard CICS region will, by default, receive requests from clients andservers that use a DCE RPC interface, for example:v Another CICS regionv A PPC gatewayv CICS terminals such as cicsterm or cicsteld

<Key> This is a 12-byte identifier for the LD entry. LD keys are notsupported by National Language Support (NLS). CICS allows theASCII characters A-Z, 0-9, dollar ($), at sign (@) and number sign (#).

ActivateOnStartup (Activate resource at cold start?)If you set this attribute to yes, CICS copies the resource definitionfrom the permanent database to the runtime database at cold start. Ifyou set the attribute to no, CICS does not copy the resourcedefinition. The default value is yes.

CICSUserIdThe default userid under which IIOP requests run. This can beoverridden by one of the IIOP user exits. The default value is "". Thisuser must be defined to the CICS region. If the user is not defined, orthis 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 whichthis resource definition belongs. You can specify that, for cold start,CICS copies resource definitions belonging to groups named in theGroups attribute of Region Definitions (RD) from the permanentdatabase to the runtime database, as well as copying definitions thathave ActivateOnStartup=yes. The default value is "", which does notassign the LD entry to any RDO group.

NamedPipeName (local Named Pipe name)Specifies the entry in the file prodDir\bin\cicslcli.ini, which isused by the command cicsltermto connect to this region. The value ofthe attribute must be 6 alphanumeric characters, of which the last twocharacters must be unique within the local system.

Permanent (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to no,

you can amend or delete the entry. You can still amend or delete anentry with Permanent=yes by first setting Permanent to no. If you doamend the entry, you should set Permanent back to yes afterwards.The default value is yes.

Protocol (Protocol type)This attribute defines the type of LD entry. If it is set to TCP this is anLD entry for CICS clients using TCP/IP, and CICS family TCP/IPconnection. If it is set to SNA this is an LD entry for local SNAsupport. If it is set to NamedPipe this is an LD entry for cicsltermterminal. If it is set to LU0 this is the LD entry for SNA LU0communication (Windows NT only). If it is set to IIOP, this is an LDentry for IIOP clients using TCP/IP IIOP connections. The defaultvalue is TCP.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing the resource. The defaultvalue is Listener Definition.

SNAServerNodeName (local SNA Node Name) (CICS for Solaris only)This attribute defines 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/IPthen the SNAServerNodeName is the IP address or TCP/IP hostname of the host on which the SNA server is running.

SSLAuthenticationThis attribute specifies whether SSL authentication is supported by anIIOP listener. The default no indicates that the listener does notsupport SSL. Other values are yes and client. Specify yes to configurean IIOP SSL listener that accepts SSL flows other than clientauthentication. Specify client to accept all SSL flows including clientauthentication.

SSLEncryptionThis attribute specifies the level of encryption required on an SSLenabled IIOP listener. Possible values are no, yes and strong. Thedefault is no. Specify no for using SSL message integrity support (noencryption), specify yes or strong for SSL message encryption using40-bit or 128-bit encryption keys respectively.

Note: 128-bit keys are only valid in the US and Canada.

SSLKeyFileThis attribute specifies the location and name of the SSL key databasefile. The default value is "".

SSLKeyPasswordThis attribute specifies the password for the SSL key database file. The

default value is "". If no password is specified, CICS assumes apassword has been saved in a stash file in the same directory as theSSL key database file.

SSLCertificateThe name (label) of the certificate for this SSL listener in the keydatabase file. The default value is "", which causes CICS to use thedefault nominated certificate in the database.

SSLSessionTimeoutThis is the timeout (in minutes) for SSL to timeout the current sessionkey. SSL then attempts to create a new session key, The default is 0(the timeout is 1 day).

TCPAddress (TCP adapter address)This attribute defines which local network adapter addresses will beused by CICS to accept TCP/IP connections. It is applicable only ifProtocol=TCP. Set TCPAddress=""when connection requests are to beaccepted on any of the network adapters configured on the localmachine. Alternatively, set TCPAddressto a single network adapteraddress 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 defined in the Internet name service. For example,

aix5.cicsland.com.

TCPService (TCP service name)This attribute specifies the service name in the file /etc/services(forOpen Systems) or\system32\driver\etc\services (for WindowsNT).that should be used by CICS when starting the TCP protocol. Avalue of ″″ means the reserved CICS port number (1435/tcp) will beused. The default value is "".

Entries in /etc/services for TCPService must specify the port numberand the tcp protocol. For example, ifTCPService = "cicstcp"

The file /etc/services could contain:cicstcp 2345/tcp # CICS Common Clients

Monitoring Definitions (MD)

The MD controls monitoring output from the CICS region.

Conversational (Write separate records for conversational tasks?)This attribute specifies whether conversational tasks are to haveseparate monitoring records written for each pair of terminal controlinput and output requests. Set it to yes if you require separaterecords, or to no otherwise. The default value is no.

Exclude (Monitoring identifiers to be excluded)By default, all performance monitoring fields are reported by CICS tothe transient data queue. The Exclude attribute is 1024 bytes long, andcontains a list of all fields which are not to be reported by CICS.

All available performance monitoring fields have their own numericfield identifier together with an associated group name. This groupname identifies the group of fields to which each individual fieldbelongs.

You can exclude fields from reporting either by using the numericidentifier, to exclude a single field, or the group name, to exclude agroup of fields. Alternatively you can use a combination of numericand group identifications to exclude monitoring fields.

The Exclude attribute can contain one or more group names ornumeric identifiers, and these are separated by commas.

The Exclude attribute can just contain the string ALL to indicate thatall fields should be excluded from performance monitoring.

You cannot exclude field identifiers 1, 2, 4, 5, 6, and 89 which arealways part of a Monitoring Record. The default value is "".

Include (Monitoring identifiers to be included)By default, all performance monitoring fields are reported by CICS tothe transient data queue. The Include attribute is 1024 bytes long, andcontains a list of all fields which are to be reported by CICS.

All available performance monitoring fields have their own numericfield identifier together with an associated group name. This groupname identifies the group of fields to which each individual fieldbelongs.

You can include fields for reporting either by using the numericidentifier, to include a single field, or the group name, to include agroup of fields. Alternatively you can use a combination of numericand group identifications to include monitoring fields.

The Include attribute can contain one or more group names ornumeric identifiers, and these are separated by commas. The defaultvalue is "".

Note: CICS always processes the Exclude attribute before the Includeattribute. This allows the easy encoding of the selection of alimited set of fields to be reported. You normally use theInclude attribute to override the effects of the Exclude attribute.

For a list of monitoring fields and their associated groups, see theCICS Administration Guide.

Modifiable (Protect the resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to yes,you can amend or delete the entry. You can still amend or delete anentry with Modifiable=no by first setting Modifiable to yes. If you doamend the entry, you should set Modifiable 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 CICSis to perform monitoring. If you initially set this to no, you can stilluse 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 Definition”.

TDQ (TDQ to hold monitoring information)This ASCII text attribute specifies the name of the transient dataqueue where CICS writes all the monitoring information. You mustdefine the queue in the Transient Data Definitions (TDD) as anextrapartition queue for output with variable length records. Theshorthand notations %R, %H, and %S are not expanded for thisattribute. 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, butnothing 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 allowsyou to customize how monitoring is controlled within your CICSregion.

For further information, read “Performance monitoring user program”on page 395.

Object definitions (OD)

A new CICS Resource Definition called the Object Definition (OD) has beenintroduced for the CICS IIOP ORB. The OD has the following defaultattributes:

< Key>A unique 8-character key

GroupNameThe group to which resource belongs. The default value is "".

ActivateOnStartupSpecifies whether to copy to runtime on cold start. The default is yes.

ResourceDescriptionThe text describing this resource. The default value is ObjectDefinition.

AmendCounterReserved for CICS internal use.

PermanentSpecifies whether to protect from modification. The default value isno.

ModuleThe full IDL module name. The default value is "".

InterfaceThe full IDL interface name. The default value is "".

OperationThe full IDL operation name. The operation can be left null, whichenables a match on a specific operation, also enabling other attributes(for example, Transid) to be set specifically for that operation. If amatch for a specific operation cannot be made, then the match ismade based on Module::Interface. The default value is "".

TransIdThe transaction identifier that is used. The value is passed to thesecurity user exit. The default is value is "" (the transaction thendefaults to CIOD).

ManagedSpecifies whether the resource is workload managed. The defaultvalue is no.

OrbAdapterDllNameThe name of the DLL that is loaded. The default value is "".

ImplementationLanguageThe implementation language (Java). The only supported language isJava.

CachedSpecifies whether the object is cached. The default value is no.

ReloadableSpecifies whether the object is reloadable. The default value is yes.

Product Definitions (XAD)

CICS uses the Product Definitions (XAD) to hold information needed tointerface to other transactional products, using the X/Open XA protocol. EachXAD entry contains information for one product.

<Key> This represents the name of the product, and is the key for the XADentry. Product names can be up to 12 characters long.

Permanent (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete the permanent database entry. If you set the attribute to no,you can amend or delete the entry. You can still amend or delete anentry with Permanent=yes by first setting Permanent to no. If youamend 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 the resource. The defaultvalue is “XA Product Definition”.

SwitchLoadFile (Switch Load File Path Name)This ASCII text attribute is a path name to an object file (dll onWindows NT, or to a shared object file on CICS for Solaris) whichcontains the xa_switch_t structure definition and XA supportsubroutines for this XA compliant product. The default value is "".

This file is loaded into a CICS application server using an operatingsystem call. The file must contain a function which returns theaddress 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 file, in which case the file is searchedfor in the current region’s bin directory followed by the $CICS/bindirectory (for Open Systems) or the c:\opt\cics\bin directory (forWindows NT). This is the same as the PathName attribute in theProgram Definitions (PD) definition, and exhibits the same searchbehavior.

XAClose (Resource Manager Termination String)This is an ASCII character close string that is passed to theXA-compliant xa_close function. The content of the string is specific tothe XA product being defined. Refer to the product documentationsupplied 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 theXA-compliant xa_open function. The content of the string is specific tothe XA product being defined. Refer to the product documentationsupplied with the XA-compliant product. The default value is "".

Note: By default, the XA open string appears in the CICS region’sconsole file on startup. To prevent this string (which, for certaindatabases, can contain the userid and password) fromappearing in this file, add the lineCICS_SUPPRESS_XAOPEN_STRING=1 to the region’s environmentfile, located in: /var/cics_regions/regionName/environment (forCICS on Open Systems) and\var\cics_regions\regionName\environment (for CICS forWindows NT).

XASerialize (Resource Manager Serialization Attribute)This is an indication of how CICS should serialize access to an XAcompliant resource manager in a multithreaded process. This attribute

is used to indicate that an XA compliant resource manager supportsXA calls from multiple threads, and what style of serialization the XAcompliant 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 placearound a transaction.single_association or multiple_association - Allows CICS toserialize based on whether or not the XA compliant product isthread aware.

The default value is all_operations.

Program Definitions (PD)

Program Definitions (PD) identify the application programs, mapsets, andtables you require in your CICS region, including those supplied by CICS.

<Key> This key for the PD entry represents a unique program, mapset, ortable. It can be up to eight ASCII characters long for programs andtables, and up to seven ASCII characters long for mapsets. Names canbe taken from the ASCII characters A-Z, a-z, 0-9, $, and @ (CICSconverts all lowercase characters to uppercase). Do not begin nameswith the sequence “DFH”; this prefix is reserved for CICS internaluse. Program names do not have National Language Support (NLS).On all permanent database operations and runtime database insertoperations, CICS performs class-specific validation of the bytesforming the database key.

EnableStatus (Program enable status)Set this attribute to enabled if the program is available for use or todisabled if the program is not available for use. The default value isenabled.

GroupName (Group to which resource belongs)This eight-byte ASCII text attribute assigns a group name to whichthis resource definition belongs. You can specify that, for a cold start,CICS copy resource definitions belonging to groups named in theGroups attribute of the Region Definitions (RD) from the permanentdatabase to the runtime database. You can also have CICS copydefinitions that have the setting ActivateOnStartup=yes to theruntime database. The default value is "".

PathName (Program pathname)This is an ASCII text attribute that identifies the directory path andfilename 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 file, followed by the filename.v A relative pathname to the file, followed by the filename. CICS

interprets the pathname to be relative to/var/cics_regions/regionName (for Open Systems) orrootDir\var\cics_regions\regionName (for Windows NT).

v A filename string not containing any slash character (/) (for OpenSystems) or backslash character (\) (for Windows NT).To find a program specified as a string, CICS searches thedirectories 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 find a mapset specified as a string, thefilename must have the extension .map. CICS searches thedirectories in the following order:1. /var/cics_regions/regionName/maps/locale (for Open Systems)

or rootDir\var\cics_regions\regionName\maps\locale (forWindows NT)

2. /var/cics_regions/regionName/maps/prime (for Open Systems)or rootDir\var\cics_regions\regionName\maps\prime (forWindows NT)

3. /opt/cics/maps/locale (for Open Systems) orrootDir\opt\cics\maps\locale (for Windows NT)

4. /opt/cics/maps/prime (for Open Systems) orrootDir\opt\cics\maps\prime (for Windows NT)

Normally, the value used for locale is determined by the Languagesetting (in the International section of the Control Panel) of thesystem on which the region is running. The locale setting for usersconnected by using the command cicsteld is specified by the -loption of the cicsteld command. The setting for UNIX clientterminals is determined by the user’s UNIX locale. Thecorrespondence between the Language setting and the locale isshown in the following table:

Language Locale

Chinese zh_CN

English en_US

French fr_FR

German de_DE

Italian it_IT

Japanese Ja_JP

Korean kr_KR

Portuguese pt_BR

Spanish es_ES

To find a table specified as a string, CICS searches the directory/var/cics_regions/regionName/data (for Open Systems) orrootDir\var\cics_regions\regionName\data (for Windows NT).

For programs written in a language other than Java, the filenamespecified in the PathName attribute must not contain an extension. Forprograms written in Java, the filename must include the .class suffix.CICS searches for the program file based on its installed extension inthe 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 files (no extension)2. IBM COBOL files (with extension .ibmcob)3. Micro Focus COBOL native code files (with extension .gnt)4. Micro Focus COBOL intermediate code files (with extension

.int)5. IBM PL/I files (with extension .ibmpli)6. IBM C++ files (with extension .ibmcpp)

v On CICS for Open Systems when Micro Focus COBOL Animator isused (not all languages are available on all operating systems):

1. C program files (no extension)2. IBM COBOL files (with extension .ibmcob)3. Micro Focus COBOL intermediate code files (with extension

.int)4. Micro Focus COBOL native code files (with extension .gnt)5. IBM PL/I files (with extension .ibmpli)6. IBM C++ files (with extension .ibmcpp)

v On Windows NT systems:1. Micro Focus COBOL or Net Express files (with extension

.cbmfnt, .int, or.gnt)—see Note below2. C program files (with extension .dll)3. IBM COBOL files (with extension .ibmcob)4. IBM PL/I files (with extension .ibmpll)5. IBM C++ files (with extension .ibmcpp)6. Microsoft C++ files (with extension .cpp)

Note: The order by which CICS searches through Micro Focus filesdepends upon:v Whether you are using Micro Focus COBOL or Net Expressv If you are using Micro Focus COBOL, whether you are using

Animator

If you are using Net Express, CICS searches for Micro Focusfiles in this order whether or not you are using Animator:1. Micro Focus COBOL generated code files (with extension

.cbmfnt)2. Micro Focus COBOL native code files (with extension .gnt)3. Micro Focus COBOL intermediate code files (with extension

If you are using Micro Focus COBOL with Animator, CICSsearches for Micro Focus files in this order:1. Micro Focus COBOL intermediate code files (with extension

.int)2. Micro Focus COBOL native code files (with extension .gnt)

If you are using Micro Focus COBOL without Animator, CICSsearches only for Micro Focus files with the extension .cbmfnt.

Permanent (Protect resource from modifications?)This attribute specifies whether CICS permits you to amend or deletethe permanent database entry. If you set the attribute to no, you canamend or delete the entry. You can still amend or delete an entry with

the setting Permanent=yes by temporarily setting Permanent to no. Ifyou do amend the entry, set Permanent back to yes afterwards. Thedefault value is no.

ProgType (Program type)This attribute specifies whether the entry is a program, mapset, ortable. Specify one of the values: program, map, or table. The defaultvalue is program.

RemoteName (Name to use for program on remote system)If the program resides in a remote region, enter the name by whichthe program is known there. If you do not provide this attribute, CICSsends the program’s local identifier to the remote region. The defaultvalue is "".

RemoteSysId (Remote system on which to run program)If the program resides in a remote region, you must enter the name ofa Communications Definitions (CD) entry that defines a connection tothe remote region. The default value is "", meaning that the programresides on the local region.

Resident (Is this a program that should be cached?)This attribute specifies whether a program can reside in theapplication server’s program cache after it has been loaded. If you setthis attribute to yes, CICS caches the program if there is room in theprogram cache. The Region Definitions (RD) ProgramCacheSizeattribute determines the cache size.

Defining a program cache can improve performance because aresident program is not loaded again until one of the followingoccurs: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 modifies static data.

This attribute is ignored for Micro Focus COBOL programs. Thedefault value is no.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “Program Definition”.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for the program,

represented by a number from 1 through 24. To enable a transactionto run the program, you must have the RSLKey value in theRSLKeyList attribute in your User Definitions (UD) entry; otherwise,CICS raises the NOTAUTH condition. Instead of a number, you canalso enter public or private for the value. With public, any user canaccess the program. With private, CICS allows access to the programonly from transactions that have the attribute RSLCheck=none intheir Transaction Definitions (TD) entry. The default value is private.

For further information about resource security, see the CICSAdministration Guide.

TemplateDefined (Is a user conversion template defined?)If this resource definition entry represents a program you can runfrom a remote non-ASCII CICS system using Distributed ProgramLink (DPL), and the program is passed a COMMAREA, you need toset up a conversion template for the COMMAREA. If such a templateexists, set this attribute to yes, if not, to no. The default value is no.

TransId (Transaction name on remote system for program)Specifies a transaction to attach on the server system when DPL isused. EXEC CICS LINK TRANSID overrides the value specified here.The default value is "". If the default value is taken, the CPMItransaction is used.

UserExitNumber (User Exit number)Required if the program is a user exit program. You supply thenumber of the user exit for which this program is to be invoked. Thisnumber is the last three digits of the user exit name. You can omit anyleading zeros in the number. For more details about user exit namingconventions, and for a table of user exit numbers, see “Chapter 6.User exits” on page 407. The default value is 0, meaning that this isnot a user exit program.

Region Definitions (RD)

The RD contains both static and dynamic information required by the CICSregion at startup; this is both control and initialization information.

This section lists a basic set of RD attributes. The remainder, which supply theinformation required by SFS startup, are listed in “Region Definitions (RD) forfile server” on page 54.

ABDump (Should CICS system be dumped for ASRB abends?)You can set the ABDump attribute to yes or no. It determineswhether a system dump or a transaction dump is taken if an ASRBabend occurs. IfABDump=yes, (SysDump=yes, and

TransDump=yesfor a transaction), a systems dump occurs. IfABDump=no (and TransDump=yes for the transaction), a transactiondump is taken. The default value is yes.

AllowDebugging (Allow use of the application debugging tool) (CICS forAIX only)

On CICS for AIX this attribute specifies whether or not the use of theapplication debugging tool is permitted. The possible values are no.The default value is no .

AuthenticationService (Userid authentication performed by DCE or CICS?)This attribute specifies whether authentication is performed by DCEor by CICS. The possible values are CICS . If the value is DCE a DCEauthentication 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 cleanup resources after a non-normal shutdown of a region, should log intoDCE automatically, using the password stored in/usr/local/systems/dce.cell_admin_pw. This enables it to clean upDCE 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) andno_netname_check. The old_style value matches the behavior ofearlier versions of CICS on Open Systems. no_netname_check allowsthe region to install terminals more quickly than the default butdisables all checks for the uniqueness of the netnames.

CARPDelayHours (ATI purge interval (hours))The value of this attribute controls how often, in hours, CICSschedules the transaction which deletes ATI requests that have beenqueued for more than the PurgeDelayPeriod orProtectPurgeDelayPeriod. The default value is 8.

CheckpointIntervalThis attribute controls the frequency with which CICS writescheckpoint information to the log. A small number means decreasedperformance but decreased recovery time following errors. A highnumber means the reverse. The number corresponds to the totalwrites made to each application server log file between checkpoints.The default value is 1000.

ClassMaxTasks (Maximum number of running transactions per class (10entries))

This attribute defines the maximum number of tasks that can be run,at any one time, in each of the ten defined transaction classes.

For a given class, when this number is reached, any new tasks arequeued, up to the limit specified 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 themaximum number of tasks for class 2, n3 is the maximum number oftasks for class 3, and so on. The parameters are positional, so tenvalues, separated by commas and without spaces, must be specified.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. Formore information see the CICS Administration Guide.

ClassMaxTaskLim (Purge threshold for transaction requests aboveClassMaxTasks)

This attribute defines the limit on the number of tasks in each of theten defined transaction classes. For a given class, the value specifiesthe point at which tasks are no longer queued by the region waitingfor 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 togetherbecause, if a transaction request is received for a class that hasreached its threshold, the request will be rejected.) A count will bekept of the number of times this limit is reached and this count willbe 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 limiton the number of tasks for class 2, n3 is the limit on the number oftasks for class 3, and so on. The parameters are positional, so tenvalues, separated by commas and without spaces, must be expressed.

The default value for all classes is 0, which means no limit.

ClassTableSize (Hash sizesCD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD, OD)

This attribute contains a comma-separated list of numbers that CICSuses to control the size of the internal tables holding the resourcedefinitions. The ordering of the list is as follows: CD, FD, PD, RD,TSD, WD, TD, TDD, XAD, UD, MD, JD, LD, GD, OD. You shouldalways set the number for RD and MD to 1, and you should set JD tothe maximum number of user journals that you expect your region tosupport. As a general rule, you should set the other numbers to twicethe number of entries that you expect in that resource class. You cantune the values in this attribute by using statistical information. Forfurther information about statistics, read the CICS AdministrationGuide. 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 underDumpName. CICS uses this directory to write core images to in theevent of a nonrecoverable CICS abnormal termination. DCE andEncina also use this directory if they produce a core dump. Thedefault value is dir1.

CUBSDelayMinutes (Rescheduling interval for blocked ATIs (mins))As part of the auto start process following a normal shutdown, CICSattempts to recover Interval Control Elements (ICEs). If TemporaryStorage (TS) is not available, the system cannot do this and so itmakes periodic checks of TS, and recovers ICEs as soon as it findsthat TS queues are available. CUBSDelayMinutes specifies thefrequency 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 theCommon Work Area (CWA). This area is initially set to binary zeros,and is available to all programs. The maximum size for the work areais 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 EXECCICS 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 identifier)This attribute is used to specify the default userid for the region. The

default userid is used for tasks that are not associated with asigned-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 backon.

For intersystem requests, the following attributes are used inconjunction with the DefaultUserId attribute:v The CD LinkUserId attribute, as well as the TSL and RSL keys

defined in the UD entry for the userid specified with this attribute.v The CD RemoteSysSecurity attribute.v The CD TSLKeyMask and RSLKeyMask attributes.

Read the CICS Intercommunication Guide for more information abouthow 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 auser who is signed on as the default user invokes a transaction.Also, because remote users can be given this default userid, it isadvised that you assign to it only the minimum required TSLand RSL keys for local users to run at the security level that isneeded when the default userid is used. See the CICSIntercommunication Guide for more information about howremote 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 thesubdirectories where CICS dumps are written. The default value isdumps.

CICS uses the available subdirectories in alphabetical order. Bydefault, all CICS dumps are written to dumps/dir1, becauseCoreDumpName defaults to “dir1”.

ECIPasswordCacheSeconds (Time DCE password is cached for use by ECIapplication (secs))

This attribute controls how long, in seconds, a password will becached for userids using the External Call Interface (ECI) (either froma CICS for Open Systems client, or from an IBM CICS Client). If thepassword received in the call matches the cached one, it is notchecked with DCE. This gives better performance. A high value forthis attribute means calls to DCE are less frequent, but also means

users can carry on using passwords that have been changed throughDCE. This attribute is used only if the region uses DCE as itsauthentication service. The default value is 28800, which is 8 hours. Avalue of 0 will prevent the password being cached at all.

ESMLoad (Do you want to use an External Security Manager?)If you set this flag to yes, CICS loads the ESM program at startup. Ifyou set this flag to no, CICS does not load the ESM program. Thedefault 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. Thedefault 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 attributeto specify whether or not CICS routes product trace to an externaltrace facility. The value can be yes or no, respectively. This is inaddition to the normal trace destinations used by CICS. The defaultvalue is no.

FileRSLCheck (Type of RSL checking for Files)This attribute indicates whether or not you require an ExternalSecurity Manager (ESM) instead of CICS-provided resource securityfor files. Enter internal or external to define the type of securitychecking required for files. If you require an ESM, you must also setRSLCheck=external in the required Transaction Definitions (TD)entries. If you require external security checking, the ESMLoad andESMModule attributes must be set to configure the ESM, otherwiseonly internal security checking occurs. The default value is external.

FileSystemType (Type of file system)This attribute specifies the type of the file system to be used for CICSqueues and files. The value must be either SFS or DB2. The defaultvalue is SFS.

Groups (Startup groups)This attribute contains a list of group names used to cold start theregion. The names are each up to eight-byte ASCII text attributes, andyou are allowed to enter a maximum of 10 groups. Enter the groupsas a comma-separated list. The default value is "" which results in alldatabase entries with a default group of "" being installed.

HTMLBrowser (HTML Browser for help text) (CICS for Windows NT only)This attribute specifies the fully qualified path name of the HTMLbrowser to be used to view the help files for the CICS-supplied

transactions when using a cicslterm terminal. The location of theHTML files is specified by the environment variableCICS_CST_HTML.

IntrospectInterval (Interval between region consistency checks (mins))CICS provides you with the ability to periodically monitor theintegrity of your region. You set this attribute to the time intervalbetween these checks. To switch off this integrity checking, you set thevalue to zero. Note that frequent integrity checking decreasesperformance. You can specify any value in the range 0 to 1440. Thedefault value is 10.

IntrospectLevel (Level of checking to perform on region)In this release of CICS, this attribute has a fixed value of minimal.

IIOPObjrefsVersionThe IIOP version level supported. The default is 1.1, which meansIIOP version 1.1. This level is required for SSL support. The only othersupported 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-specific) universal unique identifier (UUID). This field in theobject key is used to validate incoming IIOP requests. For objects thatare not configured for workload management, a check is made todetermine whether the UUID in the request matches the UUID of theserver. If the object is configured for workload management, thegroup UUIDs must match (the IIOP request can be handled by anyserver in the group). Set it to a suitable unique adminstration-definedname (for example, IIOPGroupUUID = Group1). The maximumlength 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, (forexample, IIOPGroupHost = group1.cics.site.crp.com), which isinserted into the IORs for workload-managed objects. The dynamicDNS resolves this group name to a specific server decimal address.

IIOPGroupPort (IIOP Server group TCP/IP port number)This parameter is the TCP/IP port number, which is inserted into theIORs for workload-managed objects (for example,IIOPGroupPort=9876). For a dynamic DNS configuration, this is thesame port number as defined for the CICS IIOP listener. All CICSIIOP servers in the same server group must therefore use the sameport 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 theIORs for objects that are SSL enabled and workload managed (for

example, IIOPGroupSSLPort=8765). If SSL support is required withworkload management, the IIOPGroupSSLPort must be set. Allservers in the group must have an IIOP SSL listener defined.

IIOPRequestTimeoutThe number of seconds to wait for an IIOP response before raising anerror. A value of 0 (zero) indicates an infinite wait. The default is 100.

ISCDelayMinutes (Retransmission interval for queued ATIs (mins))The value of this attribute controls how often, in minutes, CICSattempts to send Automatic Transaction Initiation (ATI) requests, thathave been locally queued due to the unavailability of the targetsystem, 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 ofCICS-provided resource security for journals. Enter internal orexternal to define the type of security checking required for journals.If you require an ESM, you must also set RSLCheck=external in therequired TD entries. If you require external security checking, theESMLoad and ESMModule attributes must be set to configure theESM, otherwise only internal security checking occurs. The defaultvalue is external.

LoadDataNumBuckets (Number of LOADed data Address Hash Buckets)This attribute controls access to maps and tables. CICS rounds up thevalue that you specify here, to the nearest power of two, with aminimum value of 1. The attribute controls the size of the hash tableused by CICS to find maps and tables in the task-shared pool, and thevalue you supply depends on the expected usage of your region. Youtrade off performance and storage size with this attribute. You cantune the value of this attribute by using statistical information. Forfurther information about statistics, read the CICS AdministrationGuide. The default value is 512.

LocalLUName (Local LU name)This is the default SNA Logical Unit (LU) name for your region. It isused as the local LU name for your region with local SNA support. Itis also used as the local LU name for your region with SNA supportvia a PPC gateway if the Gateway Definitions (GD) entry for the PPCgateway has a null (″″) GatewayLUName attribute.

The LU name should be no more than eight characters long. The firstcharacter must be an upper case alphabetic character (A-Z) and thesubsequent characters must be either upper case alphabetic charactersor numeric (0-9). For example, the following values are valid for thelocal LU name:

″A″

″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 regionname. 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 localregion is attached. It is up to eight ASCII characters long. The defaultvalue is "".

LocalQProtection (Min protect level for locally queued ATIs)If an SFS server is used, this attribute controls the authentication levelused for Remote Procedure Calls between the CICS region and theStructured 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) anddefault. This attribute must be set to a value that is the same as, orgreater than, the ProtectionLevel set in the SSD for the SFS specifiedin 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 DCEauthentication. The value default is the default DCE protection level.For more information about protection levels, see the DCEdocumentation. Be aware that the higher the protection level, themore time is required to authenticate, and this may affectperformance. The default value is none.

LocalQProtectProtection (Min protect level for locally queued PROTECTATIs) If an SFS server is used, this attribute controls the authentication level

used for Remote Procedure Calls between the CICS region and theStructured 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) anddefault. This attribute must be set to a value that is the same as, orgreater than, the ProtectionLevel set in the SSD for the SFS specifiedin 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 DCEauthentication. 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 isrequired to authenticate, and this may affect performance. The defaultvalue is none.

LocalSysId (Region system identifier (short name))This attribute contains the short name of the CICS region (as used inthe SYSID option of several CICS commands). It is up to four ASCIIcharacters long with characters from the set A-Z, 0-9, dollar ($) and atsign (@). Lower case alphabetic characters will be converted to uppercase characters. The default value is ISC0.

LogicalTDQProtection (Min protect level for logical TDQs)If an SFS server is used, this attribute controls the authentication levelused for Remote Procedure Calls between the region and the SFSwhen dealing with logically recoverable TDQs. The possible settingsare none, connect, call, pkt, pkt_integ, pkt_privacy (only if you haveinstalled DCE privacy support) and default. This attribute must be setto a value that is the same as, or greater than, the ProtectionLevel setin the SSD for the SFS specified in the DefaultFileServer attribute inthe RD for SFS.

MaxConsoleSize (Maximum Console Size)MaxConsoleSize controls the size of the console.nnnnnn and thesymrecs.nnnnnn files. nnnnnn is a number that is incremented everytime a new console file is opened. A new console.nnnnnn file iswritten when a new CICS region is started or when the limit set inMaxConsoleSize has been reached.

If you set MaxConsoleSize to zero, the console.nnnnnn and symrecsfiles continue to grow within the space allowed by your system. Youshould set MaxConsoleSize to a size greater than 100000 (10 KB). Ifyou set it to be less than this, then during system initialization thevalue is automatically reset to 100000. When the upper limit isreached, two messages are issued, one explaining that the file is aboutto be closed and the second gives the name of the new file. It is

possible to ’tail’ the console file using the cicstail command. When thefile changes cicstail switches to the new file.

For automatic archiving, a program can from time to time check thecontents of the console files and look for the message at the endindicating that the file 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 storagearea used by CICS to hold CICS-private region information. The valuedepends on the number of resources in your region, the volatility ofthese resources, and the level of transactional activity. For example,the default value of 2097152 is enough to start a region with twoapplication servers.

To estimate an appropriate value, allow 1000 KB plus 50 KB for eachapplication server (set in MaxServer). For example, if MaxServer isset to 5, the calculation is 1000 KB + (50 KB * 5) = 1250 KB. If youare running FEPI, add 500 KB to this figure. Check the statistics forregion pool size. If the region pool size setting is close to the defaultsetting, consider increasing the value for MaxRegionPool. Theminimum value is 262144, the maximum value is 268435456, and thedefault 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 warningmessage is added to the console.nnnnnn when a task’s CPU usageexceeds the value of MaxTaskCPU. When set to abend, the taskabends when its CPU usage exceeds the value of MaxTaskCPU. Thedefault is warning.

MaxTaskCPU (CICS on Open Systems)Sets the maximum time (in milliseconds) allowed for CPU use by allthe transactions of a region. You can override this value for anindividual transaction by setting the MaxTaskCPU attribute in theTransaction Definitions. If you set the value to 0, there is noregion-wide control of CPU usage. You can override this if theMaxTaskCPU attribute for a particular transaction is defined in theTransaction Definitions. If the value is greater than zero, checks aremade each time the transaction enters CICS through an EXEC CICScall command. The maximum value is 2**31 —1 (approximately 24days 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 serversthat CICS uses to process transactions. The CICS Application

Programming Guide describes how to use MinServer and MaxServer torun CICS efficiently. The default value is 5.

MaxTaskPrivatePool (Task-private Storage Size in bytes)This attribute controls the amount of memory allocated for eachprocess’s task-private pool. The value depends on the sizes of EXECCICS GETMAIN areas and CICS transaction programs. To maximizeperformance, storage areas are aligned on appropriate boundaries,which can lead to more storage being allocated than used. Whencalculating this value, allow for this additional storage. The minimumvalue is 307200, the maximum value is 268435456, and the defaultvalue is 1048576.

MaxTSHPool (Task-Shared Pool Storage Size in bytes)This attribute controls the size of the task-shared pool. This is astorage area used by CICS to hold information needed by two ormore tasks, whether running in CICS code or in the user programs.

The storage from this area is used for:v COMMAREAsv Common Work Area (CWA)v Terminal Input/Output Areas (TIOAs)v TCT User Areas (TCTUAs)v Main temporary storagev Maps and tablesv Conversion templatesv Temporary storage for unprotected STARTs

The value depends on the size of CICS-provided shared areas such asthe Terminal Control Table User Areas (TCTUAs), the size of EXECCICS GETMAIN SHARED areas, the number of MAIN temporarystorage requests, and the volatility and levels of Basic MappingSupport (BMS) requests. See the CICS Application Programming Guidefor information about efficiency. The minimum value is 32768, themaximum 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 serversthat CICS uses to process transactions. The CICS ApplicationProgramming Guidedescribes how you can use MinServer andMaxServer to run CICS efficiently. The default value is 1.

Modifiable (Protect resource from modification?)This attribute specifies whether or not CICS permits you to amend ordelete 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 Modifiable=no by first setting Modifiable to yes. If you doamend the entry, you should set Modifiable back to no afterwards.The default value is no.

NameService (Use DCE Name Service (CDS) to locate CICS and Encinaservers?)

This attribute can be set to NONE to determine whether or not theDCE Name Service is to be used for name resolution. If the value isset to DCE, any SFS or PPC Gateway definition that is used must alsohave 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 levelused for Remote Procedure Calls between the CICS region and theStructured File Server when dealing with nonrecoverable TDQs. Thepossible settings are none, connect, call, pkt, pkt_integ, pkt_privacy(only if you have installed DCE privacy support) and default. Thisattribute must be set to a value that is the same as, or greater than,the ProtectionLevel set in the SSD for the SFS specified in theDefaultFileServer attribute in the RD for SFS.

NonRecTSQProtection (Min protect level for nonrecoverable TSQs)If an SFS server is used, this attribute controls the authentication levelused for Remote Procedure Calls between the CICS region and theStructured File Server when dealing with nonrecoverable TSQs. Thepossible settings are none, connect, call, pkt, pkt_integ, pkt_privacy(only if you have installed DCE privacy support) and default. Thisattribute must be set to a value that is the same as, or greater than,the ProtectionLevel set in the SSD for the SFS specified in theDefaultFileServer attribute in the RD for SFS.

PCDump (Should CICS system be dumped for ASRA abends?)You can set the PCDump flag to yes or no. It determines whether a

system dump or a transaction dump is taken if an ASRA abendoccurs. IfPCDump=yes, (SysDump=yes, and TransDump=yesfor atransaction), a systems dump occurs. If PCDump=no (andTransDump=yes for the transaction), a transaction dump is taken. Thedefault value is yes.

PhysicalTDQProtection (Min protect level for physical TDQs)If an SFS server is used, this attribute controls the authentication levelused for Remote Procedure Calls between the CICS region and theStructured File Server when dealing with physically recoverableTDQs. The possible settings are none, connect, call, pkt, pkt_integ,pkt_privacy (only if you have installed DCE privacy support) anddefault. This attribute must be set to a value that is the same as, orgreater than, the ProtectionLevel set in the SSD for the SFS specifiedin the DefaultFileServer attribute in the RD for SFS.

PostScanInterval (Timer that controls how frequently a search is initiatedfor completed WAIT EVENTs)

This attribute specifies the interval in seconds that CICS waitsbetween initiating scans to locate a completed WAIT EVENT. Thedefault 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 thatcan be cached)

This attribute specifies the maximum number of C or IBM COBOLprograms that can reside in one application server’s program cache. Aprogram is cached only if, when loading the program, the ProgramDefinitions (PD) Resident attribute is set to yes and the number ofcached programs in use has not reached the maximum number.

Defining a program cache can improve performance because aresident program will not be loaded again until one of the followingoccurs: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.

Because programs that are being used are not removed from thecache, it is recommended that the cache size should allow programs atevery 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 insteadof CICS-provided resource security for programs. Enter internal orexternal to define the type of security checking required for programs.If you require an ESM, you must also set RSLCheck=external in therequired TD entries. If you require external security checking, theESMLoad and ESMModule attributes must be set to configure theESM, otherwise only internal security checking occurs. The defaultvalue is external.

ProtectPurgeDelayPeriod (Purge delay period for PROTECT requests(hours))

The value of this attribute controls the aging period, in hours, forlocally queued ATI sends with the PROTECT option specified. Specify0 to indicate that you do not wish CICS to perform this purgefunction. The default value is 8.

PublicUserTraceFile (User Trace file or path for guest logins)You set this ASCII text attribute to the name of the user trace filewhere CICS places trace information for programs that use user tracebut run without a user identifier. 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, forlocally queued ATI sends without the PROTECT option. Specify 0 toindicate 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 configured for DB2 this attribute specifies the name ofthe instance of DB2 and is used to set the DB2 environment variableDB2INSTANCE. It is reset to the value of the -i parameter wheneverthe 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 levelused for Remote Procedure Calls between the CICS region and theStructured File Server when dealing with recoverable TSQs. Thepossible settings are none, connect, call, pkt, pkt_integ, pkt_privacy(only if you have installed DCE privacy support) and default. Thisattribute must be set to a value that is the same as, or greater than,

the ProtectionLevel set in the SSD for the SFS specified in theDefaultFileServer attribute in the RD.

RegionPoolBase (Region Pool base register) (CICS for AIX and CICS forWindows NT only)

This attribute specifies the address at which CICS should attach thesegment it uses for its region pool.

You may need to change this value if, in addition to CICS, you arerunning a utility or an application (such as a database) that also usesshared memory. By changing the value of this attribute, you canensure that the CICS shared memory segments do not overlap withthose of your application.

If you use the cicsupdate command to change this value, you canspecify it in either hexadecimal notation (for example, 0x70000000) ordecimal notation (for example, 1879048192). If you use SMIT (CICS forAIX only) to change this value, enter it in decimal notation.

On CICS for AIX, the value of the RegionPoolBase attribute must bewithin the range 0x30000000 to 0xC0000000, and must be a multiple of0x10000000. The default value is 0xA0000000.

On CICS for Windows NT, the value of the RegionPoolBase attributemust be less than 0x80000000. The size of the region pool is given bythe MaxRegionPool attribute. The area of memory defined by thesetwo attributes must not overlap with areas of any Dynamic LinkLibraries (DLLs) already loaded. If it does, you must change theRegionPoolBase value to an area of memory not in use. The defaultvalue is 0x70000000.

Do not specify the same value for this attribute as for theTaskSharedPoolBase attribute.

RegionPoolThreshold (Threshold for Region Pool short on storage (%age))You set this attribute to a percentage. When this percentage of theregion pool is exceeded, CICS generates a warning message. Thedefault value is 90.

ReleaseNum (CICS Release Number)This four-byte attribute holds the current CICS release number. It is inthe format XXXX, where the first byte is a zero. This attribute is

provided for information purposes only. If you try to change theattribute by using an editor program or cicsupdate, the change isignored at region startup.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The first 17characters of this text value are used in the “Available CICS Regions”panel when you run cicsterm (CICS for Windows NT) or cicsteldwithout a region name. Specifying this value allows you to give thispanel more meaning, otherwise, the default value, “RegionDefinition” is used.

RPCListenerThreads (Number of threads for RPC requests)This attribute specifies the number of threads used to listen fortransaction and autoinstall requests, from terminals and from CICSEPI applications, by the RPC listener process cicsrl. An RPC listenerthread is generally occupied by a request for the time it takes tocomplete a transaction or autoinstall. For further information on howthis attribute can affect performance, see the CICS AdministrationGuide. The default value is 0 and the actual number of RPC listenerthreads is calculated as ten times the value of the MaxServer attribute.

RuntimeProtection (Min protect level used when accepting RPCs)This attribute specifies the minimum level of Remote Procedure Call(RPC) protection which is requested by the CICS control process whensending an RPC. Possible values are none, connect, call, pkt,pkt_integ, pkt_privacy (only if you have installed DCE privacysupport) and default.

none means that DCE makes no attempt to authenticate the RPCs.connect, call, pkt and pkt_integ represent increasing levels of DCEauthentication. The value default is the default DCE protection level.For more information about protection levels, see the DCEdocumentation. Be aware that the higher the protection level, themore time is required to authenticate, and this may affectperformance. For communication over links whose CommunicationsDefinitions (CD) has a ConnectionType of ppc-tcp, settings of connectand call are treated as pkt.

Note: In order to implement the authentication of RPC requests, allCICS on Open Systems connected to your region must be at alevel of CICS that provides this ability. If any of these systemsdo not have the RuntimeProtection attribute included in theRegion Definitions (RD), then those that do must have thisattribute set to none.

The default value is none.

SafetyLevel (Level of protection against user corruption)This attribute defines the degree of protection that CICS provides forprograms 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 setSafetyLevel to normal, on all operating systems except Solaris, onlyCICS transactions can access the region pool. (On CICS for Solarissystems, the SafetyLevel setting is ignored entirely, and usertransactions can always access the region pool.) The guard setting isprovided specifically for use on the Windows NT operating system.On the Windows NT operating system, the normal SafetyLevelsetting incurs significant performance costs. To lessen theseperformance costs, set SafetyLevel to guard. In this case, only the firstand last pages of the region pool are protected. On CICS for AIX andCICS for HP-UX systems, the guard setting is treated the same as thenormal setting. The default value is none.

ServerIdleLimit (Time before Application Servers terminate (secs))This attribute defines the time, in seconds, that idle applicationservers are allowed to exist before CICS terminates them. CICS alwaysensures that there are MinServer servers available at all times. Thedefault value is 3600.

ServerSideTran (Server side transactions only ?)This attribute can only be set to yes to indicate that the CICS systemwill be used for communicating with a single Encina SFS system. Ifthe value is yes, the only intersystem communication that issupported is transaction routing; communication using XA may beslowed, or may cause errors. A message is issued at CICS startupindicating whether or not server-side transaction support is beingused. 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 10programs which CICS runs automatically during the first stage of thetwo-stage CICS shutdown process. Each program must have an entryin the Program Definitions (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 10programs which CICS runs automatically during the second stage ofthe two-stage CICS shutdown process. Each program must have anentry in the Program Definitions (PD). The default value is "".

StartType (Startup type)This attribute determines the type of CICS system initialization thatyou require. If the startup is cold, CICS performs a cold start. If thestartup is auto, CICS uses the restart information written by the

previous run of CICS to restart the region from the state in which itwas last shut down. If no restart information exists, CICS performs acold start. You can override this value only by explicitly stating itwhen using the startsrc command (on CICS for AIX) or the cicsstartcommand (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 10programs which CICS runs automatically during CICS startup. Eachprogram must have an entry in the Program Definitions (PD).

Note: Resource security checking is not performed during startupprogram 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 filewhere CICS is to write statistical information. The default value isstatsfile.

StatsRecord (Should stats be recorded at every interval?)Set this flag to yes or no to indicate whether CICS is to collectstatistical information every interval. For further information aboutstatistics, read the CICS Administration Guide. The default value is yes.

SufficesSupported (Should map names be suffixed?)This flag indicates whether CICS uses terminal suffixing. You set thisflag to yes or no. If you set the flag to yes, CICS uses terminalsuffixing. The default value is yes.

SysDump (System dump on shutdown, SNAP dumps, ASRx abends?)You can set the global SysDump flag to yes or no to indicate whetheror not CICS records system dump information if an abnormaltermination occurs. This flag also determines whether or not CICSproduces a dump at shutdown. In addition, for transaction abnormalterminations ASRA and ASRB, if SysDump=yes, then a system dumpmay also occur as explained under PCDump and ABDump. Thedefault value is no.

SysTraceBufferSize (System trace buffer size)You set this attribute to the size, in bytes, of the buffer that is used formain memory tracing. When system trace is in effect, CICS writes allsystem trace entries to the main memory buffer. When the buffer isfull, CICS starts again at the beginning of the buffer and overwritesthe previous entries. The minimum acceptable size of this buffer is16384 bytes. The default value is 163840.

TaskSharedPoolBase (Task-Shared Pool base register) (CICS for AIX andCICS for Windows NT only)

This attribute specifies the address at which CICS should attach thesegment it uses for its task-shared memory pool.

You may need to change this value if, in addition to CICS, you arerunning a utility or an application (such as a database) that also usesshared memory. By changing the value of this attribute, you canensure that the CICS shared memory segments do not overlap withthose of your application.

If you use the cicsupdate command to change this value, you canspecify it in either hexadecimal notation (for example, 0x70000000) ordecimal notation (for example, 1879048192). If you use SMIT (CICS forAIX only) to change this attribute, enter the value in decimal notation.

On CICS for AIX, the value of the TaskSharedPoolBase attribute mustbe within the range 0x30000000 to 0xC0000000, and must be amultiple of 0x10000000. The default value is 0xB0000000.

On CICS for Windows NT, the value of the TaskSharedPoolBaseattribute must be less than 0x80000000. The size of the task-sharedpool is given by the MaxTSHPool attribute. The area of memorydefined by these two attributes must not overlap with areas of anyDynamic Loaded Libraries (DLLs) already loaded. If it does, you mustchange the TaskSharedPoolBase value to an area of memory not inuse. The default value is 0x79C00000.

Do not specify the same value for this attribute as for theRegionPoolBase attribute.

TaskSHNumBuckets (Number of Task Shared Pool Address Hash Buckets)This attribute controls access to the task-shared pool. CICS rounds upthe value that you specify here, to the nearest power of two, with aminimum value of 512. The attribute controls the size of the hashtable used by CICS to find items in this pool, and the value yousupply depends on the expected usage of your region. You trade offperformance and storage size with this attribute. You can tune thevalue of this attribute by using statistical information. For furtherinformation about statistics, read the CICS Administration Guide. Thedefault value is 512.

TaskShPoolThreshold (Threshold for TSH Pool short on storage (%age))You set this attribute to percentage. When this percentage of the taskshared pool is exceeded, CICS generates a warning message. Thedefault value is 90.

TDPurgeInterval (Interval for purges of read records in the transient dataqueues)

You can control the frequency of purges to the transient data queues

by assigning a value to this attribute. This value indicates a timeinterval in minutes controlling how frequently the private transactionCTDP is activated. If the TDPurgeInterval attribute value is set tozero, then the CTDP transaction runs at startup and every midnight. Ifthe TDPurgeInterval attribute value is set to any value other thanzero, the CTDP transaction runs at startup and at everyTDPurgeInterval minutes.

TemporaryStorageRSLCheck (Type of RSL checking for TSQs)This attribute indicates whether or not you require an ESM instead ofCICS-provided resource security for TS queues. Enter internal orexternal to define the type of security checking required for TSqueues. If you require an ESM, you must also set RSLCheck=externalin the required TD entries. If you require external security checking,the ESMLoad and ESMModule attributes must be set to configure theESM, otherwise only internal security checking occurs. The defaultvalue is external.

Trace (Modules to trace)You set this attribute to determine whether all, some, or none of theCICS modules produce trace when the product trace is switched on.You set the value to all, partial, or none, respectively. If you specifypartial, you must also set the TraceModules attribute. If you specifyall or none, the TraceModules attribute value is ignored. The defaultvalue is all.

TraceFileA (File or path (A) for system trace)You set this ASCII text attribute to the name of the first of the twofiles into which CICS writes system trace information. CEMT allowsyou to switch this file 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 twofiles into which CICS writes system trace information. CEMT allowsyou to switch this file to TraceFileA. The default value is trace.b.

TraceFileSize (Maximum system trace file size)You set this attribute to the maximum size, in bytes, of the trace filesthat CICS writes system trace entries to. The names of the files arespecified by the attributes TraceFileA and TraceFileB. The minimumacceptable size for these files is ten times the size of the main memorybuffer, whose size is specified by the SysTraceBufferSize attribute.The default value is 3276800.

TraceModules (Module list for partial trace)You set this attribute to the module identifiers of one or more CICSmodules that you want to produce trace when trace is switched on.See the CICS Problem Determination Guide for a list of modules and

their identifiers. Separate each module identified by a comma. This listof module identifiers is used only if the Trace attribute is set topartial. The default value is 0.

TransactionRSLCheck (Type of RSL checking for Transactions)This attribute indicates whether or not you require an ESM instead ofCICS-provided resource security for transactions. Enter internal orexternal to define the type of security checking required fortransactions. If you require an ESM, you must also setRSLCheck=external in the required TD entries. If you require externalsecurity checking, the ESMLoad and ESMModule attributes must beset to configure the ESM, otherwise only internal security checkingoccurs. 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 ofCICS-provided resource security for transient data queues. Enterinternal or external to define the type of security checking requiredfor transient data queues. If you require an ESM, you must also setRSLCheck=external in the required TD entries. If you require externalsecurity checking, the ESMLoad and ESMModule attributes must beset to configure the ESM, otherwise only internal security checkingoccurs. The default value is external.

TransDumpTrace (Transaction Dump Trace)This attribute implies that the contents of the main trace buffers willbe included in the output of the transaction dumps produced by theregion. 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 and512, or a value of 0. CICS purges any TS queues that have not beenaccessed for a period longer than this value. Specify 0 to indicate thatyou do not wish CICS to perform this purge function. The defaultvalue is 20.

UserTraceDirectory (User trace directory)You set this ASCII text attribute to the name of the directory underwhich 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 specifies the interval in seconds that CICS waits beforetiming out ComSU_XPRecv calls. It can be set from 0 (zero) to thevalue specified in the INT_MAX constant. (The value of INT_MAX issystem-dependent. For 32-bit systems, the value is 2147483647seconds.) The default value is 0 (zero), meaning that the region waitsfor callback indefinitely.

Note: Do not change this setting unless you are using IBM CICSClients on any platform in an earlier version than 2.0.2, and areexperiencing CICS application server (cicsas) processes hangingas a result of a remote transaction abending. Setting this valueto greater than 0 (zero) seconds can cause transactions that runfor long periods of time (such as CEMT) to time out beforecompleting.

Region Definitions (RD) for file server

The RD contains both static and dynamic information required for the startupof an SFS or DB2 file server; this is both control and initialization information.

This information provides a partial list of the Region Definitions (RD)attributes. The remaining attributes are listed in “Region Definitions (RD)” onpage 32.

DefaultFileServer (SFS server or database storing CICS Queue Data)This attribute specifies the name of the Structured File Server or theDB2 database that is used to store CICS queue data. The default valueis “/.:/cics/sfs/%H”.

LocalQFile (SFS file for Locally-Queued Unprotected STARTs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicsnlqfile”.

LocalQIndex (SFS Index for Locally-Queued Unprotected STARTs)This attribute is the name of the file index within theDefaultFileServer. 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 beheld in LocalQFile. This attribute applies to SFS files only. The defaultvalue is 1000000.

LocalQPrePages (Number of pages to preallocate for LocalQFile)You set this attribute to the number of pages preallocated fromLocalQVol for the storage of LocalQFile. This attribute applies to SFSfiles only. The default value is 5.

LocalQProtectFile (SFS file for Locally-Queued Protected STARTs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicsplqfile”.

LocalQProtectIndex (SFS Index for Locally-Queued Protected STARTs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicsplqidx”.

LocalQProtectMaxRecs (Maximum number of records for Locally-QueuedProtected STARTs)

You set this attribute to the maximum number of records that can beheld in LocalQProtectFile. This attribute applies to SFS files only. Thedefault value is 1000000.

LocalQProtectPrePages (Number of pages to preallocate forLocalQProtectFile)

You set this attribute to the number of pages preallocated fromLocalQProtectVol for the storage of LocalQProtectFile. This attributeapplies to SFS files 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 tohold the local queue of ATI requests with the PROTECT optionspecified. 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 tohold the local queue of ATI requests without the PROTECT optionspecified. The default value is “sfs_%S”.

LogicalTDQFile (SFS file storing Logically Recoverable TDQs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicstdqlgfile”.

LogicalTDQIndex (SFS Index for Logically Recoverable TDQs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicstdqlgidx”.

LogicalTDQMaxRecs (Maximum number of records for LogicallyRecoverable TDQs)

You set this attribute to the maximum number of records that can beheld in LogicalTDQFile. This attribute applies to SFS files only. Thedefault value is 1000000.

LogicalTDQPrePages (Number of pages to preallocate for LogicalTDQFile)You set this attribute to the number of pages preallocated fromLogicalTDQVol for the storage of LogicalTDQFile. This attributeapplies to SFS files 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 thatis to contain logically-recoverable transient data queues. The defaultvalue is “sfs_%S”.

NonRecTDQFile (SFS file storing Non-Recoverable TDQs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicstdqnofile”.

NonRecTDQIndex (SFS Index for Non-Recoverable TDQs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicstdqnoidx”.

NonRecTDQMaxRecs (Maximum number of records for NonrecoverableTDQs)

You set this attribute to the maximum number of records that can beheld in NonRecTDQFile. This attribute applies to SFS files only. Thedefault value is 1000000.

NonRecTDQPrePages (Number of pages to preallocate for NonRecTDQFile)You set this attribute to the number of pages preallocated fromNonRecTDQVol for the storage of NonRecTDQFile. This attributeapplies to SFS files 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 tocontain nonrecoverable transient data queues. The default value is“sfs_%S”.

NonRecTSQFile (SFS file storing Non-Recoverable Auxiliary TSQs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicsnrectsqfil”.

NonRecTSQIndex (SFS Index for Non-Recoverable Auxiliary TSQs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicsnrectsqidx”.

NonRecTSQMaxRecs (Maximum number of records for NonrecoverableTSQs)

You set this attribute to the maximum number of records that can beheld in NonRecTSQFile. This attribute applies to SFS files only. Thedefault value is 1000000.

NonRecTSQPrePages (Number of pages to preallocate for NonRecTSQFile)You set this attribute to the number of pages preallocated fromNonRecTSQVol for the storage of NonRecTSQFile. This attributeapplies to SFS files 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 tocontain nonrecoverable temporary storage queues. The default valueis “sfs_%S”.

PhysicalTDQFile (SFS file storing Physically Recoverable TDQs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicstdqphfile”.

PhysicalTDQIndex (SFS Index for Physically Recoverable TDQs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicstdqphidx”.

PhysicalTDQMaxRecs (Maximum number of records for PhysicallyRecoverable TDQs)

You set this attribute to the maximum number of records that can beheld in PhysicalTDQFile. This attribute applies to SFS files only. Thedefault value is 1000000.

PhysicalTDQPrePages (Number of pages to preallocate forPhysicalTDQFile)

You set this attribute to the number of pages preallocated fromPhysicalTDQVol for the storage of PhysicalTDQFile. This attributeapplies to SFS files 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 tocontain physically-recoverable transient data queues. The defaultvalue is “sfs_%S”.

RecTSQFile (SFS file storing Recoverable Auxiliary TSQs)This attribute is the name of the file within the DefaultFileServer. Thedefault value is “%Rcicsrectsqfile”.

RecTSQIndex (SFS Index for Recoverable Auxiliary TSQs)This attribute is the name of the file index within theDefaultFileServer. The default value is “cicsrectsqidx”.

RecTSQMaxRecs (Maximum number of records for Recoverable AuxiliaryTSQs)

You set this attribute to the maximum number of records that can beheld in RecTSQFile. This attribute applies to SFS files only. Thedefault value is 1000000.

RecTSQPrePages (Number of pages to preallocate for RecTSQFile)You set this attribute to the number of pages preallocated fromRecTSQVol for the storage of RecTSQFile. This attribute applies toSFS files 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 tocontain recoverable temporary storage queues. The default value is“sfs_%S”.

Schema File Definitions (SCD)

The Schema File Definitions (SCD) hold the details about the files and indexesof an SFS or DB2 table. There is no restriction on the number and location ofschema files, and a schema file is independent of the server, so that you canuse a schema file to build files and indexes on any server.

<Key> This represents the SFS file name or DB2 table.

FieldLength1 (Field 1 - Length)This attribute specifies the length of a field if it is a text field. You canspecify the lengths of up to twenty fields. The default value is 0.

FieldLength20 (Field 20 - Length)This attribute specifies the length of the twentieth field if it is a textfield. The default value is 0.

FieldName1 (Field 1 - Name)This ASCII text attribute specifies the name of a field in the file. Youcan specify up to twenty fields. You do not have to set up the detailsof every logical field to define it to CICS, but you must enter enoughfields to define the record length and keys. If the file has more thantwenty fields, you must use the Encina command sfsadmin export fileto export it from the SFS. The default value is ''.

FieldName20 (Field 20 - Name)This ASCII text attribute specifies the name of the twentieth field inthe file. The default value is ''.

FieldType1 (Field 1 - Type)This attribute specifies the type of a field, for example unsignedInt16.For further information on field types, refer to the EncinaAdministration Guide Volume 2: Server Administration. You can specifythe types of up to twenty fields. The default value is none.

FieldType20 (Field 20 - Type)This attribute specifies the type of the twentieth field, for exampleunsignedInt16. The default value is none.

FileType (CICS File Type)This attribute specifies what type of SFS file or DB2 database theschema file is. The file type can be clustered (KSDS), relative (RRDS),or sequential (ESDS). If the file type is not one of these recordstructures, you must use the Encina command sfsadmin export file toexport it from the SFS. For further information on file types, refer tothe Encina Administration Guide Volume 2: Server Administration. Thedefault value is clustered.

IndexFieldDescenders1 (Secondary Index 1 - Descending Fields)This ASCII text attribute specifies the list of field names in an indexthat are sorted in descending order. You can specify this attribute forup to ten secondary indexes. The default value is ''.

IndexFieldDescenders10 (Secondary Index 10 - Descending Fields)This ASCII text attribute specifies the list of field names in the tenthindex that are sorted in descending order. The default value is ''.

IndexFieldNames1 (Secondary Index 1 - Field Names)This ASCII text attribute specifies the list of field names comprising anindex. 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 specifies the list of field names comprisingthe tenth index. The default value is ''.

IndexName1 (Secondary Index 1 - Name)This ASCII text attribute specifies the name of a secondary index onthis file. You can specify up to ten secondary indexes. If the file hasmore than ten secondary indexes, you must use the Encina commandsfsadmin export file to export it from the SFS. The default value is ''.

IndexName10 (Secondary Index 10 - Name)This ASCII text attribute specifies the name of the tenth secondaryindex on this file. The default value is ''.

IndexPreallocatePages1 (SFS ONLY: Secondary Index 1 - Preallocated Pages)This attribute specifies the number of pages to be preallocated for asecondary index. You can specify the preallocated pages for up to tensecondary indexes. The default value is 20.

IndexPreallocatePages10 (SFS ONLY: Secondary Index 10 - PreallocatedPages) This attribute specifies 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 specifies whether or not a secondary index is unique.You can specify this attribute for up to ten secondary indexes. Thedefault value is yes.

IndexUnique10 (Secondary Index 10 - Is it Unique?)This attribute specifies whether or not the tenth secondary index isunique. The default value is yes.

IndexVolumeName1 (SFS ONLY: Secondary Index 1 - Volume Name)This ASCII text attribute specifies the volume that a secondary indexis, was, or will be stored on. You can specify the volume name for upto ten secondary indexes. The default value is ''.

IndexVolumeName10 (SFS ONLY: Secondary Index 10 - Volume Name)This ASCII text attribute specifies the volume that the tenth secondaryindex is, was, or will be stored on. The default value is ''.

MaxRecords (SFS ONLY: Maximum Number of Records)This attribute specifies the maximum number of records for this file.The default value is 10000.

PreallocatePages (SFS ONLY: Number of Pages to Preallocate)This attribute specifies the number of pages to preallocate for this file.The default value is 100.

PrimaryIndexDescenders (Descending Field Names for Primary Index)This ASCII text attribute specifies the list of field names in theprimary index that are sorted in descending order. The default valueis ''.

PrimaryIndexFields (Field Names for Primary Index)This ASCII text attribute specifies the list of field names that makes upthe primary index. The default value is ''.

PrimaryIndexName (Primary Index Name)This attribute specifies the primary index name. The default value is ''.

PrimaryIndexUnique (Is Primary Index Unique?)This attribute specifies 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 defaultvalue is “SFS Schema File”.

VariableFieldLength (Variable Field - Length)This attribute specifies the maximum length of the one variable field.The default value is 0.

VariableFieldName (Variable Field - Name)This ASCII text attribute specifies the name of the one variable field.The default value is ''.

VariableFieldType (Variable Field - Type)This attribute specifies the type of the one variable field. Valid valuesare none, varLenByteArray, or shortVarLenByteArray. For furtherinformation, refer to the Encina Administration Guide Volume 2: ServerAdministration. The default value is none.

VolumeName (SFS ONLY: Volume Name)This ASCII text attribute specifies the name of the Encina volume. Theuserid that the SFS runs under must have read and write access tothis volume and its raw device. The default value is “sfs_%S”.

Structured File Server Definitions (SSD)

The SSD contain both static and dynamic information required by the SFS atstartup. 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 /.:/ prefix, so that they can behandled by SMIT on CICS for AIX and by SAM on CICS for HP-UX.

BufferPoolSize (Buffer pool size in KB)The SFS internal buffer pool size. The equivalent Encina sfs commandoption is -b. The default value is 1000.

Checkpoint (Number of Log writes per checkpoint interval)This attribute controls the frequency with which SFS writescheckpoint information to the SFS log file. A small number meansdecreased performance but decreased recovery time following errors.A high number means the reverse. The number corresponds to thetotal log writes made to the log file between checkpoints. Theequivalent 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. Theequivalent Encina sfs command option is -c. The default value is “C”.

DataVolume (logical volume for data)This attribute specifies the operating system logical volume that theSFS keeps its file data in. You must always specify an existing logicalvolume. The default value is “sfs_%S”.

IdleTimeout (Idle timeout)The time, in seconds, after which any locks held by an SFS open filedescriptor (OFD) can be overridden. The equivalent Encina sfscommand option is -d. The default value is 300.

LogFile (Log File Name)This attribute specifies the name of the file in which SFS keeps its logdata. It will be created on the logical volume specified by LogVolume.The default value is “logfile”.

LogVolume (logical volume for logging)This attribute specifies the logical volume name on which SFS keeps

its log file data. You must specify a logical volume that you havealready created. The default value is “log_%S”.

MRAArchivingEnabled (Enable MRA Archiving?)This attribute specifies whether MRA archiving is turned on (yes) oroff (no). If yes then, when the SFS runs short of space for writingrecords into the permanent volume on which the log file resides, itmoves older log records for media recovery out of the permanentvolume into one or more archive volumes. If no, the media archivefiles are not generated and any existing media archive files aredestroyed. 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 MRAarchiving, you must switch this value from no to yes, shut down theSFS, and then cold start the SFS.

See the CICS Administration Guide for more details about enabling anddisabling MRA archiving.

NameService (Name Service for advertising server)This attribute specifies whether or not DCE is available to locateservers. The possible values are NONE. If the value is set to NONEthere must be an entry in vardir/cics_servers/server_bindings forthis server. The default value is DCE.

OpThreadPoolSize (Number of threads devoted to normal operations)This attribute specifies the number of operational threads, andtherefore the maximum number of SFS requests that can be processedconcurrently by the SFS. The optimum number of threads depends onhow heavily the server is used. A guideline is to set the number ofthreads in proportion to the maximum number of application serversconfigured to use the SFS. The equivalent Encina sfs command optionis -P. The default value is 12.

ProtectionLevel (Protection level)This attribute sets the minimum authentication level at which this SFSwill receive and send Remote Procedure Calls. Possible values arenone, connect, call, pkt, pkt_integ, pkt_privacy (only if you haveinstalled 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 DCEauthentication. default is the default DCE protection level. For moreinformation about protection levels, refer to the DCE documentation.Remember that the higher the protection level, the more time isrequired to authenticate, and this may affect performance. If default iscoded, an authentication level of pkt_integ will be used. IfNameService 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 defaultvalue is “SFS Server Definition”.

ResThreadPoolSize (Number of threads devoted to resource operations)This attribute specifies the number of threads that are used byparticular SFS calls to free resources. Normally the default value isadequate, but you might want to increase it if the SFS is heavily used.The equivalent Encina sfs command option is -P. The default value is3.

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 charactersor less). The SRC subsystem name (CICS on Open Systems) or nameof the subsystem (Windows NT service) is cicssfs.ShortName. Youmust ensure that each ShortName in the SSD is unique in the SSD.The short name can be mapped to various values, and is representedas %S. For example, when a server is created, its default first volumeis called sfs_%S. Therefore, you create an operating system volumename of sfs_ShortName. This convention simplifies serverconfiguration, but you must not name servers with preexistingvolume names, because the names are unlikely to be in this form. Thedefault value is “S%H”.

StartType (Cold or auto start?)This attribute determines the type of CICS system initialization thatyou require. If the startup is cold, CICS performs a cold start. If thestartup is auto, CICS uses the restart information written by theprevious run of CICS to restart the server from the state in which itwas last shut down. If no restart information exists, CICS performs acold start. You can specify this value when using an Encina sfscommand. The default value is auto.

UserID (user ID for server)This attribute specifies the user identifier for the SFS to use. The

UserID must be able to use any operating system resources requiredby the SFS, and read and write the logical volumes of the SFS. Thedefault value is “%S”.

Temporary Storage Definitions (TSD)

Temporary Storage Definitions (TSD) describe the templates that CICS uses todetermine the attributes given to temporary storage queues for this CICSregion. When an application first creates a temporary storage queue, CICSuses the attributes of the template with the longest matching template namethat it can find in the TSD.

For further information on naming temporary storage queues and temporarystorage queue templates, see the CICS Application Programming Guide.

If no match is found, the queue automatically becomes a nonrecoverable, localqueue 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 supportedby National Language Support (NLS) and can be up to eight byteslong, taken from the ASCII values listed here. For all the permanentdatabase operations, and on a runtime database insert operation, CICSperforms class-specific validation of the bytes forming the databasekey. CICS allows any bytes from 1 to 126 decimal except comma (,),single quote (’), backslash (\), and colon (:) for permanent databasetemporary storage template keys, and 0 through 255 decimal forruntime database temporary storage keys. Binary queue names shouldnot be used for remote queue names particularly if the remote queuesare on either CICS/ESA or CICS/VSE.

ActivateOnStartup (Activate the resource at cold start?)If you set this attribute to yes, CICS always copies the resourcedefinition from the permanent database to the runtime database atcold start. If you set the attribute to no, CICS does not copy theresource definition, unless its group has been specified in the Groupsattribute of Region Definitions (RD). The default value is yes.

GroupName (Group to which resource belongs)This eight-byte ASCII text attribute assigns a group name to whichthis resource definition belongs. You can specify that, for cold start,

CICS copies resource definitions belonging to groups named in theGroups attribute of Region Definitions (RD) from the permanentdatabase to the runtime database, as well as copying definitions thathave ActivateOnStartup=yes. The default value is "".

RecoverFlag (Is queue recoverable?)This attribute determines whether the temporary storage queue isrecoverable or not. You set this attribute to yes for recoverable queues,and no for nonrecoverable queues. All temporary storage queues heldby DB2 are recoverable. If, when CICS intercommunication facilitiesare being used, a temporary storage queue could be remote andrecoverable, CICS considers the queue to be remote. You can onlyspecify recoverability in the region where the queue resides. Also, youcan only make data on auxiliary storage recoverable. The defaultvalue is no.

RemoteName (Remote Queue Name)If the temporary storage queue resides in a remote region, thisattribute is the remote temporary storage queue template name, whichcan be up to eight ASCII characters long. CICS uses this name toreplace the local template name or <Key> when a reference to thequeue is transmitted to the remote region (see the CICS ApplicationProgramming Guide for an example). If you do not provide thisattribute, then CICS sends the local identifier to the remote region. Ifyou do provide it, then the remote template name must be the samelength as the <Key>. The shorthand notations %R, %H, and %S arenot expanded for this attribute. For example, a value of “%H” reallymeans the string “%H”. The default value is "".

RemoteSysId (Remote System Identifier)If the temporary storage queue resides in a remote region, you mustenter the name of a Communications Definitions (CD) entry thatdefines 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 defaultvalue is “Temporary Storage Definition”.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for this temporary

storage queue, in the range 1 through 24. If the user, whosetransaction issues this request, does not have this RSLKey value inthe RSLKeylist attribute in their User Definitions (UD) entry, CICSraises the NOTAUTH condition. Alternatively, you can specify thevalue public or private. With public, any user may access the queue.With private, CICS only allows access to the queue from transactionswhich have the attribute RSLCheck=none in their TransactionDefinitions (TD) entry. The default value is private.

TemplateDefined (Is a user conversion template defined?)If this temporary storage queue can be accessed from a non-ASCIIregion, or if the queue contains binary or user-defined data, then youneed to define a conversion template that describes the temporarystorage record. If such a template exists, you should set this attributeto yes, otherwise to no. The default value is no.

Terminal Definitions (WD)

Terminal Definitions (WD) define the terminals available in this CICS region.Although you are supplied with predefined terminal definitions for severalterminal types, you can add, modify, or delete these as required. See“Chapter 10. Terminal model definitions” on page 501 for more informationabout the predefined terminal definitions.

<Key> This represents a unique identifier for each terminal, and is the keyfor the WD entry. Terminal identifiers are not supported by NationalLanguage Support (NLS) and can be up to four characters, taken fromthe ASCII characters listed here. For all the permanent databaseoperations, and on a runtime database insert operation, CICSperforms class-specific validation of the bytes forming the databasekey. For terminals, CICS allows the characters A-Z, a-z, 0-9, and thefollowing 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 (>).

ActivateOnStartup (Activate the resource at cold start?)If you set this attribute to yes, CICS always copies the resourcedefinition from the permanent database to the runtime database atcold start. If you set the attribute to no, CICS does not copy the

resource definition, unless its group has been specified in the Groupsattribute of Region Definitions (RD). The default value is yes.

CanStartATIs (Is terminal available for ATI requests?)You set this attribute to yes or no to indicate whether the terminal isavailable or unavailable to CICS as a target of an asynchronous EXECCICS 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 isavailable or unavailable for use by users to initiate transactions. Astransactions need to be requested from somewhere, you cannot setboth ATI and TTI to unavailable, but you can set both ATI and TTI toavailable. The default value is yes.

DevType (Device Type for model entry)This is used to select appropriate model entries for the terminalautoinstall program. The default value is "".

See “Chapter 10. Terminal model definitions” on page 501 and“Terminal autoinstall user program” on page 390 for furtherinformation.

ERRColor (Color for error messages)Some of the supplied transactions use this flag, indicating the color ofthe error messages. This option takes effect only if ERRLastLine isyes. The default value is no. Possible values are as follows:v nov bluev redv pinkv greenv turquoisev yellowv neutral

ERRHilight (Extended highlighting for error messages)Some of the supplied transactions use this flag, indicating thehighlighting of the error messages. The default value is no. Thisoption takes effect only if ERRLastLine is yes. Possible values are asfollows:v nov blinkv reverse

v underline

ERRIntensify (Should error messages be intensified?)Some of the supplied transactions use this flag, indicating whether thetransactions intensify error messages. This option takes effect only ifERRLastLine is yes. You can set the flag to yes or no. The defaultvalue is yes.

ERRLastLine (Display error messages on the last line?)This flag is used by some of the supplied transactions, and indicateswhether the transactions use the last line of the screen for errormessages. You can set the flag 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 datastreams. 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 field to yes to indicate that the terminal has colorcapability. Set it to no otherwise. The default value is no.

Highlight (Does terminal support highlighting?)You set this field to yes to indicate that the terminal supportsextended highlighting. Set it to no otherwise. CICS terminals supportextended highlighting, though terminals connected from inboundtransaction 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 definition is for aprinter, or no if the definition is not. If the attribute is set to yes, youmust also specify the NetName attribute, and set the values ofNumColumns to 132 and NumLines to 64. The default value is no.

IsShippable (Is terminal definition shippable?)You set this attribute to yes to indicate that this WD record can beshipped to a remote region. Set the flag to no otherwise. The defaultvalue is yes.

Katakana (Does terminal support Katakana?)This attribute is set to yes to indicate that the terminal supportsKatakana characters. Otherwise this attribute is set to no. The defaultvalue is no.

MapColumnThis field contains the column number of the origin of the latest mapsent to the terminal. You cannot set this attribute directly, but youmay access it through the EXEC CICS ASSIGN statement.

MapHeightThis field contains the height of the latest map sent to the terminal.You cannot set this attribute directly, but you may access it throughthe EXEC CICS ASSIGN statement.

MapLineThis field contains the line number of the origin of the latest map sentto the terminal. You cannot set this attribute directly, but you mayaccess it through the EXEC CICS ASSIGN statement.

MapWidthThis field contains the width of the latest map sent to the terminal.You cannot set this attribute directly, but you may access it throughthe EXEC CICS ASSIGN statement.

ModelId (Autoinstall Model Identifier)This attribute contains the autoinstall terminal model identifier. Youshould set this attribute if the WD entry is a candidate model. Do notset this attribute if the IsPrinter attribute is set to yes, but set theNetName attribute instead. The default value is "".

Read “Terminal autoinstall user program” on page 390 for adescription of the terminal autoinstall user exit program.

Note: Either ModelId or NetName must be specified (not allowed totake the default value), otherwise the terminal will not beloaded when the region starts and TermIderr will be returnedwhen you try to use the terminal.

NetName (NetName of the shell terminal)This attribute contains a unique ASCII eight-character identifier forthe terminal. This identifier must be unique within the TerminalDefinitions for this region. You must specify this attribute if theIsPrinter attribute is set to yes. The default value is "".

Note: Either ModelId or NetName must be specified (not allowed totake the default value), otherwise the terminal will not beloaded when the region starts and TermIderr will be returnedwhen you try to use the terminal.

NumColumns (Number of columns on terminal)This field contains the number of columns on the terminal. CICSsupports 80 and 132 columns for display terminals and 132 columnsfor printers. If the IsPrinter attribute is set to yes, you must set thisattribute to 132. Specify a value other than these only when defining aterminal that resides in a remote region. This field represents thestandard size of the display, not the alternate size. A terminal whichconnects while the alternate size is in use, will be reset to the standardsize when the first ERASE is sent from CICS. The default value is 80.

NumLines (Number of lines on terminal)This field contains the number of lines on the terminal. CICS supportsthe 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 toyes, you must set this attribute to 64. Specify a value other than theseonly when defining a terminal that resides in a remote region. Thisfield represents the standard size of the display, not the alternate size.A terminal which connects while the alternate size is in use, will bereset to the standard size when the first ERASE is sent from CICS. Thedefault value is 24.

Outline (Does terminal support field 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 defaultvalue is no.

OutService (Set terminal out of service?)You can set this flag to yes or no to indicate whether or not thisterminal is in service. The default value is no.

Priority (Terminal priority)CICS uses this attribute, in the range 0 through 255, to establish theoverall transaction processing priority. The transaction processingpriority is equal to the sum of the terminal priority, transactionpriority, and user priority; or 255, whichever is the smaller. Theprocessing priority of a transaction determines how quickly CICS

schedules that transaction. The higher the summed number, the fasterCICS schedules the task. The default value is 0.

ProgramSymbols (Program Symbols)This attribute is set to yes to indicate that the terminal supports pureMulti-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 recoveredafter a region failure. The possible values are yes and no. The defaultvalue in all the model terminal definitions provided with CICS is yes.If the value of this attribute is yes the terminal will be reinstalledautomatically following a region failure. If the value is no, theterminal will not be reinstalled. If a terminal is not recoverable thetime taken to install the terminal is slightly shorter and the time takento restart the region will also be shorter. System administrators maychoose to use recovery only for important classes of terminals.

RemoteName (Terminal identifier on remote system)If the terminal resides in a remote region, you enter the name bywhich the terminal is known on that region. If you do not providethis attribute, then CICS sends the local identifier of this terminal tothe remote region. The shorthand notations %R, %H, and %S are notexpanded for this attribute. For example, a value of “%H” reallymeans “%H”. The default value is "".

RemoteSysId (System to which terminal belongs)If the terminal resides in a remote region, you must enter the name ofa Communications Definitions (CD) entry that defines a connection tothe remote region. The default value is "" meaning that the terminal isconnected to the local region.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “Terminal Definition”.

RSLKeyList (Resource Level Security Key list)You should only specify RSLKeyList for all devices that are unable tosign on using CESN, for example, printers. This attribute contains thelist of resource security keys, RSLKeys, for this terminal. CICS usesthis to control access to resources when running transactions. You canspecify up to 24 keys, each in the range 1 through 24, and separatedby the | character.

Only resources whose RSLKeys are included in the RSLKeyList canbe accessed by any transactions running at this terminal. Therefore,you must include the security keys of all resources that can beaccessed when running transactions on this terminal. The following

example of an RSLKeyList allows transactions to access resourceswith security keys of 1, 2, 8, and 23:

1|2|8|23

Note: You should be aware of the implications of resources marked aseither public or private. With public, any terminal may accessthe resource. With private, CICS only allows access to theresource from transactions which have the attributeRSLCheck=none in their Transaction Definitions (TD) entry. Forfurther 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 supportsMulti-Byte Character Set input. Otherwise this attribute is set to no.The default value is no.

TCTUALen (Length of TCTUA)This attribute defines the length in bytes of the user area for thisterminal. It can be in the range 0 through 255, but you should make itas small as possible. CICS initializes the user area to zeros at systeminitialization. The default value is 0.

TerminalProtection (Protection level)If you are using DCE authentication this attribute sets theauthentication level of the Remote Procedure Calls (RPC) between theregion and the terminal. Possible settings are: none, connect, call, pkt,pkt_integ, pkt_privacy (only if you have installed DCE privacysupport) and default.

none means that DCE makes no attempt to authenticate the RPCs.connect, call, pkt and pkt_integ represent increasing levels of DCEauthentication. The value default is the default DCE protection level.For more information about protection levels, refer to the DCEdocumentation. Be aware that the higher the protection level, themore time is required to authenticate and this may affect performance.The default value is none.

TermSubType (Terminal subtype)This attribute is a qualification of TermType. These two attributes canget shipped in during transaction routing. CICS has a fixed TermTypeand TermSubType. The default value is 10.

TermType (Terminal type)This field contains the terminal type for information purposes only. AsCICS only has one type of terminal, changing the value does notmean that the emulation runs differently. The default value is 145.

TSLKeyList (Transaction Level Security Key list)You should only specify TSLKeyList for all devices that are unable tosign on using CESN, for example, printers. This attribute contains thelist of transaction security keys, TSLKeys, for this terminal. CICS usesthis 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 areallowed to run at this terminal. Therefore, you must include thesecurity keys of all transactions allowed to run on this terminal. Thefollowing example of a TSLKeyList allows transactions with securitykeys of 1, 5, 13, and 52:

1|5|13|52

public transactions are transactions that allow any terminal to accessthem. For further information about transaction security, see the CICSAdministration Guide.

Read the CICS Intercommunication Guide for more information abouthow this attribute is used for intersystem requests.

The default value for TSLKeyList is 1, which gives access to publictransactions.

UCTranFlag (Should terminal convert data to uppercase?)You set this attribute to yes or no to indicate whether or not CICSconverts all lowercase data to uppercase on input. The default value isno.

Validation (Does terminal support field validation?)Field validation is where the terminal forces certain input fields to becompleted before the user leaves the field. You would set this attributefield to yes to indicate that the terminal supports field validation. Setit to no otherwise. cicsterm (CICS on Open Systems cicslterm (CICSfor Windows NT) does not currently support field validation. Thedefault value is no.

Transaction Definitions (TD)

Transaction Definitions (TD) define all the transactions that CICS can processin this region. Each entry within the TD contains control information used byCICS to identify and run a transaction.

<Key> This represents a unique transaction code, and is the key for the TDentry. Transaction identifiers are not supported by National LanguageSupport (NLS), and must be made up from the ASCII characters listedhere. Transaction identifiers are between one and four ASCIIcharacters long and must not include blank characters. For all the

permanent database operations, and on a runtime database insertoperation, CICS performs class-specific validation of the bytes formingthe database key. For transactions, CICS allows the characters A-Z (donot start with a C), a-z (do not start with a c), 0-9, and the followingmetacharacters; dollar ($), at sign (@), period (.), slash (/), dash (-),underscore (_), percent (%), ampersand (&), question mark (?),exclamation (!), vertical bar or pipe (|), double quote (″), comma (,),semicolon (;), less than (<), greater than (>).

Do not define any transactions beginning with the letter C, as theseare reserved for CICS internal use.

DeadLockTimeout (Transaction deadlock timeout value (secs))This attribute specifies, in seconds, how long CICS allows thetransaction to wait when CICS has detected a possible deadlock.When that time expires, this transaction becomes a candidate forabnormal termination, and receives an abnormal termination codeAKCS if CICS chooses it. You can specify a value of 0 to mean thatthe 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 routedto a remote system dynamically, using the CICS dynamic transactionrouting facility.

If this attribute is set to no a local or remote definition is createdaccording to the RemoteSysId attribute.

If this attribute is set to yes the dynamic transaction user exit programdetermines the local or remote destination when it is invoked. TheProgName, RemoteSysId and RemoteName attributes do not need tobe set. If they are set they are passed to the user exit program asdefault parameter values. For programming information about theuser exit, see “Dynamic transaction routing user exit (UE014025)” onpage 413.

The default value is no.

EnableStatus (Transaction enable status)You set this attribute to enabled if the transaction is available for useor to disabled if the transaction is unavailable for use. The defaultvalue is enabled.

InDoubt (Effect of FORCEPURGE for InDoubt transactions)When this transaction is waiting in the first phase of the two-phasecommit process and a CEMT SET TASK FORCEPURGE is issuedagainst the transaction, CICS uses this attribute to determine whetherto commit or back out any changes made by the transaction before thewait. If you set this attribute to wait_commit, CICS commits anychanges. If you set this attribute to wait_backout, CICS backs out anychanges. The default value is wait_backout.

InvocationMode (Contexts in which transaction can START)This attribute specifies several different contexts for runningtransactions, including facility values, valid start methods, and validrun states.

Facility values (where the transaction can be started): no_facilityallows the transaction to be run without being attached to a terminalor 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 thetransaction to be started on a communications link; any_facilityenables the transaction to be run from anywhere. The default value isany_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 ifsubmitted by internal CICS code and not by a user transaction EXECCICS START call; triggered_start allows the transaction to be used asa triggered transaction for a TD Queue trigger; any_start allows thetransaction to be started by any of these methods. The default value isany_start.

Valid run states: at_startup enables the transaction to be started atsystem startup. Only the CRAB and CAIN transactions should be setwith this mode. at_normal_running allows the transaction to bestarted 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 firstphase of a normal shutdown; at_shutdown_end allows the transactionto be invoked after the first phase of normal shutdown. Only theCRAB and CROW transactions should be set with this mode.at_immediate_shutdown allows the transaction to be invoked duringimmediate shutdown. Only the CROW transaction should have thismode. 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 thetransaction can be run as the back end of a distributed transactionprocessing (DTP) transaction. The default value is no. This attributeshould be set to no if this transaction is intended to be the target oftransaction 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 whenanother transaction issues an EXEC CICS START NOCHECKcommand for this transaction, CICS queues the API request locallyuntil the remote region is back in service. Once the remote region isback in service, CICS ships all the outstanding requests to it. Thedefault value is no.

MaxTaskCPU (CICS on Open Systems)You can set the maximum time (in milliseconds) to be allowed for theuse of the CPU by a transaction. If the value is greater than zero,checks are made each time the transaction enters CICS through anEXEC CICS call command. The maximum value is 2**31 —1(approximately 24 days of User space per CPU). The default is 0. Seealso the MaxTaskCPU and MaxTaskCPUAction attributes of theRegion Definitions.

Priority (Transaction Priority)CICS uses this attribute value, in the range 0 through 255, to establish

the overall transaction processing priority. The transaction processingpriority is equal to the sum of the terminal priority, transactionpriority, and user priority, or 255, whichever is the smaller. Theprocessing priority of a transaction determines how quickly CICSschedules that transaction. The higher the summed number, the fasterCICS schedules the task. The default value is 0.

ProgName (First program name)This attribute can be up to eight ASCII characters long, and names thefirst program that this transaction runs. You need to ensure that youinclude an entry in the Program Definitions (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 transactionby running the CEMT PURGE TASK transaction. If you set thisattribute to notpurgeable, then you cannot purge this transaction. Thedefault value is purgeable.

RemoteName (Remote Transaction Identifier)If the transaction resides in a remote system, you enter the name bywhich the transaction is known in that system. If you do not providethis attribute, then CICS sends the local identifier of this transaction tothe remote system. The shorthand notations %R, %H, and %S are notexpanded for this attribute. For example, a value of ″%H″ reallymeans the string ″%H″. The default value is "".

RemoteSysId (Remote System Identifier)If the transaction resides in a remote system, you must enter the nameof a Communications Definitions (CD) entry that defines a connectionto the remote region. If you specify a RemoteSysId, the Prognameattribute is ignored. The default value is "" meaning that thetransaction resides in the local region.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “Transaction Definition”.

RSLCheck (Type of RSL Checks)This attribute determines the type of resource security checkingperformed by CICS when running this transaction. Set this attribute tonone for no resource security checking, to internal for CICS-providedresource security, or to external for CICS to use an External SecurityManager (ESM) instead of CICS-provided resource security. If yourequire an ESM for a particular resource, you must setRSLCheck=external for that resource type, in the Region Definitions(RD). The default value is none.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for this transaction, inthe range 1 through 24. CICS applies transaction resource securitychecking only for the EXEC CICS START command. If the user, whosetransaction issues this request, does not have this RSLKey value inthe RSLKeyList attribute in his or her User Definitions (UD) entry,CICS raises the NOTAUTH condition. Alternatively, you can specifythe value public or private. With public, any user may access thetransaction. With private, CICS only allows access to the transactionfrom transactions that have the attribute RSLCheck=none in theirTransaction Definitions (TD) entry. The default value is private.

SNAModeName (SNA modename for this transaction)This attribute is used to specify the mode name on an allocate requestto a SNA-connected remote system. The mode specifies thecharacteristics of the conversation that is being allocated. Aconversation may be allocated by this transaction in any of thefollowing ways:v When the transaction issues an EXEC CICS ALLOCATE command

without the PROFILE option to a SNA-connected system. (Thisattribute can be overwritten by specifying the PROFILE option onthe EXEC CICS ALLOCATE command.)

v When this transaction requests a resource that is on aSNA-connected remote system.

v When this transaction itself is defined as remote on aSNA-connected system.

The SNAModename value can be one of the mode names defined toSNA for the required SNA connection, or it can be "".

If you do not specify a value for SNAModeName, the default modename defined by the SNA software is used.

Refer to the SNA booklet for your product for how to definemodenames to SNA. See the Concepts and Facilities.

Syncpoint (Type of Syncpoint Flows)If prompt_finish is specified, EXEC CICS RETURN and EXEC CICSSYNCPOINT wait for the finish or forget flow from implicit andexplicit sync points before moving on to the next LUW or returning tothe application. If no_prompt_finish is specified, EXEC CICSRETURN and EXEC CICS SYNCPOINT may not wait for the finish orforget flow, but may return sooner, after receiving the commit flow.

Specifying no_prompt_finish can improve throughput of transactionsbecause the finish or forget flow may be “piggybacked” onto the nextflow. The only disadvantage of specifying no_prompt_finish is thatduring recovery (after all types of shutdown), more transactions willneed to be reprepared because their finishes may not have occurred.Even after normal shutdowns, you may get recovery servers on restartwhich will be waiting for the finish flows to occur.

TClass (The class of transaction)The transaction class is used by the Region Definitions (RD)ClassMaxTasks and MaxServer attributes to determine how manytasks can be run, at any given time, for this transaction. If the TClassattribute equals a value of 1 through 10, then the values specified withthe RD ClassMaxTasks attribute are used. If TClass=none, then thevalue specified with the RD MaxServer attribute is used. TheMaxServer attribute determines the maximum number of tasks theregion can run simultaneously. The default value for TClass is none.See the CICS Administration Guide for more information.

TemplateDefined (Is a user conversion template defined?)If this transaction can be started with an EXEC CICS STARTcommand issued from a non-ASCII region, and expects to be sentdata in the FROM option, then you need to define a conversiontemplate for the data. If such a template exists, set this attribute toyes, otherwise to no. The default value is no.

Timeout (Conversational timeout value (mins))This attribute specifies, in minutes, how long CICS waits for terminalinput when running this transaction. When that time expires, thistransaction abnormally terminates with code AKCT. You can specify avalue of 0 to mean that the transaction never times out. Note that aTimeout value is not used for Intersystem requests includingtransactions started by IBM CICS Clients. The default value is 0.

TPNSNAProfile (SNA TPN profile for APPC listener program)This attribute is only relevant for requests to run transactions fromremote System Network Architecture (SNA) systems. You specify herethe TPN profile name of a profile that has been configured in SNA.The TPN profile contains fields that describe the characteristics ofyour transaction. The default value is "".

Other than performance, this attribute has no effect on a TCP/IPconnection. For performance reasons (at startup only), it is importantthat TPNSNAProfile=″″ is specified for transactions that do not needto be made available over the gateway. See the CICSIntercommunication Guide for more information.

TransDump (Should transaction be dumped on an abend?)This attribute controls whether or not CICS produces a transaction

dump if the transaction abnormally terminates, and can be set to yesor no, respectively. If you set TransDump to no, CICS never producesa transaction dump. If you set TransDump to yes, CICS produces atransaction dump, and may also produce a system dump due to anASRA or ASRB abnormal termination. For further information, see thePCDump and ABDump attributes in the Region Definitions (RD). Thedefault value is no.

TSLCheck (Type of TSL Checks)This attribute indicates whether or not you require an ESM instead ofCICS-provided transaction security. Enter internal or external todefine whether you require CICS-provided transaction security or anESM. 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 thistransaction does not have this TSLKey value in the TSLKeyListattribute in his or her User Definitions (UD) entry, CICS preventsaccess to the transaction. Alternatively, you can specify a value ofpublic to allow any user to access the transaction. For furtherinformation about transaction security, read the CICS AdministrationGuide. The default value is 1.

The TSLKey value for the CICS-supplied transactions should alwaysbe set to 1 to indicate a public transaction. This includes the CICSprivate transactions (marked (p) in “Complete list of CICS-suppliedtransactions” on page 278), although you may decide to havetransaction level security checking on some sensitive transactions,such as CURD. If the TSLKey value is not 1 then unpredictable resultsdue to TSL checking will occur during region start up, region shutdown, or even in normal operation.

TWASize (Transaction Work Area Size)The value of this attribute determines the size (in bytes) of theTransaction Work Area (TWA) which CICS acquires for thistransaction. The maximum value is 32767. For a transaction thatpasses control between programs, you must specify a TWA size equalto or larger than the largest TWA size required by any of theprograms 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 partof the transaction, to upper case. Otherwise, CICS does not convertthe data. The default value is no.

Transient Data Definitions (TDD)

Transient Data Definitions (TDD) contain entries defining to CICS each of thesymbolic destinations to or from which transient data is routed in this CICSregion. The name of every transient data queue must be defined to CICSbefore the queue can be used by an application program. Unlike temporarystorage queues, transient data queues cannot be dynamically created by anEXEC CICS WRITEQ command from an application.

<Key> This represents the name of the transient data queue, and is the keyfor the TDD entry. CICS uses this name in the transient dataoperations to specify the destinations. Queue names are not supportedby National Language Support (NLS) and can be up to fourcharacters, taken from the ASCII characters listed here. For all thepermanent database operations, and on a runtime database insertoperation, CICS performs class-specific validation of the bytes formingthe database key. For transient data, CICS allows ASCII charactersfrom ! to ˜ (33 to 126 decimal). The queue name should not start withthe letter C or letters “DFH”, because these are reserved for definingthe destinations required by some CICS facilities.

DestType (Type of Queue)This attribute specifies whether the transient data queue isintrapartition, extrapartition, indirect, or remote. See the CICSAdministration Guide for further information. The default value isintrapartition.

ExtrapartitionFile (Filename or path for EP queue data file)This ASCII text attribute defines the path name and file thatcorresponds to the extrapartition queue. The file must be owned bycics. The default value is "".

FacilityId (System/Terminal for a triggered task)This ASCII text attribute defines the triggered transaction’s principalfacility identifier. It may be a system identifier or terminal identifier,

depending upon the FacilityType. You do not specify this attribute ifFacilityType=file. The shorthand notations %R, %H, and %S are notexpanded for this attribute. For example, a value of “%H” reallymeans the string “%H”. The default value is "". FacilityId attribute isapplicable only to intrapartition queues.

FacilityType (Type of facility allocated for triggered task)This attribute defines the type of facility allocated for a triggered task.You must enter either terminal, system, or file to determine thetriggered transaction’s principal facility. Terminal means that thetriggered transaction runs on the terminal specified by the FacilityIdattribute. The terminal must exist for the transaction to run. Systemmeans that CICS allocates a Distributed Transaction Processing (DTP)conversation with the remote system specified by FacilityId beforestarting it up. File means that the triggered transaction runs as anonfacility or background task, and does not have a terminal. TheFacilityId attribute is ignored. The default value is file.

IndirectQueueId (Indirect Queue Name)This ASCII text attribute provides an aliasing mechanism. The indirectdestination does not point to an actual file, but to another destination.This may be extrapartition, intrapartition, or remote. It may even beanother indirect destination. You enter this if an indirect queue isrequired. The shorthand notations %R, %H, and %S are not expandedfor this attribute. For example, a value of “%H” really means thestring “%H”. The default value is "".

IOMode (Input/Output Mode of EP Queue)This attribute defines, for an extrapartition queue, whether it is readonly, meaning that data is read from the queue, or write only,meaning that data is written to the queue. The possible settings areinput and output, respectively. The default value is output.

OpenMode (Open EP output files truncated or append)This attribute indicates whether CICS empties the outputextrapartition transient data queue, or appends to the queue. Thepossible settings are: truncate, when the queue is emptied on startupor upon closing and reopening the queue, and append, when thequeue is always appended to. The default value is truncate.

Note that CICS does not empty transient data queues that are set toappend, and you will have to empty queues that grow too big. IfCICS is offline, delete the file associated with the queue, shown in theExtrapartitionFile attribute. If CICS is online, first close and disablethe queue using the transaction CEMT SET TDQUEUE or the CICScommand EXEC CICS SET TDQUEUE, then delete the file associatedwith the queue, and finally open and re-enable the queue again usingthe transaction CEMT SET TDQUEUE or the command EXEC CICSSET TDQUEUE. See “CEMT INQ/SET TDQUEUE” on page 348 forinformation about the transaction CEMT SET TDQUEUE, or see theCICS Application Programming Referencefor information about thecommand EXEC CICS SET TDQUEUE.

RecordLen (Record length for fixed length EP queue)This attribute defines the length of records in files used to store theextrapartition transient data queue and must be a numeric value.CICS ignores this value unless DestType=extrapartition andRecordType=fixed_length. The default value is 1024.

RecordTerminator (ASCII value of terminator for fixed length queue)This attribute defines the record delimiter of transient data queuerecords and must be a three-digit character number. CICS ignores thisvalue unless DestType=extrapartition andRecordType=byte_terminated. The default value is 0.

RecordType (Record organization for EP queue data file)This attribute describes the format of the file used to store theextrapartition transient data queue. You enter one of the values:fixed_length, variable_length, line_oriented, null_terminated, orbyte_terminated. The default value is fixed_length.

RecoveryType (Recoverability type of IP queue)This attribute defines an intrapartition destination as logicallyrecoverable, physically recoverable, or not recoverable. The possiblesettings are: logical, physical, and none. Logically recoverabledestinations are restored (after individual transaction abnormalterminations and after region abnormal terminations) to the statusthey had at the end of the last completed Logical Unit of Work(LUW).

CICS restores physically recoverable destinations (after a regionabnormal termination) to the status at the time when the abnormaltermination occurred. CICS restores the last record read, enabling it tobe read again if there is a possibility that the reader did not have achance 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 whichthe queue is known there. This attribute is four ASCII characters long.If you do not specify this attribute, CICS sends the local identifier tothe remote region. If more than one region has a destination with thesame name, the local key allows the definition of an alias that routes atransient data request to a specific region. A transient data requestusing the alias, identifies the remote name and the region to whichthe request is shipped. The shorthand notations %R, %H, and %S arenot expanded for this attribute. For example, a value of “%H” reallymeans the string “%H”. The default value is "".

RemoteSysId (Remote System Identifier)If the queue resides in a remote region, you must enter the name of aCommunications Definitions (CD) entry that defines a connection tothe remote region. The default value is "" meaning that the file queueresides on the local region.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing the resource. The defaultvalue is “Transient Data Definition”.

RSLKey (Resource Level Security Key)This attribute contains the resource security key for this transient dataqueue, in the range 1 through 24. If the user, whose transaction issuesa request to access this TDQ, does not have this RSLKey value in theRSLKeyList attribute in their User Definitions (UD) entry, CICS raisesthe NOTAUTH condition. Alternatively, you can specify the valuepublic or private. With public, any user may access the queue. Withprivate, CICS only allows access to the queue from transactions whichhave the attribute RSLCheck=none in their Transaction Definitions(TD) entries. The default value is private.

TemplateDefined (Is a user conversion template defined?)If this transient data queue can be accessed from a non-ASCII region,or if the queue contains binary or user-defined data, then you need todefine 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.

TriggeredTransId (Triggered Transaction Identifier)This ASCII text attribute identifies the transaction that is to beautomatically initiated when the trigger level is reached. The purposeof transactions initiated in this way is to read records from thedestination. If you do not specify this identifier, or you enter a triggerlevel of zero, some other means must be used to schedule transactionsto read records from the destination. This transaction may not residein a remote CICS region. If it does, an abnormal termination occurswhen an attempt is made to initiate it. The default value is"".TriggeredTransId attribute is applicable only to intrapartitionqueues.

TriggerLevel (Trigger Level)This attribute defines the number of committed records to beaccumulated before a task is automatically initiated to process them.The value must be in the range 0 through 32767. The default value is0. 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 queueat startup, or on request. This condition applies to extrapartitionqueues only. The possible settings are: at_startup and on_request. Thedefault value is at_startup. Note that you must use CEMT to openand close a TD queue. See “CEMT INQ/SET TDQUEUE” on page 348for further information.

User Definitions (UD)

User Definitions (UD) identify users of a CICS region. A user not registered inthe UD is still allowed access to the CICS region, but only has public accessrights as the default userid.

<Key> This represents a unique user identifier, and is the key of the UDentry. User identifiers are not supported by National LanguageSupport (NLS) and can be up to eight characters, taken from theASCII characters listed here. For all the permanent databaseoperations, and on a runtime database insert operation, CICSperforms class-specific validation of the bytes forming the databasekey. For users, CICS allows ASCII characters from exclamation (!) totilde (˜), (33 to 126 decimal), excluding the characters '. \, #, and : .

Note that a user identifier should not be the same as the region name,otherwise unpredictable results may occur. This is because the regionname is treated as a special name by CICS security such that onlyTSL/RSL public access is granted.

ActivateOnStartup (Activate the resource at cold start?)If you set this attribute to yes, CICS always copies the resourcedefinition from the permanent database to the runtime database atcold start. If you set the attribute to no, CICS does not copy theresource definition, unless its group has been specified. The defaultvalue is yes.

CICSPassword (Encrypted password)This attribute contains an encrypted version of the password to beused to authenticate this user. This attribute can be set using the CICSRDO utilities or by using SMIT on CICS for AIX or SAM on CICS forHP-UX. The password is entered as plain text but is stored anddisplayed in its encrypted form.

DCECell ((Obsolete) DCE cell name)This attribute is obsolete and has been replaced by Principal. Itcontained ASCII text which named the DCE cell to which this userbelongs and was used by the CICS Signon (CESN) transaction as partof the authentication of a user identity.

GroupName (Group to which resource belongs)This eight-byte ASCII text attribute assigns a group name to whichthis resource description entry belongs. You can specify that, for coldstart, CICS copies resource definitions belonging to named groupsfrom the permanent database to the runtime database, as well ascopying definitions that have ActivateOnStartup=yes. The defaultvalue is "".

OpID (Operator ID)A three-byte field containing the operator identification to beassociated with this user. This value is returned by the EXEC CICSASSIGN OPID and EXEC CICS INQUIRE TERMINAL OPIDcommands. If your applications make use of this value, you shouldensure that it is unique for all users who will access this region. Thedefault values are:v AIX on CICS for AIXv HUX on CICS for HP-UXv SUN on CICS for Solarisv WNT on CICS for Windows NT

Permanent (Protect resource from modification?)This attribute specifies whether CICS permits this user to amend ordelete the permanent database entry. If you set the attribute to no, thisuser can amend or delete the entry. The user can still amend or deletean entry with Permanent=yes by first setting Permanent to no. If youdo amend the entry, you should set Permanent back to yesafterwards. The default value is no.

Principal (DCE principal of the user)This attribute contains the DCE principal for the user. You can entereither a fully qualified 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 cellname automatically. If you do not enter a principal, CICS uses theuserid in the current cell (for example, if the CICS user is FRED, theprincipal will be /.:/FRED). If you are using DCE authentication allCICS users defined in the User Definitions must have a unique DCEprincipal. DCE principals cannot be shared among CICS users. Thedefault value is "".

Priority (User priority)CICS uses this attribute, in the range 0 through 255, to establish theoverall transaction processing priority. The transaction processingpriority is equal to the sum of the terminal priority, transactionpriority, and user priority; or 255, whichever is the smaller. Theprocessing priority of a transaction determines how quickly CICSschedules that transaction. The higher the summed value, the fasterCICS schedules the task. The default value is 0.

ResourceDescription (Resource description)A 30-byte ASCII text attribute describing this resource. The defaultvalue is “User Definition”.

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 runningtransactions. You can specify up to 24 keys, each in the range 1through 24, separated by the | character and enclosed in doublequotation marks.

Only resources whose RSLKeys are included in the RSLKeyList canbe accessed by this user. Therefore, you must include the security keysof all resources needed by this user when running transactions. Thefollowing example of an RSLKeyList allows users to access resourceswith security keys of 1, 2, 8, and 23:RSLKeyList="1|2|8|23"

public resources allow any user to access them. private resourcesprevent access from transactions which do not have the attributeRSLCheck=none in their Transaction Definitions (TD) entry. Thedefault value is none.

TSLKeyList (Transaction Level Security Key List)This attribute contains the list of transaction security keys for thisuser. CICS uses this to control access to transactions. You can specifyup 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 areallowed for this user. Therefore, you must include the security keys ofall transactions needed by this user. The following example of aTSLKeyList 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 furtherinformation about transaction security, see the CICS AdministrationGuide. The default value is 1.

TraceFile (User Trace filename)This ASCII text attribute contains the file name to which CICS writesuser trace information. The file is located in the directory defined bythe UserTraceDirectory attribute in the Region Definitions (RD). Thedefault value is "".

Chapter 2. Resource definition commands and offlineutilities

About the CICS commands

CICS commands can be used to configure and control your CICS system. ForWindows NT, they are also used indirectly by the graphical user interface thatis invoked by the command tsconfig.

Several commands have prerequisite tasks or conditions that must be metbefore you can use the command. One of these conditions requires that youare logged on as a user with root (For Open Systems) or administrator (forWindows NT) privileges.

CICS on Open Systems onlyA user with root privileges is any userid that has system as the primarygroup. 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 theprocess is zero.) Even if a userid may meet the above criteria, but thereare some commands that must be run by the native root userid.

CICS for Windows NT onlyFor Windows NT, a user with administration privileges is any useridthat is a member of the group Administrators.

The following list describes how to use the CICS commands:

PurposeDescribes the purpose of the command.

SyntaxShows the syntax of the command flags and parameters.

Prerequisite Tasks or ConditionsWhere applicable, the command reference information lists tasks orconditions that must take place before the command can be used.

DescriptionWhere necessary, provides a detailed description of how the commandis used.

OptionsDescribes the purpose of each flag and parameter used with thecommand.

Returned ValuesWhere applicable, lists each possible value returned and describes themeaning of it.

ExamplesProvides examples of command usage and describes what theexample is used for.

Resource definition commands

cicsadd - Add CICS resource definitions

AIX HP-UX Sun Solaris Windows NT

X X X X

Use this command to add new CICS resource definitions.

Syntax

cicsadd -c className [-r regionName] [-P | -B] [-f fileName] [-m modelId]resourceName [attributeName=attributeValue ... ]

cicsadd -?

Description

The Resource Definition Online (RDO) command cicsadd adds a resourcedefinition of a given class to the permanent resources database, and can installa resource definition into the runtime database.

All resource attributes are optional. If you do not set an attribute, its value isobtained from the resource definition defined by the -m parameter or from thedefault resource definition if you do not specify a model. You can usecicsupdate to modify the default definition.

The cicsadd command initializes the data structures for the resource withdefault values from the reserved resource default, before overwriting themwith your specified values. Stopping the command before completion canresult in a damaged database. The command returns 0 if the run is successful,1 otherwise.

Options

-c classNamedetermines the resource class to which the resource definition is to beadded, and is one of these two- or three-character codes:

cd Communication

fd Files

gd Gateways

gsd Gateway Servers

jd Journals

ld Listeners

od Objects (AIX only)

cicsadd

Chapter 2. Resource definition commands and offline utilities 91

pd Programs

scd SFS Schemas

ssd SFS Servers

td Transactions

tdd Transient Data Queues

tsd Temporary Storage Queues

ud Users

wd Terminals

xad Products

-r regionNamespecifies the region to which the resource definition is added. If youdo not specify a region name, CICS adds the resource definition to theregion specified by the CICSREGION environment variable.

The -r parameter is invalid if you specify scd, ssd, or gsd as theresource class, because these classes are associated with a collection ofregions rather than with a specific one.

-m modelIdspecifies the model used to supply the values for the definition thatare not explicitly given in the attributeName=attributeValue pairs. If youdo not specify a model, values for omitted attributes are obtainedfrom the default definition. If the named model does not exist, anerror is generated.

-f fileNamespecifies the file that contains the schema definitions. This flag is validonly when you specify scd (SFS schema definitions) as the resourceclass.

-P instructs the command to add the resource definition to thepermanent database, without installing it into the runtime database.This is the default option if you do not specify either the -P or -Boptions.

-B instructs the command to add the resource definition to thepermanent database and then to update the runtime database andinstall the resource definition in a running system.

The -B flag is invalid if you specify gsd, scd, ssd, or xad as theresource class. If you are using DCE authentication, you must beauthenticated as a DCE principal before running the command withthis flag.

cicsadd

resourceNameis the name of the resource definition to be added.

attributeName=attributeValue ...are the names and values of attributes for which you do not wish touse the default values or the values from the specified model.

If you are using cicsadd from the command line and you want to usea metacharacter within an attribute value, you must use the shellescape mechanism. For example, to use a value of **, enter one of thefollowing:"**"\*\*'**'

You must use the pipe (|) character as the separator for multipleentries into Transaction Security Level (TSL) and Resource SecurityLevel (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 ofthe resource.

-? causes the usage message to be displayed.

Examples1. To add a definition for the file TEST in the region REGION1 in the permanent

database only:cicsadd -c fd -r REGION1 -P TEST ActivateOnStartup=yes

2. To add a definition for the program PROG1 in the region REGION2 in boththe 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 definition for journal 03 to region rb in both the permanent andruntime databases (the command places the journal files in the same placeas any extrapartition Transient Data Queues defined by the system):

cicsadd -c jd -r rb -B 03 RSLKey=public DiskA=j03a DiskB=j03b

cicsadd

cicscleandce - Remove DCE groups and CDS directories

X X X X

cicscleandce removes the DCE groups and CDS directories created by thecicssetupdce command.

Syntax

cicscleandce [-I] [-v]

cicscleandce -?

Descriptionv Unless you are migrating from a DCE cell environment to a non-DCE cell

environment,you must destroy the regions and SFSs before using thiscommand.

v You must be logged on as a user with root or administrator privilegesv 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 thisgroup. If one of these groups or directories does not exist, cicscleandcecontinues so you can use this command to clean up a partially successfulexecution of cicssetupdce. Errors, such as a failure to delete a CDS directory,forces cicscleandce to terminate abnormally unless the -I flag is used.

The following DCE groups are deleted:v cics_adminv cics_sfsv cics_ppcgwyv cics_regionsv cics_users

The following CDS directories are deleted:v /.:/cicsv /.:/cics/sfsv /.:/cics/ppcv /.:/cics/ppc/gatewayv /.:/cics/trpcv /.:/cics/tmxa

cicscleandce

v /.:/cics/profile

CAUTION:Do not use cicscleandce if you have any servers or regions configured orrunning.

Options

-I (Uppercase i) Ignores errors. Error messages are changed to warningmessages and cicscleandce continues.

-v (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, firstlog in as root or administrator and then authenticate as cell_admin, and thenenter:

cicscleandce -I

cicscleandce

cicscopystanza command

X X X X

Copies a complete stanza, or resource definition file, for a given class fromone region database to another.

Syntax

cicscopystanza [[-w] -s sourceRegion] -t targetRegion -c className -kresourceName

cicscopystanza -?

Description

The cicscopystanza command is used when an upgrade of CICS contains newdefault entries in the region database, for example, a new supplied transactionor a new model terminal. cicscopystanza adds appropriate default entries tothe region database.

The cicscopystanza commands are generated automatically and are includedin 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 specific default entry to your region, or you do notwant to add a new terminal.

Options

-s sourceRegionspecifies the name of the region supplying the resource definition file.

-t targetRegionspecifies the name of the region receiving the resource definition file.

-c classNamespecifies the class of the resource definition file to copy.

-k resourceNamespecifies the name of the resource definition file to copy.

-? causes the usage message to be displayed

Examples

To copy a user definition for user1 from region1 to region2:cicscopystanza -s region1 -t region2 -c ud -k user1

cicscopystanza

cicscp - CICS control program

X X X X

Configures 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 configuration tool to configure CICSregions and associated servers. It provides an easy-to-use command lineinterface to a CICS configuration which supports a range of users from a newuser, who will be able to configure a default region without any user inputother than the region name, and to an experienced user who will be able tooverride any default value (where there is a purpose in overriding a defaultvalue) and use model definitions to simplify the creation of similarconfigurations.

The commands automate as much as possible of the configuration of amachine to run a CICS region using default values where necessary andimposing some naming conventions. They also provide some flexibility forcustomization within this framework, for example allowing the machine to beconfigured as a DCE client rather than a server. They support the use of anexisting configuration for greater flexibility, for example, allowing the use ofan existing DCE configuration where a configuration such as a secondary CDSserver is required.

It is not intended that cicscp be the sole interface to the configuration of theunderlying stack; rather that it can automate simple configurations. Youshould be aware of this and use the other CICS commands to create morecomplex configurations. This extends to the configuration of CICS itself, ascicscp does not have an update command, so an existing configuration mustalways be altered by the other commands. It is expected that you will beginby doing all the configuration necessary for CICS through cicscp until youneed a sophisticated custom configuration.

cicscp

You must be logged on as a user with root or administrator privileges. Sometasks require you to be authenticated to DCE. If you are using DCEauthentication, cicscp prompts you for a password if you are runninginteractively, you have not set the cell_admin_pw environment variable, andthe cell_admin password is not the default password (-dce-). If you are notrunning 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 logFileproduce a log of activity in logFile.

-v (verbose) Show output of low-level commands used (see note 1).

commandcicscp accepts the following commands:

allcobol (for Open Systems)dceppcgwy_server (for Open Systems)regionsfs_serversnasna_link (for Open Systems)telnet_server

-? is the flag which produces the usage message.

If no arguments are supplied to cicscp it enters an interactive mode in whichyou can enter a sequence of commands.

Notes:

1. In normal operation, cicscp will only issue a single message indicating ifthe command worked or not.The effects of the -v flag are as follows:a. cicscp will send more messages to stderr identifying the step being

performed, for example creating the DCE configuration.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.

cicscp

New users of cicscp commands should always use the -v and -l logFileoptions, in order to understand and keep a record of what is happening.

2. In the following pages the cicscp commands are grouped by object. Forexample, all the commands that affect the DCE (create, destroy, start, andstop) are together.

Examples1. 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

cicscp

cicscp - all options

X X X X

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, theeffect is to apply the particular command to all objects that cicscp cancurrently manage on the system.

You must be logged on as a user with root or administrator privileges. If youare using DCE authentication, cicscp prompts you for a password if you arerunning interactively, you have not set the cell_admin_pw environmentvariable, and the cell_admin password is not the default password (-dce-). Ifyou are not running interactively, have not set the cell_admin_pwenvironment variable, and the password is not the default, the command fails.

Attention: Always be aware when using the all option that the commandmight destroy, start or stop the wrong objects.

Examples

To remove all CICS processes from the local system, entercicscp destroy all

This will stop all running objects and then destroy them, removing all trace ofCICS processing from the local system. This includes destroying the DCEconfiguration, but does not include the removal of the SFS logical volumes oruser identifiers.

cicscp - all

cicscp - COBOL commands

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 methodfile cicsprCOBOL. If you want to include any special objects or libraries incicsprCOBOL, you must use cicsmkcobol.

cicscp destroy cobol:

The destroy command destroys the Micro Focus COBOL language method filecicsprCOBOL.

Options

-f causes the command to execute without issuing prompts forconfirmation. This only applies when using the cicscp destroy cobolcommand.

Examples

To create the default cicsprCOBOL, enter:cicscp create cobol

cicscp - COBOL commands

cicscp - DCE commands

X X X X

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 configuration for either a server (aCDS server and a security server) or a client. -s parameter is supplied witheither the name or the Internet Protocol (IP) address1 of the machine acting asthe security server for the cell of which the client is to be part. This is notrequired if the DCE Security Server is on the local host.

In addition to the basic DCE configuration, cicscp runs cicssetupdce (ifnecessary) and cicssetupclients to configure DCE for CICS.

If a DCE configuration exists before cicscp is run, as long as it is a validconfiguration cicscp will only create the necessary CICS configuration; it willnot over-write the existing configuration. Thus, it is possible to configure amachine as only a CDS server using the DCE configuration tools and then usecicscp to do the CICS-related configuration.

cicscp destroy dce:

1. Internet Protocol (IP) is the protocol that provides the packet delivery service for TCP, UDP, and ICMP.

The destroy command stops DCE and destroys the DCE configuration of themachine. If you run the command on a client machine and the server isunavailable, cicscp will automatically remove the local configuration but theinformation held in the cell database regarding the machine will have to beremoved manually.

cicscp start dce:

The start command starts the DCE on the machine, creating the defaultconfiguration first if necessary.

cicscp stop dce:

On CICS on Open Systems, the stop command stops the DCE on the machine.

On CICS for Windows NTThe create command configures your machine to run in RPC-only mode,that is without using DCE authentication or DCE name services.

To create a DCE server configuration see related information in the CICSAdministration Guide.

To create a DCE client configuration see related information in the CICSAdministration Guide.

Options

-R specifies that DCE is to be configured not to use DCE authenticationor DCE name services.

-n cellNamespecifies the name of the cell to be created (with or without “/.../”).The default cell name is “dce_cell.hostName.domainName”.

-s securityServerspecifies the name or IP address of the security server.

-f causes the command to execute without issuing prompts forconfirmation.

Examples1. 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 configure DCE for cell /.../test_cell.hursley.ibm.com, enter:cicscp create dce -n /.../test_cell.hursley.ibm.com

cicscp - PPC Gateway server commands

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. IfCICS is not installed on the same machine as the PPC Gateway server, refer tothe Encina Administration Guide Volume 2: Server Administration manual for analternative procedure.

cicscp create ppcgwy_server:

The create command creates a PPC Gateway server server on the machine. Ifnecessary, cicsdefaultservers is run automatically. It is an error to attempt tocreate a server that is already defined - the old server definition must beremoved first.

Each PPC Gateway server server must have a unique ShortName value in theGateway Server Definitions (GSD), so if one is not supplied as an attributeoverride on the create command, cicscp chooses one which is of the form“PbaseName” where baseName is the firstpart of the server name, truncated toseven characters if necessary.No check is made that this name is unique,therefore the server name must be unique in the first seven characters if thedefault ShortName is to be used. As an example, if the PPC Gateway serverserver “ppcgwysrv1” were created, the default ShortName chosen would be“Pppcgwys” and an attempt to create “ppcgwysrv2” would result in aduplicate ShortName being used and an error.

If the UserID specified in the Gateway Server Definitions (GSD) for the serverdoes not exist, cicscp will create it with the appropriate home directory.

If the DCE is not running, cicscp will start it, creating the defaultconfiguration if necessary.

If the logical volume specified in the LogVolume attribute of the GatewayServer Definitions (GSD) does not exist, cicscp creates it. If it does exist and isowned by the correct user, cicscp issues a warning message. If it exists and isowned by a different user, cicscp issues an error message. The location andsize of the logical volume are controlled by environment variables. Thelocation is controlled by the environment variable CICS_PPCGWY_VG andthe size is controlled by the environment variable CICS_PPCGWY_SIZE. Thereare default values coded into cicscp which means that neither environmentvariable needs to be set if the default values are acceptable. The default size ofthe logical volume created is 4MB. The default location depends on theplatform.

If SNA is not configured on the machine, cicscp issues a warning as the serverwill not be able to be started until SNA is configured and started.

If the DCE name service is not being used for name resolution cicscp adds anentry 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 serverdefinition from CICS, but does NOT remove the user or the logical volume. Ifthe reserved name all is used, all configured servers are destroyed.

cicscp start ppcgwy_server:

The start command starts the server. If necessary, it uses the create commandto create a default server of the correct name.

Note: Any attribute overrides specified on the start command do not affectthe server created implicitly by the start command; they are onlyapplied to the start of the server. Issuing a start command for a serverthat does not exist is equivalent to a create command for that serverwithout any overrides, followed by the start command with theoverrides. This means that there can in such situations be a mismatchbetween the attributes applied to the gateway by default, and theoverrides provided with the start command, resulting in the commandfailing to complete successfully.

If SNA is not configured the start command issues an error messages and thePPC Gateway server server is not started.

If the reserved name all is used, all configured servers are started and anyattribute overrides specified are passed to each server.

cicscp stop ppcgwy_server:

The stop command stops the named PPC Gateway server, or all runningservers if the reserved name all is used.

Options

gatewayServeris the name of the PPC Gateway server. A name that does not beginwith the string “/.:/cics/ppc/gateway/” will have that string addedto the front of the name.

-m modelIdidentifies the existing entry on which the one to be created should bebased.

-f (on cicscp destroy ppcgwy_server)causes the command to execute without issuing prompts forconfirmation.

attributeName=attributeValue ...are overrides for Gateway Server Definitions (GSD) attributes. Formore details, see the CICS Intercommunication Guide, which describeswhich attributes are suited to modification at startup. See also“Gateway Server Definitions (GSD)” on page 14.

-f (on cicscp stop ppcgwy_server)forces the server to stop.

Examples1. To create a gateway server named /.:/cics/ppc/gateway/GwyThree with

attribute overrides, verbose messaging and a log file recording cicscpprocessing, 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 theuserid Gate3 for this gateway.

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.

cicscp - region commands

X X X X

Creates, destroys, starts or stops regions.

Syntax

cicscp create region regionName [-g groupId] [-i fileName] [-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 notrunning, cicscp starts it, creating the default configuration if necessary. If the-i option is specified then cicscp uses cicsimport, otherwise it usescicsdefault. -d option is not specified, cicscp checks that the SFS defined asthe default file server for the region is configured, creates a defaultconfiguration if it is not, and then starts the server if it is not already running.Finally cicscp configures the server for the region.

Before using the region you have created, you may wish to consider using amounted file system for the CICS log file as described in he Planning andInstallation Guide.

cicscp destroy region:

The destroy command stops and then destroys the named region, or allconfigured regions if the reserved name all is used. If the -s option is specifiedwith all it is applied to all regions.

cicscp start region:

The start command starts the named region, or all configured regions if thereserved name all is used. If a single region is started and it is not configured,

cicscp - region

a default region of the specified name is created. Any attribute overridesspecified on the start command are not passed through to the create.

Once the region has been created if necessary, cicscp checks that the necessarySFS and PPC Gateway servers are running, unless the type of server has beendeclared as remote with the -d option.

If SFSs are not declared as remote, cicscp starts the default file server for theregion and then browses each File Definition entry and examines the serverspecified for the file. If it is not running then cicscp starts it. Each of thesestarts could result in the implicit creation of the server if it does not alreadyexist.

If PPC Gateway servers are not declared as remote, cicscp browses theGateway Definitions and starts each server if necessary. Each of these startscould 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 thereserved name all is used.

Options

regionNameis the name of the region.

-g groupIdspecifies the name of the group-id with which all files of the newregion are created.

-l{m|o|c|r}specifies the action that cicscp is to take if it cannot find the target ofa symbolic link. The default action is to terminate the restorationabnormally:

-lm Mandatory. cicscp abnormally terminates the restoration if itcannot find the symbolic target.

-lo Optional. cicscp produces a warning message, creates the link

cicscp - region

and continues restoration if it cannot find the symbolic target.This allows you to restore further regions that resolve themissing links.

-lc Continue. cicscp overrides any symbolic link requirementsdefined as part of the cicsexport command.

-lr Resolve. If cicscp cannot find the symbolic target, it restores aphysical copy of the missing definition, and produces awarning message.

-i fileNamespecifies the file name of the archive copy of the resource definitions,in cpio format. If you do not specify the -i flag, the file is read fromstdin.

-d (on cicscp create region)indicates a distributed configuration. If this option is used, cicscp willnot check for the presence of the SFS. It will assume that the SFS isdefined on a different machine and that therefore its status cannot bechecked.

-o instanceNamespecifies the name of the instance of DB2.

-a aliasNamespecifies the name of the DB2 database to be used as the file server.This name is stored in the DefaultFileServer attribute in the RegionDefinitions (RD).

-u userNamespecifies the name to be used for explicit authentication. If thisparameter is specified it will form part of the XAOpen string in theProduct Definitions (XAD) entry.

-n specifies the creation of a system-defined Product Definitions (XAD)entry specifying non-XA integration.

-s (on cicscp create region)suppresses the creation of a system-defined Product Definitions (XAD)entry

all used with destroy, start or stop, causes cicscp to apply the commandto all configured CICS regions.

-f (on cicscp destroy region)causes the command to execute without issuing prompts forconfirmation.

-f (on cicscp stop region)forces an immediate shutdown.

cicscp - region

-s (on cicscp destroy region)causes the deletion of file server definitions for TD, TS and localqueues.

-d distributedServers (on cicscp start region)indicates a distributed configuration. Valid values for distributedServersare:

allsfs_serverppcgwy_server“ppcgwy_server sfs_server”

-c forces a cancel shutdown. cicsnotify is run automatically.

attributeName=attributeValue ...are the overrides for Region Definitions (RD) attributes. See “RegionDefinitions (RD)” on page 32.

Examples1. To create a region called REGION1, copying the definitions from a file 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 filerecording cicscp processing, enter:

cicscp -v -l /tmp/cicscp.log start region TestReg

This will create the region TestReg (using cicsdefault) and will configure itfor the default SFS. Additional processing will be done for SFS and DCEas necessary.

cicscp - region

cicscp - SFS commands

X X X X

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 aserver that is already defined - the old server definition must be removedfirst.

Each SFS server must have a unique ShortName value in the Structured FileServer Definitions (SSD) so if one is not supplied as an attribute override onthe create command, cicscp chooses one which is of the form “SbaseName”where baseName is the last part of the server name, truncated to the first sevencharacters if necessary. No check is made that this name is unique, thereforethe server name must be unique in the first seven characters if the defaultShortName is to be used. As an example, if the SFS server “sfssrv1” werecreated, the default ShortName chosen would be “Ssfssrv1” and an attempt tocreate “sfssrv11” would result in a duplicate ShortName being used and anerror.

If the UserId specified for the server in the Structured File Server Definitions(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 defaultconfiguration if necessary (on Open Systems). On Windows NT cicscp starts itonly if the DCE is already configured.

cicscp - SFS

There are two logical volumes associated with each SFS server: the logicalvolume for the file data, specified by the Structured File Server Definitions(SSD) attribute DataVolume, and the logical volume holding the recoveryinformation, specified by the attribute LogVolume.

If either logical volume specified does not exist, cicscp creates it. If either doesexist and is owned by the correct user, cicscp issues a warning message. Ifeither exists and is owned by a different user, cicscp issues an error message.

The location and size of each logical volume are controlled by environmentvariables. There is a pair of environment variables that controls both logicalvolumes and there is also a separate pair for each logical volume, allowingeach to be controlled separately. If one of the environment variablescorresponding to a particular logical volume is set, it takes priority over thecorresponding general environment variable.

The location is controlled by the general environment variable CICS_SFS_VGand the separate environment variables CICS_SFS_DATA_VG andCICS_SFS_LOG_VG. The size is controlled by the general environmentvariable CICS_SFS_SIZE and the separate environment variablesCICS_SFS_DATA_SIZE and CICS_SFS_LOG_SIZE. There are default valuescoded into cicscp which means that none of these environment variablesneeds to be set if the default values are acceptable. The default size of boththe data and log logical volumes is 64MB. The default location depends onthe 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 anentry 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 serverdefinition from CICS, but does not remove the user or the logical volumes. Ifthe reserved name all is used, all configured servers are destroyed.

cicscp start sfs_server:

The start command starts the server, creating a default server of the correctname if necessary.

Note: Any attribute overrides specified on the start command do not affectthe server created implicitly by the start command; they are onlyapplied to the start of the server. Issuing a start command for a serverthat does not exist is equivalent to a create command for that serverwithout any overrides followed by the start command with theoverrides. This means that there can in such situations be a mismatch

cicscp - SFS

between the attributes applied to the server by default, and theoverrides provided with the start command, resulting in the commandfailing to complete successfully.

If the reserved name all is used, all configured servers are started and anyattribute overrides specified are passed to each server.

cicscp stop sfs_server:

The stop command stops the named SFS gateway server, or all runningservers if the reserved name all is used.

Options

serverNameis the name of the server. A simple name (one without a leading“/.:/cics/sfs/” string) will have the string added to the front of thename.

-m modelIdidentifies the existing entry on which the one to be created should bebased. If you do not specify a name, the server is modeled on thedefault Structured File Server Definitions (SSD).

attributeName=attributeValue ...are the overrides for Structured File Server Definitions (SSD)attributes. See “Structured File Server Definitions (SSD)” on page 61.

all used with destroy, start or stop, causes cicscp to apply the commandto all configured or running servers.

-f (on cicscp destroy sfs_server)causes the command to execute without issuing prompts forconfirmation.

-f (on cicscp stop sfs_server)forces an immediate shutdown.

Examples1. To create an SFS named /.:/cics/sfs/SrvOne with attribute overrides,

verbose messaging and a log file recording cicscp processing, enter:

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 specifyingShortName=Sfs2 would not work because the ShortName defaultwould have been used during the create.

3. To start all SFSs, assuming that they can all be autostarted, enter:cicscp start sfs_server all

cicscp - SFS

cicscp - SNA commands

On Open systems this command creates, destroys, starts or stops SNA whileon 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, activatesand verifies an SNA configuration. Following this command, the node isready to operate as a node on an APPN network.

On CICS for Windows NT the cicscp start/stop sna commands try to start orstop the IBM Communications Server. If this server is not found, thecommands try to start or stop the Microsoft SNA Server.

If you are using DCE authentication and the task you are performing requiresyou to be logged in as the DCE cell administrator, cicscp prompts you for apassword if you are running interactively, you have not set thecell_admin_pw environment variable, and the cell_admin password is not thedefault password (-dce-). If you are not running interactively, have not set thecell_admin_pw environment variable, and the password is not the default, thecommand fails.

For more information, see the CICS Intercommunication Guide.

Options

-d nodeNamespecifies the name of the SNA node.

-w networkNamespecifies the control point name of the local SNA node.

cicscp - SNA

-x XIDnamespecifies the exchange identifier associated with the control pointname of the local SNA node.

-y stationTypespecifies an initial link station type. For CICS for AIX, any typesupported by SNA Services is valid.

-q stationNamespecifies the name of the initial link station. If a dynamic listening linkstation is required this value can be omitted. This type of station isonly supported over token ring and ethernet.

-s stationAddressspecifies 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 localSecondaryStationAddressspecifies the local secondary station address for SDLC link stations.

Examples

On CICS for AIX, to create an SNA node called AIX00005 using a token ringwith 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

cicscp - SNA

cicscp - SNA link commands

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 requiresyou to be logged in as the DCE cell administrator, cicscp prompts you for apassword if you are running interactively, you have not set thecell_admin_pw environment variable, and the cell_admin password is not thedefault password (-dce-). If you are not running interactively, have not set thecell_admin_pw environment variable, and the password is not the default, thecommand fails.

The cicscp create sna_link command creates and verifies an SNA link.

Options

stationNameis the name of the link station.

-y stationTypespecifies an initial link station type. For CICS for AIX, any typesupported by SNA Services is valid.

-s stationAddressspecifies 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 localSecondaryStationAddressspecifies the address of the local secondary station for SDLC linkstations.

The environment variable XID_NODE_ID is required to be set. This identifiesthe XID name of the PU concerned.

Creation of token ring link stations (type LLC2) requires a token ring stationTRN-O to be defined in the running Peer Server. Local SNA configuration file

cicscp - SNA link

creation will create this.

cicscp - SNA link

cicscp - telnet server commands

X X X X

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 configuration that can be usedwith inetd. On Windows Nt inetd runs as an NT Service. A shell script isautomatically created in /var/cics_clients for each telnet server created bycicscp containing the arguments to the cicsteld command.

-p option, it is added to the DCE group cics_users if it is not already in thegroup. If no keytab file is specified using the -k option, cicscp creates one in/var/cics_clients.

If no principal is specified, no DCE principal or keytab file will be created. Ifyou are not using DCE authentication or if you are using DCE authenticationbut you want to use the default keytab file created in /var/cics_clients bycicssetupclients, then you should not specify a principal.

The -m flag allows all parameter values except netName (which must beunique) to be copied from the telnet server named with the -m parameter. Itmay not be possible for cicscp to retrieve the parameter values from themodel server if the server was not created by cicscp, or the shell script hasbeen edited after the server was created.

cicscp destroy telnet_server:

The destroy command destroys a telnet server configuration, but it does notremove the DCE principal.

If you are using DCE authentication and the task you are performing requiresyou to be logged in as the DCE cell administrator, cicscp prompts you for a

cicscp - telnet server

password if you are running interactively, you have not set thecell_admin_pw environment variable, and the cell_admin password is not thedefault password (-dce-). If you are not running interactively, have not set thecell_admin_pw environment variable, and the password is not the default, thecommand fails.

Options

serverNameis the name of the server. This name must be different from everyother name used in the file /etc/services. cicscp create telnet_serverwill add an entry to /etc/services for the specified server and cicscpdestroy telnet_server will delete the entry.

-P portNamespecifies the port to be used. This port name must be unique, and willbe chosen automatically if omitted.

-c clientCodesetspecifies the client codeset.

-e emulationspecifies the type of 3270 to emulate.

-h hostListspecifies a blank-delimited list of names or addresses of hosts to besearched for the specified region. If a list of host names is notspecified, the contents of the environment variable CICS_HOSTS willbe used. If the environment variable CICS_HOSTS is not set, the localmachine will be searched.

-k keytabFilespecifies the name of the keytab file. -k option is not specified but the-p option is used, then cicscp will create a keytab file.

-l localeNamespecifies the name of the locale.

-m modelIdspecifies the model definition on which the one to be created shouldbe based.

-n netNamespecifies the network name.

-p principalNamespecifies the name of the principal to be used for DCE authenticationof this CICS telnet server.

-r regionNamespecifies the region to connect to. If no region is specified, a menu ofregions will be displayed.

-s serverCodesetspecifies the server codeset.

-t transIdspecifies the initial transaction. The default is CESN.

Examples

To create a telnet server called TELNX1 on port 9001 listening for a request toaccess REGION1, enter:

cicscp create telnet_server TELNX1 -P 9001 -r REGION1

cicscvt - Create data conversion table

X X X X

cicscvt is used to build conversion templates from DFHCNV macroconversion files.

Syntax

cicscvt fileName

cicscvt -?

Description

The cicscvt command is a utility that converts a macro source conversiontable containing DFHCNV macros into a conversion template for eachresource defined in the table.

cicscvt creates a conversion template for each DFHCNV macro in the inputfile. The name of the conversion template created isresourceName.resourceType.cnv, where resourceName is the name coded as theRNAME parameter, and resourceType is the type coded as the RTYPEparameter. To use the template it must be moved or copied to

/var/cics_regions/regionName/database/resourceType/resourceName.cnv

Options

fileNamespecifies the name of the file to be processed.

Returned Values

0 The table was successfully converted.

non-zeroThe templates were not created successfully.

Examples

If file TESTCNV contains the macro:DFHCNV TYPE=ENTRY,RTYPE=PC,RNAME=TEST

it can be converted and installed for region regionName by using thecommands:

cicscvt

cicscvt TESTCNVmv TEST.PC.cnv /var/cics_regions/regionName/database/PC/TEST.cnvOR

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 onWindows NT.

cicscvt

cicsdb2conf - Configure DB2

X X X X

You use this command to configure CICS resource definitions for DB2 and toconfigure DB2 to manage CICS queues and files.

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 configures the resource definitions in the CICSregion to meet the requirements of DB2 and adds the necessary tables to theDB2 database. You run cicsdb2conf from the operating system command line.

Options

-I causes non-critical errors to be ignored.

-m specifies that cicsdb2conf should set the IndexName for each filedefined in the File Definitions (FD) by appending “0” to its key.

-r regionNamespecifies the name of the CICS region for which you are configuringDB2.

-l logFileNamespecifies the name of the file to be used for logging configurationmessages. If this parameter is not specified the fileregionName/data/cicsdb2conf.log will be used.

-C specifies the complete configuration of DB2 for the region and theconfiguration of the region resources for DB2. The flags -i, -a, -n, -f, -s,-u and -l are valid when this option is specified.

-i instanceNamespecifies the name of the instance of DB2.

cicsdb2conf

-a aliasNamespecifies the name of the DB2 database to be used as the file server.This name is stored in the DefaultFileServer attribute in the RegionDefinitions (RD).

-f By default, the Fileserver attribute for all File Definitions (FD) entriesis set to NULL and the default specified by the DefaultFileServerattribute in the Region Definitions (RD) is used. If this option isspecified the FileServer attributes are not set to NULL.

-n specifies the creation of a system-defined Product Definitions (XAD)entry specifying integration through the DB2 single-phase commitoptimization. If this flag is not specified cicsdb2conf will place a newdefault entry in the XAD that will allow the region to connect to thealiasName database through the XA interface.

-s suppresses the creation of a system-defined Product Definitions (XAD)entry. An XAD entry is required in order to specify a DB2 databasethat will manage the CICS region’s queues and files. If this flag is notspecified cicsdb2conf will create a new default entry in the XAD thatwill allow the region to connect to the aliasName database. The use ofthis flag allows you to define your own XAD entry for the aliasNamedatabase.

-u userName[,password]specifies the user name to be used for explicit authentication. If thisparameter is specified, it forms part of the XAOpen string in theProduct Definitions (XAD) entry. If the password is not specified,CICS prompts you to enter it.

-g grant minimum privileges. If this flag is specified, cicsdb2conf willgrant EXECUTE authority to allow the userid that CICS uses toconnect to the database to execute the CICS file and queuemanagement package.

If this flag is not specified, cicsdb2conf will grant DBADM authorityto the userid that CICS uses to connect to the database.

-S specifies that a table for recoverable auxiliary TSQs is to be created.The name of the table will be regionNameREQTSQ#. The table will berecoverable.

-N specifies that a table for non-recoverable auxiliary TSQs is to becreated. The name of the table will be regionNameNREQTSQ#. Thetable will be recoverable since non-recovereable tables are notsupported by DB2.

-D specifies that a table for logically recoverable TDQs is to be created.The name of the table will be regionNameLOGTDQ#. The table will berecoverable.

cicsdb2conf

-P specifies that a table for physically recoverable TDQs is to be created.The name of the table will be regionNamePHTDQ#. The table will belogically recoverable since physically recoverable tables are notsupported by DB2.

-T specifies that a table for non-recoverable TDQs is to be created. Thename of the table will be regionNameNREQTDQ#. The table will berecoverable since non-recoverable tables are not supported by DB2.

-L specifies that a table for locally queued protected STARTs is to becreated. The name of the table will be regionNameLQPROT#. The tablewill be recoverable.

-Q specifies that a table for locally queued unprotected STARTs is to becreated. The name of the table will be regionNameLQUE#. The tablewill be recoverable.

Returned Values

0 DB2 has been configured.

non-zeroThe attempt to configure DB2 was unsuccessful.

Examples1. To configure DB2 for REGION1 with default parameters, using alias

CICSTEST for instance DB2USER:cicsdb2conf -r REGION1 -C -i DB2USER -a CICSTEST -n

cicsdb2conf

cicsdb2import - Build metadata for DB2

X X X X

Use this command to define files to a DB2 database.

Syntax

cicsdb2import -i schemaFileName [-d databaseName] [-u userName [-p passWord]] [-I] [-f fileName [-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 file containing the necessary file definitions. A

schema file can be created by using cicsadd -cscd ... or by using SMIT onCICS for AIX or SAM on CICS for HP-UX.

Description

The cicsdb2import command allows you to create files on a DB2 databasebased on the information provided in a schema file. You can specify whichdatabase a file is to be created on, and you can optionally select which filesare created from those defined within the schema. You can also select whichindexes are to be created from those defined for a particular file in theschema.

You run cicsdb2import from the operating system command line.

Options

-i schemaFileNamespecifies the name of the file containing the schema definition.

-d databaseNamespecifies the name of the database to which connection is required. Ifthe name of the database is not specified, the name contained in theenvironment variable DB2DBDFT is used.

cicsdb2import

-u userNamespecifies the name of the user to be used for explicit authentication. Ifthe user name is not specified, implicit authentication is used.

-p passWordspecifies the password to be used for explicit authentication. If thepassword is not specified, you will be prompted to enter thepassword.

-f fileNamespecifies the name of the file to be loaded from the schema. If no filename is specified, all files in the schema are loaded.

-x indexNamespecifies the name of an index to be loaded. If no index name isspecified, all indexes for the specified file are loaded.

Returned Values

0 The file or files were successfully loaded into the database.

non-zeroThe import operation was unsuccessful.

cicsdb2import

cicsddt - DB2 diagnostic tool

X X X X

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 -?

Descriptionv 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 bein any order.

-s databaseNamespecifies the name of the DB2 database. For example, cicstest. If thisoption is not specified, the server name in the environment variableCICS_XDT_SERVER or DB2DBDFTis used.

-i inputFilespecifies a text file containing DDT commands to be read andexecuted. The file can be created either by hand or by using the -ooption. Each line of the input file is treated as if it were typed ininteractive mode. The text from the input file is also displayed as it isprocessed by cicsddt. Comments can be included in the file bystarting a line with “/*”.

For example, if you create a file called create.input that contains thefollowing lines:/*/* This is a sample file to create a table called qsamtest/*create cics.qsamtestkflchar10f2

cicsddt

varchar100

Then execute cicsddt as follows:cicsddt -s databaseName -i create.input

A new table called CICS.QSAMTEST is created on the specifieddatabase.

-o outputFilecauses commands entered in the DDT session to be written to thespecified output file. This file can then be used as an input file usingthe -i option.

-e requests DDT to terminate if an error occurs. If -e is specified andDDT 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-zeroreturn code.

-r activates DDT statistics. Statistics for DDT and DB2 calls are sent to afile called ddt.stats in the current directory. This is useful formonitoring performance.

-c DDTcommands ...specifies a list of commands and text to be used in the DDT session.This is useful for calling DDT commands from a shell script. Thisparameter must be used last.

Using the DDT commands: To issue commands in DDT, pass them to DDTusing the -i or -c option, or type the command at the command prompt. DDTaccepts command abbreviations. In the command syntax the minimumabbreviation is shown in parentheses; for example, (c)reate. Any commandthat requires a file name will default to the last name used if nothing is givenat the prompt. DDT also recognizes any environment variables used at thecommand prompt.

DDT commands - list

(l)ist [(l)] searchString

Lists all the tables on the database that DDT is accessing. l option isused,additional information is given for each table. Only tables ownedby the user cics will be shown. A search string can also be given tolist specific files. If a search string is used, DDT will look for all the

cicsddt

filenames 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 Organisation Primary Index No. Records======================= ==================== ============== ===========CICS.JIM6CICSNLQFILE Key-Sequenced (KSDS) CICSNLQIDX (empty)CICS.JIM6CICSNRECTSQFIL Key-Sequenced (KSDS) CICSNRECTSQIDX (empty)CICS.JIM6CICSPLQFILE Key-Sequenced (KSDS) CICSPLQIDX (empty)CICS.JIM6CICSRECTSQFILE Key-Sequenced (KSDS) CICSRECTSQIDX 2CICS.JIM6CICSTDQLGFILE Key-Sequenced (KSDS) CICSTDQLGIDX 11CICS.JIM6CICSTDQNOFILE Key-Sequenced (KSDS) CICSTDQNOIDX (empty)CICS.JIM6CICSTDQPHFILE Key-Sequenced (KSDS) CICSTDQPHIDX (empty)

DDT commands - create

(c)reate tableName

Creates a new DB2 table. All the table information is prompted for inturn. To aid usability and eliminate creation errors, DDT will validateas much as possible and default to sensible values where appropriate.One exception is the table column name and index column name thatuse an empty entry to indicate there are no more columns. If q! isentered 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 thebeginning of the table or from a specific key based on any existingindex. Rows can also be read continuously or individually. When akey value is specified it is taken as a string unless it is in the format

cicsddt

#n, where n is a numeric value. The following format can be used fora hexadecimal representation of the key:0x0a01 ...

If the read is not continuous you have the option to delete or updateeach row read. If nothing is entered for a column during an updatethe column is left unaltered, otherwise data entry is same as for thewrite command. The read command will only show up to 44 bytes ofcolumn data and should therefore not be used to check the dataintegrity of tables containing long columns. The dtof command ismore 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... ][000010]

[Hex][4B455930303031000000 ][F2 ][Data providing information about KEY0001 ][000040]

[Hex][446174612070726F766964696E6720696E666F726D6174 ]

[Read Another, Delete or Update ? [Y]/N/D/U n

[1 Record(s) Read]

DDT commands - write

(w)rite tableName

Writes rows to a CICS DB2 table. Text or hexadecimal data can beentered in each column; these cannot be mixed. Hexadecimal isentered in the following form:0x010203 ...

If the column is long and you need to enter a large amount of data, ashorthand method can be used. For example, to fill the remainder of acolumn with 33 ’A’ characters enter:A>>32

or enter0x20>>32

for 33 spaces.

cicsddt

You must enter something in at least one of the columns in the rowfor DDT to write a complete row; if all are left blank no row will bewritten. If A>>32 would exceed the column length the string “A>>32”is taken literally.cicsddt -s cicstest -c -w qsamtest

[F1 ][ CHAR ][ Size:00010][KEY0000002[F2 ][ VARCHAR ][ Size:00100][This the data that comes with KEY 2

[Another ? [Y]/N n

[1] Record(s) Added OK.

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 cancelthe 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

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 connectto a new DB2 database. If the new connection fails DDT willreconnect 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. Ifconnection with the new user fails, DDT reconnects with the old userand password.cicsddt -s cicstest -c u acooke,jg8wq9z

ERZ037172I/0738: (Database OK)

DDT commands - qtod

(qt)od QSAMfileName

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

cicsddt

(dt)of DB2tableName

Transfers a CICS DB2 table to a flat table. The format of the flat filecan either be DDT format or Asis (the table is transferred byte by byteas it is). In DDT format the flat file starts with a header containinginformation on the structure of the table, followed by anend-of-header marker. The remainder of the flat file contains theactual records that are in the format: a newline character, followed byan eight-byte ASCII number, followed by the actual data.The numberis the length of the row excluding the number itself. If the table istransferred Asis, no extra information is contained in the flat file. Asingle record or a range of records can be dumped. The recordnumber corresponds to the position of the row using the primaryindex. To dump row 10 enter 10 at the [Dump Row(s)] prompt. Type10- to dump rows from 10 onwards and type 10-12 to dump rows 10to 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 flat table produced from the dtof command to a CICS DB2table. If the flat table is not in DDT format then dtof will still attemptto transfer the file as normal text or binary. If the DB2 table does notexist and the flat file is in DDT format, DDT will ask you if you wantthe file to be created. DDT also reads and transfers flat files created bycicssdt (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 commandprompt returns control to DDT.cicsddt -s DB2name -c !

[Exit To Shell. Use <Ctrl-D> To Return .....

cicsddt

ls q* (Open Systems)dir q*.* /w (Windows NT)qsam qsam.dfh qsamTest qsamcsd.ddt.defqsam.conv qsam.log qsamcsd qsamcsd.ddt.logqsam.def qsam.ddt.def qsamcsd.dfh qtest

DDT commands - quit

Exits DDT and returns control to the calling process.

(q)uitcicsddt -s cicstest -c q

DDT commands - help or ?

(h)elp (or ?) commandName

Gives general or specific online help for DDT commands.cicsddt -s cicstest ? create

DDT commands - QSAM to DB2 file transfer

The purpose of this section is to help you understand how to transferQSAM files from a IBM mainframe-based CICS system to a CICS onOpen Systems system (the target system).

When a file is sent directly to a target system, record boundaries arelost when it is received. By capturing the file on TSO or CMS innetdata format and sending it as a binary file to the target systemusing the File Transfer Program (ftp), the original netdata format ispreserved.

The cicsnetdata program is used to read the file and re-construct theoutput records with the count preceding each record, as expected bythe cicsddt qtod command.

If a file is in netdata format, you will find that control recordsINMR01, INMR02, INMR03 precede the data, and INMR06 followsthe data; these names are in EBCDIC. All input (control records anddata) is segmented. The first byte of a segment contains the segmentlength, including itself. The second byte of the segment contains a flagbyte. The flag settings are:0x80 first segment0x40 last segment0x20 segment is part of a control record

To transmit a file from TSO:

1. Enter: TRANSMIT (nodeName/userId) DSN(data.file)OUTDSN(data.NETDATA) SEQTRANSMIT can be abbreviated to XMIT.

cicsddt

nodeName/userId is required syntactically. Although it is not used whentransmitting to a file, it is validated, so specify a known node and userid.DSN names the input to XMIT.OUTDSN names the output netdata file. The type NETDATA is suggested.If the input was a PDS member, then SEQ is required, or the file will notbe usable on the target system. The name of utility function must beINMCOPY 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 file name can also be specified, if different from the source.Make a note of the byte count, which should be the same for the file onthe target system. The target system keeps the name in lower case, eventhough it was upper case in TSO.

To transmit a file from CMS:

1. Enter: sendfile dataFile TO *to send the file to your reader in netdata format. Do not RECEIVE it,because RECEIVE will decode the netdata. Use CP commands to ORDERit and CHANGE its CLASS to suit the reader. Define a temporary disk ifthe file is large.

2. Enter: read data NETDATA A to read the file and preserve the netdataformat.

systemName is the name of the target system.Enter userid and password when prompted.

The target file name can also be specified, if different from the source.Make a note of the byte count, which should be the same for the file onthe target system. The target system keeps the name in lower case, eventhough it was upper case in CMS.

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 80... origin node name WINVMB... origin userid BAILEYM... target node name WINVMB... target userid *... origin time stamp 19931029164640000000... no of files 1... control record: INMR02... file number 1... file size in bytes 2048... file organization 4000... logical record length 80... name of utility function INMCOPY... record format 8000... name of the file A DATA FILE... filemode number0... last change date 19920611095242000000... control record: INMR03... file size in bytes 2048... file organization 4000... logical record length 80... record format 0001... control record: INMR06... 22 input records... 4 control records... 18 output records

Definition files used by qtod:

In addition to the QSAM data file produced by the cicsnetdata program theremust be two other definition files for a successful conversion:v QSAMfileName.ddt.def

This file must be in the same directory as the QSAM data file. It containsthe key and data information about each QSAM record.The sample file qsam.sdt.def, describes what each tag means. A sampledata file can be found in prodDir/src/examples/sdt. The file must berenamed to qsam.ddt.def for qtod to pick it up. The tag SFSFile=qsamtestmust also be changed to DB2File=CICS.QSAMTEST.

v QSAMfileName.dfhThis file must also be in the same directory as the QSAM data file and isthe DFHCNV template source for the QSAM records. DDT will not validatethis file so it is recommended that the file is checked using the cicscvtprogram first. DDT only understands the source, not the compiled outputfrom cicscvt. The sample file qsam.dfh shows a typical template.

cicsddt

To run qtod:

A sample QSAM data file qsam.netdata has been provided to demonstrateQSAM to DB2 conversion using the qtod command. The following describesthe 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 file called qsam in the current directory.2. Create a suitable DB2 table to receive the QSAM records. For this example,

entercicsddt -s DB2name -c create qsamTest

3. Make sure you have the following files in a directory you can write to:qsamqsam.dfhqsam.ddt.def

The default code pages for conversion are defined at the top of the tableqsam.dfh; these may have to be changed, depending on your operatingsystem.

4. Run cicsddt so that it is working with the database that hasCICS.QSAMTEST on it, Enter:cicsddt -s DB2name -c qtod qsam

The file qsam must be in the current directory. DDT will show a runningcount of the records being transferred. If an error occurs the table must beemptied before it is reloaded.

5. When the command has finished the DDT prompt should reappear and alog file will have been created in the current directory. The file will becalled qsam.ddt.log in this example. Check this log file to make sure DDTpicked up all the record types and there were no conversion errors.

cicsddt

cicsdefault - Create a copy of the default region

X X X X

The purpose of the cicsdefault command is to allow you to restore an archivecopy of the resource definitions from the default CICS region.

Syntax

cicsdefault -r regionName [-g groupId] [-v] [-S] [-F]

cicsdefault -?

Descriptionv 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 definitions from the defaultCICS region to your new region. You run cicsdefault from the operatingsystem command line. The resource definitions that cicsdefault restores are:v All configuration files except those defining the SFS. These will have to be

reconfigured.v All resource definitionsv Conversion templatesv All programsv All mapsv All Java classesv The contents of the region’s data directory.

The region environment and region properties files are not restored. You areprompted for your DCE password if you are using DCE authentication.

cicsdefault

Options

-r regionis the name of the new region. Do not use underscores or the word“stanza” in the region name.

-g groupIdis the name of the operating system’s groupId with which all files ofthe new region are created. The default groupId is cics (OpenSystems) or cicsgroup (Windows NT).

-v (verbose) lists the files as they are restored.

-S causes the new region to be set up without using DCE servers. TheRegion Definitions (RD) attributes NameService andAuthenticationService will be set to none and CICS respectively.

-F forces the region to be overwritten if the region already exists, butdoes not recreate DCE and the entries in the operating mechanismused for starting and stopping long running processes if they alreadyexist.

Examples1. To create region REGION1:

cicsdefault -r REGION1

2. To overwrite the resource definitions of REGION2, when REGION2 alreadyexists:

cicsdefault -r REGION2 -F

cicsdefault

cicsdefaultservers - Create default resource files for servers

X X X X

Creates the default resource files for the SFS, SFS schemas and PPC gatewayservers. (Open Systems) and for the SFS schemas (Windows NT).

Syntax

cicsdefaultservers [ -s | -c | -p ]

Description

cicsdefaultservers creates the following default resource files for the:

SFS /var/cics_servers/SSD/SSD.stanza

schema/var/cics_servers/SCD/SCD.stanza

gateway/var/cics_servers/GSD/GSD.stanza

These files are owned by cics and, on Open Systems, have the permissions-rw-rw----. If no flags are specified, files are created for the SFS, schemas and,on Open Systems, gateway servers. Run this command as root oradministrator and once per machine after CICS has been installed for the firsttime.

Options

-s creates the default SFS resource file (SSD.stanza).

-c creates only the default schema resource file (SCD.stanza).

-p creates only the default PPC gateway resource file (GSD.stanza).

Examples

To create the SFS and schema resource files on one machine, enter:cicsdefaultservers -s -c

cicsdefaultservers

cicsdelete - Delete CICS resource definitions

X X X X

Use this command to delete existing CICS resource definitions.

Syntax

cicsdelete -c className [-r regionName] [-P | -R | -B] [-f fileName]resourceName [resourceName ... ]

cicsdelete -?

Description

The Resource Definition Online (RDO) command cicsdelete deletes one ormore resource definitions of a given class from the permanent resourcesdatabase, and can delete them from the runtime database.

CAUTION:Stopping the command before completion can result in a damageddatabase.

After you delete a resource definition, you cannot recover it. Each resourcedeletion is atomic. For example, suppose you try to delete three resourcedefinitions with a single command. The first two resource definitions aredeleted successfully, but the third resource definition deletion fails. Thecommand abnormally terminates, but it has still successfully deleted the firsttwo resource definitions. These two definitions are not recovered. Thecommand returns 0 if the command completes successfully, 1 otherwise.

Options

-c classNamedetermines the resource class from which the resource definition is tobe deleted, and is one of these two- or three-character codes:

cd Communication

fd Files

gd Gateways

gsd Gateway Servers

jd Journals

ld Listeners

od Objects

cicsdelete

pd Programs

scd SFS Schemas

ssd SFS Servers

td Transactions

ud Users

wd Terminals

xad Products

Resource classes rd (Region definition) and md (Monitoringdefinitions) cannot be deleted.

-r regionNamespecifies the region from which the resource definition is deleted. Ifyou do not specify a region name, CICS deletes the resourcedefinitions from the region specified by the CICSREGIONenvironment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as theresource class, because these classes are associated with a collection ofregions rather than with a specific one.

-f fileNamespecifies the name of the file that contains the schema definitions. Thisflag is valid only when you specify scd (SFS schema definitions) asthe resource class.

-P instructs the command to delete the resource definitions from thepermanent database without uninstalling them from the runtimedatabase. This is the default option if you do not specify either the -P,-R, or -B options.

-R instructs the command to uninstall the resource definitions from therunning system and delete them from the runtime database. If you areusing DCE authentication, you must be authenticated as a DCEprincipal before running the command with this flag.

The -R flag is invalid if you specify gsd, scd, or ssd as the resourceclass, because these classes are associated with a collection of regionsrather than with a specific region.

-B instructs the command to delete the resource definitions from thepermanent database, uninstall them from the running system, anddelete them from the runtime database. If you are using DCE

cicsdelete

authentication, you must be authenticated as a DCE principal beforerunning the command with this flag.

The -B flag is invalid if you specify gsd, scd, or ssd as the resourceclass, because these classes are associated with a collection of regionsrather than with a specific region.

resourceNameis the name of a resource definition to be deleted.

Examples1. 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 thepermanent and runtime databases in region REGION6:

cicsdelete -c tdd -r REGION6 -B TDQUEUE1 TDQUEUE2

cicsdelete

cicsdestroy - Destroy a CICS region

X X X X

The purpose of the cicsdestroy command is to allow you to destroy anexisting CICS region.

Syntax

cicsdestroy -r regionName [-s] [-I]

cicsdestroy -?

sufficient authority to:– Create a DCE principal and account– Create a Server Key Table– Administer the file system for the region (if you want to use the -s flag)

Usually this is a DCE cell administrator.

The cicsdestroy command destroys the specified region in the following way:

All operating system files associated with the region are destroyed.

If you specify the -s option, the TSQ, TDQ, and local queue files for the regionare deleted on the relevant file systems.The servers must be available and youmust 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 files of the CICS region have been deleted before thecicsdestroy command is issued, the SRC entries for the region are notremoved.

If you are using DCE authentication,you are logged in to DCE, and you havesufficient authority, the region principal, region account and CDS directoriesfor the region are deleted.

Note: Although cicsdestroy deletes the DCE principal and account for theregion userid, it does not delete the DCE principals and accounts for

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 youare using DCE authentication.

Options

-r regionNamespecifies the region to be destroyed.

-s specifies that region-owned data infile system usedis also to bedestroyed.

-I ignore errors.

Examples1. 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

cicsdestroy

cicsdfmt - Dump formatter

X X X X

Use this command to extract data from a dump file or files that CICS createsas part of a CICS dump sequence. The command formats the CICS dump intoa form that can be written to the operating system standard output.

Syntax

cicsdfmt [ [-r regionName] [fileName] | directoryName | fileName |-p [-r regionName] [dumpFileName] ]

cicsdfmt -?

Description

If you do not specify any parameters, the cicsdfmt command lists the dumpfiles located beneath the default region’s dump directory, and sends someexplanatory text about how to use the command to the operating systemstandard error destination.

If you specify a region and the name of a dump file, the cicsdfmt commandgenerates the full path of the dump directory for the region, extracting a valuefor the dump directory from the Region Definitions (RD). It searches in thesubdirectories of the dump directory for the named dump file.

If you specify a filename alone, the cicsdfmt command searches thesubdirectories of several locations, in the following order, to check whetherthe named dump file exists:1. The current directory2. The parent of the current directory3. The default region’s dump directory

If the named dump file does not exist, the cicsdfmt command sends an errormessage to the standard error output. If the named dump file exists, itformats all dump files 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 OpenSystems, you cannot use the vi editor to examine such dumps, but youcan use:

v cat fileName | fold newName (This converts all the lines to 80 characters toallow normal use of vi.)

cicsdfmt

v more fileName

v pg fileName

v emacs, if available

Options

-r regionNamespecifies the region to use. The cicsdfmt command generates the fullpath of the dump directory for the region regionName, extracting avalue for the dump directory name from the Region Definitions (RD).The cicsdfmt command checks that regionName is valid. If regionNameis invalid, it sends an error message to the standard error stream. Ifyou specify fileName as well as regionName, the request formats thedump file fileName for the specified region. If you do not specifyfileName, the request lists all the dump files for region regionName.

If you do not specify a region name, CICS processes dumps for theregion specified by the CICSREGION environment variable.

fileNamespecifies the base name of the file or set of files to be formatted tostandard output.

If you specify the fileName and -r regionName options, the cicsdfmtcommand formats only the dump files contained in the specifiedregion. You can specify filename with a relative or absolute path. Adump can be contained in more than one file, but the files all sharethe same base name; supply the base name to this command.

Note: The suffix of the filename must not be entered.

The format of the name of the dump file is aaaannnn, where nnnn isthe dump sequence number that CICS increments each time a dumpis performed, and aaaa is a prefix to denote how the dump arose. Theprefix 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 dumpcodeFrom an EXEC CICS DUMP command.

cicsdfmt

A four letter abnormal termination codeFrom an EXEC CICS ABEND command or from a transactionabnormal termination initiated by CICS.

directoryNamelists the dump files located in the subdirectories of a specifieddirectory. You can specify directoryName as a full or relative pathname.

-p [dumpFileName]removes all dump files specified by the dumpFileName parameters. ThedumpFileName is the base name of the file or set of files that you wantto remove. You can specify dumpFileName with a relative or absolutepath. A dump can be contained in more than one file, but the files allshare the same base name; supply the base name to this command.

If you do not specify a dumpFileName parameter, the cicsdfmtcommand lists the specified files, requests confirmation that all thefiles are to be deleted, and, if confirmed, removes the files.

If you specify -p with a dumpFileName parameter, the specified dumpfiles are deleted without requesting confirmation.

-? provides you with a help facility showing the correct syntax for thecommand. cicsdfmt also displays the correct syntax if you enter thecommand syntax incorrectly.

Examples1. To list all dump files located in directory /u/dumpdir:

cicsdfmt /u/dumpdir

2. To list all dump files for region REGIONA:cicsdfmt -r REGIONA

3. To format all dump files with a base name of shut001 that are located inthe current directory, the parent of the current directory, or the defaultregion’s dump directory:

cicsdfmt shut001

4. To remove all dump files with a base name of shut001:cicsdfmt -p shut001

5. To format a dump for a specific region:cicsdfmt -r REGIONA shut001

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

cicsdfmt

cicsexport - Export CICS resource definitions

X X X X

Use this command to make an archive copy of all the resource definitions inan existing CICS region. Using the cicsexport command with the cicsimportcommand 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 namedregion. This process lets you transfer regions across machines, possibly ondistinct 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). Beforeyou use this command, verify that you have enough space for thecopy in the directory.

Syntax

cicsexport [-r regionName] [-o outFile] [-l className...]

cicsexport -?

Description

The cicsexport command copies the resource definitions from an existingCICS region. To run cicsexport from the command line, you must be loggedin as a user with root or administrator privileges and be a member of the groupcics (CICS on Open Systems) or cicsgroup (CICS for Windows NT). Thecicsexport command copies the following definitions:v All configuration files except those defining the SFS server. These have to

be reconfigured.v All resource definitionsv Conversion templatesv All programsv All mapsv All Java classesv The contents of the region’s data directory.

Note: If you install maintenance on CICS or a new version of CICS, theexisting DEFAULT archive file is overwritten, including any alterationsyou made to it.

cicsexport

To migrate an exported region, you must import it, migrate it by using thecicsmigrate -r command, and then reexport it. The region can then beimported successfully as required.

Options

-r regionNamespecifies the existing region from which the cicsexport commandcopies resource definitions. If you do not specify a region name, CICScopies the resource definitions from the region specified by theCICSREGION environment variable.

-l className (CICS on Open Systems only)permits the archive copy to be generated in a form that createssymbolic links for the specified resource definition files. The classNamecan be one or more of the following:

cd Communication

fd Files

gd Gateways

jd Journals

ld Listeners

md Monitoring

pd Programs

od Objects

rd Regions

td Transactions

ud Users

wd Terminals

xad Products

-o outFilespecifies the output file to which the cicsexport command writes thearchive copy of the resource definitions, in Copy In and Out (cpio)format. If you do not specify the -o flag, cicsexport writes the file tostandard output.

cicsexport

Examples1. To export the region REGION1:

cicsexport -r REGION1

2. To export the region REGION2, placing symbolic links for the file andprogram definitions:

cicsexport -l fd pd -r REGION2

cicsexport

cicsget - Get CICS resource definition information

X X X X

Use this command to inquire about existing CICS resource definitions.

Syntax

cicsget -c className [-r regionName] {-l | -s [resourceName] | [resourceName]}

cicsget -c scd [-f fileName] {-l | -s resourceName | resourceName}

cicsget -?

Description

The Resource Definition Online (RDO) command cicsget retrieves resourceattributes of a specified class from the permanent resources database so thatyou can query on their status. Output from cicsget is written to standardoutput.

Do not specify the resourceName for the Region Definitions (RD) and theMonitoring Definitions (MD). However, you must specify it for all otherresource types.

The -l and -s options are mutually exclusive.

Options

-c classNamedetermines the resource class from which the resource definition is tobe retrieved, and is one of these two- or three-character codes:

cd Communication

fd Files

gd Gateways

gsd Gateway Servers

jd Journals

ld Listeners

md Monitoring

od Objects

pd Programs

cicsget

rd Regions

scd Schema File Definitions

ssd SFS Servers

td Transactions

ud Users

wd Terminals

xad Products

-r regionNamespecifies the region from which the command retrieves the resourceattributes. If you do not specify a region name, CICS retrieves theresource attributes from the region specified by the CICSREGIONenvironment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as theresource class, because these classes relate to the servers rather than tothe regions.

-s causes a list of attribute names and attribute values to be written tostandard output. The information is written as two lines ofinformation. The first line, which begins with a number sign (#), is alist of attribute names separated by colons (:). The second linecontains all the corresponding attribute values, also separated bycolons. The cicsget command appends the word region to the end ofthe first line, and appends the region name to the end of the secondline. Specify the resourceName for all classes except the region andmonitoring classes.

-l causes a list of all resources and their descriptions for a given class tobe written to standard output.

resourceNameis the name of the resource definition to be retrieved. You mustspecify a resourceName for all classes except rd and md. To retrieve theattributes for the default definition, use “” as the value. This attributewithout the -s flag results in a list of attributeName=attributeValuepairs being written to standard output.

-f fileNamespecifies the file containing the resource definitions. Use this attributeonly when retrieving data for the Schema File Definitions (SCD). Theclass scd must be used when specifying the filename.

cicsget

Examples1. To inquire about the definition 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 alist to standard output:

cicsget -c ud -r REGION8 -l

cicsget

cicsgetbindingstring - Get binding string for region or Encina server

X X X X

The purpose of the cicsgetbindingstring command is to display the bindingstring used to contact a given CICS region or Encina SFS or PPC Gatewayserver 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 doeswhen CICS components and Encina servers are started. Otherwise the resultsdisplayed may not correctly represent the endpoints used by CICS.

This command searches the DCE RPC daemons for information about regionsand servers. It will search the daemons on the machines that are specified bythe environment variable CICS_HOSTS or those on the current machine ifCICS_HOSTS is not set. If none of the daemons on the specified machines hasinformation about the region or server, a final check is made in the file/var/cics_servers/server_bindings for any binding that may have beenentered there.

Note that cicsgetbindingstring displaying a binding string does not guaranteethat 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 whenattempting to contact the region or server in the absence of the DCE directoryservice. Normally however this will indeed be an active process.

In the case of Encina SFS and PPC Gateway servers the binding stringreturned by cicsgetbindingstring may be used in place of the server namewhen using Encina facilities for manipulating the servers. This is especiallyimportant when using tkadmin, sfsadmin or ppcadmin with serversoperating without the DCE directory service. Specifying the server name insuch cases will not enable Encina to locate the server concerned (unless theenvironment variable ENCINA_BINDING_FILE is set to the name of a filecontaining a mapping between the server name and a binding string, forexample, the file /var/cics_servers/server_bindings). On the other hand thestring binding may be freely used in place of the server name and Encina willthen be able to locate the server.

cicsgetbindingstring

Options

regionNameis the name of a CICS region on one of the machines specified by theenvironment variable CICS_HOSTS or on the current machine ifCICS_HOSTS is not set.

serverNameis the name of an Encina SFS or PPC Gateway server on one of themachines specified by the environment variable CICS_HOSTS or onthe current machine if CICS_HOSTS is not set

Examples1. To find the binding string that will be used by CICS to contact the CICS

region REGION1 running on machine BLUE, enterexport CICS_HOSTS=BLUEcicsgetbindingstring REGION1

2. To find the binding string that will be used by CICS to contact the EncinaSFS 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 files on the Encina SFS server /.:/cics/sfs/SERVER1running on machine BLUE

export CICS_HOSTS=BLUEsfsadmin list files -server $(cicsgetbindingstring /.:/cics/sfs/SERVER1)

cicsgetbindingstring

cicsgpid - Get region process identifier

X X X X

Use this command to determine the process identifier of the main CICSprocess.

Syntax

cicsgpid [-r regionName]

cicsgpid -?

Description

cicsgpid determines the process identifier of the main CICS process.

Options

-r regionNamespecifies the region name. The cicsgpid command checks thatregionName is valid. If regionName is invalid, cicsgpid writes an errormessage to the standard error stream.

If you do not specify a region name, CICS determines the processidentifier for the region specified by the CICSREGION environmentvariable.

-? provides you with a help facility showing the correct syntax for thecicsgpid command. If you enter the command syntax incorrectly, thecorrect syntax is displayed.

Examples

To determine the process identifier for the CICS region REGIONB:cicsgpid -r REGIONB

cicsgpid

cicshpterm - 3270 terminal emulator

Invokes the CICS 3270 Terminal Emulator, from the operating system, so thatyou 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). Oncecicshpterm performs the configuration steps outlined under“Description”, it invokes cicsterm. All the description given forcicsterm is equally valid for cicshpterm.

Syntax

cicshpterm [-r regionName] [-n netName | -m modelId] [-t transId][-A [animatorTTY] [-T animatorTERM]

cicshpterm -?

Description1. You need access to a terminal or window that can access a machine in the

DCE cell in which the CICS region is defined. Your terminal must eitherbe suitable for autoinstall, or have an entry in the NetName attribute inthe Terminal Definitions (WD).

2. Your window must contain at least 12 lines, so that the terminal emulatorcan display a menu of region names when necessary. A menu of regionnames is displayed if you do not specify a region when you invoke theCICS 3270 Terminal Emulator. The 12 lines are needed to display variousheaders, PF key legends, blank space, and at least one region name so thatyou can scroll through the list of available regions. If the window containsless than 12 lines, there is an error message and the terminal emulatorterminates abnormally. It is recommended that you use a window with 25lines.

3. If you are using DCE authentication, you must be authenticated as a DCEprincipal, as explained under “Description”. A DCE ticket is allocatedwhen the DCE principal authenticates with the DCE security service.Tickets have a limited lifetime; 10 hours by default. If a ticket expireswhile the client is active, the client is terminated and any in-flighttransactions are terminated abnormally. DCE accounts may have theirticket 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

cicshpterm

keys listed in it that allow you to access the transactions that you want torun. This is described in the CICS Administration Guide.

The cicshpterm command is an intelligent cicsterm wrapper thatautomatically examines your environment and configures cicsterm for themaximum functionality possible within your environment. If you use cicstermalone, you are required to perform these configuration steps manually.

cicsterm command, cicshpterm checks whether or not your environment iscapable of displaying a window on a graphics terminal.

If your environment is capable of displaying a window on a graphicsterminal, cicshpterm creates an hpterm window that runs cicsterm. Thecicsterm command is run using a high-function terminal model and acustomized hpterm window that provides 24 programmed softkeys and fullcolor capabilities. The characteristics of the hpterm window created bycicshpterm are defined in the X resources file/opt/cics/etc/cicshpterm.resources. The key mapping file applied is/opt/cics/etc/3270keys.hpterm.

If your environment is not capable of displaying a window on a graphicsterminal, cicshpterm determines whether you are running on a terminal oremulation that it supports. For the supported terminals and emulations,cicshpterm configures your environment for the maximum functionalitypossible. In these cases, cicsterm runs in monochrome mode with 8 or 16programmed soft keys.

The following table lists the terminal models recognized by cicshpterm andthe 3270 key mapping file located in /opt/cics/etc that is applied for eachmodel:

Terminal type supported Associated keymap file

HP 2392A, HP 2394A, 3270keys.hp

HP 700/92, HP 700/94, HP 700/96, HP700/98

3270keys.hp

hpterm terminal emulator (non-graphicsmode)

3270keys.hp

hpterm terminal emulator (graphicsmode)

3270keys.hpterm

VT100/ VT200 3270keys.vt100

If cicshpterm does not recognize your terminal/emulation, it makes nochanges to your environment. The keymap file applied is/opt/cics/etc/3270keys.

cicshpterm

The cicshpterm command defaults the correct cicsterm model (-m) parameterfor its supported terminals whenever the cicsterm netname (-n) parameter isnot specified. You can override this default by specifying a terminal modelusing the -m parameter.

Options

-r regionNamespecifies the name of the CICS region to which you wish to attach. Ifyou do not specify a regionName, CICS displays an interactive menu ofavailable regions that you can select from. If there are no regionsavailable, CICS displays an error message. You must confirm thismessage by pressing ENTER before CICS terminates the CICS 3270Terminal Emulator.

-t transIdspecifies the transaction identifier of the transaction to run afterTerminal Emulator initialization.

-n netNamespecifies the name of the netName to use for installation. To install as aparticular terminal, specify the netName of the required terminal. Ifyou omit the netName, then cicshpterm autoinstalls, and a uniquenetName is generated in the region.

-m modelIdspecifies the name of the DevType to use for autoinstallation. See“Processing” on page 254.

-A animatorTTYspecifies the name of the device for ANIMATOR stdin/stdout. If youspecify the -A, option without a value, and you are using X Windows,cicshpterm will create a window for use as the ANIMATOR console.

-T animatorTERMspecifies the name of the TERM type of the ANIMATOR terminal.

Examples1. 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 Definitionson region region1:

cicshpterm -n BlueTerm -r region1

cicshpterm

4. If you want to log on to a different userid after you have startedcicshpterm:

cicshpterm -r region1 -t CESN

cicshpterm

cicsimport - Import CICS resource definitions

X X X X

Use this command to restore an archive copy of the resource definitions froman existing CICS region. Using the cicsimport command with the cicsexportcommand 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 namedregion. This process lets you transfer regions across machines, possibly ondistinct networks.

Syntax

cicsimport -r regionName [-g groupName] [-i inFile] [-l{m|o}][-v] [-F] [-S|-D][-o]

cicsimport -?

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 definitions from an existingregion to your new region. You run cicsimport from the command line aslong as you are logged in as a user with root or administrator privileges. Thedefinitions that cicsimport restores are:v All configuration files except those defining the SFS. Even if SFS files

already exist for an imported region, you should rerun cicssfsconf to resetthe ACLs.

v All resource definitionsv Conversion templatesv All programsv All mapsv All Java classesv The contents of the region’s data directory

cicsimport

If you are using DCE authentication and there are User Definitions (UD) inthe region archive being imported that do not currently exist in the DCE cell,their DCE principals and accounts are created automatically with thefollowing details:v The password is the same as that for the user’s 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 existalready, are made members of the DCE group cics_users.

If you are not using DCE authentication or name services, the option -S mustbe specified.

If you install a new region, this command can be used to copy another regionwhich already exists.

If you want to migrate an exported region database, you must import usingcicsmigrate -r, and then re-export it again. The region can then be importedsuccessfully as required.

If you are using SFS for CICS queues and files, after running cicsimport, runcicssfsconf to reset the Access Control Lists.

Options

-r regionNamespecifies the name of the region to restore.

-g groupNamespecifies the name of the group with which all files of the new regionare created. The default groupid is cics (CICS on Open Systems) andcicsgroup (CICS for Windows NT).

-l{m|o} (CICS on Open Systems only)specifies the action that cicsimport is to take if it cannot find thetarget of a symbolic link:

-lm Mandatory. cicsimport terminates the restoration immediately.

-lo Optional. cicsimport produces a warning message, creates thelink, and continues restoration. This allows you to restorefurther regions that resolve the missing links.

The default action is to terminate the restoration.

cicsimport

-i inFilespecifies the name of the archive copy of the resource definitions inCopy In and Out (cpio) format. If you do not specify the -i flag, thefile is read from stdin.

-v (verbose) lists files as they are created.

-F forces an overwrite of the region if the region already exists, but doesnot recreate DCE and the entries in the database of the facility thatstarts and stops processes if they already exist.

-S causes the new region to be set up without using DCE servers. Itmust be specified if the region from which the archive was createdused DCE servers but the new region does not. The RegionDefinitions (RD) attributes NameService and AuthenticationServicewill be set to CICS respectively.

-D forces DCE servers to be used when migrating a region that did notuse DCE servers to a machine that does use them. The RegionDefinitions (RD) attributes NameService and DCE.

-o Do not create DCE principals and accounts for the CICS users in theregion. If not specified, each user definition in the region will have aDCE principal and account added to the DCE registry and the accountwill be added to the DCE group cics_users.

-? produces the usage message.

Examples1. To import region REGION1 from archive file /archive/region1:

cicsimport -r REGION1 -i /archive/region1

2. To import region REGION2 from archive file /archive/region2 producingwarning messages if any symbolic link requirements defined as part of thecicsexport command cannot be found:

cicsimport -lo -r REGION2 -i /archive/region2

cicsimport

cicsinstall - Install CICS resource definitions

X X X X

Use this command to install CICS resource definitions into the runtimedatabase.

Syntax

cicsinstall [-v] [-r regionName] { -a | -g groupName [groupName ... ] }

cicsinstall -?

Description

The Resource Definition Online (RDO) command cicsinstall installs resourcedefinitions into the runtime database for the specified region. The -g and -aoptions 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 aserver key table. Usually, this requires an identity as a DCE celladministrator.

Options

-r regionNamespecifies the region to which the cicsinstall command is to install theresource definitions. If you do not specify a region name, CICS installsthe resource definitions to the region specified by the CICSREGIONenvironment variable.

-g groupName ...specifies the names of the group or groups whose resource definitionsthe cicsinstall command is going to install. As many as ten groupnames can be specified. The -g flag must be the last flag specified onthe cicsinstall command.

-v requests that the cicsinstall command produce messages indicatingwhich resources it has installed, as well as the total number ofresources installed. If you do not specify this option, it produces amessage only if an error occurs.

-a requests the cicsinstall command to install into the CICS runtime

cicsinstall

database all resource definitions from the permanent database thathave the ActivateOnStartup flag set.

Examples1. To install all resource definitions 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 definitions in the region REGION0that have the ActivateOnStartup flag set, plus receive progress messages:

cicsinstall -r REGION0 -a -v

cicsinstall

cicsivp - Set up resource definitions for installation verification

X X X X

Sets up the resource definitions required to run the Installation VerificationPrograms (IVPs).

Syntax

cicsivp -r regionName [-s serverName] [-v volumeName] [-l sampleLanguage]

cicsivp -r regionName [-s databaseName][-l sampleLanguage]

Descriptionv 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 groupcicsgroup.

v If you are using an SFS as a file server:– You must be running an SFS.– cicssfsconf must have been run to configure the SFS.– You must have authority to create an SFS file. Usually this means that

you must be logged in with the DCE principal, cell_admin.v If you are using DB2 as a file 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 configure the database.– You must have the authority to create a table.

The IVPs are designed to run with a set of pre-defined resource definitions.The cicsivp command adds these resource definitions to the specified regiondatabase. After you’ve run cicsivp, you must cold start the region for thechanges to take effect.

Once the region is running, you can run cicsivp again to change the languagein which the sample transactions are coded.

Options

-r regionNamespecifies the region to be amended.

-s serverNamespecifies the name of the required SFS if the region is using an SFS fileserver(attribute FileSystemType=SFS in the Region Definition). If the

cicsivp

server is not specified then the default server is/.:/cics/sfs/hostName, where hostName is the name of the machinerunning CICS and can be found using the command uname -n.

-s databaseNamespecifies the name of the required DB2 database if the region is usingDB2 as a file server (attribute FileSystemType=DB2 in the RegionDefinition). If the name of the database is not specified then the valueof the Region Definition attribute DefaultFileServer is used as thedatabase name.

-v volumeNamespecifies the name of the required SFS logical volume. If it is notspecified, the default volume is DataVolume in the Structured FileServer Definitions (SSD).

-l sampleLanguagespecifies the language of the sample transactions. The language can beone of:

C – the samples coded in C are to be used.

IBMCOB– the samples coded in IBM COBOL are to be used (CICS forAIX only).

COBOL– the samples coded in Micro Focus COBOL are to be used.

Examples1. To add the required resource definitions to a region called REGION1, using

the default SFS and SFS logical volume, enter:cicsivp -r REGION1

2. To add to required resource definitions to a region called REGION1, usingthe default SFS, which has an SFS logical volume called sfs_MINE, enter:

cicsivp -r REGION1 -v sfs_MINE

cicsivp

cicslssrc - Check subsystem status

The cicslssrc command shows the status of CICS subsystems. By default, allsubsystems are listed. Alternatively, a specific 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 field is blank.v The current status of the subsystem. The statuses are:

inoperativeThe subsystem is not currently running.

active The subsystem is running as the process identified by the PID field.

stoppingThe subsystem is processing a shutdown request.

Options

-a display the status of all subsystems. This is the default parameter.

-s subsystemdisplay the status of the specified subsystem. A region’s subsystemname is formed by appending the region name to cics.; for examplecics.region2. An SFS subsystem name is similarly formed byappending the short name of the SFS to cicssfs.; for example,cicssfs.SHostA.

-g groupNamedisplay the status of all subsystems in the specified group.

Examples1. To list all CICS subsystems, use the following:

cicslssrc

On a system with a region named region2 and an SFS named SHostA,something similar to the following is shown:Subsystem PID Statuscics.region2 7444 activecicssfs.SHostA 605 active

If the SFS were not running, then the following is shown:Subsystem PID Statuscics.region2 7444 activecicssfs.SHostA inoperative

2. To check the status of an SFS named SHostA, use the following:cicslsrrc cicssfs.SHostA

cicslssrc

cicslterm - Invoke the local CICS client 3270 terminal emulator

Invokes the local CICS client 3270 terminal emulator so that you can connectto 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 -?

Descriptionv You need to understand about the 3270 terminal subsystem before you use

the cicslterm command. See the CICS Administration Guide for moreinformation.

v The window in which you start cicslterm must contain at least 12 lines. It isrecommended that you use a window with 25 lines.

v You must be authorized to run the transactions that you specify. That is, theUD entry for the userid you are using must have the TSL and RSL keyslisted 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 screenthat is running the IBM 3270 Information Display System emulation. You canthen enter the transaction identifier of the transaction you want to run.

Alternatively, you can run a transaction immediately when cicslterm isinitially invoked, by enteringcicslterm -t=transId

where transId is the transaction identifier.

The name of the pipe that is to be used for communication with the region isdetermined from file cicslcli.ini in directory prodDir/bin. The filecicslcli.ini must contain a stanza of the formServer=serverNameProtocol=LOCALCLINamedPipeName=pipeName...

where serverName is the name of the server specified on the cicsltermcommand. and pipeName is the 6-character name of the pipe to be used. The

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 Pipename) of an entry in the Listener Definitions (LD) for the region. If youchange the file cicslcli.ini, you must use the ″Stop All Local Terminals″icon to stop all CICS local terminals and the cicslcli client before usingcicslterm to restart a CICS local terminal to pick up the change. For a fulldescription of the format of the client initialization file, see CICS Clients:Administration.

The CICS 3270 Terminal Emulator is associated with a particular region forthe lifetime of the cicslterm process. If the region terminates, the cicsltermprocess is left running to wait for any current scheduled protectedtransactions for the given terminal when the region is restarted. Otherwise,the cicslterm process terminates.

Options

-s=serverName or -r=serverNamespecifies the name of the CICS server you wish to use.

-t=transIdspecifies the identifier of the transaction to run after the terminalemulator has initialized.

-k=keyFilespecifies the name of the keyboard mapping file to be used by theemulator. If this parameter is omitted, the environment variableCICSKEY is used to identify the key mapping file. If CICSKEY is notdefined, it is assumed that a file called cicskey.ini in the currentdirectory contains the keyboard mapping.

-c=colorFilespecifies the name of a color mapping file to be used by the emulator.If this parameter is omitted, the environment variable CICSCOL isused to identify the color mapping fle. If CICSCOL is not defined, it isassumed that a file called cicscol.ini in the current directorycontains the color mapping.

-m=modelIdspecifies the name of a model terminal definition, defined in theregion’s Terminal Definitions (WD), that is to be used to define thecharacteristics of the window in which transactions are to be run. Ifneither of the -m or -n parameters is specified, then any ModelTermvalue from the client initialization file is used. If no ModelTerm valuehas been specified in the initialization file, or if the -m parameter isspecified without a value, the server’s default terminal definition isused.

cicslterm

-n=netNamespecifies the name of a particular terminal definition as defined in theregion’s Terminal Definitions (WD).

-p=printCommandspecifies a Windows NT command used to process the temporaryprint file generated when requests are received by the terminalemulator. The temporary print file is processed by executing thecommand obtained by appending the name of the file to the specifiedcommand. CICS does not delete the temporary print file. Thecommand that is executed is responsible for deleting the temporaryprint file, if that is appropriate.

If the command contains embedded blanks, then it must besurrounded by double quotation marks ("). Any double quotationmarks within the command must be entered as backslash doublequote (\").

If neither of the -f or -p parameters is specified, the PrintCommand orPrintFile parameter in the client initialization file defines thecommand or file to be used for print requests.

-f=printFilespecifies the name of a file to which the output of print requests isappended. If the name of the file contains embedded blanks, it mustbe enclosed in double quotation marks ("). Any double quotationmarks within the name of the file must be entered as backslashdouble quote (\").

If neither of the -f or -p parameters is specified, the PrintCommand orPrintFile parameter in the client initialization file defines thecommand or file to be used for print requests.

-q (quiet) suppresses the display of any messages generated by thecommand.

-w (wait) prompts the user to press the Enter key before the commandcompletes, to confirm that messages generated by the command havebeen read.

Examples1. To log on to the server server1 and run transaction CEMT:

cicslterm -s=server1 -t=CEMT

cicslterm

cicsmakelv - Create a logical volume

The cicsmakelv command creates a logical volume for use by an Encinaserver.

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 file, at thelocation specified by dataPath, that will be used as an Encina logical volumeby an Encina server.

A volume created using cicsmakelv should only be removed using thecicsremovelv command since cicsmakelv also adds information to the NTRegistry concerning the location of the logical volume. Removing the volumeby other means could result in incorrect information being left in the NTRegistry.

Options

-I Ignore errors. If an Encina Logical Volume previously existed with thisname but was only partially removed, then this flag may be specifiedto force the redefinition of the volume.

-v volumeNamespecifies the name of the logical volume as it is to be referenced bythe Encina Server.

-s volumeSizespecifies the size of the logical volume in bytes.

-p dataPathspecifies the location of the logical volume.

Examples1. 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

cicsmakelv

cicsmfmt - Monitoring data formatter

X X X X

Use cicsmfmt to extract data from a monitoring transient data queue thatCICS creates as part of a CICS monitoring sequence. cicsmfmt formats theCICS monitoring data into a form that can easily be written to standardoperating system output. You can replace cicsmfmt with your owncustomized program. This information describes the version delivered withCICS and may not correspond to the version running on your system.

Syntax

cicsmfmt fileName

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, onhow to use the command. Otherwise, cicsmfmt checks that the file exists, andformats the file records.

cicsmfmt formats several fields for each transient data queue record:v the transaction namev the terminal namev the start and end time stamps for the taskv the time spent waiting for file input and output, and the number of times

CICS started and stopped the clockv the program namev the total number of file requestsv the data segment memory occupancyv the first abnormal termination code, if set.

cicsmfmt is a sample program generated from the sample source filecicsmfmt.c. It can be built with the sample makefile in the directoryprodDir/src/samples/mfmt using the command make -e -f Makefile (on OpenSystems) or nmake -e -f Makefile (on Windows NT).

If you want to replace cicsmfmt with your own program, you must changethe sample makefile accordingly.

cicsmfmt

The following files make up the monitoring data formatter:

Table 3. Monitoring data formatter files

File Type Contents

prodDir/bin/cicsmfmt (CICS on Open Systems)c:\opt\bin\cicsmfmt.exe (CICS for Windows NT)

executable The executable monitoringformatter program

prodDir/src/samples/mfmt/cicsmfmt.c source Sample monitoring formatterprogram source

prodDir/src/samples/mfmt/Makefile makefile Sample makefile that builds andinstalls the monitoring formatter

prodDir/lib/libcicsmfmtsa.a (CICS on OpenSystems) prodDir/lib/libcicsmfmtsa.lib (CICS forWindows NT)

object library Library containing the functionsfor reading and processing aMonitoring Data file

prodDir/include/cicsmfmt.h include Definitions used by the samplemonitoring formatter

prodDir/include/cicsmfmt_msg.h include English messages used by thesample monitoring formatter

prodDir/msg/en_US/cicsmfmt.cat (CICS for AIXand Solaris)prodDir/msg/en_US.iso88591/cicsmfmt.cat (CICSfor HP-UX)

message text Message catalog for cicsmfmtproduced by gencat. Onlyrequired by formatter programscompiled with CICS release 2.1.1or earlier.

Options

fileNamean operating system file corresponding to a CICS extrapartitiontransient 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 thecommand. cicsmfmt also displays this if you enter the commandsyntax incorrectly.

Examples1. To list file shut001:

cicsmfmt shut001

2. To obtain help:cicsmfmt -?

cicsmfmt

cicsmigrate - Create migration script

X X X X

Creates a shell script (On Open Systems) or a command file (Windows NT)which updates, or migrates, databases and DCE principal names toaccommodate the changes required by a Program Temporary Fix (PTF) or anew release.

Syntax

On Open Systems:

cicsmigrate [-r regionName | -s | -c | -p | -m] -g fileName -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 commandfile (Windows NT) which you can run to update resource databases and DCEprincipal names to provide for the changes required by the PTF or newrelease. This shell script (On Open Systems) or a command file(Windows NT) can:v Add new attributesv Delete old attributesv Add new resource classesv Change the names for SFSv Change an attribute’s value, for example, the minimum value, or the

defaultv Add new resource definitions, for example a new model terminal or

supplied transaction.

The shell script (On Open Systems) or a command file (Windows NT)incorporates the cicsmigrateclass, cicsupdateclass, and cicscopystanzacommands which make the appropriate changes. Although typically, in astandard installation, you do not normally need to make any modifications, ifyou want to make any specific changes to the databases, such as changing the

cicsmigrate

default value of a new attribute, edit the migration shell script (On OpenSystems) or a command file (Windows NT) before running it.

The shell script (On Open Systems) or a command file (Windows NT)updates the permanent and auto-start images of the databases.

To run the shell script (On Open Systems) or a command file (Windows NT)generated by the cicsmigrate command, you must be logged in as root oradministrator and authenticated as cell_admin.

Options

-r regionNamebuilds a migration shell script (On Open Systems) or a command file(Windows NT) which migrates only the named region (affects all thefiles in /var/cics_regions/region/database).

Note: For Windows NT, regionName is sufficient; you do not need the-r option. regionName specifies the CICS region to be migrated.If regionName is not specified, the command only migrates theSFS resource definitions.

-s builds a migration shell script (On Open Systems) which migratesonly the SFS resource database

-c builds a migration shell script (On Open Systems) which migratesonly the default schema database (affects only the/var/cics_servers/SCD/SCD.stanza file).

-p builds a migration shell script (On Open Systems) which migratesonly the GSD resource database (affects only the files in/var/cics_servers/GSD).

-m builds a migration shell script (On Open Systems) that migrates allthe regions, SFS, schema and PPC gateway files on the host machine(affects all the files in /var/cics_servers/SSD). Once this migrationscript has been built and run for a new release, it should not berebuilt for that release. Instead, either rerun the original script ormigrate items individually.

-g fileNamespecifies the name of the migration shell script (On Open Systems) tobe created.

-o outputLogspecifies the name of the log file which will contain all the changes

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 regiondatabase 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 theregions and SFS on a machine, enter:

cicsmigrate -g /homes/mine/migrateallscript -o /tmp/logfile -m

On Windows NT:

1. To create a command file called migratescript that upgrades only theregion database in region1, enter:

cicsmigrate region1

cicsmigrate

cicsmigrateclass - Add and delete resource attributes

Adds new attributes and deletes old attributes from the resource definition filefor a given class.

Syntax

cicsmigrateclass [-r regionName] [-w] -c className [-a attributeName {-n defaultValue | -d | -u newAttributeName} ] [-f fileName] cicsmigrateclass -?

Description

The cicsmigrateclass command adds, updates, or deletes the appropriateattributes in a resource definition file that needs to be changed because of anupgrade to CICS. The cicsmigrateclass commands are generated automaticallyand are included in the migration shell script which was created when youran cicsmigrate. The updates to the attributes are mandatory. You can specifya new value using the cicsmigrate command’s -n parameter, but you must notdelete, or change cicsmigrateclass commands within the migration shellscript. The syntax is described here so you can understand the shell script thatcicsmigrate generates.

In a migration shell script created by cicsmigrate, all cicsmigrateclasscommands automatically include the -w flag.

Options

-r regionNamespecifies the name of the region database being modified. For mostclasses, you must specify the regionName parameter. It is optional onlyfor the ssd, scd, and gsd classes.

-w updates the autostart images.

-c classNamespecifies the name of the class being modified. Valid classes are:

cd Communication definitions

fd File definitions

gd Gateway definitions

gsd Gateway server definitions

jd Journal definitions

ld Listener definitions

cicsmigrateclass

md Monitoring definitions

od Object definitions

pd Program definitions

rd Region definitions

ssd Structured file server definitions

scd Schema file definitions. Must be used with -f fileName.

td Transaction definitions

tdd Transient data definitions

tsd Temporary storage definitions

ud User definitions

wd Terminal definitions

xad Product definitions.

-a attributeNamespecifies the name of the attribute to add, modify, or delete.

-f fileNamespecifies the path and filename of the schema resource file. Thisoption is valid only if -c scd is specified.

-n defaultValuespecifies the default value of a new attribute to add.

-d deletes the attribute.

-u newAttributeNamespecifies the new name of the attribute.

Examples1. To add the new attribute Salutation, with the value greetings, to every

entry, including the default entry, in the User definitions 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 definitions forregion1 to Farewell, enter:

cicsmigrateclass -r region1 -w -c ud -a Salutation -u Farewell

3. To delete the attribute Farewell from every entry in the file for the Userdefinitions in region1, enter:

cicsmigrateclass -r region1 -w -c ud -a Farewell -d

cicsmigrateclass

cicsmigrateclients - Reconfigure DCE

Reconfigures DCE for each host running a CICS client or region. Use thiscommand 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 anddeletes the old principal and account. It sets new passwords for the account inthe keytab file in the /var/cics_clients directory. If you are using DCEauthentication you must be logged in as root or administrator andauthenticated as cell_admin. Run this command on all hosts which run CICSclients or regions.

Options

-I (Uppercase letter “i”) Ignores errors.

-v gives a detailed output while the command runs.

Examples

To reconfigure a DCE client after a patch has been installed, first log in as rootor administrator and authenticate as cell_admin, then enter:

cicsmigrateclients

cicsmkcobol - Create the cicsprCOBOL file

Syntax

cicsmkcobol [-o outFileName] [-L libraryPathName] ... [objectFileNames][libraryNames]

Description

Creates the COBOL language method file and the COBOL runtime library. Thecicsmkcobol command must be run whenever one of the following isinstalled:v A new version or release of Micro Focus COBOLv A new version or release of CICS applicable to your operating systemv A new version or release of any supported database product

cicsmkcobol creates the COBOL language method file and the CICS runtimelibrary for Micro Focus COBOL support. It combines the object filescontaining the CICS COBOL-support routines with the COBOL runtimesystem to create a loadable and executable file, and a shared librarycontaining the COBOL runtime support. The language method file is placed inthe current directory as cicsprCOBOL unless another path and filename arespecified using the -o option. The CICS COBOL runtime library is placed inprodDir/lib as libcicscobrtsrt.so libcicscobrtsrt.sl on CICS for HP-UX).

Note: On Windows NT there is no specific action required to provide alanguage environment for CICS. The COBOL language method filecicsprCBFNT is provided in the c:\opt\cics\bin directory

Processing

To be used by CICS:v The COBOL language method file must be placed either in prodDir/bin or

in /var/cics_regions/regionName/bin with the name cicsprCOBOL.Versions of the file placed in /var/cics_regions/regionName/bin takeprecedence over the file placed in prodDir/bin. This allows you to havedifferent COBOL language method files for each region.

v The CICS COBOL runtime library must be placed in a directory that isincluded in your library search path specified by the appropriateenvironment variable. On CICS for AIX the environment variable isLIBPATH; on CICS for HP-UX it is SHLIB_PATH. The sequential order inwhich the directories appear in the environment variable determines which

cicsmkcobol

libcicscobrtsrt.so file is used by CICS. This allows you to have differentCOBOL 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 file for use by all regions, or make/var/cics_regions/regionName/bin the current directory if you want tocreate a cicsprCOBOL file 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 find:– COBOL executable files.

For CICS for AIX, CICS for HP-UX onlyIf COBOL is not installed in the standard directory, set theenvironment variables COBDIR and COBLIB to the directory wherethe COBOL executables are held.

In the PATH environment variable, the executables directory (forexample, $COBDIR/bin) must be before the COBOL driver directory (forexample, /usr/bin).

– Operating system commands (such as echo, sed, and grep)– The executable files for CICS on your operating system.

Options

-o outFileName (on CICS for AIX, and CICS for HP-UX only)specifies the name of the generated file. If the command is runwithout the -o parameter (and always on and CICS for Solaris), thefile is named cicsprCOBOL and is placed in the directory prodDir/bin.

-L libraryPathNamespecifies a directory you want to add to the library path used bycicsprCOBOL. This is useful where you want to include sharedlibraries.

objectFileNamesare the names of the object files you want to use (for example, Cfunctions). Ths object files should be put into the $CICS/lib directory.

libraryNamesare the names of the libraries you want to use.

cicsmkcobol

Examples

To create a cicsprCOBOL file in the current directory, enter:cicsmkcobol

To create a cicsprCOBOL file in the bin directory of a region named regionA,enter:cicsmkcobol -o /var/cics_regions/regionA/bin/cicsprCOBOL

cicsmkcobol

cicsnotify - Deallocate resources

Use the cicsnotify command to deallocate resources left allocated when theregion is no longer running.

Syntax

cicsnotify subsystemName

Description

This command is used to release resources and delete the region lock filewhen, due to a non-normal shutdown, resources are left allocated after theregion 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) commandhas been used with the -c option, or when the region has failed tocomplete a shutdown in a logical manner.

Options

subsystemNameis the subsystem name used by the region. This is normally in theform cics.regionName.

Examples

To deallocate resources in a specific CICS region called REGION1:cicsnotify cics.REGION1

The CICS Administration Guide contains additional information on shutdownprocedures.

cicsnotify

cicsppcgwy - Start a PPC Gateway server

The purpose of the cicsppcgwy command is to start and initialize an EncinaPPC Gateway server.

Syntax

cicsppcgwy [-I] [-t component:traceMask [:component:traceMask] ... ] [[-TtraceClass [=traceClass ... ] = [modifier,modifier]outputClass:destination]...][serverName] [attributeName=attributeValue ... ]

cicsppcgwy -?

Descriptionv 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, thenrefer to the Encina Administration Guide Volume 2: Server Administration fordescriptions of alternative procedures.

The cicsppcgwy command starts and initializes an Encina PPC gatewayserver.

If for any reason cicsppcgwy encounters a problem, it leaves the PPCGateway server as it is, to allow investigation of the problem. cicsppcgwyshutcan then be used to shut down the PPC Gateway server when required.

The server’s 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 isstarted using an operating system command. On CICS for AIX this is thestartsrc command.

Stanza attributes can be overridden by supplying one (or more) pairs ofattributeName=attributeValue assignments. Note that the specification of aStartType override (cold or auto) determines whether the details are retrieved

cicsppcgwy

from the server database or its recovery-image. On CICS for AIX only, if thecommand is called from the SMIT panels cicscstartgsd or cicsastartgsd, thisoverride is explicitly added.

The -t and -T options are provided to allow the PPC gateway to be tracedusing the Encina trace facilities. It is expected that these options will only beused under the direction of your support organization, so they are notdocumented here in detail. See the CICS Intercommunication Guide for moreinformation.

Options

-I causes errors to be ignored.

-t ... specifies Encina trace masks.

-T ... specifies Encina trace output classes. -T can be used more than once.

serverNameis the full name of the server, such as/.:/cics/ppc/gateway/servername.

If a server name is not given cicsppcgwy will use contents of theenvironment variable CICS_PPCGWY_SERVER.

attributeName=attributeValue ...are overrides for database values.

Examples1. To start and initialize the PPC Gateway server GATESERV1 with a StartType

of cold, entercicsppcgwy /.:/cics/ppc/gateway/GATESERV1 StartType=cold

2. To autostart the PPC Gateway server GATESERV1, entercicsppcgwy /.:/cics/ppc/gateway/GATESERV1

cicsppcgwy

cicsppcgwycreate - Create a PPC Gateway server server

The purpose of the cicsppcgwycreate command is to create an Encina PPCGateway server.

Syntax

cicsppcgwycreate [-v] [-I] [-S] serverName [-m modelName][attributeName=attributeValue ... ]

cicsppcgwycreate -?

Descriptionv 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 - usuallythe DCE cell administrator.

v The userid, which is to be used as the gateway ShortName, must have beencreated. It should be defined with a primary group of cics and a homedirectory of /var/cics_servers/GSD/cics/ppc/gateway/userId. You willfind 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, thenrefer to the Encina Administration Guide Volume 2: Server Administrationmanual for descriptions of alternative procedures.

cicsppcgwycreate cannot be used to create an Encina PPC Gateway server ona 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 theremote machine.

The cicsppcgwycreate command is used to add a PPC Gateway server serverinto the server database. It also adds an SRC entry, the CDS entry, andregistry and keytab entries.

An invalid option will result in an error message being displayed.

With no options specified cicsppcgwycreate will display the usage messagefor this command.

cicsppcgwycreate

If you are not using DCE servers you must add an entry to/var/cics_servers/server_bindings after running cicsppcgwycreate.

Options

-v (verbose) Messages describing the progress of the server creation aredisplayed.

-S causes the PPC Gateway server server to be created without usingDCE servers.

serverNameis the name of the PPC Gateway server server (GSD.stanza key).

-m modelNamespecifies the name of a model server.

attributeName=attributeValue ...overrides for database values.

Examples1. To create the PPC Gateway server server GATESERV1 using the model server

MODELGATE, entercicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 \

-m /.:/cics/ppc/gateway/MODELGATE

2. To create the PPC Gateway server server GATESERV1 with a short name ofGATESERV1, enter

cicsppcgwycreate /.:/cics/ppc/gateway/GATESERV1 ShortName=GATESERV1

cicsppcgwycreate

cicsppcgwydestroy - Destroy a PPC Gateway server

The purpose of the cicsppcgwydestroy command is to destroy an Encina PPCGateway server.

Syntax

cicsppcgwydestroy [-v] [-S] serverName

cicsppcgwydestroy -?

Descriptionv 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

The cicsppcgwydestroy command is used to destroy a PPC Gateway server,by removing the log restart files, 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 berecreated, data associated with the gateway is lost.

Options

-v (verbose) Messages describing the progress of the destruction of theserver are displayed.

-S causes the PPC Gateway server server to be destroyed without usingDCE servers.

serverNameis the name of the PPC Gateway server.

cicsppcgwydestroy

Examples

To destroy the PPC Gateway server GATESERV1, entercicsppcgwydestroy /.:/cics/ppc/gateway/GATESERV1

cicsppcgwydestroy

cicsppcgwylock - Lock or unlock a PPC Gateway server

The purpose of the cicsppcgwylock command is to take or release an EncinaPPC Gateway server lock.

Syntax

cicsppcgwylock { -l | -u | -t } serverName

cicsppcgwylock -?

CICS must be installed on the same machine as the PPC Gateway server. IfCICS is not installed on the same machine as the PPC Gateway server, thenrefer to the Encina Administration Guide Volume 2: Server Administration manualfor descriptions of alternative procedures.

The cicsppcgwylock command either takes or releases a lock for a specifiedPPC Gateway server. It is used to serialize the create, start, stop, and destroyphases of a PPC Gateway server.

Each PPC Gateway server (/.:/cics/ppc/gateway/serverName) has a lock filecalled /var/cics_servers/GSD/cics/ppc/gateway/serverName/lock.

Options

-l cicsppcgwylock to wait until the PPC Gateway server that owns thelock file is no longer running and then takes the lock.

-u causes the lock file for the PPC Gateway server to be releasedunconditionally.

-t cicsppcgwylock to try to take the lock file but to return immediately ifit is unsuccessful.

serverNameis the name of the PPC Gateway server for which the lock is to betaken or released.

Returned Values

0 Successful

1 Unsuccessful

cicsppcgwylock

Examples1. To take the lock on the PPC Gateway server GATESERV1 and return error if

it is not free, entercicsppcgwylock -t /.:/cics/ppc/gateway/GATESERV1

2. To release the lock on the PPC Gateway server GATESERV1, entercicsppcgwylock -u /.:/cics/ppc/gateway/GATESERV1

cicsppcgwylock

cicsppcgwyshut - Shut down a PPC Gateway server

The purpose of the cicsppcgwyshut command is to shut down an Encina PPCGateway server.

Syntax

cicsppcgwyshut [-f] [-c] serverName

cicsppcgwyshut -?

Descriptionv 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

The cicsppcgwyshut command shuts down a PPC Gateway server for a CICSregion. It also removes the lock on the server after a successful shutdown.

Options

-f forces a shutdown of the PPC Gateway server.

-c cancels the SRC subsystem in which the PPC Gateway server isrunning.

serverNameis the name of the PPC Gateway server.

Examples

To force a shutdown of the PPC Gateway server GATESERV1, entercicsppcgwyshut -f /.:/cics/ppc/gateway/GATESERV1

cicsppcgwyshut

cicsremovelv - Remove a logical volume

The cicsremovelv command removes a logical volume that was created bycicsmakelv.

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 NTRegistry information for the volume.

This command destroys all data on the logical volume; the data cannot berecovered at a later time.

Options

-v volumeNamespecifies the name of the logical volume that is to be deleted.

Examples1. To delete the logical volume known as sfs_Server1:

cicsremovelv -v sfs_Server1

cicsremovelv

cicsrlck - Remove old region lock files

X X X X

Use this command to remove any lock files for a region left by a CICS processthat terminated in an uncontrolled manner.

Syntax

cicsrlck [-f] { -a | -r regionName}

cicsrlck -?

Description

The cicsrlock command removes any CICS lock files left by a CICS processthat terminated in an uncontrolled manner. You must use this command withgreat care because the -a and -f flags enable you to override CICS lockingmechanisms, allowing you to run multiple CICS processes in the same region.The cicsrlck command writes a message to the system log for each lock filethat it removes.

Options

-f removes a single lock file from the region whose owning CICS processis still running.

-a unconditionally removes the lock files from all regions. If the regionor regions are still running, the locks are removed regardless ofwhether or not the -f flag is specified.

-r regionNamespecifies the region name when removing a single lock file. Thecicsrlck command checks that regionName is valid. If regionName isinvalid, cicsrlck writes an error message to standard error.

If you do not specify a region name, CICS removes the lock files forthe region specified by the CICSREGION environment variable.

-? displays the usage message that shows the correct syntax for thecicsrlck command. If you enter the command syntax incorrectly, thecorrect usage is displayed.

Examples1. To remove all CICS lock files:

cicsrlck -a

2. To remove the CICS lock file for the CICS region REGIONB:

cicsrlck

cicsrlck -r REGIONB

cicsrlck

cicssdt - SFS diagnostic tool

X X X X

The CICS SFS Diagnostic Tool (SDT) provides an interactive interface to theSFS.

Syntax

cicssdt [-s SFSname] [-i inputFile] [-o outputFile] [-e] [-r] [-c SDTcommands ...]

cicssdt -?

Descriptionv 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 bein any order.

-s SFSnamespecifies the name of the SFS. For example, /.:/cics/sfs/SFS1. If thisoption is not specified, the server name in the environment variableCICS_XDT_SERVER is used. CICS_XDT_SERVER overridesCICS_SFS_SERVER.

-i inputFilespecifies a text file containing SDT commands to be read andexecuted. The file can be created either by hand or by using the -ooption. Each line of the input file is treated as if it were typed ininteractive mode. The text from the input file is also displayed as it isprocessed by cicssdt. Comments can be included in the file by startinga line with “/*”.

cicssdt

For example, if you create an input file called create.input thatcontains the following lines:/*/* This is a sample file to create a SFS file called qsamTest/*create qsamTest

bflbyteArray10f2varLenByteArray100

f1yf1a

then execute cicssdt as follows:cicssdt -s SFSname -i create.input

A new file called qsamTest is created on the specified SFS.

-o outputFilecauses commands entered in the SDT session to be written to thespecified output file. This file can then be used as an input file usingthe -i option.

-e requests SDT to terminate if an error occurs. If -e is specified and SDTis being driven from a shell script (-i) or the command line (-c), anyerror resulting from a command will exit SDT with a non-zero returncode.

-r activates SDT statistics. Statistics for SDT and SFS calls are sent to afile called sdt.stats in the current directory. This is useful formonitoring performance.

-c SDTcommands ...specifies a list of commands and text to be used in the SDT session.This is useful for calling SDT commands from a shell script. Thisparameter must be used last.

Using the SDT commands: To issue commands in SDT, pass them to SDTusing the -i or -c option, or type the command at the command prompt. SDTaccepts command abbreviations. In the command syntax the minimumabbreviation is shown in parentheses; for example, (s)etopen. Any command

cicssdt

that requires a file name will default to the last name used if nothing is givenat the prompt. SDT also recognizes any environment variables used at thecommand prompt.

SDT commands - setopen

(s)etopen

Defines the characteristics of any open calls used in other SDTcommands. Non-transactional opens are used by default. If the openis transactional, SDT will manage the client transaction for you. Thiscommand also lets you define the locking mode used during a read,(the default is no lock or a dirty read). If a value of zero is specifiedfor the OFD operation timeout this effectively defines no timeout,such as wait forever. Error Isolation can only be inactive fortransactional 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 files on the server that SDT is accessing. If the l option isused, additional information is given for each file. If SDT cannot opena file to obtain long information, processing continues with the nextfile. A search string can also be given to list specific files. If a searchstring is used, SDT will look for all the filenames that contain thestring. There are no “wild card” characters, so the search string istaken as entered.cicssdt -s SFSname -c li l AC1cics

File Name Organisation Primary Index No. Records================== ===================== =============== ===========AC1cicsnlqfile btreeClustered (KSDS) cicsnlqidx (empty)AC1cicsnrectsqfil btreeClustered (KSDS) cicsnrectsqidx (empty)AC1cicsplqfile btreeClustered (KSDS) cicsplqidx (empty)AC1cicsrectsqfile btreeClustered (KSDS) cicsrectsqidx (empty)AC1cicstdqlgfile btreeClustered (KSDS) cicstdqlgidx (empty)

SDT commands - create

(c)reate fileName

Creates a new SFS file. All the file information is prompted for inturn. To aid usability and eliminate creation errors, SDT will make

cicssdt

sure everything entered is valid and default to sensible values ifnothing is entered. One exception is the record Field Name and indexField Name that use an empty entry to indicate there are no morefields. Also, some fields may not be able to determine a default entryand reprompt for input after displaying some help. If q! is entered atany 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 fileName

Reads records from a file on the SFS. Records can be read from thebeginning of the file or from a specific key based on any active index.Records can also be read continuously or individually. When a keyvalue is specified 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 ahexadecimal representation of the key:0x0a01 ...

A key that corresponds to a string field must be entered in the form:$string

If the read is not continuous you have the option to delete or updateeach record read. If the record is to be updated the primary indexcannot be changed. If nothing is entered for a field during an updatethe field is left unaltered, otherwise data entry is same as for the write

cicssdt

command. This command will not handle , nor will it handle readsusing the Entry Sequence Number for sequential files. 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 field data andshould therefore not be used to check the data integrity of recordscontaining long fields. 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 fileName

Writes records to a file on the SFS. Text or hexadecimal data can beentered in each field; these cannot be mixed. Hexadecimal is enteredin the following form:0x010203 ...

If the field is long and you need to enter a large amount of data, ashorthand method can be used. For example, to fill the remainder of afield with 33 ’A’ characters enterA>>32

or enter0x20>>32

for 33 spaces.

You must enter something in at least one of the fields in the record forSDT to write it; if all are left blank no record will be written. Partlyfilled fixed-length fields are not automatically padded with spaces. IfA>>32 would exceed the field length the string “A>>32” is takenliterally. Automatic writes can be achieved by specifying #N followed

cicssdt

by the number of writes in an unsignedInt32 field. For example, use#N10 to add 10 records automatically. If #N or #N0 is specified, writeswill continue until an error occurs.cicssdt -s SFSname -c w recover

[skey1 ][ byteArray ] [Size:00008][001[srecord1 ][ byteArray ] [Size:00042][Some text

[Another ? [Y]/N n

[1] Record(s) Added OK.

SDT commands - empty

(e)mpty fileName

Empties a file of all committed records. SDT provides two types ofrecord emptying; an exclusive empty and a shared empty. Anexclusive empty will attempt to get exclusive access to the file to issuean empty call. If a shared empty is requested SDT will delete as manyrecords as it can, leaving the ones that are locked. The exclusiveempty is recommended as this guarantees an empty file.cicssdt -s SFSname -c empty recover

[Exclusive Empty ? [Y]/N ....: Y[Empty File "recover" ? Y/[N] y

SDT commands - delete

(d)elete fileName

Deletes a file from the SFS. This command will time out and fail if thefile is still in use.cicssdt -s SFSname -c delete recover

[Delete File "recover" ? Y/[N] y

SDT commands - free

(fr)ee fileName

Destroys all the Open File Descriptors (OFDs) associated with aparticular file. This command should only be used if the file is not inuse. SDT will tell you the transaction identifiers related to each OFD itdestroys. The transaction identifiers will not necessarily disappearwith the OFD. Use tkadmin commands to check the status of thetransaction identifiers if the file still remains locked. For details oftkadmin commands, see the Encina Administration Guide Volume 1:Basic Administration.

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 fileName

Adds a secondary index to the SFS file. Exclusive access is requiredfor this command, so the file should not be in use. The secondaryindex will be added and made active automatically. Typing q! willcancel the command.cicssdt -s SFSname -c a Angus

[Filename ...................: Angus[Secondary Index Name........: index2[Is Index Unique ? [Y]/N ....: n[Alternate Rec. Spec. ? Y/[N]: N[Index Field 01: Field Name .: f2[Index Field 01: Ordering ...: d[escending][Index Field 02: Field Name .:

SDT commands - delindex

(deli)ndex fileName

Deletes a secondary index from the SFS file. Exclusive access isrequired for this command, so the file should not be in use.cicssdt -s SFSname -c delindex Angus

[Secondary Index Name........: index2

SDT commands - info

(i)nfo fileName

Shows detailed information about the SFS file. This command will listall the active Open File Descriptors (OFDs) and locks held on the file.This is particularly useful to see if a file is still in use or hasunresolved 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

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: 00000002Isolation: 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: 00000002Isolation: 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 LockLock 03: Record Write Lock held on index f1----------------------------------------------------------------

SDT commands - server

(ser)ver serverName

Changes the current SDT server to the new one specified. Thecomplete server name must be given. If the new server cannot becontacted the old server remains current.cicssdt -s SFSname -c ser /.:/cics/sfs/jim

[Contacting new server... (Server OK)]

SDT commands - qtos

(qt)os QSAMfileName

Transfers and converts a QSAM file to an SFS file.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 SFSfileName

Transfers an SFS file to a flat file. The format of the flat file can eitherbe SDT format or Asis (the file is transferred byte by byte as it is). InSDT format the flat file will start with a header containing informationon the structure of the file, followed by a newline character and aneight-byte number. The number is the length of the record excludingthe number itself. If the file is transferred Asis, no extra information iscontained in the flat file. A single record or a range of records can be

cicssdt

dumped. The record number corresponds to the position of the recordusing the primary index. To dump record 10, enter 10 at the [DumpRecord(s) prompt. Type 10- to dump records from 10 onwards andtype 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 SFSfileName

Transfers a flat file produced from the stof command to an SFS file.The SFS file must already exist, but does not have to be the file usedto create the flat file. In fact, ftos will transfer anything that will fitinto the specified SFS file. See the stof command for the expected flatfile format. If the SFS file does not exist and the flat file is in SDTformat, SDT will ask if you want the file to be created. If the flat file isnot in a recognised format produced using the stof command, ftoswill read the flat file as it is and will attempt to fit the data into theSFS file.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 promptreturns control to SDT.cicssdt -s SFSname -c !

[Exit To Shell. Use <Ctrl-D> To Return .....

ls q* (Open Systems) ordir q*.* /w (Windows NT)qsam qsam.dfh qsamTest qsamcsd.sdt.defqsam.conv qsam.log qsamcsd qsamcsd.sdt.logqsam.def qsam.sdt.def qsamcsd.dfh qtest|D

SDT commands - quit

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 specific online help for SDT commands.cicssdt -s SFSname ? create

QSAM to SFS file transfer: The purpose of this section is to help youunderstand how to transfer QSAM files from a host system to a target systemrunning a CICS for Open Systems product.

When a file is sent directly to a target system, record boundaries are lost whenit is received. By capturing the file on TSO or CMS in netdata format andsending it as a binary file to the target system using the File Transfer Program(ftp), the original netdata format is preserved.

The cicsnetdata program is used to read the file and re-construct the outputrecords with the count preceding each record, as expected by the cicssdt qtoscommand.

If a file is in netdata format, you will find that control records INMR01,INMR02, INMR03 precede the data, and INMR06 follows the data; thesenames are in EBCDIC. All input (control records and data) is segmented. Thefirst byte of a segment contains the segment length, including itself. Thesecond byte of the segment contains a flag byte. The flag settings are:0x80 first segment0x40 last segment0x20 segment is part of a control record

To transmit a file from TSO:

1. Enter: transmit (nodeName/userId) DSN (data.file) OUTDSN(data.NETDATA)SEQTRANSMIT can be abbreviated to XMIT.nodeName/userId is required syntactically. Although it is not used whentransmitting to a file, it is validated, so specify a known node and userid.DSN names the input to XMIT.OUTDSN names the output netdata file. The type NETDATA is suggested.If the input was a PDS member, then SEQ is required, or the file will notbe usable on the target system. The name of utility function must beINMCOPY for correct results (see sample messages below).

cicssdt

The target file name can also be specified, if different from the source.Make a note of the byte count, which should be the same for the file onthe target system. The target system keeps the name in lower case, eventhough it was upper case in TSO.

To transmit a file from CMS:

1. Enter: sendfile dataFile TO *to send the file to your reader in netdata format. Do not receive it becausereceive will decode the netdata. Use CP commands to order it and changeits class to suit the reader. Define a temporary disk if the file is large.

2. Enter: read data NETDATA A to read the file and preserve the netdataformat.

The target file name can also be specified, if different from the source.Make a note of the byte count, which should be the same for the file onthe target system. The target system keeps the name in lower case, eventhough it was upper case in CMS.

To run the cicsnetdata program:

cicsnetdata < data.netdata > outputfile

Messages are sent to the operating system file stream stderr.

Messages from a sample run of cicsnetdata (origin CMS):

cicssdt

... control record: INMR01

... logical record length 80

... origin node name WINVMB

... origin userid BAILEYM

... target node name WINVMB

... target userid *

... origin time stamp 19931029164640000000

... no of files 1

... file number 1

... file size in bytes 2048

... file organisation 4000

... name of utility function INMCOPY

... record format 8000

... name of the file A DATA FILE

... filemode number0

... last change date 19920611095242000000

... file size in bytes 2048

... file organisation 4000

... record format 0001

... 22 input records

... 4 control records

... 18 output records

Definition files used by qtos:

In addition to the QSAM data file produced by the cicsnetdata program theremust be two other definition files for a successful conversion:v QSAMfilename.sdt.def

This file must be in the same directory as the QSAM data file. It containsthe key and data information about each QSAM record.The sample file qsam.sdt.def, describes what each tag means. A sampledata file can be found in prodDir/src/examples/sdt.

v QSAMfilename.dfhThis file must also be in the same directory as the QSAM data file and isthe DFHCNV template source for the QSAM records. SDT will not validatethis file so it is recommended that the file is checked using the cicscvtprogram first. SDT only understands the source, not the compiled outputfrom cicscvt. The sample file qsam.dfh shows a typical template.

To run qtos:

A sample QSAM data file qsam.netdata has been provided to demonstrateQSAM to SFS conversion using the qtos command. The following describesthe steps necessary to convert this example:

cicssdt

1. Convert qsam.netdata to SDT-readable format using the cicsnetdataprogram as follows:cicsnetdata < qsam.netdata > qsam

to produce a file called qsam in the current directory.2. Create a suitable SFS file to receive the QSAM records. For this example,

entercicssdt -s SFSname -c create qsamTest

3. Make sure you have the following files in a directory you can write to:qsamqsam.dfhqsam.sdt.def

The default code pages for conversion are defined at the top of the fileqsam.dfh; these may have to be changed, depending on your operatingsystem.

4. Run cicssdt so that it is working with the server which has qsamTest onit.Entercicssdt -s SFSname -c qtos qsam

The file qsam must be in the current directory. SDT will show a runningcount of the records being transferred. If an error occurs the file must beemptied before it is reloaded, unless the setopen command has beenpreviously used to give a transactional load.

5. When the command has finished the SDT prompt should reappear and alog file will have been created in the current directory. The file will becalled qsam.sdt.log in this example. Check this log file to make sure SDTpicked up all the record types and there were no conversion errors.

cicssdt

cicssetupclients - Configure DCE for the CICS clients

X X X X

If you are using DCE authentication the command cicssetupclients is used toconfigure a DCE client for a CICS client or region. On CICS for AIX only, it isalso used to install the AIX kernel extensions used by the CICS terminalemulator. You must run this command once for each host before you run aterminal or region.

You may also need to use this command if you add or change a network cardin your client machine since the card number is used to generate the principalname for the client.

Syntax

cicssetupclients [-I] [-v] [-m] [-d]

cicssetupclients -?

Descriptionv 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 configure a DCEclient for a CICS client.This command creates a keytab file containing theclient’s principal and account. The keytab file is placed in the directory/var/cics_clients. Run this command on all hosts which will run CICSclients or regions.

On CICS for AIX only, use this command to install the AIX kernel extensionsused by the CICS terminal emulator.

If you are not using DCE authentication and you are not running CICS forAIX you do not need to use this command at all.

Options

-I (Uppercase letter “i”) Ignores errors.

-m installs the kernel extensions on CICS for AIX only withoutconfiguring DCE.

cicssetupclients

-d configures DCE but does not install the kernel extensions on CICS forAIX only.

-? displays the usage message.

Examples

To configure DCE for a newly installed CICS client, first log in as root oradministrator and authenticate your DCE principal, then enter:

cicssetupclients

cicssetupdce - Create directories and groups within a DCE cell

X X X X

Creates directories and groups for CICS within DCE’s Cell Directory Service.

Syntax

cicssetupdce [-v] [-C | -I [-a | -o]]

Description

cicssetupdce adds the following directories and groups to DCE’s CellDirectory Service. The directories will eventually contain entries for SFS andregions:

Directories:

/.:/cics CDS directory

/.:/cics/ppcCDS directory

/.:/cics/ppc/gatewayCDS directory

/.:/cics/trpcCDS directory

/.:/cics/tmxaCDS directory

/.:/cics/profileCDS profile

/.:/cics/sfsCDS directory

Groups:

cics_userscontains principals for CICS processes

cics_admincontains principals for CICS administrators

cics_sfscontains principals for SFS

cics_ppcgwycontains principals for PPC group

cicssetupdce

cics_regionscontains principals for CICS regions

You need to run cicssetupdce only once per DCE cell, during theconfiguration of a newly installed CICS system. To run it, you must beauthenticated as a DCE principal (such as cell_admin) with sufficientprivileges to create or view a DCE group, directory or object and to set thenecessary Access Control Lists (ACLs).

ACLs control the security of directories. Use cicssetupdce to set the ACLs foreach newly created directory so that the members of the appropriate group,the principal that is executing the command, the CDS groupssubsys/dce/cds-admin and subsys/dce/cds-server have access to the directoryand its objects. Members of the other groups are granted more restrictiveaccess to these directories based on their needs. cicssetupdce also sets theinitial container and initial object ACLs.

cicssetupdce first searches to see if the groups and directories it is about tocreate currently exist. If you specify the -l flag when you invoke cicssetupdce,it overwrites any existing groups or directories with new ones. You can usethe -a or -o option to control how cicssetupdce changes the ACLs of existingdirectories or groups. If neither of these flags is specified, then the ACLs forpre-existing directories are left unchanged because to alter these ACLs maycompromise security. If the -l flag wasn’t used, cicssetupdce stops with anerror code when it encounters a pre-existing group or directory.

Note: Make sure that your /etc/hosts file contains a valid host name and thatits permissions are set correctly.

Options

-I (Uppercase i) Ignores error messages about pre-existing entries. Errormessages are changed to warning messages and cicssetupdcecontinues, overwriting existing directories and groups with new ones.Use this flag if a DCE cell has already been partially pre-configured,possibly by a previous invocation of the command that wasinterrupted.

-a ACLs defining how the groups access the CDS directories are added tothe ACLs for the existing CDS directories. ACLs defining how anyother principals or groups access these directories are not changed. Ifyou use this option, check that the resulting ACLs meet your securityneeds. Use this with the -l flag

-o ACLs defining how the groups access the CDS directories override theACLs for the existing CDS directories. Any pre-existing ACLs forother principals or groups are removed. This flag can be used only in

cicssetupdce

a cell whose CDS server principals are members of groupsubsys/dce/cds-server. Use this with the -l flag.

-C removes any existing CICS groups and CDS directories prior torecreating them. Accounts that are members of these groups are alsodeleted. Using this flag is equivalent to executing cicscleandce beforerunning cicssetupdce. Use this parameter only if you know that noneof the entities selected for removal are required.

Examples1. 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 directoriesare discovered, cicssetupdce adds to their ACLs, the ACLs defining theaccess privileges for the CICS groups.

2. If you want cicssetupdce to display what it is doing while it creates therequired groups and directories and to fail if it discovers pre-existinggroups or directories, enter:

cicssetupdce -v

Because you have not specified the -l flag, cicssetupdce stops with anerror code if it discovers a pre-existing group or directory.

cicssetupdce

cicssfmt - Statistics formatter

X X X X

To extract data from a statistics file or files that CICS creates as part of a CICSstatistics sequence.

Syntax

cicssfmt [-c categoryNames] [-s startTime] [-e endTime] [-l pageLength][-w pageWidth] [-h] [-i] fileName1 ... fileNamen

cicssfmt [-?]

Description

cicssfmt formats the CICS statistics data into a form that can easily be writtento operating system standard output. cicssfmt is requested from the operatingsystem shell, and can be replaced with your own customized version. Thisinformation describes the version delivered with CICS and this may notcorrespond to the version running on your system.

If you specify too few or too many parameters, or enter the -? option, cicssfmtsends some explanatory text on how to use the command to the operatingsystem standard error output.

If the named statistics file does not exist, cicssfmt outputs an error to thestandard error output. If the named statistics file exists, cicssfmt formats allstatistics records to standard output.

cicssfmt is a sample program generated from the source file cicssfmt.c. It canbe built with the sample makefile in the directory prodDir/src/samples/sfmtusing the command make -e -f Makefile (on Open Systems) or nmake -e -fMakefile (on Windows NT).

If you want to replace cicssfmt with your own program, you must change thesample makefile accordingly.

The following files make up the statistics data formatter:

Table 4. Statistics data formatter files

File Type Contents

prodDir/bin/cicssfmt (CICS on OpenSystems) or prodDir/bin/cicssfmt.exe(CICS for Windows NT)

executable The executable statisticsformatter program

cicssfmt

Table 4. Statistics data formatter files (continued)

File Type Contents

prodDir/src/samples/sfmt/cicssfmt.c,prodDir/src/samples/sfmt/cicssf_delta.c,prodDir/src/samples/sfmt/cicssf_summ.c,prodDir/src/samples/sfmt/cicssf_supp.c

source Sample statistics formatterprogram source

prodDir/src/samples/sfmt/Makefile makefile Sample makefile thatbuilds and installs thestatistics formatter

prodDir/lib/libcicssfmtsa.a (CICS onOpen Systems),prodDir/lib/libcicssfmtsa.lib (CICS forWindows NT)

object library Library containing thefunctions for reading andprocessing a statistics datafile

prodDir/include/cicssfmt.h include Definitions used by thesample statistics formatter

prodDir/include/cicssfmt_msg.h include English messages used bythe sample statisticsformatter

/msg/en_US.iso8859/cicssfmt.cat (CICSfor HP-UX)prodDir/msg/en_US/cicssfmt.cat (CICSfor AIX and Solaris)

message text Message catalog forcicssfmt produced bygencat. Only required byformatter programscompiled with CICSrelease 2.1.1 or earlier.

Options

-c categoryNamesspecifies a comma-separated list of categories to be formatted. If the -coption is not specified, all categories are formatted. The categories areas follows:

DUMPDump statistics

FILE File statistics

ISCM Intersystem Communication Management statistics

JOUR Journal statistics

LUWMLogical Unit of Work Management statistics

PROG Program statistics

RTDB Runtime Database statistics

STOR Region Storage statistics

cicssfmt

STOT Task Storage statistics

TASK Task statistics

TERM Terminal statistics

TDQUTransient 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 TRANcategory. However, it does collect details, so to obtaintransaction statistics, you must specify the TRAN category withthe -i option.

-s startTimespecifies the start time for the report to be produced. You shouldspecify the time in the format yymmddhhmmss. The default startingtime is the timestamp on the first record in the file.

-e endTimespecifies the end time for the report to be produced. You shouldspecify the time in the format yymmddhhmmss. The default endingtime is the timestamp on the last record in the file.

-l pageLengthspecifies the length, in lines, of each page of the report. The defaultvalue is 24 lines on each page.

-w pageWidthspecifies the width, in columns, of each page of the report. The defaultvalue is 80 columns.

-h suppresses the printing of page headers. The default is to print pageheaders.

-i indicates that detailed statistics are required. The default is to producesummary statistics.

fileName1 ... fileNamenspecifies the files containing the CICS-generated statistics.

-? causes the usage message to be displayed. cicssfmt also displays theusage message if you enter the command syntax incorrectly.

Examples1. To list statistics file shut001:

cicssfmt shut001

cicssfmt

2. To list transaction interval statistics produced from 9 a.m. on January 1st,1995 onwards, from file shut001 with no page headers:

cicssfmt -c TRAN -s 950101090000 -h -i shut001

3. To list file summary statistics produced up to 6 p.m. on January 1st, 1995,from file shut001 with no page headers:

cicssfmt -c FILE -e 950101180000 -h shut001

4. To list statistics file shut001 with a report page width of 70:cicssfmt -w 70 shut001

See the CICS Administration Guide for additional information.

cicssfmt

cicssfs - Start a CICS SFS

X X X X

You use this command to start an SFS that CICS uses.

Syntax

Syntax (CICS on Open Systems)cicssfs [serverName] [attributeName=attributeValue ... ] [-a] [-I] [-tcomponent:traceMask [:component:traceMask] ... ] [[-T traceClass[=traceClass ... ] = [modifier,modifier]outputClass:destination]...] [-v]

cicssfs -?

Syntax (CICS for Windows NT)cicssfs [serverName] [attributeName=attributeValue ... ] [-a|-nlv] [-I] [-tcomponent:traceMask [:component:traceMask] ... ] [[-T traceClass[=traceClass ... ] = [modifier,modifier]outputClass:destination]...] [-v]

cicssfs -?

Descriptionv You must create the following logical volumes for the SFS:

– The logical volume used for journal data written by the SFS, as specifiedby 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 file data, as specified by theDataVolume attribute for the SFS. The default is sfs_shortName, whereshortName is the server short name.

v When an SFS is created with the cicssfscreate command an operatingsystem userid is associated with the server. This userid must have read andwrite 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

the authority to read and test the Cell Directory Service (CDS) directorywhere the CDS object representing the SFS will be created, and to read theobject itself.

cicssfs

For example, to start a server named /.:/cics/sfs/SFSserver1, you needread and test permission for directory /.:/cics/sfs, and you need readpermission for /.:/cics/sfs/SFSserver1.Usually, you must be a DCE cell administrator or a member of the DCEgroup 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 terminatedabnormally, the lock file of the server might not be cleaned up. You mustuse the cicssfslock command to remove the lock file, which is:/var/cics_servers/SSD/cics/sfs/modifiedCDSname/lock

Refer to “cicssfslock - Release an SFS lock file” on page 237 for moreinformation.

The command cicssfs starts an SFS that CICS uses and waits for it to initializebefore returning. You run cicssfs from the operating system command line.

The output of the SFS is directed to the file whose path is constructed fromthe Cell Directory Service (CDS) name of the server. CICS removes the /.: or/... from the front of this name, and substitutes the modified 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 samedirectory as the output file 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 attributevalue 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 theEncina trace facilities. It is expected that these options will only be used underthe direction of your support organization, so they are not documented herein detail. For more information about problem determination for SNAproducts 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

cicssfs

Options

serverNameis the name of the SFS to be started.If the server is being cold-startedthe name of the server must be specified. If the server is not beingcold-started and the name of the server is not specified, then the nameof the sever is obtained from the environment variableCICS_SFS_SERVER.

attributeName=attributeValueis the value or values that override those in the CICS permanentdatabase for the server.

-a starts the SFS in administrative mode. You cannot cold start an SFS inadministrative mode, so this flag 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 afterfilling up.

-t ... specifies Encina trace masks.

-T ... specifies Encina trace output classes. -T can be used more than once.

-v requests verbose output.

-? is the flag which produces the usage message.

0 SFS started.

non-zeroUnsuccessful attempt to start SFS.

To start an SFS SERVER1:cicssfs /.:/cics/sfs/SERVER1

Additional information is contained in the CICS Administration Guide and theCICS Administration Guide.

cicssfs

cicssfsconf - Configure a CICS SFS

X X X X

You use this command to configure 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 runningthe region.

The command cicssfsconf configures the SFS to meet the CICS regionrequirements. You run cicssfsconf from the operating system command line.

If the region is not using DCE servers the cicssfsconf command will assumethat the SFS is also not using DCE servers and that the SFS will be found onone of the machines specified by the environment variable CICS_HOSTS.

Note: You can configure all queues (this is the default) at a time for each useof cicssfsconf or, if only one queue is specified, only that queue isconfigured.

Options

-q is used to request “quiet” processing. If -q is specified, no informationmessages will be displayed.

wc configures the SFS without changing any Region Definition values.

regionNamespecifies the name of the CICS region for which you are configuringthe SFS.

cicssfsconf

ra configures the SFS for recoverable auxiliary TS queues.

na configures the SFS for non-recoverable auxiliary TS queues.

lr configures the SFS for logically recoverable TD queues.

pr configures the SFS for physically recoverable TD queues.

nr configures the SFS for non-recoverable TD queues.

lqp configures the SFS for locally-queued protected STARTs.

lqu configures the SFS for locally-queued unprotected STARTs.

attributeName=attributeValue ...specify attribute names and values to override those in the RegionDefinitions (RD).

-R (CICS for AIX and CICS for Solaris only)resets the region to use Structured File Server (SFS) instead of DB2.

DefaultFileServer=serverNamespecifies the name of the Structured File Server (SFS) to be used. Thename of the server will be stored in the DefaultFileServer attribute inthe Region Definitions (RD).

Returned Values

0 SFS configured

non-zeroUnsuccessful attempt to configure SFS.

Examples1. To configure the SFS for REGION1 without changing any attributes of the

Region Definition:cicssfsconf wc REGION1

2. To configure the SFS for REGION1 for recoverable auxiliary TS queues,logically recoverable TD queues, and protected STARTs:

cicssfsconf ra REGION1cicssfsconf lr REGION1cicssfsconf lqp REGION1

3. To configure the SFS for REGION1 and change the maximum number ofrecords 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), usingserver SERVER1:

cicssfsconf -R wc REGION2 DefaultFileServer=/.:/cics/sfs/SERVER1

cicssfsconf

cicssfscreate - Create a CICS SFS

X X X X

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) orcicsgroup (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 logicalvolumes and their associated raw devices. Either make the SFS userid theowner of the volumes, or add the SFS userid to the group that can read andwrite the volumes, so that volumes can be shared.

The user for the SFS must be set up as a local user on the machine. Theuser definitions must not come from the Network Information Service(NIS).

v You must be a member of the group cics (CICS on Open Systems) orcicsgroup (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 allowCICS to use it. You run cicssfscreate from the operating system commandline.

cicssfscreate adds:v An SFS into the CICS server database.

cicssfscreate

v Its entry for the operating system mechanism which is used to start andstop long running processes.

v If you are using DCE authentication, its DCE principal, its DCE accountand its DCE keytab entry.

You must set the ShortName attribute override to a unique ShortName withinall SFS that CICS uses in this DCE cell. On CICS for AIX you can get a list ofall the current SFS ShortNames used by CICS by entering the following shellcommands:

for i in cicsget -c ssd -l | cut -d' ' -f1docicsget -c ssd $i | grep ShortNamedone

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. Youmust create the remote SFS while logged on to the remote machine.

Options

-v produces verbose informational output.

-I continues processing on non-critical errors

-S causes the SFS to be created without using DCE servers.

-m modelNamespecifies the name of the SFS to model this server on. If you do notspecify a name, the server is modeled on the default SSD entry.

serverNamespecifies the name of the SFS, SSD key, to be created.

attributeName=attributeValue ...specify attribute names and values to override those in the model ordefault server.

-? produces the usage message.

Returned Values

0 SFS created.

non-zeroUnsuccessful attempt to create SFS.

cicssfscreate

Examples

To create an SFS named SERVER1, with a ShortName of SERVER1 and an SFSuserid of SFSSERVER:

cicssfscreate /.:/cics/sfs/SERVER1 ShortName=SERVER1 UserID=SFSSERVER

cicssfscreate

cicssfsdestroy - Destroy a CICS SFS

X X X X

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 theSFS.)

The command cicssfsdestroy destroys an SFS that CICS uses. You runcicssfsdestroy 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 theauthority to do so.

The output of the SFS is directed to the file whose path is constructed fromthe CDS name of the server. CICS removes the /.: or /... from the front ofthis name, and substitutes the modified CDS name into:

/var/cics_servers/SSD/cics/sfs/modifiedCDSname/msg

For example, output from SFS /.:/cics/sfs/myserver goes to the file:/var/cics_servers/SSD/cics/sfs/myserver/msg

cicssfscreate

After you have run cicssfsdestroy, it is useful to also carry out the followingoperations:v Remove the operating system user id specified 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 specified in the DataVolume attribute in theSSD. (Use the operating system to do this.)

v If you are using DCE authentication, reauthenticate the DCE tickets for anydce_login contexts that have accessed the server, either by logging in to theDCE again or by using the DCE command kinit. This will remove anycached tickets for the old server, and so avoid problems if a new SFS iscreated using the same name as the one just destroyed.

Options

-v produces verbose informational output.

-S causes the SFS to be destroyed without using DCE servers.

serverNameis the name of the SFS to be destroyed.

-? is the flag 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-zeroUnsuccessful attempt to destroy SFS.

Examples

To destroy an SFS SERVER1:cicssfsdestroy /.:/cics/sfs/SERVER1

The CICS Administration Guide and the Planning and Installation Guide containadditional information.

cicssfscreate

cicssfsimport - Build an SFS’s metadata

X X X X

You use this command to build an SFS’s metadata using one or more entriesin a schema file.

Syntax

cicssfsimport -i schemaFileName -s serverName [-I] [-f fileName][[-x indexName] ... ]

Descriptionv You must be logged in as a user with root or administrator privileges.v The userid must have read/write permission for the schema file as defined

explicitly by the file permissions.v You must have sufficient privileges to create SFS files (CICS on Open

Systems). You must be a member of the group cicsgroup (CICS forWindows 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 file 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 Definitions (SCD) to SFS, you need to be a member of thegroup cics_admin.

The cicssfsimport command creates one or more files on an SFS. It builds theSFS’s metadata using one or more entries in a Schema File Definitions (SCD).

The server does not need to be present in the Structured File ServerDefinitions (SSD), so you can build arbitrary SFSs without the overhead ofentering their details into the system.

All the files are created before secondary indexes are created. A file that isnamed in the list must exist at index creation time. If a file or index named inthe lists does not exist in the schema file, there will be a warning message, butthe import continues.

cicssfsimport

Options

-i schemaFileNameis the relative or absolute path to the schema file. The relative path isin relation to the working directory.

-I is a flag to force the command to ignore errors. This is useful if aprevious cicssfsimport did not complete, for example after a machinecrash, but some files have been created. If the -I flag is set, you canrun cicssfsimport again, and any ″file exists″ errors generated areignored.

-s serverNameis the Cell Directory Service (CDS) name of the SFS on which the filesand indexes are to be built.

-f fileNameis a file from the schema to be created. To specify a list of files, specifyeach file with a separate -f flag. If you do not specify the -f option,then all files and indexes in the named schema file are created. If youspecify the -f option, but do not specify a -x option, then all theindexes for that file are created.

-x indexNamespecifies an index from the preceding file to add. To specify a list ofindexes, specify each index with a separate -x flag. If a set of indexesassociated with a file does not include the primary index, a primaryindex is created. If you specify the -f option, but do not specify a -xoption, then all the indexes for that file are created.

Examples1. To create two files, FILE1 and FILE2 on a server SERVER1, using the entries

from schema file 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 file FILE3 and all its indexes on a server SERVER1, using theentries from schema file SCHEMA1:

cicssfsimport -i SCHEMA1 -s /.:/cics/sfs/SERVER1 -f FILE3

3. To create all files and indexes from a schema file SCHEMA2 on SERVER1,ignoring errors:

cicssfsimport -i SCHEMA2 -s /.:/cics/sfs/SERVER1 -I

cicssfsimport

cicssfslock - Release an SFS lock file

X X X X

Use this command to release an SFS lock file that may have been left when anSFS 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 toserialize the create, start, stop and destroy phases of an SFS. The lock file is in:

/var/cics_servers/SSD/cics/sfs/serverName/lock

Options

-l cicssfslock to wait until the SFS that owns the lock file is no longerrunning and then takes the lock.

-u causes the lock file for the SFS to be released unconditionally.

-t cicssfslock to try to take the lock file but to return immediately if it isunsuccessful.

serverNamespecifies the name of the SFS.

-? causes the usage message to be displayed. cicssfslock also displaysthe usage message if you enter the command incorrectly.

Returned Values

0 Successful

1 Unsuccessful

Examples

To release the lock for SFS sfs_SFS_SERV:cicssfslock -u /.:/cics/sfs/sfs_SFS_SERV

cicssfslock

cicssfsshut - Shut Down a CICS SFS

X X X X

You use this command to shut down an SFS that CICS uses.

Syntax

cicssfsshut [-f] [-c] serverName

cicssfsshut -?

Descriptionv 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

the authority to read and test the Cell Directory Service (CDS) directorycontaining 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 youneed read permission for directory .

Usually, you must be a DCE cell administrator or a member of the DCEgroup cics_users.

v If the SFS is not using DCE authentication (that is, if NameService=none inthe SSD) you must not be logged into DCE.

The command cicssfsshut shuts down an SFS that CICS uses. You runcicssfsshut from the operating system command line.

The output of the SFS is directed to the file whose path is constructed fromthe Cell Directory Service (CDS) name of the server. CICS removes the /.: or/... from the front of this name, and substitutes the modified CDS name into:

/var/cics_servers/SSD/modifiedCDSname/msg

For example, output from SFS /.:/cics/sfs/sfs_SFS_SERV goes to the file:/var/cics_servers/SSD/cics/sfs/sfs_SFS_SERV/msg

Returned Values

-f forces an abnormal shutdown of an SFS. Do not use this flag unlessyou cannot shut the SFS down without it.

-c Cancel the SRC subsystem in which the SFS is running. Do not usethis flag unless you need to terminate the server abnormally.

cicssfsshut

serverNameis the name of the SFS to shut down.

-? is the flag that produces the usage message.

Returned Values

0 SFS is shut down.

non-zeroUnsuccessful attempt to shut down SFS.

Examples

To shut down an SFS SERVER1:cicssfsshut /.:/cics/sfs/SERVER1

See the CICS Administration Guide for related information.

cicssfsshut

cicsstart - Start a CICS region

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 successfullystarts and runs post-initialization programs, CICS allows transactionprocessing.

It fails if the region is locked, in which case cicsstop should be used to ensurethat the region is shutdown.

By default cicsstart performs an AUTO start of cics. This normally involvesclearing SFS.

You can run the cicsstart command directly from the command line.

You can override multiple RD parameters on the same command line. Tomake permanent changes to the RD, use the CICS resource managementcommands.

For more information, see the CICS Administration Guide.

Options

-c forces cicsstart to perform a cold start of CICS.

-a forces cicsstart to perform an automatic start of CICS.

-o is used to override Region Definitions (RD) for this region startup.

attributeName=attributeValueis an attribute and its value to be used in this startup. MultipleattributeName=attributeValue pairs can be specified in the -o option. Usedouble quotes to delimit values containing spaces.

cicsstart

regionNameis the name of the region to be started. If you do not specify a regionname, CICS starts the region specified by the environment variableCICSREGION.

Examples

To cold start the region named REGION1:cicsstart -c REGION1

cicsstart

cicsstop - Stop a CICS region

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 currentprocessing and releases resources before shutting the region down.

If the -f (force) option is used, cicsstop releases the resources, but does notwait 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 forces cicsstop to shut the region down after releasing resources.

-k forces cicsstop to shut the region down immediately, killing all CICSprocesses, removing lock files, and cleaning up shared memory.

regionNamespecifies the name of the region to be stopped. If you do not specify aregion name, CICS stops the region specified by the CICSREGIONenvironment variable.

Examples

To shut down the region named REGION1 immediately:cicsstop -k REGION1

For more information about the shutdown process, see the CICSAdministration Guide.

cicsstop

cicstail - Display the end of a file

X X X X

Use this command to display the console.nnnnnn and CSMT.out files for aspecified CICS region, or to display a user-specified file.

Syntax

cicstail [-r regionName] | [-f fileName] [-b numBytes]

cicstail -?

Description

The cicstail command displays the current console.nnnnnn and CSMT.out filefor a CICS region and displays new lines as they are added to these files.Alternatively, if the name of a file is specified, the output displays that fileand any new lines that are added to the file.

New lines are displayed as they are added to the file or files until thecommand is interrupted when CTRL-C is pressed.

Options

-r regionNamespecifies the name of the CICS region whose files are to be displayed.The cicstail command displays the contents of the region’sconsole.nnnnnn and CSMT.out files in a single output stream. Ifneither the -r or -f options are specified, cicstail displays the files forthe region whose name is set in the environment variableCICSREGION.

-f fileName (CICS for Windows NT only)specifies the name of a file to be displayed. The name can be absoluteor relative to the current directory.

-b numBytes (CICS for Windows NT only)specifies that the display of the file (or files) start numBytes before theend of the file. If the -b option is omitted, the display starts 2,000bytes before the end of the file.

Examples1. To display files for the region REGION1:

cicstail -r REGION1

cicstail

2. To display the file \tmp\file1:cicstail -f c:\tmp\file1

cicstail

cicstcpnetname - Display NETNAME for CICS family TCP/IP connection

X X X X

cicstcpnetname displays the 1-8 character NETNAME which is used by aCICS region on a CICS family TCP/IP connection. This NETNAME is derivedfrom 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 CICSregion using CICS family TCP/IP connections. A CICS region’s NETNAMEused for these types of connections is derived from the Internet Protocol (IP)address and port on which the CICS region is listening for connectionrequests.

Options

-a [ IPaddress | hostName ]specifies the name or address of the network adapter used by theregion to accept CICS family TCP/IP connections. The address can bein 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 defined in the Internet name service. For example

aix5.cicsland.com.

-p portNumberspecifies the Internet port number used by the region to accept CICSfamily TCP/IP connections.

Returned Values

0 NETNAME returned

non-zeroUnable to convert the value passed on the -a flag into an InternetProtocol (IP) address.

cicstcpnetname

Examples1. 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=1435REMOTE_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.

cicstcpnetname

cicsteld - Connect telnet clients to regions

X X X X

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 systemprocess, or as a child of the inetd daemon that is supplied by the operatingsystem.

If you want to register more than five parameters (including the programname) with inetd, create an operating system shell script or command filewhich contains the actual call and parameters for cicsteld, then register theshell script or command file with inetd. For more about setting up thecicsteld server (CICS Telnet server), including registering cicsteld with inetd,see the CICS Administration Guide.

Options

-p principalNamespecifies the DCE principal that cicsteld is to use for authentication, ifDCE authentication is being used.

-P portNumberspecifies the numeric Transmission Control Protocol (TCP) portnumber that cicsteld listens on for incoming telnet client requests. Ifyou do not specify a port number, cicsteld takes the port numberfrom service name entry of cicsteld in the file /etc/services. If youspecify a port number that already exists in /etc/services, cicsteldwill comment out the existing entry and add a new one. If the portnumber is not valid, cicsteld issues an explanation message.

If the inetd daemon has started cicsteld, cicsteld ignores thisparameter because the connection to the telnet client is alreadyestablished.

cicsteld

-n netNamespecifies the network name that is used by the CICS autoinstallprogram to create the terminal identifier of the terminal. If you specifya network name, it must exist in the Terminal Definitions (WD) of theregion. If no network name is specified, the CICS region generates anetwork name when the terminal autoinstalls. If you specify anetName of longer than eight characters, cicsteld truncates the netNameto eight characters, and logs a message.

-r regionNamespecifies the region for cicsteld to connect with. If you do not specifya region, when the user connects to the port, cicsteld presents a menuof available regions and allows the user to select one.

-t initialTransactionspecifies the transaction to be run at initial connection time afterautoinstall. This could be the CESN transaction, to force users to signon.

-e emulationUse this option to override the model type that is selected by cicsteld.

When a region is connected for a telnet client, cicsteld checks if thetelnet client is using a valid terminal. If the terminal is valid, cicsteldselects a model type for that terminal. To override this selection, usethe -e option to specify a user defined model type or a CICS suppliedmodel type. The preferred CICS model types that can be used forcicsteld are:v hft and mft for terminals with extended data streamv lft for terminals that do not have extended data stream.

See the CICS Administration Guide for more information about modeltypes and “Chapter 10. Terminal model definitions” on page 501 forthe definitions of the autoinstall models.

-l localespecifies the National Language Support (NLS) locale to use for thisinstance of cicsteld. If you do not specify this option,

On CICS on Open Systems:

cicsteld uses the locale that is named in the environment variableLANG.

On CICS for Windows NT:

cicsteld uses the locale determined by the Language setting in theInternational section of the Control Panel.

-c clientCodePagecicsteld client (for example, the telnet daemon). The client of cicsteld

cicsteld

is a 3270 emulator that uses an EBCDIC character set, so this must bean EBCDIC code page. If you do not supply this option, cicsteld usesthe code page with shortcode 037. This option corresponds to theCLINTCP option of the DFHCNV macro.

See the table under the -s option.

-s serverCodePagespecifies the code page of the cicsteld server. This requires an ASCIIcode page that matches the code page of cicsteld. If you do notsupply this option, cicsteld uses the code page with shortcode 8859-1.This option corresponds to the SRVERCP option of the DFHCNVmacro.

You can supply the code page for the -c and -s options as a shortcodewhich is recognized and converted by cicsteld as follows:

Table 5. Shortcode and code pages (Open Systems)

Shortcode

Code page

CICS for AIX and CICS forSolaris

CICS for HP-UX

037 IBM-037 american_e

850 IBM-850 roman8

930 IBM-930 japanese_e

932 IBM-932 japanese

EUCJP IBM-eucJP japanese.euc

8859-1 ISO8859-1 iso8859_1

Table 6. Shortcode and code pages (Windows NT)Shortcode Code page

037 IBM-037850 IBM-850930 IBM-930932 IBM-932EUCJP IBM-eucJP8859-1 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 -cISO8859-7 uses ISO8859-7 as the name of the client codepage.

-k keytabFilespecifies the keytab file that cicsteld uses as the servertab file. If youdo not specify this parameter, cicsteld attempts to use the filevarDir/cics_clients/krb5/v5srvtab.

cicsteld

-h hostListspecifies a blank-delimited list of names or addresses of hosts to besearched for the specified region. If a list of host names is notspecified, the contents of the environment variable CICS_HOSTS willbe used. If the environment variable CICS_HOSTS is not set, the localmachine will be searched.

-v (verbose) causes all informational messages to be displayed duringstartup.

-? displays a short help message.

Examples1. 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 REGION2which 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)

cicsteld

cicsterm - Invoke the CICS 3270 terminal emulator

Invokes the CICS 3270 Terminal Emulator, from the operating system, so thatyou can connect to a CICS region.

Syntax

cicsterm [-r regionName] [-n netName] [-m modelId] [-t transId][-A [animatorTTY] [-T animatorTERM]] [-h hostList]

cicsterm -?

Descriptionv 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 defined. Your terminal must either besuitable for autoinstall (see “Terminal autoinstall user program” onpage 390), or have an entry in the attribute NetName in the TerminalDefinitions (WD).

v Your window must contain at least 12 lines, so that the terminal emulatorcan display a menu of region names when necessary. A menu of regionnames is displayed if you do not specify a region when you invoke theCICS 3270 Terminal Emulator. The 12 lines are needed to display variousheaders, PF key legends, blank space, and at least one region name so thatyou can scroll through the list of available regions. If the window containsless than 12 lines, there is an error message, and the terminal emulatorterminates abnormally. It is recommended that you use a window with 25lines.

v If you are using DCE authentication and you are connecting to a region thathas the attribute none, then you must run dce_login successfully beforeusing cicsterm. This causes a DCE ticket to be allocated by the DCEsecurity service. Tickets have a limited lifetime; 10 hours by default. If aticket expires while the client is active, the client is terminated. DCEaccounts may have their ticket lifetime changed.

v If you are not using DCE authentication then either you should not haverun dce_login before using the cicsterm command, or you must have runcicssetupclients with the -d option on the host to which you are connectingin order to create a keytab file in directory /var/cics_clients.

v You must be authorized to run the transactions that you specify. That is, theUD entry for the userid you are using must have the TSL and RSL keys

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 displayedso that you can select one. Your selection is verified before you are connectedto the region. When you use the -r option to specify a region, you are notshown the list and cicsterm connects you to the region you specified.

CICS verifies that your request is valid by checking that the DCE principalmaps to a User Definitions (UD) entry for the selected region. (The DCEprincipal is specified 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 tothose transactions and resources with TSL and RSL keys that match thoselisted 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 theregion as the region’s default userid. You are given access to thosetransactions and resources with TSL and RSL keys that match those listed inthe TSLKeyList and RSLKeyList in the UD entry for the region’s defaultuserid. If a UD entry is not defined for the region’s default userid, then youare given access only to public transactions and resources.

Note: The region’s default userid is specified with the attribute DefaultUserIdin the Region Definitions (RD), as described in “Region Definitions(RD)” on page 32.

After you are connected to the region, CICS leaves you with a blank screenthat is running the IBM 3270 Information Display System emulation. You canenter the transaction identifier of the transaction you want to run.

Alternatively, you can run a transaction immediately when cicsterm is initiallyinvoked, by enteringcicsterm -r regionName -t transId

where regionName is the region name, and transId is the transaction identifier.

The CICS 3270 Terminal Emulator is associated with a particular region forthe lifetime of the cicsterm process. If the region terminates, the cicstermprocess is left running to wait for any current scheduled protectedtransactions for the given terminal when the region is restarted. Otherwise,the cicsterm process terminates.

When cicsterm receives a user interrupt signal SIGINT, it terminatesimmediately. If a transaction is running, it is purged. The purge happens onlyat the start or end of an EXEC CICS call, so the transaction does not terminate

cicsterm

if it is waiting for a resource, or if it is in a loop that does not involve EXECCICS calls. If a transaction in this situation needs to terminate, the systemsadministrator must purge it. Refer to the FORCEPURGE parameterdescription in “CEMT INQ/SET TASK” on page 344.

You can specify a particular terminal to install by using the -n option with theNetName of the terminal from its Terminal Definitions (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 regionNamespecifies the name of the CICS region to which you want to attach. Ifyou do not specify a regionName, CICS displays an interactive menu ofavailable regions that are available for you to select. If there are noregions available, CICS displays an error message.

-t transIdspecifies the identifier of the transaction to run after TerminalEmulator initialization.

-n netNamespecifies the netName to use for installation. To install as a particularterminal, specify the netName of the required terminal. If you omit thenetName, cicsterm autoinstalls, and a unique netName is generated inthe region.

-m modelIdspecifies the name of the model device type (DevType) to use forautoinstallation. See “Processing” on page 254.

-A animatorTTYspecifies the name of the device for ANIMATOR stdin/stdout. If youspecify the -A option without a value, and you are using X Windows,cicsterm will create a window for use as the ANIMATOR console.

-T animatorTERMspecifies the name of the TERM type of the ANIMATOR terminal.

-h hostListspecifies a blank-delimited list of names or addresses of hosts to besearched for the specified region. If a list of host names is notspecified, the contents of the environment variable CICS_HOSTS isused. If the environment variable CICS_HOSTS is not set, the CellDirectory Service (CDS) is searched for a region with the specifiedname. If there is no CDS the local machine is searched.

cicsterm

Examples1. 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 definition for a high function terminal withmulti-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 Definitionson 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 commandline, you can set up cicsterm to run as part of the /etc/passwd configurationfor a particular user authentication or from a profile or shell script. This ishelpful when you always connect to the same region, and you always invokethe same transaction when you are connected to it.

Selecting Suitable Autoinstall Models: The autoinstall program is passed anumber of model entries in the Terminal Definitions (WD). The models thatare selected are:1. The models with a DevType that matches the model parameter specified

in the -m option. For example, when -m hft is specified, the definitions inthe WD stanza that has DevType=hft are used.

2. If the -m option is not specified, the models selected are those with aDevType that matches the environment variable CICSTERM.

3. If CICSTERM is not set, the models selected are those with a DevTypethat matches the environment variable TERM. The default autoinstallprogram will select the first of the models that are passed to it.

See the CICS Administration Guide for descriptions of autoinstall models thatare supplied with CICS.

How cicsterm selects the Locale: cicsterm uses the locale that is held in theenvironment variable LANG. The value of LANG is passed from cicsterm tothe region. Therefore, definitions for the locale that is specified in LANG mustexist in the system on which the region resides.

cicsterm

cicstermp - Printer emulation

The cicstermp command performs a fixed-size printer emulation of 64 lines by132 columns and ignores print attributes such as highlight, underline, highintensity 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 -?

Descriptionv 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 DCEprincipal authenticates with the DCE security service. Tickets have a limitedlifetime, and the default lifetime is 10 hours. If a ticket expires while theclient is active, the client is terminated and any in-flight transactions areabended. DCE accounts can have their ticket lifetime changed.

v Printers cannot be autoinstalled, so there must be an entry in the TerminalDefinitions (WD) whose attribute NetName matches the netName specifiedon the command before a printer can be attached to a region.

v You need to understand about the 3270 terminal subsystem before using thecicstermp command.

CICS 3270 Terminal Emulators associated with printer devices are identical tonormal user CICS 3270 Terminal Emulators, except that printer CICS 3270Terminal Emulators are not connected to an interactive device, so they cannever receive keyboard input. Either CICS must create these printer CICS 3270Terminal Emulators when the region starts up, using the Terminal Definitions(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 isdetected in the data stream sent to the terminal. The data is placed in atemporary file and the print command is issued with the name of thetemporary file appended as a parameter. The temporary file is then erased.

Note that there is no requirement for the print command actually to print thedata. It could, for example, copy the data so that it can be incorporated intodocumentation. Also, note that, since the temporary file is immediately erased,the print command must finish processing the file before returning. This

cicstermp

precludes the use of a command such as the AIX qprt command (without the-c option) that simply records the name of the file 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 mayoccur. If any of these parameters are used when PostScript printer type isnotused, an error message will be sent and cicstermp will terminate.

Options

-n netNamespecifies the network name, which is mandatory. The network namedetermines which printer terminal emulator is selected from theTerminal Definitions.

-r regionNamespecifies the name of the CICS region to which you wish to attach.

-h hostListspecifies a blank-separated list of names or addresses of hosts to besearched for the specified region. If a list of host names is notspecified, the contents of the environment variable CICS_HOSTS willbe used. If CICS_HOSTS is not set, the local machine will be searched.

-t transIdspecifies the transaction identifier of the transaction to run afterprinter CICS 3270 Terminal Emulator initialization.

-P printCommandspecifies the command used by CICS to process the data sent to theterminal. The command is appended with the name of the temporaryfile before it is issued. The default is the operating system lp -ccommand, which in turn uses the default print destination.

-S suppresses the insertion of a blank character between single- anddouble-byte characters.

-p printerTypespecifies the type of printer. The valid printer types are “postscript”and “ps55”. These types are valid in either upper or lower case.

-f font specifies 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 paperTypespecifies the paper size. Valid paper types are:

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 fontSizespecifies the default font size. The default value is 11. This option isvalid only if the printer type is “postscript”.

-R rotates the printed output through 90 degrees. This option is validonly if the printer type is “postscript”.

Examples1. 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 specific printer (lp0) on CICS region wessex and netnamePrinter1:

cicstermp -r wessex -n Printer1 -P "lp -ddest lp0"

4. To print DBCS data with outlines onto PS/55 printers whose queue nameis 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"

cicstermp

cicstfmt - Trace formatter

X X X X

Use this command to create a trace report from the trace data generated bythe CICS trace facility. This trace report is written either to standard operatingsystem output or to an operating system file if you provide a filename.

Syntax

cicstfmt [-h [!]hookIdList] [-m [!]moduleIdList] [-o outFile] [-f fileName][-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 traceformatter, cicstfmt, reads this trace data and generates readable trace outputof the form described in the CICS Problem Determination Guide. The cicstfmtcommand can be used to:v Format a region’s auxiliary trace filev Format a user trace filev List a user’s trace filesv Delete all of a user’s trace filesv Delete some of a user’s trace filesv Format a specific file

If you enter the command syntax incorrectly or specify invalid parameters, thecicstfmt command writes a message to standard error. It does not produce anerror message if a trace file contains invalid data.

The cicstfmt command formats trace files that contain only CICS trace. OnAIX, you can format trace files that contain non-CICS trace by using theoperating system trace formatting utility trcrpt.

Options

-h [!]hookIdListspecifies a list of hook identifiers (separated by spaces or commas) ofthose trace entries that are to be formatted or, if an exclamation point(!) is specified, that are to be ignored. Each hook identifier must be ahexadecimal number between 000 and FFF. A range of hook identifierscan be specified by using the hyphen (−) character. If the list containsspaces, the list must be enclosed in quotes. If this option is not

cicstfmt

specified, the cicstfmt command formats the trace data for all theCICS trace hook identifiers, subject to the effect of the -m parameter.The hook identifiers used by CICS are listed in the CICS ProblemDetermination Guide.

-m [!]“moduleIdList”specifies a list of module names or identifiers (separated by spaces orcommas) of those trace entries that are to be formatted or, if anexclamation point (!) is specified, that are to be ignored. An asterisk (*)can be used as a wild character in a module name. If the list containsspaces, the list must be enclosed in quotes. Each CICS module has afive-character name and a numeric identifier. The names andidentifiers are listed in the CICS Problem Determination Guide.

-o outFilespecifies a filename for the trace report. If you do not specify thisoption, the cicstfmt command uses the standard output.

-f fileNamespecifies the pathname and filename of the trace file you wish toformat.

-r regionNamespecifies the region name. This option is required only if formattingan auxiliary or user trace file, otherwise, it is ignored. The cicstfmtcommand checks that regionName is valid. If regionName is invalid, thecicstfmt command writes an error message to standard error.

If you do not specify a region name, CICS formats trace files for theregion specified by the CICSREGION environment variable.

-s {a | b}specifies that cicstfmt formats one of the auxiliary trace files. Theoptions a or b specify which auxiliary trace file to format. Forexample, specifying -s a formats the trace file specified in the RegionDefinitions (RD) TraceFileA attribute. If you do not specify a or b,cicstfmt writes an error message to the standard error stream.

-u userIdspecifies that the cicstfmt command format a user trace file for useruserId. If you do not specify this option, the command uses the useridspecified by the environment variable LOGNAME.

-n traceSeqNospecifies the sequence number of a user trace file. The cicstfmtcommand uses the userId (specified by the -u parameter) to look upthe trace filename in the TraceFile attribute of User Definitions. It thenuses this value and the traceSeqNo to generate the filename of the usertrace file. For example, if the TraceFile attribute is set to MyTracefile

cicstfmt

and the traceSeqNo is 001, then the user trace file is calledMyTracefile.001. Only one sequence number can be specified after -n.

-p [traceSeqNos]specifies that you wish to delete some or all of a user’s trace files. Ifyou specify any trace file sequence numbers, the cicstfmt commandremoves all trace files associated with the specified traceSeqNos. IftraceSeqNos is not specified, all the user’s trace files are removed. Thecicstfmt command requests confirmation before it deletes all files.More than one sequence number can be specified after the -p option.

Examples1. To format all trace data in auxiliary trace file A for the region REGIONA to

the file auxa:cicstfmt -o auxa -r REGIONA -s a

2. To format trace hooks 584 and 582 from the user trace file 001 for the userUSER1 in the region REGIONB:

cicstfmt -h "584 582" -r REGIONB -u USER1 -n 001

3. To list all of the user trace files for the user USER1 in the region REGIONB:cicstfmt -r REGIONB -u USER1

4. To delete all of the user trace files for user USER1 in the region REGIONB:cicstfmt -r REGIONB -u USER1 -p

5. To delete the user trace file 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 fileTraceFile in the current directory to a file called TraceOutput:

cicstfmt -msto* -o TraceOutput -f TraceFile

See the CICS Administration Guide and CICS Application Programming Guide forrelated information.

cicstfmt

cicstracefilter - Trace filter

X X X X

The cicstracefilter command filters a CICS trace file to select or removespecified trace entries. The trace entries to be selected or removed can bespecified by hook identifier or by CICS module identifier or both. On CICS forAIX only, this command may also be used to filter an AIX EPTF-format file.

Syntax

cicstracefilter [-h [!]hookIdList] [-m [!]moduleIdList]

cicstracefilter -?

Description

cicstracefilter reads standard input, which is assumed to be in the format of aCICS trace file. Each trace entry is echoed to standard output or is discardeddepending on the values of the -h and -m options. The output fromcicstracefilter is also in the format of a CICS trace file and can be formattedusing the CICS program cicstfmt. using the CICS program cicstfmt or, on AIXonly, using the AIX program trcrpt.

Options

-h [!]hookIdListspecifies a comma-separated list of hook identifiers of those traceentries that are to be echoed to standard output or, if ’!’ is specified,the entries that are to be discarded. Each hook identifier must be ahexadecimal number between 000 and FFF. A range of hook identifierscan be specified by using a ’−’ character. The hook identifiers used byCICS are listed in the CICS Problem Determination Guide.

-m [!]moduleIdListspecifies a comma-separated list of names or identifiers of moduleswhose trace entries are to be echoed to standard output or, if ’!’ isspecified, whose entries that are to be discarded. An asterisk can beused as a wild character in a module name. Each CICS module has afive-character name and a numeric identifier. The names andidentifiers are listed in the CICS Problem Determination Guide.

cicstracefilter

Examples1. To select only hook entries for identifiers 581 to 583 and 586 the CICS trace

entries not made by modules StoTA or StoRE in the trace file trace1placing the output in file filteredtrace, enter:

cicstracefilter -h581-583,586 -m!stota,store <trace1 >filteredtrace

2. To remove EXEC CICS interface entry and exit traces from the trace filetrace2, enter:

cicstracefilter -h!582,583 <trace2

cicstracefilter

cicsupdate - Modify CICS resource definitions

X X X X

Use this command to modify existing CICS resource definitions.

Syntax

cicsupdate -c className [-r regionName] [-P | -R | -B] [-f fileName][resourceName] [attributeName=attributeValue ... ]

cicsupdate -?

Description

The Resource Definition Online (RDO) command cicsupdate updates aresource definition of a specified class in the permanent resources database, orinstalls the resource definition into the runtime database, or both.

The cicsupdate command initializes the data structures for the resource withthe current values before overwriting them with your specified 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 defaultassociated with each resource class.

Options

-c classNamedetermines the resource class to which the resource definition is to beupdated, and is one of these two- or three-character codes:

cd Communication

fd Files

gd Gateways

gsd Gateway Servers

jd Journals

ld Listeners

md Monitoring

od Objects

pd Programs

cicsupdate

rd Regions

scd SFS Schemas

ssd SFS Servers

td Transactions

ud Users

wd Terminals

xad Products

-r regionNamespecifies the region whose resource definition is to be updated. If youdo not specify a region name, CICS updates the resource definition inthe region specified by the CICSREGION environment variable.

The -r parameter is invalid if you specify gsd, scd, or ssd as theresource class, because these classes are associated with a collection ofregions rather than with a specific one.

-f fileNamespecifies the file that contains the schema definitions. Use this flagonly when you specify scd (SFS schema definitions) as the resourceclass.

-P instructs the command to update the resource definition in thepermanent database without installing it into the runtime database.This is the default option if you do not specify the -P, -R, or -Boptions.

-R instructs the command to update the runtime database and install theresource definition in a running system. If you are using DCEauthentication, you must be authenticated as a DCE principal beforerunning the command with this flag.

The -R flag is invalid if you specify rd or md as the resource classbecause these classes cannot be updated in a running system, or ifyou specify gsd, scd, or ssd as the resource class, since these classesare not associated with a specific region.

-B instructs the command to update the resource definition in thepermanent database, update the runtime database, and install theresource definition in a running system. The second part of thisoperation fails if there is already an entry in the runtime database, soyou must use cicsdelete -R to delete any existing entry first. If you are

cicsupdate

using DCE authentication, you must be authenticated as a DCEprincipal before running the command with this flag.

The -B flag is invalid if you specify rd or md as the resource classbecause these classes cannot be updated in a running system, or ifyou specify gsd, scd, or ssd as the resource class since these classesare not associated with a specific region.

resourceNameis the name of the resource definition to be updated. You must enter aresourceName for all classes except rd and md. To update the reserveddefault resource definition, enter resourceName as two doublequotation marks (″″).

attributeName=attributeValue ...are the names and values of attributes belonging to the class classNamethat you wish to change.

If you are using cicsupdate from the command line and you want touse a metacharacter such as double asterisks (**), backslash (\), orpipe (|) within an attribute value, you must use a shell escapemechanism. For example, if you want to use ** as a value, you mustenter one of the following:"**"\*\*'**'

You must use the pipe (|) character as the separator for multipleentries into Transaction Security Level (TSL) and Resource SecurityLevel (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 ofthe resource.

Examples1. 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 inthe permanent database and install it in the runtime database:

cicsupdate

cicsupdate -c pd -r REGION4 -B PROG1 \PathName=/var/cics_regions/REGION4/bin/prog1

cicsupdate

cicsupdateclass command

X X X X

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 filename ]

cicsupdateclass -?

Description

The cicsupdateclass command is used when an upgrade of CICS on OpenSystems causes a change to the value of an attribute in the default resourcedefinition file, for example, the default value, or a change in the range ofvalues that the attribute can take. cicsupdateclass globally modifies the valueof each specified attribute for all the resource definition files in that class.

These commands are generated automatically and are included in themigration shell script which was created when you ran cicsmigrate. If you rancicsmigrate to update the warm start region images, the cicsupdateclasscommands are generated with a -w flag.

You can edit the cicsupdateclass commands in the shell script, for example, ifyou wanted to change the default value of an attribute for your system. Youcan explicitly specify the new value using the -n parameter, or you can copy anew value from an existing attribute using the -b parameter.

You can also specify that the attribute value changes only under certainconditions. For example, you can specify that a change occurs only if thecurrent 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 currentvalue is equal to a specified value, you can specify either a numerical value,or a valid character value. You can also specify that a change occurs only for acertain stanza by naming its key.

Options

-r regionNamespecifies the name of the region being modified. It is optional only forthe following resources: ssd, gsd, and scd.

-w updates the warm start region images.

cicsupdateclass

-c classNamespecifies the name of the class being modified. Valid classes are:

cd Communication definitions

fd File definitions

gd Gateway definitions

gsd Gateway server definitions

jd Journal definitions

ld Listener definitions

md Monitoring definitions

od Object definitions

pd Program definitions

rd Region definitions

scd Schema file definitions

ssd Structured file server definitions

td Transaction definitions

tdd Transient data definitions

tsd Temporary storage definitions

ud User definitions

wd Terminal definitions

xad Product definitions.

-a attributeNamespecifies the name of the attribute being modified.

-n newValuespecifies the new value for the attribute.

-b fromAttributespecifies the name of an attribute whose value is used as the newvalue for the attribute being modified.

-lt oldValuechanges the value of the attribute only if its current value is less thana numerical value, oldValue, that you specify.

-gt oldValuechanges the value of the attribute only if its current value is greaterthan a numerical value, oldValue, that you specify.

cicsupdateclass

-eq oldValuechanges the value of the attribute only if its current value is equal to avalue, oldValue, that you specify. The value you specify can benumerical or valid characters.

-k key changes the value of the stanza only with the key specified.

-f filenamespecifies the path and filename of the schema resource file. Thisoption is valid only if -c scd is specified.

Examples1. 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 previouslyhad the value wait_backout for every entry in the Transaction Definitions(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 RegionDefinitions (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 RSLCheckattribute for every transaction in the Transaction Definitions (TD) inregion4:

cicsupdateclass -r region4 -c td -a TSLCheck -f RSLCheck -w

5. To set the attribute NameService to NONE for a specified Structured FileService Definition (SSD) entry:

cicsupdateclass -w -c ssd -a NameService -n NONE \-k "/.;/cics/sfs/serverName"

cicsupdateclass

cicsusedceservers - Migrate CICS regions and Encina servers to use DCE

X X X X

The purpose of the cicsusedceservers command is to migrate CICS regionsand Encina SFS and PPC Gateway servers to make use of the DCE CDS andSecurity 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 themachine.

You must be logged in to DCE with credentials to create DCE principals andaccounts.

This command will migrate CICS regions and Encina servers from operatingwithout the use of the DCE directory and security services to operate usingthese service. It is intended to ease the migration to a more complexconfiguration or to one that requires the use of DCE security.

The command may be used to migrate all regions and servers on the machineat once or to migrate individual regions and servers. All Encina serversshould be migrated before attempting to use any migrated regions that makeuse of their facilities.

cicsusedceservers will create the necessary DCE principals and keytab fileswhich are normally created by cicsdefault or by cicsimport, cicssfscreate andcicsppcgwycreate (CICS on Open Systems only) when those commands areused in the presence of the DCE servers. It will also change the settings of theNameService and AuthenticationService attributes for the regions andservers to DCE. The various attributes specifying RPC protection levels willall be left set to none, however, so, if higher protection levels are required, itwill 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 runcicsusedceservers.

cicsusedceservers

Options

-A causes cicsusedceservers to migrate all CICS regions and all Encinaservers defined on the local machine.

-I causes cicsusedceservers -A to continue migration of other CICSregions and Encina servers if a failure is encountered in migrating oneof them.

-R regionNamespecifies the name of a single region on the local machine that is to bemigrated.

-S serverNamespecifies the name of a single Encina SFS server to be migrated.

-G gatewayNamespecifies the name of a single Encina PPC gateway server to bemigrated.

-v causes cicsusedceservers to display more information about theprogress of the migration.

Examples1. To migrate all CICS regions and Encina servers on the local machine even

if an error is encountered with one or more of them, entercicsusedceservers -AI

2. To migrate region Region1 on the local machine, entercicsusedceservers -R Region1

3. To migrate SFS server /.:/cics/sfs/SERVER1 on the local machine, entercicsusedceservers -S /.:/cics/sfs/SERVER1

cicsusedceservers

Chapter 3. CICS-supplied transactions

This chapter describes the CICS-supplied transactions and tells you how toinvoke 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 storagequeue. The CICS-supplied transactions are referred to by their four-charactertransaction identifier (or tranid) and always start with the letter “C”, as inCEMT.

Data Conversion (CALF)This transaction is used to convert VSAM-based data to the structured fileservices (SFS) format used in CICS on Open Systems. This is done duringmigration of applications from IBM mainframe-based CICS to CICS onOpen Systems.

Application Diagnosis Configuration (CDCN)This transaction is used to turn on and off the IBM ApplicationDebugging Program.

Temporary Storage Browse (CEBR)This transaction is used to browse temporary storage queues and transientdata queues.

Command Level Interpreter (CECI)This transaction allows you to check the syntax of, interpret, and runEXEC 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 beenpreprocessed with the CICS translator command (cicstran -e).

Runtime Resource Management (CEMT)This transaction allows you to inquire about CICS resources in theruntime environment and to change their control parameters dynamically.

Signoff (CESF)This transaction is used to sign off from CICS. It has the same effect asCSSF.

Signon (CESN)This transaction is used to sign on to CICS.

CJDBJava application diagnosis configuration

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 signon to CICS on that system.

Signoff (CSSF)This transaction is used to sign off from CICS. It has the same effect asCESF.

Statistics (CSTD)This transaction is used to display statistics information.

CICS uses the tranid to identify the application programs that handle thespecified transactions and to establish a task to run them.

Note: CEDF and CRTE are private transactions. They do not have a programname in the Transaction Definitions (TD) so you cannot change theirnames or copy them.

For more information, see “Chapter 3. CICS-supplied transactions” onpage 273.

For information about how user-written as well as CICS-supplied transactionsare defined to CICS, see “Transaction Definitions (TD)” on page 73.

How to invoke the CICS-supplied transactions

You invoke CICS-supplied transactions by entering the transaction identifier(tranid) at the command line. Several CICS-supplied transactions acceptadditional information, such as keywords or values. For example, if you wantto inquire about the status of PROG1 using the CEMT transaction, you wouldenter:

CEMT INQ PROGRAM(PROG1)

where CEMT is the tranid of the Runtime Resource Management transaction,the INQ keyword specifies that you want to make an inquiry, PROGRAMstates the resource type, and PROG1 is the specific name of the program.

The transaction starts a full screen session. When you end the session, thefollowing message is generated:

STATUS: SESSION ENDED

Prompts, issued from the transaction, are displayed if required keywords orvalues are missing or incorrect.

Note: If the upper case translation flag for your terminal is set to yes, you canenter the tranid at your terminal in either uppercase or lowercasecharacters, 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 andtheir 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 followingindicates 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 selectan item from an item list. For example, the following indicates that ifneither EXIT nor GOODNIGHT are selected, the transaction is executed asif EXIT were specified.

Example of showing the defaultCESF [EXIT | GOODNIGHT]

v Enter parentheses exactly as shown, unless indicated otherwise, as they actas delimiters.

v When an ellipsis (...) is shown in a list, repeat as many items, or group ofitems, as needed.

The following example of CEMT transaction syntax demonstrates that:1. Either INQ or SET must be specified.

Chapter 3. CICS-supplied transactions 275

2. TRANSACTION must also be specified, but because there are bracketsaround (tranid), you do not need to provide it.

3. The brackets around ALL, PRIORITY(value), and ENABLED | DISABLEDindicate that these are optional.

4. When PRIORITY is specified, you must provide a value.

Example of showing when a value must be providedCEMT {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 valueCEMT SET TCLASS MAXSERVERS(5)

Syntax notation on screen displays

The syntax notation displayed on screen, and in figures showing examplescreens, 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 commanduntil you specify the option.

v Parentheses are used to indicate that an option requires a value or datafield, but you have not specified one.

Minimum abbreviation of keywords

In general, the CICS-supplied transactions accept an abbreviation for eachkeyword, provided that the abbreviation uniquely identifies the keywordwithin the request. In this way you can enter the keyword TASK as TAS orTA, 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 permittedabbreviation in uppercase characters, the remainder in lowercase. See “How toinvoke CEMT” on page 323 for an example of this.

If you enter an ambiguous abbreviation, CICS issues a warning message, butassumes and uses the first possible keyword.

Default security settings

Transaction security is handled at two levels:v The first 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 RSLchecking.

TSL and RSL security checking can be handled by the CICS internal securitychecking mechanism or by an External Security Manager (ESM). Internal orexternal security checking is specified with the Transaction Definitions (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-suppliedtransactions

Tranid TSLCheck RSLCheck

CALF internal internal

CDCN internal internal

CEBR internal internal

CECS internal internal

CECI internal internal

CEDF internal internal

CEMT internal none

CESF internal none

CSSF internal none

CESN internal none

CMLV internal none

CRTE internal none

CSTD internal none

For internal security checking, each transaction is assigned a TSL key valueand 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 UserDefinitions (UD). These numbers indicate which transactions they are

permitted to use. If a number in the user list matches a transaction keynumber, 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 thetransaction and they must have 20 in their RSL key list if they need to be ableto access resources with that transaction.

The CICS-supplied transactions are initially shipped with these TSL and RSLkeys set to public so that all CICS users can use them. However, this mayhave been changed by your local administrator. For example, it may not bedesirable for all users to be able to use CEMT as this gives them the ability tochange CICS resource definitions in the runtime environment.

If you are responsible for setting up security checking for the CICS-suppliedtransactions, and you need more information about this, see the CICSAdministration Guide.

Complete list of CICS-supplied transactions

This information lists all the transactions that are supplied with CICS onOpen Systems, except for those that are part of CICS-supplied sampleprograms. The transactions that have operator interfaces, and that thereforeare listed in this book, are marked with an asterisk (*).

Transactions followed by a (p) are private transactions. They do not have aprogram name in the Transaction Definitions (TD) so you cannot change theirnames or copy them.

Changing any attributes of a private transaction may have unpredictableresults and is not supported.

CAGE (p) Temporary storage queue aging

CAIN (p) Region initialization

CALF * Data conversion

CARP (p) ATI request/queue purge

CATS (p) Asynchronous transaction sender

CAUT (p) Automatic statistics transmission

CCIN (p) Autoinstall CICS Communications Definitions (CD) entries

CDCN Debugging Configuration

CEBR * Temporary storage queue browse

CECI * Command interpreter

CECS * Command syntax check

CEDF *(p) Execution diagnostic facility

CEMT * Master terminal

CESF * Signoff transaction

CESN * Signon transaction

CFTS (p) Delete surrogate terminals

CGWY Gateway transaction. For information about this transaction,see the CICS Intercommunication Guide.

CHAT (p) Autoinstall terminals

CICE (p) Interval control element expiry transaction

CLAM (p) Monitors internal data consistency

CMLV * Browses the console log

CPMI (p) Function shipping mirror transaction

CRAB (p) Run program list

CROW (p) Region shutdown

CRSR (p) Remote scheduling

CRTE *(p) Routing transaction

CSMI (p) Function shipping mirror transaction

CSM1 (p) SYSMSG model

CSM2 (p) Scheduler model

CSM3 (p) Queue model

CSM5 (p) DL/I model

CSSF * Signoff transaction

CSTD * Statistics display transaction

CST0 - CST9, CSTA,CSTB, CSTZ (p)

Statistics display transactions

CTDP (p) Purges read reacords from the Transient Data Queues

CTIN (p) Autoinstall CICS Client terminals

CUBS (p) Update blocked starts

CURD (p) Update runtime database

CVMI (p) Function shipping mirror transaction

Interface descriptions for the CICS-supplied transactions

For each CICS-supplied transaction that has an operator interface, thefollowing information is provided:

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.

CALF (Data Conversion)

Converts data from VSAM format to structured file services (SFS) format.

Syntax

Description

CALF is a CICS-supplied transaction that performs data conversion so thatexisting VSAM-based applications can be migrated to the CICS structured fileserver (SFS) environment used in . CALF accepts the following three filetypes: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 file to a destination file. Youenter control data in the data entry fields to control the transaction, and usethe PF keys to run the transaction.

Starting and ending CALF:

You start the CALF transaction directly by entering the tranid CALF. You endthe transaction by pressing PF3.

Using the CALF screens:

CALF displays the following screen:

CICS FILE IMPORT FACILITYSOURCE FILE : ( ) SYNCPOINT : (0000) DUPREC : (Y) PAD : (Y)

REMOTE NAME : REMOTE SYSTEM :

FILE NAME :FILE SERVER :INDEX NAME :

FILE TYPE : RECORD LENGTH : RECORD FORMAT :KEY LENGTH : KEY POSITION :

DESTINATION FILE : ( ) COPIED : DUPLICATES :FILE NAME : RECOVERABLE (Y)FILE SERVER :INDEX NAME :

FILE TYPE : RECORD LENGTH : RECORD FORMAT :KEY LENGTH : KEY POSITION :

PF 1 HELP 2 CLEAR 3 END 5 OPEN 9 IMPORT

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 requestdoes not complete (see “The Calf error screen” on page 283). The transactionends, and the screen displays an error message, the number of records thatwere copied, and information about the last record that was copied. Theinformation about the last record copied depends upon the filetype. For aKSDS file, the screen displays 255 bytes containing the key in hexadecimal.For an ESDS file, it displays the relative byte address (RBA), and for an RRDSfile, it displays the relative record number (RRN).

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 fields:

These are the fields on the second and ninth lines of text on the screen,indicated by brackets, where you can enter the source file name, thedestination file name, and transaction control data.

SOURCE FILEis the file that the transaction copies records from. The file can be local orremote. The file types, record lengths, and record formats of the source filemust be consistent with the destination file. If the file is local, you cancheck this in the information fields after you press PF5.

If the file is remote, when you press PF5, only the information fieldsREMOTE NAME and REMOTE SYSTEM contain meaningful data, so youcannot check filetype, record length, or record format consistency. Theremight be record length conflicts during the copy process, with thefollowing 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 fixed length file, a

LENGERR error condition occurs and the transaction terminatesabnormally.

v If a source record is shorter than the length of a fixed length file, theoutcome depends upon the setting of the PAD data entry field (see thePAD description below).

v If records are of variable length, an attempt to write a record mightcause an INVREQ or a LENGERR error condition, and the transactionterminates abnormally.

If the source file is an ESDS file, the transaction maintains the recordorder, but the structured file server (SFS) allocates its own relative byteaddresses (RBAs).

SYNCPOINTcontrols how often a SYNCPOINT is issued if the destination field isrecoverable. The value of the field specifies the number of records that arewritten in each logical unit of work (LUW). The default is 0.

DUPRECcontrols whether or not to ignore DUPREC conditions. The DUPRECcondition occurs if an attempt is made to add a record to a data set whenthe same key already exists in the data set. You can set the field to Y or N.If you set the field to Y, the transaction ignores the DUPREC conditionsand you can resubmit a partially completed copy operation. The default isY.

PADcontrols whether or not to pad a record with nulls when the source recordlength is less than the record length of a fixed length file. This type ofrecord length conflict can occur when you import a remote file. If the fieldis set to Y, the record is padded with nulls to the required length and arecord is written. If the field is set to N, the transaction terminatesabnormally. The default is Y.

DESTINATION FILEis the file that the transaction copies records to. The destination file mustbe local, so after you press PF5, there is always data in the FILE TYPE,RECORD LENGTH, and RECORD FORMAT information fields.

The destination file must be configured with the correct information aboutall indexes, because the transaction only has information about the indexit uses for access.

Information:

REMOTE NAMEdisplays the name of the file if the filetype is remote.

REMOTE SYSTEMdisplays the name of the system if the filetype is remote.

FILE NAMEdisplays the Structured File Server (SFS) name for the file.

FILE SERVERdisplays the name of the SFS file system where this file resides.

INDEX NAMEdisplays the name of the SFS index associated with this path to the file.

FILE TYPEdisplays the type of file if the file is local. File types can be KSDS, ESDS,or RRDS.

RECORD LENGTHdisplays the record length if the file is local.

RECORD FORMATdisplays the record format if the file is local. The record format can befixed or variable.

KEY LENGTHdisplays the length of the key in the underlying SFS file if the file is local,or the value recorded in the File Definitions (FD) if the file is remote.

KEY POSITIONdisplays the key position in the underlying SFS file if the file is local, orthe value recorded in the File Definitions (FD) if the file is remote.

COPIEDis a field that is periodically updated, depending on the SYNCPOINT, asthe transaction carries out the copy procedure.

DUPLICATESis a field that is periodically updated as the transaction carries out thecopy procedure.

RECOVERABLEdisplays whether a file 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 statusinformation to display. Information can be error messages or messages aboutthe transaction status.

Program function (PF) key values:

PF1displays help.

PF2clears all fields.

PF3exits from CALF.

PF5opens the files specified in the data entry fields, and displays informationabout the files.

PF9initiates copying records from the source file to the destination file. Youmust open the files first.

CDCN (Application Diagnosis Configuration) (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 ApplicationDebugging Program on and off. The IBM Application Debugging Program canbe used to diagnose errors in a transaction identified by naming a resource inone of the following classes:v Terminal (identified by its termid)v System (identified by its sysid)v Transaction (identified by its transid)v Program (identified by its program name)

When a transaction meets one (or more) of the criteria set by CDCN, the IBMApplication Debugging Program starts an X-window session on the specifieddisplay.

Options

TERMID=termIdspecifies the four-character identifier of the terminal on which thetransaction to be tested will be run. This may or may not be theterminal on which CDCN is invoked. If no other resources arespecified termId defaults to the identifier of the current terminal. Thisterminal must be defined in the Terminal Definitions (WD), unless it isgenerated from a terminal autoinstall. The terminal must be a terminalin the same region as the current terminal.

To find the identifier of an autoinstalled terminal, you can run theCEMT INQ TERMINAL transaction, which lists all the terminalslogged on to the CICS region. Alternatively, you can look at theautoinstall message in the CSMT log, in the file/var/cics_regions/regionName/data/CSMT.out.

SYSID=sysIdspecifies the four-character identifier of the remote region where thetransaction to be diagnosed will originate. This region must bedefined in the Communications Definitions (CD).

TRANSID=transIdspecifies the identifier of the transaction to be diagnosed. Thistransaction must be defined in the Transaction Definitions (TD).

PROGRAM=programNamespecifies the name of the program to be diagnosed. This programmust be defined in the Program Definitions (PD). -a option of thecicstcl command and its source must be in the directories specified bythe xldb.sourceSearchPath resource in your .Xdefaults file. See theCICS Application Programming Guidefor more information.

DISPLAY=displayspecifies the name of the X-display on which the IBM ApplicationDebugging Program will display its panels. If this parameter is notspecified, the name of the display is obtained from the file specifiedby the environment variable CICSDEBUGENV. The name of thedisplay must be specified in the format XserverName:displayNumber.

ON specifies that the IBM Application Debugging Program is to be turnedon for the named resources. This is the default if neither ON nor OFFis specified.

OFF specifies that the IBM Application Debugging Program is to be turnedoff for the named resources.

Using the CDCN screen:

If you enter CDCN without specifying the DISPLAY parameter or if the commandline is invalid or incomplete, the following screen is displayed:

CDCN CICS Debugging Configuration Transaction

DISPLAY :( ) DEBUG : ON

To configure for a terminal specify the TERMID TERMID : ( )

To configure for a system specify the SYSID SYSID : ( )

To configure for a transaction specify the TRANSID TRANSID: ( )

To configure for a program specify the PROGRAM PROGRAM: ( )

ENTER: COMMIT SELECTIONPF1 : HELP PF2 : DEBUG ON/OFF PF3 : EXITPF4 : MESSAGES PF5 : UNDEFINED PF6 : UNDEFINEDPF7 : UNDEFINED PF8 : UNDEFINED PF9 : UNDEFINEDPF10: UNDEFINED PF11: UNDEFINED PF12: UNDEFINED

The data entry fields, indicated by parentheses, are where you can enter datacorresponding to the parameters.

After you have filled in the fields you want, press ENTER from the mainscreen.

Program Function Keys:

The program function keys have the following functions:

PF1 displays help

PF2 toggles the IBM Application Debugging Program on and off

PF3 exits from CDCN

PF4 messages

Using CDCN:

When you use CDCN to turn the IBM Application Debugging Program on fora named resource, it does not cause the IBM Application Debugging Programto start immediately. If you satisfy the security checks, and you are able bothto run the CDCN transaction and to access the region database entries to turnon the IBM Application Debugging Program for the resource, the resource youname acts as a “trigger”. Startup of the IBM Application Debugging Programis triggered later, depending on the type of resource involved:

Resource Startup of the IBM Application Debugging Program triggered by

termid The next transaction run on that terminal

sysid The next transaction run as a result of a request from that system

transid The next invocation of that transaction

program The next invocation of that program

When the IBM Application Debugging Program is first started, it remainsattached to the CICS application server (cicsas) process, debugging one ormore programs, until the end of the transaction (even when it has beentriggered to debug a program), or until you choose to quit from the IBMApplication Debugging Program. The IBM Application Debugging Program is“attached” when it is attached to the cicsas process (that is, actuallydebugging one or more programs); the IBM Application Debugging Programis “detached” when it is no longer attached to the cicsas process (that is, whenit has finished debugging a transaction and is waiting to be triggered again).Once the IBM Application Debugging Program has started, it can only beterminated 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 ApplicationDebugging Program started for it, and there is an implied order of precedenceof:1. termid2. sysid3. transaction4. program

This means, for example, that, if you turn on debugging both for a terminalwith identifier AR01 and for a transaction with identifier ALAN, and you runtransaction ALAN on terminal AR01, only one session of the IBM ApplicationDebugging Program will be started (that associated with terminal AR01)because two debug sessions cannot debug the same physical copy of the codeand the terminal trigger takes precedence over the transaction trigger. Asecond invocation of ALAN run from a different terminal, however, will alsostart a session of the IBM Application Debugging Program (that associatedwith transaction ALAN). It is thus possible to have multiple copies of thesame program code being debugged at the same time.

Note that only programs compiled for debug will produce symbolic outputfrom the IBM Application Debugging Program when run under control of theIBM Application Debugging Program. If the IBM Application Debugging

Program is triggered for a program that has not been compiled for debug, theIBM Application Debugging Program displays the program as assemblerstatements.

CEBR (Temporary Storage Browse)

Used to browse the contents of temporary storage queues.

Syntax

CEBR [queueName]

Options

queueNameis the name of the temporary storage queue that you wish to browse. Ifyou do not specify a queue name, the CEBR transaction generates one foryou. The generated queue name is CEBRtermId, where termId is yourterminal identifier.

Examples

To browse temporary storage queue TSQ1:CEBR TSQ1

Description

Temporary Storage Browse (CEBR) is a debugging aid that you can use tobrowse (read without changing) and manipulate the contents of CICStemporary storage queues. You can also use it to transfer a transient dataqueue 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 followingfigure. In this figure, no queue name is supplied, and the terminal invokingthe CEBR transaction has a terminal identifier of TERM.

CEBR TS QUEUE CEBRTERM RECORD 1 OF 0 COL 1 OF 0ENTER COMMAND ===>

TEMPORARY STORAGE QUEUE CEBRTERMPF1 : HELP PF2 : SWITCH HEX/CHAR PF3 : TERMINATE BROWSEPF4 : VIEW TOP PF5 : VIEW BOTTOM PF6 : REPEAT LAST FINDPF7 : SCROLL BACK HALF PF8 : SCROLL FORWARD HALF PF9 : UNDEFINEDPF10: SCROLL BACK FULL PF11: SCROLL FORWARD FULL PF12: 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 thefollowing CEBR commands:

BOTTOMshows the last page of the current queue.

COLUMN nnnnmoves the displayed area to this column of the queue.

FIND /stringfinds the next occurrence of the specified string after the current line,making the line containing the string the second on the display page. Theslash (/) is a delimiting character. The delimiting character does not haveto be slash. However, it must not be a character that appears in the searchargument. If there are blank characters in the string, you must terminatethat string with the delimiting character that started it.

For example, to find the first 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 find a specified string if it is on the first line or on thecurrent line.

GET TDqueueNamemoves the data from a named transient data queue to the temporarystorage queue that is being browsed. This allows you to browse the

contents of the named transient data queue. TDqueueName must be thefour-character name either of an intrapartition transient data queue, or ofan extrapartition transient data queue that has been opened for input.

If the transient data queue is logically recoverable, the GET commandplaces 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 CICSWRITEQ TD or a CEBR PUT which has not completed) CEBR GET willwait for the WRITE lock to be released (when the transaction writing therecords reaches completion or syncpoint) before reading the records intothe temporary storage queue for display.

LINE nnnnmakes the specified line the second line on the screen.

PURGEerases the contents of the queue being browsed.

PUT TDqueueNamecopies the data from the temporary storage queue being browsed to thenamed transient data queue. You can use this command to prepare datafor printing, or to return data to a transient data queue after you havebrowsed through it. TDqueueName must be the four-character name eitherof an intrapartition transient data queue, or of an extrapartition transientdata queue that has been opened for output.

If the transient data queue is logically recoverable CEBR PUT places aWRITE 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 GETTDqueueName in another CEBR session until this CEBR session hasended.

QUEUE TSqueueNamespecifies the eight-character name of a temporary storage queue that youwant to become the current queue. The value that you specify can be inhexadecimal, 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 field on the top of the screen, and pressingthe ENTER key.

TERMINAL termIdchanges the name of the queue. CEBR takes the first four characters of the

current queue name and adds the four characters represented by termId(the terminal identifier) to the end, so that they become the last fourcharacters of the new queue name.

TOPshows the first page of the current queue.

Information:

This area consists of the remainder of the screen between the “commandinput” area at the top, and “PF key values” at the bottom of the screen. CICSuses this area to display the temporary storage queue.

When CEBR displays an argument in character format, some of the charactersmay not be displayable (including lowercase characters). CEBR replaces eachnondisplayable character by a period, so you must be aware that periodsindicate either a valid period character, or storage containing othernondisplayable data.

Data display does not take into account the locale the user is using, and anybyte 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 asa 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 user’s environment thatdefines conventions for a specified culture, such as time formatting,numeric formatting, monetary formatting, and character classification,conversion, and collation. Refer to your operating systemdocumentation for more information about locales and how they areused.

The four lines at the bottom of the CEBR screen provide a menu indicatingthe 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 requiredinstruction on the screen and pressing the ENTER key. You can use the tabkeys to position the cursor correctly.

The following list explains the meaning of each PF key.

PF1displays help.

PF2toggles between displaying data in character and hexadecimal formats.CICS maintains the state of the toggle when you select a new TS queue.

PF3exits from CEBR.

PF4displays the first page of data (equivalent to the TOP command).

PF5displays the last 14 lines of data (equivalent to the BOTTOM command).

PF6repeats the last FIND command.

PF7scrolls back half a page (eight lines or less if the top of queue isencountered).

PF8scrolls forward half a page (eight lines or less if the bottom of queue isencountered).

PF9is an undefined PF key, unless any lines for the current queue are too longto display. If this happens, PF9 permits you to view off-screen data. ThePF9 key scrolls to the right each time you press it until the last column isreached. If you press the PF9 key again, it scrolls to the left until columnone is reached. You can repeat this cycle indefinitely. CICS scrollshorizontally in units of up to 60 columns (30 if the screen is inhexadecimal format), until CICS reaches the end of the data. The PF keylegend for this key is updated to indicate the current assignment of thiskey. The possible legends are VIEW RIGHT, VIEW LEFT, andUNDEFINED.

PF10scrolls back one page.

PF11scrolls forward one page.

PF12is an undefined function key.

Running CEBR:

You use CEBR commands or the PF keys to process the queue. You can alsouse CEBR to copy transient data queues to temporary storage (although youcannot read an output extrapartition transient data queue) and to copy

temporary storage to transient data queues (although you cannot write aninput extrapartition transient data queue).

Note: The term extrapartition transient data is used to describe a CICS facilitythat temporarily saves data in the form of queues, called destinations.Extrapartition destinations are used for data that is either coming froma source outside the region, or is being directed from a source withinthe region to a destination outside the region.

The CEBR transaction allows users to browse or copy data on queues. Youmight want to restrict access to the transaction so that unauthorized personnelcannot browse the data. To restrict access to the transaction, you shouldemploy transaction level security. To restrict access to the queues, you shouldemploy resource level security.

CECI (Command Level Interpreter) and CECS (Syntax Checker)

To check the syntax of, interpret, and run EXEC CICS commands.

Syntax

{CECI | CECS} [commandName]

Options

commandNameis 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 file FILEA:CECI READ FILE('FILEA') RIDFLD('009000')

Description

CECI allows you to check the syntax of, interpret, and run EXEC CICScommands. 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 aCICS system.v When writing application programs, you can check the syntax of the whole

CICS command level application programming interface. If you are usingCECI, you can carry through most of the commands to invocation, and youcan 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 file control record that has been overwritten with invaliddata, create or delete a temporary storage queue, and so on. CECI providesa useful extension to the facilities provided by the runtime resourcemanagement transaction, CEMT.

Starting and ending CECI or CECS:

You start the CECI or CECS transaction directly by entering the transactionidentifier CECI or CECS, respectively and, optionally, a CICS command. Youend the transaction by pressing PF3.

Using the CECI and CECS screens:

The command checker and interpreter divides the screen into four areas.These are:

CECI and CECS

v Command Input (the first line of the screen)v Status (the second line of the screen)v Information (21 lines on a 24 x 80 screen)v PF Key Values (the last line of the screen)

Command input:

This is the first line of the screen. You use this line to enter the commandwhose syntax is to be checked, or that is to be performed, either in the normalformat, or in an abbreviated or condensed form that reduces the number ofkeystrokes involved. The condensed form of the command is obtainedbecause: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 areshown in uppercase characters in the syntax displayed on screen.

v The quotes around character strings are optional, and all strings ofcharacters are treated as character-string constants unless they are precededby 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 specified. The value received from CICSis included in the syntax screen after CICS performs the command.

The following example shows the condensed form of a command. You canenter the file 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 defined previously), andyou can leave it out.

Status:

This is the second line of the screen. It contains one of the followingmessages:COMMAND SYNTAX CHECK

ABOUT TO EXECUTE COMMAND

COMMAND EXECUTION COMPLETE (or COMMAND NOT EXECUTED)

CECI and CECS

EXEC INTERFACE BLOCK

VARIABLES

SYNTAX MESSAGES

EXPANSION OF

The status message describes the type of information in the information areaof the screen.

The COMMAND SYNTAX CHECK status message indicates that CICS haschecked the syntax of the entered command, but is not about to perform thecommand. This is always the status for CECS, and for CECI with a questionmark before the command. It is also the status when the syntax check of thecommand gives severe error messages and for those commands that can notbe run (for example, HANDLE CONDITION and HANDLE AID).

The ABOUT TO EXECUTE COMMAND status message appears when noneof the reasons for stopping at COMMAND SYNTAX CHECK apply.

The COMMAND EXECUTION COMPLETE status message appears inresponse 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 atan option value or a variable, and press ENTER.

Information:

This area consists of the remainder of the screen between the command inputand status areas at the top, and PF key values at the bottom of the screen. CICSuses this area to display the syntax of the entered command, error messageinformation, the response to the run, and any other information that can beobtained by using the PF keys or the cursor.

A line at the bottom of this area is reserved for messages describing errors inthe conversation with you (for example, INVALID PACKED DECIMAL). CICShighlights these messages to attract attention.

The content of the information area varies, depending on which message is inthe status area. The information area of the screen for COMMAND SYNTAX

CECI and CECS

CHECK, ABOUT TO EXECUTE COMMAND, and COMMAND EXECUTIONCOMPLETE contains information common to all three screens.

Command syntax check:

CICS displays the full syntax of the command and error information at thebottom of the screen. CICS intensifies options in the syntax panel to showthose specified on the command input line, those assumed by default, andany receivers.

You can modify the command on the command input line at any time byovertyping and pressing the ENTER key.

When an argument is to be displayed in character format, some of thecharacters may not be displayable. CECI replaces each nondisplayablecharacter by a period (.). You must be aware that periods can indicate either avalid period character, or storage containing data other than a period. Youcannot overtype characters with a period in character format. To overtype acharacter with a period, you must use PF2 to switch the screen to hexadecimalformat 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 indicatethat 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 thisbook 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 youspecify the option.

v Parentheses ( ) are used to indicate that an option requires a value or datafield, but you have not specified one.

The error information consists either of a single error message, or anindication 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 SYNTAXCHECK, but there is no error information. You can modify option values byovertyping them in the syntax information.

CECI and CECS

This modification is a temporary modification for the duration of thecommand and does not affect the command input line. It is similar to themodification of option values that is possible with the Execution DiagnosticFacility (EDF) when debugging an application program.

Command execution complete:

The information area of this screen is similar to that of COMMAND SYNTAXCHECK, but it displays the results after CICS has performed the command.CICS displays any receivers as intensified, whether they were specified or not,together with their CICS-supplied values. If the value of an option is too longfor 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 wholeoption value, position the cursor, using the tab key, at the start of the optionvalue and pressing the ENTER key.

CICS displays the appropriate response code (for example, NORMAL)together with the contents of the EIBRESP field of the Exec Interface Block(EIB) at the bottom of the information area.

Note: CECI returns exceptional conditions for some commands, even if theselected options are correct, because CECI checks every option of thecommand, whether or not you specified the options. You may not havespecified an option because you did not need it. Alternatively, you maynot have specified certain options because they are mutually exclusive.For example, the ASSIGN command always returns the exceptionalcondition INVREQ when you check it using CECI.

Because CECI is an interactive transaction, CICS processes all commandsrunning under its control as if the NOHANDLE option were active, thusforcing 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 execinterface block. See the CICS Application Programming Reference for furtherinformation.

Variables:

The information area shows, in response to pressing the PF5 key, all thevariables 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 istaken as a character string constant. However, sometimes this value must be

CECI and CECS

represented by a variable. The command interpreter recognizes a value as avariable only if it is preceded by an ampersand (&).

You can specify a variable when connecting two associated commandsthrough the values supplied in their options, for example, READ INTO(data-area), UPDATE, and REWRITE FROM (data-area). You can use avariable to make the data area in the FROM option the same as that in theINTO option.

A variable is also useful when the values of options cause the command toexceed the line length of the command input area. The commands can beused by creating variables with the required values and specifying thevariable names in the command.

You can also use variables to contain commands, and you can enter variablenames in a command input line that contains complete or partial commands.

CICS deletes variables at the end of a command interpreter session unless youtake action to save them, for example, in temporary storage.

You can use one of the following methods to create variables, which can be ofdata 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 defined.

You request this list by pressing key PF5. The screen shows all definedvariables giving, for each, its name, length in bytes, and its value. CICSdisplays the value in character form, but you can use PF2 to switch fromcharacter to hexadecimal. You obtain an expanded display of each variableby positioning the cursor under the ampersand (&) of the name andpressing the ENTER key. To create a new character variable, enter its nameand 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 field. CECI initializes these fields 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 obtainingthe expanded display of the variable and overtyping the name field.

v By associating a variable name with the value of an option. Positioning thecursor, using the tab key, at the start of the line of the syntax display andpressing 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= field of the syntax display on screen.This creates a variable containing the current command.

CECI and CECS

Note: When variables are displayed in hexadecimal, those character variableswhich contain numerical values are displayed in the byte order of themachine, whereas variables of type F, H, or P are displayed with themost significant byte to the left, irrespective of the byte order of themachine.

Three variables are provided initially:

&DFHCis a sample.

&DFHWcontains a temporary storage EXEC CICS WRITEQ command.

&DFHRcontains an EXEC CICS READQ command.

You can write a command to temporary storage by entering &DFHC in theNAME= field of the syntax display on the screen, entering &DFHW in thecommand input line, and performing the EXEC CICS WRITEQ command. Inthis way, you can request a list of commands to be written. The command listcan be read and performed by alternately entering &DFHR and &DFHC inthe 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 syntaxmessages associated with the entered command. Each message has anassociated severity, which is displayed as a single character and a colonpreceding the error message. An example is an error message, which ispreceded by “E:”.

If there is more than one message generated for a command, the number ofmessages is also displayed.

Expansion of screen area:

The whole of the information area of the screen is used to display an areaselected by means of the cursor. You can position the cursor at the start of thevalue of an option on a syntax screen, or under the ampersand of a variablein a variables screen. Press ENTER to get the expanded area screen. You canuse the scrolling keys to display all the information if it exceeds a full screen.

CECI and CECS

The single line at the bottom of the screen provides a menu indicating theeffect of the PF keys for the display. If your terminal has no PF keys, you canobtain the same effect by positioning the cursor under the required item in themenu by means of the tab keys, and pressing ENTER.

The following PF keys are available:

PF1displays help on using the command interpreter or syntax checker and onthe meanings of the PF keys.

PF2toggles between displaying data in character and hexadecimal forms. Allfurther screens stay in the chosen mode until the next time you press thePF2 key.

PF3exits from CECI or CECS, so ends the current session of the interpreter orsyntax checker.

PF4shows the contents of the EXEC interface block (EIB). This key is notavailable in the EIB display.

PF5shows all the variables associated with the current command interpretersession, giving for each its name, length, and value. This key is notavailable in the variables display.

PF6shows what you would see if the terminal had been running a transactionwhich contained the screen access commands which have been run usingthe interpreter. This key is not available from CECS or when you areviewing the user display.

PF7scrolls half a page backward.

PF8scrolls half a page forward.

PF9shows all the messages generated during the syntax check of a command.This key is not available in the syntax messages display.

PF10scrolls a page backward.

PF11scrolls a page forward.

CECI and CECS

PF12is undefined.

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 READFILE(’FILEA’) RIDFLD(’009000’).

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 atransaction security key (TSL) that matches the transaction security keydefined in the Transaction Definitions (TD).

The TD entry for the CECI transaction specifies, by default, that resource levelsecurity checking is required for any resources referenced with the interpreter.This checking applies to files, transient data queues, temporary storagequeues, programs, transaction identifiers of the EXEC CICS START command,and journal file identifiers.

If the resource security level (RSL) specified in the appropriate resourcedefinition—such as the File Definitions (FD) for a file—is not matched by RSLkeys of the user that is signed on, the resource security check fails, and theresponse to the command is the NOTAUTH condition. This response is givenon 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 thescreen. If there is more than one error message, the screen displays amessage to press PF9 to see them.

CECI and CECS

E: Command requires the option: 'RIDFLD'

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 requestedrecord identification field.

The command is now ready to be run, and you achieve this by pressing theENTER key. CICS displays the screen shown in“CECI screen after command has been executed” on page 308, showing theresult of performing the command.

CECI and CECS

RESPONSE: NORMAL EIBRESP=+000000000PF 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 checkscreen and prevents CICS performing the command.

The use of CECS forces a question mark before the command. This gives thecommand syntax check screen and prevents CICS performing the command.In a system where security is important, you can make CECS more widelyavailable than CECI.

See the CICS Application Programming Reference and the CICS AdministrationGuide for related information.

CECI and CECS

CEDF (Execution Diagnostic Facility)

To control the Execution Diagnostic Facility (EDF).

Syntax

CEDF { termId | sysId } [,ON | ,OFF ]

Options

termIdis the four-character identifier of the terminal on which the transaction tobe tested is being run. This identifier must be defined in the TerminalDefinitions (WD), unless it is generated from a terminal autoinstall. Theterminal must be another terminal in the same region as the currentterminal. The WD entry specifies what type the terminal is, for example aphysical terminal or a window.

To find the terminal identifier of an autoinstalled terminal, you can runthe CEMT INQ TERMINAL transaction, which lists all the terminalslogged on to the CICS region. Alternatively, you can look at the autoinstallmessage in the CSMT log, which is in the following file:/var/cics_regions/regionName/data/CSMT.out

sysIdis the four-character identifier of the remote region (sysid) when you wantto test inbound transactions from a different region. This identifier mustbe defined in the Communications Definitions (CD).

ONspecifies that the EDF session is to be started. This is the default.

OFFspecifies 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 identifier used to start or stop an ExecutionDiagnostic Facility (EDF) session on a terminal or a region. EDF enables youto test, online, an application program that has been preprocessed using the -eoption of the CICS translator (cicstran), without modifying the program. If the

-d option of the cicstran command is also used, the translator source listingalso has line numbers that EDF can use. CICS passes control to EDF atspecific interception points. EDF displays the state of the application programat the interception point, and allows you to interact with EDF screens to bothview additional information about the program, and overtype certain areas ofthe screen to test the execution of the program, before returning control to theapplication code.

In CICS on Open Systems or CICS for Windows NT, you can use EDF ineither single or dual screen mode. In single screen mode the CEDF transactionand the application being debugged run on the same terminal and PF6 is usedto switch between them. In dual screen mode two different terminals are used,one for the CEDF transaction and one for the application, though these maybe two logical terminals (windows) on one physical terminal. You can useEDF only from a terminal that has a screen width of 80 columns or more, anda screen depth of 24 lines or more.

When you run CEDF to debug a transaction, the transaction runs, sets a flag,and exits, all in a very short time. Therefore, CEDF is not running in thesystem as you run your transaction (in a similar way that apseudo-conversational transaction is not running and most of the time doesnot appear on INQ TASK displays). On CICS on Open Systems of CICS forWindows NT, both terminals are under the control of a single task (the usertask), which is effectively debugging itself and sending the output to theterminal running under CEDF.

You can use EDF to test user transactions (application programs) and thefunction shipping mirror transaction supplied by CICS. You must firsttranslate any applications for use by EDF using cicstran or cicstcl. You cannotuse EDF for any other transaction provided by CICS.

Starting and ending CEDF:

You start the CEDF transaction by entering the transaction identifier CEDFand, for dual screen mode, either a terminal id or a sysid. The ON parameteris not required as ON is the default. You end the transaction by enteringCEDF OFF.

Using the CEDF screen:

The execution diagnostic facility divides the screen into four areas. These are:v Program information (the first 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)

The following figure shows a typical EDF screen.

TRANSACTION: ABCD PROGRAM: ABCDPROG TASK NUMBER: 0000000059 DISPLAY: 00STATUS: COMMAND EXECUTION COMPLETEEXEC CICS READQ TSQUEUE ('AC011111')INTO (' ........')LENGTH (12)ITEM (1)

LINE: EIBFN=X'0A04'RESPONSE: NORMAL EIBRESP=0

ENTER: CONTINUEPF1 : HELP PF2 : SWITCH HEX/CHAR PF3 : END EDF SESSIONPF4 : SUPPRESS DISPLAYS PF5 : WORKING STORAGE PF6 : USER DISPLAYPF7 : SCROLL BACK PF8 : SCROLL FORWARD PF9 : STOP CONDITIONSPF10: UNDEFINED PF11: UNDEFINED PF12: ABEND USER TASK

If you press the ENTER key while the cursor is not positioned within the PFkey definition area, EDF performs the function specified for the ENTER key.

EDF uses the line immediately above the PF key menu to display messages toyou.

You can request argument values to be displayed in character or hexadecimalformat. If you request character format, EDF shows numeric arguments innumeric character format, with a sign if the number is negative. Eachargument 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 indicatethat the value is incomplete. If EDF displays the argument in hexadecimalformat, EDF also displays the address of the argument.

You can overtype any screen area where the cursor stops when you press thetab keys. For example, you can move the cursor to the response field andchange the response from NORMAL to ERROR, to test the program’s errorhandling 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.

2. If you make invalid changes, EDF redisplays the screen with a diagnosticmessage 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 keydefinition area, EDF accepts any changes and performs the actionrequested by the PF key.

4. If you use the ENTER key while the cursor is not in the PF key definitionarea, and have not modified the screen (other than the REPLY field), thenEDF performs one of the following functions, corresponding to the ENTERkey:

CONTINUEcauses your user transaction to continue, unless you have modified thescreen. If you have modified the screen, EDF redisplays the screenwith changes incorporated.

CURRENT DISPLAYdisplays the screen displayed before you started examining otherscreens, such as EIB, unless you have modified the screen. If you havemodified the screen, EDF redisplays the screen with changesincorporated.

Program information:

The first line of a CEDF screen displays information about the applicationprogram being debugged. It displays the transaction identifier, the programidentifier, and the task number. It also shows the current display number(fixed 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 followinginformation area.

Information:

This area consists of the remainder of the screen between the status area at thetop, and the PF key values at the bottom of the screen. CEDF uses this area todisplay the syntax of the command being performed, error messageinformation, the response to the run, and any other information that can beobtained by using the PF keys or the cursor.

The four lines at the bottom of the CEDF screen provide a menu indicatingthe effect of the PF keys for that particular screen. Although the menu changesfrom 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, usingthe tab keys, under the required instruction on the screen, and press theENTER key.

PF1 : HELPdisplays help.

PF2 : SWITCH HEX/CHARtoggles the display between hexadecimal and character representation.CICS maintains further screen displays in the chosen mode until the nexttime you press the PF2 key, or you exit from CEDF.

PF3 : END EDF SESSIONexits from CEDF. The debugging session ends, so the terminal comes outof EDF mode. The user transaction continues.

PF4 : EIB DISPLAYdisplays the value of fields in EIB and COMMAREA (if any).

PF4 : SUPPRESS DISPLAYSsuppresses all EDF displays until the next stop condition occurs.

PF5 : WORKING STORAGEdisplays the current working storage section of a COBOL user program.The information corresponding to this section is shown in bothhexadecimal and character representations, similar to a dump listing. Youcannot view your own main storage area (acquired by the use of theEXEC CICS GETMAIN command), but you can view the COMMAREAstorage.

PF5 : DATA AREAdisplays the current data area of a C user program. The informationcorresponding to this section is shown in both hexadecimal and characterrepresentations, similar to a dump listing. You cannot view your ownmain storage area (acquired by the use of the EXEC CICS GETMAINcommand), but you can view the COMMAREA storage. If the stack frameof the C user program is available, you can use PF9 to switch between thecurrent data area and the current stack frame.

PF5 : STACK FRAMEdisplays the current stack frame of a C user program. This is availableonly from the “About to Execute Command”, “Command ExecutionComplete”, and “Command Not Executed” screens. The informationcorresponding to this section is shown in both hexadecimal and characterrepresentations, similar to a dump listing. You can use PF9 to switchbetween the current data area and the current stack frame.

PF6 : USER DISPLAYis used in single screen mode to switch from the CDEF display to theapplication display. Once in the application pressing any key switchesback to the CEDF display.

PF7 : SCROLL BACKscrolls a command or EIB display backwards. A plus sign (+) against thefirst option or field indicates there are more options or fields preceding.

PF7 : SCROLL BACK HALFscrolls a working storage display half a screen backwards, displayinglower addresses.

PF8 : SCROLL FORWARD HALFscrolls a working storage display half a screen forward, displaying higheraddresses.

PF9 : DATA AREAswitches the stack frame display for a C user program to the data areadisplay. You use this in conjunction with PF5.

PF9 : STACK FRAMEswitches the data area display for a C user program to the stack framedisplay. You use this in conjunction with PF5.

PF9 : STOP CONDITIONSswitches to a display that allows you to determine the conditions underwhich CEDF will interrupt the program being tested.

PF10: SCROLL BACK FULLscrolls a working storage display a full screen backwards, displayinglower addresses.

PF11: SCROLL FORWARDscrolls a command or EIB display forward. A plus sign (+) against the lastoption or field indicates there are more options or fields following.

PF11: SCROLL FORWARD FULLscrolls a working storage display a full screen forward, displaying higheraddresses.

PF12: ABEND USER TASKterminates the user task. EDF asks you to confirm this action by

displaying the message ENTER ABEND CODE AND REQUEST ABENDAGAIN. To abnormally terminate the task with a transaction dumpidentified by a specified abend code, enter the code at the cursor positionand request the PF12 function again. If you enter “NO”, CICS abnormallyterminates the task without a dump.

Abnormal termination codes beginning with the character A are reservedfor use by CICS. If you use a CICS abnormal termination code you mightcause unpredictable results.

You cannot use this function if an abnormal termination is already inprogress or the task is terminating.

PFxx: UNDEFINEDmeans 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 fieldsthat the cursor stops at when you move it using the tab keys. You also use thetab keys to move the cursor within the PF key menu, but you cannot changethe menu fields.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 ordelete 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 field that you can overtype only with aminus or a blank.

v You can overtype the response field in the information area with the nameof any exceptional condition, including ERROR, that can occur for thecurrent function, or with the word NORMAL. When EDF continues, theprogram takes the prescribed action for the specified response.

v The EIBRESP field can be overtyped with any desired decimal value that isvalid for this field when it is displayed as part of the EXEC interface block(EIB). This does not apply when this field is part of a command display.

When you overtype a field representing a data area of a program, EDF placesthe entered value directly into the application program’s storage. However,before performing a command, when you overtype a field representing a datavalue (which may be a constant), EDF uses a copy of the field. Therefore, thechange does not affect other parts of the program using the same constant foran unrelated purpose.

For example, you might overtype the map name before running an EXECCICS SEND MAP command. The map used temporarily is the map name youentered, but the map name displayed on response is the original map name.

When EDF displays an argument in character format, some of the charactersmay not be displayable (including lowercase characters). EDF replaces eachnondisplayable character by a period. When overtyping a period, you must beaware that periods indicate either a valid period character, or storagecontaining other nondisplayable data. You cannot overtype characters with aperiod in character format, because EDF ignores the change, and does notissue any diagnostic message. Similarly, when EDF displays a value inhexadecimal format, EDF ignores overtyping with a blank character, and doesnot issue any diagnostic message.

To overtype a character with a period, use PF2 to switch the screen tohexadecimal format and type X’2E’.

When EDF displays storage in both character and hexadecimal format, if youchange both and the changes conflict, the value of the hexadecimal field takesprecedence. EDF does not issue any diagnostic message.

Data display does not take into account the locale the user is using, and anybyte 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 asa 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 user’s environment thatdefines conventions for a specified culture, such as time formatting,numeric formatting, monetary formatting, and character classification,conversion, and collation. Refer to your operating systemdocumentation for more information about locales and how they areused.

If you enter invalid data, regardless of the action you requested, EDF ignoresthe invalid data and displays a diagnostic message.

Interception points:

When running a user transaction in debug mode, EDF intercepts the runningof the application program at the following points, to allow you to interactwith EDF before returning control to the application:1. At program initiation:

After initialization of the EIB, but before giving control to the applicationprogram.

2. Immediately before performing each EXEC CICS command:After making the initial trace entry, but before performing the requestedaction.

3. Immediately after performing each EXEC CICS command (except ABEND,XCTL, and RETURN):After performing the requested action, but before invoking the EXEC CICSHANDLE CONDITION mechanism, and before making the response traceentry.

4. At program termination, task termination, and abnormal task termination.5. When an ABEND occurs.

At all the above points of interception, EDF displays the current status byidentifying the cause of interception. In addition:v At point 1, EDF displays the contents of the fields in the EIB.v At point 2, EDF displays the command, including keywords, options, and

argument values. The command is identified by transaction identifier,program name, and, if the program has been translated using the cicstrancommand with the -d option, the line number of the command as given inthe translator source listing. You can modify any argument value, orsuppress the running of the command, but you cannot add or deleteoptions.

v At point 3, EDF displays the same as at point 2, plus the response fromcommand running. You can modify certain argument values and theresponse code.

v At points 6 and 7, EDF displays the values of the fields in the EIB and theabnormal termination code.You can interact with EDF in the following ways:

v Display the values of the fields in the EIB associated with the program.v Modify most fields of the EIB. (See the CICS Application Programming

Referencefor a complete list of fields). You cannot modify the followingfields:– EIBTASKN– EIBFN– EIBRCODE– EIBRSRCE– EIBSYNC– EIBFREE– EIBRECV– EIBSYNRB

v Display the program’s working storage in hexadecimal and character form.v Switch off debug mode and continue running the application normally.v Force an ABEND.v Request that command displays are suppressed until one or more of a set

of specific conditions is fulfilled. These conditions are:– EDF encounters a specific named command.– EDF encounters any error condition for which the system action is to

abnormally terminate the task.– EDF encounters a specific exceptional condition.– EDF encounters the command at a specific line number (assuming the

program had been translated using the cicstran command with the -doption).

– 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 figure. After you havesuppressed displays with the SUPPRESS DISPLAYS function, you can use thismenu to specify one or more conditions that cause EDF to stop yourtransaction and start redisplaying commands.

TRANSACTION: ABCD PROGRAM: ABCDPROG TASK NUMBER: 0000000098DISPLAY: 00STATUS: DISPLAY ON CONDITIONS

COMMAND: EXEC CICSLINE NUMBER:CICS EXCEPTIONAL CONDITION:ANY CICS ERROR CONDITION YESTRANSACTION ABEND YESNORMAL TASK TERMINATION YESABNORMAL TASK TERMINATION YES

ENTER: CURRENT DISPLAYPF1 : HELP PF2 : UNDEFINED PF3 : END EDF SESSIONPF4 : SUPPRESS DISPLAYS PF5 : WORKING STORAGE PF6 : USER DISPLAYPF7 : UNDEFINED PF8 : UNDEFINED PF9 : UNDEFINEDPF10: UNDEFINED PF11: UNDEFINED PF12: UNDEFINED

EDF uses the functions in this menu to reduce the amount that you need tointervene when you check a partly working program.

You can stop the transaction:v When a specified command is encounteredv When a specified exceptional condition occurs while performing a

command

v When any error condition occurs while performing a commandv When a transaction abend occurs while performing a commandv At normal task terminationv At abnormal task termination

You can also stop the transaction on a specified line. You can only do this ifyou specified the -d flag when you used the cicstran or cicstcl command totranslate 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 flag, there may be severalsource files with CICS statements at the line you specify. EDF stops atthe first line that you specified that has a CICS statement, which mightnot be the source file that you intended. In this situation, continue touse the same stop condition until EDF stops at the specified line in thesource file you wanted.

While you are debugging a transaction originating from a remote system, thetransaction has its own set of stop conditions that apply only to thattransaction. However, when a transaction ends and you choose to continuethe EDF session, typically when debugging a pseudoconversational sequenceof transactions, CICS maintains the current stop conditions against theCommunications Definitions (CD) entry for the remote system. Anysubsequent transaction originating from the remote region inherits these stopconditions. This continues until CICS maintains a new set of stop conditionsagainst the same CD entry. The new set of stop conditions overwrites theprevious 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 firstEDF user chooses to continue the EDF session. CICS maintains the stopconditions that were in force for transaction A against the CD entry for theremote system. Then transaction B terminates, and the second EDF userchooses to continue the EDF session. CICS maintains the stop conditions thatwere in force for transaction B against the same CD entry for the remotesystem. These stop conditions replace those from transaction A (which CICSloses). Any further transactions originating from the remote system begin withthe stop conditions from transaction B.

Running CEDF:

You must specify the same TSLCheck value in the Transaction Definitions(TD) entry for the CEDF transaction as that specified for the user transaction.Therefore, to use internal security, both must be set to internal, or to use anExternal Security Manager (ESM), both must be set to external.

To invoke EDF, you must have a TSLKey that matches the TSLKey definedfor the CEDF transaction in the TD. In addition, to test a particulartransaction, you must have a TSLKey that matches the TSLKey for thattransaction. If this condition is not satisfied, CICS terminates the EDF sessionimmediately 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 thetransaction under test, unless you redefine the CEDF transaction as notrequiring these checks. To redefine the CEDF transaction, edit the TD forCEDF.

If a transaction has no resource level security checks, and you do not redefinethe CEDF transaction, the default resource level security checks will cause asecurity violation, the CEDF transaction will fail, and an error message iswritten to CSMT. If security checks indicate that you are not allowed access tothe resource, your transaction raises the NOTAUTH condition. Unless youchoose to handle this condition, CICS abnormally terminates your transaction.

If a transaction that can be run under EDF is already running on the specifiedterminal or is inbound from the system, EDF associates itself with thattransaction. Otherwise, EDF associates itself with the next transaction that canbe run under EDF.

When an application program running under EDF ends, the followingmessage 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 specifiedterminal.

Note that, if you are running an EDF session on a terminal and another usertries to run an EDF session on the same terminal, the EDF session transfers tothe new user for the next transaction, even though you can request tocontinue the EDF session and will get the confirmation message:EDF SESSION CONTINUED

You run EDF on a different physical terminal, or window, to the transaction tobe tested.

See the CICS Application Programming Guide for related information.

CEMT (Runtime Resource Management)

The Runtime Resource Management (CEMT) transaction allows you toexamine and alter, while the region is running, the CICS system resourcedefinitions that were initiated at startup.

This transaction affects only the runtime environment. Any changes made toresource definitions using CEMT apply to the current session of CICS — theyare not saved but are replaced with the permanent resource definitions on thenext restart, whether cold or auto.

CEMT allows a user to inquire on and to amend resource definitions, but notto insert new definitions or to delete existing ones.

To insert new definitions, or delete existing ones, you can use the resourcedefinition online (RDO) commands cicsadd and cicsdelete. (See “cicsdelete -Delete CICS resource definitions” 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 bothINQUIRE and SET, while others are used with INQUIRE only. Refer to thefollowing tables:

Table 8. The CEMT extended parameters used with INQUIRE and SET

Extended parameter Description of extended parameter

AUTOINSTALL Inquire upon and set the name of the terminal autoinstall program. See“CEMT INQ/SET AUTOINSTALL” on page 331 for complete details.

AUXTRACE Inquire upon and set whether auxiliary trace is on or off, See “CEMTINQ/SET AUXTRACE” on page 332 for complete details.

DUMP Inquire upon and set the system dump flag. See “CEMT INQ/SET DUMP”on page 333 for complete details.

DUMPOPTIONS Inquire upon and set whether a system dump is required following anabnormal termination with code ASRA or ASRB. See “CEMT INQ/SETDUMPOPTIONS” on page 334 for complete details.

FILE Inquire upon and set certain file attributes in the runtime database. See“CEMT INQ/SET FILE” on page 335 for complete details.

JOURNAL Inquire upon and set whether a journal is open for output or closed. See“CEMT INQ/SET JOURNAL” on page 338 for complete details.

MONITOR Inquire upon and set whether performance monitoring is on or off. See“CEMT INQ/SET MONITOR” on page 339 for complete details.

Table 8. The CEMT extended parameters used with INQUIRE and SET (continued)

NETNAME(netname) Inquire upon certain network name attributes. Network name attributescannot be SET. See “CEMT INQ/SET NETNAME” on page 340 for completedetails.

PROGRAM Inquire upon and set certain program and map attributes in the runtimedatabase. See “CEMT INQ/SET PROGRAM” on page 342 for completedetails.

TASK[(number)] Inquire upon and set runtime task attributes. See “CEMT INQ/SET TASK”on page 344 for complete details.

TCLASS Inquire upon and set runtime task class attributes. See “CEMT INQ/SETTCLASS” on page 347 for complete details.

TDQUEUE Inquire upon and set certain transient data queue attributes in the runtimedatabase. See “CEMT INQ/SET TDQUEUE” on page 348 for completedetails.

TERMINAL Inquire upon and set runtime terminal attributes. See “CEMT INQ SETTERMINAL” on page 351 for complete details.

TRACE Inquire upon and set whether the trace facility is on or off. See “CEMTINQ/SET TRACE” on page 353 for complete details.

TRANSACTION Inquire upon and set runtime transaction attributes. See “CEMT INQ/SETTRANSACTION” on page 354 for complete details.

Read also “Concepts of Inquire and Set Operations” on page 328.

INQUIRE

As described in “Inquiring upon CICS system parameters using CEMT” onpage 355, you can inquire about the following system parameters:

Table 9. The CEMT extended parameters used with INQUIRE only

AKP How often CICS writes checkpoint records.

APPLID The eight-character name that identifies the CICS region.

DATEFORM The date format used by the EXEC CICS FORMATTIME command.

INTROINTVL The number of minutes between invocations of the CICS private transactionthat checks the integrity of the region.

LOCALE The value of the region-wide locale.

The term locale is used to refer to a subset of a user’s environment thatdefines conventions for a specified culture, such as time formatting, numericformatting, monetary formatting, and character classification, conversion,and collation. Refer to your operating system documentation for moreinformation about locales and how they are used.

Table 9. The CEMT extended parameters used with INQUIRE only (continued)

MAXREGIONPOOL The maximum region pool size required by CICS.

MAXTASKSHPOOL The maximum task shared pool size required by CICS.

OPREL The operating system release number.

OPSYS A one-character abbreviation of the operating system.

REGIONTHRESH When CICS should report that it is running out of Region Pool storage.

RELEASE The CICS release level.

SYSID The four-character CICS region identifier.

TASKSHTHRESH 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 thetransaction security key defined for CEMT in the Transaction Definitions (TD).The default region settings do not carry out resource level security checkingfor 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 completerequest. The CEMT transaction checks the syntax of requests and diagnoseserrors. If your request is syntactically correct, CICS performs it immediately. IfCICS cannot satisfy your request because of syntax errors, CICS displays thefull syntax of your request.

Once you start the CEMT transaction, you do not have to type CEMT forfurther requests, because the identifier is implied at the beginning of eachfurther request until you exit from CEMT. To exit from CEMT, press PF3.1. Type CEMT on the command line of your screen, as follows:

CEMTPress the ENTER key. CICS displays the following:STATUS: ENTER ONE OF THE FOLLOWINGInquirePerformSet

2. If you want to inquire about a resource, enter INQUIRE (or a suitableabbreviation) on the command line.If you want to perform a function that is not concerned with resourcestatus, 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 asuitable abbreviation) on the command line.

Entering any of the three keywords cause CICS to display a screendetailing the options available with the command. Each option isdisplayed with its minimum permitted abbreviation in uppercasecharacters and the remainder in lowercase. For example, if you enter INQ,you get the following screen:

You can inquire upon any of the displayed options by typing its keywordafter INQ on the command line. For example,CEMT INQ PROGRAM

tells you the name of each program, what language it is written in, andwhether it is enabled or disabled.

System parameters

The CICS system parameters are a subset of the attributes that are defined inthe Region Definitions (RD). You can use CEMT to find out the values ofthese parameters. For further information, see “Inquiring upon CICS systemparameters using CEMT” on page 355.

See the CICS Administration Guide for information about the CICS resourcelevel security checking mechanism.

Using the CEMT screen

The CEMT screen contains three distinct areas. These are:v Command Input (the first line of the screen)

ISTATUS: ENTER ONE OF THE FOLLOWING OR HIT ENTER FOR SYSTEM PARAMETERS

AUTInstmode TClassAUXtrace TRACeDUMP TRANsactionDUMPOptionsFEConnectionFENodeFEPOolFEPRopsetFETargetFIleTDqueueTErminalNetnameProgramTAsk

APPLID=region7PF 1 HELP 3 END 9 MSG

Figure 1. CEMT INQ

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 first line of the screen. You use this line to enter any of the CEMTcommands described in “Concepts of Inquire and Set Operations” on page 328and “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 thetop and PF key values at the bottom of the screen. CICS uses this area todisplay options that you can use in the current command context, orinformation 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 doesnot have PF keys, you can position the cursor under the required instructionon the screen using the tab keys, and press the ENTER key.

PF1 displays help.

PF3 exits from CEMT, so requests that CICS terminates your CEMTtransaction and ends the session. However, if you use this key whenmodifying your screen, for example, by keying in a new command, orby overtyping an old command, CICS ignores the request and doesnot end your session.

PF7 scrolls back half a page.

PF8 scrolls forward half a page.

PF9 expands messages. If CICS generates more than one message inresponse to your request, CICS displays a message near the bottom ofthe screen telling you how many messages have been generated. ThePF9 key allows you to display all the messages on a separate screen.To go back to your original screen, press the ENTER key.

PF10 scrolls back a whole page.

PF11 scrolls forward a whole page.

Scrolling symbol (+ sign)

A plus (+) sign on the first or last line of a screen tells you that there is moredata preceding or following the current screen. Scrolling backward revealsdata above, and scrolling forward reveals data below.

All parameter

Many of the request formats contain the ALL parameter. For INQ this is adefault which CEMT assumes if you do not specify an alternative. Forexample:

INQ TERMINALshows the attributes of all terminals (default is ALL).

INQ TERMINAL ALLshows 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 identifier tospecify a family of resources. * represents any number of characters (includingnone), and + represents a single character. For example:v A* specifies all identifiers beginning with A.v TERM00+ specifies all seven-character identifiers beginning with TERM00.

Subdefining resource groups

When you make an inquiry, you can subdefine a resource group by specifyingone or more attributes of the group, for example:INQ TERMINAL ALL INSERVICE

displays the status of all terminals that are in service.

You cannot subdefine a resource group by specifying the attributes of a groupby using SET. For example:SET TERMINAL ALL INSERVICE PRIORITY(4)

puts all terminals in service and sets the priority to 4. However, you canmanage such groups of resources by specifying INQ, and modifying thescreen produced.

Inquiry

When you make an inquiry, you get a screen that consists of at least one lineof status information for each resource in the specified group. CICS displaysthe status information as a list of abbreviated keywords.

Overtyping

You can move the cursor to any alterable field in a line and change itscontents by overtyping. When you press the ENTER key again, CICS readsthe contents of all fields that you have changed, and performs any validoperations implied by the changes. If you make an invalid change, CICSdisplays an error message and does not change the field.

The values for each field are not case sensitive, so you can overtype fieldswith lowercase or uppercase characters.

CEMT accepts an abbreviation in fields that allow only certain values, such asthe READABLE and NOTREADABLE field.

Examples:1. If you overtype the READABLE and NOTREADABLE field 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 field.

2. If you overtype the READABLE and NOTREADABLE field with thecharacter N (in uppercase or lowercase) followed by any other character(or no character at all), CEMT allocates the value NOTREADABLE to thefield.

3. If you overtype the ON and OFF field with the characters OF (inuppercase or lowercase), CEMT allocates the value OFF to the field.

If the field allows the values "value" and "NOTvalue" and you overtype thefield with spaces, CEMT allocates the default value to the field. If the originalvalue of the field is "NOTvalue", CEMT displays the field as a blank field. Forexample, if you overtype the READABLE and NOTREADABLE field withspaces, CEMT allocates the value NOTREADABLE to the field.

Whenever you overtype a screen, CICS takes that particular action and alsorefreshes all the status information. You can avoid the associated overheadseither by using the SET command, or by limiting your inquiry to a specificnumber of resources.

Tab key

The fields you can change are different in each screen, but you can detectthem by pressing the Tab key repeatedly. This moves the cursor from one fieldto the next, and you can then overtype the field with the appropriateinformation.

Although you can move to the PF key fields at the bottom of the screen bypressing the Tab key, overtyping these fields has no effect. If you press theEnter key when you are in one of these fields, the result is the action of thatPF key.

Blank fields

Some screens contain blank fields that allow you to specify parameters, suchas NEWCOPY and PURGE, that are not part of the status of a resource. Astatus, such as NOREAD, that begins with “NO” is also represented by ablank field. You can use the Tab key to detect these fields.

Concepts of Inquire and Set Operations

You can use the CEMT transaction to inquire upon (INQ), or set (SET) thestatus of a resource (such as a terminal), a group of resources (such as a classof terminals), or a list of resources. For INQUIRE, CICS displays the status ofspecified resources. For SET, CICS makes the changes specified and displaysthe new status of the resources. However, CICS does not make the change if itfinds 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 files that are remote and enabled, you type:

CEMT INQUIRE FILE REMOTE ENABLED

The CEMT screen displays each file that is remote and enabled, together withall the attributes (the status) of those files. The attributes are set in the regiondefinitions for the resource that you are enquiring upon, so in this example,the File Definitions (FD).

CICS displays the status of the resource in the order shown in the syntax foreach resource. If an attribute is one of several options, the valid option forthat resource is displayed, with the valid options for any other attributes, as alist across the screen, using the first three letters of each option. If a parameterrequires a value, for example an index name, CICS displays each parameterand its value on a separate line. For example, the command INQ FILE(file1)produces a screen with the following layout:

For SET, you must specify a resource identifier as an argument, a genericargument, or ALL. ALL is not a default. For example:

SET TERMINAL INSERVICEproduces an error because there is no resource identifier.

SET TERMINAL(TRM1) INSERVICEsets TRM1 in service.

SET TERMINAL(TRM*) INSERVICEsets all terminals in service whose identifiers start with TRM.

SET TERMINAL ALL INSERVICEsets all terminals in service.

You can specify a list of resource identifiers, rather than a single one. Separatethe 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 theregion definitions for that resource. In the preceding example, this is theTerminal Definitions (WD).

STATUS: RESULTS - OVERTYPE TO MODIFYfil(file1 ) Sfs Clo Ena Rea Upd Add Bro Del

bas( sfs2 )idx( index2 )fsc( /.:/cics/sfs/server1 )

Figure 2. CEMT status screen

CEMT PERFORM SNAP

To obtain a dump and continue running CICS.

SyntaxCEMT PERFORM SNAP [DUMP]

Options

DUMPspecifies that CICS produce a dump. DUMP is the default, so you do nothave to specify this parameter.

To obtain a dump and continue running CICS, use the PERFORM SNAPcommand. In effect, you obtain a snapshot of the CICS region.

CICS always returns a response code 0 (NORMAL), whether or not the dumpis successful.

Note: The use of CEMT PERFORM SNAP prevents all other tasks fromrunning, so other terminal users can experience long delays inresponse.

On CICS for AIX only:

A CICS SNAP DUMP cannot be taken when the IBM Application DebuggingProgram is active. If you do take a dump with IBM Application DebuggingProgram switched on, the dump does not complete. To turn the IBMApplication Debugging Program on and off, use Application DiagnosisConfiguration (CDCN).

CEMT PERFORM SNAP

CEMT INQ/SET AUTOINSTALL

To inquire upon and set the name of the terminal autoinstall program.

SyntaxCEMT {INQ | SET} AUTOINSTALL [PROGRAM(programName)]

Options

PROGRAM(programName)is used to specify the name of the autoinstall user program. A defaultprogram is supplied.

You use this transaction to inquire upon and set the name of the terminalautoinstall program. For guidance information about the automatic installationof 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)

CEMT INQ/SET AUTOINSTALL

CEMT INQ/SET AUXTRACE

To inquire upon and set whether auxiliary trace is on or off, and whichauxiliary trace file is active.

SyntaxCEMT {INQ | SET} AUXTRACECEMT SET AUXTRACE {ON | OFF | SWITCH}

Options

OFFstops recording entries in the auxiliary trace file and closes the file.

ONopens the auxiliary trace file if it was not previously opened, and startsrecording entries in that file. CICS does not record auxiliary trace entries,however, unless internal trace is active at the same time. In this way, youcan control auxiliary tracing by activating and deactivating internal trace.

SWITCHcloses the current auxiliary trace file, then opens the alternate trace file.The status of auxiliary trace (on or off) remains as it was before the switchrequest, unless the second file cannot be opened. If the second file cannotbe opened, CICS turns off auxiliary trace.

CICS writes trace entries to the auxiliary trace file if both internal tracing andauxiliary tracing are in effect. Internal tracing can be started and stoppedusing 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 file is active.

CEMT INQ/SET AUXTRACE

CEMT INQ/SET DUMP

To inquire upon and set the system dump flag.

SyntaxCEMT {INQ | SET} DUMPCEMT SET DUMP {ON | OFF}

Options

OFFsets the system dump flag off.

ONsets the system dump flag on.

This transaction allows you to inquire upon and set the system dump flag.This flag controls whether a system dump is produced or suppressed. Thedefault setting is obtained from the SysDump attribute in the RegionDefinitions (RD).

Examples

To set the system dump flag on:CEMT SET DUMP ON

CEMT INQ/SET DUMP

CEMT INQ/SET DUMPOPTIONS

To inquire upon and set whether a system dump is required following anabnormal termination with code ASRA or ASRB.

SyntaxCEMT {INQ | SET} DUMPOPTIONS [PCDUMP

| NOPCDUMP] [ABDUMP| NOABDUMP]

Options

ABDUMPselects a CICS system dump if a transaction abnormally terminates withcode ASRB (system call abnormal termination). This is the default.

NOABDUMPselects no CICS system dump for ASRB transaction abnormalterminations. A transaction dump might still be produced, depending onthe TransDump attribute in the Transaction Definitions (TD).

NOPCDUMPselects no CICS system dump if a transaction abnormally terminates withcode ASRA (signal or exception). A transaction dump might still beproduced, depending on the TransDump attribute in the TransactionDefinitions (TD).

PCDUMPselects 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 insome situations. This command updates the ABDump, or PCDump attributes,or both, in the runtime Region Definitions (RD).

PCDump and ABDump take effect only if the system dump flag is set to yesin the runtime RD. The system dump flag is the SysDump attribute in theRD.

Examples

To request a CICS system dump if a transaction abnormally terminates withcode ASRB, but no CICS system dump if a transaction abnormally terminateswith code ASRA:CEMT SET DUMPOPTIONS ABDUMP NOPCDUMP

CEMT INQ/SET DUMPOPTIONS

CEMT INQ/SET FILE

To inquire upon and set certain file attributes in the runtime database.

SyntaxCEMT {INQ | SET} FILE[(fileName)]

CEMT INQ FILE[(fileName)] [SFS | REMOTE ] [UNENABLED]

where:

Options

ADDmeans records can be added to the file.

BASENAME (baseName)specifies the Structured File Server Definitions (SSD) name for the file.

BROWSEmeans records in the file can be browsed.

CLOSEDmeans the file is closed; the access method does not allow accesses to thedata until the file is opened. The file may be opened either explicitly byyou, or, if the file has the ENABLED attribute, implicitly by CICS on thenext reference to the data.

When used with SET, the file is closed and also disabled. (The file isdisabled to prevent access requests from implicitly opening the file again.)The close is effected at the time of the command only if there are no taskscurrently accessing the file. If there are current users, the screen indicatesCLOSE requested. This means that when the last user completes his use ofthe file, it effects the close.

Note that a file that has been disabled by means of a SET CLOSEDcommand becomes enabled again by a subsequent SET OPEN command.To distinguish between a file that is disabled in this way from one that isdisabled by means of a SET DISABLED command, CICS displays theformer with the UNENABLED attribute.

CEMT INQ/SET FILE

A file with the DISABLED attribute can be enabled only by a SETENABLED command. A file with the UNENABLED attribute can beenabled by a SET ENABLED command or SET OPEN command.

DELETEmeans records can be deleted from the file.

DISABLEDmeans the file is not available for use by applications except for thosewhich are currently using it. If there are any such users, CICS alsodisplays DISABLING. When used with SET, this command has no effecton existing users; it simply prevents new users accessing the file.

The file can be re-enabled by SET ENABLED. (See UNENABLED.)

ENABLEDmeans the file is available for use by applications and, if closed, it isopened in the first request.

FILESERVER (serverName)specifies the name of the Structured File Server (SFS) file system wherethis file resides.

INDEXNAME (indexName)specifies the name of the SFS index associated with the path to the file.

NOADDmeans records cannot be added to the file.

NOBROWSEmeans records in the file cannot be browsed.

NODELETEmeans records cannot be deleted from the file.

NOREADmeans records in the file cannot be read.

NOUPDATEmeans records in the file cannot be updated.

OPENmeans the file is open. If the file is OPEN ENABLED it is available fordata accesses by CICS transactions. If it is OPEN DISABLED, it must firstbe enabled before it is available. When used with SET, if the file isdisabled only implicitly by a previous SET CLOSED command as opposedto explicitly by SET DISABLED, the SET OPEN re-enables the fileimplicitly.

READmeans records in the file can be read.

CEMT INQ/SET FILE

REMOTEmeans the file is defined as remote. You cannot use CEMT SET for remotefiles.

SFSmeans the file is owned by the Structured File Server (SFS).

UNENABLEDmeans the file is not available for use by applications except for thosewhich are currently using it. If there are applications using the file, CICSalso displays DISABLING.

The UNENABLED status is the same as DISABLED. The difference is thatthe file status becomes UNENABLED implicitly when a SET CLOSE isrequested, and a SET OPEN request implicitly sets the status toENABLED.

UPDATErecords in the file can be updated.

This command allows you to inquire upon and set certain file attributes in theruntime database. Unless the fileName contains the special * and + characters,it must be defined in the File Definitions (FD). The syntax shows the order inwhich the parameters are displayed after an INQUIRE command. See“Concepts of Inquire and Set Operations” on page 328 for an example of thescreen layout. After a SET command, the parameters requiring a name aredisplayed before the parameters that are one of a set of options.

If a file is UPDATABLE or BROWSABLE, it is implicitly readable.For example:v If you set the file to NOTREADABLE when it is either UPDATABLEor

BROWSABLE, the response is NORMAL but the file remains READABLE.v If you set a file to UPDATABLE or BROWSABLE when it is

NOTREADABLE, it implicitly becomes READABLE.v If you set a file to both NOTUPDATABLE and NOTBROWSABLE,it does

not implicitly become NOTREADABLE.

Examples1. To inquire upon all SFS files with read and update permission:

CEMT INQUIRE FILE SFS READ UPDATE

2. To set file FILE1 to have read and write permission, but no updatepermission:CEMT SET FILE(FILE1) READ ADD NOUPDATE

CEMT INQ/SET FILE

CEMT INQ/SET JOURNAL

To inquire upon and set whether a journal is open for output or closed.

OptionsCEMT {INQ|SET} JOURNAL[(journalNumber)] [ALL]

CEMT SET JOURNAL[(journalNumber)] [OUTPUT | CLOSED | SWITCH]

CEMT INQ JOURNAL[(journalNumber)] [DATASET(suffix)]

Options

journalNumberis the journal number. This number can be in the range 1 to 99.

CLOSEDcloses the journal. The journal can now be read by an offline program.

DATASET(suffix)shows the status of the disk file associated with the journal. suffix can be Aor B, and specifies the disk file DISKA or DISKB. The status can beCURRENT, showing that the specified disk file is currently active, orREADY, showing that the specified disk file is not active.

OUTPUTopens the journal for output. The journal must be closed before it can beread by an offline program.

SWITCHswitches between the two disk files, DISKA or DISKB, associated witheach journal.

This transaction allows you to inquire upon and set whether the journal canbe read by an offline program. You can switch a journal between disk files, soit remains available to CICS, but its contents are moved offline for furtherprocessing, for example, archiving or deleting.

Examples1. To inquire about the status of all journals:

CEMT INQUIRE JOURNAL ALL

2. To close journal 21:CEMT SET JOURNAL(21) CLOSED

CEMT INQ/SET JOURNAL

CEMT INQ/SET MONITOR

To inquire upon and set whether performance monitoring is on or off.

SyntaxCEMT {INQ|SET} MONITOR

CEMT SET MONITOR {ON | OFF}

Options

OFFswitches monitoring off.

ONswitches monitoring on.

Examples

To switch performance monitoring off:CEMT SET MONITOR OFF

This transaction allows you to inquire upon and set whether performancemonitoring is on or off.

CEMT INQ/SET MONITOR

CEMT INQ/SET NETNAME

To inquire upon certain network name attributes.

SyntaxCEMT INQ NETNAME(netName) [TERMINAL(termId)]

[TRANSACTION(transId)] [PRIORITY(value)][INSERVICE | OUTSERVICE] [ATI | NOATI][TTI | NOTTI]

Options

netNameis the name by which a terminal is known to the network. Wildcards arenot accepted for this command. The remaining parameters are identical tothose for INQ TERMINAL.

ATImeans the terminal is available for use by transactions that are initiatedautomatically from within CICS.

INSERVICEmeans the terminal is available for use.

NOATImeans the terminal is not available for use by transactions that areinitiated automatically from within CICS.

You cannot specify both NOATI and NOTTI.

NOTTImeans the terminal is not available for use by transactions that areinitiated from this terminal.

You cannot specify both NOTTI and NOATI.

OUTSERVICEmeans the terminal is not available for use.

PRIORITY(value)is the priority of a terminal relative to other terminals. The priority of atask is the sum of the transaction priority, the terminal priority, and theuser priority. The value is in the range from 0 to 255, where 255 is thehighest priority.

TERMINAL(termId)is the name by which the terminal is defined in the Terminal Definitions(WD).

TRANSACTION(transId)is the name of the transaction currently running with this terminal as itsprincipal facility.

TTImeans the terminal is available for use by transactions that are initiatedfrom this terminal.

This transaction allows you to inquire upon and set certain attributes relatingto network names. If you are familiar with network names, you may prefer touse this command as an alternative to “CEMT INQ SET TERMINAL” onpage 351.

Examples

To inquire upon the terminal whose network name is NET16 whether it isavailable for use by transactions initiated from the terminal:CEMT INQUIRE NETNAME(NET16)

If the response screen shows TTI, the terminal is available for use bytransactions initiated from the terminal.

CEMT INQ/SET PROGRAM

To inquire upon and set certain program and map attributes in the runtimedatabase.

SyntaxCEMT {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.

COBOLmeans the program is written in COBOL.

DISABLEDmeans the program is not available for use. You cannot disable programswhose names begin with DFH, because these are reserved for use byCICS.

ENABLEDmeans the program is available for use.

NEWCOPYallows you to get an updated version of a program or a map, or to restorea map that has been overwritten in main storage. When NEWCOPY is notused, CICS will only recognize new versions of programs when they arenot in a program cache or in Micro Focus COBOL runtime memory. If thisis the case, use NEWCOPY to get the updated version.

The loading of Micro Focus COBOL programs is controlled by theenvironment variable COBSW.

The new version of the program may not be available immediately afterNEWCOPY is issued:v In the case of a C program, the new version will not be loaded while

the version in the application server’s C program cache is still beingused.

v In the case of a COBOL program, the new version will not be loadedwhile any COBOL application programs are still being used, as theCOBOL runtime must be reloaded to remove the old version of theprogram. Reloading the runtime will then cause all COBOL programsto be refreshed.

Examples1. To inquire upon all disabled programs:

CEMT INQUIRE PROGRAM DISABLED

2. To enable program PROG1:CEMT SET PROGRAM(PROG1) ENABLED

CEMT INQ/SET TASK

To inquire upon and set runtime task attributes.

CEMT SET TASK[(taskNumber)] {PURGE | FORCEPURGE}

Options

taskNumberis the CICS-generated task number. You cannot use an asterisk (*), or aplus sign (+). If you do not specify a task number, the command appliesto all tasks.You cannot display or change system task attributes. Systemtasks are those tasks started (and used internally) by CICS, not as a resultof a user transaction.

DESTmeans the task has been initiated by a transient data queue trigger level.

DISPATCHABLEmeans the task is ready to run.

FACILITY(facilityId)returns a four-character string representing the name of the facilityassociated with the named task. If the task was initiated from a terminal(FACILITYTYPE of TERM), FACILITY returns the name of the terminal. Ifthe task was initiated by a destination trigger level as defined in theTransient Data Definitions (TDD) (FACILITYTYPE of DEST), FACILITYreturns the name of the associated transient data queue. Otherwise, a nullvalue (blanks) is returned.

INDOUBTmeans that the task is in the “in doubt” state during syncpoint processing.

INFLIGHTmeans that CICS has initiated the task, but no attempt has yet been madeto commit any changes that may have been made to recoverable resourcesduring the current unit of work.

PROCESSID(processId)the process id of the process running the transaction associated with thetask.

PURGE | FORCEPURGEmeans CICS abnormally terminates the task:

CEMT INQ/SET TASK

PURGEspecifies that the task is to be abnormally terminated, but only whenCICS can maintain system and data integrity. A task is not purged ifits associated Transaction Definitions (TD) entry has the notpurgeable.

FORCEPURGEspecifies that the task is to be abnormally terminated immediately. If atask has already been marked for FORCEPURGE, a furtherFORCEPURGE request for the task will be rejected.

As the use of FORCEPURGE can lead to unpredictable results, itshould only be used in exceptional conditions. We do not recommendthe use of FORCEPURGE because it could cause the region toterminate, rather than the task, depending upon what the chosen taskis doing.

A task running in an XA-registered CICS application server cannot beforce purged since this would cause an XA error from the databaseand would result in a region abend. If it is essential to do so, atransaction could be purged at the database end with the risk of anerror causing a region abend.

When a task is marked for PURGE or FORCEPURGE, CICS checks forthese during processing of EXEC CICS commands on behalf of the userprogram. When the check indicates that the task is to be purged orforcepurged, abnormal task termination is triggered. ENQ locks issued bythe task will be released; resources such as terminals, queues, and fileslocked for use by the task will be released; outstanding Logical Unit ofWork will be backed out; and recoverable ATI requests will be requeued.

If the user program keeps control without issuing any EXEC CICScommands, for example, if the program is looping, then the check forPURGE or FORCEPURGE cannot be made and the PURGE request willhave no effect. Similarly, if the user program is waiting for a resourcewithin the execution of an EXEC CICS command the check for PURGEwill not occur until the resource is released. If this does not occur, thePURGE request will have no effect.

If FORCEPURGE was requested, then, if after giving the task anopportunity to be checked for this attribute and CICS was unable to dothis (possibly for one of the above reasons), CICS will force abnormaltermination of the task. CICS may be able to terminate the task tidily, ormay need to terminate the application server, or may cause regionabnormal termination, depending on what the task was doing at the timeof the request.

RUNNINGmeans the task is running.

CEMT INQ/SET TASK

SUSPENDEDis only included for consistency with other CICS family members. If youspecify INQ TASK SUSPENDED, CICS displays a zero length list.

TASKmeans the task has been initiated from another task.

TCLASS(classId)identifies the task class to which the task belongs.

TERMmeans 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.

WAITFORGETmeans that the task is in the “wait forget” state during syncpointprocessing.

Examples

To inquire upon all INDOUBT tasks:CEMT INQUIRE TASK INDOUBT

See the CICS Intercommunication Guide for related information.

CEMT INQ/SET TASK

CEMT INQ/SET TCLASS

To inquire upon and set runtime task class attributes.

SyntaxCEMT {INQ|SET} TCLASS[(classId)]

[ALL] [MINSERVERS(numServers)][MAXSERVERS(numServers)]

Options

classIdidentifies the class to which the task belongs. In CICS on Open Systems orCICS for Windows NT, this value can only be 1.If you specify the specialcharacters + or *, the value is set to 1.

MAXSERVERS (numServers)is the maximum number of application servers permitted to implementtasks for the classId specified in TCLASS.

MINSERVERS (numServers)is the minimum number of application servers required to implementtasks for the classId specified in TCLASS.

Note: If you increase MAXSERVERS to a number greater than the number ofactual application servers running, the extra servers will be startedautomatically. Similarly, if you decrease MINSERVERS below the actualnumber running, the extra servers will be stopped.

Examples1. 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)

CEMT INQ/SET TCLASS

CEMT INQ/SET TDQUEUE

To inquire upon and set certain transient data queue attributes in the runtimedatabase.

SyntaxCEMT {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

TDQnameis a four-character name defined in the TDD. On a SET, the destId cannotrelate to a REMOTE or INDIRECT queue.

CLOSEDmeans the TD queue is closed. The access method does not allow accessesto the data until the queue is opened. The queue must be openedexplicitly by you using CEMT.

When used with SET, the queue is closed and also disabled. (The queue isdisabled to prevent access requests from implicitly opening the queueagain.) The close occurs at the time of the command only if there are notasks currently accessing the queue. If there are current users, the screenshows CLOSING. This means that when the last user no longer requiresthe queue, CEMT effects the close.

DISABLEDmeans the queue is not available for use by applications except for thosethat are already using it. If there are any such users, CICS also displaysDISABLING. When used with SET, this command has no effect onexisting users, but it prevents new users accessing the queue.

The queue can be re-enabled by SET ENABLED.

ENABLEDmeans the queue is available for use by applications and, if closed, it isopened in the first request.

EXTRAmeans the queue is defined as extrapartition.

Note: The term extrapartition transient data is used to describe a CICSfacility that temporarily saves data in the form of queues, calleddestinations. Extrapartition destinations are used for data that is

either coming from a source outside the region, or is being directedfrom a source within the region to a destination outside the region.

INDIRECTmeans the queue is defined as indirect.

INTRAmeans the queue is defined as intrapartition.

Note: The term intrapartition transient data is used to describe a CICSfacility that temporarily saves data in the form of queues, calleddestinations. Data is written to the queue by a user task and can besubsequently used as input data by other tasks with the region.

NAMEIND(indirectTDQname)is available only for indirect queues. The indirectTDQname is the name ofthe queue for which the specified TDQname is an indirect name.

OPENindicates that the queue is open. If the queue is OPEN ENABLED, it isavailable for data accesses by CICS transactions. If it is OPEN DISABLED,it must first be enabled before it is available. If you use the SET commandwhen the queue is disabled implicitly by a previous SET CLOSEDoperation, as opposed to disabled explicitly by SET DISABLED, the SETOPEN enables the queue again implicitly.

REMOTEmeans the queue is defined as remote.

TERMID(termId)is available only for intrapartition queues. The dest is the name of theterminal to be associated with the queue when automatic transactioninitiation (ATI) occurs.

TRANID(transId)is available only for intrapartition queues. The transId is the name of thetransaction that is to be initiated automatically when the queue triggerlevel is reached.

TRIGGERLEVEL(number)is available only for intrapartition queues. The number is the number ofrequests 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 dataqueue attributes in the runtime database. Unless the TDQname contains thespecial * and + characters, it must be defined in the Transient Data Definitions(TDD).

Examples1. 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

CEMT INQ SET TERMINAL

To inquire upon and set runtime terminal attributes.

OptionsCEMT {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 “CEMTINQ/SET NETNAME” on page 340, which uses these names.

Options

termIdis the four-character identifier.

ATImeans the terminal is available for use by transactions that are initiatedautomatically from within CICS.

INSERVICEmeans the terminal is available for use.

NETNAME(netName)is the name by which the terminal is known to the network.

NOATImeans the terminal is not available for use by transactions that areinitiated automatically from within CICS.

You cannot specify both NOATI and NOTTI.

NOTTImeans the terminal is not available for use by transactions that areinitiated from this terminal.

You cannot specify both NOTTI and NOATI.

OUTSERVICEmeans the terminal is not available for use. If you set a terminal toOUTSERVICE, transactions can no longer use the terminal and CICSreleases the terminal and signs the user off, either immediately or whenthe current transaction terminates. If you also specify PURGE, CICSabnormally terminates any transaction using the terminal. If you do notspecify PURGE, CICS allows the transaction to terminate normally, butdoes not allow further transactions to use the terminal.

PRIORITY(value)is the priority of a terminal relative to other terminals. The priority of atask is the sum of the transaction priority, the terminal priority, and theoperator priority. The value must be in the range from 0 to 255, where 255is the highest priority.

PURGEmeans CICS abnormally terminates the task, but only when CICS canmaintain system integrity, data integrity, or both.

TRANSACTION(transId)is the name of the transaction currently running with this terminal as itsprincipal facility.

TTImeans the terminal is available for use by transactions that are initiatedfrom this terminal.

Examples1. 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 terminateany transactions currently using the terminal:CEMT SET TERMINAL(TRM6) OUTSERVICE PURGE

This transaction allows you to inquire upon and set runtime terminalattributes. Unless the termId contains the special * and + characters, it must bedefined in the Transaction Definitions (TD).

CEMT INQ/SET TRACE

To inquire upon and set whether the trace facility is on or off.

SyntaxCEMT {INQ|SET} TRACE

CEMT SET TRACE {ON | OFF}

Options

OFFswitches trace off.

ONswitches 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

CEMT INQ/SET TRACE

CEMT INQ/SET TRANSACTION

To inquire upon and set runtime transaction attributes.

SyntaxCEMT {INQ | SET} TRANSACTION[(transId)][ALL] [PRIORITY(value)][ENABLED | DISABLED]

Options

where:

transIdis the four-character transaction identifier.

DISABLEDmeans the transaction is not available for use. You cannot disabletransactions that have identifiers beginning with C because these arereserved for use by CICS.

ENABLEDmeans the transaction is available for use.

PRIORITY (value)is the priority of a transaction relative to other transactions. When atransaction is running as a CICS task, the priority of a task is the sum ofthe transaction priority, the terminal priority, and the operator priority.The value must be in the range from 0 to 255, where 255 is the highestpriority.

Note: Unless the transId contains the special * and + characters, it must bedefined in the Transaction Definitions (TD).

Examples1. To inquire upon all disabled transactions:

CEMT INQUIRE TRANSACTION DISABLED

2. To enable transaction TRN1:CEMT SET TRANSACTION(TRN1) ENABLED

CEMT INQ/SET TRANSACTION

Inquiring upon CICS system parameters using CEMT

To inquire upon CICS runtime system parameters.

SyntaxCEMT INQUIRE

Description

To inquire upon CICS runtime system parameters, type CEMT INQ. When thepanel shown in Figure 1 on page 324 is displayed press ENTER again todisplay the system parameters. The meaning of these parameters is as follows:

Options

AKPis how often CICS writes checkpoint records. The value is the cumulativenumber of writes to the log made across all CICS application servers inthe region.

APPLIDis the eight-character name that identifies the CICS region uniquely acrossall CICS regions.

DATEFORMis the date format used by the EXEC CICS FORMATTIME command. Thethree possible values are:

mmddyyis the date in the form month-day-year.

ddmmyyis the date in the form day-month-year.

yymmddis the date in the form year-month-day.

INTROINTVLis the number of minutes between invocations of the CICS privatetransaction that checks the integrity of the region.

LOCALEis the value of the region-wide locale.

Note: The term locale is used to refer to a subset of a user’s environmentthat defines conventions for a specified culture, such as timeformatting, numeric formatting, monetary formatting, and characterclassification, conversion, and collation. Refer to your operatingsystem documentation for more information about locales and howthey are used.

MAXREGIONPOOLis the maximum region pool size, in bytes, required by CICS.

MAXTASKSHPOOLis the maximum task shared pool size, in bytes, required by CICS.

MAXSERVERS (numServers)is the maximum number of application servers permitted to implementtasks for the classId specified in TCLASS.

MINSERVERS (numServers)is the minimum number of application servers required to implementtasks for the classId specified in TCLASS.

OPRELis the operating system release number.

OPSYSis a one-character abbreviation of the operating system. CICS returns thefollowing values:

H HP/UX

L Sun Solaris

N Windows NT

REGIONTHRESHis when CICS should report that it is running out of Region Pool storage.The threshold is a percentage value of the total allocation.

RELEASEis the CICS release level. For example, the value 0210 indicates version 2,release 1, modification level 0.

SYSIDis the four-character CICS region identifier.

TASKSHTHRESHis 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 CEMTINQ (without a keyword), press the ENTER key twice, and follow the screenprompts. CICS displays a screen showing a subset of the system parameters,defined and managed using the CICS resource definition online (RDO) facility.

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. CSSFis an early version of the transaction retained for compatibility.

SyntaxCSSF [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 signoffmessage is written to the terminal.

v If you are attached to a remote region through the CICS 3270 TerminalEmulator, 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 thedefault 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 connectionbetween you and CICS is broken, but you remain logged in to the sameDCE userid as you were in before entering CICS.

Note: The TSLKey should not be changed in the Transaction Definitions (TD)entries for either CESF or the CSSF as they should always have publicaccess.

Starting and ending CESF and CSSF:

You start the CESF or CSSF transaction directly by entering the tranid CESF orCSSF. The transaction ends when you are logged off.

Options

EXITcauses CICS to sign you off the terminal, but does not set the terminal outof service. This is the default option.

GOODNIGHTcauses CICS to sign you off the terminal and sets the terminal out ofservice (disabled) and unavailable for further CICS use. This option isignored when the terminal is remote or when the terminal is

CESF and CSSF

autoinstalled. Use the GOODNIGHT option when you don’t want theterminal used until it is put back in service.

Examplesv To sign off and leave the terminal in service:

v To sign off and set the terminal out of service (for local terminals that arenot autoinstalled):CSSF GOODNIGHT

See the CICS Intercommunication Guide for related information.

CESF and CSSF

CESN (Signon)

Syntax

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 correspondingDCE principal from this userid. If a User Definitions (UD) entry exists forthis userid, the DCE principal is specified in the UD entry with thePrincipal attribute. If no UD entry corresponds to this userid, or if novalue is specified with the Principal attribute of the UD entry, then theuserid is passed to DCE as the DCE principal.If you are not using DCE authentication, the userid and password mustmatch those stored in a User Definition.

2. Enter the password corresponding to the DCE principal established in Step1. The password cannot be more than eight characters, nor can it be allblanks or spaces.

3. (optional) Enter a new password to replace the one entered in Step 2. Youwill be prompted to enter the new password a second time for verification.

If you want to exit the signon panel immediately, press F3.

If verification of the DCE principal and password succeed, you are logged inas the CICS userid that you entered. (If no UD key exists for that userid, youwill become the region’s default userid.)

If DCE does not verify the principal and password (if no DCE principal existsor if the password is not correct), the terminal session defaults to the region’s

default userid and you are given access to those transactions and resourceswith TSL and RSL keys that match those listed in the UD entry for theregion’s default userid.

You may use CESN to change the userid you are signed on as. For example, ifyou 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 yousign off using CESF while using CRTE, your userid reverts to the region’sdefault userid rather than BERT.

When you use CESN to sign on as a different user from a CICS client (forexample, 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 notchange the ticket limit and ticket expiry refresh limit account information forthe CICS client that you are using.

For example, if user BERT (who has a ticket of one hour) accesses CICS usingcicsterm, and uses CESN to sign on as ERNIE (who has a ticket of eighthours), the original ticket being used by cicsterm remains unchanged. BERT’sticket expires after its one hour life and his network authentication expiresand the user can no longer access the region even though CESN was used touse ERNIE’s userid. All that really changes when you use CESN to changeyour userid is the specifics defined for the UD entry, such as the transactionsand resources you are given access to.

To regain the original userid after having changed it with CESN (whether ornot you were able to log on to a valid CICS userid) either sign on again usingCESN, 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 beenused 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 Definitionfor CESN.

Starting and ending CESN:

You start the CESN transaction directly by entering the tranid CESN. Thetransaction ends when you have successfully logged on or when the logon isrejected.

See the CICS Intercommunication Guide for information about the securityconsiderations when signing on to a CICS system during transaction routing.

CMLV (Console Message Log Viewer)

Browses the console log.

Syntax

Description

CMLV is a CICS-supplied transaction that seamlessly browses theconsole.nnnnnn files for the region in which it is running. It can be used tobrowse the console message log for another region by running it remotelyusing CRTE. The name of the region for which the console message log isbeing displayed is shown in the top left hand corner of the CMLV map in theAPPLID field.

When CMLV is invoked it makes a copy of the console log and browses thecopy. Any changes to the original file cannot be seen unless the refreshfunction (PF9) is used.

CMLV displays 160 characters per logical line. Any messages that exceed thislength are split onto 2 or more lines. In order to maximise the number ofmessages displayed, only 80 characters of each line are displayed at any onetime. Scrolling functions are available to scroll to the end of a line.

Using CMLV:

PF1 displays the help information for the console message log viewertransaction.

PF3 exits from the log viewer and clears the screen.

PF4 displays the first page of the file.

PF5 displays the last page of the file.

PF7 scrolls backwards.

PF8 scrolls forwards.

PF9 closes the file and reopens it. This allows any changes since CMLVwas invoked to be displayed. The refresh operation returns thedisplay to the start of the file.

PF11 scrolls the display left by 40 characters.

PF12 scrolls the display right by 40 characters.

CLEARexits from the log viewer and clears the screen.

CRTE (Routing Transaction)

To run transactions owned by a connected CICS region.

Syntax

CRTE SYSID{=sysId | (sysId) }

Options

sysIdis the four-character key of the Communications Definitions (CD) entrythat defines the remote region where the transaction is to run.

Example:

To route to the remote region whose local CD definition is called REG1:CRTE SYSID=REG1

Description

You can use CRTE to run transactions that reside on a connected remote CICSsystem, instead of defining these transactions as remote in the local system.CRTE is particularly useful for infrequently used transactions, or fortransactions such as CEMT that reside on all systems. It avoids the necessityof defining the remote CEMT in the local system with a different name.

The transactions run can include pseudoconversational transactions as well asCRTE itself.

The terminal through which CRTE is run must be defined on the remotesystem (the application-owning region) or it must be shipped from the localregion (the terminal-owning region). See the CICS Intercommunication Guide foradditional information.

The routing transaction verifies that the specified remote region is known andis available. If it is, a message displays confirming that a routing session tothe required region is started. You can then clear the screen and enter thetransaction code for the transaction to be run on that system, and you enterinput of the form:

yyyyzzzzzz...

where yyyy is the name by which the required remote transaction is known onthe remote region, and zzzzzz... is the initial input to that transaction.Subsequently, you can use the remote transaction as if you have defined it

locally and run it in the ordinary way. In fact, you use the terminal as if itwere connected directly to the remote region.

When using CRTE, security checking on the remote system is not affected bythe userid you used to sign on to the local system. Instead, security checkingdepends 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

region’s default userid. When a transaction is run, the security checks arecarried out against this default user. A check is also done against the linkuserid to see whether the remote system itself has authority to access theresource. Thus, access is granted to those resources defined for the defaultuserid that are also defined for the link userid. If a link userid is notspecified, then access is granted to those resources defined for the defaultuserid that are also defined in the Communications Definitions (CD) entryTSLKeyMask and RSLKeyMask attributes.

v If you do sign on to the remote region while running CRTE (using CESN),access is granted to those resources defined for the signed on userid thatare also defined for the link userid. If a link userid is not specified, thenaccess is granted to those resources defined for the default userid that arealso defined in the Communications Definitions (CD) entry TSLKeyMaskand RSLKeyMask attributes.

You end a routing session by entering the CANCEL keyword. This keywordautomatically signs you off from the connected region (assuming you weresigned on in that region). When a routing session is ended, CICS displays themessage: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 toend the routing session.

Note: In a chain of CRTE sessions, different systems may be in differentlocales. The term locale is used to refer to a subset of a user’senvironment that defines conventions for a specified culture, such astime formatting, numeric formatting, monetary formatting, andcharacter classification, conversion, and collation. Refer to youroperating system documentation for more information about localesand how they are used.

Although the routing transaction is implemented as a pseudoconversationaltransaction, CICS holds the terminal from which the transaction is run untilCICS terminates the routing session.

While a terminal is in a routing session with another region (that is, duringthe period between entering CRTE and CANCEL) the terminal cannot receivemessages delivered by automatic transaction initiation (ATI).

Starting and ending CRTE:

You start the CRTE transaction directly by entering the tranid CRTE. Thetransaction ends when the CANCEL keyword is used.

See “CESN (Signon)” on page 359 for information about what userid is usedand what level of security you are given when using CRTE to change useridsafter you have used CRTE. See also the CICS Intercommunication Guide forrelated information.

CSTD (Statistics)

Displays statistics information.

Syntax

Description

CSTD is a CICS-supplied transaction that displays statistics information for:v Temporary storage and transient datav Storage poolsv Tasksv Intersystem communicationv Filesv Terminalsv Transactionsv Programs

To gather these statistics, CSTD uses the EXEC CICS COLLECT STATISTICScommand (see the CICS Application Programming Reference for information onthis command).

Using CSTD:

When you enter CSTD the following screen is displayed:

CSTD 01/17/96 11:02:09 CICS Statistics Display

Option ===>

1 - TS and TD Statistics 2 - Pool Storage Statistics3 - Miscellaneous Statistics 4 - ISC Details Statistics5 - File Statistics 6 - Terminal Statistics7 - Program Statistics 8 - Transaction Statistics9 - Class Max Task Statistics 10 - ISC Summary Statistics

11 - Transaction/Program Rates 12 - 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 pressingEnter.

Enter refreshes the display

Clear exits from CSTD

PF3 Returns to the main CSTD menu

PF5 Stop auto update

PF6 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 acategory as shown in “The CSTD screen” on page 367. The statistics are thendisplayed.

Setting ’Display inactive files’ to ’N’ causes CSTD not to display files thathave zero values. Placing characters in the ’Start display with file:’ field causesthe display to start with the indicated characters.

The terminal on which CSTD is running should be set to ‘ATI’.

Chapter 4. Operator control of FEPI

Two CICS-supplied transactions, CEMT and CETR, provide operator controlof FEPI: you can use the CEMT INQUIRE, SET, and DISCARD commands tocontrol FEPI resources such as nodes, targets, and pools; and the CETRtransaction to control FEPI trace.

CICS/ESA onlyYou can also use VTAM commands to manage communication withtarget systems.

FEPI application programs, and the CICS resources they use, are controlledjust like other CICS applications and resources.

CEMT—master terminal transaction

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

CEMT DISCARD

DISCARD removes targets, nodes, pools, or property sets completely fromFEPI.

Syntax

Press the Clear key to clear the screen. Type CEMT DISCARD (the minimumabbreviation 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 first or second line gives a syntaxprompt.

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.

CEMT DISCARD

CEMT INQUIRE FECONNECTION

Display information about FEPI connections.

Context

INQUIRE FECONNECTION displays information about the state of FEPIconnections. A connection is identified by specifying the target and node. Theresults are given in order of target within the node. Family selection can beused for TARGET and NODE, but list selection cannot be used.

Syntax

Press the Clear key to clear the screen. There are two ways of commencingthis 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 yourequire. For example, if you enter cemt i fec p(pool5) acq, the resultingdisplay will show you the details of all FEPI connections in pool5 on whichsessions are bound.

You can tab to the highlighted fields and overtype them with new values.

CICS/ESA only:

ÊÊ CEMT Inquire FEConnectionALl

NODe(nodename) Target(targetname)

ÊPool(poolname) INSTalled

NOTinstalledINSErviceOutservice

ACquiredReleased

ÊState(value) Waitconvnum(value) Lacqcode(value)

CICS for Windows NT:

Chapter 4. Operator control of FEPI 371

ÊÊ CEMT Inquire FEConnectionALl

NODe(nodename) Target(targetname)

ÊPool(poolname) INSTalled

NOTinstalledINSErviceOutserviceGOINgout

ACquiredReleasedOBTAiningFREEing

ÊState(value) Waitconvnum(value) Lacqcode(value)

Options

ALlis the default. Information about all connections is given, unless youspecify a selection.

NODe(nodename)is the 8-character name of a node. Information is restricted to connectionsof which this node forms part.

Target(targetname)is the 8-character name of a target. Information is restricted to connectionsof which this target forms part.

Examples

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.

CEMT IN FECSTATUS: RESULTS - OVERTYPE TO MODIFYNode(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

Pool(poolname)displays the 8-character name of a pool of connections.

Installed|Notinstalleddisplays a value identifying the install state of the connection. The valuesare:

InstalledThe connection is in a pool that has been defined by INSTALLand is available for use.

NotinstalledThe connection is in a pool, or involves a node or target that isbeing discarded, but is still in use.

Inservice|Outservice|Goingoutdisplays a value identifying the service state of the connection. The valuesare:

InserviceThe connection is in service and can be used in a conversation.

CICS/ESA onlyIf OUTSERVICE state has been requested but has not yetcompleted, a ‘GOING OUT’ message is shown.

OutserviceThe connection is out of service and cannot be used for anyconversation.

Goingout

CICS for OS/2 and CICS for Windows NTThe connection is being put out of service.

Acquired|Released|Obtaining|Freeingdisplays a value identifying whether a session on the connection is bound.The values are:

AcquiredA session is bound on the connection.

CICS/ESA onlyIf RELEASED state has been requested but has not yetcompleted, a ‘BEING RELEASED’ message is shown.

ReleasedNo session is bound on the connection. If ACQUIRED state hasbeen requested but has not yet completed, a ‘BEING ACQUIRED’message is shown.

Obtaining

CICS for OS/2 and CICS for Windows NTA session is being bound on the connection. The connectionremains in the OBTAINING state until all the criteria forACQUIRED have been met.

Freeing

CICS for OS/2 and CICS for Windows NTThe session involving the connection is being unbound.

State(value)displays a 12-character value identifying the state of the conversationusing the connection. The values are:

APPLICATIONA normal application task owns the conversation

BEGINSESSIONA begin-session handling task owns the conversation

FREE An end-session handling task owns the conversation, following aFEPI FREE command

NOCONVNo conversation is active on the connection

PENDBEGINA begin-session handling task has been scheduled

PENDDATAFEPI is waiting for inbound data, following a FEPI STARTcommand

PENDFREEAn end-session handling task has been scheduled, following aFEPI FREE command

PENDPASSThe conversation is unowned, following a FEPI FREE PASScommand

PENDRELEASEAn end-session handling task has been scheduled, following anunbind request

PENDSTARTInbound data having arrived, a task specified by FEPI START hasbeen scheduled

PENDSTSNAn STSN-handling task has been scheduled

PENDUNSOLAn unsolicited-data handling task has been scheduled

RELEASEAn end-session handling task owns the conversation, following anunbind request

STSN An STSN-handling task owns the conversation

UNSOLDATAAn unsolicited-data handling task owns the conversation.

The “pending” states indicate the conversation is unowned, pending theevent or task indicated. If a “pending” state persists, it is likely that theapplication has failed in some way; you should consider resetting theconnection by issuing a CEMT SET FECONNECTION RELEASEDcommand.

Waitconvnum(value)displays a value identifying the number of conversations that are waitingto start using a connection. (If a conversation could use any one of severalconnections, it is counted as waiting on each one.)

Lacqcode(value)

CICS/ESA onlydisplays a hexadecimal value indicating the result of the last acquirerequest for the node; that is, the sense code from the last VTAMREQSESS, a zero indicating success. For information about VTAMsense codes, see either the VTAM Messages and Codes or the SNAFormats manual.

CICS for OS/2 and CICS for Windows NTdisplays a hexadecimal value indicating the result of the last acquirerequest for the node; zero indicating success. For information aboutsense codes, see either the Conventional LUA Programming Referencemanual or the SNA Formats manual.

CEMT INQUIRE FENODE

Display information about a FEPI node.

Syntax

Press the Clear key to clear the screen. There are two ways of commencingthis 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 yourequire. For example, if you enter cemt i fen inst, the resulting displaywill show you the details of all FEPI nodes that have been installed and areready for use.

You can tab to the highlighted fields and overtype them with new values.

CICS/ESA only:

CEMT INQUIRE FENODE

ÊÊ CEMT Inquire FENodeALl

(nodename) INSTalledNotinstalled

INSErviceOutservice

ÊACquiredReleased

Lacqcode(value)ÊÍ

CEMT INQUIRE FENODE

ÊÊ CEMT Inquire FENodeALl

(nodename) INSTalledNotinstalled

INSErviceOutserviceGOINgout

ÊACquiredReleasedOBTAiningFREEing

Lacqcode(value)ÊÍ

CEMT INQUIRE FENODE

Options

ALlis the default. Information about all nodes is given, unless you specify anode.

nodenameis the 8-character name of the node to be queried.

Examples

Options

Fenoindicates that this panel relates to an FENODE inquiry.

(value)displays the 8-character name of a node.

Installed|Notinstalleddisplays a value identifying the install state of the node. The values are:

InstalledThe node has been defined by INSTALL and is available for use.

NotinstalledThe node is being discarded, but is still in use.

Inservice|Outservice|Goingoutdisplays a value identifying the service state of the node. The values are:

InserviceThe node is in service and can be used in a conversation.

CEMT IN FENSTATUS: RESULTS - OVERTYPE TO MODIFYFeno(NODE1 ) Inst Inse Acqu Lacq(X'00000000')Feno(NODE2 ) Inst Inse Acqu Lacq(X'00000000')Feno(NODE3 ) Inst Inse Acqu Lacq(X'00000000')Feno(NODE4 ) Inst Inse Acqu Lacq(X'00000000')

Figure 4. CEMT INQUIRE FENODE screen

CEMT INQUIRE FENODE

OutserviceThe node is out of service and cannot be used for anyconversation.

Goingout

CICS for OS/2 and CICS for Windows NTThe node is being put out of service.

Acquired|Released|Obtaihp0.ining|Freeingdisplays a value identifying the acquire state of the node. The values are:

Acquired

CICS/ESA onlyThe VTAM ACB for the node is open and the VTAM ‘setlogon start’ command has completed. If RELEASED state hasbeen requested but has not yet completed, a ‘BEINGRELEASED’ message is shown. If this persists, you mightneed to use VTAM commands to recover the node.

CICS for OS/2 and CICS for Windows NTThe node is acquired and, if in service, can be used in aconversation.

Released

CICS/ESA onlyThe VTAM ACB is closed. If ACQUIRED state has beenrequested but has not yet completed, a ‘BEING ACQUIRED’message is shown. If this persists, you might need to useVTAM commands to recover the node.

CICS for Windows NTThe node is released and can not be used for anyconversation.

OBTAining

CEMT INQUIRE FENODE

CICS for Windows NTThe node is being acquired. The node remains in theOBTAINING state until all the criteria for ACQUIRED havebeen met.

FREEing

CICS for Windows NTThe node is being released.

Lacqcode(value)

CICS/ESA onlydisplays a hexadecimal value indicating the result of the last acquirerequest for the node; that is, the sense code from the last VTAMOPEN ACB, a zero indicating success. For information about VTAMsense codes, see either the VTAM Messages and Codes or the SNAFormats manual.

CICS for Windows NTdisplays a hexadecimal value indicating the result of the last acquirerequest for the node; zero indicating success.

For information about IBM Communications Servers sense codes, seeeither the Conventional LUA Programming Reference manual or theSNA Formats manual.

CEMT INQUIRE FENODE

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 commencingthis 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 yourequire. For example, if you enter cemt i fepo inse, the resulting displaywill show you the details of all FEPI pools that are in service and can beused by conversations.

You can tab to the highlighted ‘service state’ field and overtype it with a newvalue.

CICS/ESA only:

CEMT Inquire FEPOol

ÊÊ CEMT Inquire FEPOolAll

(poolname) INSTalledNotinstalled

INSErviceOutservice

ÊDevice(value) Waitconvnum(value)

CEMT Inquire FEPOol

ÊÊ CEMT Inquire FEPOolAll

(poolname) INSTalledNotinstalled

INSErviceOutserviceGOINgout

ÊDevice(value) Waitconvnum(value)

CEMT INQUIRE FEPOOL

Options

Allis the default. Information about all pools is given, unless you specify apool to be queried.

poolnamespecifies the name of a pool of connections.

Examples

Options

Fepoindicates that this panel relates to an FEPOOL inquiry.

(value)displays the 8-character name of a pool of connections.

Installed|Notinstalleddisplays a value identifying the install state of the pool. The values are:

InstalledThe pool has been defined by INSTALL and is available for use.

NotinstalledThe pool is being discarded, but is still in use.

Inservice|Outservice|Goingoutdisplays a value identifying the service state of the pool. The values are:

InserviceThe pool is in service and can be used in a conversation.

CEMT IN FEPOSTATUS: RESULTS - OVERTYPE TO MODIFYFepo(POOL3 ) Inst Inse Devi(T3278M4 ) Wait(00000)Fepo(POOL5 ) Inst Inse Devi(T3278M2 ) Wait(00000)

Figure 5. CEMT INQUIRE FEPOOL screen

CEMT INQUIRE FEPOOL

OutserviceThe pool is out of service and cannot be used for anyconversation.

Goingout

CICS for Windows NTThe pool is being out put of service.

Device(value)displays a value identifying the mode of conversation and the type ofdevice. The values are:

T3278M2SLU2 mode, 3278 Model 2

T3279M2SLU2 mode, 3279 Model 2B

TPS55M2SLU2 mode, PS/55, 24 lines

LUP SLU P mode, all cases

Waitconvnum(value)displays a value identifying the number of conversations that are waitingto start using a connection in the pool.

CEMT INQUIRE FEPOOL

CEMT INQUIRE FEPROPSET

Display information about a set of FEPI properties.

Press the Clear key to clear the screen. There are two ways of commencingthis 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 currentlyinstalled.

v Type CEMT INQUIRE FEPROPSET (CEMT I FEPR) followed by the name of aparticular property set. For example, if you enter cemt i fepr (feprop1),the resulting display will show you whether or not the FEPI property setfeprop1 is installed. (If it is not installed, you get a 'NOT FOUND' response.)

Syntax

ÊÊ CEMT Inquire FEPRopsetAll

(propsetname)ÊÍ

Options

Allis the default. Information about all property sets is given, unless youspecify a particular one.

propsetnameis the name of the property set to be queried.

Examples

Options

Feprindicates that this panel relates to an FEPROPSET inquiry.

CEMT IN FEPRSTATUS: RESULTSFepr(PROP1 )Fepr(PROP2 )Fepr(PROP3 )Fepr(PROP4 )

Figure 6. CEMT INQUIRE FEPROPSET screen

(value)displays the 8-character name identifying a property set.

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 commencingthis 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 yourequire. For example, if you enter cemt i fet inse, the resulting displaywill show you the details of all FEPI targets that are in service.

You can tab to the highlighted ‘service state’ field and overtype it with a newvalue.

CICS/ESA only:

ÊÊ CEMT Inquire FETargetALl

(targetname) APpl(applname) INSTalledNotinstalled

ÊINSErviceOutservice

ÊÊ CEMT Inquire FETargetALl

(targetname) APpl(applname) INSTalledNotinstalled

ÊINSErviceOutserviceGOINgout

Syntax

ALlis the default. Information about all targets is given, unless you specifythe target to be queried.

targetnameis the name of the target to be queried.

Examples

Options

Fetaindicates 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 systemthat the target represents.

Installed|Notinstalleddisplays a value identifying the install state of the target. The values are:

InstalledThe target has been defined by INSTALL and is available for use.

NotinstalledThe target is being discarded, but is still in use.

Inservice|Outservice|Goingoutdisplays a value identifying the service state of the target. The values are:

InserviceThe target is in service and can be used in a conversation.

CEMT IN FETSTATUS: RESULTS - OVERTYPE TO MODIFYFeta(TARGETA ) Appl(APPL5 ) Inst InseFeta(TARGETB ) Appl(APPL6 ) Inst InseFeta(TARGET1 ) Appl(APPL1 ) Inst InseFeta(TARGET2 ) Appl(APPL2 ) Inst InseFeta(TARGET3 ) Appl(APPL3 ) Inst InseFeta(TARGET4 ) Appl(APPL4 ) Inst Inse

Figure 7. CEMT INQUIRE FETARGET screen

OutserviceThe target is out of service and cannot be used for anyconversation.

Goingout

CICS for Windows NTThe target is being put out of service.

Chapter 5. CICS-supplied programs

CICS-supplied programs make it possible for you to modify the systemwithout changing any of its standard user interfaces. These programs can becustomized or replaced to suit the requirements of your installation. The sixsupplied programs are:

External Security Manager (ESM)CICS calls the ESM (cicsesm) to carry out resource and transactionsecurity checking in place of CICS-provided security checking. This isdescribed in “External Security Manager user program” on page 395.

Terminal Autoinstall ProgramCICS calls Terminal Autoinstall (DFHCHATX) to control theautomatic installation of terminals which are not defined to CICS atstart-up. The automatic installation of these terminals takes placewhen they request connection to a CICS system. This is described in“Terminal autoinstall user program” on page 390.

Communications Definitions (CD) entry Autoinstall ProgramThe CD entry autoinstall program (DFHCCINX) is called from theCCIN transaction. CCIN runs whenever an IBM CICS client connectsto the region, or if a remote CICS server requests an autoinstall of aCD entry. DFHCCINX is responsible for determining whether to allowthe autoinstall of the CD entry and, if the autoinstall is to proceed, itcan specify values for some of the attributes in a newly installed CDentry. DFHCCINX is described in the CICS Intercommunication Guide.

Performance monitoring programCICS calls the Performance Monitoring User Program (cicsemp) toperform the processing at user Event Monitoring Points taking theform of EXEC CICS ENTER API commands. This is described in“Performance monitoring user program” on page 395.

Function Shipping User Conversion ProgramCICS calls the Function Shipping User Conversion Program(DFHUCNV) to perform non-standard data conversion when functionshipping. This is described in the CICS Intercommunication Guide.

Transaction Routing User Conversion ProgramCICS calls the Transaction Routing User Conversion Program(DFHTRUC) to perform non-standard data conversion whentransaction routing. This is described in the CICS IntercommunicationGuide.

Terminal autoinstall user program

Terminals are defined to CICS using Terminal Definitions (WD). Only someterminals’ entries are stored permanently in the WD; most terminals do nothave a permanent entry. When these terminals request a CICS session, CICShas to create a WD entry automatically, so that CICS can recognize theterminal. 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 aruntime WD entry for the terminal.

These autoinstalled terminals are defined in the runtime WD only while theyare connected to CICS. When you terminate the connection, CICSautomatically removes the WD entry. A particular advantage of autoinstall isthat you do not have to create and maintain a large permanent WD. Anyterminal or pseudo-terminal that does not have an entry in the WD for theregion, is autoinstallable.

CICS can use the terminal autoinstall user program to control the process ofadding entries to the runtime WD whenever terminals, not already defined toCICS, request connection to CICS.

The supplied user program selects the first in a list of suitable models toderive the terminal identifier. You may customize the program to carry outany processing that you require. For example, you may wish to count andlimit the total number of logged on terminals, or keep utilization informationabout the terminal.

The user program is also called when the terminal is uninstalled and removedfrom the WD. This can be used, for example, to update any statistics set upon autoinstall.

Terminal model definition

If you have a commonly used terminal type, you can add it to the terminaldefinitions. If the terminal is to be a model terminal, you must set theModelId and DevType attributes. If the terminal is a real terminal, you mustset the NetName attribute instead.

The supplied terminal autoinstall program

The user terminal autoinstall program takes responsibility for deciding toallow or disallow the connection of a new terminal resource to the CICSsystem. This decision may be based on a number of site-dependent factors, forexample security, or the total number of connected terminals. CICS takes nopart in either the decision, or checking the factors. You decide whether

CICS-supplied programs

checking takes place, and how it is done. The user terminal autoinstallprogram provides you with the means of implementing your decision.

An autoinstall model is a terminal definition that you use as a model whenyou attempt to invoke a session and define your autoinstallable terminal toyour CICS system.

The default terminal autoinstall program, DFHCHATX, is a C programsupplied to you as part of CICS. The sample source code, cics_aut.ccs is inprodDir/src/samples/install, together with a makefile makefile. You alsoneed the file cics_aut.h, which is in the header files.

You can install DFHCHATX in its unmodified form, or you can customize itto meet the particular requirements of your organization. Before you changeDFHCHATX, try the default autoinstall program first. If you decide to alterthe functionality of the default autoinstall program, take a backup copy of theprogram source first, in case you encounter problems and need to revert tothe original version.

After modification, you must place the generated executable load module intothe required directory so that it is available for use by your CICS system.

For information about the CICS directory structure, see the Planning andInstallation Guide book.

You can write the program in either C or COBOL, and you can use EXECCICS commands. You must define the program in the Program Definitions(PD).

You can customize the default terminal autoinstall program to carry out anyprocessing required by your installation. Here are some customizationsuggestions.

Your user terminal autoinstall program could:v Control the allocation of terminal identifiers.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 userterminal autoinstall program on a remote CICS system receives an

Chapter 5. CICS-supplied programs 391

autoinstall request, the request may involve the global user terminalautoinstall program, and data can be transferred from one user terminalautoinstall program to another.

Each time the terminal autoinstall program is invoked, CICS passes aparameter list to the program using the COMMAREA mechanism of theEXEC CICS LINK command. The contents of the parameter list define whichfunction to perform (INSTALL or UNINSTALL) and provide data relevant tothe particular event.

If the user terminal autoinstall program decides that the autoinstall requestcan proceed, the program must return the name of the autoinstall model toCICS , together with an associated terminal identifier, by storing the requiredvalues in the COMMAREA return information field. Subsequently, CICS usesthe returned values to install the terminal in the WD. In addition, the userterminal autoinstall program must indicate in the returned status bytewhether or not the event is to proceed. If the autoinstall is to proceed, it setsthe status field set to binary zeros.

The model name is selected from the array of model names passed to theautoinstall program in the parameter list. CICS uses this model so that it canrecognize the terminal. CICS selects the autoinstall models in the array fromthe complete list of terminal models according to their compatibility with thesystem information describing the resource.

The default user terminal autoinstall program selects the first model from thelist. CICS uses this model to build the Terminal Definitions (WD) entry anddetermine the CICS attributes of the automatically installed terminal. Thedefault user terminal autoinstall program generates the terminal identifierfrom the first two and the last two characters of the name by which theterminal is known to the network. CICS passes this netname to the defaultprogram, using the COMMAREA.

If the user terminal autoinstall program returns a model name that is not inthe list passed to the user terminal autoinstall program, CICS generates anABEND and will not install the terminal.

If the user terminal autoinstall program decides that the autoinstall request isto be rejected, it must set the status byte in the COMMAREA to be not equalto binary zeros.

When processing is complete, the user terminal autoinstall program mustreturn to CICS by issuing an EXEC CICS RETURN command.

When you write the user terminal autoinstall program, the processingrequired for the UNINSTALL function does not depend upon whether the

program received control because a previously autoinstalled resource is nolonger required, or because a previous INSTALL process failed for somereason. The processing you need to perform may be considered identical forthe two events; there is no difference in the environment or in the actions thatyour program needs to perform.

Invoking the user terminal autoinstall program to perform the UNINSTALLfunction enables you to reverse the processes carried out at the INSTALLevent. For example, if your user terminal autoinstall program increments acount of the total number of automatically installed resources at INSTALLtime, your program can decrement the count at UNINSTALL time.

Terminal autoinstall program parameters

When CICS runs the user terminal autoinstall program, the followingparameters are passed through the COMMAREA:

Parameter 1This is a four-byte field. The first byte indicates the request type,INSTALL being 0 and UNINSTALL being 1. The remaining three bytesare reserved by CICS.

Parameter 2This is a pointer to the identifier structure. The identifier structureconsists of a two-byte length field, followed by the eight-byteNETNAME of the resource requesting a CICS session.

The NETNAME is the name which identifies the terminal to thenetwork. CICS generates the NETNAME by combining the hostnameon which the CICS 3270 Terminal Emulator is running with the nameof the operating system tty device that is being controlled. This stringis 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 ofEAGLS027, 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 calledeagle would have a NETNAME of EAGLTYVC. For a cicsteldterminal, the process identifier of the cicsteld process is used insteadof the tty device identifier.

To produce a unique terminal name, CICS places the first twocharacters of the supplied NETNAME in front of the last twocharacters of the NETNAME (EA27 in the example above). Ifnecessary, the NETNAME formed from this combination istransformed until a unique terminal name is produced.

Parameter 3This is a pointer to a structure containing an array of names of eligibleautoinstall models. The structure contains a two-byte field defining

the number of elements in the array; followed by the array containingeight-byte name elements. If the array is empty, the number field isset to zero.

Parameter 4This is a pointer to the 21-byte return information field, set to blankson input. You can use it to return the following information to thecalling program. The first eight bytes contain the autoinstall modelname, the next four-bytes contain the terminal name, the next eightbytes are blank, and the last byte is a status-byte used to indicatewhether or not the terminal installation event is to proceed.

Parameter 5This area is not relevant to CICS and is set to zero.

The parameters which CICS passes in the COMMAREA to the user terminalautoinstall program when reversing the autoinstall process are:

Parameter 1This is a four-byte field. The first byte is set to 1 to indicate anUNINSTALL request.

Parameter 2This is a pointer to a four-byte field containing the terminal identifierof the deleted resource.

When the terminal autoinstall program is accessed

When the CICS 3270 Terminal Emulator (or a replacement) connects to aregion for the first time, CICS calls a transaction called CHAT. This transactionis responsible for performing the autoinstall operation for terminals which arenot already defined to the Terminal Definitions (WD). CHAT calls theuser-supplied autoinstall program if the terminal is to be autoinstalled. Youare permitted to control the autoinstall program name by using the CEMTSET AUTOINSTALL command. CICS also calls the autoinstall program whenan autoinstalled definition is deleted, permitting you to reverse whateveractions were performed at install time. Deletion of an autoinstalled definitionoccurs automatically when you run the CSSF transaction.

The autoinstall program is also called when a terminal is connected orremoved on a CICS Client connected to the region. In this case, thetransaction that is running is called CCIN. It passes the same parameters tothe exit, and calls it at the same stages as CHAT does. See the CICSIntercommunication Guidefor more information.

CICS passes control to the user program when:v An autoinstall INSTALL request is being processedv An autoinstall INSTALL request has failed

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, andv Autoinstall processing has completed to a point where information (a

terminal identifier and autoinstall model name) from the user program isrequired in order to proceed.

To provide symmetry of user control over the autoinstall process, the userprogram also receives control automatically when a session with a previouslyautomatically installed terminal has ended, or an autoinstall request waspreviously accepted by the user program but the subsequent INSTALL processfailed for some reason.

External Security Manager user program

The default External Security Manager (ESM) program, cicsesm, is supplied toyou as part of CICS. You can implement it in its unmodified form, or you cancustomize it to meet the particular requirements of your site. Note that in itsunmodified form, the ESM will simply return CICS_ESM_RETURN_OK toevery security check, indicating that authorized access has been granted to thetransaction or resource.

The initial configuration of a CICS region sets external security off, using theESMLoad attribute in the Region Definitions (RD). CICS performs internalsecurity checking when ESMLoad is off. If you wish to override internalsecurity checking, then you must modify the ESM program to carry out thesecurity checks that you require.

After modification, you must place the generated executable load module intothe 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 programavailable 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 theResource Definition Online (RDO) facility to set the MonitorStatus attribute inthe permanent Monitoring Definitions (MD). You can also use the CEMT SET

MONITOR transaction to set the MonitorStatus attribute. You use the RDOfacility to specify the name of the Performance Monitoring user program inthe UserMonitorModule attribute in the Monitoring Definitions (MD).

CICS calls the program:v During task startupv During task exitv To process the EXEC CICS ENTER commandv To stop the user clocks and return the user data to be written to the

monitoring transient data queuev To restart the user clocksv At the end of a task, to clean up the user data.

You can customize the default program to carry out any processing that yourequire.

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 aspart of CICS. You should customize the default performance monitoring userprogram to meet the particular requirements of your installation.

After modification, you must place the generated executable load module intothe required directory, so that the executable is available for use by the CICSsystem.

You must customize the program using C, but you cannot use EXEC CICScommands. You must define the program in the Monitoring Definitions (MD).

The default performance monitoring user program is an example program,provided to illustrate how performance monitoring interfaces with CICS. Theprogram consists of four separate functions:1. Initialization

This function returns the address of the other three interface functions tothe caller plus the address of the program’s private data area (forsubsequent use by the other user functions because the user programcannot use static data). If the function encounters an error, an error code isreturned for CICS to write as part of a message.The default Initialization function uses the algorithm:

Allocate task's data area space (malloc)IF the malloc fails

Return CICS_EMP_RETURN_FAIL to disable user programELSE

Set up the return valuesReturn CICS_EMP_RETURN_OK

END-IF.

2. EnterAPI

This function processes the EXEC CICS ENTER command. CICS passes theinformation from the EXEC CICS ENTER command parameters. Thefunctionality of the function is entirely user-defined. The functionprocesses the request and returns instructions to CICS on what to performnext at completion. If the function encounters an error, an error code isreturned 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 programEND-IF.Switch on the TRACEID from the EXEC CICS ENTER API

CASE 1:Return CICS_EMP_RETURN_WRITEto Write a monitoring record.

CASE 2:IF ENTRYNAME is “START”

Start clock 1Mark clock 1 active

ELSEIF ENTRYNAME is “STOP”

Stop clock 1Mark clock 1 inactive

ELSENo action taken

END-IFEND-IF.Return CICS_EMP_RETURN_OK.

CASE 3:Add DATA1 to counter 1Return CICS_EMP_RETURN_OK.

CASE 4:Set counter 2 to DATA2Return CICS_EMP_RETURN_OK.

CASE 5:Increment counter 3Return CICS_EMP_RETURN_OK.

CASE 6:Disable all monitoring for this taskRelease data space (free)Return CICS_EMP_RETURN_DISABLE.

CASE 7:Time a write to the monitoring TD QueueStart clock 2Return CICS_EMP_RETURN_WRITE

CASE 8:Disable the user program for this taskRelease 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 CICSappends to a monitoring record. If the address of the buffer is NULL orthe length is zero, CICS does not append any user monitoring data to thesystem information. The functionality of this function is entirelyuser-defined, it should however, stop clocks if appropriate.If the function encounters an error, an error code is returned for CICS towrite 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 taskRelease data space (free)Return CICS_EMP_RETURN_DISABLE

ELSEIF Operator ID is zeroOR Data area (from Initialization) invalidDisable user program for taskRelease data space (free)Return CICS_EMP_RETURN_FAIL

END-IFEND-IFStop clock 1Move counters and times into target recordReturn the record address and length.

4. Restart

This function releases any resources acquired by the Initializationfunction.CICS passes the address of the user program’s private data.If the function encounters an error, an error code is returned for CICS towrite 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 programEND-IF.Switch on the action request from CICS

CASE CICS_EMP_FINISH_RESTART:Reset all 3 countersStop clock 2IF clock 1 is marked as active

Start clock 1END_IFReturn CICS_EMP_RETURN_OK.

CASE CICS_EMP_FINISH_CLEANUP:Release data space (free)IF memory freed successfully

Return CICS_EMP_RETURN_OKELSE

Return CICS_EMP_RETURN_FAILEND-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.SynopsisCICS_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 thefunction:

CICS_EMP_CLOCK_TYPE_ELAPSEDRecord elapsed time.

CICS_EMP_CLOCK_TYPE_SYSTEMRecord system time.

CICS_EMP_CLOCK_TYPE_USERRecord user time.

CICS_EMP_CLOCK_TYPE_BOTHRecord both system and user time.

The function returns one of the following return values to your program:

CICS_EMP_CLOCK_RETURN_OKThe clock started successfully.

CICS_EMP_CLOCK_RETURN_PHASEThe clock started out of phase.

CICS_EMP_CLOCK_RETURN_INVALIDThe clock type is invalid.

CICS_EMP_CLOCK_RETURN_FAILURECannot obtain system or user times.

If the function returns CICS_EMP_CLOCK_RETURN_OK, the functionalso updates the Timer parameter.

2. CICS_EMP_StopClock

Provides you with the necessary functionality to stop monitoring clocks,and accumulate the time recorded by that clock, passed in the Timer dataarea.

Note: The Timer data area must be initially set to nulls, because this iswhere the timer functions CICS_EMP_StartClock andCICS_EMP_StopClock accumulate clock information.

SynopsisCICS_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_OKThe clock stopped successfully.

CICS_EMP_CLOCK_RETURN_PHASEThe clock stopped out of phase.

CICS_EMP_CLOCK_RETURN_INVALIDThe clock type is invalid.

CICS_EMP_CLOCK_RETURN_FAILURECannot obtain system or user times.

If the function returns CICS_EMP_CLOCK_RETURN_OK, the functionalso updates the Timer parameter.

3. CICS_EMP_GetTime

Provides you with the necessary functionality to get the current time in aCICS_EMP_Time_t data area.Synopsisvoid CICS_EMP_GetTime(CICS_EMP_Time_t *CurrentTime);

4. CICS_EMP_SubtractTime

Provides you with the necessary functionality to calculate the differencebetween two times of type CICS_EMP_Time_t.Synopsisvoid 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 dependupon which of the four functions CICS is about to perform.

1. The initialization function

Function prototype#include <cics_emp.h>CICS_EMP_Return_tCICS_EMP_Init (IN struct CICS_EMP_RegionData *RegionData

,INOUT struct CICS_EMP_Functions *Functions,INOUT void **SaveSpace,INOUT int *ErrorCode,IN struct CICS_EMP_PerformanceClass *SystemData,IN struct cics_eib *EIB,IN const struct CICS_EMP_Map *Dictionary);

The parameter passed by CICS to this function is:

RegionDataThis is a pointer to data describing the CICS region. Theparameters contained within this data are:

Region_IdThe eight-character name of the region.

ReleaseIdThe four-character release number.

Transaction IdThe four-character transaction identifier.

The parameters returned by this function are:

Return_CodeThis is the return code returned by the function. It is one of:

CICS_EMP_RETURN_OKThe initialization completed successfully.

CICS_EMP_RETURN_FAILThe initialization detected an error. CICS disables userEMPs for this region.

CICS_EMP_RETURN_DISABLEThe initialization completed successfully, but CICS is todisable monitoring for this task.

FunctionsIf the Return_Code=CICS_EMP_RETURN_OK, this is a pointer toa buffer that contains the Event Monitoring Point (EMP) functionaddresses. The addresses contained in the buffer are:

EnterAPIProcess the EXEC CICS ENTER command.

WriteRecordReturn user data to write to the performance file.

ReStartAllow the user to restart any clocks following the write ofa monitoring record.

SaveSpaceThis is the address of the user program’s private data forthe task.

ErrorCodeIf the Return_Code is not CICS_EMP_RETURN_OK, thisis a pointer to an error code which CICS writes as part ofa message.

SystemDataThis is a pointer to the performance class monitoringstructure. The address of the SystemData is constant forthe life of the transaction. The Monitor Field Table detailsthis.

EIB The Execution Interface Block for the transaction.

DictionaryThis contains information on how to interpret theSystemData. The address of the Dictionary is constant forthe life of the CICS region.

The mask definitions used to extract data from the DictionaryCICS_EMP_Map structure are:v CICS_EMP_CLOCK_TYPE_MASKv CICS_EMP_GROUP_MASKv CICS_EMP_TDQ_DETAIL_TYPE_MASKv CICS_EMP_FID_MASK

Note: Dictionary, EIB, and SystemData must be treated as read-only bythe user exit functions.

2. The enter API function

Function prototype#include <cics_emp.h>CICS_EMP_Return_tCICS_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:

SaveSpaceThis is the address of the user program’s private data for the task.

EnterDataThis is a pointer to the information from the EXEC CICS ENTERcommand. The information is:

ID The 16-bit EMP identification number in the range 0 through 255.

EntryNameThe eight-character ENTRYNAME parameter of the EXEC CICSENTER command.

Data1 The DATA1 field from the EXEC CICS ENTER command. This isthe most significant 32 bits from the FROM parameter.

Data2 The DATA1 field from the EXEC CICS ENTER command. This isthe least significant 32 bits from the FROM parameter.

Error CodeIf the Return_Code is not CICS_EMP_RETURN_OK orCICS_EMP_RETURN_WRITE, this is a pointer to an error codewhich CICS writes as part of a message.

CICS_EMP_RETURN_OKThe function completed successfully.

CICS_EMP_RETURN_FAILThe function detected an error. CICS will disable userEMPs for this region.

CICS_EMP_RETURN_DISABLEThe function completed successfully but CICS will disablemonitoring for this task.

CICS_EMP_RETURN_WRITEThe function completed successfully. CICS writes amonitoring record at this point. This return value causesCICS to call WriteRecord to obtain the user data record.

3. The writerecord function

Function prototype#include <cics_emp.h>CICS_EMP_Return_tCICS_EMP_WriteRecord (

OUT void **UserData,OUT short *UserDataLength,IN struct CICS_EMP_PerformanceClass *SystemData,

IN int *UnSupportedFlds,INOUT void **SaveSpace,OUT int *ErrorCode,IN const struct CICS_EMP_Map *Dictionary);

SystemDataThis is a pointer to the performance class monitoring structure.The address of the SystemData is constant for the life of thetransaction. The Monitor Field Table details this.

UserDataIf the function returns CICS_EMP_RETURN_OK, this parametercontains a pointer to the User Data record which CICS writes tothe monitoring Transient Data (TD) Queue. If this parameter isnull, CICS writes only the system monitoring data to the TDQueue.

UserDataLengthIf the function returns CICS_EMP_RETURN_OK, this 16-bitparameter contains the length of the User Data record which CICSwrites to the monitoring TD Queue. If this parameter is null, CICSonly writes the system monitoring data to the TD Queue.

Error CodeIf the Return_Code is not CICS_EMP_RETURN_OK, this is apointer to an error code which CICS writes as part of a message.

DictionaryThis contains information on how to interpret the SystemData.The address of the Dictionary is constant for the life of the CICSregion.

The mask definitions used to extract data from the DictionaryCICS_EMP_Map structure are:v CICS_EMP_CLOCK_TYPE_MASKv CICS_EMP_GROUP_MASKv CICS_EMP_TDQ_DETAIL_TYPE_MASKv CICS_EMP_FID_MASK

Note: Dictionary, SystemData, and UnsupportedFlds must be treated asread only by the user exit functions.

4. The restart function

Function prototype#include <cics_emp.h>CICS_EMP_Return_tCICS_EMP_Restart (IN enum CICS_EMP_Finish Action

,INOUT void **SaveSpace,INOUT int *ErrorCode);

FinishActionCICS passes one of two possible values to the function to indicatethe functionality required:

CICS_EMP_FINISH_RESTARTRestart any clocks or counters stopped by the precedingWriteRecord call.

CICS_EMP_FINISH_CLEANUPPerform any cleanup functions required to terminate thetask.

Error CodeIf the Return_Code is not CICS_EMP_RETURN_OK, this is apointer to an error code which CICS writes as part of a message.

When the performance monitoring program is accessed

CICS calls the Initialization function within the Performance Monitoring userprogram at the start of each transaction, so that the user program can performany Event Monitoring Point (EMP) specific initialization.

CICS calls the Performance Monitoring user program during the execution ofa 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 userprogram. One of the return conditions from this function causes CICS towrite a Monitoring Record.

v At the end of the task.After preparing the Performance part of the Monitoring record, CICS callsthe WriteRecord function within the user program, to retrieve the user data.On completion of the write to the Transient Data Queue (TD Queue), CICScalls the Restart function within the user program to release any resourcesit has acquired.

v The user program requests that CICS write a monitoring record.The EnterAPI function within the user program, returns a request to writea Monitoring record. CICS builds a record from user-selected PerformanceMonitoring information and calls the WriteRecord function within the userprogram. On completion of the write to the TD Queue, CICS calls theRestart function within the user program to restart or reset any informationstopped by the write request.

v The CICS event monitoring function detects an error.If CICS disables the Performance Monitoring in response to an errorcondition it detects, it also calls the Restart function within the userprogram to release any resources it has acquired.

Chapter 6. User exits

A user exit point (normally referred to as a user exit) is a place in a CICSmodule at which CICS can transfer control to a program that you havewritten (a user exit program), and at which CICS can resume control whenyour exit program has finished its work. You do not have to use any of theuser exits, but you can use them to extend and customize the function of yourCICS system according to your own requirements.

For example, you may wish to log the completion of each task or take someaction if a task completes abnormally. To do this you write a user exitprogram to be invoked at the task termination user exit and you set theUserExitNumber attribute in the Program Definition of the program to ’15’,the number that identifies the task termination user exit.

Each user exit has a unique number and name and is normally referred to byits 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 identifier of the CICS component that invokes theuser exit program and nnn is the user exit number, padded to a length ofthree characters with leading zeroes.

The following table shows the numbers and names of the user exits:

User Exit Number User Exit Name Description

15 UE014015 Task termination

17 UE052017 Dump request

25 UE014025 Dynamic transaction routing

50 UE015050 Dynamic distributed program link

51 UE016051 Syncpoint

52 UE115052 IIOP security exit

53 UE115053 IIOP certificate exit

31 UEI09031 FEPI data conversion

For more information on how to make use of user exits, and the rulesgoverning the writing of user exit programs, see the CICS AdministrationGuide. For information about the IIOP user exits, see the CICS IIOP ORBProgramming Guide.

Standard definitions and data types

The supplied cicstype.h file must be used when defining parameters in theheader and specific parameter lists.

Constants

The following constants are defined for user exits#define cics_UE_NAME_MAX 8 /* max length of UE name */#define cics_UE_TRAN_MAX 4 /* transaction name max length */#define cics_UE_USER_MAX 8 /* userid max length */#define cics_UE_TERM_MAX 4 /* termid max length */#define cics_UE_PROG_MAX 8 /* application program name max length */#define cics_UE_SYSID_MAX 4 /* Max length of a sysid */#define cics_UE_APPL_MAX 8 /* Max length of a region name */#define cics_UE_HEADER_VERSION 1 /* all version number start at 1 */#define cics_UE_WORKAREA_SIZE 128 /* fixed size for this version */

The return code from all user exit functions iscics_UE_Return_t;

The definition of each user exit specifies which return codes are supportedand the subsequent behavior for each.

The following values are provided for cics_UE_Return_t#define UE_Normal (cics_UE_Return_t) 0#define UE_Bypass (cics_UE_Return_t) 1#define UE_Abend (cics_UE_Return_t) 2#define UE_Shortonstorage (cics_UE_Return_t) 3#define UE_Term_Abend (cics_UE_Return_t) 4#define UE_Terminate (cics_UE_Return_t) 5#define UE_ProgramNotKnown (cics_UE_Return_t) 6#define UE_HeaderVersion (cics_UE_Return_t) 7#define UE_SpecificVersion (cics_UE_Return_t) 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 provideinformation, which is standard for all user exits, in a consistent manner acrossthe product. These are all input-only parameters.

typedef struct{

cics_ushort_t UE_Version;cics_ulong_t UE_ProcessId;

User exits

cics_ulong_t UE_Thread;cics_ushort_t UE_Number;cics_char_t UE_Name[cics_UE_NAME_MAX+1];cics_char_t UE_TransId[cics_UE_TRAN_MAX+1];cics_ulong_t UE_TaskNo;cics_char_t UE_Workarea;cics_ushort_t UE_WorkareaSize;cics_UE_YesNo_t UE_TraceOnExit;cics_char_t UE_RegionName[cics_UE_APPL_MAX+1];cics_UE_Header_t;

The fields in cics_UE_Header_t are defined as follows:

UE_Versionis the version number for this structure and takes the value defined incics_UE_HEADER_VERSION. It is advisable to check this in user exitprograms to ensure that the version number passed when the userexit is called is the same as that contained in the version of cicsue.hused when the program was generated. If a mismatch is detected thencontents of fields are unpredictable and the UE program should beregenerated using the correct version of cicsue.h.

UE_ProcessIdis the id of the process which has invoked the user exit.

UE_Threadis the id of the thread in which the user exit is invoked.

UE_Numberis a number which uniquely identifies the user exit which has beeninvoked. Refer to the definition for that user exit in order to determinethe name of the exit-specific structure which is passed to the user exitand the name of the function which the associated user exit programmust contain.

UE_Nameis the name of the user exit as it appears in dumps, traces, and theexit-specific structure.

UE_Transidis the transaction which was active when the user exit was invoked.All user exits have an associated transaction.

UE_TaskNoprovides a unique number for the task associated with the user exit.All user exits have an associated task number.

UE_Workareais a pointer to the workarea associated with user exits for this task. Itcan be used to pass information between user exits for the same taskand is also useful when debugging user exit programs. The workareais located in storage immediately after the cics_UE_header storage;

User exits

Chapter 6. User exits 409

both areas are traced when an A15Z abend is issued, if trace is activefor the component which called the user exit at which the A15Z wascaught. It can also be traced based on the setting of UE_TraceOnExit.All user exits have an associated task. The workarea will bereinitialized between tasks. You must control the usage of thisworkarea between user exits. It can be used creatively whendebugging user exit programs.

UE_WorkareaSizeis the size of the user exit workarea. This is a fixed length of 128bytes.

UE_TraceOnExitOn entry to a user exit this field is set to UE_No. It can be altered bythe user exit program to UE_Yes, which will cause the header andspecific parameter lists to be traced on exit (if product trace is active).

UE_RegionNameThe name of the CICS region.

Task termination user exit (UE014015)

The task termination user exit is invoked at normal and abnormal tasktermination (after any syncpoint has been taken).

You should ensure that no recoverable work is done in the user exit program.

Function prototypecics_UE_return_t UE014015(

/*IN*/ cics_UE_Header_t *cics_UE_Header,/*IN*/ cics_UE014015_t *cics_UE_Specific

Exit-specific constants#define cics_UE014015_VERSION 2 /* all version numbers start at 2 */typedef enum

{UE_Normaltermination,UE_Abnormaltermination

} cics_UE_Terminationtype_t;

Exit-specific structuretypedef struct

{cics_ushort_t UE_Version;cics_UE_Terminationtype_t UE_Terminationtype;

} cics_UE014015_t;

User exits

Fields in exit-specific structure

UE_Versionis the version number for this structure and takes the value defined incics_UE014015_VERSION. It is advisable to check this in user exitprograms to ensure that the version number passed when the userexit program is called is the same as that contained in the version ofcicsue.h used when the program was generated. If a mismatch isdetected then contents of fields are unpredictable and the user exitprogram should be regenerated using the correct version of cicsue.h.

UE_Terminationtypeis the type of task termination. It can take the values of

UE_Normalterminationthe task ended in a controlled manner. This may include atask abnormal termination.

UE_Abnormalterminationan error occurred during task termination.

Return codes

UE_NormalContinue 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 ortransaction dump is taken.

Function prototypecics_UE_Return_t UE052017 (

/*IN*/ cics_UE_Header_t *cics_UE_Header,/*IN*/ cics_UE052017_t *cics_UE_Specific

Exit-specific constants#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, /* EXEC CICS DUMP issued */UE_DUMP_ABEN, /* Transaction abend occurred */UE_DUMP_ASRA, /* Transaction abend ASRA occurred */UE_DUMP_ASRB, /* not issued currently */

Task termination user exit (15)

UE_DUMP_SNAP, /* CEMT PERF SNAP requested */UE_DUMP_SHUT, /* Shutdown dump */UE_DUMP_SYSA /* System abend occurred */

} cics_UE_DumpReason_t;

{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;

UE_VersionIs the version number for this structure and takes the value defined incics_UE052017_VERSION. It is advisable to check this in user exitprograms to ensure that the version number passed when the userexit is called is the same as that contained in the version of cicsue.hused when the program was generated. If a mismatch is detected thenthe contents of fields are unpredictable and the user exit programshould be regenerated using the correct version of cicsue.h.

UE_UserUser ID.

UE_TermTerminal ID. This parameter is only valid for terminal attached tasks,being set to ″″ otherwise.

UE_ProgName of the application program. This parameter may not be validfor system dumps, when it will be set to ″″.

UE_DumpcodeDump code.

UE_DumpReasonDump reason, as defined for UE_Dump_reason.

*UE_CWAPointer to CWA.

Dump request user exit (17)

UE_CWALENLength of CWA.

*UE_TCATWAPointer to TWA.

UE_TCATWA_LENLength of TWA.

UE_TransDumpThis parameter only has meaning for transaction dumps. It isextracted from the TransDump attribute of the Transaction Definition.This parameter cannot be altered within a user exit program.

Return codes

UE_normalContinue processing.

UE_bypassSuppress 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 defined as dynamic in its Transaction Definition

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 Prototypecics_UE_return_t UE014025 (

/*IN*/ UE_header_t *UE_header,/*INOUT*/ UE014025_t *UE_specific

Exit-specific constants

Constants used in declaring the exit-specific 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:

Dump request user exit (17)

typedef enum cics_UE_Func{

UE_ROUTESEL, /* Route selection */UE_RTESELERR, /* Error in route selection */UE_ROUTETERM, /* Successful end of dynamic route */UE_RTERESVD, /* Not used */UE_RTEABEND /* The transaction has abended locally, or some

* failure occurred during the routing of the* transaction to a remote system */

} cics_UE_Func_t;

Constants indicating the reason for connection failure:typedef enum cics_UE_Error

{UE_SYSID_UNKNOWN, /* System identifier was not found */UE_SYSID_OUT_SRV, /* System was out-of-service */UE_CON_FAILURE, /* Unable to connect or connection failure */UE_NO_ERROR /* No route selection error has occurred */

} cics_UE_Error_t;

{cics_ushort_t UE_Version;cics_UE_Func_t UE_Dyrfunc;cics_ushort_t UE_Dyrcount;cics_char_t UE_Dyrsysid[cics_UE_SYSID_MAX+1];cics_ubyte_t *UE_Dyrtptr;cics_ushort_t UE_Dyrtlgth;cics_char_t *UE_Dyrcwaptr;cics_ushort_t UE_Dyrcwalgth;cics_char_t UE_Dyrlclsys[cics_UE_SYSID_MAX+1];cics_char_t UE_Dyrlclapl[cics_UE_APPL_MAX+1];cics_UE_YesNo_t UE_Dyropter;cics_UE_YesNo_t UE_Dyrretry;cics_UE_Error_t UE_Dyrerror;cics_char_t UE_Dyrtran[cics_UE_TRAN_MAX+1];cics_char_t UE_Dyrprog[cics_UE_PROG_MAX+1];cics_char_t UE_Dyrabcde[cics_UE_ABND_MAX+1];cics_char_t *UE_Dyruser;cics_ushort_t UE_Dyrusersize;cics_char_t *UE_Dyrcomptr;cics_ushort_t UE_Dyrcomlgth;

} cics_UE014025_t;

UE_version (Input parameter only)is the version number for this structure and takes the value defined incics_UE014025_VERSION. It is advisable to check this in user exitprograms to ensure that the version number passed when the userexit is called is the same as that contained in the version of cicsue.hused when the program was generated. If a mismatch is detected then

Dynamic transaction routing user exit (25)

the contents of fields are unpredictable and the user exit programshould be regenerated against the correct version of cicsue.h.

UE_Dyrfunc (Input parameter only)tells you the reason for this invocation of the dynamic transactionrouting program.

The possible values are:

UE_ROUTESELInvoked for transaction routing.

UE_RTESELERRInvoked because an error occurred in route selection.

UE_ROUTETERMInvoked because a previously routed transaction hasterminated.

UE_RTEABENDInvoked because the routed transaction abended.

UE_Dyrcount (Input parameter only)is a count of the times the dynamic transaction routing program hasbeen invoked for routing purposes for this transaction withUE_Dyrfunc set to UE_ROUTESEL, UE_RTEABEND or UE_RTESELERR. Thisoption is provided to allow you to limit the number of retry requests.

UE_Dyrsysididentifies a CICS system. The exact meaning of this parameterdepends on the value for UE_Dyrfunc:v When UE_Dyrfunc is set to UE_ROUTESEL, UE_Dyrsysid contains:

– The remote CICS system identifier as specified on theRemoteSysId attribute of the installed transaction definition, or,

– The system identifier of the local CICS system if RemoteSysId isnot specified.

The dynamic transaction routing program can accept this value orchange it before returning to CICS. If the system identifier youreturn to CICS is the same as the local system identifier, CICS runsthe transaction in the local system.

v When UE_Dyrfunc is set to UE_RTESELERR, UE_Dyrsysid contains theCICS system identifier returned to CICS by the dynamic transactionrouting program on its previous invocation, and the systemidentifier is found to be in error. The action that your dynamictransaction routing program can take when UE_Dyrfunc isUE_RTESELERR depends on the UE_Dyrerror parameter setting:– If UE_Dyrerror is set to UE_SYSID_UNKNOWN (unknown system

identifier) or to UE_SYSID_OUT_SRV (CICS system out-of-service)

and you want CICS to retry transaction routing, you mustchange UE_Dyrsysid before returning to CICS.

– If UE_Dyrerror is set to UE_CON_FAILURE (connection failure) youcan retry the same system identifier or you can change the valuein UE_Dyrsysid.

– The transaction can be routed locally, by changing UE_Dyrsysidto be null or the identifier of the local system.

v When UE_Dyrfunc is set to UE_RTEABEND, UE_Dyrsysid contains thename of the CICS system on which the transaction abended. Thetransaction cannot be retried.

v When UE_Dyrfunc is set to UE_ROUTETERM, UE_Dyrsysid contains thename of the CICS system on which the completed transactionexecuted.

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 identifier of the local system.

UE_Dyrlclapl (Input parameter only)is the applid name of the local system.

UE_Dyropterspecifies whether the dynamic transaction routing program is to bereinvoked when the routed transaction terminates either successfullyor because of a transaction abend.

UE_No The dynamic transaction routing program is not to bereinvoked. 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 mustbe set to UE_Yes on the initial invocation of the user exit.

UE_Dyrretryindicates whether the dynamic transaction routing program should bereinvoked if a route selection error occurs.

UE_No The dynamic transaction routing program is not to bereinvoked. 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 indicatesthe type of error that occurred during the last attempt to route atransaction. The possible values are:

UE_SYSID_UNKNOWNThe selected system is unknown.

UE_SYSID_OUT_SRVThe selected system is out-of-service.

UE_CON_FAILUREUnable to connect to remote system, or connection failure.

UE_NO_ERRORNo connection failure has occurred.

UE_Dyrtrancontains the remote transaction name. When UE_Dyrfunc is set toUE_ROUTESEL, UE_Dyrtran contains the remote transaction namespecified in the RemoteName attribute of the installed TransactionDefinition. Your dynamic transaction routing program can accept thisremote transaction name, or supply a different transaction name forforwarding to the remote CICS system. You can change UE_Dyrtran onany call to the dynamic transaction routing program, though it iseffective 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_Dyrtranis set to a null string, then the local transaction name is used as theremote transaction name.

UE_Dyrprogis the name of the initial program associated with the transaction forwhich the dynamic transaction routing program is invoked, if thetransaction is defined for dynamic routing. You can use this field tospecify the name of an alternative program to be run if the transactionis routed locally. For example, if all remote CICS systems areunavailable, and the transaction cannot be routed, you may want torun a program in the local system to send an appropriate message tothe user. This defaults to the ProgName attribute defined in theTransaction Definition for the transaction.

Note: UE_Dyrprog should never be returned containing a null string. Ifa null string is found when the parameter list is passed back to CICSthen an abend and message will be issued.

UE_Dyrabcde (Input parameter only)if the transaction was routed locally, this field contains the abend codeof that transaction. If the transaction was routed remotely, this fieldcontains the abend code of the transaction routing session.

UE_Dyruseris a pointer to a user area with a length of UE_Dyrusersize. CICSinitializes this user area to zeroes before invoking the dynamictransaction routing program for a given task. This user area can bemodified by the dynamic transaction routing program, returned toCICS, and is passed to subsequent invocations of the dynamictransaction routing program for a given transaction instance. If theuser 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_Dyrcomptris a pointer to the transaction’s COMMAREA.

UE_Dyrcomlgthis the length of the transaction’s COMMAREA.

Return Codes

UE_NormalContinue processing with parameters returned from the user exitprogram.

UE_TerminateTerminate the dynamic transaction routing request.

UE_Term_AbendTerminate 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 differentcases: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

Definition (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.

Notes:

1. ‘dynamic distributed program link’ is abbreviated to ‘dynamic DPL’ in thisdefinition.

2. The application program which issues the EXEC CICS LINK command iscalled the ‘linking’ program.

3. The application program which is linked to is called the ‘linked-to’program.

Function prototypecics_UE_return_t UE015050 (

Exit-specific constants#define cics_UE_DPLAREA_SIZE 128 /* User Exit user area size */#define cics_UE015050_VERSION 1 /* All version numbers start at 1 */

Constants indicating why UE015050 was invoked:typedef enum cics_UE_LinkFunc

{UE_LINKSEL,UE_LINKUNKNOWN,UE_LINKTERM,UE_LINKABEND

} cics_UE_LinkFunc_t;

Definitions:

UE_LINKSELIndicates that this is the initial invocation of the user exit program.The user exit program can make decisions about which system orprogram to link to.

UE_LINKUNKNOWNIndicates that this is the initial invocation of the user exit program fora program to link to which does not have a Program Definition (PD).The user exit program can make decisions about which system orprogram to link to.

UE_LINKTERMIndicates that the linked-to program completed successfully.

UE_LINKABENDIndicates that the linked-to program did not complete successfully.

{cics_ushort_t UE_Version;

Dynamic distributed program link user exit (50)

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

} cics_UE015050_t;

UE_Version (Input parameter only)is the version number for this structure and takes the value defined incics_UE015050_VERSION. It is advisable to check this in the user exitprogram to ensure that the version number passed when the user exitis called is the same as that contained in the version of cicsue.h usedwhen the program was generated. If a mismatch is detected thencontents of fields are unpredictable and the user exit program shouldbe 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_LINKSELInvoked for selection of link destination.

UE_LINKUNKNOWNInvoked for selection of link destination for an undefinedprogram.

UE_LINKTERMInvoked after successful return from a linked-to program.

UE_LINKABENDInvoked after an unsuccessful return from a linked-toprogram.

UE_Dplsysididentifies the system identifier of a CICS system to which to route thelink request.

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 identifier of the local system.

UE_Dpllclapl (Input parameter only)is the applid name of the local system.

UE_Dplopterspecifies whether the dynamic DPL user exit program is to bereinvoked when the linked-to program terminates either successfullyor unsuccessfully. The possible values are:

UE_No The user exit program is not to be reinvoked. This is thedefault.

UE_Yes The user exit program is to be reinvoked. If you wishUE15050 to be reinvoked then UE_Dplopter must be set toUE_Yes on the initial invocation of the user exit program.

UE_Dplmirtrancontains the name of the mirror transaction on the remote system. Seethe CICS Administration Guide for a full description of this parameter.

UE_Dplprogis the name of the program to be started by the EXEC CICS LINK.This field can be used to change the name of the program on the localor 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_Dpluseris a pointer to a user area of length UE_Dplusersize.

CICS initializes this user area to zeros before invoking the dynamicDPL user exit program for a given DPL request. This user area can bemodified by the user exit program. It is then passed to the finalinvocation of the user exit program for a given DPL request.

UE_Dplusersize (Input parameter only)This is the length of the user area. Initially this will be 128 bytes.

UE_DplinvokingpgmThe name of the program that issued the EXEC CICS LINK command.After the LINK command has been shipped once this field willcontain the name of the mirror program.

UE_DpluseridThe userid executing the EXEC CICS LINK command. If the request isto a remote system and the request is not already part of an existinglogical unit of work to that system, this field can be modified toexecute the request under a different userid. See CICS AdministrationGuide for a full description of this parameter.

Return codes

UE_NormalContinue processing with parameters returned from the user exitprogram.

UE_ProgramNotKnownIndicates that the program name passed to the user exit program isnot valid and the linking program must be abended with an APCTabend. This will be most useful when the user exit program is calledas CICS is about to link to a program which does not have a ProgramDefinition (PD), and the user exit program cannot determine whichprogram or system to link to.

Syncpoint user exit (UE016051)

The syncpoint user exit is invoked following an EXEC CICS SYNCPOINTcommand. The result of the EXEC CICS SYNCPOINT command is madeavailable in this user exit program. It is not possible to alter the outcome ofthe EXEC CICS SYNCPOINT command in this user exit program.

Function prototypecics_UE_return_t UE016051 (

Exit-specific constants

Constants used in declaring the user exit specific structure:#define cics_UE016051_VERSION 1 /* All version numbers start at 1 */

Constants indicating why UE016051 was invoked:

typedef enum UE_SyncType /* Reason for UE invocation */{

UE_USER_SYNCPOINT} cics_UE_SyncType_t;

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 transaction’sTransaction Definition.

typedef enum UE_SyncTRPrompt{

UE_PROMPT_FINISH,UE_NO_PROMPT_FINISH

} cics_UE_SyncTRPrompt_t;

{cics_ushort_t UE_Version;cics_UE_SyncType_t UE_SyncType;cics_UE_SyncResp_t UE_SyncResp;cics_UE_SyncTRPrompt_t UE_SyncTRPrompt;

} cics_UE016051_t;

UE_Version (Input parameter only)is the version number for this structure and takes the value defined incics_UE016051_VERSION. It is advisable to check this in the user exitprogram to ensure that the version number passed when the user exitis called is the same as that contained in the version of cicsue.h usedwhen the program was generated. If a mismatch is detected thencontents of fields are unpredictable and the user exit program shouldbe regenerated using the correct version of cicsue.h.

UE_SyncType (Input parameter only)tells you the reason for this invocation of the syncpoint user exitprogram. The possible values are:

UE_USER_SYNCPOINTInvoked for an EXEC CICS SYNCPOINT command.

UE_SyncResp (Input parameter only)contains the result of the last syncpoint/rollback API command. Thepossible values are:

Syncpoint user exit (51)

UE_COMMITTEDThe last syncpoint was committed.

UE_ROLLEDBACKThe last syncpoint was a Rollback.

UE_ABENDThe last syncpoint failed, so therefore investigate thecircumstances of this failure.

UE_SyncTRPrompt (Input parameter only)contains the Syncpoint attribute from the transaction’s TransactionDefinitions (TD) entry. The possible values are:

UE_PROMPT_FINISHThe syncpoint has been completed on all distributed systems.

UE_NO_PROMPT_FINISHThe syncpoint may not yet have completed on all distributedsystems.

Return codes

UE_NormalContinue processing.

Syncpoint user exit (51)

Chapter 7. The CICS monitoring data formatter offlineutilities

This topic describes functions for reading and processing monitoring andstatistics files.

Monitoring data formatter functions

The object library, prodDir/ lib/ libcicsmfmtsa.a, contains the functionsused by cicsmfmt for reading and processing a Monitoring Data file.

The following functions are provided:

CICS_MFMT_OpenMonitorFileOpens a Monitoring Data file stream.

CICS_MFMT_ReadNextReads the next record from a Monitoring Data file.

CICS_MFMT_FindFieldFinds the detail sub-record for a specified field in a record.

CICS_MFMT_CloseMonitorFileCloses a Monitoring Data stream.

CICS_MFMT_GetMessageGets the message text from the cicsmfmt message catalog.

CICS_MFMT_FreeMessageFrees the memory allocated for a message text obtained fromCICS_MFMT_GetMessage.

CICS_MFMT_ReleaseCatalogueCloses the cicsmfmt message catalog opened by a previousCICS_MFMT_GetMessage call.

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 file, FileName,and reads in the first record. It returns a pointer to identify the MonitoringFile Stream in subsequent operations (see “CICS_MFMT_ReadNext” onpage 427).

If CICS_MFMT_OpenMonitorFile cannot open the file specified or the filedoes not contain monitoring data, it returns NULL and the Status parameter isset to indicate the cause of the failure. If this field is set toCICS_MFMT_STATUS_SYS_ERROR, the environment variable errno containsthe error code returned by the operating system.

Note that variable length records written by CICS to an extrapartitionTransient Data Queue have the record length in the first four bytes. This is inaddition to the record length and signature which start the Monitoring record,as defined by CICS_EMP_MonitoringRecord.

CICS_MFMT_CloseMonitorFile closes the Monitoring Data file streamidentified by Stream and releases any memory buffers associated with thestream.

Return codes

Upon successful completion, CICS_MFMT_OpenMonitorFile returns apointer to a CICS_MFMT_Stream_t object, which is used to access the file viathe CICS_MFMT_ReadNext and CICS_MFMT_FindField functions.

CICS_MFMT_OpenMonitorFile returns a value of NULL if an error isdetected or the file does not contain monitoring data. The Status parameterindicates the cause of the failure to open the file:

CICS_MFMT_STATUS_SYS_ERRORCICS_MFMT_OpenMonitor File detected an error and the globalvariable errno contains the operating system error code.

CICS_MFMT_STATUS_FILE_EOFCICS_MFMT_OpenMonitorFile detected an unexpected EOF.

CICS_MFMT_STATUS_FILE_ERRORCICS_MFMT_OpenMonitorFile detected an invalid Monitoringrecord.

CICS_MFMT_CloseMonitorFile returns 0 if the monitor file is closedsuccessfully, otherwise a value of -1 is returned and the global variable errnocontains the operating system error code.

CICS_MFMT_ReadNext

enum CICS_MFMT_Status CICS_MFMT_ReadNext (CICS_MFMT_Stream_t *Stream);

CICS_MFMT_ReadNext reads the next record from the Monitoring Data filespecified by Stream into the FileBuffer member of the structure.

Return codes

CICS_MFMT_STATUS_OKThe read succeeded.

CICS_MFMT_STATUS_EOFThe end of the file was reached.

CICS_MFMT_STATUS_SYS_ERRORCICS_MFMT_ReadNext detected an error and the global variableerrno contains the operating system error code.

CICS_MFMT_STATUS_FILE_EOFCICS_MFMT_ReadNext detected an unexpected EOF.

CICS_MFMT_STATUS_FILE_ERRORA corrupt Monitoring record was detected.

Chapter 7. The CICS monitoring data formatter offline utilities 427

CICS_MFMT_FindField

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 theMonitoring File Stream (Stream) for the detail sub-record whose ID matchesthat specified by FieldID.

Return codes

Upon successful completion, CICS_MFMT_FindField returns a pointer to theCICS_EMP_TDQ_RecordDetails_t object containing the data for the specifiedfield ID.

A value of NULL is returned if no field matching the specified ID is found inthe record.

CICS_MFMT_GetMessage, CICS_MFMT_FreeMessage, andCICS_MFMT_ReleaseCatalogue

char *CICS_MFMT_GetMessage (int MessageNumber, int SetNumber);void CICS_MFMT_FreeMessage (char *Message);void CICS_MFMT_ReleaseCatalogue (void);

These functions support the message catalog for cicsmfmt.

CICS_MFMT_GetMessageretrieves a message from the cicsmfmt message catalog and returns acopy of the message text in a string allocated by the malloc command.MessageNumber gives the message number and SetNumber givesthe message set number. If the function cannot find one of the InfEVerror messages, a copy of the US English message is returned.

CICS_MFMT_FindField

CICS_MFMT_FreeMessagereleases the space acquired for a message obtained by a previousCICS_MFMT_GetMessage call. The parameter Message gives themessage’s space to release.

CICS_MFMT_ReleaseCataloguecloses any message catalogue opened by a previousCICS_MFMT_GetMessage call.

Note that the buffer allocated by CICS_MFMT_GetMessage for the messagetext should be released via CICS_MFMT_FreeMessage when it is no longerrequired.

Return codes

Upon successful completion, CICS_MFMT_GetMessage returns a pointer tothe malloc’ed space containing the text of the message.

If CICS_MFMT_GetMessage cannot open the message catalogue, cannotallocate space using the malloc command for the message, or cannot find themessage, it returns NULL.

There is no return value from CICS_MFMT_ReleaseCatalogue.

Statistics formatter functions

The object library, prodDir/ lib/ libcicssfmtsa.a (CICS on Open Systems),prodDir/ lib/ libcicssfmtsa.lib (CICS for Windows NT), contains the functionsused by cicssfmt for reading and processing a statistics file.

The following functions are provided:

CICS_SFMT_OpenStatsFileOpens the statistics file and initializes the Record field to zero.

CICS_SFMT_FindRecordFinds the record given a specified field.

CICS_SFMT_CloseStatsFileCloses the statistics file.

CICS_SFMT_ReadRecordReads the next specified record from the Statistics file.

CICS_SFMT_Msg2IntObtains the message number and message set.

CICS_MFMT_GetMessage, FreeMessage, and ReleaseCatalogue

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 file, FileName sets theFileHandle and initializes the Record field of the StatsFileRecord structure tozero if successful, or NULL if the open failed.

CICS_SFMT_CloseStatsFile closes the statistics file, using the FileHandlefrom the StatsFileRecord.

Return codes

CICS_SFMT_STATUS_OKCICS_SFMT_OpenStatsFile opened the statistics file successfully.

CICS_SFMT_FILE_ERRCICS_SFMT_OpenStatsFile detected an error attempting to open thestatistics file. The global variable errno contains the operating systemerror code.

CICS_SFMT_STATUS_OKCICS_SFMT_CloseStatsFile closed the statistics file successfully.

CICS_SFMT_FILE_ERRCICS_SFMT_CloseStatsFile detected an error attempting to close thestatistics file. The global variable errno contains the operating systemerror code.

CICS_SFMT_OpenStatsFile and CICS_SFMT_CloseStatsFile

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 file specified by theFileHandle in the StatsFileRecord structure, to obtain the record that indicatesthe start of statistics collection in the time interval specified by StartTime andEndTime. It uses CICS_SFMT_ReadRecord to read records from the statisticsfile.

Return codes

CICS_SFMT_STATUS_OKCICS_SFMT_FindRecord has located the statistics record successfully.

CICS_SFMT_FILE_ERRCICS_SFMT_FindRecord detected an invalid statistics record.

CICS_SFMT_FILE_SHORT_READCICS_SFMT_FindRecord detected an unexpected EOF.

CICS_SFMT_REC_NOT_FOUNDCICS_SFMT_FindRecord was unable to find the specified record inthe file.

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 filespecified by the FileHandle member of the StatsFileRecord into the Recordmember of the structure.

CICS_SFMT_FindRecord

Return codes

CICS_SFMT_STATUS_OKCICS_SFMT_ReadRecord read the statistics record successfully.

CICS_SFMT_FILE_ERRCICS_SFMT_ReadRecord detected a read error, and the globalvariable errno contains the operating system error code.

CICS_SFMT_FILE_SHORT_READCICS_SFMT_ReadRecord encountered EOF before a complete recordcould be read. This is indicative of an inconsistent statistics file.

CICS_SFMT_FILE_ZERO_READCICS_SFMT_ReadRecord did not read any data, because EOF wasdetected.

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 MsgSetbased on the MsgIndex, for example, the Category or the Description fields ofthe CICS_SFMT_StatsRecord_t structure.

Return codes

CICS_SFMT_ReadRecord

Chapter 8. The statistics records

This chapter describes the collected statistics records. See the CICSAdministration Guide for information about how to collect statistic and toformat a report.

About the statistics records

The tables in this section contain the following information:

Statistic IDThe statistic ID is a unique identifier describing the instance ofstatistical data. It can be used for manipulating the statistic datareturned from the EXEC CICS COLLECT STATISTIC API call, asdescribed in the CICS Application Programming Reference. It may also beused in a statistics formatting program. This is demonstrated in thecicssfmt sample program (see “cicssfmt - Statistics formatter” onpage 221).

C and COBOLThe C and COBOL language names are the unique identifiers used toaccess the statistics information from the respective high levellanguages. In each case the name corresponds to the unique statisticID. Use of the C name is demonstrated in the cicssfmt sampleprogram.

CategoryUsed in general statistics, this detail shows the statistic category. Thecategories are:v Dumpv Filev Intersystem communicationv Journalv Logical unit of work (LUW)v Programv Runtime databasev Storagev Taskv Transient datav Terminalv Transaction

v Temporary storage

MessageThe statistic message is a default message from the main CICSmessage catalog, which a statistics formatter can use to describe thecontents of the statistic. The sample program cicssfmt provides itsown message catalog containing statistic messages, accessed with thestatistic ID, but the default can be used if another catalog cannot befound.

The message is detail is not used for general statistics.

ExplanationExplains what this statistic is used for.

General statistics

Table 10 lists the general statistic categories. Table 11 on page 438 lists thestatistic types.

Table 10. Statistic categories

Statistic ID High-level language names, statistic category, explanation

010000C CICSSTAT_CATID_DUMP

COBOLCS-CATID-DUMP

CategoryDump

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the dump category. See “Dump statistics” on page 441.

020000C CICSSTAT_CATID_FILE

COBOLCS-CATID-FILE

CategoryFile

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the file category. See “File statistics” on page 442.

Table 10. Statistic categories (continued)

030000C CICSSTAT_CATID_ISCM

COBOLCS-CATID-ISCM

CategoryIntersystem communications management

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the intersystem category. See “Intersystem communication(ISC) statistics” on page 445.

040000C CICSSTAT_CATID_JOUR

COBOLCS-CATID-JOUR

CategoryJournal

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the journal category. See “Journal statistics” on page 454.

050000C CICSSTAT_CATID_LUWM

COBOLCS-CATID-LUWM

CategoryLogical units of work

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the logical units of work category. See “Logical unit ofwork (LUW) statistics” on page 457.

060000C CICSSTAT_CATID_PROG

COBOLCS-CATID-PROG

CategoryRuntime program

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the program category. See “Program statistics” on page 458.

Chapter 8. The statistics records 435

070000C CICSSTAT_CATID_RTDB

COBOLCS-CATID-RTDB

CategoryRuntime database

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the runtime database category. See “Runtime databasestatistics” on page 459.

080000C CICSSTAT_CATID_STOR

COBOLCS-CATID-STOR

CategoryRegion storage

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the region and task shared aspect of the storage category.See “Storage statistics” on page 464.

090000C CICSSTAT_CATID_STOT

COBOLCS-CATID-STOT

CategoryTask private storage

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the task private aspect of the storage category. See “Taskstatistics” on page 473.

0A0000C CICSSTAT_CATID_TASK

COBOLCS-CATID-TASK

CategoryTask

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the task category. See “Task statistics” on page 473.

0B0000C CICSSTAT_CATID_TERM

COBOLCS-CATID-TERM

CategoryTerminal

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the terminal category. See “Terminal statistics” on page 476.

0C0000C CICSSTAT_CATID_TDQU

COBOLCS-CATID-TDQU

CategoryTransient data queue

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the transient data queue category. See “Transient datastatistics” on page 480.

0D0000C CICSSTAT_CATID_TRAN

COBOLCS-CATID-TRAN

CategoryTransaction

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the transaction category. See “Transaction statistics” onpage 483.

0E0000C CICSSTAT_CATID_TSQU

COBOLCS-CATID-TSQU

CategoryTemporary storage queue

Explanation: This is used as part of a statistics record to indicate that the recordcontains the statistics for the temporary storage queue category. See “Temporarystorage statistics” on page 485.

Table 11. Statistic types

0F0000C CICSSTAT_CATID_INTERVAL

COBOLCS-CATID-INTERVAL

CategoryInterval statistics collection

Explanation: This is used as part of a statistics record to indicate the start of ainterval statistics collection.

100000C CICSSTAT_CATID_ENDOFDAY

COBOLCS-CATID-ENDOFDAY

CategoryEnd of day statistics collection

Explanation: This is used as part of a statistics record to indicate the start of an endof day statistics collection.

110000C CICSSTAT_CATID_UNSOLICITED

COBOLCS-CATID-UNSOLICITED

CategoryUnsolicited statistics collection

Explanation: This is used as part of a statistics record to indicate the start of anunsolicited statistics collection.

120000C CICSSTAT_CATID_REQUESTED_RESET

COBOLCS-CATID-REQUESTED-RESET

CategoryRequested statistics collection (counters reset)

Explanation: This is used as part of a statistics record to indicate the start of auser-requested statistics collection that resets all of the statistics counters.

Table 11. Statistic types (continued)

130000C CICSSTAT_CATID_REQUESTED

COBOLCS-CATID-REQUESTED

CategoryRequested statistics collection

Explanation: This is used as part of a statistics record to indicate the start of auser-requested statistics collection.

140000C CICSSTAT_CATID_ENDOFREGION

COBOLCS-CATID-ENDOFREGION

CategoryLast end of day statistics collection

Explanation: This is used as part of a statistics record to indicate the start of the endof day statistics collection that is taken at region shutdown.

150000C CICSSTAT_CATID_END

COBOLCS-CATID-END

CategoryEnd of the statistics collection

Explanation: This is used as part of a statistics record to indicate the end of thestatistics collection.

160000C CICSSTAT_CATID_TIME_NA

COBOLCS-CATID-TIME-NA

CategoryTime unavailable

Explanation: This is used as part of a statistics record to indicate that the time wasunavailable when a start or stop label was generated.

170000C CICSSTAT_CATID_TIME_START

COBOLCS-CATID-TIME-START

CategoryTime started:

Explanation: This is used as part of a statistics record to indicate the time that thestatistics collection was started.

180000C CICSSTAT_CATID_TIME_STOP

COBOLCS-CATID-TIME-STOP

CategoryTime stopped:

Explanation: This is used as part of a statistics record to indicate the time that thestatistics was stopped.

190000C CICSSTAT_CATID_SUMMARY

COBOLCS-CATID-SUMMARY

CategorySummary record:

Explanation: This is used as part of a statistics record to indicate that the followingrecords in the statistics collection, are summary statistics.

1A0000C CICSSTAT_CATID_ALL_DETAILS

COBOLCS-CATID-ALL-DETAILS

CategoryAll of the detail records:

Explanation: This is used as part of a statistics record to indicate that the followingrecords in the statistics collection, are detail statistics for individual resources.

1B0000C CICSSTAT_CATID_ONE_DETAIL

COBOLCS-CATID-ONE-DETAIL

CategoryOne detail record:

Explanation: This is used as part of a statistics record to indicate that the followingrecords in the statistics collection, are detail statistics for a specific resource.

Dump statistics

Dump statistics records number of dumps written and number of dumpdirectory write errors.

Table 12. Dump statistics

Statistic ID High-level language names, statistic message, explanation

010000C CICSSTAT_DUMP_DUMPS_WRITTEN

COBOLCS-DUMP-DUMPS-WRITTEN

MessageNumber of dumps written

Explanation: This is used in the statistics record to indicate the number of dumpsthat were written.

010001C CICSSTAT_DUMP_WRITE_ERRORS

COBOLCS-DUMP-WRITE-ERRORS

MessageNumber of dump directory write errors

Explanation: Used in the statistics record to indicate the number of write errors thatoccurred while dumps were being taken.

File statistics

You can use file statistics to monitor input and output activity of applicationrequests against your files. File statistics indicate the number of servicerequests that CICS processes against each file. If CICS totals the number ofrequests on every CICS invocation, you can monitor any changes that occur inthe input and output activity for each file. Because these file statistics mighthave been reset during the day, see the summary report to obtain a figure oftotal activity against a particular file during the day.

The statistics do not tell you directly how many input and output accessesCICS has performed for each transaction. You require a single-transactionmeasurement for this. Nevertheless, by regularly totalling the service requestsagainst individual files, you can anticipate file problems that might occurwhen input and output activity increases.

The statistical information provided by CICS for files lists the number ofservice requests processed against each file defined in the File Definitions(FD). The information is dependent on the types of request allowed on thefile.

Table 13. File statistics

020000C CICSSTAT_FILE_NOREADS

COBOLCS-FILE-NOREADS

MessageNumber of file control reads

Explanation: This is used in the statistic record label to indicate the number of readsperformed by file control.

020001C CICSSTAT_FILE_NOWRITES

COBOLCS-FILE-NOWRITES

MessageNumber of file control writes

Explanation: This is used in the statistic record label to indicate the number of writesperformed by file control.

Table 13. File statistics (continued)

020002C CICSSTAT_FILE_NOBROWSES

COBOLCS-FILE-NOBROWSES

MessageNumber of file control browses

Explanation: This is used in the statistic record label to indicate the number ofbrowse operations performed by file control. It includes the number of READNEXTand READPREV requests only. It does not include the number of STARTBR, ENDBR,or RESETBR requests.

020003C CICSSTAT_FILE_NODELETES

COBOLCS-FILE-NODELETES

MessageNumber of file control deletes

Explanation: This is used in the statistic record label to indicate the number ofdeletes performed by file control.

020004C CICSSTAT_FILE_NOUPDATES

COBOLCS-FILE-NOUPDATES

MessageNumber of file control updates

Explanation: This is used in the statistic record label to indicate the number ofupdates performed by file control.

020005C CICSSTAT_FILE_NOOPENS

COBOLCS-FILE-NOOPENS

MessageNumber of file control opens

Explanation: This is used in the statistic record label to indicate the number of opensperformed by file control.

020006C CICSSTAT_FILE_NOCLOSES

COBOLCS-FILE-NOCLOSES

MessageNumber of file control closes

Explanation: This is used in the statistic record label to indicate the number of closesperformed by file control.

020007C CICSSTAT_FILE_NOREADS_TOTAL

COBOLCS-FILE-NOREADS-TOTAL

MessageTotal number of file control reads

Explanation: This is used in the statistic record label to indicate the number of readsperformed by file control.

020008C CICSSTAT_FILE_NOWRITES_TOTAL

COBOLCS-FILE-NOWRITES-TOTAL

MessageTotal number of file control writes

Explanation: This is used in the statistic record label to indicate the total number ofwrites performed by file control.

020009C CICSSTAT_FILE_NOBROWSES_TOTAL

COBOLCS-FILE-NOBROWSES-TOTAL

MessageTotal number of file control browses

Explanation: This is used in the statistic record label to indicate the total number ofbrowses performed by file control.

02000AC CICSSTAT_FILE_NODELETES_TOTAL

COBOLCS-FILE-NODELETES-TOTAL

MessageTotal number of file control deletes

Explanation: This is used in the statistic record label to indicate the total number ofdeletes performed by file control.

02000BC CICSSTAT_FILE_NOUPDATES_TOTAL

COBOLCS-FILE-NOUPDATES-TOTAL

MessageTotal number of file control updates

Explanation: This is used in the statistic record label to indicate the total number ofupdates performed by file control.

02000CC CICSSTAT_FILE_NOOPENS_TOTAL

COBOLCS-FILE-NOOPENS-TOTAL

MessageTotal number of file control opens

Explanation: This is used in the statistic record label to indicate the total number ofopens performed by file control.

02000DC CICSSTAT_FILE_NOCLOSES_TOTAL

COBOLCS-FILE-NOCLOSES-TOTAL

MessageTotal number of file control closes

Explanation: This is used in the statistic record label to indicate the total number ofcloses performed by file control.

Intersystem communication (ISC) statistics

Intersystem communication (ISC) statistics record both intersystem andintersession communication statistics. CICS provides statistics for each systementry defined in the Communications Definitions (CD).

Table 14. ISC statistics

030000C CICSSTAT_ISCM_MAXNUMLQSR

COBOLCS-ISCM-MAXNUMLQSR

MessageMaximum number of locally queued outbound function shipping requests

Explanation: This is used in the statistic record to indicate the maximum number offunction shipping requests that were locally queued.

030001C CICSSTAT_ISCM_NUMLQSR

COBOLCS-ISCM-NUMLQSR

MessageNumber of locally queued outbound function shipping requests

Explanation: This is used in the statistic record to indicate the number of functionshipping requests that are currently queued.

030002C CICSSTAT_ISCM_NUMXMITLQSR

COBOLCS-ISCM-NUMXMITLQSR

MessageNumber of locally queued outbound function shipping requests transmitted

Explanation: This is used in the statistic record to indicate the number of functionshipping requests that have been sent to the remote systems.

030003C CICSSTAT_ISCM_PURGEDLQSR

COBOLCS-ISCM-PURGEDLQSR

MessageNumber of locally queued outbound function shipping requests purged

Explanation: This is used in the statistic record to indicate the number of locallyqueued function shipping requests that have been purged from the queue.

Table 14. ISC statistics (continued)

030004C CICSSTAT_ISCM_NUMATTEMPTS

COBOLCS-ISCM-NUMATTEMPTS

MessageNumber of attempts to function ship a locally queued request to remotesystem

Explanation: This is used in the statistic record to indicate the number of times alocally queued function ship request has been made to the remote system.

03000BC CICSSTAT_ISCM_NUMALLOC

COBOLCS-ISCM-NUMALLOC

MessageNumber of Distributed Transaction Processing (DTP) conversations allocated

Explanation: This is used in the statistic record, to indicate the number ofDistributed Transaction Processing (DTP) conversations that have been allocated.

03000CC CICSSTAT_ISCM_NUMICES

COBOLCS-ISCM-NUMICES

MessageNumber of Interval Control Elements in the chain

Explanation: This is a statistic value which gives the current number of IntervalControl Elements in the internal chain.

03000DC CICSSTAT_ISCM_NUMENQRES

COBOLCS-ISCM-NUMENQRES

MessageNumber of resources enqueued to date

Explanation: This is a statistic value which gives the number total number of distinctresources that have been enqueued with EXEC CICS ENQ to date.

03000EC CICSSTAT_ISCM_MAXICES

COBOLCS-ISCM-MAXICES

MessageMaximum number of Interval Control Elements in the chain

Explanation: This is a statistic value which gives the maximum number of IntervalControl Elements which have existed in the chain to date.

03000FC CICSSTAT_ISCM_ENQWAIT

COBOLCS-ISCM-ENQWAIT

MessageNumber of ENQ requests that waited for a resource

Explanation: This is a statistic value which gives the number of EXEC CICS ENQrequests that waited until the specified resource was available.

030010C CICSSTAT_ISCM_LOCKWAIT

COBOLCS-ISCM-LOCKWAIT

MessageNumber of LOCK requests that waited for a resource

Explanation: This is a statistic value which gives the number of internal lockrequests that waited until the specified resource was available.

030011C CICSSTAT_ISCM_NFCIN

COBOLCS-ISCM-NFCIN

MessageNumber of inbound function shipping File Control (FC) requests

Explanation: This is used in the statistic record to indicate the number of FileControl (FC) function shipping requests that were received from remote systems.

030012C CICSSTAT_ISCM_NFCOUT

COBOLCS-ISCM-NFCOUT

MessageNumber of outbound function shipping File Control (FC) requests

Explanation: This is used in the statistic record to indicate the number of FileControl (FC) function shipping requests that were sent to remote systems.

030013C CICSSTAT_ISCM_NFCXFR

COBOLCS-ISCM-NFCXFR

MessageNumber of forwarded function shipping File Control (FC) requests

Explanation: This is used in the statistic record to indicate the number of FileControl (FC) function shipping requests that were received from remote systems andforwarded on to others for processing.

030014C CICSSTAT_ISCM_NTDIN

COBOLCS-ISCM-NTDIN

MessageNumber of inbound function shipping Transient Data (TD) queue requests

Explanation: This is used in the statistic record to indicate the number of TransientData (TD) queue function shipping requests that were received from remote systems.

030015C CICSSTAT_ISCM_NTDOUT

COBOLCS-ISCM-NTDOUT

MessageNumber of outbound function shipping Transient Data (TD) queue requests

Explanation: This is used in the statistic record to indicate the number of TransientData (TD) queue function shipping requests that were sent to remote systems.

030016C CICSSTAT_ISCM_NTDXFR

COBOLCS-ISCM-NTDXFR

MessageNumber of forwarded function shipping Transient Data (TD) queue requests

Explanation: This is used in the statistic record to indicate the number of TransientData (TD) queue function shipping requests that were received from remote systemsand forwarded on to others for processing.

030017C CICSSTAT_ISCM_NTSIN

COBOLCS-ISCM-NTSIN

MessageNumber of inbound function shipping Temporary Storage (TS) queuerequests

Explanation: This is used in the statistic record to indicate the number of TemporaryStorage (TS) queue function shipping requests that were received from remotesystems.

030018C CICSSTAT_ISCM_NTSOUT

COBOLCS-ISCM-NTSOUT

MessageNumber of outbound function shipping Temporary Storage (TS) queuerequests

Explanation: This is used in the statistic record to indicate the number of TemporaryStorage (TS) queue function shipping requests that were sent to remote systems.

030019C CICSSTAT_ISCM_NTSXFR

COBOLCS-ISCM-NTSXFR

MessageNumber of forwarded function shipping Temporary Storage (TS) queuerequests

Explanation: This is used in the statistic record to indicate the number of TemporaryStorage (TS) queue function shipping requests that were received from remotesystems and forwarded on to others for processing.

03001AC CICSSTAT_ISCM_NATIIN

COBOLCS-ISCM-NATIIN

MessageNumber of inbound function shipping Interval Control (IC) requests

Explanation: This is used in the statistic record to indicate the number of IntervalControl (IC) function shipping requests that were received from remote systems.

03001BC CICSSTAT_ISCM_NATIOUT

COBOLCS-ISCM-NATIOUT

MessageNumber of outbound function shipping Interval Control (IC) requests

Explanation: This is used in the statistic record to indicate the number of IntervalControl (IC) function shipping requests that were sent to remote systems.

03001CC CICSSTAT_ISCM_NATIXFR

COBOLCS-ISCM-NATIXFR

MessageNumber of forwarded function shipping Interval Control (IC) requests

Explanation: This is used in the statistic record to indicate the number of IntervalControl (IC) function shipping requests that were received from remote systems andforwarded on to others for processing.

03001DC CICSSTAT_ISCM_NDPLIN

COBOLCS-ISCM-NDPLIN

MessageNumber of inbound function shipping Distributed Program Link (DPL)requests

Explanation: This is used in the statistic record to indicate the number of DistributedProgram Link (DPL) function shipping requests that were received from remotesystems.

03001EC CICSSTAT_ISCM_NDPLOUT

COBOLCS-ISCM-NDPLOUT

MessageNumber of outbound function shipping Distributed Program Link (DPL)requests

Explanation: This is used in the statistic record to indicate the number of DistributedProgram Link (DPL) function shipping requests that were sent to remote systems.

03001FC CICSSTAT_ISCM_NDPLXFR

COBOLCS-ISCM-NDPLXFR

MessageNumber of forwarded function shipping Distributed Program Link (DPL)requests

Explanation: This is used in the statistic record to indicate the number of DistributedProgram Link (DPL) function shipping requests that were received from remotesystems and forwarded on to others for processing.

030020C CICSSTAT_ISCM_NDL1IN

COBOLCS-ISCM-NDL1IN

MessageNumber of inbound function shipping DL/1 requests

Explanation: This is used in the statistic record to indicate the number of DL/1function shipping requests that were received from remote systems and then rejectedbecause DL/1 is not supported by CICS.

030021C CICSSTAT_ISCM_OUTTRREQ

COBOLCS-ISCM-OUTTRREQ

MessageNumber of outbound transaction routing requests that were sent

Explanation: This is used in the statistic record, to indicate the number ofTransaction Routing requests that were sent to the application owning region (AOR).

030022C CICSSTAT_ISCM_INTRREQ

COBOLCS-ISCM-INTRREQ

MessageNumber of inbound transaction routing requests that were received

Explanation: This is used in the statistic record, to indicate the number ofTransaction Routing requests that were received from the Terminal Owning Region(TOR).

030023C CICSSTAT_ISCM_BPSDEFSENT

COBOLCS-ISCM-BPSDEFSENT

MessageNumber of terminal definitions that were sent

Explanation: This is used in the statistic record, to indicate the number of terminaldefinitions that were sent to the application owning region (AOR).

030024C CICSSTAT_ISCM_BPSDEFRECEIVED

COBOLCS-ISCM-BPSDEFRECEIVED

MessageNumber of terminal definitions that were received

Explanation: This is used in the statistic record, to indicate the number of terminaldefinitions that were received from the Terminal Owning Region (TOR).

030025C CICSSTAT_ISCM_FORWARD

COBOLCS-ISCM-FORWARD

MessageNumber of transaction routing requests that were forwarded

Explanation: This is used in the statistic record, to indicate the number of transactionrouting requests that have been forwarded to another, remote application owningregion (AOR).

Journal statistics

CICS produces statistical information for every journal defined to a CICSregion.

Table 15. Journal statistics

040000C CICSSTAT_JOUR_CALLBACK_COUNT

COBOLCS-JOUR-CALLBACK-COUNT

MessageNumber of requests to perform system log archive management

Explanation: This is used in the statistic record to indicate the number of times theLog Service has called CICS with an archive management request during the selectedperiod.

040001C CICSSTAT_JOUR_NOSPACE_TOTAL

COBOLCS-JOUR-NOSPACE-TOTAL

MessageNumber of journal NOSPACE conditions

Explanation: This is used in the statistic record to indicate the total number ofjournal NOSPACE conditions arising during the selected period. These conditionsarise when CICS is unable to write to a user journal because there is insufficientspace available in the relevant file system.

040002C CICSSTAT_JOUR_NOSPACE_ITERATIONS_TOTAL

COBOLCS-JOUR-NOSPACE-ITERATIONS-TTL

MessageNumber of journal write retries attempted

Explanation: This is used in the statistic record to indicate the number ofunsuccessful attempts to write a record to a user journal due to NOSPACEconditions during the selected period. When a journal write fails because of aNOSPACE condition, the write is retried at intervals until space becomes available.

Table 15. Journal statistics (continued)

040003C CICSSTAT_JOUR_CHECKPOINT_COUNT

COBOLCS-JOUR-CHECKPOINT-COUNT

MessageNumber of CICS checkpoints written to the system log

Explanation: This is used in the statistic record to indicate the number of CICScheckpoint operations (called activity keypoints in CICS/MVS terminology)performed during the selected period.

040004C CICSSTAT_JOUR_SYS_JRNL_PUTS_COUNT

COBOLCS-JOUR-SYS-JRNL-PUTS-COUNT

MessageNumber of records written to the system log

Explanation: This is used in the statistic record to indicate the number of recordswritten to the system log during the specified period.

040005C CICSSTAT_JOUR_BUFFERED_WRITES_TOTAL

COBOLCS-JOUR-BUFFERED-WRITES-TOTAL

MessageNumber of buffered write requests to user journals

Explanation: This is used in the statistic record to indicate the total number ofrecords written in buffered mode (written by EXEC CICS JOURNAL commandswithout the WAIT option) to user journals during the specified period.

040006C CICSSTAT_JOUR_FLUSHED_WRITES_TOTAL

COBOLCS-JOUR-FLUSHED-WRITES-TOTAL

MessageNumber of flushed write requests to user journals

Explanation: This is used in the statistic record to indicate the total number ofrecords written and flushed to user journals during the specified period. This figureis the sum of the number of records written by EXEC CICS JOURNAL commandsspecifying the WAIT option and the number of EXEC CICS WAIT JOURNALcommands which forced at least one buffered record to a journal.

040007C CICSSTAT_JOUR_IOERRORS_TOTAL

COBOLCS-JOUR-IOERRORS-TOTAL

MessageNumber of journal IOERR conditions

Explanation: This is used in the statistic record to indicate the total number of userjournal requests which were unsuccessful due to IOERR conditions during thespecified period.

040008C CICSSTAT_JOUR_NOTAUTH_ATTEMPTS_TOTAL

COBOLCS-JOUR-NOTAUTH-ATTEMPTS-TOTAL

MessageNumber of unauthorized access attempts on journals

Explanation: This is used in the statistic record to indicate the total number of userjournal requests which were unsuccessful due to NOTAUTH conditions during thespecified period.

040009C CICSSTAT_JOUR_BUFFERED_WRITES

COBOLCS-JOUR-BUFFERED-WRITES

MessageNumber of buffered write requests to user journals

Explanation: This is used in the statistic record to indicate the total number ofrecords written in buffered mode (written by EXEC CICS JOURNAL commandswithout the WAIT option) to user journals during the specified period.

04000AC CICSSTAT_JOUR_FLUSHED_WRITES

COBOLCS-JOUR-FLUSHED-WRITES

MessageNumber of flushed write requests to user journals

Explanation: This is used in the statistic record to indicate the total number ofrecords written and flushed to user journals during the specified period. This figureis a summation of the number of records written by EXEC CICS JOURNALcommands specifying the WAIT option and the number of EXEC CICS WAITJOURNAL commands which forced at least one buffered record to a journal.

04000BC CICSSTAT_JOUR_IOERRORS

COBOLCS-JOUR-IOERRORS

MessageNumber of journal IOERR conditions

Explanation: This is used in the statistic record to indicate the total number of userjournal requests which were unsuccessful due to IOERR conditions during thespecified period.

04000CC CICSSTAT_JOUR_NOTAUTH_ACCESSES

COBOLCS-JOUR-NOTAUTH-ACCESSES

MessageNumber of unauthorized access attempts

Explanation: This is used in the statistic record to indicate the number of requestsfor a particular user journal which were unsuccessful due to NOTAUTH conditionsduring the specified period.

04000DC CICSSTAT_JOUR_NOSPACE_CONDITIONS

COBOLCS-JOUR-NOSPACE-CONDITIONS

MessageNumber of NOSPACE conditions

Explanation: This is used in the statistic record to indicate the number ofunsuccessful attempts to write a record to a particular user journal, due toNOSPACE conditions during the selected period.

Logical unit of work (LUW) statistics

CICS produces accumulated statistical information relating to all LUWs.

Table 16. Logical unit of work statistics

050001C CICSSTAT_LUWM_NUM_ABORTED

COBOLCS-LUWM-NUM-ABORTED

MessageNumber of Logical Units of Work which aborted

Explanation: This is used in the statistic record, to indicate the number of LogicalUnits of Work which aborted during the selected period.

050003C CICSSTAT_LUWM_NUM_HITS

COBOLCS-LUWM-NUM-HITS

MessageNumber of hashing algorithm hits

Explanation: This is used in the statistic record to indicate the number of times thata hash table entry has been used to find a transaction identifier during the selectedperiod.

050004C CICSSTAT_LUWM_MAX_CHAIN_LENGTH

COBOLCS-LUWM-MAX-CHAIN-LENGTH

MessageMaximum hash table chain length

Explanation: This is used in the statistic record, to indicate the maximum number ofactive transaction identifiers which have mapped to the same hash value during theselected period. After a hash table lookup, the chain of matching transactionidentifiers is searched by CICS using a linear search algorithm. This statistictherefore indicates how many lookups may be needed (worst case) to find therequired transaction identifier in the table.

Program statistics

CICS produces statistical information for all programs defined in the ProgramDefinitions (PD).

You can use these statistics to assist in tuning the system and for accountingpurposes. You can also use them to calculate the average interval betweenuses of a program by dividing the statistics interval time by the number oftimes a program is used.

Table 17. Program statistics

060000C CICSSTAT_PROG_TOTAL_PROGS_RUN

COBOLCS-PROG-TOTAL-PROGS-RUN

MessageTotal number of programs run

Explanation: This is used in the statistic record to indicate the total number ofprograms run in the region so far.

060001C CICSSTAT_PROG_NUM_TIMES_USED

COBOLCS-PROG-NUM-TIMES-USED

MessageNumber of times program run

Explanation: This is used in the statistic record to indicate the number of times aparticular program has been run in the region.

Runtime database statistics

CICS gathers statistics on the usage of the runtime database and the collisioncharacteristics of the supporting hash table. The structure of each statistic isheld in the individual hash table entry.

CICS accumulates statistics from the hash entries for both a single class or allclasses, and collects incremental statistics to count the calls to severalfunctions within the CICS database class module.

Table 18. Runtime database statistics

070000C CICSSTAT_RTDB_ADD

COBOLCS-RTDB-ADD

MessageNumber of requests to add a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to add an entry into the runtime database class.

Table 18. Runtime database statistics (continued)

070001C CICSSTAT_RTDB_GET

COBOLCS-RTDB-GET

MessageNumber of requests to read a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to read an entry from the runtime database class.

070002C CICSSTAT_RTDB_GETP

COBOLCS-RTDB-GETP

MessageNumber of requests to obtain a pointer to a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to obtain a pointer to an entry from the runtime database class.

070003C CICSSTAT_RTDB_DELTA

COBOLCS-RTDB-DELTA

MessageNumber of requests to amend a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to amend an entry in the runtime database class.

070004C CICSSTAT_RTDB_DELETE

COBOLCS-RTDB-DELETE

MessageNumber of requests to delete a runtime database entry.

Explanation: This is used in the statistic record, to indicate the number of deleterequests.

070005C CICSSTAT_RTDB_BROWSE

COBOLCS-RTDB-BROWSE

MessageNumber of requests to browse the runtime database class

Explanation: This is used in the statistic record, to indicate the total number ofrequests to browse the runtime database class.

070006C CICSSTAT_RTDB_NEXT

COBOLCS-RTDB-NEXT

MessageNumber of requests to read next in a runtime database class

Explanation: This is used in the statistic record, to indicate the total number ofrequests to read the next entry in the runtime database class.

070007C CICSSTAT_RTDB_CHAIN

COBOLCS-RTDB-CHAIN

MessageLength of chain of database records

Explanation: This is not used in the statistic record, but is reserved by CICS forinternal use.

070008C CICSSTAT_RTDB_CHAINHI

COBOLCS-RTDB-CHAINHI

MessageHigh water mark length of chain of database records

Explanation: This is not used in the statistic record, but is reserved by CICS forinternal use.

070009C CICSSTAT_RTDB_DELTAUSE

COBOLCS-RTDB-DELTAUSE

MessageNumber of requests to delta and use a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to delta an entry in the runtime database class, while retaining use of it.

07000AC CICSSTAT_RTDB_USE

COBOLCS-RTDB-USE

MessageNumber of requests to use a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to use an entry in the runtime database class.

07000BC CICSSTAT_RTDB_ENDUSE

COBOLCS-RTDB-ENDUSE

MessageNumber of requests to end use of a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to end use of an entry in the runtime database class.

07000CC CICSSTAT_RTDB_EXCLUSIVE

COBOLCS-RTDB-EXCLUSIVE

MessageNumber of exclusive requests for a runtime database entry

Explanation: This is used in the statistic record, to indicate the total number ofrequests to obtain exclusive access to an entry in the runtime database class.

07000DC CICSSTAT_RTDB_RECORDS

COBOLCS-RTDB-RECORDS

MessageNumber of entries in database class

Explanation: This is used in the statistic record, to indicate the total number ofentries in the runtime database class for this region.

07000EC CICSSTAT_RTDB_COLLISIONS

COBOLCS-RTDB-COLLISIONS

MessageNumber of collisions in database class’s hash chains

Explanation: This is used in the statistic record, to indicate the current total numberof hash chain collisions in the runtime database class.

07000FC CICSSTAT_RTDB_CHAINMAX

COBOLCS-RTDB-CHAINMAX

MessageMaximum number of entries in a hash chain

Explanation: This is used in the statistic record, to indicate the number of entries inthe currently longest hash chain for the runtime database class.

070010C CICSSTAT_RTDB_CHAINHIMAX

COBOLCS-RTDB-CHAINHIMAX

MessageMaximum of highest historical hash chain length

Explanation: This is used in the statistic record, to indicate the number of entries inthe longest hash chain that has occurred for the runtime database class.

Storage statistics

CICS provides statistical information relating to three distinct storage areas:v Region poolv Task-shared poolv Task-private pool

Task-private pool statistics are also included in the CICS Administration Guide.

Table 19. Region pool statistics

080000C CICSSTAT_STOR_RPOOL_SIZE

COBOLCS-STOR-RPOOL-SIZE

MessageThe region pool size (in bytes)

Explanation: This statistic records the configured size of the region storage pool astaken from the Region Definition or start up parameters for the region.

080001C CICSSTAT_STOR_RPOOL_THRESH

COBOLCS-STOR-RPOOL-THRESH

MessageThe region pool storage stress threshold

Explanation: This statistic records the percentage of the region pool which must beallocated from the region pool before it is considered to be under stress. The storagestress threshold is set as a warning marker to highlight that some transactions andCICS processes may start to abnormally terminate because there is not enoughregion pool storage to satisfy requests for control blocks.

080002C CICSSTAT_STOR_RBYTES_USED

COBOLCS-STOR-RBYTES-USED

MessageThe number of bytes allocated from region pool

Explanation: This statistic records the number of bytes currently allocated from theregion pool during the selected period. This value reflects activity in the region poolsince the last statistics collection run.

Table 19. Region pool statistics (continued)

080003C CICSSTAT_STOR_RALLOCS_SUCCEEDED

COBOLCS-STOR-RALLOCS-SUCCEEDED

MessageThe number of successful region pool storage allocations

Explanation: This statistic indicates the number of successful allocations of regionpool storage which have occurred during the selected period.

080004C CICSSTAT_STOR_RALLOCS_FAILED

COBOLCS-STOR-RALLOCS-FAILED

MessageThe number of unsuccessful region pool storage allocations

Explanation: This statistic indicates the number of failed allocations of region poolstorage which have occurred during the selected period. A nonzero number in thisfield indicates that CICS is using up too much region-pool storage and that theregion pool size is configured with a size that cannot sustain the activity in theregion.

080005C CICSSTAT_STOR_RFREES_SUCCEEDED

COBOLCS-STOR-RFREES-SUCCEEDED

MessageThe number of successful region pool storage deallocations

Explanation: This statistic indicates the number of successful deallocations of regionpool storage which have occurred during the selected period.

080006C CICSSTAT_STOR_RFREES_FAILED

COBOLCS-STOR-RFREES-FAILED

MessageThe number of unsuccessful region pool storage deallocations

Explanation: This statistic indicates the number of failed deallocations of region poolstorage which have occurred during the selected period. A nonzero number in thisfield indicates that there are problems within the CICS software. This should bereflected by messages on console.nnnnnn

Table 19. Region pool statistics (continued)

080007C CICSSTAT_STOR_RSOS_OCCURRENCE

COBOLCS-STOR-RSOS-OCCURRENCE

MessageThe number of times the region pool became short of storage

Explanation: This statistic indicates how many times the region pool storage stressthreshold was breached. If this number is not zero, it indicates either that thethreshold is set too low or that the region pool size may be under-configured for theamount of region pool storage activity in the region.

080008C CICSSTAT_STOR_RHASH_MAXLEN

COBOLCS-STOR-RHASH-MAXLEN

MessageLargest address hash bucket in region pool is: NOT USED

Explanation: Not used for Region Pool. (place holder)

Table 20. Task-shared pool statistics

080009C CICSSTAT_STOR_TPOOL_SIZE

COBOLCS-STOR-TPOOL-SIZE

MessageThe task-shared pool size (in bytes)

Explanation: This statistic records the configured size of the task-shared storage poolas taken from the Region Definition or start up parameters for the region.

Table 20. Task-shared pool statistics (continued)

08000AC CICSSTAT_STOR_TPOOL_THRESH

COBOLCS-STOR-TPOOL-THRESH

MessageThe task-shared pool storage stress threshold

Explanation: This statistic records the percentage of the task-shared pool which mustbe allocated from the task-shared pool before it is considered to be under stress. Thestorage stress threshold is set as a warning marker to highlight that sometransactions and CICS processes may start to abnormally terminate because there isnot enough task-shared pool storage to satisfy requests for GETMAIN SHARED,BMS map or application table storage.

08000BC CICSSTAT_STOR_TBYTES_USED

COBOLCS-STOR-TBYTES-USED

MessageThe number of bytes allocated from task-shared pool

Explanation: This statistic records the number of bytes currently allocated from thetask-shared pool during the selected period. This value reflects activity in thetask-shared pool since the last statistics collection run.

08000CC CICSSTAT_STOR_TALLOCS_SUCCEEDED

COBOLCS-STOR-TALLOCS-SUCCEEDED

MessageThe number of successful task-shared pool storage allocations

Explanation: This statistic indicates the number of successful allocations oftask-shared pool storage which have occurred during the selected period.

08000DC CICSSTAT_STOR_TALLOCS_FAILED

COBOLCS-STOR-TALLOCS-FAILED

MessageThe number of unsuccessful task-shared pool storage allocations

Explanation: This statistic indicates the number of failed allocations of task-sharedpool storage which have occurred during the selected period. A nonzero number inthis field indicates that transactions are using up too much task-shared pool storageand that the task-shared pool size is configured with a size that cannot sustain theactivity in the region.

08000EC CICSSTAT_STOR_TFREES_SUCCEEDED

COBOLCS-STOR-TFREES-SUCCEEDED

MessageThe number of successful task-shared pool storage deallocations

Explanation: This statistic indicates the number of successful deallocations oftask-shared pool storage which have occurred during the selected period.

08000FC CICSSTAT_STOR_TFREES_FAILED

COBOLCS-STOR-TFREES-FAILED

MessageThe number of unsuccessful task-shared pool storage deallocations

Explanation: This statistic indicates the number of failed deallocations of task-sharedpool storage which have occurred during the selected period. A nonzero number inthis field indicates that there are problems within transactions or the CICS software.This should be reflected by messages on console.nnnnnn.

080010C CICSSTAT_STOR_TSOS_OCCURRENCE

COBOLCS-STOR-TSOS-OCCURRENCE

MessageThe number of times the task-shared pool became short of storage

Explanation: This statistic indicates how many times the task-shared pool storagestress threshold was breached. If this number is nonzero it indicates either that thethreshold is set too low or that the task-shared pool size may be under-configuredfor the amount of task-shared pool storage activity in the region.

080011C CICSSTAT_STOR_THASH_MAXLEN

COBOLCS-STOR-THASH-MAXLEN

MessageThe number of elements in the longest task-shared pool address hashbucket

Explanation: Access to task-shared pool allocations is by a hash table. This statisticindicates how many elements were in the longest address hash bucket within thehash table. A high number in this statistic indicates that the hash table is too smallfor the level of activity in the task-shared pool and that a number of task-sharedpool allocations are being accessed with one or more hash buckets. The size of thehash table should be increased if the number is greater than 5. See also thedescriptions of the LoadDataNumBlocks and TaskSHNumBlocks attributes in CICSAdministration Reference.

080012C CICSSTAT_STOR_RHASH_BUCKET

COBOLCS-STOR-RHASH-BUCKET

MessageWorst Hash Bucket currently recorded in Region Pool is: NOT USED

Explanation: Not used for Region Pool. (place holder)

080013C CICSSTAT_STOR_THASH_BUCKET

COBOLCS-STOR-THASH-BUCKET

MessageLongest task-shared pool address hash bucket

Explanation: This statistic identifies the hash-bucket number of the hash bucketwhich has the largest number of elements.

080014C CICSSTAT_STOR_RBYTES_HIGHWATER

COBOLCS-STOR-RBYTES-HIGHWATER

MessageThe highest number of bytes which have been allocated from region pool

Explanation: This statistic records the largest number of bytes allocated from theregion pool since the start of the region. The highwater mark allocation can be takenas a peak measure of region pool allocation activity.

080015C CICSSTAT_STOR_TBYTES_HIGHWATER

COBOLCS-STOR-TBYTES-HIGHWATER

MessageThe highest number of bytes which have been allocated from task-sharedpool

Explanation: This statistic records the largest number of bytes allocated from thetask-shared pool during the selected period. The highwater mark allocation can betaken as a peak measure of task-shared pool activity.

080016C CICSSTAT_STOR_RBYTES_ALLOCSTART

COBOLCS-STOR-RBYTES-ALLOCSTART

MessageThe total number of bytes currently allocated from region pool

Explanation: This statistic records the number of bytes currently allocated from theregion pool as recorded from the start of the region. This value reflects the overallactivity in the region pool since the region began operation.

080017C CICSSTAT_STOR_TBYTES_ALLOCSTART

COBOLCS-STOR-TBYTES-ALLOCSTART

MessageThe total number of bytes currently allocated from task-shared pool

Explanation: This statistic records the number of bytes currently allocated from thetask-shared pool as recorded from the start of the region. This value reflects theoverall activity in the task-shared pool since the region began operation.

080018C CICSSTAT_STOR_RBYTES_FREED

COBOLCS-STOR-RBYTES-FREED

MessageThe number of bytes released back into the region pool

Explanation: This statistic records the number of bytes currently deallocated backinto the region pool during the selected period. This value reflects activity in theregion pool since the last statistics collection run.

080019C CICSSTAT_STOR_TBYTES_FREED

COBOLCS-STOR-TBYTES-FREED

MessageThe number of bytes released back into the task-shared pool

Explanation: This statistic records the number of bytes currently deallocated backinto the task-shared pool during the selected period. This value reflects activity inthe task-shared pool since the last statistics collection run.

Table 21. Task-private pool statistics

090000C CICSSTAT_STOT_ALLOCS_SUCCEEDED

COBOLCS-STOT-ALLOCS-SUCCEEDED

MessageThe number of successful task-private storage allocations

Explanation: This statistic indicates the number of successful allocations oftask-private storage which have occurred during the selected period.

090001C CICSSTAT_STOT_DEALLOCS_SUCCEEDED

COBOLCS-STOT-DEALLOCS-SUCCEEDED

MessageThe number of successful task-private storage deallocations

Explanation: This statistic indicates the number of successful deallocations oftask-private storage which have occurred during the selected period.

090002C CICSSTAT_STOT_ALLOCS_FAILED

COBOLCS-STOT-ALLOCS-FAILED

MessageThe number of unsuccessful task-private storage allocations

Explanation: This statistic indicates the number of failed allocations of task-privatestorage which have occurred during the selected period. A nonzero number in thisfield indicates that some transactions are using up too much task-private storage.

Table 21. Task-private pool statistics (continued)

090003C CICSSTAT_STOT_DEALLOCS_FAILED

COBOLCS-STOT-DEALLOCS-FAILED

MessageThe number of unsuccessful task-private storage deallocations

Explanation: This statistic indicates the number of failed deallocations of task-privatestorage which have occurred during the selected period. A nonzero number in thisfield indicates that some transactions are raising error and abend conditions whilefreeing task-private storage.

090004C CICSSTAT_STOT_ABEND_OCCURRENCE

COBOLCS-STOT-ABEND-OCCURRENCE

MessageThe number of task-private storage abends

Explanation: This statistic indicates how many task-private storage abend conditionshave been raised during the selected period. A nonzero number in this field indicatesthat some transactions are causing storage errors. The storage statistics fortransactions show how many task-private storage abends have been raised againstparticular transactions.

090005C CICSSTAT_STOT_NUMBER_OF_TASKS

COBOLCS-STOT-NUMBER-OF-TASKS

MessageThe number of tasks using task-private storage

Explanation: This statistic indicates how many CICS tasks were using task-privatestorage during the selected period.

090006C CICSSTAT_STOT_TRANS_ABENDS

COBOLCS-STOT-TRANS-ABENDS

MessageThe number of task-private storage abends for transaction

Explanation: This statistic is gathered for each CICS transaction. It records howmany task private storage abends have been raised against a transaction.

Task statistics

CICS produces accumulated statistical information relating to all tasks.

Table 22. Task statistics

0A0000C CICSSTAT_TASK_NUM_TRANS

COBOLCS-TASK-NUM-TRANS

MessageTotal number of transactions started

Explanation: This is used in the statistic record, to indicate the total number oftransactions run in the region during the selected period.

0A0001C CICSSTAT_TASK_NUM_TRANS_ABENDED

COBOLCS-TASK-NUM-TRANS-ABENDED

MessageTotal number of transactions which abnormally terminated

Explanation: This is used in the statistic record, to indicate the total number oftransactions abnormally terminated in the region during the selected period.

0A0002C CICSSTAT_TASK_NUM_INVALID_ADDRESS

COBOLCS-TASK-NUM-INVALID-ADDRESS

MessageTotal number of exceptions raised due to invalid memory addresses

Explanation: This is used in the statistic record, to indicate the total number ofexceptions raised in the region, due to invalid memory addresses, during theselected period.

0A0003C CICSSTAT_TASK_NUM_PROT_VIOLATION

COBOLCS-TASK-NUM-PROT-VIOLATION

MessageTotal number of exceptions raised due to protection violations

Explanation: This is used in the statistic record, to indicate the total number ofexceptions raised in the region, due to protection violations, during the selectedperiod.

Table 22. Task statistics (continued)

0A0004C CICSSTAT_TASK_NUM_SYSTEM_ERROR

COBOLCS-TASK-NUM-SYSTEM-ERROR

MessageTotal number of exceptions raised by operating system detected errors

Explanation: This is used in the statistic record, to indicate the total number ofexceptions raised in the region, due to operating system detected errors, during theselected period.

0A0005C CICSSTAT_TASK_NUM_EXCEPTIONS

COBOLCS-TASK-NUM-EXCEPTIONS

MessageTotal number of transactions abnormally terminated due to exceptions

Explanation: This is used in the statistic record, to indicate the total number oftransactions, for the region, which are abnormally terminated due to exceptions,during the selected period.

0A0006C CICSSTAT_TASK_NUM_TRANNONS

COBOLCS-TASK-NUM-TRANNONS

MessageTotal number of transactions which CICS was unable to start

Explanation: This is used in the statistic record, to indicate the total number oftransactions, for the region, which CICS was unable to start, during the selectedperiod.

0A0007C CICSSTAT_TASK_NUM_APP_SERVERS_FULL

COBOLCS-TASK-NUM-APP-SERVERS-FULL

MessageTotal number of times the number of active transactions reached themaximum number of application servers

Explanation: This is used in the statistic record, to indicate the total number of timesthe number of active transactions reached the maximum number of applicationservers for the region, during the selected period.

0A0008C CICSSTAT_TASK_PEAK_TASKS

COBOLCS-TASK-PEAK-TASKS

MessagePeak number of tasks

Explanation: This is used in the statistics record to indicate the maximum number oftask requests that the region was processing at any one moment in time, during theselected interval. This includes both queued and running tasks requests.

0A0009C CICSSTAT_TASK__CLASS1_MAXVAL

COBOLCS-TASK-CLASS1-MAXVAL

MessageMaximum number of running Class 1 tasks allowed

Explanation: This is used in the statistics record to indicate the value defined in theClassMaxTasks attribute of the Region Definition file for Class 1.

0A000AC CICSSTAT_TASK__CLASS1_CURRENT

COBOLCS-TASK-CLASS1-CURRENT

MessageCurrent number of tasks (running and queued) for Class 1

Explanation: This is used in the statistics record to indicate the total number of Class1 tasks in the region at the time the statistics were written. This includes bothqueued and running tasks.

0A000BC CICSSTAT_TASK__CLASS1_MAX_TIMES_HIT

COBOLCS-TASK-CLASS1-MAX-TIMES-HIT

MessageThe number of times Class 1 running tasks reached the maximum

Explanation: This is used in the statistics record to indicate the number of times thestarting of a new task resulted in the number of Class 1 running tasks in the regionreaching the maximum value, during the selected interval. The maximum value isdefined by the ClassMaxTasks attribute of the of the Region Definition file.

0A000CC CICSSTAT_TASK__CLASS1_PEAK_TASKS

COBOLCS-TASK-CLASS1-PEAK-TASKS

MessagePeak number of tasks for Class 1

Explanation: This is used in the statistics record to indicate the maximum number oftask 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.

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 byend-users. The statistics also show transmission faults. Both these factors havea negative influence on system performance.

The number of messages received and sent by a terminal represents theamount of message activity for that terminal. These numbers represent themessage traffic between CICS and terminals. Input traffic is the result of userinitiated input, which is initial transaction input or input as a result of aconversational read to the terminal. Output messages are written by theapplication program or sent by CICS.

These messages can vary because of differences in the application programsbeing used on different terminals. Transactions initiated by automatic taskinitiation (ATI) usually do not have terminal input but can generate one, ormany, output messages.

CICS provides global statistical information relating to all terminals that aredefined in the Terminal Definitions (WD).

CICS also provides statistics information for each individual terminal.

Table 23. Terminal statistics

0B0000C CICSSTAT_TERM_INPUTS

COBOLCS-TERM-INPUTS

MessageNumber of input messages received from CICS terminals

Explanation: This is used in the statistics record to indicate the number of messagesreceived by CICS from CICS terminals.

0B0001C CICSSTAT_TERM_OUTPUTS

COBOLCS-TERM-OUTPUTS

MessageNumber of output messages sent to cics terminals

Explanation: This is used in the statistics record to indicate the number of messagessent by CICS to cics terminals.

0B0002C CICSSTAT_TERM_XMITERRS

COBOLCS-TERM-XMITERRS

MessageNumber of terminal transmission errors

Explanation: This is used in the statistics record to indicate the number oftransmission failures between CICS and cics terminals.

0B0003C CICSSTAT_TERM_TRANS

COBOLCS-TERM-TRANS

MessageThe number of transactions.

Explanation: This is used in the statistics record to indicate the number of (TTI)transactions submitted against the terminal.

Table 23. Terminal statistics (continued)

0B0004C CICSSTAT_TERM_TRANERRS

COBOLCS-TERM-TRANERRS

MessageNumber 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.

0B0005C CICSSTAT_TERM_TOTAL_AUTOINSTALLS

COBOLCS-TERM-TOTAL-AUTOINSTALLS

MessageNumber of terminals which have autoinstalled

Explanation: This is used in the statistics record to indicate the number of terminalswhich have autoinstalled onto CICS.

0B0006C CICSSTAT_TERM_TOTAL_AUTOFAILS

COBOLCS-TERM-TOTAL-AUTOFAILS

MessageNumber of unsuccessful terminal autoinstalls

Explanation: This is used in the statistics record to indicate the number of terminalswhich have not succeeded in autoinstalling onto CICS.

0B0007C CICSSTAT_TERM_TOTAL_AUTODISCONNECTS

COBOLCS-TERM-TOTAL-AUTODISCONNECTS

MessageNumber of autoinstalled terminal which have disconnected

Explanation: This is used in the statistics record to indicate the number ofautoinstalled terminals which have uninstalled from CICS.

0B0008C CICSSTAT_TERM_SCHDL_LIMIT

COBOLCS-TERM-SCHDL-LIMIT

MessageThe times the synchronous scheduling limit has been hit

Explanation: This is used in the statistics record to indicate the number of times thesynchronous scheduling limit has been reached.

0B0009C CICSSTAT_TERM_SYNC_COUNT

COBOLCS-TERM-SYNC-COUNT

MessageThe number of synchronous threads currently running

Explanation: This is used in the statistics record to indicate the number ofsynchronous threads currently running.

0B000AC CICSSTAT_TERM_ASYNC_COUNT

COBOLCS-TERM-ASYNC-COUNT

MessageThe number of asynchronous threads currently running

Explanation: This is used in the statistics record to indicate the number ofsynchronous threads currently running.

0B000BC CICSSTAT_TERM_THREAD_HWM

COBOLCS-TERM-THREAD-HWM

MessageThe high water mark for the number of threads

Explanation: This is used in the statistics record to indicate the high water mark forthe number of threads.

0B000CC CICSSTAT_TERM_THREAD_LIMIT

COBOLCS-TERM-THREAD-LIMIT

MessageThe number of times the thread limit has been hit

Explanation: This is used in the statistics record to indicate the number of times themaximum number of threads has been in use.

0B000DC CICSSTAT_TERM_RPC_REQUESTS

COBOLCS-TERM-RPC-REQUESTS

MessageThe number of remote procedure call requests

Explanation: This is used in the statistics record to indicate the number of remoteprocedure call requests.

0B000EC CICSSTAT_TERM_RPC_ERRORS

COBOLCS-TERM-RPC-ERRORS

MessageThe number of remote procedure calls which returned in error

Explanation: This is used in the statistics record to indicate the number of remoteprocedure calls which returned in error.

Transient data statistics

CICS provides global statistical information relating to transient data queuesdefined to CICS in the Transient Data Definitions (TDD). CICS accumulatesthese statistics for all TD requests on the region since region start-up. CICSalso provides statistical information relating to each individual TD queuedefined to CICS in the TDD.

Table 24. Transient data statistics

0C0000C CICSSTAT_TDQU_STAT_EP_READS

COBOLCS-TDQU-STAT-EP-READS

MessageNumber of extrapartition transient data queue reads

Explanation: This text is used as the label for the TDQ global statistics count ofextrapartition queue reads.

0C0001C CICSSTAT_TDQU_STAT_EP_WRITES

COBOLCS-TDQU-STAT-EP-WRITES

MessageNumber of extrapartition transient data queue writes

Explanation: This text is used as the label for the TDQ global statistics count ofextrapartition queue writes.

0C0002C CICSSTAT_TDQU_STAT_IP_READS

COBOLCS-TDQU-STAT-IP-READS

MessageNumber of intrapartition transient data queue reads

Explanation: This text is used as the label for the TDQ global statistics count ofintrapartition queue reads. This includes queues defined with a trigger level.

0C0003C CICSSTAT_TDQU_STAT_IP_WRITES

COBOLCS-TDQU-STAT-IP-WRITES

MessageNumber of intrapartition transient data queue writes

Explanation: This text is used as the label for the TDQ global statistics count ofintrapartition queue writes. This includes queues defined with a trigger level.

Table 24. Transient data statistics (continued)

0C0004C CICSSTAT_TDQU_STAT_RMT_READS

COBOLCS-TDQU-STAT-RMT-READS

MessageNumber of remote transient data queue reads

Explanation: This text is used as the label for the TDQ global statistics count ofremote queue reads.

0C0005C CICSSTAT_TDQU_STAT_RMT_WRITES

COBOLCS-TDQU-STAT-RMT-WRITES

MessageNumber of remote transient data queue writes

Explanation: This text is used as the label for the TDQ global statistics count ofremote queue writes.

0C0006C CICSSTAT_TDQU_STAT_TRIG_READS

COBOLCS-TDQU-STAT-TRIG-READS

MessageNumber of times a triggerable transient data queue was emptied by a TDqueue read

Explanation: This text is used as the label for the TD queue global statistics count ofthe number of TD queue reads which emptied a triggerable intrapartition TD queue,starting a new automatic transaction initiation cycle for that TD queue.

0C0007C CICSSTAT_TDQU_STAT_TRIG_WRITES

COBOLCS-TDQU-STAT-TRIG-WRITES

MessageNumber of times the trigger level of transient data queue was reached by aTD queue write

Explanation: This text is used as the label for the TD queue global statistics count ofthe number of TD queue writes which resulted in the number of items on atriggerable intrapartition TD queue reaching the defined trigger level, resulting in arequest to initiate the triggered transaction.

Table 24. Transient data statistics (continued)

0C0008C CICSSTAT_TDQU_STAT_LABEL_READS

COBOLCS-TDQU-STAT-LABEL-READS

MessageNumber of transient data queue reads

Explanation: This text is used as the label for the read count statistic stored in eachTDQ.

0C0009C CICSSTAT_TDQU_STAT_LABEL_WRITES

COBOLCS-TDQU-STAT-LABEL-WRITES

MessageNumber of transient data queue writes

Explanation: This text is used as the label for the write count statistic stored in eachTDQ.

Transaction statistics

CICS provides statistical information for all transactions defined in theTransaction Definitions (TD).

Table 25. Transaction statistics

0D0000C CICSSTAT_TRAN_TRAN_STARTS

COBOLCS-TRAN-TRAN-STARTS

MessageTotal number of times transaction started

Explanation: Statistic record label.

Table 25. Transaction statistics (continued)

0D0001C CICSSTAT_TRAN_TRANS_ABENDS

COBOLCS-TRAN-TRANS-ABENDS

MessageThe number of task private storage abends for transaction

Explanation: This statistic is gathered for each CICS transaction. It records howmany task private storage abends have been raised against a transaction.

0D0002C CICSSTAT_TRAN_DYNAMIC_RETRY_COUNT

COBOLCS-TRAN-DYNAMIC-RETRY-COUNT

MessageThe total number of times that the destination system of a dynamictransaction had to be retried before the transaction was successfully routed.

Explanation: This statistic can be used to find out how effective the dynamictransaction routing user exit was when attempting to route this transaction. If adynamic transaction had to be retried multiple times before it was routed to a validand available system, then there may be a problem with the dynamic transactionrouting user exit. If the transaction is not dynamic then this statistic will always bezero.

0D0004C CICSSTAT_TRAN_DYNAMIC_REMOTE

COBOLCS-TRAN-DYNAMIC-REMOTE

MessageThis is the number of times the dynamic transaction routing exit has chosento run this transaction on the local system.

Explanation: This statistic is used to count the number of times that a particulartransaction, which is defined as dynamic, has been routed locally by the dynamictransaction routing user exit. If the transaction is not dynamic then this statistic willalways be zero.

Table 25. Transaction statistics (continued)

0D0005C CICSSTAT_TRAN_DYNAMIC_LOCAL

COBOLCS-TRAN-DYNAMIC-LOCAL

MessageThis is the number of times the dynamic transaction routing exit has chosento run this transaction on a remote system.

Explanation: This statistic is used to count the number of times that a particulartransaction, which is defined as dynamic, has been routed to a remote system by thedynamic transaction routing user exit. If the transaction is not dynamic then thisstatistic will always be zero.

Temporary storage statistics

CICS provides global statistical information relating to temporary storagequeues that are defined in the Temporary Storage Definitions (TSD).

Table 26. Temporary storage statistics

0E0000C CICSSTAT_TSQU_READ_MAIN

COBOLCS-TSQU-READ-MAIN

MessageNumber of MAIN Temporary Storage (TS) queue read requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) read requests from MAIN queues.

0E0001C CICSSTAT_TSQU_WRITE_MAIN

COBOLCS-TSQU-WRITE-MAIN

MessageNumber of MAIN Temporary Storage (TS) queue write requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) write requests to MAIN queues.

Table 26. Temporary storage statistics (continued)

0E0002C CICSSTAT_TSQU_DELETE_MAIN

COBOLCS-TSQU-DELETE-MAIN

MessageNumber of MAIN Temporary Storage (TS) queue delete requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) MAIN queue delete requests.

0E0003C CICSSTAT_TSQU_READ_AUX

COBOLCS-TSQU-READ-AUX

MessageNumber of AUXILIARY Temporary Storage (TS) queue read requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) read requests from AUXILIARY queues.

0E0004C CICSSTAT_TSQU_WRITE_AUX

COBOLCS-TSQU-WRITE-AUX

MessageNumber of AUXILIARY Temporary Storage (TS) queue write requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) write requests to AUXILIARY queues.

0E0005C CICSSTAT_TSQU_DELETE_AUX

COBOLCS-TSQU-DELETE-AUX

MessageNumber of AUXILIARY Temporary Storage (TS) queue delete requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) AUXILIARY queue delete requests.

0E0006C CICSSTAT_TSQU_CHECKPOINT

COBOLCS-TSQU-CHECKPOINT

MessageNumber of CICS checkpoints written to the system log

Explanation: This is used in the statistic record, to indicate the number of CICScheckpoint operations (called activity keypoints in CICS/MVS terminology)performed during the selected period.

0E0007C CICSSTAT_TSQU_ABORT

COBOLCS-TSQU-ABORT

MessageNumber of Temporary Storage (TS) aborts

Explanation: This is used in the statistic record, to indicate the number of transactionabort requests received by Temporary Storage (TS).

0E0008C CICSSTAT_TSQU_COMMIT

COBOLCS-TSQU-COMMIT

MessageNumber of Temporary Storage (TS) commits

Explanation: This is used in the statistic record, to indicate the number of transactioncommit requests received by Temporary Storage (TS).

0E0009C CICSSTAT_TSQU_EXHAUSTED

COBOLCS-TSQU-EXHAUSTED

MessageNumber of times NOSPACE condition has arisen on Temporary Storage(TS)

Explanation: This is used in the statistic record, to indicate the number of timesTemporary Storage (TS) has encountered a NOSPACE condition.

0E000AC CICSSTAT_TSQU_PEAK_QS

COBOLCS-TSQU-PEAK-QS

MessagePeak number of Temporary Storage (TS) queues existing

Explanation: This is used in the statistic record, to indicate the largest concurrentnumber of Temporary Storage (TS) queues existing.

0E000BC CICSSTAT_TSQU_CURRENT_QS

COBOLCS-TSQU-CURRENT-QS

MessageCurrent number of Temporary Storage (TS) queues existing

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) queues existing in the region at this instance.

0E000CC CICSSTAT_TSQU_MOST_ITEMS

COBOLCS-TSQU-MOST-ITEMS

MessageMost items in a Temporary Storage (TS) queue

Explanation: This is used in the statistic record, to indicate the largest number ofitems that has existed in any Temporary Storage (TS) queue.

0E000DC CICSSTAT_TSQU_IO_ERRORS

COBOLCS-TSQU-IO-ERRORS

MessageNumber of Temporary Storage (TS) queue IOERRs

Explanation: This is used in the statistic record, to indicate the number of timesTemporary Storage (TS) has encountered the IOERR condition.

0E000EC CICSSTAT_TSQU_AUTH_FAILURES

COBOLCS-TSQU-AUTH-FAILURES

MessageNumber of Temporary Storage (TS) queue authorization failures

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) queue requests that have been made without sufficient authority tooperate on the TS queue.

0E000FC CICSSTAT_TSQU_QS_PURGED

COBOLCS-TSQU-QS-PURGED

MessageNumber of Temporary Storage (TS) queues purged by the CICS _privateTemporary Storage Queue Aging transaction (CAGE)

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) queues that have been deleted by the CICS _private Temporary StorageQueue Aging transaction (CAGE). The time elapsed since they were last accessedwas greater than the TS queue aging limit.

0E0010C CICSSTAT_TSQU_CAGE_RUNS

COBOLCS-TSQU-CAGE-RUNS

MessageNumber 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 thatthe CICS_private Temporary Storage Queue Aging transaction (CAGE) has been run.

0E0011C CICSSTAT_TSQU_DELETE_WAITS

COBOLCS-TSQU-DELETE-WAITS

MessageNumber of Temporary Storage (TS) queue delete usage conflicts.

Explanation: This is used in the statistic record, to indicate the number of times thata Temporary Storage (TS) has encountered another user of a queue when deleting itand has had to wait before retrying.

0E0012C CICSSTAT_TSQU_REMOTE_REQS

COBOLCS-TSQU-REMOTE-REQS

MessageNumber of REMOTE Temporary Storage (TS) queue requests

Explanation: This is used in the statistic record, to indicate the number of TemporaryStorage (TS) requests to queues on remote CICS regions.

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 Description

CCFLAGS For CICS on Open Systems platforms, it sets bothcompile and link options. For Windows NT thisspecifies the compile and link options for the Ccompiler.

cell_admin_pw Contains the DCE password of the DCE celladministrator.

CICSCOL Specifies the name of the default color mappingfile to be used by the cicslterm command.

CICSDB2CONF_CONNECT_USER Specifies the DB2 UDB user ID for use by thecicsddt and cicsdb2conf commands.

CICSDB2CONF_CONNECT_USING Specifies the DB2 UDB password for use by thecicsddt and cicsdb2conf commands.

CICSDB2PASSWORD Specifies the DB2 UDB password for use by thecommand cicsdb2conf.

CICSDEBUGENV Specifies the location of the file that containsdefault values for the IBM ApplicationDebugging Program.

CICS_DUMP_STORAGE_CHAIN (CICS forWindows NT)

On the Windows NT platform, set this variableequal to t:TranID f:FileName to allow thediagnostic data to be directed to a different filethan the memory dump.

CICSECIANIMATE Specifies a blank-separated list of TTYs on whichterminals installed by ECI commands are to beanimated. This variable applies to theenvironment in which the ECI program executes,not to the CICS environment. See the CICSFamily: Client/Server Programming manual.

CICSEPIANIMATE Specifies a blank-separated list of TTYs on whichterminals installed by EPI commands are to beanimated. This variable applies to theenvironment in which the EPI program executes,not to the CICS environment. See the CICSFamily: Client/Server Programming manual.

Table 27. CICS and Encina Environment Variables (continued)

CICSEPIMAXTERMINALS Controls the number of threads created by anapplication. This variable can be set to any valuefrom 1 through 500. The default value is 100.

CICSEXTERNALTRACE Causes CICS clients and offline utilities to writeto an external (operating system) eventperformance trace facility if set to a value otherthan null.

CICSKEY Specifies the name of the default key mappingfile to be used by the cicslterm command.

CICSPATH Specifies 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. ForWindows NT the default value is d:\opt\cics.This environment variable must not be changed.

CICSREGION Sets the default working region.

CICSTERM If set in the current environment, CICSTERM isused instead of TERM.

CICSTRACE If set, causes tracing to be started during CICSinitialization. For CICS clients or utilities,CICSTRACE contains the name of the file towhich trace entries are written.

CICS_BROWSE_CACHE Specifies the number of 4KB pages required forthe browse cache.

CICS_HOSTS Contains a blank-separated list of hostnames tobe searched for regions when starting a CICSterminal.

CICS_CST_HTML Specifies pathname of the directory where theHTML help files for the CICS-suppliedtransactions can be found.

CICS_IBMC_FLAGS For Windows NT this specifies user-defined flagsto be passed to the compile and link stages by thecicstcl command when compiling a C programusing the IBM C++ compiler.

CICS_IBMCOB_FLAGS Specifies user-defined flags to be passed to thecompile and link stages by the cicstcl commandwhen compiling a COBOL program using theIBM COBOL compiler.

CICS_IBMPLI_FLAGS Specifies user-defined flags to be passed to thecompile and link stages by the cicstcl commandwhen compiling a PL/I program using the IBMPL/I compiler.

Environment variables used by CICS

CICS_MSC_FLAGS For Windows NT only, this specifies user-definedflags to be passed to the compile and link stagesby the cicstcl command when compiling a Cprogram using the Microsoft C++ compiler.

CICS_PPCGWY_SERVER Specifies the name of a PPC gateway server. Usedby cicsppcgwy command if the server name isnot supplied with the command.

CICS_PPCGWY_SIZE Specifies the size (in MB) of the PPC gatewaylogical volume.

CICS_PPCGWY_VG Specifies the logical volume group for the PPCgateway logical volume.

CICS_SCHEMA Sets the default working schema file.

CICS_SFS_DATA_SIZE Specifies the size (in MB) of the data logicalvolume for the SFS. This overrides theenvironment variable CICS_SFS_SIZE.

CICS_SFS_DATA_VG For Open systems, this specifies the logicalvolume group for, and for Windows NT, thelocation of, the data logical volume for the SFS.This overrides the environment variableCICS_SFS_VG.

CICS_SFS_LOG_SIZE Specifies the size (in MB) of the log logicalvolume for the SFS. This overrides theenvironment variable CICS_SFS_SIZE.

CICS_SFS_LOG_VG For Open Systems, this specifies the logicalvolume group for, and for Windows NT, thelocation of, the log logical volume for the SFS.This overrides the environment variableCICS_SFS_VG.

CICS_SFS_SERVER Sets the default working SFS. This overrides theenvironment variable ENCINA_SFS_SERVER.

CICS_SFS_SIZE Specifies the sizes (in MB) of both the data andthe log logical volumes for the SFS.

CICS_SFS_VG For Open Systems, this specifies the logicalvolume group for, and for Windows NT, thelocation of, both the data and the log logicalvolumes for the SFS.

CICS_SUPPRESS_XAOPEN_STRING Prevents the XA OPEN string from printing inthe CICS console file when a region attempts toconnect to an XA-compliant database.

Chapter 9. Environment variables used by CICS 493

CICS_XDT_SERVER Specifies the default database for CICS. Thisoverrides the environment variableCICS_SFS_SERVER.

CICS_XFH_DBNAME Defines the name of the DB2 database to be usedby the external file handler. If the variable is notset, the default DB2 database is used.

CICS_XFH_ COMMITINTERVAL If the external file handler is running innon-transactional mode (the environment variableCICS_XFH_TRANMODE is not set or is set to“N”) the environment variableCICS_XFH_COMMITINTERVAL specifies thenumber of recoverable operations that will beperformed on the database before they arecommitted. If CICS_XFH_COMMITINTERVAL isnot set the changes will be committed after everyoperation.

CICS_XFH_LOCAL_LINE_SEQ (CICS for WindowsNT)

On the Windows NT platform where CICS isusing DB2 for its file manager, set this variableequal to 1, if the user wants an external file ofline sequential type to be handled by MFCOBOL, instead of DB2.

CICS_XFH_LOCAL_ SEQ (CICS for Windows NT) On the Windows NT platform where CICS isusing DB2 for its file manager, set this variableequal to 1, if the user wants an external file ofsequential type to be handled by MF COBOL,instead of DB2.

CICS_XFH_LOCAL_ INDEXED (CICS for WindowsNT)

On the Windows NT platform where CICS isusing DB2 for its file manager, set this variableequal to 1, if the user wants an external file ofindexed type to be handled by MF COBOL,instead of DB2.

CICS_XFH_LOCAL_RELATIVE (CICS for WindowsNT)

On the Windows NT platform where CICS isusing DB2 for its file manager, set this variableequal to 1, if the user wants an external file ofrelative type to be handled by MF COBOL,instead of DB2.

CICS_XFH_LOGFILE Defines the path name to an alternate log for theexternal file handler. Normally this environmentvariable is not set and the external file handlerappends to a file in tmp directory calledxfh.LogFile. If this file does not exist, then it iscreated. Multiple concurrent external file handlerapplications can use the same file. If you don’twant to keep a log file, set this environmentvariable to NONE. When this is done, errors arereported to stderr.

CICS_XFH_TRANMODE Defines transactional ‘T’ or non-transactionalaccess to the database. The default operation isnon-transactional access. For more information onthe differences between the access modes andhow they are implemented, see the CICSApplication Programming Guide.

CICS_XFH_USERNAME Defines the user name used to connect to thedatabase. If this is not set, then the userid thatwas logged in when the application started isused to access the database.

CICS_XFH_USERPASS Defines the user password used to connect to thedatabase. If this is not set, then the userid thatwas logged in when the application started isused to access the database.

COBDIR Set, if Micro Focus COBOL or Micro Focus NetExpress is not installed in the standard directory.(Standard directory depends on version ofCOBOL.)This specifies the COBOL directory forMicro Focus COBOL or Net Express.

COBLIB Specifies the shared library for COBOL for MicroFocus COBOL or Net Express.

COBOPTS Sets COBOL compile and link options for MicroFocus COBOL or Net Express.

COBSW COBOL run-time switches. Refer to the MicroFocus COBOL or Micro Focus Net Expressdocumentation for further details. By default,Micro Focus COBOL and Net Express cacheCOBOL programs. Caching can be disabled bysetting the -l (lowercase L) memory switch tozero in the environment file in the regiondirectory (for example, COBSW=″-l0″) before youstart the region. If you disable the caching, a newcopy of the COBOL program is loaded wheneverthe program is run.

DB2DBDFT Contains the name of the default DB2 database.

ENCINA_AUTHN CICS requires that this variable must not be set.Defines the DCE protection level that an Encinaclient or server uses when it sends an RPC to anEncina Server.

ENCINA_AUTHZ Defines whether an Encina server checks theauthorization of any client that sends an RPCrequest against the access control lists (ACLs)defined for the server. Authorization checks takeplace if ENCINA_AUTHZ=1 and do not ifENCINA_AUTHZ=0.

ENCINA_BINDING_FILE Specifies the location of the file of bindingtranslations used when not using DCE servers.For CICS this must always be set to eitherVarDir/var/cics_servers/server_bindings orVarDir\var\cics_servers\server_bindings.

ENCINA_CDS_ROOT The name of a DCE cell directory service (CDS)directory under which all your Encina serversregister their names. Each type of server registersin a different subdirectory under the namedefined in ENCINA_CDS_ROOT.

ENCINA_GWY_SERVER The default gateway server name; used when the-server option for Encina administrativecommands is not used.

ENCINA_KEY_FILE The file, known as the keytab file, containing thepassword of a DCE principal that is used by anEncina server.

ENCINA_MIN_AUTHN Defines the minimum DCE protection level thatan Encina server accepts on RPC requests itreceives. It can be in the range 0-6. IfENCINA_MIN_AUTHN=1, the server cannotperform authorization checks on the RPC, soENCINA_AUTHZ should be 0.

ENCINA_PRINCIPAL The name of the DCE principal to be used by anEncina server, such as the SFS.

ENCINA_SFS_SERVER Sets the default SFS server used by Encinasfsadmin command.

ENCINA_TK_SERVER Sets the default server used by Encina tkadmincommand.

ENCINA_TRACE Specifies which components in an Encina serverare to produce trace. For example, to get the trancomponent of the Encina toolkit to produce trace,specify: export ENCINA_TRACE=tran:0x1f

LANG This variable sets the locale in which CICS runs.The region’s locale can be set by the standardLANG variable (for example LANG=en_US orLANG=C) or it can be overridden in the region’senvironment file. The client side (for example,cicsterm) uses the locale from the currentenvironment.

LIBPATH (CICS for AIX) For use On Open Systems only. If you are usingMicro Focus COBOL level 3.2.27 or laterLIBPATH should be set to $COBDIR/coblib (bycicsmkcobol). Otherwise it should not be set.

MSQL_DEAD (CICS for Windows NT) When a Microsoft SQL Server encounters atransaction deadlock, it terminates the transactionand invalidates the XAID. This causes theXA_ROLLBACK to return RMER_NOTA (-4).CICS treats the negative return as fatal andabends the region (U8030) unless the environmentvariable MSQL_DEAD is set to 1. If theenvironment variable MSQL_DEAD is set to 1CICS will instead abend only the applicationserver. To enable this option MSQL_DEAD=1must be defined in the region’s environment file.

PATH This includes the bin directory for CICS, Encinaand 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 usingMicro Focus COBOL level 3.2.27 or laterSHLIB_PATH should be set to $COBDIR/coblib(by cicsmkcobol). Otherwise it should not be set.

TERM Determines the type of terminal used when aterminal is autoinstalled. Can be set in the user’senvironment.

CICS does not allow you to use absolute or relative paths when specifyinglocale names. Locale names must not be larger than 32 bytes in length.

Environment variables for Micro Focus COBOL and Net Express compileroptions

Table 28. Environment variables for Micro Focus COBOL compiler options

Option Note

VSC2 Required for COBOL II (CICS for AIX) or HP COBOL/HPUX (CICS forHP-UX). The default value is NOVSC2.

OSVS Recommended. The default value is NOOSVS.

ANS85 The default value is ANS85.

IBMCOMP Recommended. The default value is NOIBMCOMP.

NOALTER Recommended. The default value is ALTER.

NOTRUNC Recommended – USAGE COMP truncation behavior. The default value isTRUNC=ANSI.

NOBOUND Recommended – no check on OCCURS limits at runtime. The default valueis NOBOUND.

WARNING=2 Default gives informational messages. The default value is WARNING=3.

ANIM Required for ANIMATOR debugging. The default value is NOANIM.

DEFAULTBYTE=0 Recommended – initializes data division entries to low-values instead ofspaces. The default value is DEFAULTBYTE=32.

User-defined environment variables for CICS are defined in the environmentfile, located in the region directory. The file has the same format as the file/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.

Chapter 10. Terminal model definitionsTable 29. Road map for terminal model definitions

If you want to... Refer to...

See the IBM CICS Client model. Table 30 on page 502.

See the IBM CICS ECI model. Table 30 on page 502.

See the example vt100 model. Table 30 on page 502.

See the example aixterm model. Table 30 on page 502.

See the example aixterm-m model. Table 30 on page 502.

See the example ibm3151 model. Table 30 on page 502.

See the high-function multibyte color model. Table 31 on page 502.

See the high-function singlebyte color model. Table 31 on page 502.

See the high-function multibyte mono model. Table 31 on page 502.

See the high-function singlebyte mono model. Table 31 on page 502.

See the low-function multibyte mono model. Table 31 on page 502.

See the low-function singlebyte mono model. Table 31 on page 502.

See the example HP terminal definition model. Table 31 on page 502.

See the hpterm model definition model. Table 31 on page 502.

See the example xterm model. Table 32 on page 503.

See the 327x-x-E for cicsteld model. Table 32 on page 503.

See the 327x-x for cicsteld model. Table 32 on page 503.

See the example vt220 model. Table 32 on page 503.

See the example dxterm (vt300) model. Table 32 on page 503.

See the example dtterm model. Table 32 on page 503.

See the example 327x-3-E model for cicsteld Table 32 on page 503.

See the example 327x-3 model for cicsteld Table 32 on page 503.

See the example 97801 model Table 33 on page 504.

Table 29. Road map for terminal model definitions (continued)

If you want to... Refer to...

See the example model for Sun command tool andshell tool

Table 33 on page 504.

Table 30. Terminal Definition attributes for autoinstall models MDCL, MDCI, MD01, MD02, MD03, MD04,MD05 and MD06Attribute MDCL MDCI MD01 MD02 MD03 MD04 MD05 MD06Permanent yes yes yes yes yes yes yes yesModelId ″cicscli″ ″cicseci″ ″vt100″ ″aixterm″ ″aix-m″ ″ibm3151″ ″ibm3161″ ″ibm3164″DevType ″ibm-

cics-client″

″ibm-cics-eci″

″vt100″ ″aixterm″ ″aixterm-m″″ibm3151″ ″ibm3161″ ″ibm3164″

CanStartATIs yes no yes yes yes yes yes yesCanStartTTIs yes yes yes yes yes yes yes yesUCTranFlag no no no no no no no noTCTUALen 0 0 0 0 0 0 0 0Katakana no no no no no no no noIsPrinter no no no no no no no noTSLKeyList none none none none none none none noneRSLKeyList none none none none none none none noneIsShippable yes yes yes yes yes yes yes yesTermType 145 145 145 145 145 145 145 145TermSubType 10 10 10 10 10 10 10 10Priority 0 0 0 0 0 0 0 0ErrLastLine yes no yes yes yes yes yes yesERRIntensify yes no yes yes yes yes yes yesErrColor no no no red no no no noERRHilight no no no no no no no noOutService no no no no no no no noHighlight yes no yes yes yes yes yes yesForeground yes no no yes no no no noProgramSymbols no no no no no no no noSOSI no no no no no no no noOutline no no no no no no no noValidation no no no no no no no noExtDS yes no yes yes yes yes yes yesNumLines 24 24 24 24 24 24 24 24NumColumns 80 80 80 80 80 80 80 80TerminalProtection none none none none none none none noneRecoverTerminal yes yes yes yes yes yes yes yes

Table 31. Terminal Definition attributes for autoinstall models MD07, MD08, MD09, MD10, MD11, MD12,MD13 and MD14Attribute MD07 MD08 MD09 MD10 MD11 MD12 MD13 MD14Permanent yes yes yes yes yes yes yes yes

Table 31. Terminal Definition attributes for autoinstall models MD07, MD08, MD09, MD10, MD11, MD12,MD13 and MD14 (continued)Attribute MD07 MD08 MD09 MD10 MD11 MD12 MD13 MD14ModelId ″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 yesCanStartTTIs yes yes yes yes yes yes yes yesUCTranFlag no no no no no no no noTCTUALen 0 0 0 0 0 0 0 0Katakana no no no no no no no noIsPrinter no no no no no no no noTSLKeyList none none none none none none none noneRSLKeyList none none none none none none none noneIsShippable yes yes yes yes yes yes yes yesTermType 145 145 145 145 145 145 145 145TermSubType 10 10 10 10 10 10 10 10Priority 0 0 0 0 0 0 0 0ERRLastLine yes yes yes yes yes yes yes yesERRIntensify yes yes yes yes yes yes yes yesERRCOlor red red no no no no no noERRHilight no no no no no no no reverseOutService no no no no no no no noHighlight yes yes yes yes no no no yesForeground yes yes no no no no no noProgramSymbols yes no yes no yes no no noSOSI yes no yes no yes no no noOutline yes no yes no no no no noValidation no no no no no no no noExtDS yes yes yes yes yes no no yesNumLines 24 24 24 24 24 24 24 24NumColumns 80 80 80 80 80 80 80 80TerminalProtection none none none none none none none noneRecoverTerminal yes yes yes yes yes yes yes yes

Table 32. Terminal Definition attributes for autoinstall models MD15, MD16, MD17, MD18, MD19, MD20,MD21 and MD22Attribute MD15 MD16 MD17 MD18 MD19 MD20 MD21 MD22Permanent yes yes yes yes yes yes yes yesModelId ″xterm″ ″3270C″ ″3270M″ ″vt220″ ″vt300″ ″dtterm″ ″3270C-3″ ″3270M-3″DevType ″xterm″ ″3270C″ ″3270M″ ″vt220″ ″vt300″ ″dtterm″ ″3270C-3″ ″3270M-3″CanStartATIs yes yes yes yes yes yes yes yesCanStartTTIs yes yes yes yes yes yes yes yesUCTranFlag no no no no no no no noTCTUALen 0 0 0 0 0 0 0 0Katakana no no no no no no no noIsPrinter no no no no no no no no

Table 32. Terminal Definition attributes for autoinstall models MD15, MD16, MD17, MD18, MD19, MD20,MD21 and MD22 (continued)Attribute MD15 MD16 MD17 MD18 MD19 MD20 MD21 MD22TSLKeyList none none none none none none none noneRSLKeyList none none none none none none none noneIsShippable yes yes yes yes yes yes yes yesTermType 145 145 145 145 145 145 145 145TermSubType 10 10 10 10 10 10 10 10Priority 0 0 0 0 0 0 0 0ERRLastLine yes yes yes yes yes yes yes yesERRIntensify yes yes yes yes yes yes yes yesERRCOlor red red no no red red red noERRHilight no no no no no no no noOutService no no no no no no no noHighlight yes yes no yes yes yes yes noForeground yes yes no no yes yes yes noProgramSymbols no no no no no no no noSOSI no no no no no no no noOutline no no no no no no no noValidation no no no no no no no noExtDS yes yes no yes yes yes yes noNumLines 24 24 24 24 24 24 32 32NumColumns 80 80 80 80 80 80 80 80TerminalProtection none none none none none none none noneRecoverTerminal yes yes yes yes yes yes yes yes

Table 33. Terminal Definition attributes for autoinstall models MD23, MD24, MD25, MD26, MD27 andMD28Attribute MD23 MD24 MD25 MD26 MD27 MD28Permanent yes yes yes yes yes yesModelId ″3270C-4″ ″3270M-4″ ″3270C-5″ ″3270M-5″ ″97801″ ″sun-

cmd″DevType ″3270C-4″ ″3270M-4″ ″3270C-5″ ″3270M-5″ ″97801″ ″sun-

cmd″CanStartATIs yes yes yes yes yes yesCanStartTTIs yes yes yes yes yes yesUCTranFlag no no no no no noTCTUALen 0 0 0 0 0 0Katakana no no no no no noIsPrinter no no no no no noTSLKeyList none none none none none noneRSLKeyList none none none none none noneIsShippable yes yes yes yes yes yesTermType 145 145 145 145 145 145TermSubType 10 10 10 10 10 10Priority 0 0 0 0 0 0

Table 33. Terminal Definition attributes for autoinstall models MD23, MD24, MD25, MD26, MD27 andMD28 (continued)Attribute MD23 MD24 MD25 MD26 MD27 MD28ERRLastLine yes yes yes yes yes yesERRIntensify yes yes yes yes yes yesERRCOlor red no red no red redERRHilight no no no no no noOutService no no no no no noHighlight yes no yes no yes yesForeground yes no yes no yes yesProgramSymbols no no no no no noSOSI no no no no no noOutline no no no no no noValidation no no no no no noExtDS yes no yes no yes yesNumLines 43 43 27 27 24 24NumColumns 80 80 132 132 80 80TerminalProtection none none none none none noneRecoverTerminal yes yes yes yes yes yes

Chapter 11. Index of CICS resource attributes

If you are using CICS for AIX you can use the System Management InterfaceTool (SMIT), rather than CICS commands, to configure CICS resources. Thetables in this chapter cross reference the descriptions of resource attributes asthey appear in SMIT panels with the attribute names used in RDOcommands.

Table 34. Communications Definitions (CD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentConnection type ConnectionTypeName of remote system RemoteLUNameSNA network name for the remote system RemoteNetworkNameSNA profile describing the remote system SNAConnectNameDefault modename for a SNA connection DefaultSNAModeNameGateway Definition (GD) entry name GatewayNameListener Definition (LD) entry name ListenerNameTCP address for the remote system RemoteTCPAddressTCP port number for the remote system RemoteTCPPortDCE cell name of remote system DCECellTimeout on allocate (in seconds) AllocateTimeoutCode page for transaction routing RemoteCodePageTRSet connection in service? InServiceSend userids on outbound requests? OutboundUserIdsSecurity level for inbound requests RemoteSysSecurityUserId for inbound requests LinkUserIdTransaction Security Level (TSL) Key Mask TSLKeyMaskResource Security Level (RSL) Key Mask RSLKeyMaskTransmission encryption level RemoteSysEncrypt

Table 35. File Definitions (FD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentFile enable status EnableStatus

Table 35. File Definitions (FD) (continued)Attribute description Attribute name

Remote System Name RemoteSysIdRemote filename RemoteNameResource Level Security Key RSLKeyProtection level per OFD FileProtectionError isolation ErrorIsolationFile open status OpenStatusRead access status ReadOptUpdate access status UpdateOptBrowse access status BrowseOptAdd access status AddOptDelete access status DeleteOptEmpty status for first file open EmptyOptServer filename BaseNameFile Server FileServerServer Index Name IndexNameRecoverability status RecoverStatusIs a user conversion template defined TemplateDefinedKey length to use with remote requests KeyLenRecord length to use with remote requests RecordSizeNumber of pages to preallocate PrePages

Table 36. Gateway Definitions (GD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentDCE cell name of the gateway DCECellCDS path name of the gateway GatewayCDSNameSNA LU name of the gateway GatewayLUNameDCE principal under which this gateway runs GatewayPrincipal

Table 37. Gateway Server Definitions (GSD)Attribute description Attribute name

Resource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentCold or auto start? StartTypeProtection level ProtectionLevelNumber of threads for RPC requests ThreadPoolSizeShort name used for SRC ShortNameAIX user ID for server UserID

Resource attribute cross-reference

Table 37. Gateway Server Definitions (GSD) (continued)Attribute description Attribute name

AIX logical volume for logging LogVolumeSNA default mode name (HP only) SNADefaultModeNameName Service for advertising server NameService

Table 38. Journal Definitions (JD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentResource Level Security Key RSLKeyFile or path A holding the journal DiskAFile or path B holding the journal DiskBDisk A Status DiskAStatusDisk B Status DiskBStatusAbort region if journal is inaccessible? CrucialFlagOpen journal on region startup? InitialOpenFlag

Table 39. Listener Definitions (LD)Attribute description Attribute name

local Named Pipe name (CICS for Windows NT) NamedPipeNameGroup to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentProtocol type ProtocolTCP adapter address TCPAddressTCP service name TCPServicelocal SNA Node Name SNAServerNodeName

Table 40. Monitoring Definitions (MD)Attribute description Attribute name

Resource description ResourceDescriptionNumber of updates AmendCounterProtect the resource from modification? ModifiableWrite separate records for conversational tasks? ConversationalSet monitoring on? MonitorStatusTDQ to hold monitoring information TDQMonitoring identifiers to be excluded ExcludeMonitoring identifiers to be included IncludeFile or path of user monitoring program UserMonitorModule

Chapter 11. Index of CICS resource attributes 509

Table 41. Product Definitions (XAD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentSwitch Load File Path Name SwitchLoadFileResource Manager Initialization String XAOpenResource Manager Termination String XACloseResource Manager Serialization Attribute XASerialize

Table 42. Program Definitions (PD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modifications? PermanentProgram enable status EnableStatusRemote system on which to run program RemoteSysIdName to use for program on remote system RemoteNameTransaction name on remote system for program TransIdResource Level Security Key RSLKeyProgram path name PathNameProgram type ProgTypeUser Exit number UserExitNumberIs a user conversion template defined? TemplateDefinedIs this a program that should be cached? Resident

Table 43. Region Definitions (RD)Attribute description Attribute name

Resource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? ModifiableStartup type StartTypeStartup groups GroupsPrograms to execute at startup StartupProgListPrograms to execute at phase 1 of shutdown ShutdownProgList1Programs to execute at phase 2 of shutdown ShutdownProgList2Interval value controlling frequency of purging of the read recordsfrom the transient data queues

TDPurgeInterval

Name of the default user identifier DefaultUserIdType of file system FileSystemTypeThe RDBMS Instance name RDBMSInstance

Table 43. Region Definitions (RD) (continued)Attribute description Attribute name

Type of RSL checking for Files FileRSLCheckType of RSL checking for TDQs TransientDataRSLCheckType of RSL checking for TSQs TemporaryStorageRSLCheckType of RSL checking for Journals JournalRSLCheckType of RSL checking for Programs ProgramRSLCheckType of RSL checking for Transactions TransactionRSLCheckDo you want to use an External Security Manager? ESMLoadName of ESM Module ESMModuleMin protect level used when accepting RPCs RuntimeProtectionMin protect level for logical TDQs LogicalTDQProtectionMin protect level for physical TDQs PhysicalTDQProtectionMin protect level for non-recoverable TDQs NonRecTDQProtectionMin protect level for recoverable TSQs RecTSQProtectionMin protect level for non-recoverable TSQs NonRecTSQProtectionMin protect level for locally queued PROTECT ATIs LocalQProtectProtectionMin protect level for locally queued ATIs LocalQProtectionCICS Release Number ReleaseNumRegion system identifier (short name) LocalSysIdNetwork name to which local region is attached LocalNetworkNameCommon Work Area Size CWASizeMinimum number of Application Servers to maintain MinServerMaximum number of Application Servers to maintain MaxServerMaximum number of running transactions per class (10 entries) ClassMaxTasksPurge threshold for transaction requests above ClassMaxTasks ClassMaxTaskLimTime before Application Servers terminate (secs) ServerIdleLimitLevel of protection against user corruption SafetyLevelNumber of threads for RPC requests RPCListenerThreadsFormat date for FORMATTIME DateFormHash sizes CD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD ClassTableSizeRegion Pool Storage Size (bytes) MaxRegionPoolTask-private Storage Size (bytes) MaxTaskPrivatePoolTask Shared Pool Storage Size (bytes) MaxTSHPoolThreshold for Region Pool short on storage (%age) RegionPoolThresholdThreshold for TSH Pool short on storage (%age) TaskShPoolThresholdNumber of Task Shared Pool Address Hash Buckets TaskSHNumBucketsNumber of LOADed data Address Hash Buckets LoadDataNumBucketsSystem dump on shutdown, SNAP dumps, ASRx abends? SysDumpShould CICS system be dumped for ASRA abends? PCDumpShould CICS system be dumped for ASRB abends? ABDumpDirectory in which dump output is written DumpNameDirectory in which Core Dump output is written CoreDumpNameModules to trace TraceModule list for partial trace TraceModules

External trace facility required? ExternalTraceFile or path (A) for system trace TraceFileAFile or path (B) for system trace TraceFileBMaximum system trace file size TraceFileSizeSystem trace buffer size SysTraceBufferSizeUser trace directory UserTraceDirectoryUser Trace file or path for guest logins PublicUserTraceFileInterval between region consistency checks (mins) IntrospectIntervalLevel of checking to perform on region IntrospectLevelRetransmission interval for queued ATIs (mins) ISCDelayMinutesRescheduling interval for blocked ATIs (mins) CUBSDelayMinutesATI purge interval (hours) CARPDelayHoursPurge delay period for PROTECT requests (hours) ProtectPurgeDelayPeriodPurge delay period for no PROTECT requests (hours) PurgeDelayPeriodShould stats be recorded at every interval? StatsRecordFile or path for statistics StatFileShould map names be suffixed? SufficesSupportedNumber of records logged between checkpoints CheckpointIntervalSFS server or database storing CICS Queue Data DefaultFileServerSFS file storing Recoverable Auxiliary TSQs RecTSQFileSFS Index for Recoverable Auxiliary TSQs RecTSQIndexRecoverable Auxiliary TSQ Volume Name RecTSQVolNumber of pages to preallocate for RecTSQFile RecTSQPrePagesMaximum number of records for Recoverable Auxiliary TSQs RecTSQMaxRecsSFS file storing Non-Recoverable Auxiliary TSQs NonRecTSQFileSFS Index for Non-Recoverable Auxiliary TSQs NonRecTSQIndexNon-recoverable TSQ Volume Name NonRecTSQVolNumber of pages to preallocate for NonRecTSQFile NonRecTSQPrePagesMaximum number of records for Non-recoverable TSQs NonRecTSQMaxRecsSFS file storing Logically Recoverable TDQs LogicalTDQFileSFS Index for Logically Recoverable TDQs LogicalTDQIndexLogically Recoverable TDQ Volume Name LogicalTDQVolNumber of pages to preallocate for LogicalTDQFile LogicalTDQPrePagesMaximum number of records for Logically Recoverable TDQs LogicalTDQMaxRecsSFS file storing Physically Recoverable TDQs PhysicalTDQFileSFS Index for Physically Recoverable TDQs PhysicalTDQIndexPhysically Recoverable TDQ Volume Name PhysicalTDQVolNumber of pages to preallocate for PhysicalTDQFile PhysicalTDQPrePagesMaximum number of records for Physically Recoverable TDQs PhysicalTDQMaxRecsSFS file storing Non-Recoverable TDQs NonRecTDQFileSFS Index for Non-Recoverable TDQs NonRecTDQIndexNon-recoverable TDQ Volume Name NonRecTDQVolNumber of pages to preallocate for NonRecTDQFile NonRecTDQPrePages

Maximum number of records for Non-recoverable TDQs NonRecTDQMaxRecsSFS file for Locally-Queued Protected STARTs LocalQProtectFileSFS Index for Locally-Queued Protected STARTs LocalQProtectIndexLocally-Queued Protected START Volume Name LocalQProtectVolNumber of pages to preallocate for LocalQProtectFile LocalQProtectPrePagesMaximum number of records for Locally-Queued Protected STARTs LocalQProtectMaxRecsSFS file for Locally-Queued Unprotected STARTs LocalQFileSFS Index for Locally-Queued Unprotected STARTs LocalQIndexLocal Q Volume Name LocalQVolNumber of pages to preallocate for LocalQFile LocalQPrePagesMaximum number of records for Local Qs LocalQMaxRecsExpiry limit for unaccessed TSQs (days) TSQAgeLimitMaximum number of C or IBM COBOL programs that can becached

ProgramCacheSize

Local LU name LocalLUNameRegion Pool base register RegionPoolBaseTask Shared Pool base register TaskSharedPoolBaseServer side transactions only ? ServerSideTranUserid authentication performed by DCE or CICS? AuthenticationServiceUse DCE Name Service (CDS) to locate CICS and Encina servers? NameServiceAllow use of the application debugging tool AllowDebuggingTime DCE password is cached for use by ECI application (secs) ECIPasswordCacheSecondsHTML Browser for help text HTMLBrowser(Windows NT)Mode for autoinstallation of Terminals AutoInstallMode

MaxTaskCPUAction(CICS onOpen Systems)MaxTaskCPU(CICS on OpenSystems)

Maximum Console Size MaxConsoleSizeTransaction Dump Trace TransDumpTrace

Table 44. Schema File Definitions (SCD)Attribute description Attribute name

Resource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentCICS File Type FileTypeSFS ONLY: Volume Name VolumeNameSFS ONLY: Number of Pages to Preallocate PreallocatePagesSFS ONLY: Maximum Number of Records MaxRecordsPrimary Index Name PrimaryIndexNameIs Primary Index Unique? PrimaryIndexUniqueField Names for Primary Index PrimaryIndexFields

Table 44. Schema File Definitions (SCD) (continued)Attribute description Attribute name

Descending Field Names for Primary Index PrimaryIndexDescendersField 1 - Name FieldName1Field 1 - Type FieldType1Field 1 - Length FieldLength1Field 20 - Name FieldName20Field 20 - Type FieldType20Field 20 - Length FieldLength20Variable Field - Name VariableFieldNameVariable Field - Type VariableFieldTypeVariable Field - Length VariableFieldLengthSecondary Index 1 - Name IndexName1SFS ONLY: Secondary Index 1 - Volume Name IndexVolumeName1SFS ONLY: Secondary Index 1 - Preallocated Pages IndexPreallocatePages1Secondary Index 1 - Is it Unique? IndexUnique1Secondary Index 1 - Field Names IndexFieldNames1Secondary Index 1 - Descending Fields IndexFieldDescenders1Secondary Index 10 - Name IndexName10SFS ONLY: Secondary Index 10 - Volume Name IndexVolumeName10SFS ONLY: Secondary Index 10 - Preallocated Pages IndexPreallocatePages10Secondary Index 10 - Is it Unique? IndexUnique10Secondary Index 10 - Field Names IndexFieldNames10Secondary Index 10 - Descending Fields IndexFieldDescenders10

Table 45. Structured File Server Definitions (SSD)Attribute description Attribute name

Resource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentCold or auto start? StartTypeProtection level ProtectionLevelEnable MRA Archiving? MRAArchivingEnabledBuffer pool size in Kbytes BufferPoolSizeIdle timeout IdleTimeoutNumber of Log writes per checkpoint interval CheckpointNumber of threads devoted to normal operations OpThreadPoolSizeNumber of threads devoted to resource operations ResThreadPoolSizeCollating language CollatingLanguageShort name used for SRC ShortNameAIX user ID for server UserIDAIX logical volume for data DataVolumeAIX logical volume for logging LogVolumeLog File Name LogFileName Service for advertising server NameService

Table 46. Temporary Storage Definitions (TSD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentRemote System Identifier RemoteSysIdRemote Queue Name RemoteNameResource Level Security Key RSLKeyIs queue recoverable? RecoverFlagIs a user conversion template defined? TemplateDefined

Table 47. Terminal Definitions (WD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentSet terminal out of service? OutServiceSystem to which terminal belongs RemoteSysIdTerminal identifier on remote system RemoteNameTransaction Level Security Key list TSLKeyListResource Level Security Key list RSLKeyListAutoinstall Model Identifier ModelIdNumber of lines on terminal NumLinesNumber of columns on terminal NumColumnsIs terminal available for ATI requests? CanStartATIsCan transactions be initiated from this terminal? CanStartTTIsShould terminal convert data to uppercase? UCTranFlagLength of TCTUA TCTUALenNetName of the shell terminal NetNameDoes terminal support Katakana? KatakanaIs this an output only device? IsPrinterIs terminal definition shippable? IsShippableTerminal type TermTypeTerminal subtype TermSubTypeTerminal priority PriorityDoes terminal support field validation? ValidationDoes terminal support highlighting? HighlightIs foreground color supported? ForegroundIs BMS to generate extended data streams? ExtDSProgram Symbols ProgramSymbolsDoes terminal support field outlining? Outline

Table 47. Terminal Definitions (WD) (continued)Attribute description Attribute name

Does terminal support SOSI SOSIDisplay error messages on the last line? ERRLastLineShould error messages be intensified? ERRIntensifyColor for error messages ERRColorExtended highlighting for error messages ERRHilightDevice Type for model entry DevTypeProtection level TerminalProtection

Table 48. Transaction Definitions (TD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionThe class of transaction TClassNumber of updates AmendCounterProtect resource from modification? PermanentTransaction enable status EnableStatusCan transaction be dynamically routed? DynamicRemote System Identifier RemoteSysIdRemote Transaction Identifier RemoteNameResource Level Security Key RSLKeyTransaction Level Security Key TSLKeyType of RSL Checks RSLCheckType of TSL Checks TSLCheckShould transaction be dumped on an abend? TransDumpFirst program name ProgNameSNA TPN profile for APPC listener program TPNSNAProfileIs a user conversion template defined? TemplateDefinedIs back end of a DTP transaction? IsBackEndDTPTransaction Work Area Size TWASizeTransaction Priority PriorityTransaction purgeability PurgeabilityType of Syncpoint Flows SyncpointTransaction deadlock timeout value (secs) DeadLockTimeoutEffect of FORCEPURGE for InDoubt transactions InDoubtShould data be converted to uppercase? UCTranFlagSNA modename for this transaction SNAModeNameLocally Queue ATI requests for this transaction? LocalQConversational timeout value (mins) TimeoutContexts in which transaction can START InvocationMode

MaxTaskCPUAction(CICS onOpen Systems)

Table 48. Transaction Definitions (TD) (continued)Attribute description Attribute name

MaxTaskCPU(CICS on OpenSystems)

Table 49. Transient Data Definitions (TDD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentRemote System Identifier RemoteSysIdRemote Queue Name RemoteNameResource Level Security Key RSLKeyType of Queue DestTypeInput/Output Mode of EP Queue IOModeFilename or path for EP queue data file ExtrapartitionFileTime at which queue is to be opened WhenOpenedOpen EP output files truncated or append OpenModeRecord organization for EP queue data file RecordTypeRecord length for fixed length EP queue RecordLenASCII value of terminator for fixed length queue RecordTerminatorIndirect Queue Name IndirectQueueIdType of facility allocated for triggered task FacilityTypeRecoverability type of IP queue RecoveryTypeTriggered Transaction Identifier TriggeredTransIdTrigger Level TriggerLevelSystem/Terminal for a triggered task FacilityIdIs a user conversion template defined? TemplateDefined

Table 50. User Definitions (UD)Attribute description Attribute name

Group to which resource belongs GroupNameActivate the resource at cold start? ActivateOnStartupResource description ResourceDescriptionNumber of updates AmendCounterProtect resource from modification? PermanentTransaction Level Security Key List TSLKeyListResource Level Security Key List RSLKeyListDCE principal of the user PrincipalUser priority PriorityUser Trace filename TraceFileOperator ID OpID(Obsolete) DCE cell name DCECell

Table 50. User Definitions (UD) (continued)Attribute description Attribute name

Encrypted password CICSPassword

Table 51. Alphabetic cross-reference of attribute names to attribute descriptions

Attribute name Class Attribute description

ABDump RD Should CICS system be dumped for ASRB abends?

ActivateOnStartup FD, GD,JD, LD,PD, XAD

Activate resource at cold start?

CD, TD,TDD,TSD, UD,WD

Activate the resource at cold start?

AddOpt FD Add access status

AllocateTimeout CD Timeout on allocate (in seconds)

AllowDebugging RD Allow use of the application debugging tool

AmendCounter CD, FD,GD, GSD,JD, LD,MD, PD,RD, SCD,SSD, TD,TDD,TSD, UD,WD,XAD

Number of updates

AuthenticationService RD Userid authentication performed by DCE or CICS?

AutoDCELogin RD CICS on Open Systems

AutoInstallMode RD Mode for autoinstallation of terminals

BaseName FD Server filename

BrowseOpt FD Browse access status

BufferPoolSize SSD Buffer pool size in Kbytes

CanStartATIs WD Is terminal available for ATI requests?

CanStartTTIs WD Can transactions be initiated from this terminal?

CARPDelayHours RD ATI purge interval (hours)

Checkpoint SSD Number of Log writes per checkpoint interval

CheckpointInterval RD Number of records logged between checkpoints

CICSPassword UD Encrypted password

Table 51. Alphabetic cross-reference of attribute names to attribute descriptions (continued)

ClassMaxTaskLim RD Purge threshold for transaction requests aboveClassMaxTasks

ClassMaxTasks RD Maximum number of running transactions per class (10entries)

ClassTableSize RD Hash sizesCD,FD,PD,RD,TSD,WD,TD,TDD,XAD,UD,MD,JD,LD,GD

CollatingLanguage SSD Collating language

ConnectionType CD Connection type

Conversational MD Write separate records for conversational tasks?

CoreDumpName RD Directory in which Core Dump output is written

CrucialFlag JD Abort region if journal is inaccessible?

CUBSDelayMinutes RD Rescheduling interval for blocked ATIs (mins)

CWASize RD Common Work Area Size

DataVolume SSD AIX logical volume for data

DateForm RD Format date for FORMATTIME

DCECell UD (Obsolete) DCE cell name

CD DCE cell name of remote system

GD DCE cell name of the gateway

DeadLockTimeout TD Transaction deadlock timeout value (secs)

DefaultFileServer RD SFS server or database storing CICS Queue Data

DefaultSNAModeName CD Default modename for a SNA connection

DefaultUserId RD Name of the default user identifier

DeleteOpt FD Delete access status

DestType TDD Type of Queue

DevType WD Device Type for model entry

DiskA JD File or path A holding the journal

DiskAStatus JD Disk A Status

DiskB JD File or path B holding the journal

DiskBStatus JD Disk B Status

DumpName RD Directory in which dump output is written

Dynamic TD Can transaction be dynamically routed?

ECIPasswordCacheSeconds RD Time DCE password is cached for use by ECI application(secs)

EmptyOpt FD Empty status for first file open

EnableStatus FD File enable status

PD Program enable status

TD Transaction enable status

ERRColor WD Color for error messages

ERRHilight WD Extended highlighting for error messages

ERRIntensify WD Should error messages be intensified?

ERRLastLine WD Display error messages on the last line?

ErrorIsolation FD Error isolation

ESMLoad RD Do you want to use an External Security Manager?

ESMModule RD Name of ESM Module

Exclude MD Monitoring identifiers to be excluded

ExtDS WD Is BMS to generate extended data streams?

ExternalTrace RD External trace facility required?

ExtrapartitionFile TDD Filename or path for EP queue data file

FacilityId TDD System/Terminal for a triggered task

FacilityType TDD Type of facility allocated for triggered task

FieldLength1 SCD Field 1 - Length

FieldLength20 SCD Field 20 - Length

FieldName1 SCD Field 1 - Name

FieldName20 SCD Field 20 - Name

FieldType1 SCD Field 1 - Type

FieldType20 SCD Field 20 - Type

FileProtection FD Protection level per OFD

FileRSLCheck RD Type of RSL checking for Files

FileServer FD File Server

FileSystemType RD Type of file system

FileType SCD CICS File Type

Foreground WD Is foreground color supported?

GatewayCDSName GD CDS path name of the gateway

GatewayLUName GD SNA LU name of the gateway

GatewayName CD Gateway Definition (GD) entry name

GatewayPrincipal GD DCE principal under which this gateway runs

GroupName CD, FD,GD, JD,LD, PD,TD, TDD,TSD, UD,WD,XAD

Group to which resource belongs

Groups RD Startup groups

Highlight WD Does terminal support highlighting?

HTMLBrowser RD HTML Browser for help text

IdleTimeout SSD Idle timeout

Include MD Monitoring identifiers to be included

IndexFieldDescenders1 SCD Secondary Index 1 - Descending Fields

IndexFieldDescenders10 SCD Secondary Index 10 - Descending Fields

IndexFieldNames1 SCD Secondary Index 1 - Field Names

IndexFieldNames10 SCD Secondary Index 10 - Field Names

IndexName FD Server Index Name

IndexName1 SCD Secondary Index 1 - Name

IndexName10 SCD Secondary Index 10 - Name

IndexPreallocatePages1 SCD SFS ONLY: Secondary Index 1 - Preallocated Pages

IndexPreallocatePages10 SCD SFS ONLY: Secondary Index 10 - Preallocated Pages

IndexUnique1 SCD Secondary Index 1 - Is it Unique?

IndexUnique10 SCD Secondary Index 10 - Is it Unique?

IndexVolumeName1 SCD SFS ONLY: Secondary Index 1 - Volume Name

IndexVolumeName10 SCD SFS ONLY: Secondary Index 10 - Volume Name

IndirectQueueId TDD Indirect Queue Name

InDoubt TD Effect of FORCEPURGE for InDoubt transactions

InitialOpenFlag JD Open journal on region startup?

InService CD Set connection in service?

IntrospectInterval RD Interval between region consistency checks (mins)

IntrospectLevel RD Level of checking to perform on region

InvocationMode TD Contexts in which transaction can START

IOMode TDD Input/Output Mode of EP Queue

IsBackEndDTP TD Is back end of a DTP transaction?

ISCDelayMinutes RD Retransmission interval for queued ATIs (mins)

IsPrinter WD Is this an output only device?

IsShippable WD Is terminal definition shippable?

JournalRSLCheck RD Type of RSL checking for Journals

Katakana WD Does terminal support Katakana?

KeyLen FD Key length to use with remote requests

LinkUserId CD UserId for inbound requests

ListenerName CD Listener Definition (LD) entry name

LoadDataNumBuckets RD Number of LOADed data Address Hash Buckets

LocalLUName RD Local LU name

LocalNetworkName RD Network name to which local region is attached

LocalQ TD Locally Queue ATI requests for this transaction?

LocalQFile RD SFS file for Locally-Queued Unprotected STARTs

LocalQIndex RD SFS Index for Locally-Queued Unprotected STARTs

LocalQMaxRecs RD Maximum number of records for Local Qs

LocalQPrePages RD Number of pages to preallocate for LocalQFile

LocalQProtectFile RD SFS file for Locally-Queued Protected STARTs

LocalQProtectIndex RD SFS Index for Locally-Queued Protected STARTs

LocalQProtection RD Min protect level for locally queued ATIs

LocalQProtectMaxRecs RD Maximum number of records for Locally-Queued ProtectedSTARTs

LocalQProtectPrePages RD Number of pages to preallocate for LocalQProtectFile

LocalQProtectProtection RD Min protect level for locally queued PROTECT ATIs

LocalQProtectVol RD Locally-Queued Protected START Volume Name

LocalQVol RD Local Q Volume Name

LocalSysId RD Region system identifier (short name)

LogFile SSD Log File Name

LogicalTDQFile RD SFS file storing Logically Recoverable TDQs

LogicalTDQIndex RD SFS Index for Logically Recoverable TDQs

LogicalTDQMaxRecs RD Maximum number of records for Logically RecoverableTDQs

LogicalTDQPrePages RD Number of pages to preallocate for LogicalTDQFile

LogicalTDQProtection RD Min protect level for logical TDQs

LogicalTDQVol RD Logically Recoverable TDQ Volume Name

LogVolume GSD, SSD AIX logical volume for logging

MaxConsoleSize RD Maximum Console size

MaxRecords SCD SFS ONLY: Maximum Number of Records

MaxRegionPool RD Region Pool Storage Size (bytes)

MaxServer RD Maximum number of Application Servers to maintain

MaxTaskCPUAction RD TD CICS on Open Systems

MaxTaskCPU RD TD CICS on Open Systems

MaxTaskPrivatePool RD Task-private Storage Size (bytes)

MaxTSHPool RD Task Shared Pool Storage Size (bytes)

MinServer RD Minimum number of Application Servers to maintain

ModelId WD Autoinstall Model Identifier

Modifiable RD Protect resource from modification?

MD Protect the resource from modification?

MonitorStatus MD Set monitoring on?

MRAArchivingEnabled SSD Enable MRA Archiving?

NamedPipeName (CICS forWindows NT)

LD local Named Pipe name

NameService GSD, SSD Name Service for advertising server

RD Use DCE Name Service (CDS) to locate CICS and Encinaservers?

NetName WD NetName of the shell terminal

NonRecTDQFile RD SFS file storing Non-Recoverable TDQs

NonRecTDQIndex RD SFS Index for Non-Recoverable TDQs

NonRecTDQMaxRecs RD Maximum number of records for Non-recoverable TDQs

NonRecTDQPrePages RD Number of pages to preallocate for NonRecTDQFile

NonRecTDQProtection RD Min protect level for non-recoverable TDQs

NonRecTDQVol RD Non-recoverable TDQ Volume Name

NonRecTSQFile RD SFS file storing Non-Recoverable Auxiliary TSQs

NonRecTSQIndex RD SFS Index for Non-Recoverable Auxiliary TSQs

NonRecTSQMaxRecs RD Maximum number of records for Non-recoverable TSQs

NonRecTSQPrePages RD Number of pages to preallocate for NonRecTSQFile

NonRecTSQProtection RD Min protect level for non-recoverable TSQs

NonRecTSQVol RD Non-recoverable TSQ Volume Name

NumColumns WD Number of columns on terminal

NumLines WD Number of lines on terminal

OpenMode TDD Open EP output files truncated or append

OpenStatus FD File open status

OpID UD Operator ID

OpThreadPoolSize SSD Number of threads devoted to normal operations

OutboundUserIds CD Send userids on outbound requests?

Outline WD Does terminal support field outlining?

OutService WD Set terminal out of service?

PathName PD Program path name

PCDump RD Should CICS system be dumped for ASRA abends?

Permanent CD, FD,GD, GSD,JD, LD,PD, SCD,SSD, TD,TDD,TSD, UD,WD,XAD

Protect resource from modification?

PhysicalTDQFile RD SFS file storing Physically Recoverable TDQs

PhysicalTDQIndex RD SFS Index for Physically Recoverable TDQs

PhysicalTDQMaxRecs RD Maximum number of records for Physically RecoverableTDQs

PhysicalTDQPrePages RD Number of pages to preallocate for PhysicalTDQFile

PhysicalTDQProtection RD Min protect level for physical TDQs

PhysicalTDQVol RD Physically Recoverable TDQ Volume Name

PreallocatePages SCD SFS ONLY: Number of Pages to Preallocate

PrePages FD Number of pages to preallocate

PrimaryIndexDescenders SCD Descending Field Names for Primary Index

PrimaryIndexFields SCD Field Names for Primary Index

PrimaryIndexName SCD Primary Index Name

PrimaryIndexUnique SCD Is Primary Index Unique?

Principal UD DCE principal of the user

Priority WD Terminal priority

TD Transaction Priority

UD User priority

ProgName TD First program name

ProgramCacheSize RD Maximum number of C or IBM COBOL programs that canbe cached

ProgramRSLCheck RD Type of RSL checking for Programs

ProgramSymbols WD Program Symbols

ProgType PD Program type

ProtectionLevel GSD, SSD Protection level

ProtectPurgeDelayPeriod RD Purge delay period for PROTECT requests (hours)

Protocol LD Protocol type

PublicUserTraceFile RD User Trace file or path for guest logins

Purgeability TD Transaction purgeability

PurgeDelayPeriod RD Purge delay period for no PROTECT requests (hours)

RDBMSInstance RD The RDBMS Instance name

ReadOpt FD Read access status

RecordLen TDD Record length for fixed length EP queue

RecordSize FD Record length to use with remote requests

RecordTerminator TDD ASCII value of terminator for fixed length queue

RecordType TDD Record organization for EP queue data file

RecoverFlag TSD Is queue recoverable?

RecoverStatus FD Recoverability status

RecoveryType TDD Recoverability type of IP queue

RecTSQFile RD SFS file storing Recoverable Auxiliary TSQs

RecTSQIndex RD SFS Index for Recoverable Auxiliary TSQs

RecTSQMaxRecs RD Maximum number of records for Recoverable AuxiliaryTSQs

RecTSQPrePages RD Number of pages to preallocate for RecTSQFile

RecTSQProtection RD Min protect level for recoverable TSQs

RecTSQVol RD Recoverable Auxiliary TSQ Volume Name

RegionPoolBase RD Region Pool base register

RegionPoolThreshold RD Threshold for Region Pool short on storage (%age)

ReleaseNum RD CICS Release Number

RemoteCodePageTR CD Code page for transaction routing

RemoteLUName CD Name of remote system

RemoteName PD Name to use for program on remote system

FD Remote filename

TDD,TSD

Remote Queue Name

TD Remote Transaction Identifier

WD Terminal identifier on remote system

RemoteNetworkName CD SNA network name for the remote system

RemoteSysEncrypt CD Transmission encryption level

RemoteSysId TD, TDD,TSD

Remote System Identifier

FD Remote System Name

PD Remote system on which to run program

WD System to which terminal belongs

RemoteSysSecurity CD Security level for inbound requests

RemoteTCPAddress CD TCP address for the remote system

RemoteTCPPort CD TCP port number for the remote system

Resident PD Is this a program that should be cached?

ResourceDescription CD, FD,GD, GSD,JD, LD,MD, PD,RD, SCD,SSD, TD,TDD,TSD, UD,WD,XAD

Resource description

ResThreadPoolSize SSD Number of threads devoted to resource operations

RPCListenerThreads RD Number of threads for RPC requests

RSLCheck TD Type of RSL Checks

RSLKey FD, JD,PD, TD,TDD,TSD

Resource Level Security Key

RSLKeyList UD, WD Resource Level Security Key List

RSLKeyMask CD Resource Security Level (RSL) Key Mask

RuntimeProtection RD Min protect level used when accepting RPCs

SafetyLevel RD Level of protection against user corruption

ServerIdleLimit RD Time before Application Servers terminate (secs)

ServerSideTran RD Server side transactions only ?

ShortName GSD, SSD Short name used for SRC

ShutdownProgList1 RD Programs to execute at phase 1 of shutdown

ShutdownProgList2 RD Programs to execute at phase 2 of shutdown

SNAConnectName CD SNA profile describing the remote system

SNADefaultModeName GSD SNA default mode name (HP only)

SNAModeName TD SNA modename for this transaction

SNAServerNodeName LD local SNA Node Name

SOSI WD Does terminal support SOSI

StartType GSD, SSD Cold or auto start?

RD Startup type

StartupProgList RD Programs to execute at startup

StatFile RD File or path for statistics

StatsRecord RD Should stats be recorded at every interval?

SufficesSupported RD Should map names be suffixed?

SwitchLoadFile XAD Switch Load File Path Name

Syncpoint TD Type of Syncpoint Flows

SysDump RD System dump on shutdown, SNAP dumps, ASRx abends?

SysTraceBufferSize RD System trace buffer size

TaskSharedPoolBase RD Task Shared Pool base register

TaskSHNumBuckets RD Number of Task Shared Pool Address Hash Buckets

TaskShPoolThreshold RD Threshold for TSH Pool short on storage (%age)

TClass TD The class of transaction

TCPAddress LD TCP adapter address

TCPService LD TCP service name

TCTUALen WD Length of TCTUA

TDPurgeInterval RD Interval, in minutes, indicating the time between purging ofread records in the transient data queues by theCICS-private transaction CTDP

TDQ MD TDQ to hold monitoring information

TemplateDefined FD, PD,TD, TDD,TSD

Is a user conversion template defined?

TemporaryStorageRSLCheck RD Type of RSL checking for TSQs

TerminalProtection WD Protection level

TermSubType WD Terminal subtype

TermType WD Terminal type

ThreadPoolSize GSD Number of threads for RPC requests

Timeout TD Conversational timeout value (mins)

TPNSNAProfile TD SNA TPN profile for APPC listener program

Trace RD Modules to trace

TraceFile UD User Trace filename

TraceFileA RD File or path (A) for system trace

TraceFileB RD File or path (B) for system trace

TraceFileSize RD Maximum system trace file size

TraceModules RD Module list for partial trace

TransactionRSLCheck RD Type of RSL checking for Transactions

TransDump TD Should transaction be dumped on an abend?

TransDumpTrace RD Transaction Dump Trace

TransId PD Transaction name on remote system for program

TransientDataRSLCheck RD Type of RSL checking for TDQs

TriggeredTransId TDD Triggered Transaction Identifier

TriggerLevel TDD Trigger Level

TSLCheck TD Type of TSL Checks

TSLKey TD Transaction Level Security Key

TSLKeyList UD, WD Transaction Level Security Key List

TSLKeyMask CD Transaction Security Level (TSL) Key Mask

TSQAgeLimit RD Expiry limit for unaccessed TSQs (days)

TWASize TD Transaction Work Area Size

UCTranFlag TD Should data be converted to uppercase?

WD Should terminal convert data to uppercase?

UpdateOpt FD Update access status

UserExitNumber PD User Exit number

UserID GSD, SSD AIX user ID for server

UserMonitorModule MD File or path of user monitoring program

UserTraceDirectory RD User trace directory

Validation WD Does terminal support field validation?

VariableFieldLength SCD Variable Field - Length

VariableFieldName SCD Variable Field - Name

VariableFieldType SCD Variable Field - Type

VolumeName SCD SFS ONLY: Volume Name

WhenOpened TDD Time at which queue is to be opened

XAClose XAD Resource Manager Termination String

XAOpen XAD Resource Manager Initialization String

XASerialize XAD Resource Manager Serialization Attribute

Bibliography

v CICS Administration Guide

v CICS Intercommunication Guide, SC09-4462v CICS Application Programming Guide,

SC09-4460v CICS Problem Determination Guide,

SC09-4465v Encina Administration Guide Volume 2:

Server Administration, SC09-4474v Concepts and Facilities, SC09-4455v CICS Application Programming Reference,

SC09-4461v Planning and Installation Guide

v CICS Clients: Administration, SC33-1792v Encina Administration Guide Volume 1:

Basic Administration, SC09-4473v Using IBM Communications Server for AIX

with CICS, SC09-4469v Using IBM Communications Server for

Windows NT with CICS, SC09-4470v Using Microsoft SNA Server with CICS,

SC09-4471v Using SNAP-IX for Solaris with CICS,

SC09-4472v Using HP-UX SNAplus2 with CICS

v VTAM Messages and Codes

v SNA Formats

v Conventional LUA Programming Reference

v SNA Formats

v VTAM Messages and Codes

v SNA Formats

v Conventional LUA Programming Reference

v SNA Formats

v CICS IIOP ORB Programming Guide,SC09-4467

v CICS Administration Reference, SC09-4459

v CICS Family: Client/Server Programming,SC33-1435

Notices

This information was developed for products and services offered in theU.S.A. IBM may not offer the products, services, or features discussed in thisdocument in other countries. Consult your local IBM representative forinformation on the products and services currently available in your area. Anyreference to an IBM product, program, or service is not intended to state orimply that only that IBM product, program, or service may be used. Anyfunctionally equivalent product, program, or service that does not infringeany IBM intellectual property right may be used instead. However, it is theuser’s responsibility to evaluate and verify the operation of any non-IBMproduct, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not giveyou any license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact theIBM Intellectual Property Department in your country or send inquiries, inwriting, to:

IBM World Trade Asia Corporation Licensing2-31 Roppongi 3-chome, Minato-kuTokyo 106, Japan

The following paragraph does not apply to the United Kingdom or anyother country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISDOCUMENT “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OR CONDITIONS OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Somestates do not allow disclaimer of express or implied warranties in certaintransactions, 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 willbe incorporated in new editions of the document. IBM may make

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 forconvenience only and do not in any manner serve as an endorsement of thoseWeb sites. The materials at those Web sites are not part of the materials forthis 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 itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for thepurpose of enabling: (i) the exchange of information between independentlycreated programs and other programs (including this one) and (ii) the mutualuse of the information which has been exchanged, should contact:

For Component Broker:IBM CorporationDepartment LZKS11400 Burnet RoadAustin, TX 78758U.S.A.

For TXSeries:IBM CorporationATTN: Software Licensing11 Stanwix StreetPittsburgh, PA 15222U.S.A.

Such information may be available, subject to appropriate terms andconditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM InternationalProgram License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environmentsmay vary significantly. Some measurements may have been made ondevelopment-level systems and there is no guarantee that these measurementswill be the same on generally available systems. Furthermore, somemeasurements may have been estimated through extrapolation. Actual resultsmay vary. Users of this document should verify the applicable data for theirspecific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available

sources. IBM has not tested those products and cannot confirm the accuracyof performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should beaddressed to the suppliers of those products.

All statements regarding IBM’s future direction or intent are subject to changeor withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples mayinclude the names of individuals, companies, brands, and products. All ofthese names are fictitious and any similarity to the names and addresses usedby an actual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

Trademarks and service marks

The following terms are trademarks or registered trademarks of the IBMCorporation in the United States, other countries, or both:

AFSAIXAS/400CICSCICS OS/2CICS/400CICS/6000CICS/ESACICS/MVSCICS/VSECICSPlexDB2DCE Encina Lightweight ClientDFSEncinaIBM

IMSMQSeriesMVS/ESAOS/2OS/390OS/400PowerPCRISC System/6000RS/6000S/390TransarcTXSeriesVSE/ESAVTAMVisualAgeWebSphere

Microsoft, Windows, Windows NT, and the Windows 95 logo are trademarksof Microsoft Corporation in the United States and/or other countries.

Oracle and Oracle8 are registered trademarks of the Oracle Corporation in theUnited States and/or other countries.

Notices 535

UNIX is a registered trademark of The Open Group in the United Statesand/or other countries licensed exclusively through X/Open CompanyLimited.

OSF and Open Software Foundation are registered trademarks of the OpenSoftware Foundation, Inc.

* HP-UX is a Hewlett-Packard branded product. HP, Hewlett-Packard, andHP-UX are registered trademarks of Hewlett-Packard Company.

Orbix is a registered trademark and OrbixWeb is a trademark of IONATechnologies Ltd.

Sun, SunLink, Solaris, SunOS, Java, all Java-based trademarks and logos, NFS,and Sun Microsystems are trademarks or registered trademarks of SunMicrosystems, Inc. in the United States and/or other countries.

Some of this documentation is based on material from Object ManagementGroup bearing the following copyright notices:

Copyright 1995, 1996 AT&T/NCRCopyright 1995, 1996 BNR Europe Ltd.Copyright 1991, 1992, 1995, 1996 by Digital Equipment CorporationCopyright 1996 Gradient Technologies, Inc.Copyright 1995, 1996 Groupe BullCopyright 1995, 1996 Expersoft CorporationCopyright 1996 FUJITSU LIMITEDCopyright 1996 Genesis Development CorporationCopyright 1989, 1990, 1991, 1992, 1995, 1996 by Hewlett-Packard CompanyCopyright 1991, 1992, 1995, 1996 by HyperDesk CorporationCopyright 1995, 1996 IBM CorporationCopyright 1995, 1996 ICL, plcCopyright 1995, 1996 Ing. C. Olivetti &C.SpCopyright 1997 International Computers LimitedCopyright 1995, 1996 IONA Technologies, Ltd.Copyright 1995, 1996 Itasca Systems, Inc.Copyright 1991, 1992, 1995, 1996 by NCR CorporationCopyright 1997 Netscape Communications CorporationCopyright 1997 Northern Telecom LimitedCopyright 1995, 1996 Novell USGCopyright 1995, 1996 02 TechnolgiesCopyright 1991, 1992, 1995, 1996 by Object Design, Inc.Copyright 1991, 1992, 1995, 1996 Object Management Group, Inc.Copyright 1995, 1996 Objectivity, Inc.Copyright 1995, 1996 Oracle CorporationCopyright 1995, 1996 Persistence Software

Copyright 1995, 1996 Servio, Corp.Copyright 1996 Siemens Nixdorf Informationssysteme AGCopyright 1991, 1992, 1995, 1996 by Sun Microsystems, Inc.Copyright 1995, 1996 SunSoft, Inc.Copyright 1996 Sybase, Inc.Copyright 1996 Taligent, Inc.Copyright 1995, 1996 Tandem Computers, Inc.Copyright 1995, 1996 Teknekron Software Systems, Inc.Copyright 1995, 1996 Tivoli Systems, Inc.Copyright 1995, 1996 Transarc CorporationCopyright 1995, 1996 Versant Object Technology CorporationCopyright 1997 Visigenic Software, Inc.Copyright 1996 Visual Edge Software, Ltd.

Each of the copyright holders listed above has agreed that no person shall bedeemed to have infringed the copyright in the included material of any suchcopyright holder by reason of having used the specification set forth herein orhaving conformed any computer software to the specification.

WHILE THE INFORMATION IN THIS PUBLICATION IS BELIEVED TO BEACCURATE, THE OBJECT MANAGEMENT GROUP, AND THECOMPANIES LISTED ABOVE MAKE NO WARRANTY OF ANY KIND WITHREGARDS TO THIS MATERIAL INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE. The Object Management Group and the companieslisted above shall not be liable for errors contained herein or for incidental orconsequential damages in connection with the furnishing, performance, or useof this material.

This software contains RSA encryption code.

Other company, product, and service names may be trademarks or servicemarks of others.

Notices 537

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 ofcharacters 1

Numerics327x-3 autoinstall model for

cicsteld 504327x-3-E autoinstall model for

cicsteld 504327x-4 autoinstall model for

cicsteld 507327x-5 autoinstall model for

cicsteld 507327x-x-E for cicsteld autoinstall

model 504327x-x for cicsteld autoinstall

model 50497801 autoinstall model 507

Aabbreviations for keywords 276ABDump attribute

region definitions 32ABDUMP parameter

CEMT inquire/setdumpoptions 334

abnormal termination dump 334abnormally terminate user task

(EDF) 315about to execute command

CECI or CECS information 301ACL

set for CICS directories andgroups 219

AcquiredCEMT INQUIRE

FECONNECTION 373

Acquired (continued)CEMT INQUIRE FENODE 379

ActivateOnStartup attributecommunications definitions 2file definitions 9gateway definitions 12journal definitions 16listener definitions 19object definitions 24product definitions 25program definitions 27temporary storage definitions 64terminal definitions 66transaction definitions 74transient data definitions 81user definitions 86

ADD parameterCEMT inquire/set file 335

addindex (DDT command) 135addindex (SDT command) 209AddOpt attribute

file definitions 9aixterm autoinstall model 502aixterm-m autoinstall model 502AKP parameter

CEMT inquire 355ALL parameter

CEMT 326CEMT inquire/set file 335CEMT inquire/set journal 338CEMT inquire/set monitor 339CEMT inquire/set program 342CEMT inquire/set task 344CEMT inquire/set tclass 347CEMT inquire/set tdqueue 348CEMT inquire/set terminal 351CEMT inquire/set

transaction 354AllocateTimeout attribute

communications definitions 2AllowDebugging

region definitions 33AmendCounter attribute

file definitions 9gateway definitions 13gateway server definitions 15journal definitions 17listener definitions 19monitoring definitions 22

AmendCounter attribute (continued)object definitions 24product definitions 25program definitions 27region definitions 33schema file definitions 58SFS definitions 61temporary storage definitions 64terminal definitions 67transaction definitions 74transient data definitions 81user definitions 86

ampersand (CECI) 302Appl

CEMT INQUIREFETARGET 387

Application Diagnosis Configuration(CDCN)

data entry fields 289description of 287overview 273PF (program function) key

values 289reference 287screen layout 288syntax 287

APPLID parameterCEMT inquire 355

archivecopying resource definitions 153restoring resource

definitions 166ASCII multi-byte monochrome

autoinstall model 503ASCII single-byte monochrome

autoinstall model 503ASRA dump 334ASRB dump 334asterisk character (CEMT) 326ATI parameter

CEMT inquire netname 340CEMT inquire/set terminal 351

attribute name – attributedescription cross-reference 507

AuthenticationService attributeregion definitions 33

AutoDCELogin attributeregion definitions 33

autoinstallautoinstall program

parameters 393terminal Autoinstall user

program 390the supplied program 390when the program is

accessed 394autoinstall models 501

327x-3-E for cicsteld 504327x-3 for cicsteld 504327x-4-E for cicsteld 507327x-4 for cicsteld 507327x-5-E for cicsteld 507327x-5 for cicsteld 507327x-x-E for cicsteld 504327x-x for cicsteld 50497801 507aixterm 502aixterm-m 502ASCII multi-byte

monochrome 503ASCII single-byte

monochrome 503dtterm 504dxterm (vt300) 504hp terminal definition 503hpterm definition 503IBM CICS Client 502IBM CICS ECI 502ibm3151 502ibm3161 502ibm3164 502Sun command tool and shell

tool 507vt100 502vt220 504Windowed multi-byte color 503Windowed multi-byte

monochrome 503Windowed single-byte color 503Windowed single-byte

monochrome 503xterm 504

AUTOINSTALL parameterCEMT inquire/set 331

AutoinstallMode attributeregion definitions 33

automatic transaction initiationrestriction with routing

transaction 365Automatic Transaction Initiation

(ATI) 340, 351auxiliary trace

CEMT inquire/set 332, 353

AUXTRACE parameterCEMT inquire/set 332

BBaseName attribute

file definitions 9BASENAME parameter

CEMT FILE 335binding strings 159blank fields in a screen

CEMT 328BROWSE parameter

CEMT inquire/set file 335BrowseOpt attribute

file definitions 9BufferPoolSize attribute

SFS definitions 61

CC programs

caches 31, 45Cached attribute

object definitions 25CALF transaction

data entry fields 283description of 281error screen layout 282information fields 284overview 273PF (program function) key

values 285reference 281screen layout 281, 282, 289status information 285syntax 281

CanStartATIs attributeterminal definitions 67

CanStartTTIs attributeterminal definitions 67

CARPDelayHours attributeregion definitions 33

CD (Communications Definitions) 1CDCN transaction

data entry fields 289description of 287overview 273PF (program function) key

CEBR transactioncommand input area 293description of 292information area 295

CEBR transaction (continued)overview 273PF(program function) key

values 295reference 292screen layout 293syntax 292using the transaction 292

CECI transactioncommand input 299description of 298information area 300invoking 306overview 273PF (program function) key

values 304reference 298screen layout 299, 306, 307security rules 298status area 299syntax 298

CECS 298CECS transaction

command input 299description of 298information area 300invoking 306overview 273PF (program function) key

values 304reference 298screen layout 299, 306security rules 298status area 299syntax 298

CEDF transaction 310description of 309information area 312interception points 316invoking EDF 310overtyping 315overview 273parameters 309PF (program function) key

values 313reference 309screen layout 310, 318security 310status area 312stopping the application

run 318syntax 309

cell_admin_pw environmentvariable 98, 100, 101, 103, 107,110, 115, 117, 119, 122

Cell Directory Serviceconfigure for CICS 218directories for CICS 218

CEMT INQUIRE 328CEMT SET 329CEMT transaction 369

? character 323+ character 326AKP parameter 355APPLID parameter 355AUTOINSTALL parameter 331auxiliary trace 353AUXTRACE parameter 332blank fields in a screen 328command line request 323DATEFORM parameter 355description of 321DISCARD 370DUMP parameter 333DUMPOPTIONS parameter 334FILE parameter 335INQUIRE 323INQUIRE

FECONNECTION 371INQUIRE FENODE 377INQUIRE FEPOOL 381INQUIRE FEPROPSET 384INQUIRE FETARGET 386inquire/set overview 328inquiring about a resource 327INTROINTVL parameter 355invoking 323JOURNAL parameter 338LOCALE parameter 355MAXREGIONPOOL

parameter 356MAXTASKSHPOOL

parameter 356MONITOR parameter 339NETNAME parameter 340OPREL parameter 356OPSYS parameter 356overtyping a screen 327overview 273parameters, overview of 321PERFORM 323PERFORM SNAP 330PF (program function) key

values 325PROGRAM parameter 342prompting for options 323reference 321REGIONTHRESH

parameter 356RELEASE parameter 356

CEMT transaction 369 (continued)request formats 324screen layout 324scrolling a screen 326SET 323syntax 321SYSID parameter 356system parameters 355tab key 328TASK parameter 344TASKTHRESH parameter 356TCLASS parameter 347TDQUEUE parameter 348TERMINAL parameter 351TRACE parameter 353TRANSACTION parameter 354using with CRTE 366

CESF transaction 357description of 357overview 273reference 357syntax 357

CESN transactiondescription of 359overview 274reference 359security 359syntax 359use as initial transaction 248

character restrictions 1Checkpoint attribute

SFS definitions 61CheckpointInterval attribute

region definitions 33CICS (Customer Information Control

System)CICS-supplied transactions 369

CICS clientcicsmigrateclients command 186cicssetupclients command 216

CICS Client Autoinstall 389CICS control program

cicscp command 97CICS_HOSTS environment

variable 122, 159, 228, 250, 253,256

CICS_PPCGWY_SERVERenvironment variable 192

CICS_PPCGWY_SIZE environmentvariable 106

CICS_PPCGWY_VG environmentvariable 106

CICS_SFS_DATA_SIZE environmentvariable 114

CICS_SFS_DATA_VG environmentvariable 114

CICS_SFS_LOG_SIZE environmentvariable 114

CICS_SFS_LOG_VG environmentvariable 114

CICS_SFS_SERVER environmentvariable 203, 227, 494

CICS_SFS_SIZE environmentvariable 114, 493

CICS_SFS_VG environmentvariable 114, 493

CICS-supplied programsCICS Client Autoinstall 389External Security Manager

(ESM) 389function shipping 389Overview 389performance monitoring user

program 389Terminal Autoinstall 389transaction routing 389user conversion programs 389

CICS-supplied transactionscomplete list 278

CICS_SUPPRESS_XAOPEN_STRINGenvironment variable 26, 493

cics_UE_Return_t 408cics_UE014015_t 411cics_UE052017_t 411CICS_XDT_SERVER environment

variable 131, 203cicsadd command 91cicscleandce command 94CICSCOL environment variable 176cicscopystanza command 96cicscp all options 100cicscp COBOL commands 101cicscp command 97cicscp commands

all option 100COBOL commands 101DCE commands 102PPC Gateway server

commands 105region commands 109sfs_server commands 113SNA commands 117SNA link commands 119telnet server commands 121

cicscp DCE commands 102cicscp PPC Gateway server

commands 105cicscp region commands 109cicscp sfs_server commands 113

Index 541

cicscp SNA commands 117cicscp SNA link commands 119cicscp telnet server commands 121cicscvt command 124cicsdb2conf command 46, 126CICSDB2CONF_CONNECT_USER

environment variable 491CICSDB2CONF_CONNECT_USING

environment variable 491cicsdb2import command 129cicsddt command 131cicsddt commands

! 137addindex 135create 133database 136delete 135delindex 135dtof 137empty 135ftod 137help (?) 138info 136list 132qtod 136quit 138read 133user 136write 134

cicsdefault command 142cicsdefaultservers 144cicsdelete command 145cicsdestroy command 148cicsdfmt 150cicsexport command 153cicsget command 156cicsgetbindingstring command 159cicsgpid 161cicshpterm command 162cicsimport command 166cicsimportl 167cicsinstall command 169cicsivp command 171CICSKEY environment variable 176cicslssrc command 173cicslterm command 175cicsmakelv command 178cicsmfmt 179cicsmfmt functions 425

CICS_MFMT_CloseMonitorFile 426CICS_MFMT_FindField 428CICS_MFMT_FreeMessage 428CICS_MFMT_GetMessage 428CICS_MFMT_OpenMonitorFile 426CICS_MFMT_ReadNext 427

cicsmfmt functions 425 (continued)CICS_MFMT_ReleaseCatalogue 428

cicsmigrate command 181cicsmigrateclass command 184cicsmigrateclients command 186cicsmkcobol 187cicsnetdata program 138, 212

running 140, 213cicsnotify 190cicsnotify command 190CICSPassword attribute

user definitions 86cicsppcgwy command 191cicsppcgwycreate command 193cicsppcgwydestroy command 195cicsppcgwylock command 197cicsppcgwyshut command 199cicsprCOBOL 187CICSREGION environment

variable 92, 146, 151, 154, 157,161, 169, 201, 241, 242, 259, 264

cicsremovelv command 200cicsrlck 201cicssdt command 203cicssdt commands

! 211addindex 209create 205delete 208delindex 209empty 208free 208ftos 211help (?) 212info 209list 205qtos 210quit 212read 206server 210setopen 205stof 210write 207

cicssetupclients command 216cicssetupdce command 218cicssfmt 221cicssfmt functions 429cicssfs command 225cicssfsconf command 228cicssfscreate command 230cicssfsdestroy command 233cicssfsimport command 235cicssfslock 237cicssfsshut command 238cicssrcdestroy command 148

cicsstart command 240cicsstop command 242cicstail command 243cicstcpnetname command 245cicsteld command 247cicsterm command 251CICSTERM environment

variable 254cicstermp command 255cicstfmt 258cicstracefilter 261cicsupdate command 263cicsupdateclass command 267cicsusedceservers command 270CICSUserId attribute

listener definitions 19ClassMaxTaskLim attribute

region definitions 34ClassMaxTasks attribute

region definitions 34ClassTableSize attribute

region definitions 35CLINTCP option on DFHCNV

macro 249CLOSED parameter

CEMT inquire/set file 335CEMT inquire/set journal 338CEMT inquire/set tdqueue 348

CMLV transactiondescription of 362overview 274PF (program function) key

values 362reference 362syntax 362

COBDIR environment variable 188COBLIB environment variable 188COBOL

setting up for Micro FocusCOBOL 187

COBSW environment variable 342code page, specifying 247CollatingLanguage attribute

SFS definitions 61command execution complete

CECI or CECS information 302Command Level Interpreter (CECI)

values 304reference 298

Command Level Interpreter (CECI)(continued)

screen layout 299, 306, 307security rules 298status area 299syntax 298

command syntax checkCECI or CECS information 301

commandName parameterCECI and CECS

transactions 298commands

3270 terminal emulation 175,251

CEMT DISCARD 370cicsadd 91cicscleandce 94cicscp 97cicscp all 100cicscp COBOL 101cicscp DCE 102cicscp PPC Gateway server 105cicscp region 109cicscp sfs_server 113cicscp SNA 117cicscp SNA link 119cicscp telnet server 121cicscvt 124cicsdb2conf 126cicsdb2import 129cicsddt 131cicsdefault 142cicsdelete 145cicsdestroy 148cicsdfmt 150cicsexport 153cicsget 156cicsgetbindingstring 159cicsgpid 161cicsimport 166cicsinstall 169cicsivp 171cicslssrc 173cicslterm 175cicsmakelv 178cicsmfmt 179cicsmkcobol 187cicsnotify 190cicsppcgwy 191cicsppcgwycreate 193cicsppcgwydestroy 195cicsppcgwyshut 199cicsremovelv 200cicssdt 203cicssetupdce 218

commands (continued)cicssfmt 221cicssfs 225cicssfsconf 228cicssfscreate 230cicssfsdestroy 233cicssfsimport 235cicssfslock 237cicssfsshut 238cicsstart 240cicsstop 242cicstail 243cicstcpnetname 245cicsteld 247cicsterm 251cicstfmt 258cicstracefilter 261cicsupdate 263cicsusedceservers 270

Commands3270 terminal emulation 162cicshpterm 162cicsppcgwylock 197

Communications Definitions (CD) 1configuring DB2

cicsdb2conf command 126configuring SFS

cicssfsconf command 228ConnectionType attribute

communications definitions 2Console Message Log Viewer

(CMLV)description of 362overview 274reference 362syntax 362

constants for user exits 408Control Panel

Language setting 248Conversational attribute

monitoring definitions 22copying a region 153CoreDumpName attribute

region definitions 35create (DDT command) 133create (SDT command) 205CRTE transaction

automatic transactioninitiation 365

description of 364overview 274reference 364syntax 364SYSID parameter 364using with CEMT 366

CrucialFlag attributejournal definitions 17

CSSF 357CSSF transaction 357

description of 357overview 274reference 357syntax 357

CSTD transactiondescription of 367overview 274PF (program function) key

CUBSDelayMinutes attributeregion definitions 35

CWASize attributeregion definitions 35

DData Conversion (CALF)

data entry fields 283description of 281error screen layout 282information fields 284overview 273PF (program function) key

values 285reference 281screen layout 281, 282, 289status information 285syntax 281

database (DDT command) 136DATASET parameter

CEMT inquire/set journal 338DataVolume attribute

SFS definitions 61DateForm attribute

region definitions 35DATEFORM parameter

CEMT inquire 355DB2 Diagnostic Tool

cicsddt command 131DB2DBDFT environment

variable 129, 131DB2INSTANCE environment

variable 46DCE

CDS 270configure for CICS 218DCE client 186deleting CICS directories and

groups 94

Index 543

DCE (continued)directory service 159security services 270

DCECell attributecommunications definitions 3gateway definitions 13user definitions 86

DDT commands! 137addindex 135create 133database 136delete 135delindex 135dtof 137empty 135ftod 137help (?) 138info 136list 132QSAM to DB2 file transfer 138qtod 136quit 138read 133user 136write 134

DeadLockTimeout attributetransaction definitions 74

deallocating resources 190debugging a remote transaction 310debugging tool

EDF 309default region

copying 142dump directory 150

DefaultFileServer attributeregion definitions 54

DefaultSNAModeNamecommunications definitions 3

DefaultUserId attributeregion definitions 35

defining and managing resourcesCommunications Definitions

(CD) 1File Definitions (FD) 8Gateway Definitions (GD) 12Gateway Server Definitions

(GSD) 14Journal Definitions (JD) 16Listener Definitions (LD) 19Monitoring Definitions (MD) 21object definitions 24Product Definitions (XAD) 25Program Definitions (PD) 27Region Definitions (RD) 32

defining and managing resources(continued)

Region Definitions for file server(RD) 54

Temporary Storage Definitions(TSD) 64

Terminal Definitions (WD) 66Transaction Definitions (TD) 73Transient Data Definitions

(TDD) 81User Definitions (UD) 85

definition files used by qtod 140definition files used by qtos 214delete (DDT command) 135delete (SDT command) 208DELETE parameter

CEMT inquire/set file 336DeleteOpt attribute

file definitions 9delindex (DDT command) 135delindex (SDT command) 209DEST parameter

CEMT inquire/set task 344destid parameter

CEMT inquire/set tdqueue 348DestType attribute

transient data definitions 81Device

CEMT INQUIRE FEPOOL 383DevType attribute

terminal definitions 67DFHCHATX, terminal autoinstall

program 391DFHCNV macro

CLINTCP option 249conversion by cicscvt 124SRVERCP option 249

DISABLED parameterCEMT inquire/set file 336CEMT inquire/set tdqueue 348CEMT inquire/set

transaction 354DiskA attribute

journal definitions 17DiskAStatus attribute

journal definitions 17DiskB attribute

journal definitions 17DiskBStatus attribute

journal definitions 18DISPATCHABLE parameter

CEMT inquire/set task 344dtof (DDT command) 137dtterm autoinstall model 504dual screen mode (EDF) 320

dumpCEMT 334CEMT requests 330

dump formatter command 150DUMP parameter

CEMT 330CEMT inquire/set 333

dump request user exit (17) 411dump statistics 441DumpName attribute

region definitions 36DUMPOPTIONS parameter

CEMT inquire/set 334dxterm (vt300) autoinstall

model 504Dynamic attribute

transaction definitions 74dynamic distributed program link

user exit (50) 418dynamic transaction routing user

exit (25) 413

EECIPasswordCacheSeconds

region definitions 36EDF 309, 310

dual screen mode 320information area 312interception points 316invoking 310overtyping 315parameters 309PF (program function) key

values 313screen layout 310, 318security 310status area 312stopping the application

run 318empty (DDT command) 135empty (SDT command) 208emptying journals 17emptying transient data queues 83EmptyOpt attribute

file definitions 9ENABLED parameter

CEMT inquire/set file 336CEMT inquire/set tdqueue 348CEMT inquire/set

transaction 354EnableStatus attribute

file definitions 9program definitions 28transaction definitions 75

ENCINA_BINDING_FILEenvironment variable 159, 203

Encina SFS 159, 270ENCINA_SFS_SERVER environment

variable 493encryption 5environment variables 491

cell_admin_pw 98, 100, 101, 103,107, 110, 115, 117, 119, 122

CICS_HOSTS 122, 159, 228, 250,253, 256

CICS_PPCGWY_SERVER 192CICS_PPCGWY_SIZE 106CICS_PPCGWY_VG 106CICS_SFS_DATA_SIZE 114CICS_SFS_DATA_VG 114CICS_SFS_LOG_SIZE 114CICS_SFS_LOG_VG 114CICS_SFS_SERVER 203, 227, 494CICS_SFS_SIZE 114, 493CICS_SFS_VG 114, 493CICS_SUPPRESS_XAOPEN_STRING 26,

493CICS_XDT_SERVER 131, 203CICSCOL 176CICSDB2CONF_CONNECT_USER 491CICSDB2CONF_CONNECT_USING 491CICSKEY 176CICSREGION 92, 146, 151, 154,

157, 161, 169, 201, 241, 242, 259,264

CICSTERM 254COBDIR 188COBLIB 188COBSW 342DB2DBDFT 129, 131DB2INSTANCE 46ENCINA_BINDING_FILE 159,

203ENCINA_SFS_SERVER 493LANG 248, 254LD_LIBRARY_PATH 188LIBPATH 188LOGNAME 259PATH 188SHLIB_PATH 188TERM 254XID_NODE_ID 119

ERRColor attributeterminal definitions 67

ERRHilight attributeterminal definitions 67

ERRIntensify attributeterminal definitions 68

ERRLastLine attributeterminal definitions 68

ErrorIsolation attributefile definitions 9

ESM (External SecurityManager) 389

ESMLoad attributeregion definitions 37

ESMModule attributeregion definitions 37

Exclude attributemonitoring definitions 22

exec interface blockCECI or CECS information 302

Execution Diagnostic Facility (CEDF)description of 309information area 312interception points 316invoking EDF 310overtyping 315overview 273parameters 309PF (program function) key

values 313reference 309screen layout 310, 318security 310status area 312stopping the application

run 318syntax 309

Execution Diagnostic Facility (EDF)dual screen mode 320information area 312interception points 316invoking 310overtyping 315parameters 309PF (program function) key

values 313screen layout 310, 318security 310security rules 310status area 312stopping the application

run 318EXIT parameter 357expansion of

CECI or CECS information 304ExtDS attribute

terminal definitions 68External Security Manager

(ESM) 389The supplied program 395

ExternalTrace attributeregion definitions 37

EXTRA parameterCEMT inquire/set tdqueue 348

ExtrapartitionFile attributetransient data definitions 81

FFACILITY parameter

CEMT inquire/set task 344FacilityId attribute

transient data definitions 81FacilityType attribute

transient data definitions 82FD (File Definitions) 8Feno

CEMT INQUIRE FENODE 378FENODE option

CEMT DISCARD command 370FEPI

CICS-supplied transactions 369operator control 369

FepoCEMT INQUIRE FEPOOL 382

FEPOOL optionCEMT DISCARD 370

FeprCEMT INQUIRE

FEPROPSET 384FEPROPSET option

CEMT DISCARD 370CEMT INQUIRE

FEPROPSET 385Feta

CEMT INQUIREFETARGET 387

FETARGET optionCEMT DISCARD 370

FieldLength1 attributeschema file definitions 58

FieldName1 attributeschema file definitions 58

FieldType1 attributeschema file definitions 58

filestatistics 442

File Definitions (FD) 8FILE parameter

CEMT inquire/set 335filename parameter

CEMT FILE 335FileProtection attribute

file definitions 10FileRSLCheck attribute

region definitions 37files

CEMT inquire/set 335

Index 545

FileServer attributefile definitions 10

FILESERVER parameterCEMT inquire/set file 336

FileSystemType attributeregion definitions 37

FileType attributeschema file definitions 58

FORCEPURGE parameterCEMT inquire/set task 345

Foreground attributeterminal definitions 68

free (SDT command) 208Freeing

CEMT INQUIREFECONNECTION 374

CEMT INQUIRE FENODE 380ftod (DDT command) 137ftos (SDT command) 211

GGateway Definitions (GD) 12Gateway Server Definitions

(GSD) 14GatewayCDSName attribute

gateway definitions 13GatewayLUName attribute

gateway definitions 13GatewayName attribute

communications definitions 3GatewayPrincipal attribute

gateway definitions 14GD (Gateway Definitions) 12Goingout

CEMT INQUIRE FENODE 379CEMT INQUIRE FEPOOL 383CEMT INQUIRE

FETARGET 388GOODNIGHT parameter 357GroupName attribute

communications definitions 3file definitions 10gateway definitions 14journal definitions 18listener definitions 19object definitions 24product definitions 25program definitions 28temporary storage definitions 64terminal definitions 68transaction definitions 75transient data definitions 82user definitions 86

Groups attributeregion definitions 37

GSD (Gateway ServerDefinitions) 14

Hhelp (DDT command) 138help (SDT command) 212Highlight attribute

terminal definitions 68hp terminal definition autoinstall

model 503hpterm definition autoinstall

model 503HTMLBrowser attribute

region definitions 37

IIBM CICS Client autoinstall

model 502IBM CICS ECI autoinstall

model 502IBM COBOL programs

caches 31, 45ibm3151 autoinstall model 502ibm3161 autoinstall model 502ibm3164 autoinstall model 502IdleTimeout attribute

SFS definitions 61IIOP resource definitions 24IIOPGroupHost attribute

region definitions 38IIOPGroupPort attribute

region definitions 38IIOPGroupSSLPort attribute

region definitions 38IIOPGroupUUID attribute

region definitions 38IIOPObjrefsVersion attribute

region definitions 38IIOPRequestTimeout attribute

region definitions 39ImplementationLanguage attribute

object definitions 25importing DB2

cicsdb2import command 129Include attribute

monitoring definitions 22IndexFieldDescenders1 attribute

schema file definitions 58IndexFieldNames1 attribute

schema file definitions 59IndexName attribute

file definitions 10INDEXNAME parameter

CEMT inquire/set file 336

IndexName1 attributeschema file definitions 59

IndexPreallocatePages attributeschema file definitions 59

IndexUnique1 attributeschema file definitions 59

INDIRECT parameterCEMT inquire/set tdqueue 349

IndirectQueueId attributetransient data definitions 82

InDoubt attributetransaction definitions 75

INDOUBT parameterCEMT inquire/set task 344

INFLIGHT parameterCEMT inquire/set task 344

info (DDT command) 136info (SDT command) 209InitialOpenFlag attribute

journal definitions 18INQUIRE, CEMT

FECONNECTION 371FENODE 377FEPOOL 381FEPROPSET 384FETARGET 386

INQUIRE (CEMT transaction) 328AUTOINSTALL parameter 331AUXTRACE parameter 332DUMP parameter 333DUMPOPTIONS parameter 334FILE parameter 335JOURNAL parameter 338MONITOR parameter 339NETNAME parameter 340overview 321PROGRAM parameter 342system parameters 355task parameter 344TCLASS parameter 347TDQUEUE parameter 348TERMINAL parameter 351TRACE parameter 353TRANSACTION parameter 354

inquire aboutresource 323

INQUIRE keyword, CEMT 323Inservice

FETARGET 387

InService attributecommunications definitions 3

INSERVICE parameterCEMT inquire netname 340CEMT inquire/set terminal 351

installation verification programcicsivp command 171

InstalledCEMT INQUIRE

FECONNECTION 373CEMT INQUIRE FENODE 378CEMT INQUIRE FEPOOL 382CEMT INQUIRE

FETARGET 387intercepting a transaction 316Interface attribute

object definitions 24intersystem communication

(CRTE) 364intersystem communication (ISC)

statistics 445INTRA parameter

CEMT inquire/set tdqueue 349INTROINTVL parameter

CEMT inquire 355IntrospectInterval attribute

region definitions 38IntrospectLevel attribute

region definitions 38InvocationMode attribute

transaction definitions 75invoking

CEMT 323invoking a supplied transaction 274invoking a transaction 274IOMode attribute

transient data definitions 82IsBackEndDTP attribute

transaction definitions 76ISCDelayMinutes attribute

region definitions 39IsPrinter attribute

terminal definitions 68IsShippable attribute

terminal definitions 68

JJD (Journal Definitions) 16Journal Definitions (JD) 16JOURNAL parameter

CEMT inquire/set 338journal statistics 454JournalRSLCheck attribute

region definitions 39journals 17

journals 17 (continued)CEMT inquire/set 338

KKatakana attribute

terminal definitions 69key, tab

CEMT 328KeyLen attribute

file definitions 11keytab file 186, 251keyword, minimum

abbreviation 276

LLacqcode

CEMT INQUIRE FENODE 380LANG environment variable 248,

254Language setting 248LD (Listener Definitions) 19LD_LIBRARY_PATH environment

variable 188LIBPATH environment variable 188link security 6LinkUserId attribute

communications definitions 3list (DDT command) 132list (SDT command) 205Listener Definitions (LD) 19ListenerName attribute

communications definitions 4LoadDataNumBuckets attribute

region definitions 39locale, specifying 247LOCALE parameter

CEMT inquire 355LocalLUName attribute

region definitions 39LocalNetworkName attribute

region definitions 40LocalQ attribute

transaction definitions 76LocalQFile attribute

region definitions 54LocalQIndex attribute

region definitions 54LocalQMaxRecs attribute

region definitions 54LocalQPrePages attribute

region definitions 54LocalQProtectFile attribute

LocalQProtectIndex attributeregion definitions 54

LocalQProtection attributeregion definitions 40

LocalQProtectMaxRecs attributeregion definitions 55

LocalQProtectPrePages attributeregion definitions 55

LocalQProtectProtection attributeregion definitions 40

LocalQProtectVol attributeregion definitions 55

LocalQVol attributeregion definitions 55

LocalSysId attributeregion definitions 41

LogFile attributeSFS definitions 61

Logical Unit name 245LogicalTDQFile attribute

region definitions 55LogicalTDQIndex attribute

region definitions 55LogicalTDQMaxRecs attribute

region definitions 55LogicalTDQPrePages attribute

region definitions 55LogicalTDQProtection attribute

region definitions 41LogicalTDQVol attribute

region definitions 55LOGNAME environment

variable 259LogVolume attribute

gateway server definitions 15SFS definitions 61

LU name 245LUW statistics 457

Mmakefile 179Managed attribute

object definitions 24managing DB2 databases

Schema File Definitions(SCD) 57

managing file serversRegion Definitions for file server

(RD) 54managing resources using RDO

cicsadd command 91cicsdefault command 142cicsdestroy command 148cicsexport command 153cicsget command 156cicsimport command 166

Index 547

managing resources using RDO(continued)

cicsinstall command 169cicsupdate command 263

Managing resources using RDOcicsdelete command 145cicsppcgwy command 191

managing SFScicssfscreate command 230cicssfsdestroy command 233cicssfsimport command 235Structured File Server Definitions

(SSD) 61Managing SFSs

cicssfsshut command 238MapColumn attribute

terminal definitions 69MapHeight attribute

terminal definitions 69MapLine attribute

terminal definitions 69MapWidth attribute

terminal definitions 69master terminal operator

CEMT transaction 324MaxConsoleSize attribute

region definitions 41MaxRecords attribute

schema file definitions 60MaxRegionPool attribute

region definitions 42MAXREGIONPOOL parameter

CEMT inquire 356MaxServer attribute

region definitions 42MAXSERVERS parameter

CEMT inquire/set system 356CEMT inquire/set tclass 347

MaxTaskCPU attributeregion definitions 42transaction definitions 76

MaxTaskCPUAction attributeregion definitions 42

MaxTaskPrivatePool attributeregion definitions 43

MAXTASKSHPOOL parameterCEMT inquire 356

MaxTSHPool attributeregion definitions 43

MD (Monitoring Definitions) 21Micro Focus COBOL

versions supported by CICS 187migrating a region 184, 267migrating a region database 181migrating a server database 181

MinServer attributeregion definitions 43

MINSERVERS parameterCEMT inquire/set system 356CEMT inquire/set tclass 347

model type, specifying 247ModelId attribute

terminal definitions 69Modifiable attribute

monitoring definitions 23region definitions 43

Module attributeobject definitions 24

MONITOR parameter 339CEMT inquire/set 339

monitoring data formatter 179Monitoring Definitions (MD) 21MonitorStatus attribute

monitoring definitions 23MRAArchivingEnabled attribute

SFS definitions 62

NNamedPipeName attribute

listener definitions 19NAMEIND parameter

CEMT inquire/set tdqueue 349NameService attribute

region definitions 44SFS definitions 15, 62

netdata format records 138, 212NETNAME 245NetName attribute

terminal definitions 69NETNAME parameter

CEMT inquire 340CEMT inquire/set terminal 351

networkCEMT inquire 340

NOABDUMP parameterCEMT inquire/set

dumpoptions 334NOADD parameter

CEMT inquire/set file 336NOATI parameter

NOBROWSE parameterCEMT inquire/set file 336

NodeCEMT INQUIRE

FECONNECTION 372CEMT INQUIRE FENODE 378

NODELETE parameterCEMT inquire/set file 336

NonRecTDQFile attributeregion definitions 55

NonRecTDQIndex attributeregion definitions 56

NonRecTDQMaxRecs attributeregion definitions 56

NonRecTDQPrePages attributeregion definitions 56

NonRecTDQProtection attributeregion definitions 44

NonRecTDQVol attributeregion definitions 56

NonRecTSQFile attributeregion definitions 56

NonRecTSQIndex attributeregion definitions 56

NonRecTSQMaxRecs attributeregion definitions 56

NonRecTSQPrePages attributeregion definitions 56

NonRecTSQProtection attributeregion definitions 44

NonRecTSQVol attributeregion definitions 56

NOPCDUMP parameterCEMT inquire/set

dumpoptions 334NOREAD parameter

CEMT inquire/set file 336Notinstalled

FETARGET 387NOTTI parameter

NOUPDATE parameterCEMT inquire/set file 336

NumColumns attributeterminal definitions 70

NumLines attributeterminal definitions 70

OObject definitions

CICS IIOP ORB resourcedefinition 24

ObtainingCEMT INQUIRE

FECONNECTION 374CEMT INQUIRE FENODE 379

OFF parameterCEDF 309CEMT inquire/set

AUXTRACE 332CEMT inquire/set dump 333CEMT inquire/set monitor 339CEMT inquire/set trace 353

offline utilitiescicsdfmt 150cicsgpid 161cicsmfmt 179cicsrlck 201cicssfmt 221cicssfslock 237cicstfmt 258cicstracefilter 261

ON parameterCEDF 309CEMT inquire/set

AUXTRACE 332CEMT inquire/set dump 333CEMT inquire/set monitor 339CEMT inquire/set trace 353

OPEN parameterCEMT inquire/set file 336CEMT inquire/set tdqueue 349

open stringsuppressing 26

OpenMode attributetransient data definitions 82

OpenStatus attributefile definitions 11

Operation attributeobject definitions 24

operator controlcommands 369

OpID attributeuser definitions 86

OPREL parameterCEMT inquire 356

OPSYS parameterCEMT inquire 356

OpThreadPoolSize attributeSFS definitions 62

OrbAdapterDllName attributeobject definitions 24

OutboundUserIds attributecommunications definitions 4

Outline attributeterminal definitions 70

OUTPUT parameterCEMT inquire/set journal 338

OutserviceCEMT INQUIRE

FECONNECTION 373

Outservice (continued)CEMT INQUIRE FENODE 379CEMT INQUIRE FEPOOL 383CEMT INQUIRE

FETARGET 388OutService attribute

terminal definitions 70OUTSERVICE parameter

overtypingCEDF screen 315CEMT screen 327EDF screen 315

PPATH environment variable 188PathName attribute

program definitions 28PCDump attribute

region definitions 44PCDUMP parameter

CEMT inquire/setdumpoptions 334

PD (Program Definitions) 27PERFORM SNAP

CEMT 330performance monitoring user

program 389default performance monitoring

user program 396overview 395program parameters 400when the program is

accessed 406Permanent attribute

communications definitions 4file definitions 11gateway definitions 14gateway server definitions 15journal definitions 18listener definitions 19object definitions 24product definitions 25program definitions 30schema file definitions 60SFS definitions 62temporary storage definitions 65terminal definitions 70transaction definitions 76transient data definitions 83user definitions 87

PF (program function) key valuesCALF 285CDCN 289

PF (program function) key values(continued)

CEBR 295CECI 304CECS 304CEDF 313CEMT 325CMLV 362CSTD 368EDF 313

PhysicalTDQFile attributeregion definitions 56

PhysicalTDQIndex attributeregion definitions 56

PhysicalTDQMaxRecs attributeregion definitions 57

PhysicalTDQPrePages attributeregion definitions 57

PhysicalTDQProtection attributeregion definitions 45

PhysicalTDQVol attributeregion definitions 57

plus character (CEMT) 326Pool

CEMT INQUIRE FEPOOL 382PostScanInterval attribute

region definitions 45PPC Gateway 159, 270PreallocatePages attribute

schema file definitions 60PrePages attribute

file definitions 11PrimaryIndexDescenders attribute

schema file definitions 60PrimaryIndexFields attribute

schema file definitions 60PrimaryIndexName attribute

schema file definitions 60PrimaryIndexUnique attribute

schema file definitions 60Principal attribute

user definitions 87Printer CICS 3270 Terminal

Emulator 255Priority attribute

terminal definitions 70transaction definitions 76user definitions 87

PRIORITY parameterCEMT inquire netname 340CEMT inquire/set terminal 352CEMT inquire/set

transaction 354

Index 549

process identifier 161PROCESSID parameter

CEMT inquire/set task 344Product Definitions (XAD) 25ProgName attribute

transaction definitions 77Program Definitions (PD) 27PROGRAM parameter

CEMT inquire/set 342program statistics 458program testing

EDF 309ProgramCacheSize attribute

region definitions 45ProgramRSLCheck attribute

region definitions 46programs

CEMT inquire/set 342ProgramSymbols attribute

terminal definitions 71ProgType attribute

program definitions 31ProtectionLevel attribute

ProtectPurgeDelayPeriod attributeregion definitions 46

Protocol attributelistener definitions 20

PublicUserTraceFile attributeregion definitions 46

PURGE parameterCEMT inquire/set task 345CEMT inquire/set terminal 352

Purgeability attributetransaction definitions 77

PurgeDelayPeriod attributeregion definitions 46

QQSAM to DB2 file transfer 138QSAM to SFS file transfer 212qtod (DDT command) 136

definition files 140running 141

qtos (SDT command) 210definition files 214running 214

question mark (CECI) 308question mark (CEMT) 323quit (DDT command) 138quit (SDT command) 212

RRD (Region Definitions) 32

RDBMSInstance attributeregion definitions 46

read (DDT command) 133read (SDT command) 206READ parameter

CEMT inquire/set file 336ReadOpt attribute

file definitions 11RecordLen attribute

transient data definitions 83RecordSize attribute

file definitions 11RecordTerminator attribute

transient data definitions 83RecordType attribute

transient data definitions 83RecoverFlag attribute

temporary storage definitions 65RecoverStatus attribute

file definitions 11RecoverTerminal attribute

terminal definitions 71RecoveryType attribute

transient data definitions 83RecTSQFile attribute

region definitions 57RecTSQIndex attribute

region definitions 57RecTSQMaxRecs attribute

region definitions 57RecTSQPrePages attribute

region definitions 57RecTSQProtection attribute

region definitions 46RecTSQVol attribute

region definitions 57reference section

operator commands 369region

copying the default region 142destroying 148migrating 184process identifier 161

Region Definitions (RD) 32RegionPoolBase attribute

region definitions 47RegionPoolThreshold attribute

region definitions 47REGIONTHRESH parameter

CEMT inquire 356RELEASE parameter

CEMT inquire 356Released

Released (continued)CEMT INQUIRE FENODE 379

ReleaseNum attributeregion definitions 47

Reloadable attributeobject definitions 25

REMOTE parameterCEMT inquire/set file 337CEMT inquire/set tdqueue 349

RemoteCodePageTR attributecommunications definitions 5

RemoteLUName attributecommunications 5

RemoteName attributefile definitions 11program definitions 31temporary storage definition 65terminal definitions 71transaction definitions 77transient data definitions 84

RemoteNetworkName attributecommunications definitions 5

RemoteSysEncrypt attributecommunications definitions 5

RemoteSysId attributefile definitions 11program definitions 31temporary storage definition 65terminal definitions 71transaction definitions 77transient data definitions 84

RemoteSysSecurity attributecommunications definitions 6link security 6user security 6

RemoteTCPAddress attributecommunications definitions 6

RemoteTCPPort attributecommunications definitions 7

Resident attributeprogram definitions 31

resourcedeallocation 190

resource attributesname – description

cross-reference 507resource definitions

shorthand notation 1resource files

creating default 144ResourceDescription attribute

communications definitions 7file definitions 12gateway definitions 14gateway server definitions 15

ResourceDescription attribute(continued)

journal definitions 18listener definitions 20monitoring definitions 23object definitions 24product definitions 26program definitions 31region definitions 48schema file definitions 60SFS definitions 63temporary storage definitions 65terminal definitions 71transaction definitions 77transient data definitions 84user definitions 87

ResThreadPoolSize attributeSFS definitions 63

restoring a region 166restrictions on use of characters for

<Key> 1Routing Transaction (CRTE)

automatic transactioninitiation 365

description of 364overview 274reference 364syntax 364using with CEMT 366

RPCListenerThreads attributeregion definitions 48

RSLCheck attributetransaction definitions 77

RSLKey attributefile definitions 12journal definitions 18program definitions 31temporary storage definition 65transaction definitions 78transient data definitions 84

RSLKeyList attributeterminal definitions 71user definitions 87

RSLKeyMask attributecommunications definitions 7

running cicsnetdata 140, 213RUNNING parameter

CEMT inquire/set task 345running programs

Micro Focus COBOL 187running qtod 141running qtos 214runtime database statistics 459

runtime resource management(CEMT)

? character 323+ character 326blank fields in a screen 328command line request 323INQUIRE 323inquire/set overview 328inquiring about a resource 327invoking 323overtyping a screen 327PERFORM 323PF (program function) key

values 325prompting for options 323request formats 324screen layout 324scrolling a screen 326SET 323tab key 328

Runtime Resource Management(CEMT)

AKP parameter 355APPLID parameter 355AUTOINSTALL parameter 331auxiliary trace 353AUXTRACE parameter 332DATEFORM parameter 355description of 321DUMP parameter 333DUMPOPTIONS parameter 334FILE parameter 335INTROINTVL parameter 355JOURNAL parameter 338LOCALE parameter 355MAXREGIONPOOL

parameter 356MAXTASKSHPOOL

parameter 356MONITOR parameter 339NETNAME parameter 340OPREL parameter 356OPSYS parameter 356overview 273parameters, overview of 321PERFORM SNAP 330PROGRAM parameter 342reference 321REGIONTHRESH

parameter 356RELEASE parameter 356syntax 321SYSID parameter 356system parameters 355TASK parameter 344

Runtime Resource Management(CEMT) (continued)

TASKTHRESH parameter 356TCLASS parameter 347TDQUEUE parameter 348TERMINAL parameter 351TRACE parameter 353TRANSACTION parameter 354using with CRTE 366

runtime terminal attributesCEMT inquire/set 351

RuntimeProtection attributeregion definitions 48

SSafetyLevel attribute

region definitions 49SCD (Schema File Definitions) 57Schema File Definitions (SCD) 57screen layout

CALF 281, 282CDCN 288CEBR 292, 293CECI 299, 306, 307CECS 299, 306CEDF 311, 318CEMT 324CEMT inquire 328CSTD 367EDF 311, 318syntax notation 276

scrolling a screenCEMT 326

SDT command 203SDT commands

! 211addindex 209create 205delete 208delindex 209empty 208free 208ftos 211help (?) 212info 209list 205QSAM to SFS file transfer 212qtos 210quit 212read 206server 210setopen 205stof 210write 207

Index 551

securityCESN 359external 389signon 359

security rulesCECI 298CECS 298EDF 310

server (SDT command) 210server status

cicslssrc command 173cicsmakelv command 178cicsremovelv command 200cicstail command 243

ServerIdleLimit attributeregion definitions 49

ServerSideTran attributeregion definitions 49

SET (CEMT transaction) 329AUTOINSTALL parameter 331AUXTRACE parameter 332DUMP parameter 333DUMPOPTIONS parameter 334FILE parameter 335JOURNAL parameter 338MONITOR parameter 339overview 321PROGRAM parameter 342TASK parameter 344TCLASS parameter 347TDQUEUE parameter 348TERMINAL parameter 351TRACE parameter 353TRANSACTION parameter 354

setopen (SDT command) 205SFS

cicssfs command 225SFS diagnostic tool

cicssdt command 203SFS parameter

CEMT inquire/set file 337SHLIB_PATH environment

variable 188shorthand notation 1ShortName attribute

shutdown 190cicsnotify command 190

ShutdownProgList1 attributeregion definitions 49

ShutdownProgList2 attributeregion definitions 49

Signoff (CESF)description of 357

Signoff (CESF) (continued)overview 273reference 357syntax 357

Signoff (CSSF)description of 357overview 274reference 357syntax 357

signoff transactions (CESF andCSSF) 357

Signon (CESN)description of 359overview 274reference 359security 359syntax 359

SMIT – CICS resource crossreference 507

SNAConnectName attributecommunications definitions 7

SNADefaultModeName attributegateway server definitions 16

SNAModeName attributetransaction definitions 78

SNAPCEMT PERFORM 330

SNAServerNodeName attribute(CICS for Solaris only)

listener definitions 20SOSI attribute

terminal definitions 72SRVERCP option on DFHCNV

macro 249SSD (Structured File Server

Definitions) 61SSLAuthentication attribute

listener definitions 20SSLCertificate attribute

listener definitions 21SSLEncryption attribute

listener definitions 20SSLKeyFile attribute

listener definitions 20SSLKeyPassword attribute

listener definitions 20SSLSession attribute

listener definitions 21standard data types for user

exits 408standard header structure for user

exits 408StartType attribute

gateway server definitions 16region definitions 49

StartType attribute (continued)SFS definitions 63

StartupProgList attributeregion definitions 50

StateCEMT INQUIRE

FECONNECTION 374StatFile attribute

region definitions 50statistics

dump statistics 441file statistics 442general 434intersystem communication (ISC)

statistics 445journal statistics 454LUW statistics 457monitoring 339program statistics 458runtime database statistics 459storage statistics 464task statistics 473temporary storage statistics 485terminal statistics 476transaction statistics 483transient data statistics 480

Statistics (CSTD)description of 367overview 274reference 367syntax 367

StatsRecord attributeregion definitions 50

stof (SDT command) 210stop conditions, EDF 318storage statistics 464Structured File Server Definitions

(SSD) 61SufficesSupported attribute

region definitions 50Sun command tool and shell tool

autoinstall model 507supplied programs

CICS Client Autoinstall 389External Security Manager

(ESM) 389function shipping 389performance monitoring user

program 389Terminal Autoinstall 389transaction routing 389user conversion programs 389

SUSPENDED parameterCEMT inquire/set task 346

SWITCH parameterCEMT inquire/set

AUXTRACE 332CEMT inquire/set journal 338

SwitchLoadFile attributeproduct definitions 26

symbols used in manual 275symbols used on screen

displays 276Syncpoint attribute

transaction definitions 78syncpoint user exit (51) 422Syntax Checker (CECS)

values 304reference 298screen layout 299, 306security rules 298status area 299syntax 298

syntax messagesCECI or CECS information 304

syntax notation 275syntax notation on screen

displays 276SysDump attribute

region definitions 50sysid parameter 364

CEDF 287, 309SYSID parameter

CEMT inquire 356CRTE transaction 364

system dump flag 333system parameters

CEMT inquire 355SysTraceBufferSize attribute

Ttab key

CEMT 328Target

task classesCEMT inquire/set 347

task monitoring 339TASK parameter

CEMT inquire/set 344CEMT inquire/set task 346

task statistics 473task termination user exit (15) 410tasks

CEMT inquire/set 344TaskSharedPoolBase attribute

region definitions 51TaskSHNumBuckets attribute

region definitions 51TaskShPoolThreshold attribute

region definitions 51TASKSHTHRESH parameter

CEMT inquire 356TClass attribute

transaction definitions 79TCLASS parameter

CEMT inquire/set 347CEMT inquire/set task 346

TCPAddress attributelistener definitions 21

TCPService attributelistener definitions 21

TCTUALen attributeterminal definitions 72

TD (Transaction Definitions) 73TD queues

CEMT inquire/set 348TDD (Transient Data

Definitions) 81TDPurgeInterval attribute

region definitions 51TDQ attribute

monitoring definitions 23TDQUEUE parameter

CEMT inquire/set 348telnet

cicsteld command 247code page, specifying 247locale, specifying 247model type, specifying 247terminal type, specifying 247

TemplateDefined attributefile definitions 12program definitions 32temporary storage definitions 66transaction definitions 79transient data definitions 84

Temporary Storage Browse (CEBR)command input area 293description of 292information area 295overview 273PF (program function) key

values 295reference 292screen layout 293

Temporary Storage Browse (CEBR)(continued)

syntax 292using the transaction 292

Temporary Storage Definitions(TSD) 64

temporary storage statistics 485TemporaryStorageRSLCheck

attributeregion definitions 52

TERM environment variable 254TERM parameter

CEMT inquire/set task 346termid parameter

CDCN 287CEDF 309

TERMID parameterCEMT inquire/set tdqueue 349

Terminal Autoinstall 389terminal autoinstall program

CEMT inquire/set 331terminal autoinstall user exit

when the program isaccessed 394

terminal autoinstall user programDFHCHATX 391overview 390program parameters 393the supplied program 390

Terminal Definitions (WD) 66TERMINAL parameter

CEMT inquire netname 340CEMT inquire/set 351

terminal statistics 476terminal type, specifying 247TerminalProtection attribute

terminal definitions 72terminals

CEMT inquire/set 351TermSubType attribute

terminal definitions 72TermType attribute

terminal definitions 72ThreadPoolSize attribute

gateway server definitions 16timeout

DeadlockTimeout attribute 74Timeout attribute

transaction definitions 79TPNSNAProfile attribute

transaction definitions 79Trace attribute

region definitions 52trace facility

CEMT inquire/set 353

Index 553

TRACE parameterCEMT inquire/set 353

TraceFile attributeuser definitions 88

TraceFileA attributeregion definitions 52

TraceFileB attributeregion definitions 52

TraceFileSize attributeregion definitions 52

TraceModules attributeregion definitions 52

TRANID parameterCEMT inquire/set task 346CEMT inquire/set tdqueue 349

Transaction Definitions (TD) 73TRANSACTION parameter

CEMT inquire netname 340CEMT inquire/set 354CEMT inquire/set terminal 352CEMT TRANSACTION 354

transaction statistics 483TransactionRSLCheck attribute

region definitions 53transactions

CALF 281CDCN 287CEBR 292CECI 298CECS 298CEDF 309, 310CEMT inquire/set 354CESF 357CESN 359CMLV 362CRTE 364CSSF 357CSTD 367invocation of 274routing 364

TransDump attributetransaction definitions 79

TransDumpTrace attributeregion definitions 53

TransId attributeobject definitions 24program definitions 32

Transient Data Definitions(TDD) 81

transient data queuesCEMT inquire/set 348emptying 83extracting data from 179

transient data statistics 480

TransientDataRSLCheck attributeregion definitions 53

transmit a file from CMS 139, 213transmit a file from TSO 138, 212TriggeredTransId attribute

transient data definitions 85TriggerLevel attribute

transient data definitions 85TRIGGERLEVEL parameter

CEMT inquire/set tdqueue 349TSD (Temporary Storage

Definitions) 64TSLCheck attribute

transaction definitions 80TSLKey attribute

transaction definitions 80TSLKeyList attribute

terminal definitions 73user definitions 88

TSLKeyMask attributecommunications definitions 8

TSQAgeLimit attributeregion definitions 53

TTI parameterCEMT inquire netname 341CEMT inquire/set terminal 352

TWASize attributetransaction definitions 80

UUCTranFlag attribute

terminal definitions 73transaction definitions 80

UD (User Definitions) 85UE014015 (task termination user

exit) 410UE014025 (dynamic transaction

routing user exit) 413UE015050 (dynamic distributed

program link user exit) 418UE016051 (syncpoint user exit) 422UE052017 (dump request user

exit) 411UNENABLED parameter

CEMT inquire/set file 337UPDATE parameter

CEMT inquire/set file 337UpdateOpt attribute

file definitions 12user (DDT command) 136user conversion programs

function Shipping 389transaction routing 389

User Definitions (UD) 85user exit numbers 407

user exits15 - task termination 41017 - dump request 41125 - dynamic transaction

routing 41350 - dynamic distributed program

link 41851 - syncpoint 422constants 408External Security Manager

(ESM) 395standard data types 408standard header structure 408user exit numbers 407what is a user exit? 407

user programsterminal autoinstall 390

user security 6UserExitNumber attribute

program definitions 32UserID attribute

USERID parameterCEMT inquire/set task 346

UserMonitorModule attributemonitoring definitions 23

UserTraceDirectory attributeregion definitions 53

VValidation attribute

terminal definitions 73VariableFieldLength attribute

schema file definitions 60VariableFieldName attribute

schema file definitions 60VariableFieldType attribute

schema file definitions 60variables

CECI or CECS information 302VolumeName attribute

schema file definitions 61vt100 autoinstall model 502vt220 autoinstall model 504

WWaitconvnum

CEMT INQUIRE FEPOOL 383WAITFORGET parameter

CEMT inquire/set task 346WD (Terminal Definitions) 66WhenOpened attribute

transient data definitions 85

Windowed multi-byte colorautoinstall model 503

Windowed multi-byte monochromeautoinstall model 503

Windowed single-byte colorautoinstall model 503

Windowed single-byte monochromeautoinstall model 503

write (DDT command) 134

write (SDT command) 207

XXAClose attribute

product definitions 26

XAD (Product Definitions) 25

XAOpen attribute

XASerialize attribute

XID_NODE_ID environmentvariable 119

XPRecvTimeout attribute

xterm autoinstall model 504

Index 555

Program Number: 5765-E275639-I075765-E285765-E295639-I095639-I115765-E315765-E30

Printed in the United States of Americaon recycled paper containing 10%recovered post-consumer fiber.

SC09-4459-00

Spine information:

IBM WebSphere CICS Administration ReferenceVersion 3.0

CICS Administration Reference

Documents

Transcript of CICS Administration Reference

Xpediter/CICS Quick Reference

CICS 5P M qwLrhF - pudn.comread.pudn.com/downloads49/ebook/167786/CICS_Programing.pdf · IBM CICS Clients Administration | – SC33-1436-00 for CICS Clients Version 1.0 ... IBM Transaction

Version 5 Release 5 CICS Transaction Server for z/OS€¦ · CICS Transaction Server for z/OS Version 5 Release 5 CICS Statistics Reference IBM

Intranasal administration of carbamazepine to mice: a ... · Reference: PHASCI 3006 ... 3 CICS-UBI – Health Sciences Research Centre, University of Beira Interior, Av. ... For IN

Version 6.0, November 2003 - Micro Focus Supportline · basic concepts of CORBA 2.3 and CICS administration. ... is also a useful reference. For migration issues refer to the Mainframe

NCICS / CICS-NC Overview - University Of Marylandcicsmd.umd.edu/assets/1/7/1-7_Otis_Brown.pdf · 4 . CICS-NC – Seven Streams of Effort • Administration • Access and Services

CICS TS for z/OS: Resource Reference - IBM

CICS Application Programming Reference

CICS TS for z/OS: CICS System Programming Reference€¦ · CICS Transaction Server for z/OS CICS System Programming Reference Version 3 Release 1 ... This book is for system programmers

Information Exchange Administration Services Messages … · Expedite/CICS Customizing and ... Information Exchange Administration Mailbox Command Reference, GC34-2260 Information

CICS Application Programming Reference - mainframewiki.commainframewiki.com/.../04/CICS-Application-Programming-Reference.pdf · CICS Application Programming Reference ... This book

CICS Handbook - Reference V1.5

CICS TS for z/OS: CICS System Programming Reference

PREMIERS' CONFERENCES · In March 1987 the Canadian Intergovernmental Conference Secretariat (CICS) ... Included in this reference volume are the formal ... CICS | PREMIERS’ CONFERENCES

CICS Transaction Server for z/OS Version 5 Release 2publibfi.dhe.ibm.com/epubs/pdf/dfha8g00.pdf · viii CICS TS for z/OS 5.2: System Programming Reference. Changes in CICS Transaction

CICSPlex SM Administration - IBM - United States 1. Directly-connectable CICS systems by CICSPlex SM release CICS system CICSPlex SM component of CICS TS 3.1 CICSPlex SM component

Cics 400 Administration and Operations Guide

Response to RFP for - SYSCOM · CICS ADMINISTRATION ... specific information in the table below to use as a reference throughout the installation process.

ADVANCED COMMAND CENTER CICS DB2 MQ ADMINISTRATION …k2softwarefactory.com/DOCADM.pdf · · 2017-07-18ADVANCED COMMAND CENTER CICS DB2 MQ ... It makes use of standard CICS SP Application

CICS for iSeries Administration and Operations Guide V5public.dhe.ibm.com/systems/power/docs/systemi/v6r1/... · About CICS for iSeries Administration and Operations Guide (SC41-5455)