home *** CD-ROM | disk | FTP | other *** search
/ Collection of Education / collectionofeducationcarat1997.iso / COMPUSCI / PEO.ZIP / MANUAL.DOC < prev    next >
Text File  |  1994-02-10  |  61KB  |  1,299 lines
  1.  
  2.                     JAMES W. YOUNG & ASSOCIATES, INC.
  3.                         1403 5th Street, Suite G
  4.                         Davis, California 95616
  5.                               (916)756-3051
  6.  
  7.         Dear Professional:
  8.  
  9.         Thank you for taking a look at James W. Young & Associates,
  10.         Inc.'s COBOL system analysis tool, Program Entity Organizer
  11.         (PEO). This is the same version of PEO we use to provide top
  12.         notch services and support for our clients.
  13.  
  14.  
  15.         TERMINOLOGY
  16.  
  17.         PEO refers to the screens which the user works with to analyze
  18.         the COBOL programs. However, in general, PEO refers to the
  19.         entire system; i.e., the batch programs (the supporting software)
  20.         and the screens.
  21.  
  22.         SEO refers to the batch portion of  PEO. SEO is the supporting
  23.         software for PEO. SEO consists of a preprocessor and a parser.
  24.  
  25.         MACHY refers to the group of senior programmer/analysts that
  26.         developed the PEO and SEO software. It is also the name of the
  27.         main directory that is created at installation.
  28.  
  29.         Application identifier is an important part of PEO. It
  30.         represents a particular group of COBOL programs and their
  31.         copybooks. Each application identifier (i.e., a unique set
  32.         of COBOL programs and copybooks) must be created as a
  33.         subdirectory of MACHY. The actual source code does not have
  34.         to be in the subdirectory. The first application identifier
  35.         subdirectory is created at install time.
  36.  
  37.         Publisher refers to James W. Young & Associates.
  38.  
  39.         Author refers to the copyright holders for the PEO and SEO
  40.         software.
  41.  
  42.  
  43.  
  44.  
  45.                              WHAT IS PEO?
  46.  
  47.  
  48.         PEO is a COBOL source code analysis and documentation tool.
  49.         It replaces the compiler output as the primary analysis tool.
  50.  
  51.         It gives you a huge leap in productivity and confidence;
  52.  
  53.          productivity, because PEO handles the cross reference grunt
  54.           work and bundles main programs and all their subprograms
  55.           into a single package for analysis;
  56.  
  57.          confidence, because you can be sure you've covered everything!
  58.  
  59.         Anything you can do with a compile listing you can do many times
  60.         faster with PEO and with virtual one-hundred percent accuracy.
  61.  
  62.         You can identify and document business functions in a fraction
  63.         of the time formerly required.
  64.  
  65.         You can identify and document program control functions in a
  66.         fraction of the time formerly required.
  67.  
  68.         PEO is a custom tool used by James W. Young & Associates and
  69.         clients for more than two years. It was designed and developed
  70.         by four senior programmer analysts with over 90 years combined
  71.         experience with mainframe COBOL systems. It's designed for the
  72.         real world of esoteric (spaghetti) code; numerous modifications;
  73.         numerous subprograms; alternate entry points; a plethora of
  74.         GO TO's, ALTER's; superfluous group moves and group parameters;
  75.         AND modern, structured code.
  76.  
  77.  
  78.         THE PEO DEMONSTRATION
  79.  
  80.         PEODEMO is a very tiny COBOL program with no function other
  81.         than demonstrate the look and feel of PEO; and, to show you
  82.         some of the features of PEO. Don't let the small size of the
  83.         demo fool you; there's no size limit on programs as long as
  84.         you have the DASD. Copy the demonstration and peo.exe files
  85.         to a hard drive to get an accurate idea of the speed of PEO.
  86.  
  87.         Change to the drive and directory containing peo.exe and the
  88.         PEODEMO.* files. You MUST do this to run the demonstration.
  89.         Select PEODEMO from the first screen.
  90.  
  91.         The PEODEMO.HIH file is output from the parser and shows the
  92.         call hierarchy, alternate entry points, and source files
  93.         containing the entry point (if different from the entry name).
  94.  
  95.         The PEODEMO.DTE file is an example of a data element name
  96.         filter. The string "YYMM" was the filter. The file contains
  97.         the selected names which met the criterion. These names can be
  98.         used with the PEO screens to analyze their use in the COBOL
  99.         system. You may specify multiple filters.
  100.  
  101.  
  102.  
  103.         DISCLAIMER - AGREEMENT
  104.  
  105.         USERS OF PROGRAM ENTITY ORGANIZER (PEO) AND ITS SUPPORTING
  106.         SOFTWARE, THROUGHOUT THIS DOCUMENT, REFERRED TO AS SEO, MUST
  107.         ACCEPT THIS DISCLAIMER OF WARRANTY:
  108.  
  109.         PROGRAM ENTITY ORGANIZER (PEO) AND SEO ARE SUPPLIED AS IS.
  110.         THE AUTHOR AND PUBLISHER DISCLAIM ALL WARRANTIES, EXPRESSED
  111.         OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE WARRANTIES OF
  112.         MERCHANTABILITY AND OF FITNESS FOR ANY PURPOSE. THE AUTHOR
  113.         AND PUBLISHER ASSUME NO LIABILITY FOR DAMAGES, DIRECT OR
  114.         CONSEQUENTIAL, WHICH MAY RESULT FROM THE USE OF PROGRAM ENTITY
  115.         ORGANIZER (PEO) AND SEO. THE USER MUST ASSUME THE ENTIRE RISK
  116.         OF USING THE PROGRAM. ANY LIABILITY OF THE AUTHOR AND PUBLISHER
  117.         WILL BE LIMITED EXCLUSIVELY TO PRODUCT REPLACEMENT OR REFUND OF
  118.         PURCHASE PRICE.
  119.  
  120.  
  121.  
  122.         CONTENTS:
  123.  
  124.         I.      Some Information About Getting Started
  125.         II.     The Outline of the User's Manual
  126.         III.    Draft Copy of the User's Manual.
  127.         IV.     JWY&Assoc., Inc.'s support for PEO.
  128.         V.      qikstart
  129.  
  130.  
  131.         I.      Some Information About Getting Started
  132.  
  133.         Here is some information which should get you started without
  134.         having to look at very  much of the User's Manual. The install
  135.         information is at the very end of this file.
  136.  
  137.         PEO is as easy to use as 1, 2, 3:
  138.  
  139.                 1. preprocess all the COBOL source code in the
  140.                    directory,
  141.                 2. parse the program(s) and load into the PEO data
  142.                    base, and
  143.                 3. analyze the program.
  144.  
  145.         Step one must be done at least one time during the "life-cycle"
  146.         of PEO for a particular set of COBOL programs. You repeat step
  147.         one only when a program is added to the directory or when
  148.         program names or alternate entry point names have been added or
  149.         changed; or, internal/external file definition names have been
  150.         added or changed.
  151.  
  152.         Step two depends upon step one being run at least one time.
  153.  
  154.         Step two must be done when you choose a program for analysis
  155.         for the first time. Usually, you will not have to do step two
  156.         more than once for each project. The capabilities PEO gives
  157.         you make it possible to do a thorough analysis, make the
  158.         changes to the program, and forget about the program until
  159.         the next project.
  160.  
  161.         Step three depends upon step two before a program can be analyzed.
  162.  
  163.         Step three is repeated as often as necessary to analyze the
  164.         program(s).
  165.  
  166.  
  167.         All three steps depend upon a certain configuration of DOS
  168.         directories. The main working directory is created at install
  169.         time. It is named, MACHY. The preprocessor and parser are
  170.         copied to this directory by install.bat. A particular set of
  171.         COBOL source code (referred to here as an application or
  172.         application ID) must be given a name by the user. The application
  173.         ID is used to create a subdirectory of MACHY. The application
  174.         ID is a required command line parameter when you run install.bat.
  175.         The third directory required by PEO is named EXS and is created
  176.         by install.bat as a subdirectory of application ID. The PEO.exe
  177.         file is copied to the EXS subdirectory by install.bat. Here is a
  178.         representation of the DOS directories:
  179.  
  180.           root                     the c: drive
  181.              |
  182.              MACHY                 the preprocessor and parser are here
  183.                  |
  184.                  application ID    the working directory for a set of COBOL
  185.                               |    code
  186.                               |
  187.