home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / HP95_100 / DATABASE / DBV / DBV.DOC < prev    next >
Encoding:
Text File  |  1996-10-14  |  17.3 KB  |  515 lines
  1. ----------------------------------------------------------------
  2.  DBView 2.0: HP200LX Database viewer                [HK:10/96]
  3. ----------------------------------------------------------------
  4.  
  5.  DBView is a database viewer for GDB/NDB/PDB database
  6. files, having the same look & feel as the built-in
  7. database application. It can also perform simple statistical
  8. calculations on selected fields with given criteria.
  9.  
  10. The differences between DBView and the System Manager's DB
  11. application are:
  12.  
  13.  
  14.  * DBView can run in DOS,
  15.  
  16.  * Has better searching capabilities with AND/OR operators,
  17.    speed-locate & find "Only" features.
  18.  
  19.  * Opens database files for read-only, extending battery
  20.    life when viewing database files stored in a flashcard.
  21.    This also prevents possible file corruption.
  22.  
  23.  * Performs simple statistical calculations: SUM, AVG, MIN
  24.    & MAX  on specified fields with given criteria.
  25.  
  26.  * When used with HDM (a DOS application manager), it enables
  27.    you to load & view any of your database files with a press of
  28.    a single button. Please read document below for more details.
  29.  
  30.  * You can specify a search string directly at the DOS prompt
  31.    when launching DBV.
  32.  
  33.  * DBView can be used on your desktop computer by using the
  34.    INT5F HP200LX Graphics emulator (included in this ZIP).
  35.  
  36.  
  37.  New in this version:
  38.  --------------------
  39.  
  40.  + Added SUM, MIN, MAX, AVG computing capabilities.
  41.  + Added field extraction feature.
  42.  + Added horizontal lines option.
  43.  + Implemented Right-Justify option for list-view.
  44.  + Added HOME key when viewing notes.
  45.  
  46.  + Fixed bug when speed-locating strings containing commas.
  47.  + Fixed list-view column overlapping.
  48.  + Fixed a few other display glitches.
  49.  + Fixed Note (PGDN) bug.
  50.  
  51.  + Included INT5F graphics driver to enable the use
  52.    of DBView on a desktop computer.
  53.  
  54.  
  55.  _______________
  56.  I. Installation
  57.  
  58.  There are 5 files included in this archive:
  59.  
  60.  + DBV.DOC:   The DBView documentation.
  61.  + DBV.EXE:   The DBView program.
  62.  + DBV.CFG:   The DBView configuration file.
  63.  + DBV.ICN:   The DBView icon.
  64.  
  65.  + INT5F.ZIP: Graphics emulator to enable you to run DBView
  66.               on your desktop. Documentation for it is
  67.               available in INT5F.ZIP
  68.  
  69.  
  70.  DBView is a YAPA (Yet Another PAL Application<g>), and like
  71. all PAL applications, it's a DOS program. Simply copy the
  72. files of the archive in a directory of your choice. The
  73. configuration file DBV.CFG must always reside in the same
  74. directory as DBV.EXE.
  75.  
  76.  
  77.  NOTE: DBV requires at least 130k of memory to operate.
  78.        If you install DBV in System Manager, please remember
  79.        to add '|130' at the end of the name. For example,
  80.        if DBV is installed in A:\DBV, the System manager
  81.        entry will look like this:
  82.  
  83.            a:\dbv\dbv.exe|130
  84.  
  85.        The '|130' will reserve 130k of memory for DBV. For
  86.        more details on installing applications in System
  87.        manager please consult your HP200LX owner's manual.
  88.  
  89.  
  90.  You can also specify database filenames if you would like
  91. to have several System Manager DBV entries (one for each
  92. database file for example):
  93.  
  94.            a:\dbv\dbv.exe myfile.gdb|130
  95.  
  96.  
  97.  
  98.  Configuration:
  99.  --------------
  100.  
  101.  DBV.CFG is the configuration file of DBView. You can use
  102. it to change some of the default parameters of DBView. At this
  103. moment, DBV.CFG is divided into 3 sections, [options], [paths]
  104. & [files]:
  105.  
  106.  
  107. [options]
  108. ; Set to 1 to enable error beeps, 0 to disable them.
  109. beep=1
  110. ; Set to 1 to enable search in note fields.
  111. SearchNotes=0
  112. ; Set to 1 to enable horizontal lines separating records.
  113. HorizLines=0
  114. ; Set to 1 to display numbers right-justified in list-view.
  115. RightJustify=0
  116.  
  117. [paths]
  118. ; set your database directory
  119. dbdir=c:\_dat
  120.  
  121. [files]
  122. ; filename of dump/extraction file
  123. DumpFile=dbv.sav
  124.  
  125.  
  126.  You can add comments anywhere in DBV.CFG provided that you
  127. start the lines with a semicolon.
  128.  
  129.  NOTE: Normally DBV.CFG should be located in the same
  130.        directory as DBV.EXE. However, you can make DBV
  131.        find DBV.CFG from any directory, by just copying
  132.        DBV.CFG into the C:\_DAT directory.
  133.  
  134.  
  135.  There's also an icon provided in this archive if you wish to
  136. install DBView in the System Manager.
  137.  
  138.  
  139. _____________________
  140. II.Program operation.
  141.  
  142.  You probably know how to use the System Manager's database
  143. application to create & view database files. DBView works
  144. very similar for viewing them.
  145.  
  146.  DBView supports multiple card database files. These are
  147. database files having more then 1 page of record information
  148. (up to 4 max.). DBView will display the page number on the
  149. top status line. Pressing the PGUP/PGDN keys will enable you
  150. to view the other pages, when available.
  151.  
  152.  * DBView cannot view password protected database files!
  153.    (will display Error#24 if file is password protected).
  154.  
  155.  
  156.  To run DBView from the DOS prompt simply type dbv <ENTER>.
  157. You may include a database filename at the command line if
  158. you wish, and DBView will run & load the specified database
  159. file. The command line arguments are:
  160.  
  161.   dbv <dbfile> <search string>
  162.  
  163.  where <dbvfile> is the name of a valid GDB, NDB or PDB file.
  164. If no extension is given, .GDB is taken as the default. You
  165. can also (optionally) specify a search string. DBV will launch
  166. and search for that string if you specify one.
  167.  
  168. IMPORTANT: Software Carousel(tm) users may switch into a
  169.            DOS session, leaving the System Manager's database
  170.            application open. You can not load a database
  171.            file that is currently open by the SysMgr's DB
  172.            application. The following error message will be
  173.            displayed and DBV will quit if you attempt to do so:
  174.  
  175.                  "Database file not closed?"
  176.  
  177.  If the DATABASE application is open and using the file you
  178. wish to load in DBV, you must close the DATABASE application,
  179. and then use DBView to view it. You may also get this message
  180. if the DATABASE application hasn't closed the database file
  181. properly (when this happens the lookup table is missing in
  182. the file). To correct this, you must open the database file
  183. using the DATABASE application, and then close it by quitting
  184. DATABASE. This will do the necessary cleanup in the database
  185. file.
  186.  
  187.    *** Now here's a solution to avoid the above problems:
  188.    ------------------------------------------------------
  189.    Since backups are always a good idea, why not use DBView on
  190.    your backup database files, and System manager's DB on the
  191.    original ones (when editing is needed).
  192.  
  193.  
  194.  DBView has 2 display modes: List view and record view. You
  195. can use the UP/DOWN arrows to select a record. To see the
  196. contents of a record press ENTER or F2. Most of the DBV
  197. functions can be accessed from the function keys. Some
  198. of the functions can also be accessed by the menus (please
  199. note that menus work only in list-view mode).
  200.  
  201. Here's the description of the function keys for the list-view
  202. mode:
  203.  
  204.  
  205.  ARROWS:  The Up key browses into the database backwards.
  206.           The Down key browses forward. The current
  207.           record is displayed on the top status bar along
  208.           with the loaded database filename.
  209.  
  210.  HOME:    Select the first record of the database.
  211.  END:     Select the last record of the database.
  212.  
  213.  F1:      Simple help screen.
  214.  F2:      Same as ENTER, displays the selected record data.
  215.  
  216.  F3:      Full screen note. The record's note (if any) will
  217.           be displayed in full.
  218.  
  219.  
  220.      NOTE: The current version of DBView still has a limited
  221.            way on viewing the complete note of a record.
  222.            (a multi-line field requires a lot of code<g>).
  223.            You can press the F3 key [more] to view the
  224.            rest of a large note. [HOME] or F4 will bring
  225.            you at the beginning of the note.
  226.  
  227.  
  228.  F4: Find feature. The find dialog will popup waiting for
  229.      the following input:
  230.  
  231.      String1: String of text/numbers you wish to find in the
  232.               database file.
  233.  
  234.      String2: Optional, second search string. If used, you
  235.               must select the searching method (logic):
  236.  
  237.          AND: Searches for a match of both String1 & String2
  238.          OR:  Searches for a match of either String1 or String2
  239.  
  240.  
  241.          [x]: The 'include notes' checkbox toggles the search
  242.               mode to include notes while searching (slower).
  243.  
  244.  
  245.         NOTE: Hold down the ESC key to abort the search. DBView
  246.               will search only through the records of the
  247.               currently selected subset (all records by
  248.               default).
  249.  
  250.      If a match is found, DBView will highlite the record. You
  251.      can then press ENTER to see its contents.
  252.  
  253.  F5: Will search for the next match, and display it if found.
  254.  
  255.  F6: Find "Only" feature. This search option will create
  256.      a subset of all matching records. You can return to
  257.      the previous subset by pressing F7, or even create
  258.      other subsets from the matching results by pressing
  259.      F6 as many times as you like.
  260.  
  261.  F7: Change to a different subset of the database. The
  262.      default is 'all database items'.  Note that this will
  263.      affect the search, since it will search only through
  264.      the records of the selected subset.
  265.  
  266.      NOTE: There may be ocassions where some subsets will not
  267.            appear in the subset selection window. This is
  268.            because the subset indexes are missing from the
  269.            database file. By simply opening the database
  270.            file with System Manager's database application
  271.            and viewing the 'missing' subsets, the file will
  272.            be updated and the missing subsets should then
  273.            appear in DBView's subset selection window.
  274.  
  275.  
  276.  F8: Dump the current record to a file (filename specified
  277.      in DBV.CFG) in ASCII (text) format.
  278.  
  279.  
  280.  F9: Open database. You can use this option to load another
  281.      database file into DBView.
  282.  
  283.  
  284.  There are some DBView features that can only be accessed
  285. by the menus. These include database calculations (explained
  286. further below), and field extraction.
  287.  
  288.  MENU->Database->Extract field data:
  289.  
  290. This feature can be used to extract the data from all the records,
  291. of a selected field into the DBV.SAV file. DBView will ask you
  292. for the field you wish to extract, and then extract it in ASCII
  293. format. You can only extract fields that contain numeric or text
  294. data (checkboxes and radio buttons cannot be extracted<g>.)
  295. Note that if DBV.SAV already exists, it will be over-written,
  296. not appended.
  297.  
  298.  
  299.  PRESSING ANY OTHER KEY:
  300.  
  301.   Pressing any alphanumerical key activates the SPEED-LOCATE
  302.   feature. A small window will popup at the top of the screen,
  303.   and every keystroke you enter will appear in that window.
  304.   DBV will search for a match while you are typing. If no
  305.   match can be found a short beep will be heard. Please note
  306.   that the speed locate feature searches only through the
  307.   items of the first (left) column of the list view display.
  308.   (same as System Manager's database application).
  309.  
  310.  
  311.  Now in the record-view mode (F2), the following keys are active:
  312.  
  313.  F1:        Small help screen.
  314.  F2/ESC:    Back to list view display mode.
  315.  F3:        View the record note (if any) in full screen.
  316.  F4:        Search for 1 or 2 strings in database (see above).
  317.  F5:        Find next match (see above).
  318.  F6/UP:     Select the previous record in the list.
  319.  F7/DOWN:   Select the next record in the list.
  320.  PGUP/PGDN: Select the page to view in a multiple-card database.
  321.  
  322.  
  323.  
  324. ___________________________________
  325. III. DBView COMPUTING CAPABILITIES.
  326.  
  327. DBView has a small set of 4 statistical calculations that can
  328. be performed on a selected field, with given criteria. These
  329. features are only accessible from within the menus:
  330.  
  331.  
  332.  a) Set Criteria
  333.  ---------------
  334.  
  335. If you don't use this option, DBView will perform the
  336. selected calculation on ALL database records of the CURRENT
  337. SUBSET. You can provide the following criteria if you want
  338. DBView to do the calculation based on records that only match
  339. the criteria you have entered.
  340.  
  341.  The criteria is based on 3 values: First, the field that
  342. will be used to compare the criteria against. Then, you
  343. must provide one of the 10 relational operators (comparison
  344. between field & criteria). Finally, the criteria data that
  345. will be compared against the selected field using the
  346. selected relational operator. Here's the list of the possible
  347. relational operators:
  348.  
  349.  NOP: No criteria - process all records.
  350.  
  351.  String operators:
  352.  
  353.   = : Field must match the given criteria.
  354.       ATTENTION: criteria string is CASE-SENSITIVE!
  355.  
  356.  ~= : Criteria must match at least a PART of the field.
  357.       ATTENTION: criteria string is CASE-SENSITIVE!
  358.  
  359.  <> : Field must not match given criteria.
  360.       ATTENTION: criteria string is CASE-SENSITIVE!
  361.  
  362.  Numeric operators:
  363.  
  364.   = : Field value must match criteria value.
  365.  <> : Field value must not match given criteria.
  366.   < : Field value must be smaller then criteria value.
  367.  <= : Field value must be smaller or equal to criteria value.
  368.   > : Field value must be greater then criteria value.
  369.  >= : Field value must be greater or equal to criteria value.
  370.  
  371.  Boolean operators:
  372.  
  373.  ON : Checkbox or Radio button must be enabled (marked).
  374.  OFF: Checkbox or Radio button must be disabled (unmarked).
  375.  
  376.  
  377.  b) Calculations:
  378.  ----------------
  379.  
  380.  All calculations will be performed on the current subset,
  381. and only with records that match the given criteria (or
  382. all records if no criteria are given).
  383.  
  384.  SUM: Adds numeric data of the specified field and displays
  385.       the total.
  386.  
  387.  AVG: Computes the average (SUM/n) of the specified field.
  388.  MIN: Find the MINimum (smallest) value of the specified field.
  389.  MAX: Find the MAXimum (largest) value of the specified field.
  390.  
  391.  
  392.  
  393.  NOTES:
  394.  ------
  395.  >, >=, <, <= operators can only be used with numeric values.
  396.  ON, OFF operators must only be used with checkbox or radio
  397.  button types of fields.
  398.  
  399.  DBView assumes that strings having the "hh:mm" format contains
  400.  time data, so it computes & shows the result in the same format.
  401.  
  402.  DBView does not compute dates.
  403.  
  404.  
  405.  
  406.                               ***
  407.  
  408. ________
  409. APPENDIX
  410.  
  411.  INT5F.ZIP:
  412.  ----------
  413.  
  414.  This file is included in this archive. It's a small TSR
  415.  which simulates the HP200LX graphics on desktop computers.
  416.  If you would like to use DBView on your desktop system,
  417.  please pkunzip this file and read the included documentation.
  418.  You can also use other PAL applications such as PalEdit
  419.  and HV with INT5F on your desktop.
  420.  
  421.  
  422.  ERROR CODES:
  423.  ------------
  424.  
  425.  Here are listed a few usefull error codes that DBV may return:
  426.  
  427.  Error #2 : Out of memory (may also display 'PALMEM fail: out of memory').
  428.  Error #4 : File read operation error (file corrupted?).
  429.  Error #5 : Index is missing from database file, must be refreshed
  430.             by System Manager's database application.
  431.  
  432.  Error #7 : Not a database file.
  433.  Error #8 : World time database file - not supported.
  434.  Error #9 : Appointment book database file - not supported.
  435.  Error #14: Error opening database file (file not found?).
  436.  Error #24: Database file is password protected.
  437.  
  438.  
  439.  * If you get unexpected errors when using DBView within
  440.    System Manager, try to increase the amount of memory
  441.    on the application entry screen.
  442.  
  443.  
  444.  HDM USERS:
  445.  ----------
  446.  
  447.  If you're using HDM, a DOS application manager written for
  448. the HP200LX palmtops (and also a PAL application) you can
  449. use it to display several database files in the icon screen,
  450. and open a database file by simply selecting its icon. In
  451. order for this to work, you must enter 'dbv <dbfile>' as
  452. DOS application names. Here's an example:
  453.  
  454.  Press F2 in HDM and the 'New application' screen will appear.
  455. Enter the following in the entry fields:
  456.  
  457.  APPLICATION NAME: Phonebook
  458.  PATH & FILENAME : a:\dbv\dbv
  459.  COMMAND TAIL    : c:\_dat\phone.pdb
  460.  
  461.  Ofcourse, the 'PATH & FILENAME' line above assumes that DBView
  462. resides in a:\dbv directory, and your phone.pdb file in
  463. c:\_dat. You will need to enter your own paths in there.
  464.  
  465.  Now this new entry in HDM will enable you to load & view your
  466. phonebook database with a press of a button. You can add as
  467. many entries like this one as you wish, one for each database
  468. file, and startup DBView with the selected database with
  469. a single keystroke.
  470.  
  471.  
  472. _______
  473. Credits
  474.  
  475.  I would like to thank all the PAL contributors for providing
  476. the PAL library, specially Gilles Kohl, and Fred Kaufman
  477. for giving me the idea of this program. I would also like
  478. to thank ALL of you for your suggestions on improving DBV.
  479.  
  480.  
  481.  DBView is a freeware PAL application. DBView, like any program,
  482. may have bugs. Although I have tested DBView and use it with
  483. my own database files, I cannot guaranty that it's full-proof.
  484. so "use it at your own risk"! You can send me bug reports &
  485. comments at:
  486.  
  487.  
  488.    Harry Konstas
  489.  
  490.    email:    72540.620@compuserve.com
  491.    web site: http://ourworld.compuserve.com/homepages/harry/
  492.  
  493.  
  494.    TODO list:
  495.    ----------
  496.  
  497.  Sorry if some of your suggestions didn't make it in this
  498. version. There are *many* things I would like to add and
  499. improve in DBView, but unfortunately the memory requirements
  500. won't allow me to do so. DBView now needs at least 130k to
  501. run, and soon, if we add more stuff, we won't be able to use
  502. it within System Manager.
  503.  
  504. So future releases would probably be only bug fixes, and
  505. maybe some minor additions or enhancements.
  506.  
  507.  
  508.    DBView 2.0
  509.    Portions copyright, the PAL Group. (c)1996
  510.  
  511.  
  512.                             ---
  513.  
  514.  
  515.