Start of README v1.2

IVIEW - Drilldown for ISERIES


IVIEW was developed by McKay Software Services Ltd www.mckaysoftware.ie

This describes the purpose and components of IVIEW and how to download, install, and use IVIEW.

IVIEW is a drill down program for AS400 / ISERIES.
It retrieves relevant information available through commands such as
DSPOBJD, DSPFD, DSPDBR and DSPFFD
and displays this in an integrated series of displays.
All the displays are green-screen.  This is targetted at V5R3 and later of OS/400.
Various IBM supplied API's are used to harvest the information.
Thus it is possible to start with all the objects in QSYS
and drill down to the list of fields in a file.
Please note that this, the first release, provides detailed information on files only.
Later releases of IVIEW will provide information on other object types.

    CONTENTS

  1. OPERATION
  2. COMMAND KEYS
  3. To run IVIEW
  4. SAVEFILE
  5. SHIPPING LIST
  6. Change Log

  1. OPERATION
  2. IVIEW is called with the command IVIEW.  The parameters are ...
    • Object(s)
    • Library
    • Type

    When the user presses Enter on the command, the first screen OBJECT LIST is displayed.

    ENTRY LEVEL SECOND LEVEL THIRD LEVEL FOURTH LEVEL
    OBJECT LIST
    Option 1 ---> OBJECT OVERVIEW
    Option 2 ---> FILE OVERVIEW
    F5 - FORMATS ---> RECORD FORMATS
    Option 1 ---> FIELDS
    Option 2 ---> INDEX
    Option 3 ---> SELECT / OMIT
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F6 - LOGICALS ---> LOGICALS
    Option 1 ---> FILE OVERVIEW (LOGICAL)
    Option 1 ---> FILE OVERVIEW (PHYSICAL)
    F5 - FORMATS ---> FORMATS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS --->TRIGGERS
    F10 - CONSTRAINTS --->CONSTRAINTS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F8 - MEMBERS ---> MEMBERS
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F9 - TRIGGERS ---> TRIGGERS
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F14 - PATH ---> ACCESS PATH OVERVIEW
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F13 - FILE ---> FILE OVERVIEW
    F15 - PF ---> PHYSICAL FILE OVERVIEW
    F16 - LF ---> LOGICAL FILE OVERVIEW
    F19 - AUTH ---> FILE AUTHORITIES OVERVIEW
    F15 - PF ---> PHYSICAL FILE OVERVIEW
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F13 - FILE ---> FILE OVERVIEW
    F14 - PATH ---> ACCESS PATH OVERVIEW
    F19 - AUTH ---> FILE AUTHORITIES OVERVIEW
    F16 - LF ---> LOGICAL FILE OVERVIEW
    F5 - FORMATS ---> FORMATS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F13 - FILE ---> FILE OVERVIEW
    F14 - PATH ---> ACCESS PATH OVERVIEW
    F19 - AUTH ---> FILE AUTHORITIES OVERVIEW
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F13 - FILE ---> FILE OVERVIEW
    F14 - PATH ---> ACCESS PATH OVERVIEW
    F15 - PF ---> PHYSICAL FILE OVERVIEW
    F16 - LF ---> LOGICAL FILE OVERVIEW
    F19 - AUTH ---> FILE AUTHORITIES OVERVIEW
    F5 - FORMATS ---> FORMATS
    F6 - LOGICALS ---> LOGICALS
    F7 - JOINS ---> JOINS
    F8 - MEMBERS ---> MEMBERS
    F9 - TRIGGERS ---> TRIGGERS
    F10 - CONSTRAINTS ---> CONSTRAINTS
    F13 - FILE ---> FILE OVERVIEW
    F14 - PATH ---> ACCESS PATH OVERVIEW
    F15 - PF ---> PHYSICAL FILE OVERVIEW
    F16 - LF ---> LOGICAL FILE OVERVIEW
    Command IVIEW loads the program.
    The parameters for IVIEW are ...
    • Object
    • Library
    • Type

    The default for Object is *ALL
    The default for Library is QSYS
    The default for Type is *ALL


    The user can select an object name, e.g. QCLSRC, or a generic name, e.g. QCL* or leave *ALL for all objects.
    Then the user can change the library name. A full library name must be entered. *CURRENT is not recognized.
    Finally, the user can select a type of object, for example *FILE.
    F4 will display a list of available object types.
    The first screen, OBJECT LIST (S2), defaults to the parameters from the command.
    This screen lists the objects of the selected type in the library.
    The user can change the parameters, or continue with those from the command.

    OBJECT LIST shows the following details:
    • Object
    • Type
    • Description

    OBJECT LIST has two options and a number of command keys.

    When the user presses ENTER, the list of objects is displayed.

    Option 1 gives some generic information on the object selected on the OBJECT OVERVIEW (S4) screen.
    Option 2 gives an overview of the file on the FILE OVERVIEW (FA) screen.


    F17 and F18 will display the top or bottom of the subfile.

    F3 will end the program.

    The OBJECT OVERVIEW (S4) screen lists the following details:
    • Extended Attribute
    • User Attribute
    • Owner
    • Size
    • Created
    • Changed
    • Last Used
    • Saved
    • Restored
    • Journal

    F12 and F24 will return to the previous screen.

    F3 will end the program.

    FILE OVERVIEW (FA) lists meta-data for the file.

    This is meta-data for the file as an object.

    Command keys enable the user to drill down to view data specific to the file type or the formats.

    When the user presses ENTER, the list of objects is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on FILE OVERVIEW are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    • F14 Path
    • F15 PF
    • F16 LF
    • F19 Auth
    ACCESS PATH OVERVIEW (FB) displays the following access path information for the file.

    • Description
    • Type
    • Maximum Key Length
    • Nulls duplicate key action
    • Primary key access path
    • Primary Key
    • Size
    • Number of key fields
    • Forced Keyed Access Path
    • AltSeq
    • Recovery
    • Journalled
    • Maintenance
    • Unique Constraint
    • Floating Point Key
    When the user presses ENTER, the access path information is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on ACCESS PATH OVERVIEW are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    • F13 File
    • F15 PF
    • F16 LF
    • F19 Auth
    PHYSICAL FILE OVERVIEW (FC) displays the following physical file information.

    • Member Size
    • Initial Number of Records
    • Maximum Increments
    • Number of Triggers, Constraints
    • % Deleted Records
    • ReUse Deleted Records
    When the user presses ENTER, the physical file information is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on PHYSICAL FILE OVERVIEW are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    • F13 File
    • F14 Path
    • F16 LF
    • F19 Auth
    LOGICAL FILE OVERVIEW (FD) displays the following logical file information.

    • Select/Omit Statements
    • Dynamic Select/Omit
    • Join File
    • Record Format Selector
    • Program
    • SQL View/Data/Index
    When the user presses ENTER, the logical file information is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on LOGICAL FILE OVERVIEW are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    • F13 File
    • F14 Path
    • F15 PF
    • F16 LF
    • F19 Auth
    FILE AUTHORITIES OVERVIEW (FF) displays the following information on the file authorities.

    • Allow Read
    • Allow Write
    • Allow Update
    • Allow Delete
    • Public Authority
    When the user presses ENTER, the following information on the file authorities is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on FILE AUTHORITIES OVERVIEW are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    • F13 File
    • F14 Path
    • F15 PF
    • F16 LF
    Screen RECORD FORMATS (SB), lists the record formats on the file.


    The record format name and the description are given.

    The RECORD FORMATS screen has three options and a number of command keys.
    When the user presses ENTER, the names of the Formats are displayed.

    Option 1 lists the fields on screen S9.
    Option 2 lists Index fields on screen SJ.
    Option 3 lists Select/Omit details on screen SM.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    The other function keys on RECORD FORMATS are
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    • F10 Constraints
    Screen FIELDS (S9) lists the fields on the record format.

    The following field related information is provided:
    • Field Name
    • Start Position
    • Length
    • Size
    • Decimal Positions
    • Type
    • Usage
    • Text
    • Column Headings
    When the user presses ENTER, the list of fields for the record format is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    F11 will unfold / unfold to display the Text and Column Headings
    Screen INDEX KEY FIELDS (SJ) lists the index fields on the record format.

    The related sequence information is provided.
    When the user presses ENTER, the list of index key fields for the record format is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    Screen SELECT / OMIT FIELDS (SM) lists the select / omit rules on the record format.

    Each field name, rule and compare value is provided.
    When the user presses ENTER, the list of select / omit rules for the record format is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    Screen MEMBERS (S6) lists the members in the file.

    The member name, number of records and description are provided.
    When the user presses ENTER, the list of members is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    The other function keys on the MEMBERS screen are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F09 Triggers
    • F10 Constraints
    Screen TRIGGERS (SP) lists the triggers over the file.

    The following pieces of information are provided.
    • Time
    • Event
    • Program
    • Repeat
    • Threadsafe
    • Multithreaded
    When the user presses ENTER, the list of triggers over the file is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    The other function keys on the TRIGGERS screen are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F10 Constraints
    Screen CONSTRAINTS (SS) lists the constraints over the file.

    The following pieces of information are provided.
    • Type
    • Event
    • Program
    • Repeat
    • Threadsafe
    • Multithreaded
    When the user presses ENTER, the list of constraints over the file is displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    The other function keys on SS are
    • F05 Formats
    • F06 Logicals
    • F07 Joins
    • F08 Members
    • F09 Triggers
    Screen LOGICALS (SD) lists the logical files over the physical file.

    The following pieces of information are provided.
    • Logical File Name
    • Description
    • Number of joins
    When the user presses ENTER, the list of logical files over the phyical file is displayed.

    Option 1 will display the FILE OVERVIEW for the based-on physical file.
    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    Screen JOINS (SG) lists the details of those logical files which are also join files.

    The following pieces of information are provided.
    • Join File Names
    • Join Field Names
    When the user presses ENTER, the details of the join file are displayed.

    F12 will return to the previous screen.
    F24 will return to the first screen, OBJECT LIST.
    F3 will end the program.

    F17 and F18 will display the top or bottom of the subfile.

    ===>CONTENTS

  3. COMMAND KEYS
  4. The following command keys are used ...
    F3 Exit F3 ends the program.
    F4 List Object Types F4 lists the type of object available to select.
    F5 Formats F5 lists the formats for the selected file on screen FORMATS (SB).
    F6 Logicals F6 lists the logical files attached to the selected physical file on screen SD.   This is similar to DSPDBR.
    F7 Joins F7 expands a joined logical file on screen SG.
    F8 Members F8 lists the members in a physical or logical file on screen S6.
    F9 Triggers F9 lists the triggers on a physical or logical file on screen SP.
    F10 Constraints F10 lists the constraints on a physical or logical file on screen SS.
    F11 Unfold / Fold F11 unfolds / folds the field detail on S9.
    F12 Previous F12 returns to the previous screen.
    F13 File Overview F13 displays the file overview on screen FA.  This is the same as is displayed by option 2 on the initial screen S2.
    F14 Access Path Overview F14 gives an overvew of the access path on screen FB.
    F15 Physical File Overview F15 gives an overvew of the physical file on screen FC.
    F16 Logical File Overview F16 gives an overvew of the logical file on screen FD.
    F17 Top F17 will re-display the first page of a subfile listing.
    F18 Bottom F18 will display the last page of a subfile listing.
    F19 File Authorities Overview F19 will display the authoriies related to the file on FF.
    F24 Return to Initial Screen F24 will return to the initial screen OBJECT LIST.

  5. To run IVIEW
  6. Command IVIEW calls the program IVIEW01CL which executes IVIEW01R.
    The parameters on the command are passed through the CL program to IVIEW01R.
    This is a stand-alone program.
    The only file is the screen file IVIEW01FM.
    Activation group is *CALLER.
    The objects can be stored in a library of your own choice.
    ===>CONTENTS
  7. SAVEFILE
  8. The objects are provided in a savef MCKIVWSAVF.  To restore the savef, first create a savef on the ISerie. Use FTP with binary to upload the file to the savf you created.
    You may then move the contents to a library or libraries of your choice.
    ===>CONTENTS

  9. SHIPPING LIST
  10. The following objects are shipped in the savefile MCKIVWSAVF ...
    IVIEWCMDThis is the command which calls the program.
    IVIEW01CLCL programCalls the executable.
    IVIEW01RRPGLE programThe main executable.
    IVIEW01FMScreen fileScreen layouts
    IVWSRCSource fileThis contains the source for the commands IVIEW and MAKESPACE.
    MAKESPACECMDThis is the command which creates the workspaces.
    ===>CONTENTS


  11. Change Log V1.0

  12. 29 May 2011   Initial release of IVIEW
    06 Jun 2011   First display is write only, documentation updated
    24 Jul 2011   Cmd Key F4 (List Object Types) made functional
    ===>CONTENTS


    11 May 2011
    ©2009 McKay Software Services Ltd
    www.mckaysoftware.ie
    www.rpglanguage.com
    End of README v1.2