home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / maxal104.zip / MAXALL.DOC < prev    next >
Text File  |  1993-09-21  |  15KB  |  286 lines
  1.  
  2.  
  3.  
  4.                   MaxAll - Maximus All Reports Generator v1.04
  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, to generate
  16.         today's callers, yesterday's callers, top callers, top downloaders
  17.         (kb), top uploaders (kb), best ratio, worst ratio, usage graphs for
  18.         the last week, month and quarter year, and some overall system
  19.         statistics. I've designed this utility to run as fast as possible, on
  20.         my system (a 386-33, multitasking with Desqview and Hyperdisk cache,
  21.         all the reports with 600 users takes about 4 seconds, which isn't all
  22.         that long.) The time taken to process is shown at the end of each run,
  23.         if anyone is getting times of longer than 20-30 seconds then something
  24.         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.
  71.  
  72.         If a user is online and looking at a report, and MaxAll is processing
  73.         in another task, this report will be skipped if its not made avaliable
  74.         within a few seconds. This doesn't affect the operation of MaxAll, and
  75.         the report can be updated next time its executed.
  76.  
  77.  2.5    The system stats report requires a day before it will be generated, as
  78.         of course will the yesterday's callers.
  79.  
  80.         The worst ratio and best ratio reports are caculated on the assumption
  81.         that a ratio is download/upload and that if uploads equal zero then a
  82.         one is subsituted. Thus a user who has uploaded nothing and a user who
  83.         has uploaded 1k but both downloaded say 200k will both have a 200:1
  84.         ratio. Anyone object to this caculation method?
  85.  
  86. ┌─────────────────────────────────────────────────────────────────────────────┐
  87. │░░ Installation (With Mailer) ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 3 ░░│
  88. └─────────────────────────────────────────────────────────────────────────────┘
  89.  
  90.  3.1    It is assumed that you have extracted MaxAll into a tempory directory.
  91.         So I would recommend a home directory of MaxAll\ off your Maximus
  92.         directory be created and all the files placed in it.
  93.  
  94.  3.2    Now so that the today's callers can display the caller's baud rate and
  95.         node number, you will need a few additional dos variables in the batch
  96.         file that drives the BBS or however you load up Maximus. The following
  97.         batch commands to initilise two variables 'baud' and 'node' to
  98.         approprate values for each call that comes in. Usually your can
  99.         determine this from errorlevels returned from the mailer or the mailer
  100.         might generate a batch file with arguments containing these values.
  101.         These variables are then used by MaxAll for the today's callers.
  102.  
  103.         SET BAUD=?????
  104.         SET NODE=??
  105.  
  106.         So simply put, when a call comes in, set BAUD to the baud rate of the
  107.         incomming call, and NODE to the current node number for this call, or
  108.         1 for single line system. (NODE is a two digit number in HEX)
  109.  
  110.  3.3    After Maximus is called and before the mailer is loaded again, you
  111.         will need to do something similar to this: (Thus you can see what the
  112.         variables are used for) The 'rtyu' tells MaxAll to generate reports,
  113.         today's callers, yesterday's callers and the usage graphs every time.
  114.  
  115.  ->     (replace 'cdd maxall' with approprate directory change for your system
  116.         depending on where you placed the MaxAll files. I have assumed that
  117.         MaxAll is "off" your Maximus directory, therefore, you will notice I
  118.         use "..\" in front of arguments, this can be replaced with the full
  119.         path to your Maximus directory if you do not want MaxAll's files off
  120.         the Maximus directory.)
  121.  
  122.         cdd maxall
  123.         maxall rtyu ..\lastus%node.bbs ..\user.bbs ..\misc\ -n%node -b%baud
  124.  
  125.         Required Arguments:
  126.  
  127.         rtyu                    Generate these reports: Reports, Today's,
  128.                                 Yesterday's and Usage Graphs. NOTE: For
  129.                                 multinode systems which have local node(s) or
  130.                                 if a node you do NOT wish to have usage time
  131.                                 added to the useage reports then add an "l" to
  132.                                 this argument.
  133.  
  134.         ..\lastus%node%.bbs     Path and name to LASTUSxx.BBS - This reads the
  135.                                 last user called. Can be replaced with
  136.                                 "..\lastus01.bbs" for single line systems.
  137.  
  138.         ..\user.bbs             Path and name to USER.BBS - Maximus's user
  139.                                 file.
  140.  
  141.         ..\misc\                Path with trailing slash, the directory you
  142.                                 wish the reports to be generated in.
  143.  
  144.         -n%node%                Current node number MaxAll is running on. (Can
  145.                                 be replaced with "-n01" for single line
  146.                                 systems.)
  147.  
  148.         Optional Arguments:
  149.  
  150.         -b%baud%                Current caller's baud rate. This is required
  151.                                 for displaying the user's baud rate on the
  152.                                 today's callers reports.
  153.  
  154.         cdd maxall
  155.         maxall rtyu ..\lastus%node%.bbs ..\user.bbs ..\misc\ -n%node% -b%baud%
  156.  
  157.  3.4    For speedy return to the mailer, only use 't' here, this will save the
  158.         caller's details and only generate a today's callers list, then in a
  159.         maintenance event, you can generate the rest of the reports. Ie. the
  160.         following after Maximus:
  161.  
  162.         cdd maxall
  163.         maxall t \lastus%node%.bbs \user.bbs ..\misc\ -n%node% -b%baud%
  164.  
  165.         And this in a daily maintenance: (Notice the 'maint' used for the last
  166.         user file, MaxAll ignores this as there is no last caller!)
  167.  
  168.         cdd maxall
  169.         maxall rtyui maint \user.bbs ..\misc\
  170.  
  171. ┌─────────────────────────────────────────────────────────────────────────────┐
  172. │░░ Installation (in WFC mode) ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 4 ░░│
  173. └─────────────────────────────────────────────────────────────────────────────┘
  174.  
  175.  4.1    Included with MaxAll is MAXALL.MEC which will create a batch file to
  176.         be run after the caller logs off. To use it, place it in your MISC
  177.         directory and edit it to suit the paths you are using - (The included
  178.         MEC assumes the Maximus directory is G:\ so one should replace these
  179.         with approprate paths) Also if you are not using a .PRG user file
  180.         which is created with UEdit 2.01 then remove this file and the
  181.         semi-colon seperating it.
  182.  
  183.         Edit your WELCOME bbs file and include the following line near the top
  184.         of the file:
  185.  
  186.         [link]g:\misc\maxall
  187.  
  188.         (Again replacing the approprate directory for your system) As a user
  189.         logs on, Maximus will create a batch file named MAXALLxx.BAT (xx =
  190.         current node number) so one simply adds the following line in their
  191.         AFTERMAX.BAT file to call MaxAll: (Refer to paragraph 3.2 for what is
  192.         required to set the %node% environment variable in multiline systems)
  193.  
  194.         call g:\maxall%node%.bat
  195.  
  196.         Or for single line systems;
  197.  
  198.         call g:\maxall01.bat
  199.  
  200.         In MAXALL.MEC you will notice the batch file created will only
  201.         generate today's callers report, so if you intend to create the others
  202.         on an event see paragraph 3.4, or add the other report generating
  203.         letters "ryu" to the maxall line. Eg:
  204.  
  205.         [isremote][write]maxall tryu g:\lastuser.bbs ... etc.
  206.                                 ^^^^
  207.  
  208. ┌─────────────────────────────────────────────────────────────────────────────┐
  209. │░░ Installation (with Maximus) ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 5 ░░│
  210. └─────────────────────────────────────────────────────────────────────────────┘
  211.  
  212.  5.1    You will then need to create menu options for the reports, the
  213.         following is an example (cut from mine accually):
  214.  
  215.         Display_File    F:\Misc\Ma_calls       Disgrace   "1Top Callers"
  216.         Display_File    F:\Misc\Ma_brati       Disgrace   "2Best File Ratio"
  217.         Display_File    F:\Misc\Ma_wrati       Disgrace   "3Worst File Ratio"
  218.         Display_File    F:\Misc\Ma_kdls        Disgrace   "4Top Kb Downloaded"
  219.         Display_File    F:\Misc\Ma_kuls        Disgrace   "5Top Kb Uploaded"
  220.         Display_File    F:\Misc\Ma_sys         Disgrace   "6System Stats"
  221.         Display_File    F:\Misc\Ma_uweek       Disgrace   "7Weekly Usage"
  222.         Display_File    F:\Misc\Ma_umon        Disgrace   "8Monthly Usage"
  223.         Display_File    F:\Misc\Ma_uquar       Disgrace   "9Quartly Usage"
  224.         Display_File    F:\Misc\Ma_info        Disgrace   "0MaxAll Info"
  225.         Display_File    F:\Misc\Ma_today       Disgrace   "Today's Callers"
  226.         Display_File    F:\Misc\Ma_yeday       Disgrace   "Yesterday's"
  227.  
  228.         After these options are in your MENUS.CTL, run SILT to update the
  229.         menus and everything should be done.
  230.  
  231.  5.2    The batch file RUN.BAT is useful for updating the reports manually.
  232.         You can now run this batch file to generate the reports.
  233.  
  234. *5.3    MaxAll will read the CMOS date & time, so hopefully this clock will
  235.         return the correct local time.
  236.  
  237.  5.4    If anyone can not work out my instructions or has problems installing
  238.         this utility please drop me a message and I'll try and sort it out for
  239.         you. See below for contact.
  240.  
  241. ┌─────────────────────────────────────────────────────────────────────────────┐
  242. │░░ Known Problems ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 6 ░░│
  243. └─────────────────────────────────────────────────────────────────────────────┘
  244.  
  245.  6.1    Time banks may cause my program to miscaculate the time spent online
  246.         by a user as these programs alter the lastcallers record. It maybe
  247.         possible to run my program before you run a time bank's maintenance to
  248.         solve this problem. I don't have the time to find a suitable solution
  249.         for this. Also the Kb downloaded on users call maybe incorrect if a
  250.         time bank supports saving of Kb's. The OnFor and Kbdn items on the
  251.         today's callers configuration maybe left out of the report if you get
  252.         this problem.
  253.  
  254.  6.2    The generation of system stats like downloads/uploads (kb), calls in a
  255.         week will not be exact if user records are removed from the user file
  256.         on a daily basis. But on large systems with many users & lines a few
  257.         users deleted is not going to affect the reports significantly. This
  258.         does not mean I recommened NOT removing users from your user file - it
  259.         would grow too big otherwise!
  260.  
  261.  ->     This can be solved by including a 2nd user file seperated by a
  262.         semi-colon as produced by a utility such as UEdit 2.01.
  263.  
  264. ┌─────────────────────────────────────────────────────────────────────────────┐
  265. │░░ Credits, Contacts, Etc. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 7 ░░│
  266. └─────────────────────────────────────────────────────────────────────────────┘
  267.  
  268.  7.1    MaxAll (Maximus All Reports Generator) is
  269.         Copyright 1993 by Craig Allsop.
  270.  
  271.         Maximus is Copyright by Scott Dudley.
  272.  
  273.  7.2    The latest version of MaxAll is file requestable at 61:6700/180
  274.         Worldnet or 3:640/225 Fidonet (Australia +61-7-344-3621) under the
  275.         name "MAXALL" or beta versions under the name "MAXALLB". Notification
  276.         of releases will take place in BBS_DOORS & MUFFIN. Please note that
  277.         currently speed is limited to 2400.
  278.  
  279.  7.3    If anyone has suggestions, comments, bug reports, improvement ideas
  280.         etc. then please direct them to Craig Allsop in forums BBS_DOORS
  281.         (worldnet) or MUFFIN - Maximus Support/ MAXDEV - Maximus Developers
  282.         (fidonet).
  283.  
  284.  
  285. -end-
  286.