home *** CD-ROM | disk | FTP | other *** search
/ World of Ham Radio 1997 / WOHR97_AmSoft_(1997-02-01).iso / packet / pak_11 / amsoft.iii next >
Text File  |  1997-02-01  |  22KB  |  494 lines
  1. USERMAN.DOC - ARES/Data Remote Packet User Information
  2.  
  3. Be sure to also read QUIKREF.DOC - Packet Operator Quick Reference
  4. Version 1.5
  5.  
  6.                       OVERVIEW OF ARES/Data
  7.  
  8. Briefly, ARES/Data may be regarded as a specialized multiple-port,
  9. multiple-connect database with a specific command set tailored to the
  10. handling of information input, search, listing, and summary requests.
  11. In addition, the system provides a full-featured conference bridge so
  12. that all connected stations may converse conveniently with one another.
  13.  
  14. The ARES/Data network is a star network with the ARES/Data database
  15. machine at the hub.  It looks something like this:
  16.  
  17.                   _______ARES/Data Database Machine_______
  18.                   |           |             |             |
  19.                Port A       Port B       Port C        Port D
  20.                   |           |             |             |
  21.                 radio       radio         radio         radio
  22.                  ..          ...           ...           ....
  23.                 . .         . . .         . . .         . . . .
  24.                . . .       .  .  .       .  .  .       .  .  . .
  25.               . .   .     .  . .  .     .  . .  .     .  . .  . .
  26.               P P    P    P  P P  P     P  P P  P     P  P P  P P
  27.  
  28. Each "P" represents a remotely-connected packet station which is
  29. connected to the ARES/Data database machine.  All the remotely-connected
  30. stations have shared access to the data in the system.  In particular,
  31. the packet operators can utilize two groups of functions provided by
  32. ARES/Data which are described in detail in this file:
  33.  
  34.       I.  send/receive status requests and current information to/from
  35.           the ARES/Data database station
  36.       II. send/receive short messages to/from other remotely connected
  37.           stations or the sysop (Conference Bridge)
  38.  
  39.  
  40. A.  CONNECTING TO THE ARES/Data DATABASE STATION
  41.  
  42.     TNC SETTINGS FOR REMOTELY CONNECTED PACKET STATIONS:  These are
  43.     quite inportant for efficient operation of the network!
  44.     Use the commands appropriate for your type of TNC:
  45.  
  46.            TAPR, AEA, PACCOMM:                     WA8DED:
  47.            DWAIT 25 (250 MS)                      * W 25 (250 MS)
  48.            MAXFRAME 1                             * O 1
  49.            FRACK 10 (10 SEC)                      * F 10 (10 SEC)
  50.            RETRY 10                               * N 10
  51.            AX25L2V2 ON                            * V 2
  52.            RESPTIME 10 (1.0 SEC)                  * @T2 100
  53.            TXDELAY 40 (400 ms)                    * T 40 (400 ms)
  54.  
  55.     NOTE: Set paclen larger than the longest input line you expect to use.
  56.     For example, if you will have 4 20-character fields plus an 80 char.
  57.     message, then to include four commas use
  58.            PACLEN 164
  59.  
  60.     Next, using the ARES/Data callsign that has been chosen by the sysop,
  61.     simply initiate a connection.
  62.  
  63.     (Note: if the sysop is running a G8BPQ switch at the main database
  64.     station, this first connect will be to the switch.  Usual commands
  65.     like NODES, ROUTES, etc. are available.  In addition, a new command,
  66.     ARESDATA, will connect you to the ARES/Data application.)
  67.  
  68.     After a successful connect, acknowledged by "ARES/Data System
  69.     Online", you may begin to interact with the database or use the
  70.     conference bridge.  By the way, always be patient in waiting for a
  71.     response from the system - as you can see from the diagram above,
  72.     there may be a large number of operators using the system, and at
  73.     1200 baud, you may have to wait for responses at times.  If you are
  74.     collecting information from a group of voice operators (see Section
  75.     D.4), activate your voice net on the designated simplex frequency if
  76.     needed.  Note that in this case the packet operator needs two
  77.     antennas (one for packet and one for voice) with the antennas
  78.     arranged to eliminate de-sense (unless the packet portion is set up
  79.     on an alternate band, which is preferable).
  80.  
  81.  
  82. B.  WHAT INFORMATION IS STORED IN THE DATABASE
  83.  
  84.     ARES/Data organizes the incoming data into "records", which you can
  85.     view as a group of pieces of information about some particular
  86.     person, place, or thing.  Each record is given a unique "record
  87.     number" by the program.  Here is what can be stored in each record:
  88.  
  89.                   field1,field2,field3,field4,message
  90.  
  91.     where each of fields 1-4 can be a 20-character string, and the
  92.     message string can be 80 characters long.  The distinction between
  93.     the "fields" and the "message" is that the "fields" are organized
  94.     internally by the program so that the packet operator can request
  95.     searches and summaries on the information in any one of the four
  96.     fields.  Searches and summaries cannot be performed on the
  97.     information in the message field.
  98.  
  99.     If this sounds a little abstract, don't worry.  It is one of the
  100.     major virtues of the system that the meaning of the stored
  101.     information is not defined in advance.  In this manner, ARES/Data
  102.     can be used in a variety of ways, depending upon the particular
  103.     disaster or emergency at hand.  In a given event, the sysop can
  104.     issue a "labels" command that gives particular meaning to each of
  105.     the fields and the message, so that all know how ARES/Data is being
  106.     used for that event.
  107.  
  108.     For example, in an evacuation, you may want to keep track of
  109.     evacuees at shelters.  Then you may want the fields to mean:
  110.  
  111.     Name, Shelter, Status, PhoneNumber, Contact person.
  112.  
  113.     On the other hand, if there is a multiple-casualty incident, you may
  114.     want the fields to mean:
  115.  
  116.     Triage number, Sex/Age, Ambulance, Hospital, Condition.
  117.  
  118.     See the paper on ARES/Data in the 7th ARRL Computer Networking
  119.     Conference Proceedings (1988) for more examples.
  120.  
  121.  
  122. C.  GENERAL RULES FOR CURRENT INFORMATION INPUT
  123.  
  124.     Enter the four fields and any message, in order, with separators
  125.     between the fields.  The only valid separator is the comma.  Within
  126.     a field, leading and trailing blanks are ignored, but imbedded
  127.     blanks ARE significant.  If no value is desired for a particular
  128.     field, just skip the field by adding an extra comma.  The database
  129.     will fill that field with ten blank characters.
  130.  
  131.  
  132. D.  SYNTAX FOR CURRENT INFORMATION INPUT:
  133.  
  134.                   field1,field2,field3,field4,message<cr>
  135.  
  136.     (<cr> means carriage return)
  137.  
  138.  
  139.   1.  FIELD1 - FIELD4
  140.  
  141.       The four fields are very general.  Each can have up to 20
  142.       characters, with imbedded blanks.  Entries can be in upper
  143.       or lower case, or a mixture, but are converted to UPPER case
  144.       before being stored in the database.  The meaning of each field is
  145.       defined in real-time by the ARES officials, depending upon the
  146.       nature of the event.  The sysop can issue a "labels" command that
  147.       will give specific names to each of the four fields to help the
  148.       operators remember what they mean.  Similarly, the remote packet
  149.       operator can type "labels<cr>" to see the current label
  150.       definitions.
  151.  
  152.   2.  MESSAGE
  153.  
  154.       MESSAGE is a free-form field that can be up to 80 characters long.
  155.       It could contain a message, a phone number, an address, or other
  156.       information deemed useful for the incident.
  157.  
  158.       AUTOMATIC ORIGIN FEATURE:
  159.  
  160.       When a record is initially entered into ARES/Data, the callsign of
  161.       the originating station is automatically added to the beginning of
  162.       the message field in the format "<W1AW>   rest of message here   ".
  163.       This origin identifier automatically changes if another station
  164.       alters the record later.  As a result of this, the effective length
  165.       of the message field is 80 minus the number of characters in the
  166.       origin identifier, which is usually more like 72 characters.
  167.  
  168.   3.  EXAMPLES OF DATA INPUT
  169.  
  170.             4085553195,joe,12,sj34<cr>
  171.             Johnson,mary,93445,sj13, home 2333 Alsace Ln SJ 617-555-1212<cr>
  172.  
  173.       All of the input information is stored in the database
  174.       as a record of the status and location of a particular person,
  175.       place, or thing at a particular time and date.  The time and date
  176.       are added automatically by the ARES/Data program.  Further STATUS INPUT
  177.       packets for the same person, place, or thing will also be saved
  178.       in the database.  The time and date will identify the most recent
  179.       information.
  180.  
  181.   4.  DETAILED EXAMPLE INPUT TO THE ARES/Data DATABASE
  182.  
  183.       Suppose that the four fields have been defined to be:  LAST NAME,
  184.       FIRST NAME, SHELTER NUMBER, and basic physical CONDITION.  This
  185.       example also assumes that a voice operator is telling the packet
  186.       operator what to type in.  If voice operators are not in use, the
  187.       packet operator simply types the information in directly.
  188.  
  189.       Voice Operator says:                        Packet Operator types:
  190.  
  191.       This is current info,                         (nothing)
  192.       The last name is Johnson                      Johnson,
  193.       The first name is Joe                         Joe,
  194.       The shelter is RS03 (Riverside Shelter 3)     RS03,
  195.       The condition is "okay"                       ok,
  196.       (optional) The message is "came with dog"     came with dog
  197.  
  198.       which should look like this on your terminal:
  199.  
  200.                 Johnson,Joe,RS03,ok,came with dog<CR>
  201.  
  202.       The ARES/Data Database will acknowledge your input, for example, by
  203.  
  204.                 "1450: data input accepted, #234."
  205.  
  206.       or, by sending an error message requiring a re-entry.  The
  207.       acknowledgment contains the current time and the record
  208.       number for that person's entry in the database.  Note that
  209.       the program adds the actual time and date to each entry, which you
  210.       can see when you list the record (see below).
  211.  
  212.       If you later enter more information for the same person, you
  213.       would re-enter the same last and first names, and then enter
  214.       new values for any other fields that have changed.  BOTH entries
  215.       will be kept as a sort of "audit trail" of what has happened to
  216.       that person.  Alternatively, you can just change the value in the
  217.       specific field that has changed (see the next section).
  218.  
  219.  
  220. E.  CORRECTING AND/OR UPDATING INFORMATION
  221.  
  222.     If you accidentally enter incorrect information into the database,
  223.     or if the information in a particular record has changed, you have
  224.     several options.  You can delete the entire record, or you can
  225.     change the value in a specific field of a specific record.
  226.  
  227.     1. DELETING A BAD RECORD:
  228.  
  229.       You can ask the sysop to delete the bad entry by typing:
  230.  
  231.            tell sysop ooops, typo. pse delete #234.<CR>
  232.  
  233.       OR, if the sysop has enabled the remote delete feature, you
  234.       can delete this entry yourself, and then re-enter the correct
  235.       data.  To do this, you first make sure you know the record number,
  236.       then use the delete command:  "d nnnn<CR>"
  237.  
  238.                 d 234<CR>
  239.  
  240.       This function is always enabled at the sysop keyboard.  Its use by
  241.       remotely connected packet stations is controlled initially by the
  242.       configuration file during program startup.  Thereafter, the sysop
  243.       can disable or enable this function as necessary.  Be extremely
  244.       careful in using this command!  Always list the record first
  245.       before deleting to be sure you have the right one.
  246.  
  247.     2. CHANGING (UPDATING) A PARTICULAR FIELD OF A PARTICULAR RECORD:
  248.  
  249.       The syntax for updating fieldm of record nnnn is:
  250.  
  251.       #nnnn,m=new text for fieldm<cr>
  252.  
  253.       where m = 1-4 for the first four fields, and m = 5 for the message.
  254.       For example, suppose you needed to change the value in field3
  255.       of record 235 to "shelter 9".  You would type:
  256.  
  257.       #235,3=shelter 9<cr>
  258.  
  259.       Note that when you correct or update a single field like this, the
  260.       time and date for the record are not changed.  ARES/Data responds
  261.       by showing you what the old values for record 235 were, and what
  262.       the new values are according to your update command.
  263.  
  264.  
  265. F.  INFORMATION THAT MAY BE REQUESTED FROM THE ARES/Data DATABASE
  266.  
  267.     The packet operator can request several types of searches of the
  268.     ARES/Data database.  S/he can request a search for a specific value
  269.     of any one of the four main fields.  In this case, the ARES/Data
  270.     program sends back to the packet operator a status report listing
  271.     all entries in the database having the specified value for the
  272.     selected field.  In addition, the operator can request a "wildcard"
  273.     search, which looks for any entries in a specific field that START
  274.     with a particular string.  The Packet Op can also request a summary
  275.     for any one of the four fields, which is a list of the number of
  276.     entries in the database for each distinct value of that field (see
  277.     Section H).  The operator can list single records in the database by
  278.     specifying the record number.
  279.  
  280.     For example, suppose that for a particular incident, the sysop has
  281.     designated field1 to be the person's last name.  Suppose the packet
  282.     operator needs to find the information on all people in the system
  283.     with a given last name.  The operator sends a search request for
  284.     field1, stating which last name s/he is interested in.  The
  285.     ARES/Data system will respond with all entries with the given name;
  286.     one line for every entry in the database matching that name.  If the
  287.     operator knows only the beginning of the name or if the name is
  288.     long, the wildcard search is very useful.
  289.  
  290.  
  291. G. SEARCH REQUESTS
  292.  
  293.   1.  SYNTAX FOR SEARCH REQUESTS
  294.  
  295.             /1,value<cr>                      for field 1
  296.             /2,value<cr>                      for field 2
  297.             /3,value<cr>                      for field 3
  298.             /4,value<cr>                      for field 4
  299.  
  300.                     or
  301.  
  302.             ?1,value<cr>                      for field 1
  303.             ?2,value<cr>                      for field 2
  304.             ?3,value<cr>                      for field 3
  305.             ?4,value<cr>                      for field 4
  306.  
  307.       This type of packet instructs the database machine to look in the
  308.       database for ALL entries with the same entry as "value" in the
  309.       specified field.  The string "value" must exactly match what was
  310.       originally typed in for the selected field, with leading and
  311.       trailing blanks removed, and without regard for case.  The initial
  312.       character of the search request can be "/" or "?" - use whichever
  313.       is most convenient.  The two formats are handled identically.  A
  314.       status report listing all information for each match is sent back
  315.       to the requesting packet station.  The first line gives the search
  316.       value and the field number.  At the end of the report, the line:
  317.  
  318.             "ARES/Data Search done at 1534, nn hits."
  319.  
  320.       is sent, which signifies no more information coming, and
  321.       that "nn" matches (or hits) were found in the database.
  322.  
  323.   2.  WILDCARD SEARCH OR PARTIAL SEARCH
  324.  
  325.       The syntax for a wildcard or partial search is:
  326.  
  327.         /n,val*<cr>
  328.  
  329.       where "n" is the field number (1-4), and "val*" means that you want to
  330.       search for all entries in fieldn that start with the characters
  331.       "val".  The response from the system is identical to that for an
  332.       exact search request.  This is very useful if a particular field
  333.       has been defined to hold more than one piece of information.  For
  334.       example, suppose field 1 is defined to be "Lastname-Firstname" so
  335.       that Bill Jones would be entered by the line:
  336.  
  337.       Jones-Bill, shelter3, OK, 444-555-1212, message<cr>
  338.  
  339.       Now if you did not know Mr. Jones' first name, you could still
  340.       search for him in the database by typing
  341.  
  342.       ?1,Jone*<cr>
  343.  
  344.       and you would retrieve all records whose first field began with
  345.       the characters "JONE".
  346.  
  347.   3.  DETAILED EXAMPLE OF SEARCH REQUEST
  348.  
  349.       Assume that the label definitions are the same as in D.4
  350.       above.  This example applies to a last name search request
  351.       (field1).
  352.  
  353.       Voice Operator says:                        Packet Operator types:
  354.  
  355.       This is a request for last name search        /1,
  356.       The name is johnson                           johnson
  357.  
  358.       which should look like this on your terminal:
  359.  
  360.                 /1,johnson<CR>
  361.  
  362.       The ARES/Data database will acknowledge your request by either
  363.       stating that there are no entries in the database for that value
  364.       for field1, or by sending a status report which looks like:
  365.  
  366.       Exact Search for value "JOHNSON" in Last name
  367.       Recno    DT/Time  Last name, First name, Shelter, Condition, Msg
  368.       234      23/1124  JOHNSON,JOE,RS03,OK,<W6ABC> CAME WITH DOG
  369.       ARES/Data Search done at 1530, 1 hits.
  370.  
  371.       Some versions of ARES/Data may have disabled the search features
  372.       for certain fields to save disk(ette) space and speed access.
  373.       (And for some situations, it won't make sense to be able to
  374.       search on any field).  If searches have been disabled, you will
  375.       get a message like this one:
  376.  
  377.       Cannot search on this field, index file not in use.
  378.  
  379.  
  380. H.  SUMMARY REQUESTS
  381.  
  382.       $1<cr>                      produces a  list of all distinct
  383.                                   values for field1, with the number
  384.                                   of entries in the database for each
  385.  
  386.       $2<cr>                      similar, except summarize on field 2
  387.       $3<cr>                      similar, except summarize on field 3
  388.       $4<cr>                      similar, except summarize on field 4
  389.  
  390.     For example, suppose field 3 were defined to be the shelter name.
  391.     After the packet operator types "$3<cr>", ARES/Data sends a summary
  392.     on field 3, which may be interpreted as a list of shelters, with the
  393.     number of people that have checked in to each shelter.
  394.  
  395.  
  396. I.  LISTING SPECIFIC ENTRIES (RECORDS) IN THE DATABASE
  397.  
  398.       l nnnn<cr>                  Lists record nnnn
  399.  
  400.       The response will be a short header showing the labels for the
  401.       various fields, and then the complete information for record nnnn.
  402.  
  403.       l nnn,mmm<cr>               Lists records numbered from nnn to mmm
  404.  
  405.       l all<cr>                   List ALL records in the database.
  406.  
  407.            WARNING: be careful with this command, as it may cause a
  408.            large number of packets to be sent on the channel.  You can
  409.            stop an undesired "list all" by simply disconnecting from the
  410.            ARES/Data machine.  This will cause no harm.  Then just
  411.            reconnect.
  412.  
  413.  
  414. J.  DOWNLOADING FILES
  415.  
  416.     You may download a file from a special public directory on the database
  417.     machine by typing:
  418.  
  419.          get filename<cr>
  420.  
  421.     This facility is intended to be used and controlled by the sysop in
  422.     the sense that s/he controls what is in the public subdirectory and
  423.     whether this feature is on or off.  One file that is currently
  424.     provided with ARES/Data is an "info" file, which gives more
  425.     information of interest to general users.  If the sysop has copied
  426.     this file to the public subdirectory, you can download it by typing:
  427.  
  428.          get info<cr>
  429.  
  430.     If the sysop deems that it is useful, this complete documentation
  431.     file can be downloaded by typing "get userman.doc<cr>", but please
  432.     remember that a lot of packets will be generated by this operation.
  433.  
  434.     To get a listing of the files available for downloading from the
  435.     public area, type
  436.  
  437.          dir<cr>
  438.  
  439. K.  CONFERENCE BRIDGE (roundtable - "users" and "tell" commands)
  440.  
  441. This feature allows any connected station to send messages to other
  442. connected stations or to the sysop.
  443.  
  444.   1.  Users command:
  445.  
  446.       The users command, in the form "users<cr>" or "u<cr>", returns a
  447.       list of the callsigns of currently logged-on packet stations.  The
  448.       response is of the form:
  449.  
  450.       Users at WN6I-1 (AX0):  N6KL  W6BB-3  W6XYZ  WB6MRQ-7
  451.       Users at WN6I-4 (DR0):  0:N6KL-3 1:N5BZK 3:AA4RE-12
  452.  
  453.       Note that there is one line for each port defined in the ARES/Data
  454.       system, so that you can see who is using which port.  The
  455.       callsigns used by ARES/Data for the verious defined ports do not
  456.       have to be identical.  After the database callsign, the port name
  457.       defined by the sysop during startup is shown in parentheses.  Note
  458.       also that for the DRSI packet adapter, several radios and even
  459.       several boards can be attached to the database machine.  All the
  460.       users connecting to the DRSI adapters are treated as being on one
  461.       port of the ARES/Data network.  You can refer specifically to the
  462.       user on DRSI sub-port 1 by putting a "1:" in front of the
  463.       callsign:  "1:N5BZK".  In general, however, this is not really
  464.       necessary, since as far as ARES/Data is concerned, "N5BZK" or
  465.       "BZK" will do just as well (see below).
  466.  
  467.   2.  Tell command:
  468.  
  469.       The Tell command allows connected packet stations to use ARES/Data as a
  470.       conference bridge, or roundtable.  The general format is:
  471.  
  472.       tell callsign message<cr>      or:
  473.       t callsign message<cr>
  474.  
  475.       For example:
  476.  
  477.       tell w6bb-3 The food truck just arrived at SJ12<cr>
  478.  
  479.       The message "The food truck just arrived at SJ12" is sent to the
  480.       connected station W6BB-3 prefaced by a time stamp and the call of the
  481.       station originating the tell command.  In this case, if the tell
  482.       command was sent by W6XYX,  W6BB-3 sees:
  483.  
  484.       1230 W6XYZ> The food truck just arrived at SJ12
  485.  
  486.       It is not necessary to enter the entire callsign - just the suffix or
  487.       some other substring will do.  If several connected callsigns contain the
  488.       substring, each station will get the message.  The special callsign
  489.       "*" or "all" is used to send a message to all connected stations.  The
  490.       special callsign "sysop" sends the message to the sysop at the ARES/Data
  491.       database station.
  492.  
  493. END USERMAN.DOC
  494.