home *** CD-ROM | disk | FTP | other *** search
/ Vectronix 2 / VECTRONIX2.iso / FILES_01 / COSTAREG.ZIP / COSTA / COSTA.TXT < prev    next >
Text File  |  1996-04-27  |  20KB  |  534 lines

  1.                           CoSTa Manual
  2.                           Version 1.40
  3.                     (c)1995,96 Gary A. Priest
  4.  
  5. Contents
  6.         Introduction                            2
  7.         Getting Started                         2
  8.         Setting Up CoSTa                        2
  9.         Paths                                   3
  10.         Preferences                             3
  11.         Duration Offsets                        4
  12.         Costs                                   5
  13.         Main Window                             6
  14.                 Include Paid Calls              6
  15.                 Show Costs Including VAT        6       
  16.         Filter Calls                            7       
  17.         Extracting Call Information             7
  18.         Editing/Deleting a Call                 8
  19.         Paying Bills                            9
  20.         Output                                  9
  21.         Recost Unpaid Calls                     9
  22.         Purging Old Call/Bill Details           9
  23.         Registering                            10
  24.         Disclaimer                             10
  25.         Credits                                10
  26.  
  27.  
  28.  
  29.                           Introduction
  30.                           ------------
  31. CoSTa  was written almost as soon as I got myself a modem and
  32. got on-line to the internet.
  33. I immediately realised that there was no way of knowing how much
  34. time I spend on line and hence have no idea of what my telephone
  35. bill is going to be.
  36. Using CoSTa this problem is solved.
  37. Each time you connect to the internet using the supported
  38. programs a log file is created/appended with the current start
  39. date and time, plus an awful lot of other information. This file
  40. quickly becomes very large, with no apparent use. Until now!!
  41. CoSTa runs over this log file and extracts all the information
  42. it requires about each call made, it then calculates the length
  43. of the call and the cost.
  44. Each call can easily be seen in the main window, along with a
  45. current phone bill total.
  46. When the phone bill arrives, you can tell CoSTa to flag all
  47. calls up to the date of the bill as paid, the current total is
  48. reset and ready for your next month's/quarter's phone calls.
  49.  
  50. CoSTa currently works in conjunction with Atari NOS, ICE,
  51. MiNTnet, CoNnect, and CixComm.
  52.  
  53. Hardware required
  54. -----------------
  55. This program should run on all TOS based computers from an ST
  56. to a Falcon.  It was developed on a Falcon and hence looks
  57. best running on this machine.
  58.  
  59.                          Getting Started
  60.                          ---------------
  61. Installing CoSTa
  62. ----------------
  63. CoSTa is installed and run like any other normal Gem Application.
  64. It does not run as an accessory.
  65.  
  66. On-Line Help
  67. ------------
  68. CoSTa comes complete with it's own on-line help system.
  69. Position the mouse cursor over whichever window help is required
  70. on and press Help.
  71.  
  72.                         Setting Up CoSTa
  73.                         ----------------
  74. After installing CoSTa, it is necessary to set up certain
  75. information for CoSTa to function correctly.
  76. BEFORE performing an extract, the costs, paths and preferences
  77. must be configured in order that the program knows where to find
  78. the log files, and how much a call is going to cost.
  79. See the relevant sections in this manual on how to do this.
  80. CoSTa comes with the costs for a British Telecom local call
  81. already set up.
  82.  
  83.  
  84.                               Paths
  85.                               -----
  86. CoSTa currently works with the log files created by NOS, ICE,
  87. MiNTnet, CoNnect, and CixComm.
  88.  
  89. It is important to tell CoSTa where to find the log files.
  90. Click on either the text or on the path beside it. Use the file
  91. selector to locate the relevant log files, that you use.
  92. Click on the check box beside the path to tell CoSTa that this
  93. file is to be used during extraction.
  94.  
  95. The log files are normally named as follows:
  96. NOS     -  NOS.LOG
  97. ICE     -  ICE.LOG
  98. MiNTnet -  messages
  99. Connect -  CONNECT.LOG
  100. CixComm -  CIXCOMM.LOG
  101.  
  102.                            Preferences
  103.                            -----------
  104. Backup NOS Log File To History
  105. ------------------------------
  106. After CoSTa has extracted call details from the NOS.LOG file,
  107. this file is renamed to NOS.HST to prevent further processing.
  108. N.B. this only applies to NOS because the log file contains
  109. vast amounts of information and quickly becomes very large.
  110. All other log files are processed using a timestamp
  111. (see Timestamp in the Extracting Calls section).
  112.  
  113. This can happen in two ways (which option you choose depends on
  114. whether you feel the need to keep a history or not):
  115.  
  116. Append
  117. ------
  118. The contents of the current .LOG file are appended on to the end
  119. of any existing .HST, hence it can get very large but does contain
  120. ALL details.
  121. This file should be deleted/archived on a regular basis.
  122.  
  123. Overwrite
  124. ---------
  125. Any existing .HST file is deleted, and the current .LOG file is
  126. renamed to .HST.
  127. This keeps the size of the .HST down, but of course, all details
  128. prior to the last extraction are lost.
  129.  
  130.  
  131. Auto Extract on Startup
  132. -----------------------
  133. If this option is set to 'Yes', then CoSTa will automatically
  134. perform an extraction whenever it is called ie. on program
  135. startup.
  136. This makes the process of call extraction completely transparent
  137. to the user. Simply run CoSTa and it will automatically know
  138. about all your calls.
  139.  
  140.  
  141. GMT Adjustment
  142. --------------
  143. This applies only for extractions from NOS and ICE.
  144.  
  145. All times written to NOS.LOG and ICE.LOG are in Greenwich Mean
  146. Time.  This obviously causes a problem if your local time zone
  147. is not GMT, as your telephone company costs calls based on your
  148. local time.
  149. CoSTa needs to know how to convert the GMT times into local ones.
  150. The Time Adjustment field can contain a number of hours between
  151. 0 and 23. The sign is set by selecting the relevant box beside it.
  152. Hence, if your local time zone is 1 hour ahead of GMT
  153. (British Summer Time or France, for example) set this field to 1+.
  154. Now CoSTa will convert the GMT date/time into local and your call
  155. will be costed correctly.
  156.  
  157.  
  158. Show Costs Including VAT
  159. ------------------------
  160. This sets the default display of costs to either include VAT or
  161. exclude it.
  162. This can be overriden from the menu option.
  163.  
  164.  
  165.                         Duration Offsets
  166.                         ----------------
  167. Most log files do not accurately record a call duration.
  168. They miss out the modem negotiation time which means the call
  169. tends to be 10-20 seconds shorter in CoSTa than appears on the
  170. bill.
  171.  
  172. This window allows you to define a number of seconds that will be
  173. added or subtracted to the length of each call when recorded in
  174. CoSTa, thus making CoSTa more accurate.
  175.  
  176. The actual number of seconds can be determined by comparing
  177. several telephone bill entries with the corresponding entries
  178. logged in CoSTa and using the average difference, so that
  179. subsequent calls will be logged more accurately.
  180.  
  181. All of the supported communications software has differing
  182. degrees of accuracy hence it may be necessary to 'adjust' NOS
  183. calls by a different number of seconds from ICE calls etc.
  184.  
  185.  
  186.                               Costs
  187.                               -----
  188. When CoSTa extracts call details, it costs the call.  To achieve
  189. this it must know how much a telephone call costs. British Telecom
  190. currently have different costs for local, regional and national
  191. calls.  Earlier versions of CoSTa did not support this. Until Now.
  192. CoSTa will cost a call by using the telephone number, thus calls
  193. to different costing regions are fully supported, as are calls
  194. to 0891 numbers etc.
  195.  
  196. CoSTa currently costs calls in the same manner as British Telecom.
  197. ie. it calculates using the cost per minute, to the nearest second.
  198. Therefore if the call is 2minutes 30seconds, the call is NOT
  199. rounded up to 3minutes.
  200. Costs are held in pence and to 3 decimal places.
  201.  
  202. Peak Hours
  203. ----------
  204. Most telephone companies charge at a higher rate during 'their'
  205. peak hours.  British Telecom's peak hours are 08:00:00 to 18:00:00.
  206. Other telephone companies' hours may differ.  Enter the hours 
  207. applicable here.
  208.  
  209. VAT Rate
  210. --------
  211. If costs are set up as excluding VAT, then the current VAT rate
  212. should be set up here.
  213. It is recommended that this facility is used and all costs are
  214. keyed in excluding VAT.
  215.  
  216. Minimum Cost
  217. ------------
  218. Although British Telecom now charge by the second, the still
  219. impose a minimum cost to each call. ie. if the cost of your call
  220. is below this minimum then it is rounded up to the minimum.
  221. This is currently approximately 5 pence. Therefore every call you
  222. make will cost at least 5 pence.
  223. This is the minimum cost of a telephone call.
  224.  
  225. List of Telephone Numbers
  226. -------------------------
  227. A list of telephone numbers and associated costs can be maintained
  228. here.
  229. It is NOT necessary to define every number used, as CoSTa uses a
  230. default which will be used if the telephone number is not found
  231. in the list. The default supplied with CoSTa is for a local BT
  232. call exc. VAT.
  233.  
  234. The default is indicated by having a telephone number of '*'.
  235.  
  236. Other telephone numbers can be maintained, such as BBS's etc.
  237.  
  238. CoSTa only uses the default it the actual telephone number cannot
  239. be found.
  240.  
  241. Entries can be added, deleted and edited by double clicking or
  242. clicking on Edit.
  243.  
  244. The default '*' cannot be deleted.
  245.  
  246. MiNTnet
  247. Extraction of MiNTnet calls will always use the default cost.
  248. This is because MiNTnet does not make the telephone number
  249. available in it's log file, so CoSTa doesn't know the number.
  250.  
  251. CixComm
  252. The CixComm log does not include any Mercury or ACC access codes
  253. in the log. Only the Cix telephone number is recorded.
  254. Thus ensure that you exclude these access codes from the
  255. telephone number defined to CoSTa.
  256.  
  257. Adding/Editing an Entry
  258. -----------------------
  259. Each entry has the following fields:
  260.  
  261. Telephone Number
  262. ----------------
  263. This should be '*' for the default costs, but can be any telephone
  264. number for specific costs.
  265. Blanks do not matter as CoSTa strips them out during use.
  266. Thus 01234 5678 is the same as 012345678.
  267.  
  268. Description
  269. -----------
  270. The description of the phone number. ie. Fred's BBS.
  271.  
  272. Peak Cost
  273. ---------
  274. This is the cost per minute of a telephone call during the
  275. above peak hours.
  276.  
  277. Offpeak Cost
  278. ------------
  279. This is the cost per minute of a telephone call outside of the
  280. peak hours.
  281.  
  282. Weekend Cost
  283. ------------
  284. Peak/Offpeak hours normally only apply Monday to Friday. Weekend
  285. rates then apply from midnight Friday to midnight Sunday.
  286. This is the cost per minute of a telephone call at the weekend.
  287.  
  288.  
  289.                            Main Window
  290.                            -----------
  291. The main window display lists all calls known to CoSTa.
  292. The day, date, time, duration, cost, telephone number and origin
  293. of each call is displayed, along with a flag to indicate if the
  294. call has been paid for.
  295. At the bottom of the window are totals. These are the total
  296. number of calls, total length of time and the total cost in
  297. pounds.
  298.  
  299. Include Paid Calls
  300. ------------------
  301. The display will either list all calls known to CoSTa, or will
  302. just display current unpaid calls.
  303. This can be changed by use of the 'Include Paid Calls' menu
  304. option.
  305. The default is to only show current unpaid calls.
  306.  
  307. Show Costs Including VAT
  308. ------------------------
  309. The display will show all costs with or without VAT applied.
  310. This only makes a difference if a VAT rate is defined within the
  311. COSTS window. The default is set in the Preferences window.
  312.  
  313.  
  314.                           Filter Calls
  315.                           ------------
  316. The filter allows you to only display calls that match specific
  317. criteria. ie. you can see just the calls made via CoNnect, or
  318. just calls over 10p made with ICE etc, etc.
  319.  
  320. The filter works in conjunction with the 'Include Paid Calls'
  321. menu setting and the 'Show VAT' setting.
  322.  
  323. The filter also determines which calls are output via the 'Output'
  324. menu option.
  325.  
  326. It does NOT affect which calls are flagged as paid via the
  327. 'Pay Bill' function.
  328.  
  329. If the filter is active then a check mark appears against the
  330. 'Filter Calls' menu option.
  331.  
  332.  
  333.                         Extracting Calls
  334.                         ----------------
  335. For CoSTa to be able to display call details, it is necessary to
  336. tell it to extract the information from the relevant log files.
  337. This should only be performed after preferences and cost details
  338. have been maintained and is achieved by selecting 'Extract' from
  339. the menu.
  340.  
  341. CoSTa processes the log files, extracts call details and costs them,
  342. and stores each call in CALLS.DTA.
  343. The log file is then backed up in the manner chosen in Preferences
  344. or a timestamp file created.
  345.  
  346. NOS Specific Problems
  347. ---------------------
  348. Unfortunately NOS does not output actual
  349. 'connection made'/'connection stopped' messages and as such this
  350. causes the following problems in calculating the length of a call:
  351. a) CoSTa has to approximate the connection start time, by scanning
  352. the log file for a specific string that will only occur after a
  353. connection has been made. Start times may be a second or two out,
  354. but at least it does handle number busy and redials correctly.
  355. b) CoSTa also has to approximate the end time. It looks for the
  356. 'NOS stopped' message in the log file.
  357. Thus it is essential that after you have ended the connection with
  358. 'ppp sl0 lcp close', you immediately exit NOS by typing 'exit'.
  359.  
  360. MiNTnet Specific Problems
  361. -------------------------
  362. MiNTnet does not put the telephone number into the log file.
  363. Thus CoSTa puts blanks into it's database and uses the 'default'
  364. costs entry to cost the call.
  365.  
  366. Timestamps
  367. ----------
  368. All log files except the one created by NOS are either relatively
  369. small containing only basic information or in the case of CoNnect
  370. and CixComm they are actually used for later analysis and thus
  371. should not be renamed/deleted.
  372.  
  373. The way CoSTa gets around this problem is by keeping a note of the
  374. date/time of the last call it has extracted. Then when extraction
  375. is performed again, only calls after the stored date are processed. 
  376. These date/time's are stored in files called COSTA.???
  377. (where ??? is MNT for MiNTnet, ICE for ICE etc.) and should not
  378. be deleted.
  379.  
  380. The log files should be cleared down/backed up manually on a
  381. regular basis, to keep the size down.
  382. It is important to note that CixComm uses it's log file to
  383. calculate Cix charges, thus any archiving should be done with
  384. careful consideration.
  385.  
  386.  
  387.                      Editing/Deleting a Call
  388.                      -----------------------
  389. Occasionally it might be necessary to edit or delete details of
  390. a particular call.  One reason for this is that your Atari's
  391. clock was wrong when you logged onto the internet, and hence the
  392. date or time of the call once extracted into CoSTa is wrong,
  393. which could in turn lead to the call being costed incorrectly.
  394.  
  395. To edit a call, simply double click on it from the main window
  396. with the left mouse button, and the edit window will be
  397. displayed.
  398.  
  399. You can amend the date, time, duration, cost, and telephone number.
  400. The only item you cannot amend is the origin of the call ie.
  401. NOS or ICE.
  402.  
  403. You can also override a particular day/time to be Peak, Offpeak,
  404. or Weekend.
  405. This is useful because some telephone companies treat Bank Holidays
  406. as a Weekend rate.  CoSTa does not know about Bank Holidays and
  407. thus would treat a Monday as a Weekday(peak or offpeak).
  408. To correct this, edit each call and override it to Weekend.
  409. The cost is automatically recalculated for you.
  410.  
  411. Re-cost
  412. -------
  413. If you change the date or time of the call, it could well fall
  414. into a different cost category ie. if you change the time peak
  415. to off-peak, or the date from midweek to weekend.
  416. You can either manually alter the cost or you can have CoSTa
  417. re-cost the call for you using the new date time, and duration.
  418. If you would like CoSTa to re-cost the call, it is important to
  419. click on 'Recost' BEFORE clicking on 'Ok' to update the call
  420. details.
  421. Note: The cost here is excluding VAT (regardless of the display
  422. setting).
  423.  
  424. Delete
  425. ------
  426. To actually delete this call, click on 'Delete'.
  427.  
  428.  
  429.                          Paying The Bill
  430.                          ---------------
  431. When the telephone bill arrives, you need to flag all the calls
  432. up to the date of the bill as paid.
  433. In this way they will then be excluded from the current unpaid
  434. totals.
  435.  
  436. Select 'Pay Bill' from the main menu and you will be presented
  437. with the 'Pay Bill' window.
  438. This window displays a history of all previous paid bills and
  439. their totals, as well as allowing you to pay a new bill.
  440.  
  441. Enter the date of the bill, and all calls up to and including
  442. that date will be flagged as paid.
  443.  
  444. The totals paid will then be added to a list of previous paid
  445. bills. This list is displayed in this window and shows date of
  446. bill, total number of calls, total time, and total cost.
  447. The list allows a history of paid bills to be examined at a
  448. glance.
  449.  
  450.  
  451.                              Output
  452.                              ------
  453. It is possible to output a list of calls and the totals to either
  454. a printer or the clipboard.
  455. Either all calls can be listed or just the unpaid ones.
  456.  
  457.  
  458.                        Recost Unpaid Calls
  459.                        -------------------
  460. This option processes all 'Unpaid' calls and recalculates their
  461. costs. This could be useful if you need to change cost details
  462. (or if upgrading from a previous CoSTa version that didn't
  463. support VAT).
  464.  
  465.                      Purging Old Calls/Bills
  466.                      -----------------------
  467. After a while, the number of calls/bills will start to grow,
  468. and it may be a good idea to get rid of very old calls/bill
  469. details that are of no further use. This will help keep CoSTa
  470. performing at maximum speed also, because the more call
  471. details stored, the more work it has to do.
  472.  
  473. Only calls that have been flagged as 'Paid' are eligible for
  474. purging. 
  475.  
  476. Select 'Purge Calls' from the 'File' menu, to display the 'Purge'
  477. window.
  478.  
  479. A date must be entered, up to and including which all 'Paid'
  480. calls will be deleted. 
  481.  
  482. To delete old 'Bill' details (as shown in the Pay Bill window),
  483. it is also necessary to click on the 'Bills Too' radio button.
  484. Bill details will probably want to be purged much less
  485. frequently than Call details, as Bill details are a nice history
  486. log of your internet usage.
  487.  
  488. It is IMPORTANT to note that once call or bill details have been
  489. Purged, they are gone for good. The only way to undo a Purge is
  490. to go back to a backup.
  491.  
  492.  
  493. Registering
  494. -----------
  495. CoSTa is a Shareware product. If you use it regularly you should
  496. do the right thing and register it.
  497. Registration costs 6 UK Pounds and includes the following
  498. benefits:
  499.  
  500. a) A unique key to enter into CoSTa.  Future versions will have
  501.    increased functionality which will be disabled unless you
  502.    have the key.
  503. b) The latest version on disk or by e-mail if you supply an
  504.    e-mail address.
  505. c) e-mail or snail mail support.
  506.  
  507. Gary Priest
  508. 32 Castle Street, Inner Avenue, Southampton SO14 6HF
  509.  
  510. gary@the-gap.demon.co.uk
  511.  
  512.  
  513. Disclaimer
  514. ----------
  515. All costings calculated by CoSTa are approximate and no guarantee
  516. to their accuracy is given.
  517. Any damage caused by use of this program, either directly or
  518. indirectly, is not my responsibility.
  519. This software is used at your own risk.
  520.  
  521.  
  522. Credits
  523. -------
  524. Atari NOS is the work of Demon and David Nash.
  525. Oasis and ICE are the creation of Phil Yeadon and Dave Levi.
  526.   Thanks guys for a brilliant program.
  527. STiK is the creation of Steve Adam.
  528.  
  529. Thanks also to the following people who have helped me by
  530. testing and supplying their views and suggestions:
  531.  
  532. Phil Yeadon, Neil Martin, Simon Husbands, Guy Harrison and Gary Wagner.
  533.  
  534.