home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / datamage.zip / HELPFILS.ZIP / AM_KEY_T.HLP < prev    next >
Text File  |  1991-04-27  |  8KB  |  154 lines
  1. APPLICATIONS MAKER - HELP ON KEYS
  2.  
  3. When you opt to initialize a STRING ITEM as type KEY you are  telling
  4. the  program  that  this item will be the basis of a  LOOKUP  into  a
  5. datafile.   The purpose of a LOOKUP is to find and load a  particular
  6. record so that information it contains can be made available for  use
  7. in your application.
  8.  
  9. These KEYS are available to find records in any of the datafiles  you
  10. have  chosen for your application.  The target datafile  is  selected
  11. from a window during the initialization of the KEY ITEM.
  12.  
  13. KEY SOURCES:
  14.  
  15. Your keys can be of five types:  KEYBOARD entries, MENU files,  AUTO-
  16. FILL,  BROWSE  and  EXPANDED.  From these you will be  able  to  find
  17. records in many different ways, suitable to almost any need.
  18.  
  19. KEYBOARD KEYS:  With the KEYBOARD KEYS your user enters the data that
  20. will  be the basis of the LOOKUP.  Within this  classification  there
  21. are  two ways to find records:  by their RECORD NUMBERS and by  their
  22. FILE INDEXES.
  23.  
  24. RECORD  NUMBER  lookups allow your user to  enter  the  user-assigned
  25. record number of a record.
  26.  
  27. With  the FILE INDEX KEYS your user will enter the data contained  in
  28. the target record.  The field containing the data for which you  will
  29. search  must  be declared as INDEXED UNIQUE.  You  will  select  your
  30. field from a window filled with the INDEXED fields.
  31.  
  32. DATAMAGE  offers  three  types of indexing: UNIQUE,  CROSS  and  NON-
  33. UNIQUE.  Of these, only UNIQUE and CROSS indexed fields are  suitable
  34. for  the  absolute  identification of a record, as  the  system  will
  35. reject new/edited records having duplications in these fields.
  36.  
  37. APPLICATIONS  MAKER does not allow you to place CROSS-INDEXED  fields
  38. on  the input screen.  These fields might have a formula attached  to
  39. them or might be written into another file.  When the lookup into the
  40. file  is executed, on entry of the last field in the cross-index,  it
  41. might  fail.   This would produce an intractable situation.   If  you
  42. wish  to allow your user to search the cross index you must  use  the
  43. EXPANDED KEY type, detailed below.
  44.  
  45. MENU KEYS:  With the MENU KEYS you will make a menu file with a  word
  46. processor,  in pure ASCII mode.  The menu file will be named  at  the
  47. time you initialize your MENU KEY item.  This file can have up to one
  48. hundred choices in it.  It must have TWO lines for each choice -  the
  49. first  holding the text proffered to the user, the second  containing
  50. the data returned to the program.  See the docs for APPLICATION MAKER
  51. for further details on MENU items.
  52.  
  53. The  MENU KEYS are used to find a particular record,  associating  it
  54. with a descriptive text which is chosen by your user.  You might have
  55. an  application that processes sales and returns.  You might wish  to
  56. add  the total generated to one record in a file if  the  transaction
  57. was sale, and another if it was a return.
  58.  
  59. As  with the KEYBOARD KEYS your menu file may return ether  a  RECORD
  60. NUMBER or the contents of a field indexed as UNIQUE.  Since there  is
  61. only  one item returned from the menu file the MENU KEYS may  not  be
  62. used in conjunction with the CROSS INDEXES.
  63.  
  64. AUTO-FILL  KEYS:   With the AUTO-FILL KEYS you  can  read/write  data
  65. to/from  a particular record.  You make the KEY data a part  of  your
  66. application,  and  the same record is found every  time.   Using  the
  67. scenario  above,  you  might  branch to  a  different  part  of  your
  68. application to process the sales and returns.  Then the choice of the
  69. record in which to place your total could be made for the user.
  70.  
  71. AUTO-FILL keys may use ether RECORD NUMBERS or UNIQUE INDEXES.
  72.  
  73. BROWSE  KEYS:  With the BROWSE KEYS the target datafile is  read  and
  74. displayed  in a window opened on top of your screen.  You select  the
  75. field inertly displayed, usually the description of the record.   The
  76. user may opt to change the display field.
  77.  
  78. Your  user can scroll through the file with his up/down  arrow  keys,
  79. page  up/down  keys  or home/end keys.  When the  desired  record  is
  80. highlighted your user hits return to select it.
  81.  
  82. You  also specify the field in the target file that will be  returned
  83. to  the  program, and fill the item.  Your user may  NOT  change  the
  84. field that is returned.
  85.  
  86. EXPANDED  KEYS:  With the EXPANDED KEYS your application screen  will
  87. clear,  the  speaker  will beep, and the  lookup  will  be  displayed
  88. complete with file number and it's description.  Your user will  have
  89. the option of searching on the RECORD NUMBERS or the FILE INDEXES.
  90.  
  91. If  your  user opts for the file indexes the program will  display  a
  92. screen  similar to the FIND RECORD function in the BASE program.   It
  93. will  prompt  your user for all of the indexed fields in  the  target
  94. datafile,  which  may be filled with a search value  or  bypassed  by
  95. pressing return.
  96.  
  97. If  your  user fills a field that is declared as indexed  UNIQUE,  or
  98. fills  all  of the fields declared as CROSS-INDEXED and  a  match  is
  99. found  in  the  targeted datafile the record will  read  in  and  the
  100. program will continue.
  101.  
  102. If your user fills a field or fields declared as indexed  NON-UNIQUE,
  103. or  some  but not all of the fields declared as CROSS-INDEXED  and  a
  104. match  is found the record will be displayed on a screen  similar  to
  105. the  record access screen in the BASE program.  Your user  will  then
  106. view the record.  After pressing Q to quit the record your user  will
  107. have the option of accepting the record displayed, or continuing  the
  108. search for the desired record.
  109.  
  110. If a record is not found the program will offer your user the  option
  111. to  retry  the  search, or to quit.  If your user opts  to  quit  the
  112. search the program will offer to find the record on any of the  modes
  113. above.  If your EXPANDED KEY item has a label to handle bypasses your
  114. user  will  have the option to continue, if not the  continue  option
  115. will  be  replaced by the option to abort.  If the  abort  option  is
  116. selected the APPLICATION will end with an error.
  117.  
  118. KEYS NOT FOUND:
  119.  
  120. Any  of the KEY TYPES may fail.  Your user may enter data into a  key
  121. item  that is not found in the target file.  Or your user may  BYPASS
  122. the key item by simply pressing return on it.
  123.  
  124. The  KEY ITEMS have the built-in option to handle bypasses by  either
  125. branching  to a label, or aborting the application.  This is  defined
  126. during the initialization of the KEY item.
  127.  
  128. In the event of your user entering data that is not found the program
  129. will  not  halt,  but  will display five options  to  deal  with  the
  130. situation:   RETRY, CONTINUE/ABORT, EXPAND, BROWSE and ENTER  RECORD.
  131. If your KEY ITEM has a label to go to on the bypass of that item  the
  132. second option offered to your user will be CONTINUE, else the  second
  133. option will be ABORT.
  134.  
  135. RETRY will allow your user to try the KEY entry again.
  136.  
  137. ABORT will end the application and CONTINUE will bypass the item.
  138.  
  139. EXPAND  Will allow your user the option to search the file on  RECORD
  140. NUMBERS,  or the FILE INDEXES.  If the FILE INDEX option is  selected
  141. ALL of the indexes will be available as search targets.
  142.  
  143. BROWSE  will produce and fill the BROWSE WINDOW, and allow your  user
  144. to video-select his record from the file.
  145.  
  146. ENTER  RECORD  will allow your user to enter a new  record  into  the
  147. target  file.   This record will then become the source of  the  data
  148. read/written to/from that file.
  149.  
  150. WRAP-UP:
  151.  
  152. As you can see, APPLICATIONS MAKER provides many ways to do a LOOKUP.
  153. There is NO other data program that offers this power and flexibility
  154. while finding records in relational files.