home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / comm / misc / 005 / examples.doc < prev    next >
Encoding:
Text File  |  1992-01-18  |  18.5 KB  |  337 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.              EXAMPLES.DOC  Example BBS Information File (BIF) Setups.
  7.        Copyright (C) 1991-1992 Liberation Enterprises.  All rights reserved.
  8.  
  9.      This document provides step-by-step example setups of Intellicomm,
  10.      including automation of a MegaMail/Qmail-type system, then an outline of
  11.      file download automation (auto-collection of files from BBS's).
  12.  
  13.      The example is meant to be used after you are relatively familiar with
  14.      Intellicomm, in that you have read QWIKSTRT.DOC and understand the
  15.      purpose of BIFs, know how to go about editing them from within
  16.      Intellicomm, and understand auto-logons.  If you haven't read
  17.      QWIKSTRT.DOC as yet, please do so -- there is important setup
  18.      information there that can be browsed fairly quickly, and will help you
  19.      avoid common setup errors.
  20.  
  21.      WHY DOESN'T INTELLICOMM JUST SET ITSELF UP?
  22.  
  23.      If we had it our way (and hopefully someday we will), you wouldn't have
  24.      to set anything up at all ... aside from your name/password a few BBS
  25.      phone numbers.  But given the current BBS situation, and the quite often
  26.      bizarre differences from one BBS to the next, this just isn't possible.
  27.  
  28.      A full auto-learn mode (having the program watch what you do online,
  29.      then copy it) was considered and dismissed, simply because auto-learned
  30.      tasks end up oblivious to unexpected errors.  Auto-learned "scripts"
  31.      know only exactly what you did online at one particular time, and
  32.      anything that happens outside those boundaries will cause the
  33.      task/script to fail.  Intellicomm does not suffer from this shortcoming,
  34.      and using properly defined BIFs it can handle virtually any error that
  35.      occurs -- leaving you with fewer worries about leaving the program
  36.      unattended.  As well, some automated tasks Intellicomm handles (auto-
  37.      up/downloads, for example, which have variables such as filenames, and
  38.      must watch for somewhat obscure error messages) are just too involved
  39.      for an auto-learned script to handle, period.
  40.  
  41.      PRE-DEFINED BIFS
  42.  
  43.      The first step in setting up a BIF is always to look on the BBS to see
  44.      if the BBS Operator, Liberation Enterprises, or a helpful Intellicomm
  45.      user has already set one up and has uploaded it to the BBS for everyone
  46.      to use.  Log onto the BBS and attempt to download a file called
  47.      ICOMBIF.ZIP (.ZIP being the compression type used on the BBS; could also
  48.      be .LZH, .PAK, etc).  If a pre-defined BIF exists, most of it should
  49.      already be set up properly and you just check the port settings, enter
  50.      your name and password, and you're done!  Be sure to see any README
  51.      files that come with the .BIF though ... and make sure you read the BBS
  52.      Notes in the BIF Editor.  There may be special setup tips there.
  53.  
  54.      AUTO LOGONS
  55.  
  56.      Without a pre-defined BIF available, configuration for automated
  57.      session/auto-logon always starts with the BIF "Logon" screen, then moves
  58.      to one or more of the other screens, depending on what it is you're
  59.      trying to automate.  Auto-logon setup tips/techniques are discussed in
  60.      QWIKSTRT.DOC, so please refer to the "BBS DIRECTORY/BIF FILES" section
  61.      of that document now if you haven't done so already.  Return here when
  62.      you complete an auto-logon successfully.
  63.  
  64.  
  65.  
  66.  
  67.      Intellicomm v0.94             EXAMPLES.DOC                             2
  68.      
  69.      
  70.  
  71.      MEGAMAIL/QMAIL-TYPE MESSAGE RUN SETUP
  72.  
  73.      The first step in setting up Intellicomm for use with MegaMail/Qmail-
  74.      type systems (which includes most: Kmail, MarkMail, NetMail, PCRelay,
  75.      Rosemail, TomCat, and others) is to set up the mail system itself and
  76.      select the message areas you're interested in.  Instructions on specific
  77.      mail system setups come with the documentation for offline readers that
  78.      support the system (MegaReader for MegaMail, Qmail DeLuxe, SLMR, EZ-
  79.      Reader or MegaReader again for Qmail/MarkMail/Tomcat, etc).  If you
  80.      haven't chosen an offline reader yet (most are available as Shareware on
  81.      BBS's), you're getting ahead of yourself trying to set up Intellicomm to
  82.      automate the mail transfer process.  It would be like trying to learn
  83.      how to change a tire before finding out what a car is...  After you
  84.      select an Offline Reader, set the reader up by following its
  85.      documentation (usually quite easy -- IF you follow the instructions),
  86.      then perform at least one mail transfer manually and continue below.
  87.  
  88.      Once you have the reader set up, and have downloaded a message packet,
  89.      start Intellicomm, select "BBS Dir", hilight the proper template for the
  90.      type of BBS (MegaMail runs on multiple BBS types;  others run on one BBS
  91.      [PCBoard or Wildcat] only), and select "Create".  If any BBS notes are
  92.      displayed, please make sure to follow them or you may run into
  93.      substantial difficulties.  Esc exits from the notes.
  94.  
  95.      Enter the proper BBS Name, phone numbers, and port settings on the first
  96.      screen, then press TAB to move to column two, hilight "Message Type" and
  97.      select "Edit" (note that we are filling in the usual items with an arrow
  98.      > after their description).  Select the proper message type (Qmail,
  99.      MegaMail, etc.), from the menu -- and take NOTE of what the screen tells
  100.      you do to in the reminder below.  If you don't read screens you will
  101.      miss out on many tips.  Press PgDn to change to the next screen when
  102.      ready.
  103.  
  104.      Enter the name you use to logon the BBS (if necessary... you should
  105.      later change the template itself and add your own name right there to
  106.      save time) and BBS password, and the response for "English" or "Standard
  107.      BBS mode" in the Mode/Language item, if applicable.  (Again, note that
  108.      we are filling in the items with arrows.)  If using a Wildcat BBS you
  109.      must also enter your birthdate/home phone # in the two "Extra" commands
  110.      (left column) near the bottom of the screen.  Replace the MMDDYY with
  111.      your month, day, year of birth and 1235551234 with the area code,
  112.      exchange and your home (voice) phone #.  Both of these items are entered
  113.      in your initial logon to the Wildcat BBS, but Wildcat feels that it's
  114.      necessary for you to re-enter the information every once in a while...
  115.      so Intellicomm must be able to do so for automation.  Just one of the
  116.      many handy-dandy uses for the BIF "Extra" commands/prompts.
  117.  
  118.      Please press PgDn to move to the next screen when ready.
  119.  
  120.      Enter the proper "Access Msg Menu" command to access the message door on
  121.      the BBS, if applicable (not necessary on Wildcat... the same command is
  122.      used from one BBS to the next to access Tomcat doors).  QMAIL
  123.      V4/ROSEMAIL USERS:  The ;PROMPTS command following the door command is
  124.      only necessary if you do NOT have the door set up to use "extended
  125.  
  126.  
  127.  
  128.  
  129.      Intellicomm v0.94             EXAMPLES.DOC                             3
  130.      
  131.      
  132.  
  133.      prompts" for scripting.  Enter the Qmail door, select C]onfigure, and
  134.      toggle the proper OPTion to turn extended prompts on and you may then
  135.      remove ;PROMPTS from the access menu command.
  136.  
  137.      Next, replace the BBSID in the Reply/Msg Filenames with the proper ID of
  138.      the BBS.  The ID is available by looking at a message packet from the
  139.      BBS; if the packet is called ABBS.DL, then you would replace BBSID with
  140.      ABBS.  E.g. BBSID.UL, BBSID.DL would be changed to ABBS.UL, ABBS.DL
  141.      [MegaMail],  BBSID.REP, BBSID.QWK would be changed to ABBS.REP, ABBS.QWK
  142.      [Qmail].
  143.  
  144.      [ANOTHER] SPECIAL NOTE FOR USERS OF QMAIL-TYPE SYSTEMS:  Intellicomm has
  145.      'invisible' support to upload .PTR (pointer reset) files, and .KEY
  146.      (keyword include/exclude) files.  'Invisible' meaning that if either the
  147.      PTR or KEY files are found for the ID of a given BBS, the file is
  148.      uploaded before downloading new mail.  No switch is provided, simply
  149.      because we feel that these files should (and probably soon will) simply
  150.      be included with your .REP packet where they could be compressed and
  151.      wouldn't require separate uploads.  Only one or two mail systems require
  152.      these separate uploads (Qmail and Rosemail) and if/when the mail system
  153.      developers change this, an Intellicomm switch to upload the file will be
  154.      obsolete.  We prefer to wait for situation to be corrected, rather than
  155.      trying to design around what we feel is a poorly implemented feature in
  156.      the message system itself.
  157.  
  158.      If you don't want these files uploaded, simply make sure Intellicomm
  159.      doesn't find them in your Reply Directory:  Specifically you may delete
  160.      .PTR files by adding the command DEL *.PTR to your DELUXE.BAT file
  161.      (Deluxe auto-extracts .PTR files from each .QWK packet, which causes
  162.      Intellicomm to upload a PTR every time).  You can always get a .PTR file
  163.      if/when you need it by entering the DOS command:
  164.  
  165.      PKUNZIP <ID>.QWK <ID>.PTR
  166.  
  167.      (E.g. PKUNZIP ABBS.QWK ABBS.PTR)  Hopefully, though, these separate .PTR
  168.      and .KEY files will disappear, and can simply be uploaded all at once
  169.      with your replies, and neither you nor Intellicomm will have to worry
  170.      about them further.
  171.  
  172.      That's it for a normal setup for one of these mail systems.  Make sure
  173.      you also define your Message/Reply -directories- in the Intellicomm MAIN
  174.      Setup, on the "File/Path" screen, or it will not be able to locate your
  175.      packets.  You need only enter Message/Reply directories on the BIF
  176.      Message screen for special cases where you need a given packet to go to
  177.      a directory other than your main Message/Reply directory (the items were
  178.      provided for BBS Sysops who use Intellicomm for network mail).  Select
  179.      "eXit", enter a filename to save the BIF under, and you're ready to set
  180.      up a "job" for message transfers.  Setting up a job is very easy: 
  181.      "Create" from the Job Directory, hilight/"Select" the BIF you just
  182.      created, then enter 3 4 (send/get mail), select "eXit", and enter a job
  183.      description.  Then "Run" the job to transfer your mail.
  184.  
  185.      If you require more detailed information on Intellicomm Jobs or BIFs,
  186.      please refer to the main user's manual.
  187.  
  188.  
  189.  
  190.  
  191.      Intellicomm v0.94             EXAMPLES.DOC                             4
  192.      
  193.      
  194.  
  195.  
  196.      AUTOMATING FILE DOWNLOADS
  197.  
  198.      The process of automating file downloads (auto collection of files from
  199.      one or more BBS's) begins with obtaining a listing of new files from the
  200.      BBS, then selecting the files you are interested in, and having
  201.      Intellicomm call the BBS back and pick up those files for you.
  202.  
  203.      The process is quite simple if you're using Intellicomm's File Tagger,
  204.      as it handles processing of the new files lists (*.NEW) and allows easy
  205.      browsing/selection of files.  If you aren't using the File Tagger,
  206.      things are a little more complicated, but certainly not as inconvenient
  207.      (and possibly expensive) as having to do things manually online.
  208.  
  209.      In either case, begin by "Create"ing one or more jobs in Intellicomm
  210.      comprised of the following tasks:
  211.  
  212.      Call <some BIF>
  213.        Get new files list
  214.        Get Files [Download]
  215.      Call <another BIF>         <<-- Optional... continue with as many CALLs
  216.        Get new files list            as you want.
  217.        Get Files [Download]
  218.  
  219.      Your job could do other things as well, but the above three are all you
  220.      need to automate downloads.  NOTE TO .QWK-COMPATIBLE MAIL USERS:  Qmail-
  221.      type doors (MarkMail, Qmail, Tomcat, etc.) can be configured to include
  222.      a new files listing with your message packets, and this SHOULD be used
  223.      wherever possible as it is faster than using the "Get new files list"
  224.      task.  Intellicomm will automatically extract the new files from the
  225.      .QWK packet, so you should substitute the "Get new files list" task with
  226.      "Get mail" and you'll get your mail and files list at the same time. 
  227.      You must enable the mail door to INCLUDE a new files list though, and
  228.      you may do this by logging on to the BBS manually, opening the mail door
  229.      and selecting [C]onfigure.  Just set the option to include a new files
  230.      list to ON or YES.  See the door's help screens if you can't find it.
  231.  
  232.      <Some BIF> would be a BIF that you'd set up with the proper BBS phone
  233.      numbers, port settings and your Logon name/password for the BBS.  As
  234.      always, try to manually download ICOMBIF.ZIP from the BBS to see if
  235.      there is already a pre-defined BIF for the BBS you're calling.  Make
  236.      sure you perform a manual "Dial" from the BBS Directory after entering
  237.      your password, to ensure that at least the auto-logon completes properly
  238.      (again, this is standard practice and should be the first step for any
  239.      new BBS you try to automate).
  240.  
  241.      Next, "Run" your automated job(s) to pick up new files lists from
  242.      whichever BBS(s) you're interested in.  The "Get Files [Download]" task
  243.      will be ignored this first run, since you haven't selected any files to
  244.      download yet.  If you're getting mail and new files at the same time
  245.      from a .QWK-compatible message system, then Intellicomm will auto-
  246.      extract the new files list when the session completes.
  247.  
  248.  
  249.  
  250.  
  251.      Intellicomm v0.94             EXAMPLES.DOC                             5
  252.      
  253.      
  254.  
  255.      After you disconnect, if the File Tagger is enabled in the main setup,
  256.      all new files will be imported into the NEWFILES catalog.  This process
  257.      can take some time on large listings, but the idea is to eventually
  258.      perform ALL of this unattended while you're doing something more
  259.      exciting (or sleeping).  Once you monitor it a couple of times, and are
  260.      sure it's working you can set a "Job starting time" in the job itself
  261.      (or use an external timer and the ICOM /Run:"Some jobs" switch... see
  262.      the main manual) and the time it takes to import new files listings to
  263.      the File Tagger will be irrelevant, since you won't be watching.
  264.  
  265.      Selecting files to download using the File Tagger is accomplished by
  266.      selecting "Tools" from the Job Directory, then "Tag files to download"
  267.      on the Tools menu (or by running TAGGER.EXE from the DOS command
  268.      prompt).  Detailed information on the File Tagger is available in the
  269.      main user's manual if you require it, but selecting files to download is
  270.      very easy.  Simply move the hilight bar with the usual cursor keys, then
  271.      select "Tag" (or press the space bar) to select/deselect a file.  When
  272.      done, you may eXit the Tagger immediately and needn't save your changes
  273.      to disk: all changes made to catalogs are saved to disk as they occur. 
  274.      The next time you "Run" your Intellicomm job with the "Get Files
  275.      [Download]" task included, the proper File Tagger catalog will be
  276.      scanned for tagged files for that BBS, and as many files as you have
  277.      time for will be automatically downloaded.  If you don't have time for a
  278.      given file, it is saved for your next automated download session on the
  279.      BBS.  All files you obtain will be copied to a second File Tagger
  280.      catalog called "FILELIST".  This catalog can then be used to "Tag files
  281.      for upload" from the Tools menu (or by entering TAGGER FILELIST from
  282.      DOS).
  283.  
  284.      If you do NOT have the File Tagger enabled, the new files lists can be
  285.      viewed using the "Tools", "File Lists" item.  New files listings use the
  286.      same base filename as the BIF and the extension .NEW (e.g. BIFNAME.NEW). 
  287.      It is recommended that you obtain Vern Beurg's "LIST" program, available
  288.      on most BBS's, to scan *.NEW files lists without the File Tagger.  Enter
  289.      LIST in the Intellicomm main setup, on the File/Path screen, in the
  290.      "File Viewer" entry, and you may then use the "View" option on the file
  291.      list menu to select a .NEW file list to view.
  292.  
  293.      With a .NEW list loaded into the LIST program for viewing, you use the
  294.      usual cursor keys to browse the file list, and when you see a file you
  295.      want to download, move it to the very top line and press [Alt-M] to
  296.      "mark" the line, then press [Alt-D] to "dump" the line to your
  297.      Intellicomm file list.  When asked for a filename, enter BIFNAME.GET ...
  298.      BIFNAME being the same name as used in the .NEW filename (i.e. if
  299.      browsing CRS.NEW, enter CRS.GET).  This .GET filename need only be
  300.      entered once per .NEW listing.  From now on when you see a file you want
  301.      to download, again move the line to the very top, press [Alt-M] to mark
  302.      it, but the second time just press [Alt-O] to dump to the SAME filename. 
  303.      So it's [Alt-M], [Alt-D] on the first file of each .NEW list, then [Alt-
  304.      M], [Alt-O] from then on. It's very quick and easy when you get the hang
  305.      of it.  NOTE that if you see an /Area: "switch" on the .NEW list, you
  306.      should also move that line to the top and mark/dump it to the .GET list. 
  307.      This will ensure that Intellicomm changes to the proper file area before
  308.      downloading the file.
  309.  
  310.  
  311.  
  312.  
  313.      Intellicomm v0.94             EXAMPLES.DOC                             6
  314.      
  315.      
  316.  
  317.      The next time you "Run" your job containing the "Get files [Download]"
  318.      task, Intellicomm will automatically download all files on the .GET
  319.      list.  Files you obtain are removed from the list for you while any
  320.      files you don't have time for will remain on the list for next time. 
  321.      All downloaded files/descriptions are copied to a special list called
  322.      FILELIST.TXT.  This file can then be used just like a .NEW list to
  323.      select files to "upload" (send) to another BBS.  While download lists
  324.      use a filename of BIFNAME.GET, upload lists use the name BIFNAME.SND
  325.      (snd for send).
  326.  
  327.      So, whether you use Intellicomm's File Tagger or create your .GET / .SND
  328.      lists manually, with either method you gain the advantage and
  329.      convenience of performing all the actual browsing/selection work
  330.      OFFLINE.  This way you are not wasting your valuable online time, nor
  331.      incurring long distance charges, nor tying up the BBS itself.  Note that
  332.      if you do use the File Tagger, you may also create/update .GET and .SND
  333.      lists using LIST or some other program (or manually with an editor).  In
  334.      fact, all the File Tagger does is create/update these lists adding the
  335.      filenames of all tagged files, when asked to do so by Intellicomm (i.e.
  336.      just before an automated file transfer).
  337.