home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / comm / race200.zip / ERACEM.DOC < prev    next >
Text File  |  1993-02-27  |  20KB  |  550 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                eRACEm Version 1.00
  30.  
  31.                 A RemoteAccess User/Answer File Pack/Sort Utility
  32.            Copyright 1991, 1993 Michael F. Janke. All Rights Reserved.
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.         Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   1
  40.  
  41.         Disclaimer  . . . . . . . . . . . . . . . . . . . . . . . . .   1
  42.  
  43.         Features  . . . . . . . . . . . . . . . . . . . . . . . . . .   1
  44.  
  45.         Licensing . . . . . . . . . . . . . . . . . . . . . . . . . .   2
  46.  
  47.         Using eRACEm  . . . . . . . . . . . . . . . . . . . . . . . .   3
  48.  
  49.         Configuration . . . . . . . . . . . . . . . . . . . . . . . .   3
  50.  
  51.         Packing the user base . . . . . . . . . . . . . . . . . . . .   3
  52.              PACK Switches  . . . . . . . . . . . . . . . . . . . . .   3
  53.                   -P  . . . . . . . . . . . . . . . . . . . . . . . .   3
  54.                   -D  . . . . . . . . . . . . . . . . . . . . . . . .   4
  55.                   -M  . . . . . . . . . . . . . . . . . . . . . . . .   4
  56.                   -G  . . . . . . . . . . . . . . . . . . . . . . . .   4
  57.                   -K  . . . . . . . . . . . . . . . . . . . . . . . .   4
  58.                   -L  . . . . . . . . . . . . . . . . . . . . . . . .   4
  59.                   -O  . . . . . . . . . . . . . . . . . . . . . . . .   4
  60.                   -C  . . . . . . . . . . . . . . . . . . . . . . . .   5
  61.  
  62.         Packing the answer file . . . . . . . . . . . . . . . . . . .   5
  63.              Answer file pack switches  . . . . . . . . . . . . . . .   5
  64.                   -A  . . . . . . . . . . . . . . . . . . . . . . . .   5
  65.                   -R  . . . . . . . . . . . . . . . . . . . . . . . .   5
  66.                   -Z  . . . . . . . . . . . . . . . . . . . . . . . .   5
  67.  
  68.         eRACEm PACK examples  . . . . . . . . . . . . . . . . . . . .   5
  69.  
  70.         Sorting the user file . . . . . . . . . . . . . . . . . . . .   6
  71.              Sorting on Primary and Secondary keys  . . . . . . . . .   6
  72.              Allowable sort fields  . . . . . . . . . . . . . . . . .   7
  73.              Ascending and Descending sort  . . . . . . . . . . . . .   7
  74.  
  75.         Using eRACEm's sort . . . . . . . . . . . . . . . . . . . . .   7
  76.              Sort command line switch . . . . . . . . . . . . . . . .   7
  77.              Sort parameters  . . . . . . . . . . . . . . . . . . . .   7
  78.  
  79.  
  80.  
  81.  
  82.  
  83.         eRACEm version 1.00                            User Documentation
  84.  
  85.  
  86.  
  87.  
  88.                             CHAPTER 1 - Introduction 
  89.  
  90.  
  91.  
  92.  
  93.         eRACEm is a companion  program to the popular RACE,  RemoteAccess
  94.         Caller  Editor.   eRACEm  has  replaced  the built-in  user  base
  95.         packing  and  sorting previously  contained in  RACE and  has had
  96.         numerous improvements and additions.
  97.  
  98.         eRACEm is  designed for, and must  only be used with,  the new RA
  99.         2.0 user files.   eRACEm will  NOT work with,  and could  damage,
  100.         user files  created  by RemoteAccess  v1.11  and below.    eRACEm
  101.         attempts to verify that the user files are RA 2.0 user files, but
  102.         this test is not guaranteed.
  103.  
  104.  
  105.         1.   Disclaimer
  106.  
  107.         eRACEm  is supplied  as is.   If you  use eRACEm,  you accept any
  108.         damage  or loss  that may  occur with  your user  files.   If you
  109.         cannot accept this condition, DO NOT use this program.
  110.  
  111.         I made every effort to insure eRACEm is safe to use.  It has been
  112.         used on numerous systems for extended periods of time, but things
  113.         can and do go wrong.  The best insurance is a current backup.
  114.  
  115.         eRACEm makes  no attempt to  share the user files  with any other
  116.         task.  If you attempt  to pack or sort the user files while RA is
  117.         active, you are asking for trouble.
  118.          
  119.  
  120.         2.   Features 
  121.  
  122.              * Purge users based on  number of calls, user  age, security
  123.                level, group and days since last call.
  124.  
  125.              * Sort  users in ascending or descending order on any one or
  126.                combination of 16 different fields.
  127.  
  128.              * Pack an  answer file of answer sets  marked deleted within
  129.                the RACE  validation routines, answers from  users that no
  130.                longer  exist  in the  user  base  and duplicate  answers.
  131.                (Answer file maintenance is a registered only feature)
  132.  
  133.  
  134.  
  135.  
  136.                                         1
  137.  
  138.  
  139.  
  140.  
  141.  
  142.         eRACEm version 1.00                            User Documentation
  143.  
  144.  
  145.  
  146.  
  147.                               CHAPTER 2 - Licensing
  148.  
  149.  
  150.  
  151.  
  152.         eRACEm is considered part of the RACE package and  as such, falls
  153.         under the guidelines of  the licensing agreement contained within
  154.         RACE.DOC.
  155.  
  156.         RACE  and eRACEm  are shareware  and require  a $15  (U.S. funds)
  157.         registration fee.  This fee applies whether you  just want to use
  158.         eRACEm, RACE or both.    A registration form has been provided in
  159.         the RACE distribution package.
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                         2
  196.  
  197.  
  198.  
  199.  
  200.  
  201.         eRACEm version 1.00                            User Documentation
  202.  
  203.  
  204.  
  205.  
  206.                              CHAPTER 3 - Using eRACEm
  207.  
  208.  
  209.  
  210.  
  211.         3.   Configuration
  212.  
  213.         eRACEm is entirely  command line  driven and  requires almost  no
  214.         configuring.   eRACEm does get path  information from RACE.CFG so
  215.         you  will  need  to  run  RACECFG.EXE  and  edit  the  file  path
  216.         information to coincide with your particular setup.
  217.  
  218.         If  you haven't  done so  already, run  RACECFG.EXE and  move the
  219.         highlight to  the main  menu FILES option.   Hit <ENTER>  to pull
  220.         down this menu, move  the highlight bar down to  SYSTEM FILENAMES
  221.         and hit <ENTER> again.
  222.  
  223.         Once  in the SYSTEM FILENAMES menu, you can enter the information
  224.         necessary  to fit  your system.   "System path" is  the drive and
  225.         directory containing  RA.    "Users.bbs" is  the  full  path  AND
  226.         filename  of the  user  file.   It  is  not  necessary to  define
  227.         "Answerfile" if you are only using eRACEm with this RACE.CFG.
  228.  
  229.  
  230.         4.   Packing the user base
  231.  
  232.         Packing  the user base only requires supplying a few command line
  233.         switches to eRACEm.  Any  number of pack switches may be  used in
  234.         combination.  All switches must be preceded by a hyphen or  slash
  235.         character and each switch must be separated by at least one space
  236.         from  other switches.  In other words,  "eRACEm -d60 -m10" is the
  237.         same  as "eRACEm /d60 /m10"  and either method  or combination of
  238.         both may be used.  Stacking of switches, i.e. "eRACEm -d60m10" is
  239.         NOT permitted.
  240.  
  241.              a.   PACK Switches
  242.  
  243.                   Switches  are  listed  below in  no  particular  order.
  244.                   Also, each switch is  surrounded by the "<>" characters
  245.                   for clarity only.   DO NOT use these characters  on the
  246.                   command line.
  247.  
  248.                   <-P>   The <P>  switch is  used only  when you  wish to
  249.                   purge the user file of users that have the deleted flag
  250.                   set.   There is no  need to use  this if you  are using
  251.                   other  switches because  RACE  will always  purge users
  252.                   that are marked deleted in that case.
  253.  
  254.                                         3
  255.  
  256.  
  257.  
  258.  
  259.  
  260.         eRACEm version 1.00                            User Documentation
  261.  
  262.                   <-Dn> The  <D> switch  requires a second  parameter (n)
  263.                   that  defines the  number of  days between  the current
  264.                   date  and the last date the user called before the user
  265.                   will be  checked further  to see if  any other  command
  266.                   line parameters have been met.
  267.  
  268.                   The <D>  switch  is a  required  switch and  all  other
  269.                   switches, with the exception of the <P> switch, will do
  270.                   nothing  if a  days  parameter is  not  provided.   One
  271.                   drawback to  this requirement  is that eRACEm  will not
  272.                   delete  users with a last  call date less  than one day
  273.                   ago unless the user is marked deleted.
  274.  
  275.                   <-Mn> This switch defines the <M>aximum security  level
  276.                   that will be  affected by  the current pack.   This  is
  277.                   slightly  different than RA's RAUSER utility which will
  278.                   only purge users BELOW the <M> parameter.
  279.  
  280.                   In other words, using -M10  would allow eRACEm to purge
  281.                   users with a security of 10 or below while RAUSER would
  282.                   only purge users with a security of 9 or below.
  283.  
  284.                   <-Gn> Purge users in <G>roup n.
  285.  
  286.                   <-K>  If this switch  is supplied on  the command line,
  287.                   the  user NO-KILL  flag  is  ignored  and it  will  not
  288.                   protect the user if all other parameters are met.
  289.  
  290.                   <-L{filename}>    The  <L>  switch writes  a  log  file
  291.                   containing information on which users were deleted.  If
  292.                   a plain <L> is used, the log file is  RACEPACK.LOG  You
  293.                   may  supply a filename so  that eRACEm will  write to a
  294.                   file of your choosing.  For example, "-Lmylog.dat" will
  295.                   create  a   file  called   MYLOG.DAT  in   the  current
  296.                   directory.  NO check is made and if a file by that name
  297.                   already exists, eRACEm will  append the log information
  298.                   to that file.
  299.  
  300.                   <-O> This  switch tells  eRACEm to write/append  to two
  301.                   files  in the user  directory.  These  files are called
  302.                   USERS.OLD and  USERSXI.OLD.   These files  will contain
  303.                   the full user record  of each deleted user.   With this
  304.                   feature, you  can  go into  RACE  and use  the  Whoops!
  305.                   feature  to restore  a user that  was purged  from your
  306.                   user  base.   Be advised  that each user  consumes just
  307.                   over 1K  of disk space.   If you use this  command line
  308.                   switch  every day and delete a lot of users, these .OLD
  309.                   files  could grow quite large.   Neither eRACEm or RACE
  310.                   maintain  these  files  in  any  other  way  that  just
  311.                   described.
  312.  
  313.                                         4
  314.  
  315.  
  316.  
  317.  
  318.  
  319.         eRACEm version 1.00                            User Documentation
  320.  
  321.  
  322.                   <-Bn> purge users below n years old.
  323.  
  324.                   <-Cn>   Purge users that  have called n  times or less.
  325.                   This  could be used to  purge users that  call one time
  326.                   and never come back.
  327.  
  328.  
  329.         5.   Packing the answer file
  330.  
  331.         eRACEm has the capability of packing a RA generated questionnaire
  332.         answer  file if  two criteria  are  met.   First, you  must be  a
  333.         registered  user of RACE/eRACEm.   Second, you must  be using the
  334.         validation feature of  RACE v2.00.   Validation creates an  index
  335.         into the answer file that eRACEm needs. 
  336.  
  337.              a.   Answer file pack switches
  338.  
  339.                   <-Afile>    The  <A>  switch must  have  the  BASE  (no
  340.                   extension) filename of the  answer file appended to the
  341.                   switch.   In other words, "eRACEm  -Anewuser" will pack
  342.                   the  Newuser.Asw file.  You may pack any answer file as
  343.                   long as an index file has been created by RACE.
  344.  
  345.                   The <A> switch removes answer sets that you have marked
  346.                   deleted within the validation feature of RACE.  The <A>
  347.                   switch =MUST= be used if you wish to use either or both
  348.                   of the following switches.
  349.  
  350.                   <-R> The  <R> switch allows  eRACEm to  go through  the
  351.                   answer file and  remove answer sets from users  that no
  352.                   longer exist  in USERS.BBS.   The  <R> switch takes  no
  353.                   parameters.
  354.  
  355.                   <-Z> This  switch <Z>aps duplicate answers.   The logic
  356.                   used here  is quite simple.   eRACEm looks  through the
  357.                   answer  file finding all answer  sets from a  user.  It
  358.                   then deletes all but  the last answer set.   eRACEm has
  359.                   no idea  whether  or  not  the other  answer  sets  are
  360.                   actually  exact duplicates.   The  <Z> switch  takes no
  361.                   parameters.
  362.  
  363.  
  364.         6.   eRACEm PACK examples
  365.  
  366.              a.   To purge users that have not called in 60 days and have
  367.                   a security level of 20 or below:
  368.  
  369.                        eRACEm -d60 -m20
  370.  
  371.  
  372.                                         5
  373.  
  374.  
  375.  
  376.  
  377.  
  378.         eRACEm version 1.00                            User Documentation
  379.  
  380.  
  381.              b.   Purge users that have not called  in 45 days and have a
  382.                   security level of 20 or below and who  are less than 18
  383.                   years of age  and purge  even if the  user meeting  the
  384.                   above criteria has the NO-KILL flag set:
  385.  
  386.                        eRACEm -d45 -m20 -b18 -K
  387.  
  388.  
  389.              c.   Purge users that have not called in 45 days and have  a
  390.                   security level below 20. Also purge answer file records
  391.                   in NEWUSER.ASW for users that no longer exist  in users
  392.                   bbs  and remove  answer file  records that  were marked
  393.                   deleted in RACE:
  394.  
  395.                        eRACEm -d45 -m20 -Anewuser -R
  396.  
  397.  
  398.         7.   Sorting the user file
  399.  
  400.         The sort provided by eRACEm works a bit differently than both the
  401.         sort  provided in  RACE v1.52  and that  provided by  RA's RAUSER
  402.         program.   The end result is certainly  the same, but the options
  403.         and usage of eRACEm is quite different.
  404.  
  405.         One  feature worthy of mention  is that eRACEm  never, ever sorts
  406.         the  first record (record 0,  usually the Sysop's  record) out of
  407.         position no matter what sort criteria you use.
  408.  
  409.         eRACEm will make use of EMS  (if available) or the hard drive for
  410.         temporary storage  if the user file is so large that it cannot be
  411.         sorted entirely in memory.   With the  new, expanded RA 2.0  user
  412.         fields, it is not likely that any but the smallest user base will
  413.         be sorted in RAM.
  414.  
  415.         Like RACE  v1.52, eRACEm will  allow you to  sort on a  number of
  416.         fields.  The  main difference is  that eRACEm will  allow you  to
  417.         sort on multiple fields  and each individual field may  be sorted
  418.         in either ascending or descending order.
  419.  
  420.  
  421.         8.   Sorting on Primary and Secondary keys (fields)
  422.  
  423.         If you've never  used a  database or other  program that  allowed
  424.         sorting on  multiple fields,  it's important that  you understand
  425.         how the  sort provided by  eRACEm works  so that you  don't think
  426.         something is wrong when the end result is not what you expected.
  427.  
  428.         A sort is first  performed on the primary sort key.   Only if two
  429.         (or  more) primary sort fields  are EXACTLY identical will eRACEm
  430.  
  431.                                         6
  432.  
  433.  
  434.  
  435.  
  436.  
  437.         eRACEm version 1.00                            User Documentation
  438.  
  439.         sort those fields on the secondary key.
  440.  
  441.         In other words,  if you select the user name  as the primary key,
  442.         it is unlikely  eRACEm will sort  any users by the  secondary key
  443.         because it is  doubtful that  you have two  users with  identical
  444.         names.
  445.  
  446.         On  the  other hand,  if  you select  the security  field  as the
  447.         primary  sort key,  you  will  no  doubt  have  many  users  with
  448.         identical  security  levels  and  the sort  will  then  sort  the
  449.         secondary key within each security level.
  450.  
  451.  
  452.         9.   Allowable sort fields
  453.  
  454.         eRACEm can sort on any one (or combination) of the following user
  455.         fields.  Fields are listed in no particular order.
  456.  
  457.              Name, City, Credit, Posts, Security, Calls, Ups, Downs, UpK,
  458.              DownK,   Group,   Pending,  LastCall,   FirstCall,  SubDate,
  459.              BirthDate.
  460.  
  461.         These  are  the  EXACT identifiers  you  must  use  for the  sort
  462.         parameters.  I won't bore you with a description of each field as
  463.         their names are fairly self-explanatory.
  464.  
  465.  
  466.         10.  Ascending and Descending sort
  467.  
  468.         eRACEm requires you to select whether you would like an ascending
  469.         or descending  sort.  This is selectable by field so that you may
  470.         select an  ascending sort  on one key  and a  descending sort  on
  471.         another key.
  472.  
  473.         An ascending  sort on a text  field (name, city, etc.)  means the
  474.         records  will be  sorted  from lowest  (the  letter "a")  to  the
  475.         highest  (the  letter "z").    On a  numeric  field  such as  the
  476.         security  field, this would start at 0  and go up to your highest
  477.         level.  A descending sort is naturally just the opposite.
  478.  
  479.  
  480.         11.  Using eRACEm's sort
  481.  
  482.              a.   Sort command line switch
  483.  
  484.                   eRACEm  has  one  simple   switch  that  signals   sort
  485.                   parameters to follow.  This is the -S  switch.  As with
  486.                   packing, you may use /S or -S.
  487.  
  488.              b.   Sort parameters
  489.  
  490.                                         7
  491.  
  492.  
  493.  
  494.  
  495.  
  496.         eRACEm version 1.00                            User Documentation
  497.  
  498.                   The -S switch must  be followed by one or more sort key
  499.                   names  mentioned in paragraph 9, Allowable sort fields.
  500.                   It  is important to  note that IF  and only  IF you use
  501.                   more  than one  sort key,  the sort  key names  MUST be
  502.                   enclosed by double or single quotes or square brackets.
  503.                   Also, each sort key name MUST be terminated with a plus
  504.                   or minus character ("+", "-") to signify  whether it is
  505.                   to  be sorted  in ascending or  descending order.   The
  506.                   first sort key name  provided in the parameter list  is
  507.                   considered the primary key.
  508.  
  509.                   An example will clarify the above requirements.  If you
  510.                   just want to sort  on the users last name  in ascending
  511.                   alphabetical (a - z) order you would use:
  512.  
  513.                        eRACEm -Sname+
  514.  
  515.                   Or  to sort  on security  level only, with  the highest
  516.                   levels first and lowest last you would use:
  517.  
  518.                        eRACEm -Ssecurity-
  519.  
  520.                   If you wanted a  sort like the one provided  by RAUSER,
  521.                   i.e.  highest  to  lowest  security   level  with  each
  522.                   individual security level sorted  by name in  ascending
  523.                   order you would use:
  524.  
  525.                        eRACEm -S"security- name+"
  526.                                  or
  527.                        eRACEm -S[security- name+]
  528.                                  or
  529.                        eRACEm -S'security- name+'
  530.  
  531.                   Note that: eRACEm -S[name+ security-] would not produce
  532.                   the  results  you  might  expect  since,  as  mentioned
  533.                   earlier, it is not likely you would have two users with
  534.                   the exact same name and therefore, the sort on security
  535.                   would never occur.
  536.  
  537.  
  538.  
  539.                                       <EOF>
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.                                         8
  550.