home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / packet / finder / finder.syo < prev    next >
Text File  |  1987-09-20  |  10KB  |  234 lines
  1. FINDER.SYO  FINDER/FINDHW System Operation Details Version 2.0
  2.  
  3. A.  OVERVIEW
  4.  
  5. The FINDER software was written in Turbo Pascal on an IBM PC by WN6I, W.E.
  6. Moerner, and N6KL, Dave Palmer.  It requires a TNC with WA8DED firmware,
  7. because host mode is used for communication between the computer and the
  8. TNC.  No requirement is placed on the other TNC's connected to the FINDER
  9. database machine, except that they use AX.25 link-layer protocol.  The host
  10. mode of the WA8DED firmware has also been used in a packet database program
  11. written by WB6MRQ for the Primavera Bike Tour.  The FINDER program utilizes
  12. the Turbo Database Toolbox for management and indexing of its B-plus
  13. structured tree.  Briefly, FINDER may be regarded as a specialized multiple
  14. connect BBS with a specific command set tailored to the handling of STATUS
  15. INPUT information and STATUS REQUESTS.
  16.  
  17.  
  18. B.  GENERAL RULES FOR CURRENT INFORMATION INPUT / STATUS REQUESTS
  19.  
  20. Enter the various fields, in order, with separators between them.  Valid
  21. separators are the comma and the blank.  Multiple consecutive separators
  22. are treated as a single separator.
  23.  
  24. C.  SYNTAX FOR CURRENT INFORMATION INPUT: EMERGENCY RESPONDER (ER) MODE
  25.  
  26.                   phonenum,aname,sl,orig,time,date<cr>
  27.  
  28. (<cr> means carriage return)
  29.  
  30. See the FINDER Data Card for an explanation of the SL field.  The
  31. first four fields are required, and the last two are optional.
  32.  
  33.  
  34.   1.  PHONENUM
  35.  
  36.       PHONENUM can have as many embedded dashes as you like; all dashes are
  37.       ignored.  Two general formats may be used:  long or short form.  The
  38.       long form has the full ten digits for area code and phone number.
  39.       The short form has only 8 digits, and uses a single leading digit as
  40.       an abbreviation for the full area code.  The abbreviation is
  41.       determined by the sysop when FINDER is started - it might be the last
  42.       digit in the area code, for example, in which case "408" can be
  43.       abbreviated "8", and "415" can be abbreviated "5".  For more general
  44.       situations, the sysop may select NO area code checking when the
  45.       FINDER program is started.  In this case, all ten digit phone numbers
  46.       are allowed, but no eight digit phone numbers.
  47.  
  48.   2.  ANAME
  49.  
  50.       ANAME is a 5 character field with a leading letter, signifying the
  51.       first 5 letters of the person's first name.
  52.  
  53.   3.  SL
  54.  
  55.       SL is the 2-digit code, which is a combination of the "My current
  56.       status is" and "I will be at" codes on the input form.  The two
  57.       digits should be entered one after the other, with no characters in
  58.       between.  Only the values shown on the input form are allowed.
  59.  
  60.   4.  ORIG
  61.  
  62.       ORIG is the 4-character code signifying the point of origin of the
  63.       status information, i.e., the "This form filled out at" field on the
  64.       input form.  The code could be the fire station code where the person
  65.       filled out the form.  ORIG must start with a letter.
  66.  
  67.   5.  TIME
  68.  
  69.       TIME is an optional field. If present, it  must be  a valid
  70.       24 hour time, with no colon.  If this field is not present, the
  71.       database program inserts the current time.  TIME must be entered,
  72.       however, if you wish to enter a DATE.
  73.  
  74.   6.  DATE
  75.  
  76.       DATE is an optional field.  If present, it must be a valid day of the
  77.       month.  If this field is not present, the database program inserts
  78.       the current day of the month.
  79.  
  80.   7.  EXAMPLES OF DATA INPUT (ER MODE)
  81.  
  82.             85553195,joe,12,sj34<cr>
  83.             415-555-8011 mary 11 a234 1235 3<cr>
  84.  
  85.       All six of these pieces of information are stored in the database as
  86.       a record of the status and location of a particular person at a
  87.       particular time and date.  Further STATUS INPUT packets with the same
  88.       PHONENUM and ANAME will supercede old information about that person.
  89.  
  90. D.  SYNTAX FOR STATUS REQUEST (PHONENUM SEARCH, ER MODE)
  91.  
  92.             /phonenum,voiceopid<cr>
  93.  
  94.                     or
  95.  
  96.             ?phonenum,voiceopid<cr>
  97.  
  98. This command line instructs the database machine to look in the database for
  99. ALL persons with the same PHONENUM.  Status requests begin with the character
  100. "/" or "?" - use whichever is most convenient.  The two formats are handled
  101. identically.  A status report listing the current information for each person
  102. is sent back to the requesting packet station.  The first line gives the
  103. PHONENUM and the routing information.  At the end of the report, the line
  104.  
  105.             "FINDER Search done at 1534, nn hits."
  106.  
  107. is sent, which signifies no more ANAMEs with that PHONENUM, and that
  108. "nn" entries were found in the database.
  109.  
  110.   1.  PHONENUM
  111.  
  112.       PHONENUM has the same restrictions as in C.1 above.
  113.  
  114.   2.  VOICEOPID
  115.  
  116.       VOICEOPID is a free-form field of any length up to about 180 characters
  117.       with no embedded blanks or commas.  It is intended to be a reminder
  118.       to the packet operator of which one of his/her voice operators
  119.       transmitted this status request.  It is not stored in the database.
  120.       It may be the same as one of the origin codes in C.4 above, or it may
  121.       be the call sign of the voice operator, or any other convenient
  122.       string of characters.
  123.  
  124.  
  125.   3.  EXAMPLES OF STATUS REQUEST (PHONENUM SEARCH)
  126.  
  127.               /8555-3195,w1aw<cr>
  128.               /408-5553456,send-back-to-kit<cr>
  129.               /55558011 sj14<cr>
  130.  
  131. E. SYNTAX FOR ORIGIN SEARCH (ER MODE):
  132.  
  133. In addition to "/phonenum,routereplyto", the phone number search, ER mode
  134. also supports:
  135.  
  136.       $orig,routereplyto<cr>      search by origin code
  137.  
  138. This produces a status report for all persons with the same origin code.
  139.  
  140. F.  HEALTH AND WELFARE MODE:
  141.  
  142. If selected at startup by the sysop in a configuration file, FINDER will
  143. utilize a different data input format suited to health and welfare traffic
  144. and patient/victim tracking.  The health and welfare mode is abbreviated HW
  145. mode, to distinguish it from the original Emergency Responder (ER) mode.
  146. The HW data input format looks like:
  147.  
  148.               phonenum,lastname,firstname,cloc,message<cr>
  149.  
  150.       where,
  151.  
  152.         a.  PHONENUM is an abbreviated 8-digit or a full 10-digit
  153.             phone number with syntax identical to that for the ER
  154.             mode. It could be the victim's  home phone  number or
  155.             the phone number of next-of-kin.
  156.  
  157.         b.  LASTNAME is  the last  name of  the person,  up to 10
  158.             characters long.
  159.  
  160.         c.  FIRSTNAME is the first name of  the person,  up to 10
  161.             characters long.
  162.  
  163.         d.  CLOC is  a 4-character  location code starting with a
  164.             letter. It could be a hospital code or a shelter code
  165.             defined in  advance or  in real-time during the inci-
  166.             dent. This field is similar to the origin  code field
  167.             in the  ER mode,  except that  instead of stating the
  168.             location where the FINDER  data card  was filled out,
  169.             CLOC is more general.
  170.  
  171.         e.  MESSAGE is  a free-form  field up to 45 characters in
  172.             length that  can contain  embedded blanks.  It is in-
  173.             tended for  additional information  about the person,
  174.             such as the name  of the  nearest relative, injuries,
  175.             etc.,  that  is  determined  to  be useful during the
  176.             incident.
  177.  
  178.       The current time and date are inserted automatically by the
  179.       program.
  180.  
  181. G.    SEARCHES AVAILABLE IN HW MODE
  182.  
  183.       /phonenum,routereplyto<cr>  produces a  list of all entries
  184.                                   with the same phonenum
  185.  
  186.       /lastname,routereplyto<cr>  searches  by  lastname, listing
  187.                                   all with the same lastname
  188.  
  189.       $cloc,routereplyto<cr>      searches  by  cloc.  As  an ex-
  190.                                   ample, this could give  a list-
  191.                                   ing of  all persons at the same
  192.                                   shelter
  193.  
  194. H.  CONFERENCE BRIDGE (roundtable - "users" and "tell" commands)
  195.  
  196. This feature allows any connected station to send messages to other
  197. connected stations or to the sysop.
  198.  
  199.   1.  Users command:
  200.  
  201.       The users command in the form "users<cr>" or "u<cr>" returns a list of
  202.       the callsigns of currently logged-on packet stations.  The response
  203.       is of the form:
  204.  
  205.       At WN6I-1:  N6KL  W6BB-3  AJ6T  WB6MRQ-7
  206.  
  207.   2.  Tell command:
  208.  
  209.       The Tell command allows connected packet stations to use FINDER as a
  210.       conference bridge, or roundtable.  The general format is:
  211.  
  212.       tell callsign message<cr>      or:
  213.       t callsign message<cr>
  214.  
  215.       For example:
  216.  
  217.       tell w6bb-3 We have lots of people here at SJ12<cr>
  218.  
  219.       The message "We have lots of people here at SJ12" is sent to the
  220.       connected station W6BB-3 prefaced by a time stamp and the call of the
  221.       station originating the tell command.  In this case, if the tell
  222.       command was sent by AJ6T, W6BB-3 sees:
  223.  
  224.       1230 AJ6T> We have lots of people here at SJ12
  225.  
  226.       It is not necessary to enter the entire callsign - just the suffix or
  227.       some other substring will do.  If several connected callsigns contain the
  228.       substring, each station will get the message.  The special callsign
  229.       "*" or "all" is used to send a message to all connected stations.  The
  230.       special callsign "sysop" sends the message to the sysop at the FINDER
  231.       database station.
  232.  
  233. END: FINDER.SYO
  234.