home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / BF / BF174.ZIP / AUCTION.DOC < prev    next >
Text File  |  1992-02-07  |  19KB  |  481 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                      Auction Entry Report Generator
  8.  
  9.                                Documention
  10.  
  11.  
  12.                            CopyRight (c) 1991
  13.                            All Rights Reserved
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                 Programed
  26.                                    and
  27.                                 Written 
  28.                                    by 
  29.                               Lavern Smith
  30.                              38 Stacey Drive
  31.                              Alabaster, Al.
  32.                                   35007
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                           Documention Directory
  57.  
  58.  
  59. Description                                                     Page
  60.  
  61. License agreement ...............................................1      
  62. Database's Description and Program setup ........................2
  63. Hot Key Tutoral .................................................5   
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.                          Warranties and License
  113.  
  114.  
  115. There are no warranties with this license or program.  This program is
  116. let out on license and remains the sole property of Lavern Smith.  You
  117. as a licensee do not have the right to sell, trade, bargin or lend to
  118. another this property that is licensed to you.  At no time shall this
  119. program be used on more than one computer per licensee, per site without
  120. the written consent of the owner.  I shall not and will not be held
  121. liable for any damages to any computer system, or for any mistakes
  122. entered into the databases created by this program.  Any failure to
  123. comply with this agreement could result in losing site license and
  124. possible prosecution by the owner of this program.
  125.  
  126. This program will conform to the published specification and to the
  127. documentation, provided that it is used on a computer hardware and with
  128. the operating system for which it was designed.  Because programs are
  129. inherently complex and may not be completely free of errors, you are
  130. advised to validate your work.  In no event will I be liable for direct,
  131. indirect, special, incidental, or consequential damages arising out of
  132. the use of or the inability to use the program or documentation.
  133.  
  134. The Warranty and License agreement set forth above are exclusive and in lieu of all
  135. others, oral or written, express or implied.
  136.  
  137.  
  138. This program can be used in an auction to keep a record of all the
  139. buyers and sellers information and generate reports from that
  140. information.  It also keeps information on the tax percentage at your
  141. location and holds the auction or house commission percentage along with
  142. the auctioneer's commission, if any.
  143.  
  144. This program has been tested in an actual running auction to test the
  145. data file integerty and it's ability to handle speed and accuracy of
  146. reports generated by the program and has been found to be accurate with
  147. the data in which it handled and with the hardcopy that was produced
  148. from that data.
  149.  
  150.  
  151. Program requirements:
  152.  
  153. DOS 3.0 or higher
  154.  
  155. Will run on disk drive system   "alot slower and disk fills up fast"     
  156.  
  157. A lot better on a hard drive system  "because of increased speed and
  158. more                                       disk space"
  159.  
  160. 286 computer system  "althought would run slower on an XT"
  161.  
  162. A high speed DMP printer with a large buffer   "IBM Compatiable"
  163. and continuous computer paper
  164.  
  165.  
  166. I will try to give a complete tutoral on the operation of running this
  167. program from the very start to the finish.  So lets get started.
  168.  
  169. First of all a little infomation on what the program databases do.  The
  170. first database is called "auction.dat".  This database holds programs
  171. information, such as sales tax percentage, auction or house commission
  172. and auctioneer's commission.  Lets stop here and look at auctioneer's
  173. commission.  In all the auctions that I have been to, the auctioneer's
  174. commission is taken out of the house commission, so thats the way its
  175. done here, even though in the program it is taken from the total sells
  176. it still comes from the house commission.  Next we have a database that
  177. will hold all of the auctions daily information and its name will change
  178. daily, because the name is derived from the date function.  Because its
  179. name changes daily I have decided to use the computers date that you
  180. will enter in a special routine to start the program database up.  So it
  181. is very important that you enter the correct date into your system at
  182. the start of running this program, so you will not add to an already
  183. exsisting database.  The database's name will look something like this
  184. name "103191.dat" when you do DIR search on your directory.  The next
  185. database's name is derived from daily database's name.  In short
  186. "1091.dat", it is created at the end of the auction when you run the
  187. house report.  If this is not the first time you use this program in
  188. this month it will then add to it.  In other words it will keep up with
  189. the monthly activity of the auction.  The last database will hold all of
  190. the information for the auction's expense's for that month, it's name
  191. will look something like "1091.exp".  In short we now have four
  192. database's.
  193.  
  194. AUCTION.DAT   "program database"
  195. 103191.DAT    "example of an daily database"
  196. 1091.DAT      "example of monthly database"
  197. 1091.EXP      "example of monthly expense database"
  198.  
  199.  
  200. All these database's are kelp in the same directoryas the program is in,
  201. so for this reason alone it is best to have a hard drive system.
  202.  
  203. Now with this behind us we can get into how the program operates. 
  204.  
  205.  
  206.  
  207.              
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216. Things to do first.
  217.  
  218. First turn on the computer system and the printer.  Make sure the
  219. printer is on line.  Now we can load the program.  At the DOS prompt
  220. type "AUCTION" and press enter.  What'a you know it is up and running.
  221. Now we can get down to the business at hand.  The screen that you see is
  222. a full working calander.  First you have initsuate the daily database
  223. your asked if the date is correct or not.  Hilite the date that is
  224. correct press Enter.  At this point you will be brought back into the
  225. program ready for the work at hand.  If you need to load an old auction
  226. date use the correct keys to find the month or day of the auction you
  227. want hilite the day and press enter.
  228.  
  229. Now lets take a look at the screen.  You will see at the top of the
  230. screen 
  231.  
  232.  
  233. Sellers number            
  234. Description                                                            
  235. Price                                     
  236. Quantity                
  237. Buyer                     
  238.  
  239.  
  240. The screen at first might not look just like this, but the shadow area
  241. is where you will be entering the auction database information.  Here
  242. again at all the auctions I've been to all the Sellers and all the
  243. buyers have a number.  In a few cases a buyer will not have a number and
  244. will pay cash, but more on that a little later.  The Sellers field is 4
  245. wide, up to 4 numbers can be entered.  Example "1234".  Letters also if
  246. you so choose.
  247.  
  248. Next Description, this field is 20 wide, in other words you can enter up
  249. to 20 characters in this description field.  Again any character will
  250. go.  
  251. Next Price, this field is only 11 wide. In it you can only enter numbers
  252. or " . " decimal.  
  253.  
  254. Next Quantity, this field is only 4 wide and will take numbers only.
  255.  
  256. Next Buyer, this field is only 4 wide.  Enter the Buyers number here. 
  257. Example "1234", it will except letters also if you choose.
  258.  
  259. These five fields are the heart of the program.  This is where you will
  260. make this program work or not work.  So make sure that the information
  261. that you enter is correct to start with for a better performing program
  262. operation.  But don't worry if you do enter mistake you can correct it. 
  263. More on this as we go thru this program. 
  264.  
  265. Now look at the line that say "Record no.  0".  This is correct for the
  266. first time that you run the program with a new database.  This is
  267. letting you know what record number is up for input.  The next thing on
  268. this same line is the date and time.  Next line you will see "Tax
  269. percentage .00" this is what the taxes are at your location. Next you
  270. you see "House Commission .00", this is the commission that the house
  271. collects off the sellers.  Next you see "Auctioneer Commission .00",
  272. this is the commission that the auctioneer get for his job.  Now at this
  273. point if the tax percentage, House Commission or the Auctioneer's
  274. Commission any or all are wrong can be changed by pressing ALT-F7 at the
  275. same time.  At this point the screen will clear and you will enter the
  276. correct tax percentage.  Example ".06" for 6% sales tax.
  277.  
  278. The screen is cleared again and ask for the House Commission. Example
  279. ".15" for 15% commission on the total sales.
  280.  
  281. The screen will clear again and the ask you for the Auctioneer's
  282. Commission.  Let me explain how this works.  First of all normaly, the
  283. Auctioneer's Commission is taken from the House Commission and that is
  284. the way it works here, but is calulated from the total sales for better
  285. operation of the program.  Example if the House Commission is 15% and
  286. the Auctioneer get 1/3 of that, which is normal, then the Auctioneer's
  287. Commission will then be ".05" which will be 1/3 of the House Commission. 
  288. If the Auctioneer does not get a commission then you enter "0" for no
  289. commission.  To this routine there is a check in the program to make
  290. sure that you do not enter an amount more than the House commssion. 
  291. Because the Auctioneers Commission is taken out of the House Commission
  292. we do not want the House to lose any money. 
  293.  
  294. Now some times the total sales will be a low total sales for that day
  295. and the auctioneer will require a minimum fee and if so you would enter
  296. it in the next question.  Lets say that the Auctioneer requires a
  297. mimimim of $15.00 then you would enter "15.00".
  298.  
  299. Now a word of caution, the last four routines alone with most of the
  300. routines in the program do not have any error checking on them so for
  301. this make sure that you enter the correct information that you need. 
  302.  
  303. The middle half of the screen is showing some of the fuction keys that
  304. help run the program.  There are more, if at any time you need to see
  305. them while in this screen you may press the "F1" fuction key to see a
  306. list of them and press any key to return back to the main screen.  These
  307. Function keys are the Heart to running the routines behind the program. 
  308. I decided to use "Hot Keys" in the operation of the program than to use
  309. a menu, because hot keys are faster than a menu and that is one of the
  310. things we need is speed to make this program work well. 
  311.  
  312.  
  313.  
  314.  
  315. Now the the last half of the screen is setup to show some of the records
  316. in the database for that day.  For a first time run you will not have
  317. anything in the database.  As the database grows this part of the screen
  318. will fill up.  The first item label is "Record", this is what record
  319. number the information to the left of it is.  Example
  320.  
  321. Record   Seller      Description           Price      Quanitity   Buyer  
  322.   1       200       CHAIR                   3.25           4       125
  323.  
  324. The above is an example of what one record will look like.  There will
  325. be a maximun of 6 on the screen.  As the database grows the records will
  326. scroll in the window and leave the top 6 records up.  The purpose of
  327. this is so you may look at what you have just entered and help you to
  328. see any errors that might have occured.  
  329.  
  330.  
  331.  
  332. KEYS
  333. Now let's look at the HotKeys before we run the program.  Heres what the
  334. help screen looks like.  Look at the center of the scrren to the fuction
  335. key there and you will see F1 - More help on keys
  336.  
  337.  
  338. ESC - Exit from program
  339. F2 - Gets a selected record to edit
  340. F4 - Prints an Auction Invoice Report
  341. F6 - Print a Buyers Report
  342. F7 - Prints Sellers Report                                              
  343. F8 - Prints to the screen the data file
  344. F9 - Saves screen to file
  345. ALT-F1   Prints report for buyers that have not paid
  346. ALT-F3   Clears all flags for a selected record
  347. ALT-F4   Clears all buyers paid flags for all records
  348. ALT-F5   Clears a selected buyers paid flags
  349. ALT-F6   Enter Monthly Expense items
  350. ALT-F7   Enter Tax percentage-House Commission--Auctioneers's Commission
  351. Alt-F8   Print Monthly Report
  352. Alt-F9   Start a new selected Record
  353. ALT-D    Deletes a selected Record
  354. ALT-T    Prints a Buyer Report for Buyers with a Tax number
  355.  
  356.  
  357.  
  358. Once in any of these routines Please do not press any key other than
  359. what you are requested to enter.  Some of these routines read and
  360. rewrite the database.  If for some reason something does go wrong and
  361. the flags in the database are massed up you can press ALT-F4 to clear
  362. all flags.
  363.  
  364.  
  365. Esc
  366.      The Esc key is for exiting form the program back to the DOS prompt.
  367. F2
  368.      This Hot Key is used to recall a record number that is attached to
  369. the information that is in the database.  If at anytime you do recall a
  370. record, make changes if necessary, then you must press F9 to update this
  371. record before yu can contuine.
  372. F4
  373.      This Hot Key is used to print a report at the end of an Auction. 
  374. This report is called the House Report.  You will press N for the very
  375. first time that you run this report using this date.
  376.  You press Y only if this is an updated report, only if this is not the
  377. first time that you have run this report.
  378. F6
  379.      This Hot Key is used to print a report for a selected buyer.  Use
  380. this key when a buyer is finished buying and wants to leave.
  381. F7
  382.      This Hot Key prints a report for a seller at the end of the Auction
  383. day.  This Hot Key does two things, first it will check to see if the
  384. seller bought anything under his(her) number.If he(she) did buy anything
  385. it will generate a buyers report, if nothing was bought it will not
  386. produce a buyers report.  Second it will generate a Sellers report for
  387. the items that was sold.  If a buyers report was generated first it will
  388. then at the end of the sellers report make the necessary calulations for
  389. sellers total profit for his(her) sell.
  390. F8
  391.      This Hot Key is used to view all the records in the auction
  392. database.  At the end of its screen you are asked to contuine or not. 
  393. Press Y or N.  The purpose of this routine is so you may view all of the
  394. records in the database for mistakes or to see if any changes are
  395. needed.
  396. F9 
  397.      Use this Hot Key to save what has been entered into the entry
  398. fields.  This Hot Key has two functions.  First it saves what you have
  399. entered in the fields, next it is used to update a record that is
  400. recalled by using the F2 Hot Key.
  401. ALT-F1
  402.      Sometimes you will have a buyer that will leave the auction without
  403. paying for his(her) merchandise.  This routine will print a report for
  404. all those people, giving totals for all that they bought.
  405.  
  406. Now for a little explaination of what happens in a database will help
  407. you understand the next three Hot Keys.  Everytime a buyer pays,
  408. his(her) records are flaged in the database as such.  For this reason if
  409. a buyer pays out you cannot get another report for this buyer until you
  410. clear his(her) flags.
  411. ALT-F3
  412.      This routine will clear all flags for a selected buyer record. 
  413. Sometimes you only need to clear flags for just one record.
  414. ALT-f4
  415.      This routine will clear all flags in all records for all buyers,
  416. except for cash payers.  Use this routine with caution.  Sometimes you
  417. will need this, lets say for an example you were printing a buyer report
  418. and the lights went out for a moment and the computer went out, you
  419. forgot where you were in the reports and needed to start all over with 
  420. the reports.  This routine would be good in this situation.
  421.  
  422. ALT-F5
  423.      Lets say that a buyer has paid out and a little later that buyer
  424. comes back and want an item or two taken off his receipt.  Can you do
  425. this?  The answer is yes with this Hot Key.  On the buyers report the
  426. first item is record.  This is for your information, it tells you what
  427. record number each item is in.  You can act accordingly to what needs to
  428. be done at this point.  If that item really belongs to another buyer you
  429. would press F2 to get the record and make the changes, then F9 to save
  430. the changes, if the buyer wants these items removed from his(her) ticket
  431. then you would need to delete this record.  To do this you would press
  432. ALT-D and reply with the right buyer number.
  433.  
  434. ALT-F6
  435.      This routine is for the House information.  You would use this
  436. routine at some free time to enter items of expense that the House
  437. needs.  In other words House Expenses.
  438.  
  439. ALT-F7
  440.      This routine will be used at the start of the Auction to enter
  441. sales taxes, House Commission, Auctioneers Commission, and the mimium
  442. fee that the Auctioneer get if the total sales does not reach a preset
  443. mimium.
  444.  
  445. ALT-F8
  446.      This routine will be used in some free time to print a monthly
  447. report for tax purposes.  If at this time you have monthly expense items
  448. and have not entered them yet, you need to press ALT-F6 and make the
  449. necessary entries before you run this report.  This routine will run a
  450. monthly report for that same month you entered in the start of the
  451. program are if ALT-F9 is used.
  452.  
  453. ALT-F9
  454.      This routine will start a new or an old database accordingly to
  455. what you need to do.  This is the same routine that you see when you
  456. first start this program up.  If you are already in the program and lets
  457. say that a buyer that has not paid at a previous date comes in and needs
  458. to settle up, you can press ALT-F9 press ALT-F1 for a list of auction
  459. dates, enter the correct date and the program will reload the database
  460. for that date that you just enter, if it is in the directory.  At this
  461. point you would press F6 for a buyers report, collect the money, then
  462. you will need to rerun the House Report for that database to update the
  463. monthly database and press Y to the question is this an update report or
  464. not.  This will then update the monthly database instead of adding to
  465. it.  Then when and only when you have done this you would press ALT-F9
  466. to reenter the correct date for the Auction at hand.  
  467.  
  468. The condition that you just read should be done when you have a little
  469. free time to do such.  It would take about 3 to 5 minutes to run
  470. according to the situation at hand.
  471.  
  472. ALT-D
  473.      This routine will not actually erase the record but will erase all
  474. the information in that record that you choose.
  475.  
  476. ALT-T
  477.      This routine should be run after the Auction is over and you have
  478. run all the buyers reports and sellers reports.  You would use this
  479. routine to get special report for all buyers that have a tax number.  It
  480. will give a report for each buyer that has a tax number one at a time
  481. and giving totals for each.