INGCICS

Purpose

The INGCICS command lets you:

  • Issue any console-enabled CICS® transaction.
  • Broadcast messages to all or selected CICS users.
  • Issue a list of defined transactions and view the output.
  • Display the output of CICS transactions in fullscreen or pipeable line mode.

Syntax

Read syntax diagramSkip visual syntax diagramINGCICSresource command_specificationbroadcast_specificationinfo_specificationTARGET=system_namedomain_IDsaplex_nameOUTMODE=LINEAUTONETLOG
command_specification
Read syntax diagramSkip visual syntax diagramREQ=CMDCMD= cics_transactionMSG= message ID
broadcast_specification
Read syntax diagramSkip visual syntax diagramREQ=BROADCASTMSG= messageROUTE= cics_route_options
info_specification
Read syntax diagramSkip visual syntax diagramREQ=INFO

Parameters

resource
The resource specifies the name of the CICS subsystem that the command will be issued to. The format is subsystem[/APL[/system]], where the subsystem is the specific name of the desired CICS subsystem and system is the name of the system that the CICS is running on.
Note: You need not specify the fully qualified name of the resource. However, the command requires enough information to execute the request against a unique CICS subsystem. The command does not support issuing requests to multiple CICS subsystems at the same time.
REQ
Specifies the request to be issued to the CICS subsystem. It can be one of the following:
CMD
Issues a CICS transaction and displays the results.
BROADCAST
Issues a CICS broadcast to all or selected users.
INFO
Issues a set of predefined commands and displays the results. The list of commands is obtained from the CICSINFO user message policy of the subsystem specified by the resource name.
CMD
Specifies the CICS transaction and its parameters to be executed for a REQ=CMD type request. If the command and parameters contain spaces, enclose the command in quotation marks (single or double). For CEMT transactions INGCICS waits up to twice the period that is defined by the system wait time parameter for a result.
MSG
Specifies the message to be sent to all or selected CICS terminals or users for the REQ=BROADCAST request.

For REQ=CMD the MSG command can be used to contain a list of words that will be used to end processing if they are received anywhere in the output results. The words will normally be a required message ID and when entered INGCICS waits up to the period that is defined by the system wait time parameter for a result. If no words are entered, CMD is processed until any result is received.

ROUTE
Specifies the CICS routing information that is used to select the CICS terminals or users are to receive the message for a REQ=BROADCAST request. The contents of the ROUTE= parameter are the parameters to be supplied to the CMSG transaction to route messages to CICS terminals or users. See the CMSG transaction for the details of the parameters for that transaction.
TARGET
For information on the TARGET parameter, see TARGET Parameter.
OUTMODE
For information on the OUTMODE parameter, see OUTMODE Parameter.

Restrictions and Limitations

To use the INGCICS command system operations must be initialized. CICS subsystems must be enabled for system console commands using the MVS MODIFY command.

Usage

The INGCICS command operates sysplexwide. For an overview see Overview of Commands that Operate Sysplexwide.

Examples

If you enter INGCICS REQ=CMD a panel similar to Figure 1 is displayed.
Figure 1. INGCICS REQ=CMD Command Dialog Panel
 EVEKYCMD                 SA z/OS  - Command Dialogs       Line 1     of 28     
 Domain ID   = IPSFM     ---------- INGCICS  ----------    Date = 03/05/02      
 Operator ID = SAUSER                                      Time = 08:23:31      
                                                                                
 Resource         => EYUMAS1A/APL/KEY1                  Format: name/type/system
 Target           =>                      System name, domain ID or sysplex name
 Request          => CMD                  CMD, BROADCAST or INFO                
 CICS Transaction => CEMT I TA                                                  
 CICS Route       =>                                                            
 CICS Message     =>                                                            
                  =>                                                            
                                                                                
 Tas(0000024) Tra(CONL)           Sus Tas Pri( 255 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C4105BD4E305)                                    
 Tas(0000026) Tra(COI0)           Sus Tas Pri( 255 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C413B3F7A908)                                    
 Tas(0000027) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430B48804)                                    
 Tas(0000028) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430C33084)                                    
 Tas(0000029) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430CFD804)                                    
 Tas(0000030) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430DB0684)                                    
 Tas(0000031) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430E8D844)                                    
 Tas(0000032) Tra(CONM)           Sus Tas Pri( 240 )                            
 Sta(U ) Use(STCUSER ) Uow(B747C41430F56504)                                    
                                                                                
 Command ===>                                                                   
    PF1=Help     PF2=End      PF3=Return   PF4=DISPINFO         PF6=Roll        
                 PF8=Forward  PF9=Refresh                       PF12=Retrieve   
 
  • The Resource field shows the name of the CICS subsystem to be used for issuing the requests. The format is name/type[/system]. Wildcards are supported.
  • The Target field shows the name of the system (system name, domain ID, or sysplex name) that the command should be routed to. Specifying this is only necessary if the resources are not part of the local sysplex.
  • The Request field shows the request to be carried out. It can be CMD, BROADCAST or INFO.
  • The CICS Transaction field shows the CICS transaction to be executed on the CICS subsystem specified by the resource field.
  • The CICS Route field shows the routing parameters for the CMSG transaction when the request is BROADCAST.
  • The CICS Message field shows the message to be sent to users or terminals for the BROADCAST request.
  • The output from the CICS transaction appears in the blank area after the CICS Message field.
If you specify INGCICS REQ=BROADCAST a panel similar to Figure 2 is displayed.
Figure 2. INGCICS REQ=BROADCAST Command Dialog Panel
 EVEKYCMD                  SA z/OS  - Command Dialogs      Line 1     of 28     
 Domain ID   = IPSFM     ---------- INGCICS  ----------    Date = 03/05/02      
 Operator ID = SAUSER                                      Time = 08:36:12      
                                                                                
 Resource         => EYUMAS1A/APL/KEY1                  Format: name/type/system
 Target           =>                      System name, domain ID or sysplex name
 Request          => BROADCAST            CMD, BROADCAST or INFO                
 CICS Transaction => CMSG R=&ROUTE,'&MESSAGE',S                                 
 CICS Route       => ALL                                                        
 CICS Message     => test1                                                      
                  =>                                                            
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
 Command ===>                                                                   
    PF1=Help     PF2=End      PF3=Return   PF4=DISPINFO         PF6=Roll        
                              PF9=Refresh                       PF12=Retrieve   

The CICS command that is issued is displayed in the CICS Transaction field. The &ROUTE and &MESSAGE parameters are resolved to the corresponding panel fields. Do not overwrite the command that is displayed because changes are not honored.

If you specify INGCICS REQ=INFO a panel similar to Figure 3 is displayed.
Figure 3. INGCICS REQ=INFO Command Dialog Panel
 EVEKYCMD                 SA z/OS  - Command Dialogs       Line 1     of 67     
 Domain ID   = IPSFM     ---------- INGCICS  ----------    Date = 03/05/02      
 Operator ID = SAUSER                                      Time = 08:40:30      
                                                                                
 Resource         => EYUMAS1A/APL/KEY1                  Format: name/type/system
 System           =>                      System name, domain ID or sysplex name
 Request          => INFO                 CMD, BROADCAST or INFO                
 CICS Transaction =>                                                            
 CICS Route       =>                                                            
 CICS Message     =>                                                            
                  =>                                                            
                                                                                
 SYSTEM INFORMATION                                                             
                                                                                
 Aging( 00500 )                                                                 
 Akp( 04000 )                                                                   
 Cdsasize(00786432)                                                             
 Cicstslevel(010200)                                                            
 Cmdprotect(Cmdprot)                                                            
 Db2conn(SG12)                                                                  
 Dfltuser(STCUSER)                                                              
 Dsalimit( 05242880 )                                                           
 Dtrprogram( DFHDYP   )                                                         
 Dumping( Nosysdump )                                                           
 Ecdsasize(0006291456)                                                          
 Edsalimit( 0041943040 )                                                        
 Erdsasize(0013631488)                                                          
 Esdsasize(0000000000)                                                          
                                                                                
 Command ===>                                                                   
    PF1=Help     PF2=End      PF3=Return   PF4=DISPINFO         PF6=Roll        
                 PF8=Forward  PF9=Refresh                       PF12=Retrieve