Review Interface Basics

Before you begin using the products, General Facilities, and Value Pack components that are included in the productgroup, we recommend that you review the following interface basics:
dm20
Before you begin using the products, General Facilities, and Value Pack components that are included in the
CA Database Management Solutions for DB2 for z/OS
, we recommend that you review the following interface basics:
3
3
We also recommend that you review the following basic interface components:
  • Interproduct interface
  • Extended query facility
  • SQL editor
  • Callable interface
  • Offline reports
Review the following topics for information about managing started tasks for the
CA Database Management Solutions for DB2 for z/OS
:
  • Report started task state and status to CA OPS/MVS
  • Manage the Xmanager started task
  • Using Xnet
After review of these topics, you can begin using the products and shared functions that are included in the
CA Database Management Solutions for DB2 for z/OS
.
Location, SSID, Version Fields
Location, DB2 subsystem ID (SSID), and Version fields appear in the header portion of most product panels. These fields let you specify a location and DB2 subsystem. They also identify the DB2 version that was defined for the subsystem in SETUPxx global parmlib member.
  • Location
    Specifies a location name for a DB2 subsystem where the objects, plans, DBRMs, packages, user IDs, and so on, reside. Distributed Data Facility (DDF) is supported. You can access information about remote objects and remote user IDs by specifying a remote location. The default is LOCAL.
  • SSID
    Specifies the DB2 subsystem ID that your product connects to. Your request is processed on this subsystem ID.
  • Version
    Identifies the DB2 version for the subsystem that is specified in the SSID field. This field is display only. 
To view a list of remote locations, available subsystem IDs, load libraries, and install system administrators (SYSADM) for those subsystems, enter a question mark (?) in the Location or SSID field on any product panel.
You can easily switch between different DB2 subsystems, even different DB2 versions, without having to exit the products and reallocate load libraries. To switch subsystems, enter the new subsystem ID in the DB2 subsystem ID field (SSID), which appears on most of the product panels. This feature lets you view a report on one subsystem, change the SSID, and view the same report on the newly specified subsystem. You can even select a subsystem from a subsystem listing.
In general, you can use products in a split screen mode. However, the DB2 Call Attach Facility does not let you simultaneously connect to two different subsystems. If you change subsystems in one of the sessions, unpredictable results can occur. See the IBM
DB2 Application Programming
documentation for more information.
Commands and PF Keys
You can execute commands by entering them on the command line or using the PF (F) keys.
Line Commands
Line commands are specified next to an object and executed when you press Enter. You can execute commands with the full command name or a valid abbreviation.
If you make an error, a message appears in the space directly under the command line. You can press F1 (Help) to display more information about the error.
PF Keys
The following list shows the PF (F) keys and the default commands that are assigned to them. These default settings apply to new users of the products. If you have used previous releases of these products, your settings can differ from those shown. An application profile is maintained for each user. PF key settings are stored in your profile.
Use the PFSHOW (ON and OFF) command to show or hide the PF key values on the bottom of the product panels. Use the KEYS command to change the default PF key settings in the PF key profile. When you change the PF key assignments in one product, the changes are also made to the other products that use the shared PF key profile. You can assign PF keys to system commands (like HELP or END), function commands (like FIND and CHANGE, and line commands (like edit I and D). You can also assign labels to the function keys. (The CA Report Facility maintains its own PF key assignments.
  • HELP (PF1/13)
    Invoke online help/tutorial system.
  • SPLIT (PF2/14)
    Divide into two panels.
  • END (PF3/15)
    End the process.
  • RETURN (PF4)
    Return to the primary option menu.
  • RFIND (PF5)
    Repeat a FIND command that you entered in browse or edit.
  • RCHANGE (PF6)
    Repeat a CHANGE command that you entered in edit.
  • UP (PF7/19)
    Scroll panel up.
  • DOWN (PF8/20)
    Scroll panel down.
  • SWAP (PF9/21)
    Jump between split panels.
  • LEFT (PF10/22)
    Scroll lower panel window left.
  • RIGHT (PF11/23)
    Scroll lower panel window right.
  • RETRIEVE (PF12/24)
    Recall previously entered command to the command line.
  • MAIN (PF16)
    Cancel processing and return to the Main Menu.
  • EXIT (PF17)
    Exit and return to the Main Menu.
  • QPRINT (PF18)
    Print entire report.
ISPF Display Interface
The ISPF Display interface is standardized on existing ISPF behaviors making it more user friendly and intuitive. It supports many commands and options to further simplify the user experience when navigating the product panels. Review the following ISPF commands:
  • Scroll
  • Print
  • Selection criteria
Scroll Commands
Scroll commands similar to those used in ISPF environments are supported. With these commands, you can scroll up and down. You can also scroll columns, pages, left (side of page), and right (side of page).
Notation Conventions
The following notation conventions are used for the scrolling command syntax:
  • UPPERCASE characters (enter as shown)
  • lowercase italicized characters (denote user-specified variables)
  • Brackets (enclose optional parameters)
Any panel that contains the Scroll field, which is displayed in the upper-right corner of the panel, lets you enter scroll amounts. The Scroll field determines the scrolling amount for a report or listing when you enter the up, down, left, or right scroll commands, or press the appropriate PF keys. Enter a question mark (?) in the Scroll field for a list of valid values.
You can use the SCROLLB and SCROLLC scroll modes to control horizontal scrolling when the report or listing is wider than the panel.
Field and Column Level Scrolling
Scrollable fields are identified on the panels by the less than (<) or greater than (>) symbols next to the field. To scroll the field, place the cursor in the field and use the left or right PF keys to view the data.
In a table of columns, the entire column is scrolled by placing the cursor on a field in the column and using the left or right PF keys.
In SCROLLB and SCROLLC TRUNCATE modes fields can become truncated as a result of left or right scroll operations. These fields may show less than (<) or greater than (>) symbols to indicate data truncation. These fields are considered truncated by panel. Do not confuse them with scrollable fields even though they look the same. Usually fields that are truncated by panel are not made scrollable, except for those fields that are wide and do not fit within the scrollable area.
The EXPAND primary command can be used (typically through an assigned PF key) to edit or view the entire field contents of both scrollable and truncated by panel fields. To view the entire contents of a field, place the cursor in the field, and press the expand PF key or type EXPAND on the command line. The Expanded View panel appears.
PTPEXLVV ------------------- Expanded View --------------------------- COMMAND ===> _________________________________________________________  INDEX NAME: PDT_IDENTITY_NPI_ON_IDENTITIY_TABLE_FOR_TEST_CASE_A03327
The value is wrapped across multiple rows within the window display width. If the expandable field can be updated, the Expanded Edit panel appears instead.
If the value is changed and saved, a new short-value is generated before the original panel appears again.
Report Considerations
When you scroll within the reports or listings for a product, consider that the first report page may not appear immediately. This processing occurs because the whole report is produced internally before the first page appears. This technique is used to release the DB2 system catalog as quickly as possible and avoid any potential locking problems.
For each report that supports horizontal scrolling, one column is frozen by default. A frozen column is fixed horizontally on the panel; it does not move when you scroll horizontally. The column that is frozen by default is always the leftmost column, which represents the object of inquiry.
When the application presents two separately scrollable reports or lists on a single panel, the cursor location is used to identify which scrollable report or list the command applies to. To scroll the first report or list, place the cursor within that report or list or move outside of all scrollable areas at the top of the panel. To scroll the second scrollable area, place the cursor within that scrollable area of the panel.
Scroll Command Syntax
You can enter the scroll commands on the command line or assign them to PF keys. If a command is not supported on a specific panel, you receive a message when you enter the command.
Note:
 For more information about each command or to display a list of valid commands for the product panel, enter a question mark (?) in the command line to access the online help.
The following scroll commands can be specified:
  • CLOCATE|CLOC 
    column name
    Locates any column of a wide report.
  • EXCLUDE|X 
    column name
    Excludes a column from a scrollable list.
  • FIND|F 
    value
     {
    column name
    }
    Finds a character string in scrollable data and can optionally include a column name.
  • FIND2|F2 
    value
     {
    column name
    }
    Finds the first occurrence of a character string in the second scrollable area of a panel.
  • FREEZE|FR 
    column name
    Freezes a column in a scrollable list.
  • MELT|ME
    Releases a previously frozen column.
  • REPORT|RE [SAVE|RESET|DISPLAY]
    Saves the panel format to an ISPF profile variable.
  • RFIND|RF
    Repeats the last find command.
  • SCROLLB|SB
    Sets the left and right scrolling mode to byte scrolling.
  • SCROLLC|SC [TRUNCATE|T]
    Sets the left and right scrolling mode to column scrolling.
  • SETWIDTH|SW 
    column name
    Sets the column width to show more or less information.
  • SHOW|SH
    Shows a previously excluded column.
  • SORT 
    column name
     {A,D}
    Sorts a scrollable list.
  • SORT2 
    column name
     {A,D}
    Sorts the rows in the second scrollable area in ascending (default) or descending order according to the values in the designated column.
  • UNFREEZE|UN 
    column name
    Releases a previously frozen column.
Truncated Fields
When navigating the product panels in SCROLLB or SCROLLC TRUNCATE mode, the interface might truncate fields on either side of the scrollable area and place the < (front truncation) or > (rear truncation) symbols in those fields.
Truncated fields and scrollable fields use the same symbols to indicate field and data truncation respectively. However, while scrollable fields can always be scrolled, truncated fields cannot.
To reveal the full field, you can:
  • Put the cursor in the field and press the EXPAND key (a PF key assigned to the EXPAND command).
  • If the field is a column, you can use the SETWIDTH command to increase the width of the column.
Print Commands
Before you use these commands, use the GP option on the CA Database Management Solutions Main Menu to define the default settings to be used with all products. You can use the QPRINT, PPRINT, QFILE, and PFILE commands to dynamically allocate a SYSOUT data set for each print request or send the output to a data set.
The print output resides under your TSO ID. Depending on the values specified in your print options, the output is held or routed to the requested printer. If you print a report with truncated fields or save it to a data set, truncated strings in those fields are suffixed by a truncation character in the offline report.
The following print commands can be specified:
  • QPRINT|QP FULL
    Prints the current report. If the report width exceeds the PRINTLINE SIZE, the printed report is truncated. When FULL is specified, the printed report is not truncated.
  • PPRINT|PP
    FULL
    Prints the part of a report that is currently displayed on the panel. When FULL is specified, the report prints with everything to the left and right of the displayed panel along with its contents.
  • QFILE
    Prints the entire report to an output data set. A prompt displays for you to specify the data set name.
  • PFILE
    Prints the displayed portion of the report to an output data set. A prompt displays for you to specify the data set name.
Selection Criteria
Many product fields accept selection criteria. Selection criteria let you specify a portion of a character string. The product then searches for all occurrences that match the selection criteria. Selection criteria can be an asterisk (*), a percent sign (%), or an underscore (_).
  • * (Asterisk)
    Selects all objects.
    Example:
     DSN* selects all the objects containing DSN.
  • % (Percent sign)
    Specifies that zero or more characters can occupy that position and all remaining positions to the end of the name or to the next character. This can appear at any location in the name.
    Example:
     DSN% retrieves all names that start with DSN. DSN%06 retrieves all names that start with DSN and end with 06.
  • _ (Underscore)
    Specifies that any character can occupy that position. You can repeat the underscore character at multiple locations within the field.
    If a character does not appear at the underscore's location, the match fails. This is different from the percent (%) character because an underscore does not match zero characters.
    Example:
     DSN_B__ matches DSNDB06 and DSNXBPH.
Help Facility
You can access help at any time by pressing the Help key (PF1 by default). Product help is context sensitive, meaning that you get help associated with the panel you are currently viewing. For example, if you press PF1 while the Plan List report displays, the help panel associated with the Plan List report displays.
The product help system is based on the standard ISPF/PDF help system:
  • Display primary commands
  • View line commands help
Display Primary Commands
You can enter primary commands on the command line found at the upper-left corner of any product panel. Primary commands are listed in the following categories:
  • Panel-specific commands that are valid only on the current panel.
  • Product-specific commands that are valid from any command line in the active product.
  • Global commands that are valid from any product or function. These commands are valid as long as you do not try to jump to a product or function that is already active in your session. For example, if you execute a BIND line command for a package from CA RC/Query® for DB2 for z/OS, you are taken into CA Plan Analyzer® for DB2 for z/OS. To return to CA RC/Query® for DB2 for z/OS, press PF3. You cannot use the RCQ command because you already have an active session for CA RC/Query® for DB2 for z/OS.
Scrollable panel commands that are valid on any scrollable panel. These panels have an active SCROLL field in the upper-right corner.
You can view a list of valid primary commands from any panel.
To view primary commands help, type a 
?
 (question mark) on the command line and press Enter. The Primary Command Display panel appears.
Command abbreviations are shown in uppercase with a brief description of the command. From this panel, you can enter the following commands in the selection area:
  • ? to see more information about a command.
  • S to execute the command.
Use the PF7 or PF8 keys to scroll up or down. Press PF3 (End) to return to the panel from which you originated.
View Line Commands Help
Most panels display a CMD field. CMD accepts line commands that affect only the item next to it. Valid line commands are typically listed at the bottom of the panel.
To view line commands help (a list of line commands you can use in a specific CMD field), type a 
?
 (question mark) in the CMD field and press Enter. The Line Command Display for the panel you are on appears.
Available line commands and a brief description are provided. From this panel, you can enter the following commands in the selection column:
  • ? to see more information about a specific command.
  • S to execute the command.
Use the PF7 or PF8 keys to scroll up or down. Press PF3 (End) to return to the panel from which you originated.