home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BUSINESS / PUNCH210.ZIP / PUNCH210.DOC < prev    next >
Text File  |  1994-03-07  |  28KB  |  486 lines

  1.  
  2.  
  3.  
  4.  
  5.                                                       PUNCHLISTtm
  6.  
  7.                                                      VERSION 2.10
  8.  
  9.                                                      USER'S MANUAL
  10.  
  11.  
  12.                                                    SHAREWARE VERSION
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                                       PREPARED BY
  27.  
  28.                                               VECTOR SERVICES CORPORATION
  29.                                                 ENGINEERS * CONSULTANTS
  30.                                                     TAMPA, FLORIDA TABLE OF CONTENTS
  31.  
  32.     I.   INTRODUCTION
  33.  
  34.    II.   SYSTEM REQUIREMENTS
  35.  
  36.   III.   INSTALLATION
  37.  
  38.    IV.   THE MAIN MENU SCREEN
  39.  
  40.     V.   THE SELECT/CREATE SCREEN
  41.  
  42.    VI.   THE PUNCHLIST DATA SCREEN
  43.          A.       Browse
  44.          B.       Editing
  45.                   1.   Ins
  46.                   2.   Revise
  47.                   3.   Erase
  48.          C.       Exiting
  49.          D.       Field Definitions
  50.  
  51.   VII.   THE PRINT PUNCHLIST SCREEN
  52.  
  53.  VIII.   UTILITIES
  54.          A.       Copy/Rename Data Files
  55.          B.       Edit Priority Code
  56.          C.       Edit Milestone
  57.          D.       Set Printer Output
  58.          E.       Configure Printer
  59.          F.       Convert Active Data File
  60.  
  61.   IX.    HELP
  62.  
  63.                                                      DISCLAIMER
  64.  
  65. This software and manual are sold "AS IS" without warranty of any kind, either expressed or implied. 
  66. Vector Services Corporation does not guarantee the correctness of the software or manual.  Should the
  67. program or documentation prove defective, the user assumes all responsibility for any problems arising
  68. from the use of the software.  Vector Services Corporation reserves the right to make changes and/or
  69. improvements to the manual and/or software at any time.  Vector Services Corporation reserves the right
  70. to make changes to the program without notice to purchaser.
  71.  
  72.  
  73. ■Vector Services Corporation 1994.  This material is proprietary and protected under the copyright laws
  74. of the United States of America.  Reproduction or other use without the express permission of Vector
  75. Services Corporation is prohibited.
  76.  
  77.  
  78. PUNCHLISTtm is a registered trade mark of Vector Services Corporation I.     INTRODUCTION
  79. PUNCHLIST provides tracking of open items (shareware version limited to 50 items) on up to ten different
  80. projects.  After installation and initial printer configuration, you will be able to obtain printouts (in a variety
  81. of formats) as fast as the data can be entered.  Various sort fields can be specified for the printouts.  For
  82. example, you can obtain a printout complete with due date, location, and description in addition to other
  83. fields that select all open items of a specified contractor.  Another example is sorting by due date or
  84. another specified field, either in chronological order or by one specified date.  With this variety of report
  85. options, managing the completion of your projects is simplified and organized.
  86.  
  87. This manual further describes what PUNCHLIST can do and explains how to use the program as an
  88. effective management tool.  It is recommended that you first read this manual completely before
  89. attempting to use the program.  This will allow you to speed up your learning process and efficiently use
  90. PUNCHLIST.
  91. II.     SYSTEM REQUIREMENTS
  92.          To use PUNCHLIST, your system must include the following:
  93.          A.  IBM PC, XT, AT or compatible with at least 512K of user memory (640K of RAM
  94.              recommended).
  95.          B.  One hard disk and one floppy disk drive.
  96.          C.  Monochrome or color monitor.
  97.          D.  MS-DOS operating system, Version 3.0 or higher.
  98.          E.  Parallel or serial printer(s) (PUNCHLIST supports IBM and Epson compatible
  99.              printers).
  100.  
  101. III.     INSTALLATION
  102. A registration card (REGISTER.TXT), an information file (README.TXT) and this manual (PUNCH210.DOC) 
  103. are included with the necessary program and sample data files.  Please fill out the registration card and
  104. return it to:
  105.          VECTOR SERVICES CORPORATION
  106.          P.O. Box 25152
  107.          Tampa, Florida  33622
  108.  
  109.          Follow the instructions below to install PUNCHLIST on your system.
  110.  
  111.          A.       From your root directory make a new subdirectory called PUNCH on your hard disk.
  112.                   DOS Command:  MD PUNCH
  113.          B.       Change to the newly created subdirectory:
  114.                   DOS Command:  CD PUNCH
  115.          C.       Copy all files from  PUNCHLIST disk #1 to the newly created subdirectory.
  116.                   DOS Command:  COPY A:*.* 
  117.          D.       Repeat this command for the second disk and leave disk #2 in the floppy disk drive. 
  118.                   Then type "PUNCH".
  119.          E.       To bring up PUNCHLIST at any time, make sure you are in the PUNCH subdirectory and
  120.                   type "PUNCH".
  121.  
  122.          Upon initial entrance into PUNCHLIST, you will be prompted to specify your company's name (20
  123.          characters or less).  Enter the name and press ENTER.  The program will record this information
  124.          on the floppy disk and in the working copy on the hard disk.  An introductory screen is then
  125.          encountered.  Hit any key to continue.
  126.  
  127. IV.      THE MAIN MENU SCREEN
  128.          The Main Menu screen allows you to access all parts of the PUNCHLIST program.  To select an
  129.          item, use the cursor control keys (or mouse) and press ENTER.
  130.  
  131.          A.     Select/Create Punchlist Data File
  132.                   This choice should be selected to create a new PUNCHLIST data file or to activate an
  133.                   existing PUNCHLIST data file to be maintained or printed.  Upon entrance into
  134.                   PUNCHLIST you have to first select this choice to activate a desired data file.
  135.  
  136.          B.       Maintain Active Data File
  137.                   This selection should be chosen when you want to add items to a punchlist, edit items
  138.                   of a punchlist, delete items from a punchlist or just browse through a punchlist.  An active
  139.                   data file must be specified before selecting this choice.
  140.  
  141.          C.       Print Active Data File
  142.                   Select this choice to print the active punchlist data file.  Several options are offered and
  143.                   are discussed in Part VI of this manual.  An active data file must be specified before
  144.                   selecting this choice.
  145.  
  146.          D.       Utilities
  147.                   This selection allows you to coordinate your printer with the PUNCHLIST program and
  148.                   define Priority Codes and Milestones for your punchlists.  These terms are defined in
  149.                   Section VII.   This selection also allows copy/rename capabilities of existing punchlist data
  150.                   files.  An active data file must be specified before selecting this choice.
  151.  
  152.          E.       Quit
  153.                   This selection returns you to DOS.
  154.  
  155.  
  156. V.       THE SELECT/CREATE PUNCHLIST MENU
  157.          After selecting "Select/Create Punchlist Data File" from the Main Menu, this screen enables the
  158.          user to:
  159.  
  160.          A.       Create a New Punchlist Data File
  161.                   This is accomplished by pressing the keys ALT-A or clicking the mouse on the "Add"
  162.                   menu, entering the data file name, and pressing ENTER.  The file name's first six
  163.                   characters must be unique.  A new data file is created and is initially empty.  The new
  164.                   data file is the active file.
  165.  
  166.          B.       Select an Existing Punchlist Data File From the List
  167.                   To activate a data file, use the cursor control keys or clicking the mouse and press
  168.                   ENTER to select a name from the EXISTING PUNCHLIST FILENAMES list located on the
  169.                   right hand side of your monitor.  The name you selected will appear in the ACTIVE FILE
  170.                   box located in the center of the screen.  This is the file you wish to maintain or print.
  171.  
  172.          C.       Delete Data Files Once a Project is Completed
  173.                   After a project is finished, you may want to delete the data file to make room for additional
  174.                   punchlists.  This is accomplished by selecting a data file name using the cursor control
  175.                   keys and the pressing ALT-K simultaneously, or clicking the mouse on "Kill File" menu. 
  176.                   You will be asked if you really want to delete the file and must respond with "Y" for yes
  177.                   and "N" for no.  The file is deleted if you answer with a "Y" keystroke.
  178.  
  179. NOTE:    ALT-E or clicking the mouse on eXit will return you to the Main Menu only if you have selected
  180.          an active file.
  181.  
  182. VI.      THE PUNCHLIST DATA SCREEN
  183.          After selecting "Maintain Active Data File" from the Main Menu, this screen appears and you have
  184.          the following options:
  185.  
  186.          -        Browse through the punchlist (NEXT, PREVIOUS, SEARCH)
  187.          -        Add items to the punchlist (ADD)
  188.          -        Change data for existing punchlist items (REVISE)
  189.          -        Delete existing punchlist items (DELETE)
  190.  
  191.          These options are presented in the form of a menu at the top of your screen.  Selecting the
  192.          desired action is performed by clicking the mouse or pressing ALT-KEYS of the capital letter of
  193.          the desired menu action.
  194.          A.       BROWSE
  195.                   One item (or record) is displayed at a time.  Browsing is accomplished by selecting NEXT
  196.                   or PREVIOUS to display the next or previous items in the punchlist data file.  The items
  197.                   are stored and scrolled in sequential order according to the punchlist number (PL#).
  198.  
  199.                   To perform a free-field search of any field select SEARCH.  A new window will appear. 
  200.                   From here you can select a search field and specify a search string.  The temporary
  201.                   search file that is created can be directed to the printer or the display.  If the selected
  202.                   search field is NUMBER then the display is automatically chosen as the destination.  This
  203.                   can useful when scrolling large files so the user can "jump" around in the file. When the
  204.                   selected search field is not "NUMBER" and the display is chosen as the destination a
  205.                   partial search file is shown on the display,  This partial file cannot be edited.  The user
  206.                   should make note of the PL#'s involved in order to edit when the complete file is
  207.                   required.  Pressing F6 returns to the main file.
  208.  
  209.                   When the printer is chosen as the destination print format #4 is always used because this
  210.                   format will be compatible with all printers and it contains all fields.
  211.  
  212.          B.     EDITING
  213.                   1.       Ins
  214.                   After selecting Ins, the highlight bar moves to the Priority Code field.  The PL#, time and
  215.                   date are automatically entered for you.  Pressing ENTER will complete or surpass any
  216.                   field.  Desired information is then entered into the fields by the user.  All the fields are
  217.                   sequentially accessed by the highlight bar and when the final field is entered, the record
  218.                   can be saved by pressing the ENTER key.  
  219.                   2.       REVISE
  220.                   REVISE works in the same way as Ins.  Any revisions that need to be made are
  221.                   accomplished by simply changing the display using the keyboard and hitting the ENTER
  222.                   key.  The fields are accessed and the revised record is saved as mentioned in Ins above.
  223.  
  224.                   3.     ERASE
  225.                   The current item being displayed is the record to be deleted.  Pressing ALT-E completes
  226.                   the deletion.  A deletion consists of the displayed punchlist item's "Description" field
  227.                   changing to "ITEM DELETED" followed by the current date.  Records that have been
  228.                   deleted will not be printed in reports.
  229.  
  230.          C.       CHANGING USER DEFINED FIELDS
  231.                   Pressing ALT-F or clicking the mouse on "Field" menu, allows you to change the field
  232.                   names of "Field A", "Field B", "Field C" and "Field D" to a more appropriate name.  These
  233.                   are text fields that are 20 characters long.
  234.  
  235.          D.       EXITING
  236.                   ALT-X or clicking the mouse on eXit will return you to the Main Menu.  (This is the case
  237.                   for most of the PUNCHLIST screens.)
  238.  
  239.          E.       FIELD DEFINITIONS
  240.                   1.       PL# - A unique integer between 1 and 9999 to distinguish each item on a project.
  241.  
  242.                   2.       Date Entered - Date the item was entered into the punchlist.
  243.                   3.       Time - Time of day that the item was entered.
  244.  
  245.                   4.       Priority Code - A user-defined symbol between A and Z that designates the
  246.                            priority of the item as far as when it should be completed.
  247.  
  248.                            Examples:         A:  ASAP
  249.                                              B:  24 Hours
  250.                                              C:  30 Days
  251.                                              D:  90 Days
  252.  
  253.                   5.       Description - A brief description of the incomplete item.
  254.  
  255.                            Example:   Install ceiling tile and return grille.
  256.  
  257.                   6.       Location - Location of unfinished item.
  258.  
  259.                            Example:          RM 235
  260.  
  261.                   7.       Equipment - Piece of equipment in question.
  262.  
  263.                            Examples:         Chiller 2
  264.                                              Compressor 1A
  265.  
  266.                   8.       Milestone - A user-defined symbol, represented by digits 0 through 9, indicating
  267.                            a significant point in development.
  268.  
  269.                            Example:
  270.                                     0:  Pouring of Main Slab
  271.                                     1:  Energize Transformers
  272.                                     2:  Final Inspection
  273.  
  274.                   9.       Contact - Responsible individual or correspondent.
  275.  
  276.                   10.      Date Due - Date that the incomplete item is or was due.
  277.  
  278.                   11.      Date Completed - Date that the item is completed.  It is recommended that this
  279.                            field be left blank for open items and used when the items are completed.  This
  280.                            will allow the open item printouts (explained later) to be accurate.
  281.  
  282.                   12.      Supplier - Supplier who may be responsible.
  283.  
  284.                   13.      Contractor/Resp. Ind. - Contractor or individual who may be responsible.
  285.  
  286.                   14.      Cost - Any cost that may be associated with the item.
  287.  
  288.                   15.      Comments - Additional comments.
  289.  
  290.                   16.      Field A, B, C, D - Anonymous fields to be used at user's discretion.
  291.  
  292. VII.     THE PRINT PUNCHLIST MENU
  293.          After selecting "Print Active Data File" from the Main Menu, this screen appears on your monitor
  294.          and allows you to:
  295.          -        Print an entire punchlist file.
  296.          -        Print selected punchlist records based on user-specified field or fields.
  297.          -        Sort then print the selected records.
  298.          -        Print all open or all open and complete items.
  299.          -        Specify a printout title.
  300.          -        Specify desired printout format.
  301.  
  302.          Initially, the highlight bar is positioned in the top left hand corner menu.  From here the user can:
  303.          -        Press F8 to display print format information.
  304.          -        Press F9 to edit the current print format.  The highlight bar will jump to FORMAT in the
  305.                   top right hand corner of the screen.  Here the desired format (1, 2, 3, 4, 5 or 6) must be
  306.                   typed  followed by ENTER.
  307.          -        Press Ctrl-Esc to exit to the Main Menu.
  308.          -        Press F1 for HELP.
  309.          -        Use cursor control keys to select ALL RECORDS if you want the whole file printed.
  310.          -        Use cursor control keys to select SPECIFIC RECORDS to print user- specified records.
  311.  
  312.          Upon selecting ALL RECORDS the user can specify printing of all open or all complete and open
  313.          items.  This criteria is based on the date completed field so this field must be accurate in order
  314.          for open items only to be printed.
  315.  
  316.          Upon selecting SPECIFIC RECORDS, the highlight bar jumps down into a data entry section of
  317.          the screen.  This section functions exactly like the punchlist item data entry screen.  Here is where
  318.          the user can type in a specific field that the records of the active file must match if it is to be
  319.          printed out.  After the fields are entered and F10 is pressed, the active data file is processed so
  320.          as to find any records that have fields identical to the fields just specified.  If matching records
  321.          are found, you must select whether you want them printed the way they occurred in the active
  322.          data file or in a sorted fashion (chronologically if by date, increasing order if by number,
  323.          alphabetically if an alphabetical field is chosen).  The lower right menu is selected by the highlight
  324.          bar if a sort is desired.  A selection is made by the now familiar cursor control keys and enter key.
  325.  
  326. NOTE:    To print ALL records sorted other than by PL#, select SPECIFIC RECORDS, progress through the
  327.          data entry section using the ENTER key, press F10, select SORT THEN PRINT MATCHING
  328.          RECORDS, and finally select the desired field to be sorted by.  This may be time consuming for
  329.          large files.
  330.  
  331.          In all print conditions, the user is prompted with an opportunity to specify printing of just open
  332.          items or all open and complete items.  The user also has a chance to title any report.  The user
  333.          is finally prompted also prompted with "PRINTER READY?  P to print, C to cancel".  At this time,
  334.          the printer should be checked to verify that it is on-line and that the paper is positioned properly. 
  335.          Pressing C will cancel the print only before it has started printing.  Pressing P will initiate printing.
  336.  
  337. VIII.    UTILITIES
  338.          After selecting "Utilities" from the Main Menu, a Utilities menu appears and its entries are explained
  339.          here.
  340.  
  341.          A.       Copy/Rename Data File
  342.                   This utility can be used if you need to copy a PUNCHLIST data file to a different name. 
  343.                   This can be time saving for similar project PUNCHLISTS.  After choosing this selection
  344.                   from the Utilities menu, a new screen will appear.  It prompts you to enter a source file
  345.                   name, and a destination file name.  There is no need to add paths or extensions when
  346.                   typing in file names--they are provided automatically.  When specifying a destination file
  347.                   name the first 6 characters must be unique.  Ctrl-Esc will bring you back to the Utilities
  348.                   menu.
  349.  
  350.          B.       Edit Priority Code
  351.                   This is an optional feature that allows the user to define a code to be used with the
  352.                   punchlist items.  Priority Code is defined in Part VI.F. of this manual.  When this selection
  353.                   is made, a simple data entry screen appears.  When finished with one entry, hit ENTER
  354.                   and the next one will be selected.  To exit, Ctrl-Esc will save your editing and return you
  355.                   to the Utilities menu.  Each punchlist data file has a unique set of priority codes.
  356.  
  357.          C.       Edit Milestone
  358.                   This feature is similar to the Edit Priority Code described above except that the definition
  359.                   of the two differ.  The definition (and an example) of Milestone is given previously in
  360.                   Section VI.E.  This screen is also data entry and works exactly like Edit Priority Code.
  361.  
  362.          D.       Set Printer Output
  363.                   This utility is to be used to specify the following printer characteristics (NOTE:  Default
  364.                   values are given below in parentheses):
  365.                   1.       Letter Quality Print (NO)
  366.                            This allows the user to define whether or not letter quality print is desired.
  367.  
  368.                   2.       Characters Per Inch (10)
  369.                            This enables the user to specify the size of the characters to be printed.  The
  370.                            choices are 10, 12 and 17 (compressed).
  371.  
  372.                   3.       Page Width (14-7/8")
  373.                            The page width of the printer that is about to print should be chosen here.
  374.  
  375.                   NOTE:  A possible printout malfunction which may occur is when Page Width is specified
  376.                   at 8 1/2", Characters Per Inch is set at 10 or 12, and format 1 or 2 is selected.  This is
  377.                   because formats 1 and 2 are designed for page widths of 14 7/8".  Compressed (17 CPI)
  378.                   mode must be used for formats 1 and 2 on a page width of 8 1/2".
  379.  
  380.                   4.       Printer Port (LPT1)
  381.                            The printer port connected to the printer that is about to print should be selected
  382.                            here.  LPT1, LPT2, LPT3, COM1 and COM2 are the available options.
  383.  
  384.                   Each of these characteristics is selected as if you were selecting a menu item--a
  385.                   sequence with which you should now be familiar.  Once all the options have been
  386.                   encountered, a Ctrl-ENTER sequence saves the characteristics to a file and these
  387.                   characteristics are used until they are changed again.
  388.  
  389.          E.       Configure Printer
  390.                   This utility is provided so that the correct control sequences for your system's printer(s)
  391.                   can be obtained.  The user must designate the name of the printer and its equivalent
  392.                   ASCII codes for such printer control sequences as Letter Quality Print, Data Processing
  393.                   Print (Letter Quality Off), 10 Characters Per Inch, 12 Characters Per Inch, 17 Characters
  394.                   Per Inch and Printer Reset.  You will need to consult your printer(s) manual to obtain
  395.                   these decimal codes.  These codes must be entered before any of the characteristics
  396.                   mentioned in D. above can be executed properly.
  397.  
  398.                   To configure your printer(s), select CONFIGURE PRINTER from the UTILITIES menu. 
  399.                   Upon initial entrance to this utility, a blank list of printers appears along with a data entry
  400.                   block (located directly below the blank list).  Here you should enter the printer name and
  401.                   a description (model number).
  402.  
  403.                   Once these fields have been completed, Ctrl-ENTER will save them and a CODES window
  404.                   will appear on the right hand side of the screen.  This window is where you specify the
  405.                   decimal ASCII code sequences for the indicated printer control functions.  Notice the
  406.                   highlight bar moves to the selection of your choice using the cursor control keys.  It is
  407.                   recommended upon initial control code entry that you specify the control sequences of
  408.                   all the fields in this window.
  409.  
  410.                   Once you have selected your choice, hit ENTER.  The cursor will flash over the first
  411.                   decimal ASCII code (initially it is ).  Now you can enter the first of up to five decimal
  412.                   ASCII codes of the corresponding printer control function and press ENTER.
  413.  
  414.                   The cursor will now jump to the second decimal ASCII code and a decimal number
  415.                   should be entered once again followed by ENTER.  To complete the code for a function,
  416.                   hit ENTER twice after entering the last decimal ASCII code (there are up to five decimal
  417.                   ASCII codes per control function).  Once all six control functions have been entered, Ctrl-
  418.                   ENTER will save the control codes and add the printer name to the list of printers.
  419.  
  420.                   Example:
  421.                   From Copal 324NLQ Manual
  422.                   Decimal Function
  423.                   27  120  48       Letter Quality Off (a.k.a.,Draft Quality)
  424.                   27  120  49       Letter Quality On
  425.                   27  80            Select Pica Width
  426.                   27  77            Select Elite Width
  427.                   15                Condensed
  428.                   27* 64**          Initialize Printer
  429.  
  430.                    * First Decimal ASCII Code
  431.                   ** Second Decimal ASCII Code
  432.  
  433.                   Now you will find yourself in the "choose printer" list.  Hit ENTER to activate a selected
  434.                   printer (designated by the highlight box).  The name of the selected printer will appear
  435.                   in the "ACTIVE PRINTER:" field.  The CODES window pops up again.  Pressing Ctrl-T
  436.                   initiates a printer test to see if the right control sequences have been specified.  Ctrl-
  437.                   ENTER or Ctrl-Esc gets rid of the CODES window (or you can make changes).  Ctrl-Esc
  438.                   will return you to the UTILITIES menu with an activated printer.  That printer stays active
  439.                   until another one is chosen from the list.  (Some systems may have more than one
  440.                   printer.)
  441.  
  442.          F.       Convert Data Files
  443.                   This Converter utility will import a dBaseII, dBaseIII, DIF(Data Interchange
  444.                   Format), or BASIC (ASCII text) file, convert it to a Clarion data file, and
  445.                   produce a Clarion FILE structure for the converted file.  Similarly, Converter
  446.                   can export a Clarion data file and convert it to a dBaseIII, DIF, or BASIC
  447.                   file.
  448.  
  449. IX.      HELP
  450.          HELP is provided for the screens mentioned in parts IV through VIII.  To initiate
  451.          a HELP screen, press the F1 key.      PUNCHLIST QUICK REFERENCE
  452.  
  453. FROM ANY SCREEN
  454.  
  455.          F1 for HELP, or click mouse on help menu.
  456.  
  457. FROM SELECT/CREATE PUNCHLIST DATAFILE SCREEN:
  458.  
  459.          ALT-A    Create a new datafile.
  460.          ALT-K    Delete chosen datafile.
  461.          ENTER    Activate chosen datafile.
  462.          ALT-E    Return to main menu.
  463.  
  464. FROM DATA ENTRY SCREEN:
  465.  
  466.          Select from menu by using the cursor control keys or typing the first letter of the desired menu
  467.          action or by clicking the mouse on desired selection.
  468.  
  469.          ENTER    Completes a menu action or a field (highlighted bar).
  470.          ENTER    To save a revised or added record.
  471.          ALT-E    Completes a delete.
  472.          ALT-F    Change user defined fields.
  473.          ALT-S    Re-enable search option.
  474.          ALT-X    Return to main menu.
  475.  
  476. FROM PRINT SCREEN:
  477.  
  478.          Use cursor control keys to select items.
  479.  
  480.          F8                Display print format information.
  481.          F9                Change print format (1,2,3, 4, 5 or 6).
  482.          F10               To complete specified fields.
  483.          ESC               Go to previous field.
  484.          P                 Print (at the appropriate prompt).
  485.          C                 Cancel (at the appropriate prompt).
  486.          CTRL-ESC          Return to main menu.