Displaying the CICS IA Command Flow Options panel

With the CICS IA Command Flow Options panel you can control the Command Flow data collection.

About this task

You can use the CICS IA Command Flow Options panel to perform the following tasks:

Start and stop the collection of the Command Flow data in the selected region or regions.
Configure the initial part of the Command Flow data collection options.
Show information about the current state of the CINC collector.
Display the CICS IA Command Flow ApplID list panel, CIUA02, which helps you to configure the second part of the Command Flow data collection options.
Display the CICS IA User Command Flow Statistics panel, CIUA03, which helps you to view the Command Flow data statistics for all the regions from the user's regions configuration.
Display the CICS IA Command Flow Application Data Collection panel, CIUA0A, to view or change the Application Data collection options.

Procedure

At a CICS terminal, type the transaction identifier CINC.
Press Enter. Panel CIUA01 is displayed; see Command Flow Options panel, CIUA01.

Figure 1. Command Flow Options panel, CIUA01

CIUA01           CICS IA Command Flow Options        ❶ ApplID   C62C1C01 
 
Command Flow state  .  .  .  . :  STOPPED               ❷            
Date/Time of last start.  .  . : 2023:12:16 08:15:16PM  ❸   
Date/Time of last stop .  .  . : 2023:12:16 09:54:47PM  ❹ 
  
Command Flow Id  .  .  .  .  . : MYCMDID           ❺

Traced user USERIDs .  .  .  . : CICSUSER          ❻ CINC Authority: GENERAL  ❽
Traced terminal TermIDs.  .  . : *___              ❼
                   
Traced transaction IDs .  .  . : TWEB TR*  T+AN TR%N T++N  (Max 5 transact. IDs)     ❾
Exclude lists .  .  .  .  .  . : Transaction               Program            ❿
Command include list   .  .  . : ________             ⓫                          
Usage of command include list: CICS _ IMS _ MQ _ Db2 _ NAT _          (Y/N)  ⓬
User Journal Name.  .  .  .  . : CIUMTJNL           ⓭
Journal Copy Criteria  .  .  . : LAST     (LAST, USER or CFID)      ⓮
User Exit Name.  .  .  .  .  . : _________                          ⓯
Dynamic Call  .  .  .  .  .  . : Y             (Yes/No)             ⓰
Tasks before Stopping  .  .  . : 0             (0-9999)             ⓱
Records before Stopping.  .  . : 0             (0-9999999)          ⓲  


CIU7000I 5655-YB1 (C) Copyright IBM and HCL, 2001,2024 
F1=Help       F2=          F3=Exit       F4=Options        F5=Start         F6=Stop ⓳
F7=Stats      F8=          F9=           F10=Applications  F11=             F12=Cancel

The meaning of each part of the CICS® IA Command Flow Options panel, CIUA01, is as follows:

❶ The 8-character APPLID of the CICS® region on which the CICS® IA Command Flow Utility is running.

❷ The current state of the Command Flow data collection process on all the regions for the user's regions configuration:

RUNNING: The Command Flow Collector is running on all the regions.
PARTLY STA: The Command Flow Collector is running on some of the regions.
STOPPED: The Command Flow Collector is stopped on all the regions
START FAIL: An error was detected during the Command Flow Collector start process.
STOP FAIL: An error was detected during the Command Flow Collector stop process.
INCOMPLETE: The Command Flow start (or stop) process was not completed. Press F6 (stop) to reset this status.
NO APPLIDS: The Command Flow APPLID list is empty.

❸The date and time when the Command Flow data collection process was last started. The time shown is the local time, and the date is given in the format specified by the Global Options Menu panel of the CINT transaction.

❹ The date and time when the Command Flow data collection process was last stopped. The time shown is the local time, and the date is given in the format specified by the Global Options Menu panel of the CINT transaction.

❺ The name of the Command Flow trace that is to be captured.

❻ The user ID associated with CICS® transactions, for which you want to collect the Command Flow data.

Note:

A PRIVILEGED CINC User can use %, +, and Wildcard *. Wildcard * can be used only as a suffix.

❼The terminal identifier associated with CICS® transactions, for which you want to collect the Command Flow data.

❽ The CINC user can be defined as a GENERAL user or a PRIVILEGED user. PRIVILEGED users can use wildcards to collect data for more than one user ID. The default value is General.

❾ The list of transaction identifiers, for which you want to collect the Command Flow data. You can enter up to five transaction IDs and you can use wildcard characters.

❿ The names for program and transaction exclude lists that are to be used by command flow collector. The exclude list format is the same with Dependency/Affinity collector (CINT). If the transaction name in the list of collected transactions does not contain wildcards, the transaction exclude list will not be applied to it.

⓫The 1 - 8-character name of a table that contains a list of 2-bites hexadecimal command prefixes. If it is used, only the commands that are included in the list will be collected by the command flow collector. It has the same structure as CIUXCOMM – the default example of a command exclude list for Interdependency collector that is supplied with CICS IA. You can compile it by using job CIUJCLXC that is also supplied with CICS IA.

Note:

This attribute is for CICS commands only, and cannot contain other non-CICS commands.

⓬ Determines whether the command include list will be used for corresponding command types.

If the value of a field is blank or N, it means no command include list is used for the corresponding type of commands. All commands of such type will be collected.
If the value of the field for IMS, MQ, Db2, or NAT is Y, then such type of commands will not be collected at all because the command include list is applied and it supports CICS commands only.
If the value of the field CICS is Y while the Command include list field contains a table that is not empty, only the commands from the list will be collected.
If the value of the field CICS is Y while the Command include list field is blank, or contains an empty table, no CICS commands will be collected.

Note:

The default value of these fields is blank, and command selection is inactive.

⓭ The journal name for trace data. The length of the name can be up to 8 characters. The default journal name is CIUMTJNL.

⓮ The LAST, USER or CFID criteria:

LAST specifies that the CIUJLCPY job must copy Command Flow records collected at the last Command Flow run.
USER specifies that the CIUJLCPY job must copy all the Command Flow records for the USER.
CFID specifies that the CIUJLCPY job must copy the Command Flow records that were collected for a specified Command Flow ID.

⓯ The 8-character user modifiable exit name that you can use to add data to a user Command Flow records.

⓰ Capturing called subprogram or main program under program name information for dynamically called COBOL program. Specify Y (Yes) or not N (No). The default value of this field is Y.

The ‘Y’ value instructs the collector to use a special CICS TS XPI, IDENTIFY_PROGRAM, to identify the dynamically called subprogram name.
For the "N" value -
1. The CICS IA collector records a top-level program name and marks the record with ‘-1’ (X’FFFFFFFF’) as a command offset for the command belonging to the dynamically called subprogram.
2. If a detected command belongs to a program unknown to CICS TS, then the CICS IA collector records a top-level program name and marks the record with ‘-1’ (X’FFFFFFFF’) as a command offset.

⓱ The number of CICS® tasks processed before stopping the collector. The default value of this field is 0. This value is used to indicate that there is no limit to the number of tasks for which command flow data is collected.

⓲ The number of CICS® IA journal records collected before stopping. The default value of this field is 0. This value is used to indicate that there is no limit to the number of journal records collected.

⓳ The control keys that you can use to select functions that control the operation of the CICS® IA User Command Flow Utility and provide help information about it. Actions are summarized in The User Command Flow Utility control keys on the Command Flow Options panel.

Table 1. The User Command Flow Utility control keys on the Command Flow Options panel
Action	Function key
Getting help information about the CICS® IA User Command Flow Utility.	F1
Starting the Command Flow data collection. The data collecting is started for all the CICS® regions from the user's regions configuration of the CICS® IA User Command Flow Utility. All the changed user command flow options are saved.	F5
Stopping collecting Command Flow data on all the CICS® regions from the user regions configuration.	F6
Displaying the statistics of the Command Flow data collection on all the CICS® regions from the user's regions configuration. (The CICS® IA User Command Flow Statistics panel, CIUA03, is displayed.)	F7
Accessing to the second part of the Command Flow options in order to view or change it. (The CICS® IA Command Flow ApplID list panel, CIUA02, is displayed.) This function does not preserve the Command Flow options changes made on the CIUA01 panel.	F4
Saving all the changed Command Flow options and returning to CICS®. Note: The changes of the Command Flow options are rejected if the Command Flow Collector is running.	F3
Saving all the changed Command Flow options without returning to CICS®. Note: The changes of the Command Flow options are rejected if the Command Flow Collector is running.	Enter
Returning to CICS® without saving any changed Command Flow options.	F12
Accessing Application Data collection options in order to view or change them. The CICS® IA Command Flow Application Data Collection panel, CIUA0A, is displayed. Note: This function does not preserve the Command Flow options changes made on the CIUA01 panel.	F10

Note:

Multiple users on the same CICS® region can use the CICS® IA Command Flow Utility concurrently. The current state of the CINC collector represents personal working status of the Command Flow data collection process for every user associated with the CINC transaction. The information about the current state includes working status itself (running or stopped) and the date and time when the Command Flow data collection process was last started by a user. (This option is reserved for future use.)
You can start the collection of the Command Flow data only when the current state of the CINC collector is stopped for you. The type of the data collected depends on what you have specified for the Command Flow options on the CICS® IA Command Flow Options and CICS® IA Command Flow ApplID list panels.
Natural programs control flow is collected if SYSRDC exit is active and scheduled at least once. It is recommended to use CIUXPROG exclude list to exclude unnecessary entries from the Command Flow collection.

Press F3 (or F12) to close the CICS® IA Command Flow Options panel. Closing the panel does not affect the state of the CINC collector.