home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / DATABASE / DBFSCA.ZIP / DBFSCAN.DOC next >
Text File  |  1992-05-17  |  15KB  |  457 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                      DBFSCAN
  21.  
  22.                                    version 1.0
  23.  
  24.  
  25.  
  26.             Utility program to find which DBF's contain a Dbase Field
  27.  
  28.  
  29.  
  30.                                         by
  31.                                  William P. York
  32.  
  33.                                Computer Team, Inc.
  34.                                 1049 State Street
  35.                               Bettendorf, Iowa 52722
  36.                                   (319) 355-0426
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.                     Copyright (c) 1991 by Computer Team, Inc.
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.       _____________________________________________________________________
  61.  
  62.                                      LICENSE
  63.       _____________________________________________________________________
  64.  
  65.  
  66.       DBFSCAN  is  NOT  public  domain  or  free  software,  but  is  being
  67.       distributed as "shareware".
  68.  
  69.       Non-registered users of  this software are granted  a limited license
  70.       to make an evaluation copy for trial use on a private, non commercial
  71.       basis,  for the  express  purpose of  determining whether  DBFSCAN is
  72.       suitable for  their needs.   At the  end of  this trial   period, you
  73.       should either register your copy or discontinue using DBFSCAN.
  74.  
  75.       In other words, if you regularly use this program then you should pay
  76.       for your copy.
  77.  
  78.       A DBFSCAN registration entitles you to use the program on any and all
  79.       computers available to you, with the  following restriction: If other
  80.       people have  access to this  program or may  use it, then  you should
  81.       purchase a site license.
  82.  
  83.       All users are  granted a limited license to copy DBFSCAN only for the
  84.       trial use of others and subject to the above limitations.
  85.  
  86.       This  license does  NOT  include  distribution  or  copying  of  this
  87.       software for the following:
  88.  
  89.         1. In connection with any other product or service.
  90.         2. For general use within a company or institution.
  91.         3. For any fee other than a nominal 'disk charge' not to
  92.            exceed $7.00
  93.         4. Distribution in modified form; the full DBFSCAN documentation
  94.            and REGISTER documentation must be included, unmodified.
  95.  
  96.       Operators   of  electronic  bulletin   board  systems   (Sysops)  are
  97.       encouraged to post DBFSCAN for downloading by their users, as long as
  98.       the above conditions are met.
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.                                 TABLE OF CONTENTS
  106.  
  107.  
  108.  
  109.       INTRODUCTION  . . . . . . . . . . . . . . . . . . . . . . . . . .   2
  110.  
  111.       BONUS FOR CLIPPER PROGRAMMERS . . . . . . . . . . . . . . . . . .   2
  112.  
  113.       INSTALLATION  . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  114.  
  115.       HOW TO USE DBFSCAN  . . . . . . . . . . . . . . . . . . . . . . .   3
  116.            Edit Field Names . . . . . . . . . . . . . . . . . . . . . .   3
  117.            Edit Paths . . . . . . . . . . . . . . . . . . . . . . . . .   3
  118.            Edit Report Name . . . . . . . . . . . . . . . . . . . . . .   4
  119.            Create Report  . . . . . . . . . . . . . . . . . . . . . . .   4
  120.            View Report  . . . . . . . . . . . . . . . . . . . . . . . .   4
  121.            Print Report . . . . . . . . . . . . . . . . . . . . . . . .   4
  122.            Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
  123.  
  124.       SAMPLE REPORT . . . . . . . . . . . . . . . . . . . . . . . . . .   5
  125.  
  126.       MISCELLANEOUS . . . . . . . . . . . . . . . . . . . . . . . . . .   6
  127.  
  128.       FINAL DISCLAIMER  . . . . . . . . . . . . . . . . . . . . . . . .   6
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.                                        -1-
  159.  
  160.  
  161.  
  162.  
  163.  
  164.                                    INTRODUCTION
  165.  
  166.       DBFSCAN is a utility program for  the xBase programmer. It provides a
  167.       quick and easy  method to locate all  of the DBF files  which contain
  168.       one  or  more specific  FIELD  names. It  works  with all  DBASE III+
  169.       compatible DBF  file formats. This  includes DBASE III+,  CLIPPER and
  170.       FOX database files.
  171.  
  172.       In simple terms, DBFSCAN will examine all  DBF files in the specified
  173.       directories and create a report listing those DBF files which contain
  174.       any of the FIELD names that you have entered.
  175.  
  176.       This  program was  written  to  save time  when  doing xBase  program
  177.       maintenance.   When  we needed to modify  a FIELD's size or see  if a
  178.       FIELD name  was  already used,  we  would manually  look at  the  DBF
  179.       structures.  DBFSCAN was written to automate this process.
  180.  
  181.  
  182.  
  183.  
  184.  
  185.                           BONUS FOR CLIPPER PROGRAMMERS
  186.  
  187.  
  188.       If your  index files were  created with  CLIPPER and your  index file
  189.       names match your DBF file  names, then DBFSCAN will list those  index
  190.       files which contain any of the FIELD names that you entered.
  191.  
  192.       For example, if you are looking for all DBF's which contain the FIELD
  193.       name CUSTNUMBER,  and  if  DBFSCAN  locates CUSTNUMBER  in  the  file
  194.       CUST.DBF, then DBFSCAN will  look to see if the file  CUST.NTX exists
  195.       and if it does, DBFSCAN will report if the formula used to create the
  196.       index file contained CUSTNUMBER.
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.                                        -2-
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.                                    INSTALLATION
  225.  
  226.       To install DBFSCAN  all you need to  do is 'unfold' DBFSCAN  from the
  227.       compressed  format in  which it  is  normally distributed.   You  may
  228.       choose to create  a separate subdirectory for DBFSCAN  or put DBFSCAN
  229.       in your Dbase programming tools subdirectory.
  230.  
  231.  
  232.  
  233.                                 HOW TO USE DBFSCAN
  234.  
  235.       To  start  DBFSCAN,  enter  DBFSCAN from  the  DOS  prompt.   If  the
  236.       subdirectory  which contains  DBFSCAN.EXE is  included  in your  PATH
  237.       statement, you can enter DBFSCAN from any subdirectory.
  238.  
  239.       When you enter DBFSCAN, you will see a screen with the below Menu:
  240.  
  241.                           .---------- Menu ----------.
  242.                           |  1) Edit Fields          |
  243.                           |  2) Edit Paths           |
  244.                           |  3) Edit Report Name     |
  245.                           |  4) Create Report        |
  246.                           |  5) View Report          |
  247.                           |  6) Print Report         |
  248.                           |  7) Exit                 |
  249.                            --------------------------
  250.  
  251.       To select an entry, you can either:
  252.         a) Use the Up/Down arrow keys to highlight the desired choice and
  253.            then press enter.
  254.         b) Enter the Number (1 through 7) of the desired choice.
  255.  
  256.  
  257.  
  258.       Edit Field Names:   Use this option to enter the Dbase FIELD names
  259.                           that want to search on.  You can enter up to 15
  260.                           different FIELD names.  Press ENTER after you
  261.                           have typed each FIELD name.  Press PgDn after
  262.                           entering the last FIELD name.
  263.  
  264.  
  265.       Edit Paths:         Use this option to enter the DOS PATH's for the
  266.                           subdirectories that contain the DBF files that
  267.                           you want to search.  You can enter up to 5
  268.                           different PATH statements.  Press ENTER after
  269.                           you have typed each PATH statement.  Press PgDn
  270.                           after entering the last PATH statement.  You
  271.                           must enter fully qualified PATH statements.
  272.                           For example; C:\PAYROLL\DATA
  273.  
  274.  
  275.  
  276.  
  277.                                        -3-
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.       Edit Report Name:   Use this option to enter the DOS file name
  285.                           where DBFSCAN will output the report.  This
  286.                           file will be located in the subdirectory
  287.                           that you currently are working in.  DBFSCAN
  288.                           will store the report in ASCII format in
  289.                           this DOS file.  If the file name previously
  290.                           existed, DBFSCAN will overlay it with the
  291.                           new report.  For example, you could use a
  292.                           report file name like DBFSCAN.REP
  293.  
  294.  
  295.       Create Report:      Use this option to create a new report.  Each
  296.                           time you execute DBFSCAN, you should select
  297.                           this option.  A message box will display while
  298.                           the report is being created.  The amount of
  299.                           time needed to create a report will depend on
  300.                           the number of Dbase FIELD's and the number of
  301.                           DBF files that you are searching.
  302.  
  303.  
  304.       View Report:        Use this option to view the report created by
  305.                           option "4) Create Report".  While you are
  306.                           viewing the report, you can use the Up/Down
  307.                           arrow keys and the PgUp/PgDn keys to scroll
  308.                           through the report.  When you are finished
  309.                           viewing the report, press ESC to return to
  310.                           DBFSCAN menu.
  311.  
  312.  
  313.       Print Report:       Use this option to print the report created by
  314.                           option "4) Create Report".  This option will
  315.                           print the report to LPT1.  If you need to print
  316.                           to a different port, then you will need to exit
  317.                           DBFSCAN and use the DOS "TYPE" command to print
  318.                           the report.  For example, if you need to print
  319.                           to LPT2 and your report name is DBFSCAN.REP,
  320.                           then would enter:  TYPE DBFSCAN.REP > LPT2:
  321.  
  322.  
  323.       Exit:               Use this option to exit DBFSCAN and return to
  324.                           the DOS prompt.
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                                        -4-
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.                                   SAMPLE REPORT
  345.  
  346.          ________________________________________________________________
  347.         |                                                                |
  348.         |  Date: 05/16/92            DBFSCAN            Time: 16:10:19   |
  349.         |                                                                |
  350.         |  DIRECTORY: C:\ACCOUNTS\DATA                                   |
  351.         |                                                                |
  352.         |  -----------------------------------------------------------   |
  353.         |  FIELD      DBF    TYPE LEN DEC  INDEX                         |
  354.         |  -----------------------------------------------------------   |
  355.         |  FCUSTNO    APMEM01  C   10   0                                |
  356.         |  FCUSTNO    ARAUI01  C   10   0  FCUSTNO                       |
  357.         |  FCUSTNO    ARAUT01  C   10   0                                |
  358.         |  FCUSTNO    ARCAS01  C   10   0  FCUSTNO+FSYSCHK               |
  359.         |  FITEMNO    ARAUT01  C   20   0                                |
  360.         |  FITEMNO    ARHTR01  C   20   0                                |
  361.         |  FITEMNO    ARITM01  C   20   0  FITEMNO                       |
  362.         |  FITEMNO    ARTRF01  C   20   0  FITEMNO                       |
  363.         |                                                                |
  364.         |  DIRECTORY: C:\TIMEBILL\DATA                                   |
  365.         |                                                                |
  366.         |  -----------------------------------------------------------   |
  367.         |  FIELD      DBF    TYPE LEN DEC  INDEX                         |
  368.         |  -----------------------------------------------------------   |
  369.         |  FCUSTNO    TBAUI01  C    6   0  FCUSTNO                       |
  370.         |  FCUSTNO    TBCAS01  C    6   0  FCUSTNO                       |
  371.         |  FCUSTNO    TBHCA01  C    6   0                                |
  372.         |  FCUSTNO    TBINV01  C    6   0                                |
  373.         |                                                                |
  374.         |________________________________________________________________|
  375.  
  376.  
  377.       The above sample report was created by searching for Dbase FIELD's
  378.       FCUSTNO and FITEMNO in PATH's C:\ACCOUNTS\DATA and C:\TIMEBILL\DATA.
  379.  
  380.       The DATE and TIME that the report was created are shown on the top
  381.       line of the report.
  382.  
  383.       Search results for each PATH are separated by a heading which lists
  384.       the specific PATH.  Within each PATH, FIELD's are listed in the order
  385.       they are entered on the DBFSCAN menu screen.
  386.  
  387.       Since the above sample report was created for our CLIPPER databases
  388.       it includes INDEX information.  When you use DBFSCAN on database
  389.       systems other than CLIPPER, the INDEX area will be blank.
  390.  
  391.       The sample report shows in DBF files in C:\ACCOUNTS\DATA that FCUSTNO
  392.       has a Length of 10 and in DBF files in C:\TIMEBILL\DATA that FCUSTNO
  393.       has a Length of 6.
  394.  
  395.  
  396.  
  397.                                        -5-
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.                                   MISCELLANEOUS
  405.  
  406.  
  407.       DBFSCAN was written in Clipper and  should run on all IBM's and  true
  408.       compatible's and with nearly any video adapter.
  409.  
  410.       DBFSCAN is being  distributed as SHAREWARE; you  are free to make  as
  411.       many copies  of  them as  you  like, and  to  share it  with  others.
  412.       However, you may NOT modify it and the program and documentation must
  413.       travel together.  If you find  DBFSCAN useful, you are  encouraged to
  414.       register your  copy. The license fee is only  $20, and if you've done
  415.       any programming,  you know the  amount of  time and energy  that goes
  416.       into a  program such as DBFSCAN.  $20 is  far less than you would pay
  417.       for  a  "commercial"  program  of  the same  quality.    If  personal
  418.       satisfaction  isn't incentive enough  for you, registered  users will
  419.       also receive the latest version (without any title screen delay), and
  420.       free updates for a year.
  421.  
  422.       We  hope that  you  find DBFSCAN  useful,  and  we encourage  you  to
  423.       register.  We  are   always  open  to  suggestions,   whether  you're
  424.       registered or  not.  We would also appreciate reports of any problems
  425.       with the  software.  You  may send any contributions,  suggestions or
  426.       problems to:
  427.  
  428.                                Computer Team, Inc.
  429.                                 1049 State Street
  430.                               Bettendorf, Iowa 52722
  431.                                   (319) 355-0426
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.                                  FINAL DISCLAIMER
  441.  
  442.  
  443.       Use of this program acknowledges this disclaimer of warranty:
  444.  
  445.       "This program is  supplied as-is. Computer  Team, Inc. disclaims  all
  446.       warranties, expressed or implied,  including, without limitation, the
  447.       warranties of merchantability and of  fitness of this program for any
  448.       purpose. Computer Team, Inc. assumes no  liability for damages direct
  449.       or consequential, which may result from the use of this program."
  450.  
  451.  
  452.  
  453.  
  454.  
  455.                                        -6-
  456.  
  457.