INGTWS

Purpose

The INGTWS command lets you:

  • Display Application, Operation, Special Resource, Work Station and Calendar information from the Current Plan.
  • Modify Application, Operation, Special Resource, Work Station information in the Current Plan.
  • Issue a request against any controller defined to SA z/OS® in a sysplex.
  • Issue a request against a foreign controller where the local tracker is defined to SA z/OS.
  • The output of the INGTWS command is either full screen or in pipeable line mode.
Note: INGOPC is a synonym for INGTWS.

Syntax

Read syntax diagramSkip visual syntax diagramINGTWSResource(resource_name)REQ=LISTMODTYPE=APPLOPSRWSCALTARGET= targetOUTMODE=LINEAUTONETLOGMOD OptionsLIST Options APPL Selection CriteriaOP Selection CriteriaSR Selection CriteriaWS Selection Criteria
MOD options
Read syntax diagramSkip visual syntax diagramUPDATE=(;keyword= value)
LIST options
Read syntax diagramSkip visual syntax diagramTWSPARM=(;keyword= value)
APPL Selection criteria
Read syntax diagramSkip visual syntax diagramAD= appl-idIA= yymmddhhmm
OP Selection criteria
Read syntax diagramSkip visual syntax diagramAD= appl-idIA= yymmddhhmmOPNO= nnnnJOBNAME= jobnameSTATUS= statusERRCODE= error_codeGROUP= groupOWNER= ownerPRIORITY= priorityWSNAME= workstation
SR Selection options
Read syntax diagramSkip visual syntax diagramSRNAME= special_resource
WS Selection options
Read syntax diagramSkip visual syntax diagramWSNAME= workstation

Parameters

resource
The resource specifies the TWS controller that is to be queried or modified. Multiple specifications are allowed as well as system and sysplex application groups. Wildcards % and * are supported.

The command attempts to resolve the specification to a single appropriate target resource. In all cases the groups are resolved to their members and wildcards are resolved to specific sets of resources.

The resulting list of resources is scanned to check whether there is a single active controller. If a single active controller is found then it is used. If no active controller is found then the list is scanned to check whether there is a single active tracker (only active trackers with LUNAME policy entries are checked because only these trackers can be used to communicate with TWS via the PIF interface). If a single active tracker is found then it is used.

If no viable resources are found an error message is displayed. If multiple viable resources are found, and INGTWS is running in full screen mode, a selection panel is displayed; when OUTMODE=LINE is specified an error message is displayed.

If an active controller could be found, a command is dispatched to the appropriate system in the sysplex to execute the TWS API on the same system as the active controller. If a tracker was found, the LUNAME parameter of the trackers OPCCNTL entry may be used to specify a remote controller. In this case the command is dispatched to the system where the tracker is running and the APPC API is used to connect to the remote controller from that system.

REQ
Specifies the request to be issued to the TWS subsystem. It can be one of the following:
LIST
Lists TWS Current Plan resources.
MOD
Modifies TWS Current Plan resources.
TYPE
Specifies the type of Current Plan resource to be listed or modified. It can be one of the following:
APPL
Specifies the Current Plan Application Description resource.
OP
Specifies the Current Plan Operation resource.
SR
Specifies the Current Plan Special resource.
WS
Specifies the Current Plan Workstation resource.
CAL
Specifies the Current Plan Calendar resource.
UPDATE
Specifies the fields that are to be updated and the new contents of the field. Multiple fields can be specified separated by a semi-colon ";". The names of the fields are the same names as specified in the MODIFY command arguments in Driving IBM Z Workload Scheduler.

An alternative to specifying all the fields to be updated using the UPDATE= parameter is to specify the fields and their contents in the default SAFE. Specify one field per message with the format of <fieldname><blank>=<blank><contents>. The blanks between the fieldname and the = symbol and the = symbol and the contents are required.

TWSPARM
Specifies additional fields to be used to locate a resource during LIST processing. Multiple fields may be specified separated by a semi-colon ";". The names of the fields are the same names as specified in the LIST command arguments described in the Driving IBM Z Workload Scheduler manual. The field names must match the TWS segment being searched. For example, CPOC fields are valid for TYPE=APPL and CPOP fields are valid for TYPE=OP, and so on. A TWS EQQ* message will be issued if the field specification is incorrect.

An alternative to specifying additional LIST fields using the TWSPARM= parameter is to specify the fields and their values in the default SAFE. Specify one field per message using the format <fieldname><blanks>=<blanks><contents>. The blanks are optional.

If the same field names are specified in both the TWSPARM and the default SAFE, the TWSPARM values will be used.

Additional LIST fields can only be specified with OUTMODE=LINE.

AD
Specifies the Application Description selection criteria. For LIST requests, this may contain the trailing "*" wildcard character. For MOD requests, this must be the exact name of the application description to be updated.
IA
Specifies the input arrival date/time of the application. The format is as specified by the system programmer when installing and customizing TWS. The default format is YYYYMMDDHHMM.
OPNO
Specifies the operation number selection criteria. This is the operation number of an operation in an application description.
JOBNAME
Specifies the TWS jobname. This field is used to qualify requests of type OP and is optional for all requests.
STATUS
Specifies the TWS status. This field is used to qualify requests of type OP and is optional for all requests.
ERRCODE
Specifies the TWS error code. This field is used to qualify requests of type OP and is optional for all requests.
GROUP
Specifies the TWS group. This field is used to qualify requests of type OP and is optional for all requests.
OWNER
Specifies the TWS owner. This field is used to qualify requests of type OP and is optional for all requests.
PRIORITY
Specifies the TWS priority. This field is used to qualify requests of type OP and is optional for all requests.
SRNAME
Specifies the Special Resource selection criteria.

For LIST requests, this may contain the trailing "*" wildcard character. For MOD requests, this must be the exact name of the special resource.

If the special resource name contains special characters then it must be enclosed in single quotation marks.

WSNAME
Specifies the workstation name selection criteria. Specifies the workstation name selection criteria but may also be used to qualify TYPE=OP requests.

For LIST requests, this may contain the trailing "*" wildcard character. For MOD requests, this must be the exact name of the workstation.

TARGET
Specifies the name of the system (system, domain, or sysplex) that the command should be routed to. The TWS controller specified in the resource field must be active on this system or the command will return no data. This is only necessary when the resource is not part of the local sysplex.

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 INGTWS command system operations must be initialized.

Usage

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

Examples

If you type INGTWS a panel similar to Figure 1 is displayed.
Figure 1. INGTWS Command Dialog Panel
 EVJKYRQ0                  SA z/OS  - Command Dialogs                           
 Domain ID   = IPSFM     ---------- INGTWS   ----------    Date = 05/08/03      
 Operator ID = NETOP1                                      Time = 04:28:39      
                                                                                
   Resource    =>                                     format: name/type/system  
   Target      =>              System name, domain ID or sysplex name           
                                                                                
   Request     =>              Request type (LIST/MODIFY)                       
   Type        =>              Type of resource (APPL/OP/SR/WS/CAL)             
                                                                                
   Application =>                                                               
   IA Date/Time=>                    (YYMMDDHHMM)                               
                                                                                
   Operation # =>              Group     =>                                     
   Jobname     =>              Owner     =>                                     
   Status       =>              Priority  =>                                     
   Error Code  =>                                                               
   Workstation =>                                                               
                                                                                
   SR Name     =>                                                               
                                                                                
 Command ===>                                                                   
    PF1=Help     PF2=End      PF3=Return                           PF6=Roll     
                                                                  PF12=Retrieve  
  • The Resource field shows the name of the TWS active controller 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, or sysplex name) that the command should be routed to. Specifying this is only necessary if the resources do not reside on the local sysplex.
  • The Request field shows the request to be carried out. It can be LIST or MODIFY.
  • The Type field shows the type of TWS Current Plan resource to be specified.
  • The Application field specifies the TWS application ID, This field is used to qualify requests of type APPL or OP and is optional for LIST requests but is required for MODIFY requests.
  • The IA(R) Date/Time field specifies the TWS input arrival time. This field is used to qualify requests of type APPL or OP and is optional for LIST requests but is required for MODIFY requests.
  • The Operation # field specifies the TWS operation number. This field is used to qualify requests of type APPL or OP and is optional for LIST requests but is required for MODIFY requests.
  • The Jobname field specifies the TWS jobname associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Status field specifies the TWS status associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Error Code field specifies the TWS error code associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Group field specifies the TWS group associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Owner field specifies the TWS owner associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Priority field specifies the TWS priority associated with an operation. This field is used to qualify requests of type OP and is optional for all requests.
  • The Workstation field specifies the TWS workstation for the operation. This field is used to qualify requests of type OP and type WS and is optional for all LIST requests but is required for type WS MODIFY requests.
  • The SR Name field specifies the TWS special resource name. This field is used to qualify requests of type SR and is optional for LIST requests but is required for MODIFY requests.

To set the status of the special resource 'testnnnn' to available, enter the following command:

ingtws req=mod type=sr srname=testnnnn outmode=line Update=(resavail=y)

If you specify INGTWS * REQ=LIST TYPE=APPL a panel similar to Figure 2 is displayed.
Figure 2. INGTWS REQ=LIST TYPE=APPL Command Dialog Panel
 INGKYSTO                 SA z/OS  - Command Dialogs  Line  1    of 65
 Domain ID   = IPSFM      -------- INGTWS    ---------    Date = 04/10/02       
 Operator ID = AFRANCK         Sysplex = KEY1PLEX         Time = 16:19:30       
 CMD: A Update    B Operations                                    / scroll      
                           Application Occurrence List                          
                       Input Arrival            Error                           
 CMD  Application Id   Date     Time  Status    Code  Description               
 ---  ---------------- -------- ----- --------- ----- ------------------------  
      JKOPCTST1        02/01/23 00:01 Completed       Test Batch Iface          
      JKTEST1          02/01/23 00:08 Completed       This is a test            
      JKOPCTST1        02/01/24 00:01 Completed       Test Batch Iface          
      JKTEST1          02/01/24 00:08 Completed       This is a test            
      IEFBR14          02/01/24 08:01 Completed       This is a test            
      JKOPCTST1        02/01/25 00:01 Starting        Test Batch Iface          
      JKTEST1          02/01/25 00:08 Completed       This is a test            
      IEFBR14          02/01/25 08:01 Completed       This is a test            
      JKOPCTST1        02/01/26 00:01 Error           Test Batch Iface          
      JKTEST1          02/01/26 00:08 Completed       This is a test            
      IEFBR14          02/01/26 08:01 Completed       This is a test            
      JKOPCTST1        02/01/27 00:01 Error           Test Batch Iface          
      JKTEST1          02/01/27 00:08 Completed       This is a test            
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End      PF3=Return                 PF5=Filters   PF6=Roll     
If you specify INGTWS * REQ=LIST TYPE=OP a panel similar to Figure 3 is displayed.
Figure 3. INGTWS REQ=LIST TYPE=OP Command Dialog Panel
 INGKYSTO                 SA z/OS  - Command Dialogs  Line  1    of 3
 Domain ID   = IPSFM      -------- INGTWS    ---------    Date = 04/10/02       
 Operator ID = NETOP1          Sysplex = KEY1PLEX         Time = 16:23:08       
 CMD: A Update                                                    / scroll      
                                 Operations List                                
      Op.  -------JES-------                                          Err. Work 
 CMD  Num. Name     Number   Status    Reason                         Code Stn. 
 ---  ---- -------- -------- --------- ------------------------------ ---- ---- 
         1 EVJSJ001          Completed                                     NV01 
         1 JKTST1   JOB06429 Completed                                     N001 
         1 IEFBR14  JOB00325 Completed                                     CPU1 
         1 EVJSJ001 JOB07522 Completed                                     N001 
         1 JKTST1   JOB07521 Completed                                     N001 
         1 IEFBR14  JOB07523 Completed                                     CPU1 
         1 EVJSJ001 JOB00787 Interrupt                                     N001 
         1 JKTST1   JOB07524 Completed                                     N001 
         1 IEFBR14  JOB07526 Completed                                     CPU1 
         1 EVJSJ001 JOB07528 Error                                    JCL  N001 
         1 JKTST1   JOB07527 Completed                                     N001 
         1 IEFBR14  JOB07529 Completed                                     CPU1 
         1 EVJSJ001 JOB07533 Error                                    JCL  N001 
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End      PF3=Return                 PF5=Filters   PF6=Roll     
If you specify INGTWS * REQ=LIST TYPE=SR a panel similar to Figure 4 is displayed.
Figure 4. INGTWS REQ=LIST TYPE=SR Command Dialog Panel
 INGKYSTO                 SA z/OS  - Command Dialogs  Line  1    of 26
 Domain ID   = IPSFM      -------- INGTWS    ---------    Date = 04/10/02       
 Operator ID = NETOP1          Sysplex = KEY1PLEX         Time = 16:27:11       
 CMD: A Update                                                    / scroll      
                             Special Resources List                             
                                                   --Actual-- -Default--        
 CMD  Name                                         Av. Quant. Av. Quant.        
 ---  -------------------------------------------- --- ------ --- ------        
      ING.KEY1.APL.CICSK1G.DOWN                    No       1 Yes      1        
      ING.KEY1.APL.CICSK1G.UP                      No       1 Yes      1        
      ING.KEY1.APL.RMF.DOWN                        No       1 Yes      1        
      ING.KEY1.APL.RMF.UP                          Yes      1 Yes      1        
      ING.KEY1.APL.RMFIII.DOWN                     No       1 Yes      1        
      ING.KEY1.APL.RMFIII.UP                       Yes      1 Yes      1        
      ING.KEY2.APL.CICSK1G.DOWN                    Yes      1 Yes      1        
      ING.KEY2.APL.CICSK1G.UP                      No       1 Yes      1        
      ING.KEY2.APL.RMF.DOWN                        No       1 Yes      1        
      ING.KEY2.APL.RMF.UP                          Yes      1 Yes      1        
      ING.KEY2.APL.RMFIII.DOWN                     No       1 Yes      1        
      ING.KEY2.APL.RMFIII.UP                       Yes      1 Yes      1        
      ING.KEY3.APL.CICSK1G.DOWN                    Yes      1 Yes      1        
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End      PF3=Return                 PF5=Filters   PF6=Roll     
If you specify INGTWS * REQ=LIST TYPE=WS a panel similar to Figure 5 is displayed.
Figure 5. INGTWS REQ=LIST TYPE=WS Command Dialog Panel
 INGKYSTO                 SA z/OS  - Command Dialogs  Line  1    of 7
 Domain ID   = IPSFM      -------- INGTWS    ---------    Date = 04/10/02       
 Operator ID = NETOP1          Sysplex = KEY1PLEX         Time = 16:29:02       
 CMD: A Update                                                    / scroll      
                               Work Stations List                               
                              Reporting  JCL                  Alt. Para.        
 CMD  Name Status  Type       Attribute  Prep STC WTO ReRoute WS   Server       
 ---  ---- ------- ---------- ---------- ---- --- --- ------- ---- ------       
      NV02 Unknown General    Automatic  No   No  No  No           No           
      NV03 Unknown General    Automatic  No   No  No  No           No           
      OPR1 Unknown General    Completion No   No  No  No           No           
      WTO1 Active  General    Automatic  No   No  Yes No           No           
      NV01 Unknown General    Automatic  No   No  No  No           No           
      CPU1 Active  Computer   Automatic  No   No  No  No           No           
      N001 Active  Computer   Automatic  No   No  No  No           No           
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End      PF3=Return                 PF5=Filters   PF6=Roll     
If you specify INGTWS * REQ=LIST TYPE=CAL a panel similar to Figure 6 is displayed.
Figure 6. INGTWS REQ=LIST TYPE=CAL Command Dialog Panel
 INGKYSTO                 SA z/OS  - Command Dialogs  Line  1    of 2
 Domain ID   = IPSFM      -------- INGTWS    ---------    Date = 04/10/02       
 Operator ID = NETOP1          Sysplex = KEY1PLEX         Time = 16:31:46       
 CMD:                                                             / scroll      
                                  Calendar List                                 
                                                                                
 CMD  Name             Days Shift Description                                   
 ---  ---------------- ---- ----- ------------------------------                
      APC                 7 0000  general APC calendar                          
      DEFAULT             8 0000  general APC calendar                          
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End      PF3=Return                 PF5=Filters   PF6=Roll    
Press PF10 and PF11 to display more information for each resource type. Issuing the command code A Update command against a resource in the CMD field displays a panel that lets you modify the resource. The Application Description list supports the B Operations command code. Issuing this command code against an application resource displays a list of operations for that resource. SORT/FIND/RFIND commands are supported. See Varying the Format of the Command Output for further information.
Pressing PF5 displays a filter selection panel similar to Figure 7 is displayed.
Figure 7. INGTWS Filter Command Dialog Panel
 EVJKFLT                   SA z/OS  - Command Dialogs                           
 Domain ID   = IPSFM     ---------- EVJFILT  ----------    Date = 04/10/02      
 Operator ID = NETOP1                                      Time = 16:36:48      
                                                                                
 Specify or revise the filter criteria:                                         
                                                                                
   Active Controller ==>  OPCF/APL/KEY1                                         
   OPC/TWS resource  ==>  CAL            APPL, OP, SR, WS or CAL                
                                                                                
   Generic Filter strings in the format NAME = value                            
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
   ==>                                  ==>                                     
                                                                                
                                                                                
 Command ===>                                                                   
  PF1=Help    PF2=End    PF3=Return    PF4=Clear    PF5=Reset       PF6=Roll    
Specify filter strings in the format field-name op contents where:
  • field-name is a valid field name as specified by the MODIFY command arguments in Driving IBM Z Workload Scheduler.
  • op can have the following values:
    • =
    • ^=
    • <
    • <=
    • >
    • >=
  • contents are the desired values to be matched by the op. The trailing wildcard character '*' may be used for op.

The operands must be separated by a blank.