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