home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / vrac / udb_20.zip / DATABANK.HLP < prev    next >
Text File  |  1996-06-18  |  10KB  |  303 lines

  1.  
  2.  
  3.  
  4.  
  5.                     ---===<<<  Universal DataBank   >>>===---
  6.  
  7.                              By: John A. Reder 1996 
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16. Contents:
  17.  
  18. Section I    Overview
  19. Section II    Searching for records
  20. Section III    Database reporting
  21. Section IV    Adding and updating database records
  22. Section V    Database configuration
  23. Section VI    Technical notes (the database .set file)
  24. Section VII    Associated files & programs
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                   --------  S E C T I O N    O N E   -----------
  32.  
  33.  
  34. Overview:
  35.  
  36. Databank is designed to allow a user to setup and configure a database 
  37. quickly without having to poor through volumes of text and learning complex
  38. and confusing database applications.
  39.  
  40. The Registered version can support up to 500 databases and each database can 
  41. be setup with up to 31 fields and have up to 10000 records.  The database reserves 
  42. 50 characters for each field but the set file will allow you to accept any number 
  43. from 1 to 50 from the data input screens.  The length of a field can be changed 
  44. to any number between 1 and 50 at any time after the database has been populated. 
  45. Note the 31st field if used has a hard coded standard size of 255 characters. 
  46. Field 31 is for a long text entry if desired.  The field names can also be changed 
  47. but whatever information appears in the text box to the right of the field name 
  48. will remain the same unless you update the records manually.  
  49.  
  50. The view data options allow you to run reports on the database using (rededit.exe) 
  51. or any viewer that you choose in the database setup and print them out or save 
  52. it as a separate text file if necessary. You may also use the rededit editor as a 
  53. stand alone program.
  54.  
  55.  
  56. < The Database Selection Screen >
  57.  
  58. Use this screen to select the database that you need to use by double clicking on 
  59. the database name or clicking on the select database button.  You also have the 
  60. option to Change Database setup or New Database Setup (see database setup).
  61.  
  62.  
  63. < The Database Search & Update screen >
  64.  
  65. This screen allows you to research and update the database information.
  66.  
  67.  
  68. < Database View Output screen >  
  69.  
  70. This screen is what you see when you choose to view contents of list button.  
  71. If you are using the rededit.exe as the viewer note the print and print setup 
  72. buttons.
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.                   --------  S E C T I O N    T W O   -----------
  80.  
  81.  
  82. < To find a specific record: >
  83.  
  84. Method One:
  85.  
  86. Once in the database search and update screen use the list to the left to 
  87. locate the listed data elements that pertain to the record that you want to 
  88. locate and click on the element that matches the record that you want to find.
  89.  
  90. Method Two: 
  91.  
  92. Click on a field that pertains to the data element that you want to look for 
  93. then click on the Display List by current active field button.  Then use method 
  94. one to locate the specific element that you are looking for.
  95.  
  96. Method Three:
  97.  
  98. Enter a line of text or a keyword to search for in the box below the List 
  99. entries using the below search string button and then press that button.  Use 
  100. methods one and two to refine your search.  Note: The highlighted list element 
  101. is placed in the search string box if you wish to single out one record.
  102.  
  103. Note: Selected Records in the list box display their contents to the right.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.                 --------  S E C T I O N    T H R E E   -----------
  110.  
  111.  
  112. < To Report on the database: >
  113.  
  114. Use methods listed above to display in the list the data elements you wish 
  115. to report on.  Once you have the records listed that you want o view click 
  116. on the View Contents of List button.   You will be presented with a list of 
  117. fields, turn on the fields that you wish to view in your report noting the 
  118. columns used indicator at the bottom and then click the View selected Fields 
  119. from List button.  This will present you with the view database output screen.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                  --------  S E C T I O N    F O U R   -----------
  126.  
  127.  
  128. < To add a database record: >
  129.  
  130. Click the clear fields to create new entry button. Input the required and 
  131. optional fields that need to be populated with the data that you wish to appear 
  132. in that record. Then click the Update database button.  Note that you have two 
  133. input screens containing up to 15 fields each.
  134.  
  135.  
  136. < To Update a database record: >
  137.  
  138. Select the record that you want to update using the search methods listed above 
  139. and click on its element in the list to display the records contents to the right.  
  140. Update the fields that need changing and then click the Update Database button 
  141. to finish.
  142.  
  143.  
  144. Note: Pressing the F1 key in a Field will give you a pick list of available options
  145. if they have been set in the database setup.
  146.  
  147.  
  148.  
  149.  
  150.  
  151.                   --------  S E C T I O N    F I V E   -----------
  152.  
  153.  
  154. < The Database Configuration Screen >
  155.  
  156. This screen allows you to design a database.  This utility will create the 
  157. database set file for you and populate its parameters. (See (.set) file contents 
  158. under the technical notes section.)
  159.  
  160. To create or modify a database:
  161.  
  162. If you are creating a new database you will need to provide a new set file name the name 
  163. must end with the extension ".set".
  164.  
  165. Once in the configuration screen:
  166.  
  167. You'll need to provide a database file name, title bar text, database name, the form
  168. names which will appear on the three buttons at the top of each form.  Also you will
  169. need to provide a log file name along with selecting the option to save changes to
  170. the log file if you wish.
  171.  
  172. Each field that you intend to use must have a name (example: UserID) if you wish
  173. to have a pick list (F1 Key) for that field then you must supply the list
  174. information separated by a pipe "|" symbol (example: UserID|Data Processor|Temp|Manager).
  175. Note that the item in the pick list will become the default for that field when
  176. it is initialized in the example just given the default for that field would
  177. be Data Processor. If the default is the word time or the word date then the
  178. field will be populated with the systems date or time. 
  179.  
  180. The field name length must be 20 characters or less if the field length is longer the
  181. software will strip off every character after character 20 and place them into the field 
  182. as the default field value.
  183.  
  184. Each field that you use must have its maximum size set and weather or not it is a required
  185. field. Required fields will prompt the user if the field is left blank for more input.
  186.  
  187. <Field auto formats>
  188.  
  189. Fields with the word "price" or "cost" in the field name will be saved as a dollar value
  190. (example: the user inputs 10 the field will be saved as $10.00)
  191.  
  192. Fields with the word "date" in the field name will be saved in this format (dd-mmm-yy)
  193. (example: the user inputs 6/18/96 the field will be saved as 18-Jun-96)
  194.  
  195. Fields with the word "time" in the field name will be saved in this format (hh:mm)
  196. (example: the user inputs 7:13pm the field will be saved as 19:13)
  197.  
  198. This helps keep records uniform so you can have easier searches.
  199.  
  200.  
  201.  
  202.  
  203.                   --------  S E C T I O N    S I X   -----------
  204.  
  205.  
  206. < Technical Notes and Other Features  >
  207. The (.SET) file contents:
  208.  
  209. Each database screen appearance is configured by the .set file located in the 
  210. same directory of the databank.exe file.
  211.  
  212. This configuration file defines the field size (two characters, 50 characters 
  213. max field size) ,Field Name (20 characters max) and then any pick list data separated by 
  214. a pipe "|" symbol. An equals sign (=) means that the field is optional and a (*) means 
  215. that the field is required and will prompt the user if they try to leave it blank.
  216.  
  217. Example:
  218.  
  219. dataline01*10User ID|Data Processor|Temp|Manager
  220. dataline02*02User Type
  221. dataline03*12User SSN
  222. dataline04*50Name (Last, First)
  223. dataline05=15NickName
  224. dataline06=00
  225. dataline07*02Status Code|01|17|08|09|99
  226. dataline08*09Date Started
  227. dataline09=09Creation Date|date
  228. dataline10=09Date Ended
  229. dataline11=00
  230. dataline12=00
  231. ...
  232. dataline30=50Other
  233.  
  234. < Other configuration elements: >
  235.  
  236. titlebar=User Database
  237. form1=conventional
  238. form2=electronic
  239. form3=notes
  240. log=on
  241. dbfile=contacts.db
  242. dbname=Contacts
  243. logfile=contacts.log
  244. textfield1=Notes
  245.  
  246. Log File:
  247. ╖ The log=on option turns on update logging.  This feature stores all changes 
  248.   and entries to the database in the databank.log file.  This file is a pipe 
  249.   delimited text file that can be imported into software packages (text editors,
  250.   spread sheets and databases for reporting and research purposes.  You can use 
  251.   this log file to track the history of a record.
  252.  
  253. ╖ logfile= this is the name of the databases log file.
  254.  
  255. Other Options:
  256. ╖ titlebar= is to set the text in the application titlebar.
  257.  
  258. ╖ form1= & form2=  & form3= sets the text in the two buttons that toggle the 
  259.   forms (Form 1&2 contain up to 15 fields each, form 3 is the long text field). 
  260.   If the syntax form1=off this will disable the form).
  261.  
  262. ╖ dbfile= this is the name of the database file.
  263.  
  264. ╖ dbname= this is the text that you want to appear in the database select screen.
  265.  
  266. ╖ textfiled1= this is the title of the 255 character text field in form 3.
  267.  
  268.  
  269.  
  270.                 --------  S E C T I O N    S E V E N   -----------
  271.  
  272. < Report Files: >
  273.  
  274. When you select view database contents this utility will create a file called 
  275. databank.txt. This file is then passed to an external program like rededit.exe or 
  276. whatever viewer you specify in the database setup file for display.  This viewer 
  277. may be changed in the database setup screen.   Come spread sheet programs require
  278. you to highlight the imported columns and select text to columns type option. 
  279. Then you must select the delimited option and use the Pipe ô|ö symbol as the field 
  280. separator.
  281.  
  282. < REDEDIT.EXE >
  283.  
  284. This is the text viewer and editor used by the universal Database tool.  This 
  285. file also requires the commdlg.dll file to run.
  286.  
  287. To wipe out the database and start with a new one:
  288.  
  289. Delete the database file in the directory of the database you want to kill. This
  290. file name is specified in that databases setup.  If you wish to remove the entire 
  291. database and its configuration then you will need to also delete the databases
  292. associated set file.
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.