CICS definitions

The CICS® API example program is, for all intents and purposes, an assembler program. It requires the normal CICS definitions, using for example CEDA or the CICS Explorer, to define it as a program and the definition to map the program to a CICS transaction.

The exit is enabled using the ENABLE PROGRAM command, for example via the CECI transaction:

CECI ENABLE PROGRAM(MTLBTXPI) EXIT('xtsereq') start

The exit is triggered each time a temporary storage request is to be serviced by CICS. The following command issued using the CECI transaction is an example of a request to temporary storage.

CECI WRITEQ TS QU('NOELNOEL') FROM('HELLO')

Figure 1 describes the CEDA definition for the API example program.

Figure 1. CICS CEDA definition for the API example program

CEDA View PROGram (METALH)                                               
  PROGram        : METALH                                                     
  Group          : NCSMETAL                                                   
  DEScription    : FIRST METAL PROGRAM                                        
  Language       : Assembler          CObol | Assembler | Le370 | C | Pli     
  RELoad         : No                 No | Yes                                
  RESident       : No                 No | Yes                                
  USAge          : Normal             Normal | Transient                      
  USElpacopy     : No                 No | Yes                                
  Status         : Enabled            Enabled | Disabled                      
  RSl            : 00                 0-24 | Public                           
  CEdf           : Yes                Yes | No                                
  DAtalocation   : Any                Below | Any                             
  EXECKey        : User               User | Cics                             
  COncurrency    : Quasirent          Quasirent | Threadsafe                  
  Api            : Cicsapi            Cicsapi | Openapi

Figure 2 describes the CICS transaction definition.

Figure 2. CICS transaction definition

CEDA View TRANSaction (MET0)                                           
  TRANSaction    : MET0                                                   
  Group          : NCSMETAL                                               
  DEScription    :                                                        
  PROGram        : METALH                                                 
  TWasize        : 00000              0-32767                             
  PROFile        : DFHCICST                                               
  PArtitionset   :                                                        
  STAtus         : Enabled            Enabled | Disabled                  
  PRIMedsize     : 00000              0-65520                             
  TASKDATALoc    : Any                Below | Any                         
  TASKDATAKey    : User               User | Cics                         
  STOrageclear   : No                 No | Yes                            
  RUnaway        : System             System | 0 | 500-2700000            
  SHutdown       : Disabled           Disabled | Enabled                  
  ISolate        : Yes                Yes | No

Figure 3 describes the CICS XPI example as defined in the CEDA.

Figure 3. Defining the CICS XPI example in the CEDA

CEDA View PROGram (MTLBTXPI)                                           
  PROGram        : MTLBTXPI                                               
  Group          : NCSMETAL                                               
  DEScription    :                                                        
  Language       : Assembler          CObol | Assembler | Le370 | C | Pli 
  RELoad         : No                 No | Yes                            
  RESident       : No                 No | Yes                            
  USAge          : Normal             Normal | Transient                  
  USElpacopy     : No                 No | Yes                            
  Status         : Enabled            Enabled | Disabled                  
  RSl            : 00                 0-24 | Public                       
  CEdf           : Yes                Yes | No                            
  DAtalocation   : Any                Below | Any                         
  EXECKey        : Cics               User | Cics                         
  COncurrency    : Quasirent          Quasirent | Threadsafe              
  Api            : Cicsapi            Cicsapi | Openapi