home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / MAXAL101.ZIP / MAXALL.DOC < prev    next >
Encoding:
Text File  |  1993-09-06  |  12.0 KB  |  237 lines
  1.  
  2.  
  3.  
  4.                   MaxAll - Maximus All Reports Generator v1.0
  5.  
  6.                       Written and Copyright by Craig Allsop
  7.  
  8.  
  9.  
  10.  
  11. ┌─────────────────────────────────────────────────────────────────────────────┐
  12. │░░ General Overview ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1 ░░│
  13. └─────────────────────────────────────────────────────────────────────────────┘
  14.  
  15.  1.1    This utility is intended for use with Maximus 2.0/2.01 and a mailer,
  16.         to generate today's callers, yesterday's callers, top callers, top
  17.         downloaders (kb), top uploaders (kb), best ratio, worst ratio, usage
  18.         graphs for the last week, month and quarter year, and some overall
  19.         system statistics. I've designed this utility to run as fast as
  20.         possible, on my system (a 386-33, multitasking with Desqview and
  21.         Hyperdisk cache, all the reports with 600 users takes about 4 seconds,
  22.         which isn't all that long.) The time taken to process is shown at the
  23.         end of each run, if anyone is getting times of longer than 20-30
  24.         seconds then something must be wrong, or you need a hardware upgrade.
  25.  
  26.  ->     This is a public release, although I have done plenty of testing,
  27.         there may still be problems that have not yet arisen. If you find
  28.         something strange happening, then please let me know.
  29.  
  30.         Although I have been using this utility on my system for a few months
  31.         now and everything is running smoothly, I will not take responsibility
  32.         if this utility does not perform, fails or causes damage to anything
  33.         else. Use it at your own risk.
  34.  
  35.         This utility maybe used by any Maximus SysOp.
  36.  
  37. ┌─────────────────────────────────────────────────────────────────────────────┐
  38. │░░ Notes & Key Items ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2 ░░│
  39. └─────────────────────────────────────────────────────────────────────────────┘
  40.  
  41.  2.1    Special marks:
  42.  
  43.         ->      A special note to be aware of.
  44.  
  45.         x.x     A process number/point number/instruction step, to follow.
  46.                 These are used to make instructions easier to follow and so I
  47.                 can redirect your attention elsewhere if needed. Or if my
  48.                 document needs alteration/updating then you can direct ME to
  49.                 the closest position.
  50.  
  51.  2.2    I assume that SysOps will be reading this document so I have written
  52.         it accordingly. I also assume that you know how to operate your system
  53.         in regards to the file system and the BBS system, its operation and
  54.         files.
  55.  
  56.  ->     I am no expert at writing documentation so if you find errors, or lack
  57.         of information then please make me aware of them/it. I do not have
  58.         time for perfect documentation, its not necessary as I'm sure you can
  59.         get my drift. (hopefully)
  60.                                         
  61.  2.3    MaxAll REQUIRES SHARE to be loaded! If it is not, then it will not
  62.         operate correctly. (I'm not sure on what will happen without share, I
  63.         haven't got time to test this. For those people with single line
  64.         systems with no multitasker you maybe able to get away without share,
  65.         but people with multiline systems will require it.)
  66.  
  67.  2.4    MaxAll is aware of multinode operation, if MaxAll is already running
  68.         in another task then it will wait until the other is finnished or
  69.         timeout after a minute. Usually it will only take a few seconds to run
  70.         anyway so I haven't had any problems under two lines. I can not test
  71.         this so if anyone does have problems then let me know.
  72.  
  73.         If a user is online and looking at a report, and MaxAll is processing
  74.         in another task, this report will be skipped if its not made avaliable
  75.         within a few seconds. This doesn't affect the operation of MaxAll, and
  76.         the report can be updated next time its executed.
  77.  
  78.  2.5    The system stats report requires a day before it will be generated, as
  79.         of course will the yesterday's callers.
  80.  
  81.         The worst ratio and best ratio reports are caculated on the assumption
  82.         that a ratio is download/upload and that if uploads equal zero then a
  83.         one is subsituted. Thus a user who has uploaded nothing and a user who
  84.         has uploaded 1k but both downloaded say 200k will both have a 200:1
  85.         ratio. Anyone object to this caculation method?
  86.  
  87. ┌─────────────────────────────────────────────────────────────────────────────┐
  88. │░░ Installation ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 3 ░░│
  89. └─────────────────────────────────────────────────────────────────────────────┘
  90.  
  91.  3.1    It is assumed that you have extracted MaxAll into a tempory directory.
  92.         So I would recommend a home directory of MaxAll\ off your Maximus
  93.         directory be created and all the files placed in it.
  94.  
  95.  3.2    Now so that the today's callers can display the caller's baud rate and
  96.         node number, you will need a few additional dos variables in the batch
  97.         file that drives the BBS or however you load up Maximus. The following
  98.         batch commands to initilise two variables 'baud' and 'node' to
  99.         approprate values for each call that comes in. Usually your can
  100.         determine this from errorlevels returned from the mailer or the mailer
  101.         might generate a batch file with arguments containing these values.
  102.         These variables are then used by MaxAll for the today's callers.
  103.  
  104.         SET BAUD=?????
  105.         SET NODE=??
  106.  
  107.         So simply put, when a call comes in, set BAUD to the baud rate of the
  108.         incomming call, and NODE to the current node number for this call, or
  109.         1 for single line system. (NODE is a two digit number in HEX)
  110.  
  111.  3.3    After Maximus is called and before the mailer is loaded again, you
  112.         will need to do something similar to this: (Thus you can see what the
  113.         variables are used for) The 'rtyu' tells MaxAll to generate reports,
  114.         today's callers, yesterday's callers and the usage graphs every time.
  115.  
  116.  ->     (replace 'cdd maxall' with approprate directory change for your system
  117.         depending on where you placed the MaxAll files. I have assumed that
  118.         MaxAll is "off" your Maximus directory, therefore, you will notice I
  119.         use "..\" in front of arguments, this can be replaced with the full
  120.         path to your Maximus directory if you do not want MaxAll's files off
  121.         the Maximus directory.)
  122.  
  123.         cdd maxall
  124.         maxall rtyu ..\lastus%node.bbs ..\user.bbs ..\misc\ -n%node -b%baud
  125.  
  126.         Required Arguments:
  127.  
  128.         rtyu                    Generate these reports: Reports, Today's,
  129.                                 Yesterday's and Usage Graphs. NOTE: For
  130.                                 multinode systems which have local node(s) or
  131.                                 if a node you do NOT wish to have usage time
  132.                                 added to the useage reports then add an "l" to
  133.                                 this argument.
  134.  
  135.         ..\lastus%node.bbs      Path and name to LASTUSxx.BBS - This reads the
  136.                                 last user called. Can be replaced with
  137.                                 "..\lastus01.bbs" for single line systems.
  138.  
  139.         ..\user.bbs             Path and name to USER.BBS - Maximus's user
  140.                                 file.
  141.  
  142.         ..\misc\                Path with trailing slash, the directory you
  143.                                 wish the reports to be generated in.
  144.  
  145.         -n%node                 Current node number MaxAll is running on. (Can
  146.                                 be replaced with "-n01" for single line
  147.                                 systems.)
  148.  
  149.         Optional Arguments:
  150.  
  151.         -b%baud                 Current caller's baud rate. This is required
  152.                                 for displaying the user's baud rate on the
  153.                                 today's callers reports.
  154.  
  155.  ->     OS/2 may require environment variables with % on both ends, ie.
  156.  
  157.         cdd maxall
  158.         maxall rtyu ..\lastus%node%.bbs ..\user.bbs ..\misc\ -n%node% -b%baud%
  159.  
  160.  ->     For speedy return to the mailer, only use 't' here, this will save the
  161.         caller's details and only generate a today's callers list, then in a
  162.         maintenance event, you can generate the rest of the reports. Ie. the
  163.         following after Maximus:
  164.  
  165.         cdd maxall
  166.         maxall t \lastus%node.bbs \user.bbs f:\misc\ -n%node -b%baud
  167.  
  168.         And this in a daily maintenance: (Notice the 'l' used for the last
  169.         user file, MaxAll ignores this as there is no last caller!)
  170.  
  171.         cdd maxall
  172.         maxall rtyu l \user.bbs f:\misc\ -n%node -b%baud
  173.  
  174.  3.4    You will then need to create menu options for the reports, the
  175.         following is an example (cut from mine accually):
  176.  
  177.         Display_File    F:\Misc\Ma_calls       Disgrace   "1Top Callers"
  178.         Display_File    F:\Misc\Ma_brati       Disgrace   "2Best File Ratio"
  179.         Display_File    F:\Misc\Ma_wrati       Disgrace   "3Worst File Ratio"
  180.         Display_File    F:\Misc\Ma_kdls        Disgrace   "4Top Kb Downloaded"
  181.         Display_File    F:\Misc\Ma_kuls        Disgrace   "5Top Kb Uploaded"
  182.         Display_File    F:\Misc\Ma_sys         Disgrace   "6System Stats"
  183.         Display_File    F:\Misc\Ma_uweek       Disgrace   "7Weekly Usage"
  184.         Display_File    F:\Misc\Ma_umon        Disgrace   "8Monthly Usage"
  185.         Display_File    F:\Misc\Ma_uquar       Disgrace   "9Quartly Usage"
  186.         Display_File    F:\Misc\Ma_today       Disgrace   "Today's Callers"
  187.         Display_File    F:\Misc\Ma_yeday       Disgrace   "Yesterday's"
  188.  
  189.         After these options are in your MENUS.CTL, run SILT to update the
  190.         menus and everything should be done.
  191.  
  192.  3.5    The batch file RUN.BAT is useful for updating the reports manually.
  193.         You can now run this batch file to generate the reports.
  194.  
  195. *3.6    MaxAll will read the CMOS date & time, so hopefully this clock will
  196.         return the correct local time.
  197.  
  198.  3.7    If anyone can not work out my instructions or has problems installing
  199.         this utility please drop me a message and I'll try and sort it out for
  200.         you. See below for contact.
  201.  
  202. ┌─────────────────────────────────────────────────────────────────────────────┐
  203. │░░ Known Problems ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 4 ░░│
  204. └─────────────────────────────────────────────────────────────────────────────┘
  205.  
  206.  4.1    Time banks may cause my program to miscaculate the time spent online
  207.         by a user as these programs alter the lastcallers record. It maybe
  208.         possible to run my program before you run a time bank's maintenance to
  209.         solve this problem. I don't have the time to find a suitable solution
  210.         for this. Also the Kb downloaded on users call maybe incorrect if a
  211.         time bank supports saving of Kb's. The OnFor and Kbdn items on the
  212.         today's callers configuration maybe left out of the report if you get
  213.         this problem.
  214.  
  215. ┌─────────────────────────────────────────────────────────────────────────────┐
  216. │░░ Credits, Contacts, Etc. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 5 ░░│
  217. └─────────────────────────────────────────────────────────────────────────────┘
  218.  
  219.  5.1    MaxAll (Maximus All Reports Generator) is Copyright 1993 by Craig
  220.         Allsop.
  221.  
  222.         Maximus is Copyright by Scott Dudley.
  223.  
  224.  5.2    The latest version of MaxAll is file requestable at 61:6700/180
  225.         Worldnet or 3:640/225 Fidonet (Australia +61-7-344-3621) under the
  226.         name "MAXALL" or beta versions under the name "MAXALLB". Notification
  227.         of releases will take place in BBS_DOORS & MUFFIN. Please note that
  228.         currently speed is limited to 2400.
  229.  
  230.  5.3    If anyone has suggestions, comments, bug reports, improvement ideas
  231.         etc. then please direct them to Craig Allsop in forums BBS_DOORS
  232.         (worldnet) or MUFFIN - Maximus Support/ MAXDEV - Maximus Developers
  233.         (fidonet).
  234.  
  235.  
  236. -end-
  237.