home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / BUSCRD11.ZIP / BUSCARD.DOC < prev    next >
Text File  |  1995-03-15  |  26KB  |  566 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                          BUSINESS CARD DATABASE
  11.  
  12.                                   v1.1
  13.  
  14.                                    by
  15.  
  16.                               Al Lawrence
  17.  
  18.                             Sunrise-80  BBS
  19.                     (404) 256-9525 (28.8 v.34)
  20.                     (404) 705-9104 (28.8 v.34)
  21.                     (404) 256-9518 (VOICE: 9am-9:30pm EST) any day
  22.                             FIDO 1:133/410
  23.  
  24.  
  25.  
  26.  
  27.                  Copyright  1994 - 1995,   Al Lawrence
  28.                           All Rights Reserved
  29.  
  30.  
  31.                           Table of Contents
  32.                           -----------------
  33.  
  34.     Overview..........................................................  1
  35.     Installation......................................................  2
  36.     Configuration File Description....................................  3 
  37.     Color Codes.......................................................  4
  38.     Restrictions......................................................  5
  39.     Category File (BUSCARD.CAT).......................................  5
  40.     Welcome...........................................................  5
  41.     Purging Business Cards............................................  6
  42.     Database Exchange.................................................  7
  43.     Non-Standard COM Support..........................................  9
  44.     Multi-Node Setup.................................................. 10
  45.     File Transfer Protocols (PROTOCOL.DAT)............................ 11
  46.     Legalities........................................................ 12
  47.     Distribution...................................................... 12
  48.     Registration...................................................... 12
  49.     Misc.............................................................. 13
  50.  
  51.                                                                        Page 1
  52.                                 OVERVIEW
  53.                                 ________
  54.  
  55.  
  56.    The BUSINESS CARD Door is designed to allow callers to post Business Cards
  57.    in any of the unlimited categories you have set up. 
  58.  
  59.  
  60.  
  61.  
  62.  
  63.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  64.          created in the Classified Door directory.
  65.  
  66.  
  67.  
  68.                                                                        Page 2
  69.                               INSTALLATION
  70.                               ____________
  71.  
  72.  
  73.    Installation is fairly easy and straight forward. The following steps and
  74.    examples should have you up and running in a very short period of time.
  75.    It is assumed that you are familiar with setting up DOORS on your system.
  76.    To this end, only examples of the configuration file and Door batch file
  77.    (if required by your BBS software) are described.
  78.  
  79.    **** SHARE.EXE is REQUIRED! Place the word SHARE on a line by itself ****
  80.    **** in your AUTOEXEC.BAT file, anywhere after your PATH statement.  ****
  81.  
  82.       1) Create a directory to hold all BUSCARD files
  83.  
  84.       2) Unzip BUSCRDxx.ZIP into the the above directory
  85.  
  86.       3) Create a configuration file, with a name of your choice, or modify
  87.          the supplied BUSCARD.CFG file. You can do this manually with an editor
  88.          of your choice. The configuration file layout/description can be found 
  89.          further on in this document
  90.  
  91.       4) Create a batch file or modify the BUSCARD file supplied (if your BBS
  92.          software requires the use of a batch file to execute the door). A
  93.          description of this file follows:
  94.  
  95.             ECHO off
  96.             cd\BBS\DOORS\BUSCARD      Location of BUSCARD files
  97.             BUSCARD  BUSCARD.CFG      EXE filename and CFG filename (Name
  98.                                       used in creating file in #3 above)
  99.             CD\BBS
  100.             BOARD
  101.  
  102.  
  103.        5) When running more than one node, read MULTI-NODE SETUP further on
  104.           in this document.
  105.  
  106.  
  107.        6) Unzip BUSBATCH.ZIP, which contains working batch files examples for
  108.           some popular protocols.
  109.  
  110.                                                                        Page 3
  111.                     BUSINESS CARD DATABASE CONFIGURATION FILE
  112.  
  113.    **                       Location of system file (See Below)
  114.    SUNRISE-80 BBS           Your BBS Name
  115.    Al                       Sysop's First name
  116.    Lawrence                 Sysop's Last Name
  117. |-----------------------------------------------------------------------------|
  118. | READ!     1                        CommPort  \ These 2 lines are required   |
  119. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  120. |-----------------------------------------------------------------------------|
  121.    00000000                 Registration Number
  122.  
  123.    2                        Keyboard timeout value in Minutes
  124.  
  125.    WELCOME                  Name of the WELCOME file. CAN contain an extension.
  126.  
  127.    N                        Y = Allow use of HiASCII characters
  128.                             N = Do NOT allow the use of HiASCII characters
  129.  
  130.    N                        Y = Use ALIAS in lieu of the BBS Logon Name.
  131.                                 (Requires DOOR.SYS)
  132.                             N = Use normal BBS LogonName
  133.    
  134.    Y                        Y = Allow Downloading, N = NO Downloading
  135.    
  136.    9                  *     Business Card border color
  137.  
  138.    14                 *     Business Card TOP LINE color
  139.  
  140.    11                 *     Business Card MIDDLE LINES color
  141.  
  142.    14                 *     Business Card BOTTOM LINE color
  143.  
  144.    11                 *     Business Card FREE FORM VERBAGE color
  145.  
  146.    30                       If NOT using a CATEGORY file then this is the
  147.                             number of days to keep a CARD entry, before it 
  148.                             becomes eligible for purging.
  149.                             0 = Do NOT purge any entries.
  150.  
  151.    SUN80                    Name of the EXPORT file that is generated by the
  152.                             BUSEXCH program. We suggest that it be a unique 
  153.                             name. DO NOT include an extension! Maximum of 6 
  154.                             characters ONLY
  155.  
  156.  
  157.  * = See next page for valid color codes
  158.  
  159. ** = Replace with a PATH to ONE of the following:
  160.    PCBOARD.SYS    CALLINFO.BBS   USERINFO.DAT    DOOR.SYS   GTUSER.BBS
  161.    DORINFOx.DEF   SFDOORS.DAT
  162.  
  163.  
  164.                                                                        Page 4
  165.                              C O L O R  T A B L E
  166.                             ======================
  167.  
  168.                         COLOR # - NAME       INTENSITY 
  169.                         -------------------------------
  170.                         0 - BLACK              Low              
  171.                         1 - BLUE                "                                   
  172.                         2 - GREEN               "                                   
  173.                         3 - CYAN                "                                   
  174.                         4 - RED                 "                                   
  175.                         5 - MAGENTA             "                                   
  176.                         6 - YELLOW              "                                   
  177.                         7 - WHITE               "                                   
  178.                         8 - GRAY               High              
  179.                         9 - LBLUE               "                
  180.                        10 - LGREEN              "                
  181.                        11 - LCYAN               "                
  182.                        12 - LRED                "                
  183.                        13 - LMAGENTA            "                
  184.                        14 - LYELLOW             "                
  185.                        15 - LWHITE              "                
  186.  
  187.  
  188.                                                                        Page 5
  189.                             RESTRICTIONS!
  190.                             -------------
  191.  
  192.  
  193. UnRegistered versions of BUSINESS CARDS have the following restrictions:
  194.  
  195.           . Maximum of 15 Business Cards may be entered
  196.           . Purge option is disabled
  197.           . Unable to IMPORT or EXPORT Business Cards
  198.  
  199.  
  200.  
  201.                         
  202.                         CATEGORY FILE (BUSCARD.CAT)
  203.                         ---------------------------
  204.        *** Note: If you do NOT wish to use a category file then you must ensure 
  205.        that the BUSCARD.CAT file is NOT present in the Door directory. ALL 
  206.        Business Cards will be grouped under ONE category called Miscellaneous. 
  207.        If this is your choice, then be sure to set the CFG entry that controls 
  208.        the number of days to keep the Cards before being eligible for purging.
  209.  
  210.        Be sure to give a lot of thought to your choice of categories, since
  211.        the category number in this file is carried in each Ad record. This
  212.        means, if you set up the categories so that #2 was 'Plumbing' and the 
  213.        caller entered a Business Card under that category, the Card would carry 
  214.        category #2 as the category number. If you then decide that you want to 
  215.        change the 'Plumbing' category to say, 'Accounting', then the Cards 
  216.        carrying #2 in their record would be classified incorrectly.
  217.  
  218.                The format of the BUSCARD.CAT file follows:
  219.  
  220.                              TTTTTTTT,UU
  221.  
  222.                Where t = Category name. Max length: 20 characters (NO COMMAS)
  223.                      
  224.                      u = Maximum number of days a Card can remain active.
  225.                          Minimum Days: 1 and Maximum Days: 9999
  226.  
  227.                              
  228.                              
  229.                              
  230.                              WELCOME  File
  231.                              -------------
  232.                              
  233.       You can define the name of the WELCOME file in the configuration file.
  234.       If the program finds that filename, it will display that file after
  235.       the opening screen and before the main menu screens. The file must
  236.       reside in the same directory as BUSCARD.EXE
  237.  
  238.   
  239.                                                                        Page  6
  240.                            
  241.                            AUTOMATED PURGING
  242.                            -----------------
  243.  
  244.  
  245.  
  246.       When you set up the categories to be used in your version of BUSINESS 
  247.       CARDS, you are asked to define the number of days the Card should remain 
  248.       active. By running the BUSMAINT (PURGE option) program in your nightly 
  249.       event process you will ensure that the Cards are deleted, automatically.
  250.  
  251.       The following is all that is required to execute the purge:
  252.  
  253.                          BUSMAINT BUSCARD.CFG /EVENT
  254.                                   ^^^^^^^^^^^
  255.                                      |
  256.                                      |------ or your congfiguration file name
  257.  
  258.           Note: This is only available in registered versions!
  259.  
  260.  
  261.   
  262.                                                                        Page 7
  263.                      DATABASE EXCHANGE  (BUSEXCH.EXE)
  264.                      ________________________________
  265.  
  266.      *** NOTE: This program is included with the Business Card registration
  267.  
  268.  
  269.   ** A GREAT WAY TO SHARE THE BUSINESS CARDS DATABASE BETWEEN 2 OR MORE BBS' **
  270.      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  271.       The Business Card Database Exchange program will allow you to participate 
  272.       in the exchange of Business Card databases with other BBS' (Any number of 
  273.       BBS' can participate). The exchange program is named BUSEXCH and comes 
  274.       included in the BUSCRDxx.ZIP file.
  275.  
  276.       BUSEXCH performs three (3) major functions:
  277.  
  278.      (1) EXPORT:  Extracts all active Cards from the Business Card database. 
  279.                   It creates files named XXXXXXrr.CXP (XXXXXX is defined in the 
  280.                   CFG file, rr is a random letter/number combination) and will 
  281.                   bypass any Card already flagged for deletion as well as those 
  282.                   Cards that were previously exported.
  283.  
  284.      (2) IMPORT:  Imports files named XXXXXXrr.CXP (XXXXXX is defined in the CFG
  285.                   file, rr is a random letter/number combination) created by the
  286.                   EXPORT option and merges all Cards into the Business Card 
  287.                   database. It will not import any Cards that duplicate Cards 
  288.                   found in the existing database. NOTE that this option will 
  289.                   IMPORT ALL files with an extension of CXP during a single 
  290.                   execution of the program.
  291.  
  292.      (3) IMPEXP:  This option will first IMPORT (as in (2) above) then turn
  293.                   around and EXPORT (as in (1) above) during one execution
  294.                   of the program.
  295.  
  296.      All BBS' involved in the exchange MUST run a registered version of 
  297.      BUSINESS Cards.
  298.  
  299.      It is critical that ALL participants in the exchange use the SAME
  300.      Category file. Failure to do so will result in Cards meant for a certain
  301.      category on one system, showing up in a category totally unrelated on
  302.      another system.
  303.  
  304.  
  305.                             (Continued on Next Page)
  306.  
  307.  
  308.                                                                        Page 8
  309.                         DATABASE EXCHANGE (Continued)
  310.  
  311.  
  312.      To run the Exchange you do the following:
  313.  
  314.     *************************************************************************
  315.     * >>>>> If you are acting as a HUB you MUST signal BUSEXCH.EXE by using *
  316.     *       HUBEXPORT, HUBIMPORT or HUBIMPEXP in lieu of EXPORT, IMPORT or  *
  317.     *       IMPEXP. If you fail to do this you will not be able to export   *
  318.     *       newly imported Cards.                                           *
  319.     *************************************************************************
  320.  
  321.      EXPORT:  a) Change to the directory containing your BUSCARD.DAT file
  322.               b) Issue this command:  BUSEXCH EXPORT BUSCARD.CFG
  323.                  If you use a different name for your Config file, then
  324.                  substitute that name for BUSCARD.CFG
  325.               c) Send (transmit) ALL *.CXP files to those involved in the 
  326.                  exchange or to the HUB.
  327.               d) Delete ALL .CXP files.
  328.  
  329.      IMPORT:  a) Change to the directory containing your BUSCARD.DAT file
  330.               b) Copy the *.CXP files that were sent to you by the
  331.                  BBS you are exchanging with, to the directory used
  332.                  in item (a) above.
  333.               c) Issue the command:   BUSEXCH IMPORT BUSCARD.CFG
  334.                  If you use a different name for your Config file, then
  335.                  substitute that name for BUSCARD.CFG
  336.               d) Delete ALL *.CXP files
  337.  
  338.      IMPEXP:  a) Change to the directory containing your BUSCARD.DAT file
  339.               b) Copy the *.CXP files that were sent to you by the
  340.                  BBS you are exchanging with, to the directory used
  341.                  in item (a) above.
  342.               c) Issue the command:   BUSEXCH IMPEXP BUSCARD.CFG
  343.                  If you use a different name for your Config file, then
  344.                  substitute that name for BUSCARD.CFG
  345.               d) Send (transmit) ALL *.CXP files to those involved in the 
  346.                  exchange or to the HUB.
  347.  
  348.  
  349.    NOTE: If you wish to EXPORT ALL Cards in the database regardless of whether
  350.          they have been previously exported, you can use the /ALL switch on the 
  351.          BUSEXCH command line. It can only be used with HUBIMPORT, HUBEXPORT or 
  352.          HUBIMPEXP and MUST be the last entry on the command line.
  353.  
  354.    NOTE: All IMPORT and EXPORT transactions are recorded in a file called 
  355.          BUSEXCH.LOG. If the file exists it will append the information, if not 
  356.          it will create the file and add the information. Thus you are free to 
  357.          delete it at any time.
  358.  
  359.  
  360.                                                                        Page  9
  361.                         NON-STANDARD COM SUPPORT
  362.                         ________________________
  363.  
  364.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  365.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  366.       number after the configuration filename. Let's assume your Door is
  367.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  368.       passed to your Door would be:
  369.  
  370.                             FOOBAR FOOBAR.CFG /5
  371.  
  372.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  373.       normally used with COM1. No /x parameter is needed for the standard
  374.       IRQ's.
  375.  
  376.       As an alternative, you may use an environmental variable on the command
  377.       line. To use the variable (following the example above), place a
  378.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  379.       different IRQ number for each node). The command line would now look
  380.       like this:
  381.  
  382.                           FOOBAR FOOBAR.CFG /%IRQ%
  383.  
  384.       This, in combination with the use of the environmental variables
  385.       described in the MULTI-NODE SETUP section will allow you to use one
  386.       batch file and one config file to run this door on all nodes.
  387.  
  388.  
  389.  
  390.   
  391.                                                                        Page  10
  392.                            MULTI-NODE SETUP
  393.                            ________________
  394.  
  395.       All Sunrise Doors are Multi-Node capable. Each node must have the
  396.       ability to access a configuration file which will have its own system
  397.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  398.       line. There are 2 ways to accomplish this:
  399.  
  400.       (1) Create a separate configuration file for each node. The only
  401.           difference between each file would be the location of the system
  402.           file for that particular node. For example, on my system there are 2
  403.           nodes and the first line of the config files would look like this:
  404.  
  405.                         NODE1:  H:\PCB1\DOOR.SYS
  406.                         NODE2:  H:\PCB2\DOOR.SYS
  407.  
  408.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  409.  
  410.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  411.           the following PCBoard/Wildcat environmental variables:
  412.  
  413.                  PCBDIR    (Directory containing the System file)
  414.                  PCBDRIVE  (Drive containing the System file)
  415.                  WCNODEID  (Active Node Number)
  416.  
  417.           Thus, the first line of the SINGLE configuration file, for this Door
  418.           would look like this:
  419.  
  420.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  421.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  422.  
  423.       NOTE: This option, as described, assumes that you are running PCB or
  424.             Wildcat software. The environmental variables are automatically
  425.             created by the software for each node.
  426.  
  427.             HOWEVER, if you are running other BBS software you should be able
  428.             to set the variables EXACTLY as described below, for EACH node
  429.             (more than likely in each batch file you use to bring up EACH node):
  430.  
  431.                             PCBDRIVE=C:
  432.                             ^^^^^^^^^
  433.                             PCBDIR=\NODE2
  434.                             ^^^^^^^^
  435.  
  436.             Info with a carat (^) under it, MUST be typed as is. The rest
  437.             depends on your naming conventions.
  438.  
  439.             This, in combination with the use of the optional environmental
  440.             variable described in the NON-STANDARD COM SUPPORT section, will
  441.             allow you to use one batch file and one config file to run this
  442.             door on all nodes.
  443.  
  444.  
  445.  
  446.                                                                        Page  11
  447.                    DOWNLOAD FILE TRANSFER PROTOCOLS
  448.                    --------------------------------
  449.  
  450.       BUSINESS CARDS externalizes all file transfer protocols used for 
  451.       Downloading of the Business Cards. This allows the Sysop to define the
  452.       file transfer protocols they wish to support.
  453.  
  454.       A file called PROTOCOL.DAT is supplied with protocols already defined,
  455.       which you may alter at any time. Each entry in the PROTOCOL.DAT file
  456.       consists of the description that will be displayed to the caller on the
  457.       Protocol Menu and the 'high level' name of the protocol's batch files.
  458.  
  459.                Example:  ZModem   Upload or Download, ZPROT
  460.  
  461.       The information to the left of the comma is the description. Business 
  462.       Cards requires that you have a batch file in the Business Cards directory
  463.       to handle the downloading. In the above example ZPROT is the 'high level'
  464.       portion of the batch file name required for ZMODEM. Your Business Card
  465.       directory should contain ZPROTS.BAT (the S is for downloading). The S
  466.       suffix MUST be present as that is what Business Cards will be looking for
  467.       in the Business Cards directory!
  468.  
  469.       Each protocol batch file MUST contain 2 batch file variables as follows:
  470.  
  471.       %1 = Business Cards will use this variable to substitute the current 
  472.            ComPort
  473.       %2 = Business Cards will use this variable to substitute the file name
  474.  
  475.       IMPORTANT! Place the variable (%1 and %2) ONLY in the EXACT location that
  476.                  your protocol requires them, in the protocol command line. Do
  477.                  NOT supply the ComPort or FileName, JUST the %1 and %2
  478.                  variables themselves (%1 and %2)!
  479.  
  480.       See example batch files supplied with the Business Cards. They are the 
  481.       ones being used on the Sunrise-80 BBS.
  482.  
  483.                              *** PLEASE NOTE ***
  484.  
  485.       There may come a time when you will need to supply information to the
  486.       protocol you are using, based on the node it will be used on. You can
  487.       accomplish this by supplying a node-specific PROTOCOL file. Everything
  488.       described above stays the same except that you will name the file
  489.       PROTOCOL.x (where x is the node number). For example, to use a special
  490.       set of protocols (or batch files) on node number 5, modify a copy of
  491.       PROTOCOL.DAT and name it PROTOCOL.5. Business Cards will use PROTOCOL.5 
  492.       when someone logs on node 5 and will use PROTOCOL.DAT for ALL OTHERS. You 
  493.       do not have to create node-specific PROTOCOL files for all nodes.. just 
  494.       the node(s) that are different.                                          
  495.       
  496.    
  497.                                                                        Page 12
  498.                               LEGALITIES
  499.                               __________
  500.  
  501.  
  502.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  503.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  504.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  505.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  506.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  507.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  508.       OR BREACH OF ANY WARRANTY.
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.                              DISTRIBUTION
  517.                              ____________
  518.  
  519.    You may make this file available for downloading from your BBS or you may
  520.    upload it to any BBS of your choice, provided that you do not make any
  521.    changes to the contents of the archive (ZIP file). The archive and its
  522.    individual contents may not be used by any service that charges any money
  523.    whatsoever, without the written permission of the author.
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                              REGISTRATION
  533.                              ____________
  534.  
  535.    Registration and the subsequent insertion of the registration number into
  536.    your configuation file, will remove all restrictions deined in the section
  537.    called "Restrictions', allows for the display of your BBS name on the
  538.    opening and closing screen
  539.  
  540.    To register your copy of BUSINESS CARDS, please fill out the registration 
  541.    form (REGISTER.FRM) and mail it along with the registration fee to the name
  542.    and address on the form.
  543.  
  544.    Once a door is registered, any changes to registration information (Sysop
  545.    name or BBS Name) will require the doors to be re-registered at the
  546.    registration fee in effect at that time.
  547.  
  548.    Be sure to use the proper upper/lower case when filling in your name and
  549.    BBS name, as they MUST match the way you entered them in the configuration
  550.    file.             ^^^^
  551.  
  552.    Based upon information supplied on the registration form, I will pre-
  553.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  554.    up your registration number OR you can enclose a SASE with the form/check.
  555.  
  556.                                                                        Page 13
  557.                                  MISC
  558.                                  ____
  559.  
  560.    The latest version of BUSINESS CARDS and other fine SUNRISE DOOR programs
  561.    are always available for download from SUNRISE-80 BBS.
  562.  
  563.    Remember, should you have any problems, questions or suggestions, be sure
  564.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  565.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  566.