Primary commands description


The following section describes File-AID/RDX primary commands. The command syntax is presented along with a brief explanation of the command function. For a more detailed explanation, refer to the section that covers the primary option(s) or sub-option(s) where the command is used. Commands processed identically in ISPF/PDF and File-AID/RDX are noted with an asterisk (*).

Several commands described below have repetition factors as valid operands. This is symbolized using the character n. Except where noted, n must be a positive integer value between one and 2,147,483,647.

Important

See Reading the Syntax Diagrams in Command-and-syntax-reference for an explanation of how to read the "railroad logic" diagrams used to notate primary command syntax.

ACCEPT (A)

Accept all suggested relationships to be included in the extract. When you press Enter, you return to the previous Extract Scope screen where you entered the CHECK command. Check Extract Warning screen only.

ADD (A)

Allows you to add an application relationship. Displays the Add Relationships — Specify Object Types screen so you can specify the parent and dependent object types for the new relationship. See Add Relationships — Specify Object Types.

ALL

Selects all available menu options for you to step through in sequence. Profile, Extract, and Load menus only. Selects all objects in the Object List Preview windows.

Selects and loads all RI relationships into the relationship file. Valid in the RI Relationship Detail Screen.

BACK (BA)

Displays the previous selection criteria set in a criteria file. Valid only on the Selection Criteria Specification Screen when defining or modifying multiple selection criteria sets (see Object Selection Criteria). There are no operands associated with this command.

CANCEL (CAN)

Exits the current panel without saving changes made to the data. There are no operands associated with this command.

CAPS

Controls whether alphabetic data entered should be automatically translated to uppercase or left as is.

The caps mode is not "remembered" from session to session. Instead, it is set to ON when you invoke File-AID/RDX. You can change the setting at any time using the CAPS command within File-AID/RDX.

image2021-12-9_10-8-52.png

CHANGE (C)

Allows you to globally replace character strings in the listed items on a panel. Valid parameters vary from panel to panel. When entered without any parameter, a Change Command window prompts for these parameters.

CHECK (CHE)

Use the CHECK command to verify the extract paths after you made navigational changes. When the path integrity validation processing is complete, the results are displayed in the Check Extract Warning window where you can resolve or ignore the findings. Extract Scope Relationship View screen only.

Important

CHECK is not valid when when the extract request is built with relationships in the Direct Plus or All Children Only mode (see Direct).

COND

Displays the Relationship Condition Definition panel where you can define a conditional test for the current AR. You must have already established a relationship before you can issue the COND command. Valid only on the Column/Field Relationships panels

There are no operands associated with this command.

CREATOR

Enter the CREATOR primary command in the graphical relationship display and all Db2 objects will include their Creator ID. This command acts as a toggle command, thus, when entering the command again, Db2 objects will include their Creator ID only when there is more than one object with the same name.

There are no operands associated with this command.

CURSOR*

Moves the cursor to the first input field on line two of the screen. This field is usually the OPTION or COMMAND field.

There are no operands associated with this command.

Db2

Switches to the corresponding Db2 Object panel, in order to specify Db2 objects. Valid only for the MVS Driving Object, MVS Relationship Facilitator, NEW MVS Object Filter, ObjectIn MVS Object Filter, or ObjectOut MVS Object Filter panels.

DELETE (DEL)

Deletes the current selection criteria set in a criteria file. Valid only on the Selection Criteria Specification Screen when defining or modifying multiple selection criteria sets (see Output Key File Definition). There are no operands associated with this command.

image2021-12-9_10-12-12.png

DETAIL (D)

Toggles the list display between a one-line and a two-line display in the Reference List screens.

DOWN

Causes scrolling toward the end of the data by the specified scroll amount.

image2021-12-9_10-12-42.png

EDIT (E)

Displays the JCL for this extract request. File-AID/RDX shows the Generated JCL panel where you review and modify the extract JCL. Extract - Db2 Driving Object and Extract - MVS Driving Object screens only.

END*

Terminates the current operation and returns control to the previous, higher-level screen. If you enter the END command on the File-AID/RDX Primary Option Menu, File-AID/RDX is terminated.

There are no operands associated with this command.

EXCLUDE (EX)

Exclude relationships from the extract or load process. Valid parameters vary from panel to panel. When entered without any parameters, an Exclude Command window prompts for these parameters.

EXPAND*

The EXPAND command enables you to view the full content of a scrollable field in a separate window. Db2 long object names are displayed in scrollable fields. In order to view a long name in a separate window, type EXPAND in the command line of the panel, move the cursor into the field to expand, and press ENTER.

There are no operands associated with this command.

FILTER (FIL)

The FILTER command restricts the relationships being displayed to the relationships for a specific object. Any relationship where the specified object is either a parent or a child will be displayed. The FILTER command can be issued to build a display that contains the relationships for multiple objects by choosing the option to retain the currently filtered list. For example, you could issue the FILTER command to display the relationships for PROJ resulting in a display of only the PROJ relationships. Then issue FILTER again, this time requesting the relationships for EMP and specifying to retain the currently filtered list. The resulting display will contain all relationships for PROJ and EMP. This is the same functionality available from the object view when the R line command is issued for multiple objects prior to the VIEW command.

FILTER Command Window

When you enter the FILTER command, File-AID/RDX will pop up the Filter Command Window as shown in the following figure. Enter the object for which you want to display all relationships, and specify the other filtered list options.

Filter Command Window

image2021-12-9_10-17-54.png

Specify the object name and filtered list options.

Object Name Field

Enter the name of the object for which to display all relationships.

Include Creator Name

Specify whether the displayed relationships for Db2 objects should also include the objects’ creator name.

Retain Current Filtered List

Enter Y to add the specified object to the current list of displayed relationships. Enter N to clear the current filtered list and display only the relationships for the specified object.

FIND (F)

The FIND command searches through data in the display and positions the line with the next occurrence of the specified find-string to the first line of the displayed data.
List of Panels supporting FIND command lists the panels where the FIND command can be issued.

Important

Entering FIND without parameters displays the window shown in Enter Find Parameter Window.

image2021-10-26_7-49-8.png

Find String

Value to be found. The first parameter for the FIND command is always the find-string. The find-string value is not case sensitive. Enclose the string in either single or double quotes when

  • find-string contains blanks.
  • find-string contains a single quote (’), you must enclose it in double quotes.
  • find-string contains double quotes ("), you must enclose it in single quotes.

Modifiers

Specify one of the following parameters to modify the search order.

NEXT

Default. Starts a search for the next occurrence of the find-string at the beginning of the first line being displayed (if the cursor is still on the COMMAND line), or at the cursor location (if the cursor is in the data part of the display).

ALL

Finds all occurrences of the find-string starting at the beginning of the first line of the data and continues to the bottom of data. If you specify both a column name and the ALL parameter, all occurrences in the specified column of the find-string are found.

PREV

Starts a search for the previous occurrence of the find-string starting at the end of the line preceding the first line being displayed (if the cursor is still on the COMMAND line), or at the cursor location (if the cursor is in the data display).

FIRST

Starts a search for the first occurrence of the find-string starting at the beginning of the first line of the data and continues until the string is found or the bottom of data is reached.

LAST

Starts a search for the last occurrence of the find-string starting at the end of the last line of the data and continues backward until the string is found, or the top of data is reached.

 List of Panels supporting FIND command

FIND with find-string, Modifiers and FIND Parameter Window

FIND with only find-string

  • Relationship Detail
  • RI Relationship Detail
  • Application Relationship Detail
  • Table List - SYSIBM.SYSTABLES
  • Extract Reference List
  • Load Reference List
  • Disguise Reference List
  • Delete Reference List
  • Request File Member List
  • Catalog Utility File List
  • New List (Disguise)
  • Data Disguise - Object List
  • Data Disguise - Column/Field List

FIND Parameter Window

When you enter the FIND command without any find-string, File-AID/RDX will pop up the Enter Find Parameter Window as shown in the following figure. Enter the find-string and modifier as described in Find String and Modifiers.

Enter Find Parameter Window

image2021-12-9_10-22-30.png

FORWARD (FOR)

Displays the next selection criteria set in a criteria file. Valid only on the Selection Criteria Specification Screen when defining or modifying multiple selection criteria sets. There are no operands associated with this command.

FUNCTION LOCK

Enables the “Lock Table during Extract” function for all Db2 objects. The Extract-Scope-Object-View-panel panel will display and enable the L line command and display the L status column. See also L (Lock Table). FUNCTION LOCK is a toggle switch so enter FUNCTION LOCK again to return to the original format. Extract Scope - Object View panel only. There are no operands associated with this command.

Important

The FUNCTION LOCK primary command is only valid if File-AID/RDX was configured at installation to allow locking tables during extract.

GEN

  1. Processes the selected execute saved request (ESR) options without displaying any JCL. Before issuing the GEN command, make sure you have specified the desired requests from the request file, the ESR JCL file, and any override files. File-AID/RDX will not issue a message upon completion of the job. Valid on the  Execute Saved Request (ESR) Options panel.
  2. Processes the Generate DDL utility request. Before issuing the GEN command, make sure you have specified the desired input and output files. File-AID/RDX will issue a message upon completion. Valid on the Generate DDL Utility panel.

GO (G)

Submits an extract request from the  Extract - Db2 Driving Object or Extract - MVS Driving Object panel.

Submits a File-AID/RDX utilities job from the  Print Disguise Control File, Print Disguise Audit Trail,  Batch RI Load,  Update Saved Extract Requests, or  Extract File Compress Utility panel.

GRAPHIC (G,GR)

Displays the Graphical Relationship Display screen. This command is valid from the Browse - Relationship Detail screen, the AR Relationship Detail screen, the RI Relationship Detail screen, and the Relationship Criteria screen. There are no operands associated with this command.

HELP*

Shows the extended description of a message that has been displayed, or invokes the online tutorial facility. If File-AID/RDX displays a message in the upper right corner, entering the HELP command will display the extended description on line three of the screen. The tutorial is invoked by immediately entering another HELP command, or by entering HELP when no message has been displayed.

There are no operands associated with this command.

HIDE (H)

The HIDE command allows less data to be displayed. Included, excluded and special status objects can be removed or hidden from the display so that the remaining content is more meaningful. Special status is any status other than blank or excluded; this will include any error messages and any objects where criteria has been provided at the relationship level as well as the object level. Use the RESET command to return all hidden objects to the display. Valid Parameters differ between Extract Scope and Target Environment implementation.

IGNORE (I)

Ignore all flagged relationships, they will not be included in the extract and their status changes to “Relational error ignored”. You can still use the Accept Path line command to change the status individually or enter the ACCEPT primary command. Check Extract Warning screen only.

INSERT (INS)

Inserts a new selection criteria set after the currently displayed set in a criteria file. The new set’s id number equals the current set’s number incremented by 1. Example: current id = 3 of 5, id of inserted set= 4 of 6. Any following set id numbers in the criteria file are of course incremented accordingly, for example 4 of 5 becomes 5 of 6, 5 of 5 becomes 6 of 6. Valid only on the Selection Criteria Specification Screen when defining or modifying multiple selection criteria sets (see Output Key File Definition). There are no operands associated with this command.

image2021-10-26_7-50-16.png

KEYLIST*

Calls the key list utility so you can browse and modify the File-AID/RDX keylists as defined for all File-AID/RDX CUA panels.

image2021-12-9_10-26-15.png

Important

ON and OFF are only valid for ISPF version 4.1 or newer.

KEYS*

Causes an immediate display of a screen on which current PF key definitions are shown and can be modified.

There are no operands associated with this command.

LEFT

Causes scrolling toward the left margin of the data by the specified scroll amount. Valid on the Selection Criteria screen only.

image2021-12-9_10-27-45.png

LIMITKEY (LK)

Displays the Limit Key Definition screen which lets you define the limit key value for each logical partition, if the tablespace is partitioned. Valid in the Create Tablespace, Create Db2 Table, and Create Index panels.

LOCATE (L)

Searches the sorted column of the displayed list and positions the line with the first occurrence of the LOCATE value to the first line of the displayed data. Valid whenever a list is displayed. If the list has not been sorted, enter a line number.

image2021-12-9_10-28-21.png

value

Value to locate. Either the beginning string of the sorted column’s entry, or a line (row) number for an unsorted list (see also SORT).

MENU

Switches to the full Extract or Load Menu from an extract or load submenu when in flow mode. Toggles between displaying all or a subset of options in the File-AID/Data Solutions Criteria Menu.

MODE

Use the MODE command to switch the current extract or load mode to either INTERACTIVE (online) or BATCH, if your installation allows extract or load requests to be executed online. Extract Menu and Load Menu only.

There are no operands associated with this command.

MVS

Switches to the corresponding MVS Object panel, in order to specify MVS objects. Valid only for the Db2 Driving Object, Db2 Relationship Facilitator, NEW Db2 Object Filter, ObjectIn Db2 Object Filter, or ObjectOut Db2 Object Filter panels.

NAVIGATION (NAV)

The NAVIGATION command takes you directly to the NAVIGATION format of the relationship view. Extract Scope Object View and Extract Scope Relationship View screens only.

NEW (N)

Creates a new extract, load, or delete request or a new disguise object list. (Reference List and Request File Member List screens only).

Also defines a new associated criteria rule in the Associated Rules List.

For an extract request or disguise object list, include one of the optional parameters, Db2 or MVS, to display the respective Driving Object screen.

image2021-12-9_10-29-28.png

NEXT (N)

Displays the next screen in the process being performed.

There are no operands associated with this command.

OBJECTIN (OI)

Allows you to add objects to your current object list. This command displays either the “ObjectIn - Db2 Object Filter” or “ObjectIn - MVS Object Filter” screen. The ObjectIn Filter panels work the same as the NEW - Db2 Object Filter and NEW - MVS Object Filter.

OBJECTOUT (OO)

Allows you to remove objects from your current object list. This command displays either the ObjectOut - Db2 Object Filter or ObjectOut - MVS Object Filter screen.

PARTITION (PART)

Displays the “Partition Definition” screen which lets you define the attributes for each index/tablespace partition (Edit Tablespace and Edit Index screens only).

PREV

Goes to previous selected menu option in flow mode (Profile screens only).

PRINT*

Causes a snapshot of the current screen to be recorded in the ISPF/PDF list file for subsequent printing.

There are no operands associated with this command.

PRINT-HI*

Same as PRINT except that high-intensity characters on the screen are printed with overstrikes to simulate the high-intensity display.

There are no operands associated with this command.

PRINTL*

Causes a snapshot of the current logical screen to be recorded in the ISPF/PDF list file.

There are no operands associated with this command.

PRINTLHI*

Same as PRINTL except that high-intensity characters on the screen are printed with overstrikes to simulate high-intensity display.

There are no operands associated with this command.

REFERENCE (REF)

Switches to the applicable Reference List from a Request File Member List or from the Extract or Load Menu.

REFRESH (R)

Refreshes the list of objects of the Target Environment screen. Use the REFRESH command after changes to the listed objects have an influence on the hierarchal and alphabetical order of the display.

REPEAT (REP)

Repeats (duplicates) the current selection criteria set after the currently displayed set in a criteria file. The new set’s id number equals the current set’s number incremented by 1. Example: current id = 1 of 5, id of inserted set= 2 of 6. Any following set id numbers in the criteria file are of course incremented accordingly, for example 2 of 5 becomes 3 of 6, 3 of 5 becomes 4 of 6, etc.. Valid only on the Selection Criteria Specification Screen when defining or modifying multiple selection criteria sets (see Output Key File Definition). There are no operands associated with this command.

image2021-12-9_10-30-42.png

REPORT (REP)

Prints the currently displayed object or relationship list. Valid on the Extract Scope Object View and Relationship View panels only.

REQUEST (REQ)

Switches to the applicable Request File Member List from a Reference List or from the Extract or Load Menu.

RESET (RES)

Use the RESET command to return all hidden objects to the display. Extract Scope Object View and Extract Scope Relationship View screens only.

RETRIEVE*

Causes a previously entered command to be recalled to the command line.

There are no operands associated with this command.

RETURN

Causes an immediate return to the File-AID/RDX Primary Option Menu.

There are no operands associated with this command.

RFIND

The RFIND command repeats the previous FIND command.

RIGHT

Causes scrolling toward the right margin of the data by the specified scroll amount. Valid on the Selection Criteria screen only.

image2021-12-9_10-37-15.png

SAMPLE

The SAMPLE command takes you directly to the SAMPLE format of the relationship view. Extract Scope Object View and Extract Scope Relationship View screens only.

SHOW (SH)

The SHOW command alters the contents of the SHOW column in the Target Environment screen. Depending on the specified parameter, the SHOW column can display the associated database, tablespace or stogroup information for the appropriate Db2 objects in the list. SHOW without a parameter displays the SHOW COMMAND window. Target Environment screen only.

image2021-12-9_10-39-7.png

SIZE (SI)

Toggles the size of list display area by hiding or displaying the panel header lines in various list display screens.

SORT

Sorts the displayed list by the specified column name. After sorting a column you can use the LOCATE primary command in that column. Valid whenever a list is displayed.

image2021-12-9_10-39-39.png

SPLIT*

Causes split screen mode to be entered or the location of the split line to be changed. The position of the split line depends on the cursor location at the time the command is entered.

There are no operands associated with this command.

SQL

Invokes an edit session on selection criteria in SQL format. Valid on the Selection Criteria screen.

There are no operands associated with this command.

SQLID

Enter the SQLID primary command to change or view the Db2 SQLID for the current load session. Each load session starts with the default SQLID as specified in the load profile (see also Default SQLID). In the Set SQLID window, enter the desired SQLID. USER is a valid entry and changes the SQLID to match the current userid. If you blank out the SQLID, it defaults to the SQLID as specified in the load profile.

STATUS (STAT)

The STATUS command takes you directly to the STATUS format of the relationship view. Extract Scope Object View and Extract Scope Relationship View screens only.

SUBMIT*

Submits the JCL for execution. Valid only on the ISPF/PDF EDIT screen shown in the Extract, Load and Delete functions.

SUGGEST (SUG)

The SUGGEST command suggests a relationship when the parent and dependent column or field name, type and length are identical. Column/Field Relationships screens only.

SWAP*

Positions the cursor to wherever it was previously located on the other logical screen of a split screen pair.

There are no operands associated with this command.

TABLE (TAB)

Displays the “Tables Within View” screen which lists the tables that are part of the complex view. Edit View screen only.

TSO*

Allows a TSO command or CLIST to be entered from the COMMAND or OPTION field of any screen.

There are no operands associated with this command.

UDTSWAP

Swaps the display for distinct type columns from UDT name to the built-in data type and length and vice versa. This command is valid only on the Driving Table Selection Criteria, Table Selection Criteria (Extract), and Column Mapping (Load) screens.

There are no operands associated with this command.

UDTTYPE

Lists all distinct data types (UDTs) that are part of the extract. The list displays the schema, UDT name, and the built-in data type and length. This command is valid only on the Driving Table Selection Criteria and Table Selection Criteria screens.

There are no operands associated with this command.

UNEXCLUDE

Causes all the relationships on the list displayed to be included again in the extract or the load process. This command is valid only on the Extract Scope - Object View, Relationship Criteria and Source to Target Mapping screens. The optional parameters Db2, KEY, and MVS limit the UNEXCLUDE command to one of the three object types. ALL is the default.

image2021-12-9_10-40-44.png

UP

Causes scrolling toward the top of the data by the specified scroll amount.

image2021-12-9_10-41-8.png

VALIDATE

Validate all relationships before you continue with the extract process. The message “No changes” informs you that all relationships have been successfully validated. If there are inconsistencies, the Update Saved Request window reports the validation results and gives you the opportunity to update the extract request. Extract Scope - Relationship View panel only.

Important

VALIDATE is not valid when when the extract request is built with relationships in the Direct Plus or All Children Only mode (see Direct).

VIEW (VI)

The VIEW command allows you to easily switch between the object and relationship views. SAMPLE, STATUS and NAVIGATION can be used to go directly to the corresponding format of the relationship view. These commands are not included on the primary command line for the object view but will be processed if entered. Extract Scope Object View and Extract Scope Relationship View screens only.

image2021-12-9_10-41-49.png

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*