home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / genapps / rquery3.arj / RQUERY3.DOC < prev    next >
Text File  |  1992-01-20  |  21KB  |  479 lines
  1.                                   RQUERY3                          1
  2.                                      
  3.                                version 1.25
  4.                                      
  5.                                      
  6.                  Copyright (C) Jerry A. Horton, 1991, 1992
  7.                                      
  8.                                      
  9.                                P.O. Box 274
  10.                                      
  11.                             Whitfield, MS 39193
  12.                                      
  13.                              FAX: 601-939-0654
  14.                                      
  15.                       Phone#: 601-939-1221, Ext# 371
  16.                                     or
  17.                      Phone#: 601-856-0604, After hours
  18.                                      
  19.                                      
  20.                                      
  21.                                      
  22.                             REVISED: 1/17/1992
  23.  
  24.                            RBase 3.xx Version!!
  25.  
  26. The program allows the user to use either existing reports of a database or
  27. to create custom reports.  RQUERY3 allows you to choose  the table to work
  28. with, the columns to use in any order, the method of sorting, and set a
  29. condition to each Query!  Rquery3 can work with both tables and views.
  30. Rquery also allows the use of the database's existing reports but allows
  31. the user to create NEW conditions and sorts.  Rquery3 also does various
  32. custom calculations, and provides access to a password protected simulated
  33. R> prompt if the developer allows it.  If called from within another Rbase
  34. application, the main screen also provides access to selecting the default
  35. printer driver to use for the current application session.  Only those
  36. printer drivers that are in the directory containing Rbase are available.
  37. To be safe all PRD files should be made available to the user.
  38.  
  39. REQUIREMENTS:  Rbase 3.xx Runtime, or Rbase 3.xx, or Personal Rbase.
  40.  
  41.  
  42.  
  43.  
  44.  
  45. LEARNING TO USE RQUERY3                                            2
  46.  
  47.  
  48. THE BEST WAY TO LEARN HOW TO USE RQUERY3 (OR ANY PRODUCT) IS TO USE IT.
  49.  
  50.  
  51. This guide is not intended as a detailed manual.   The program is basically
  52. self explanatory.   This stand alone program works only with databases
  53. created by Microrim's Rbase.
  54.  
  55. To operate the program you must have all of the files listed below, except
  56. this RQUERY.DOC and  FORM.TXT, in the directory where the RBF files are
  57. located.
  58.  
  59.  
  60. When creating  a custom reports, the program creates a temporary file
  61. called "RQUERY.DAT" to store your query, then erases it.  Therefore do not
  62. have any other file by that name in the current directory.
  63.  
  64.  
  65. LIST.COM -   This is a utility by Vernon Buerg and is separately zipped.
  66.  
  67.  
  68. RQUERY3.apx -  Start up menu for the program.
  69.  
  70. RQCHOOSE.apx This is the main portion of the program.
  71.  
  72. RQVIEW.apx - Provides the viewing and printing options.
  73.  
  74. RQUERY3.DOC -  Manual
  75.  
  76. FORM.TXT -   Registration form.
  77.  
  78. On starting the program, you will see the following screen.        3
  79.  
  80.  
  81.                        +--------------------+
  82.                        |*** RQUERY3 1.25 ***|
  83.                        +--------------------+
  84.  
  85. +--------- | RQUERY Main Screen - Choose Type of Report | --+
  86. |  Existing Report        Create Custom Report   Calculate  |
  87. |  Work with Text Files   Select Printer Option  R> prompt  |
  88. |  [DONE]                                                   |
  89. +-----------------------------------------------------------+
  90.  
  91.  
  92.  
  93. WORK WITH TEXT FILES
  94.  
  95.  
  96. Choosing this option causes the program to look in the current directory
  97. for any files.  [CTRL] [P] will print the entire file.  [F1] will bring up
  98. a help screen. [/] allows you to search for text, and [ESC] will exit.  For
  99. more details see next.
  100.  
  101.  
  102.     FUNCTION KEYS            ALT- KEYS               ALT- KEYS
  103. F1  Display HELP        a-A  find text Again    a-S  Sharing on/off
  104. F2  set FIND bg         a-B  mark Bottom line   a-T  Tabs on/off
  105. F3  Find next text      a-C  Save options       a-U  Unmark lines
  106. F4  set FIND fg         a-D  copy to file       a-V  file select menu
  107. F5  set text bg         a-E  toggle EGA 25/43   a-W  toggle windows
  108. F6  set text fg         a-F  get new Filespec   a-X  exit, restore screen
  109. F7  set 1/25 bg         a-G  Goto DOS           a-Y  recall bookmark
  110. F8  set 1/25 fg         a-H  toggle Hex mode    a-Z  show toggles
  111. F9  Find prev text      a-I  insert new file
  112. F10 Exit to DOS         a-J  Junk filter        7/8/*   hi-bit filters
  113. /  Scan for exact text  a-K  toggle Key ahead   +/-/#   skip to line #
  114. \  Find any case text   a-L  toggle preLoading   1   display first file
  115.                         a-M  Mark top line
  116. P  Printer on/off       a-N  screen saving
  117. W  Wrap long lines      a-O  append data value,
  118. Q  quit to next file    a-P  print marked amount,
  119. X  Exit to DOS, cls     a-R  Ruler on/off
  120.  
  121.  
  122.              CONTROL KEYS               CURSOR KEYS                4
  123.         c-A  scroll full left
  124.         c-C  scroll down one page       Home   Top of file
  125.         c-D  scroll right 10            End    Bottom of file
  126.         c-E  scroll up one line         PgUp   scroll up one page
  127.         c-F  printer form feed          PgDn   scroll down one page
  128.         c-H  hang-up telephone          Left   scroll left 10
  129.         c-I  define TAB interval        Right  scroll right 10
  130.         c-L  find text again            Down   scroll down one line
  131.         c-M  scroll down one page       Up     scroll up one line
  132.         c-N  display previous file
  133.         c-P  print entire file          c-Home   position by line number
  134.         c-R  scroll up one page         c-PgUp   display previous file
  135.         c-S  scroll left 10             c-PgDn   display next file
  136.         c-T  dial telephone             c-Left   scroll full left
  137.         c-U  display previous file      c-Right  scroll full right
  138.         c-V  switch windows
  139.         c-W  scroll up one line
  140.         c-X  scroll down one line
  141.         c-Y  set bookmark
  142.         c-Z  display previous file
  143.  
  144.  
  145. CREATE CUSTOM REPORT                                               5
  146.  
  147.  
  148. Next, you will be given a list of all Rbase databases in the current
  149. directory.  Simply highlight the one you wish to use and press ENTER.  The
  150. program will prompt as to whether to use tables or views after you have
  151. chosen the database to work with.
  152.  
  153. You will then be offered a list of all the existing tables or views in the
  154. currently open database.   Highlight your choice and press ENTER.
  155.  
  156. You will then  be shown all of the columns in the chosen table or view.
  157. You may choose to use all by pressing ESC or you may choose the ones you
  158. wish in any order you like to view by highlighting each in turn, Press [F2]
  159. when done.
  160.  
  161. You will then go to the SORT screen.  Once again you will be shown all of
  162. the columns in the current table or view.  After choosing a sort column you
  163. can then choose "Ascending" or Descending".   When you have made all your
  164. choices press [F2] to go on.  Press [ESC] to have no sort.
  165.  
  166.  
  167. +----------+
  168. | OBJECT   |
  169. | BLDGLIST +--------------+
  170. | DDIR     | √ FirstName  |
  171. | DIV_DESC | √ LastName   |
  172. | R_INV    | + MI         +---------------+
  173. | R_TRANS  | √ Address1   |  + FirstName  |
  174. | PO_TRANS | + Address2   |2 A LastName   |
  175. | ICREDIT  | √ CITY       |  + MI         |
  176. | PO_REC   | √ STATE      |  + Address1   |
  177. | BLDGS    | √ ZIPCODE    |  + Address2   |
  178. | COSTCTR  | + Title      |  + CITY       |
  179. | R_HOLD   | √ Company    |  + STATE      |
  180. | PRINTERS | + Vendor#    |  + ZIPCODE    |
  181. | IHISTORY | + PhoneAC    |  + Title      |
  182. | ITEMTYPE | + PhoneExc   |1 A Company    |
  183. | I_INV    | + PhoneNum   |  + Vendor#    |
  184. | INV_TYPE | + PhoneExt   |  + PhoneAC    |
  185. | People   | + CPhoneAC   |  + PhoneExc   |
  186. | PO       | + CPhoneExc  |  + PhoneNum   +------------+
  187. +----------| + CPhoneNum  |  + PhoneExt   | Ascending  |
  188.            +--------------|  + CPhoneAC   | Descending |
  189.                           +---------------+------------+
  190.  
  191. Ascending sort order
  192. Database: INV                TYPE: TEXT 6    Extension
  193.  
  194.  
  195. You will now go to the conditions screen.  Once again you will be able to
  196. choose your conditions by highlighting your choice.  When you press ENTER
  197. you will be given a list of conditions to choose from (eg. EQ, GT,
  198. CONTAINS, etc.)  After choosing the condition you will be prompted, if
  199. necessary for input to match the condition against.   Press [F2] to end or
  200. if you wish to select nothing just press [ESC].  After each choice you are
  201. prompted to choose one of the following: AND, OR, AND NOT, OR NOT, (DONE).
  202. Choose DONE when finished with your conditions.
  203.  
  204.  
  205.  
  206.          Select Columns for Conditions (Press ESC For None)        6
  207. _____________________________________________________________
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214. +----------------------------------------------------------+
  215. |      | Column             | Operator    | Value          |
  216. |------+--------------------+-------------+----------------|
  217. |      | STATE              | =           | "MS"           |
  218. | OR   | STATE              +---------------------------+  |
  219. |      |                    | =   EQUAL                 |  |
  220. |      |                    | <>  NOT EQUAL             |  |
  221. |      |                    | >   GREATER THAN          |  |
  222. |      |                    | >=  GREATER THAN OR EQUAL |  |
  223. |      |                    | <   LESS THAN             |  |
  224. |      |                    | <=  LESS THAN OR EQUAL    |  |
  225. |      |                    | BETWEEN                   |  |
  226. +---------------------------| NOT BETWEEN               |--+
  227.                             +---------------------------
  228.  
  229. Choose an operator.
  230. Database: INV
  231.  
  232.  
  233.  
  234.  
  235.                                 COMPARISONS                        7
  236.  
  237.  
  238. +--------Choose how columns and values are compared--------+
  239. | Prompt By Example asks you to choose a comparison to be  |
  240. | used with the current column. The operators are defined  |
  241. | as:                                                      |
  242. |                                                          |
  243. |   EQ          Equal to                                   |
  244. |   NE          Not equal to                               |
  245. |   GT          Greater than                               |
  246. |   GE          Greater than or equal to                   |
  247. |   LT          Less than                                  |
  248. |   LE          Less than or equal to                      |
  249. |   EXISTS      Column contains data                       |
  250. |   CONTAINS    contains "string"                          |
  251. |   IN          Value of column exists in selected rows    |
  252. |   NOT IN      Value of column does not exist in          |
  253. |               selected rows                              |
  254. |   FAILS       Column is null                             |
  255. |   IS NULL     Column is null                             |
  256. |   IS NOT NULL Column contains data                       |
  257. |   LIKE        Column equals "string"                     |
  258. |   NOT LIKE    Column not equal to "string"               |
  259. |   BETWEEN     Greater than or equal to value1 and        |
  260. |               than or equal to value2 -- place quotes    |
  261. |               around the values; connect them with AND   |
  262. |   NOT BETWEEN Less than value1 or                        |
  263. |               greater than value2                        |
  264. +----------------------------------------------------------+
  265.  
  266.  
  267.                                 CONNECTORS
  268.  
  269.  
  270. +-----Choose how qualification conditions are combine------+
  271. |   Prompt By Example asks you to choose how the previous  |
  272. |   qualifications are to be combined with the next        |
  273. |   qualification condition. The possibilities are:        |
  274. |                                                          |
  275. | AND      The previous conditions must be met and ...     |
  276. | OR       The previous conditions must be met or ...      |
  277. | AND NOT  The previous conditions must be met and not ... |
  278. | OR NOT   The previous conditions must be met or not ...  |
  279. | (Done)   No more conditions are wanted                   |
  280. +----------------------------------------------------------+
  281.  
  282.  
  283. The program will then select the data and present the following menu.                                                                   8
  284.  
  285.  
  286.                +----------+
  287.                | SCREEN   |
  288.                | PRINTER  |
  289.                | FILE     |
  290.                | END      |
  291.                +----------+
  292.  
  293.  
  294. Then if you choose "SCREEN", the report will be presented to the screen
  295. allowing you to scroll up, down  and to either side with the cursor control
  296. keys, tab key, or the page up and page down keys.  END will take you to
  297. the bottom  of the report and  Home will  take you back to the beginning.
  298. Press ESC and then  ENTER to return to the above menu. Choosing "PRINTER"
  299. will print the report to your printer.  This program uses no printer
  300. control commands, so you will have to put your printer in condensed  print
  301. format if you choose more columns than will fit on your paper normally.
  302. Choosing "FILE", will allow you to save this query, fill in a file name
  303. when prompted.   Warning!! Do not use the name "Rquery.dat", as that name
  304. is reserved by the program.!
  305.  
  306.  
  307. EXISTING REPORTS
  308.  
  309.  
  310. Once again, you will be given a list  of all Rbase databases in the current
  311. directory.   Simply highlight  the one  you wish to use and press ENTER.
  312. You will then be offered a list of all the existing tables or views in
  313. currently open database.   Highlight your  choice and  press ENTER.  If
  314. there are no reports for the table or view you  have chosen, you will get
  315. an error message and return to the main menu.  You will then be shown all
  316. of the columns in the chosen table or view.   You may choose to use all by
  317. pressing ESC or you may choose up to 10 in any order you wish to view by
  318. highlighting each in turn.
  319.  
  320. You will then go to the SORT screen.  Once again you will be shown all of
  321. the columns in the current table or view.  After choosing a sort column you
  322. can then choose "Ascending" or Descending".   Each choice is numbered as to
  323. the sort order.   When you have made you choices press [F2].  If you wish
  324. none, press ESC to go to the next screen.
  325.  
  326. You will now go to the conditions screen.  Once again you will be able to
  327. choose your conditions  by highlighting your choice.  When you press ENTER
  328. you will be given a list of conditions to choose from (eg. EQ, GT,
  329. CONTAINS, etc.)  After choosing the condition you  will be prompted, if
  330. necessary for input to match the condition against.  If you wish no
  331. conditions, press ESC.
  332.  
  333. You may have multiple conditions.  After each choice you are prompted to
  334. choose  one of  the following:  AND, OR, AND NOT, OR NOT, (DONE).  Choose
  335. DONE when finished with your conditions.
  336.  
  337. The program will then list all the available reports for the table or view
  338. you have chosen to work with.  Choose one.
  339.  
  340. The program will then select the data and present the following menu.
  341.  
  342.  
  343.  
  344.                +----------+                                        9
  345.                | SCREEN   |
  346.                | PRINTER  |
  347.                | FILE     |
  348.                | END      |
  349.                +----------+
  350.  
  351.  
  352.     If the report contains a global variable defined  elsewhere, the report
  353. will not print.  All variables used in the report must be defined in that
  354. report.  To get around this problem, copy the report with the global
  355. variable to a new name and remove all references to the global variable or
  356. provide a constant equal to the variable.
  357.  
  358.  
  359.  
  360. CALCULATE
  361.  
  362.  
  363. Next, you will be given a list of all Rbase databases in the current
  364. directory.   Simply highlight the one you wish to use and press ENTER. You
  365. will then be  offered a list of all the  existing tables or views  in the
  366. currently open database.  Highlight your choice and press ENTER.
  367.  
  368. You will now go to the conditions screen.  Once again you will be able to
  369. choose your conditions  by highlighting your choice.  When you press ENTER
  370. you will be given a list of conditions to choose from (eg. EQ, GT,
  371. CONTAINS, etc.)  After choosing the condition you will be prompted, if
  372. necessary for input to match the condition against.  You must choose at
  373. least one  condition.   If you wish to select everything in your database,
  374. match any field that will always contain a value with IS NOT NULL.
  375.  
  376. You may have up to 10 conditions.  After each choice you are prompted to
  377. choose one of the following:  AND, OR, AND NOT, OR NOT, (DONE).
  378.  
  379. Choose DONE when finished with your conditions.
  380.  
  381. You will then be asked as to what type of calculation you wish to perform.
  382. You will be given the list [SUM, COUNT, MINIMUM, MAXIMUM, AVERAGE, STANDARD
  383. DEVIATION, VARIANCE, and ALL].  Choose one.  You will then be given a list
  384. of available fields in the table or view you have chosen.
  385.  
  386. Choose one to apply the computation against based on the conditions you
  387. have previously chosen.
  388.  
  389. The program will then print the result to the screen.  If you chose ALL,
  390. only the calculations that pertain to  the field data type will be used.
  391. After pausing, you may press any key to return to the main menu.  You can
  392. not save to file the results but you can do a PrintScreen.
  393.  
  394.  
  395.  
  396. Rprompt                                                            10
  397.  
  398.  
  399. Choosing this option will run the "RPROMPT.APX application.  It first saves
  400. the current user password, and prompts for a new one.  (As the source code
  401. is available, the built in password of "RQUERY" may be changed.)  The user
  402. will then be offered a blank screen with a small r>.  The user can execute
  403. any Rbase command that will fit on one line.  On completion, the user
  404. simply presses [ENTER] on a blank line to return to the Main menu.  At that
  405. time the User password that was saved is restored.
  406.  
  407.  
  408. Select Printer Option
  409.  
  410.  
  411. +-------------- PRINTER SETUP MENU --------------+
  412. |   (1)  PICK TYPE OF PRINTER FOR APPLICATION    |
  413. |   (2)  ADD / UPDATE PRINTER TYPES              |
  414. |   (3)  EXIT                                    |
  415. +------------------------------------------------+
  416.  
  417. This option is used to select the default printer driver.  If the Rbase
  418. application has printer formating code in its reports, this routine will
  419. allow the end user to select the driver that fits his printer.  Unless the
  420. calling application has a "SET PRINTER" command to overide this, then the
  421. selection will stay in effect when Rquery is ended to return to the calling
  422. application.
  423.  
  424.  
  425.                     PRINTER  SELECT
  426.  
  427.   +√-------PRINTER-----------------MODEL------------------+
  428.   |  |Hewlett-Packard      |HP-Paintjet                   |
  429.   |  |Hewlett-Packard      |LaserjetII                    |
  430.   |  |Hewlett-Packard      |LaserjetIID                   |
  431.   |  |Hewlett-Packard      |LaserjetIIP                   |
  432.   |  |IBM Corp.            |IBM-Laser-printer             |
  433.   |  |IBM Corp.            |Proprinter                    |
  434.   |  |IBM Corp.            |ProprinterXL                  |
  435.   |  |IBM Corp.            |Proprinter-X24                |
  436.   |  |IBM Corp.            |Proprinter-XL24               |
  437.   |  |IBM Corp.            |Proprinter-X24E               |
  438.   |√ |IBM Corp.            |Proprinter-XL24E              |
  439.   |  |IBM Corp.            |Quickwriter-5204              |
  440.   |  |IBM Corp.            |ProprinterII                  |
  441.   +-------------------------------------------------------+
  442. [ALT] MENU/FORM   PRESS ANY CHARACTER 2X TO SELECT IN √ COLUMN
  443.                   PRESS THE SPACE BAR 2X TO UNSELECT
  444. [F7] SCROLL DOWN  [F8] SCROLL UP
  445.  
  446.  
  447.                        DISTRIBUTION AND REGISTRATION               11
  448.  
  449. Rquery3 is in a constant state of revision at this time and is in no way in
  450. a final format.  Therefore, as a user of this program, you accept the
  451. possibility of a failure of the software to perform as documented.  I would
  452. appreciate being made aware of any bugs or suggested enhancements.  A
  453. compiled 2.xx and simi compatible RBase 3.xx version of the program of the
  454. program "RQUERY" is also available.
  455.  
  456. As you  know software copyright violation is rampant.  This is why we have
  457. created  RQUERY3.   RQUERY3 allows  access to codelocked and compiled RBASE
  458. applications without the need of purchasing a copy of RBASE to do custom
  459. lookups and reports.  While RQUERY3 is available for distribution, there
  460. will be no need to pirate copyrighted software to obtain access to ones own
  461. database.   Please feel free to give RQUERY3 to your friends.  We are
  462. counting on you as a participant in the largest distribution network in the
  463. nation (the owners and users of PCs) to make RQUERY3 a popular product.
  464. With strong user support, RQUERY3 will be enhanced with new features and
  465. capabilities making it more powerful.   For twenty five (25) dollars you
  466. can become a registered owner of RQUERY3.  For your $25.00 you will appease
  467. your  conscience about  using unregistered software, receive notice of
  468. updates, and a copy of the latest version of RQUERY3.
  469.  
  470. The file FORM.TXT can be used as an order form.
  471.  
  472.  
  473.  SEND A CHECK TO:   Jerry A. Horton
  474.                     P.O. Box 274
  475.                     Whitfield, MS  39193
  476.  
  477.  
  478.  We thank you for your support.
  479.