home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
DOOR
/
BUSCRD13.ZIP
/
BUSCARD.DOC
< prev
next >
Wrap
Text File
|
1996-06-11
|
27KB
|
604 lines
BUSINESS CARD DATABASE
v1.3
by
Al Lawrence
Sunrise-80 BBS
(404) 256-9525 (USR v.everything 33.6)
(404) 705-9104 (USR v.everything 33.6)
(404) 256-9518 (VOICE: 9am-9:30pm EST) any day
EMAIL:al_lawre@ix.netcom.com
Copyright 1994 - 1995, Al Lawrence
All Rights Reserved
Table of Contents
-----------------
Overview.......................................................... 1
Installation...................................................... 2
Configuration File Description.................................... 3
Color Codes....................................................... 4
USAGE Log......................................................... 4
Restrictions...................................................... 5
Category File (BUSCARD.CAT)....................................... 5
Welcome........................................................... 5
Purging Business Cards............................................ 6
Database Exchange................................................. 7
Non-Standard COM Support.......................................... 9
Multi-Node Setup.................................................. 10
File Transfer Protocols (PROTOCOL.DAT)............................ 11
Legalities........................................................ 12
Distribution...................................................... 12
Registration...................................................... 12
Misc.............................................................. 13
Page 1
OVERVIEW
________
The BUSINESS CARD Door is designed to allow callers to post Business Cards
in any of the unlimited categories you have set up.
NOTE: Most errors will be logged to a file called DFRAME.ERR which is
created in the Classified Door directory.
Page 2
INSTALLATION
____________
Installation is fairly easy and straight forward. The following steps and
examples should have you up and running in a very short period of time.
It is assumed that you are familiar with setting up DOORS on your system.
To this end, only examples of the configuration file and Door batch file
(if required by your BBS software) are described.
**** SHARE.EXE is REQUIRED! Place the word SHARE on a line by itself ****
**** in your AUTOEXEC.BAT file, anywhere after your PATH statement. ****
1) Create a directory to hold all BUSCARD files
2) Unzip BUSCRDxx.ZIP into the the above directory
3) Create a configuration file, with a name of your choice, or modify
the supplied BUSCARD.CFG file. You can do this manually with an editor
of your choice. The configuration file layout/description can be found
further on in this document
4) Create a batch file or modify the BUSCARD file supplied (if your BBS
software requires the use of a batch file to execute the door). A
description of this file follows:
ECHO off
cd\BBS\DOORS\BUSCARD Location of BUSCARD files
BUSCARD BUSCARD.CFG EXE filename and CFG filename (Name
used in creating file in #3 above)
CD\BBS
BOARD
5) When running more than one node, read MULTI-NODE SETUP further on
in this document.
6) Unzip BUSBATCH.ZIP, which contains working batch files examples for
some popular protocols.
Page 3
BUSINESS CARD DATABASE CONFIGURATION FILE
** Location of system file (See Below)
SUNRISE-80 BBS Your BBS Name
Al Sysop's First name
Lawrence Sysop's Last Name
|-----------------------------------------------------------------------------|
| READ! 1 CommPort \ These 2 lines are required |
| READ! 1 Node # / ONLY for GTUSER.BBS |
|-----------------------------------------------------------------------------|
00000000 Registration Number
2 Keyboard timeout value in Minutes
WELCOME Name of the WELCOME file. CAN contain an extension.
N Y = Allow use of HiASCII characters
N = Do NOT allow the use of HiASCII characters
N Y = Use ALIAS in lieu of the BBS Logon Name.
(Requires DOOR.SYS)
N = Use normal BBS LogonName
Y Y = Allow Downloading, N = NO Downloading
9 * Business Card border color
14 * Business Card TOP LINE color
11 * Business Card MIDDLE LINES color
14 * Business Card BOTTOM LINE color
11 * Business Card FREE FORM VERBAGE color
30 If NOT using a CATEGORY file then this is the
number of days to keep a CARD entry, before it
becomes eligible for purging.
0 = Do NOT purge any entries.
SUN80 Name of the EXPORT file that is generated by the
BUSEXCH program. We suggest that it be a unique
name. DO NOT include an extension! Maximum of 6
characters ONLY
0 Minimum security level required to access the
ADD option
0 Minimum security level required to access the
DELETE option
0 Minimum security level required to access the
EDIT option
0 Minimum security level required to access the
VIEW option
N Y = Allow only ONE Entry Per Category Per Caller
N = Allow UNLIMITED Entries
Y Y = Log all callers to USAGEx file
N = Do not log callers
* = See next page for valid color codes
** = Replace with a PATH to ONE of the following:
PCBOARD.SYS CALLINFO.BBS USERINFO.DAT DOOR.SYS GTUSER.BBS
DORINFOx.DEF SFDOORS.DAT
Page 4
C O L O R T A B L E
======================
COLOR # - NAME INTENSITY
-------------------------------
0 - BLACK Low
1 - BLUE "
2 - GREEN "
3 - CYAN "
4 - RED "
5 - MAGENTA "
6 - YELLOW "
7 - WHITE "
8 - GRAY High
9 - LBLUE "
10 - LGREEN "
11 - LCYAN "
12 - LRED "
13 - LMAGENTA "
14 - LYELLOW "
15 - LWHITE "
USAGE LOG
---------
As an option, we provide you with the ability to log every player to a text
file. IF you enter Y in the CFG file to log callers, the Door will place the
caller's name as well as the ON and OFF times each time a caller selects the
Door. A separate file will be created for each Node and the name of the file
will be USAGEx, where x is the Node number.
You may delete these files at any time and the Door will recreate them the
next time a caller enters the Door. If you do NOT want to continue logging
callers, change the CFG file entry to N.
Page 5
RESTRICTIONS!
-------------
UnRegistered versions of BUSINESS CARDS have the following restrictions:
. Maximum of 15 Business Cards may be entered
. Purge option is disabled
. Unable to IMPORT or EXPORT Business Cards
CATEGORY FILE (BUSCARD.CAT)
---------------------------
*** Note: If you do NOT wish to use a category file then you must ensure
that the BUSCARD.CAT file is NOT present in the Door directory. ALL
Business Cards will be grouped under ONE category called Miscellaneous.
If this is your choice, then be sure to set the CFG entry that controls
the number of days to keep the Cards before being eligible for purging.
Be sure to give a lot of thought to your choice of categories, since
the category number in this file is carried in each Ad record. This
means, if you set up the categories so that #2 was 'Plumbing' and the
caller entered a Business Card under that category, the Card would carry
category #2 as the category number. If you then decide that you want to
change the 'Plumbing' category to say, 'Accounting', then the Cards
carrying #2 in their record would be classified incorrectly.
The format of the BUSCARD.CAT file follows:
TTTTTTTT,UU
Where t = Category name. Max length: 20 characters (NO COMMAS)
u = Maximum number of days a Card can remain active.
Minimum Days: 1 and Maximum Days: 9999
WELCOME File
-------------
You can define the name of the WELCOME file in the configuration file.
If the program finds that filename, it will display that file after
the opening screen and before the main menu screens. The file must
reside in the same directory as BUSCARD.EXE
Page 6
AUTOMATED PURGING
-----------------
When you set up the categories to be used in your version of BUSINESS
CARDS, you are asked to define the number of days the Card should remain
active. By running the BUSMAINT (PURGE option) program in your nightly
event process you will ensure that the Cards are deleted, automatically.
The following is all that is required to execute the purge:
BUSMAINT BUSCARD.CFG /EVENT
^^^^^^^^^^^
|
|------ or your congfiguration file name
Note: This is only available in registered versions!
Page 7
DATABASE EXCHANGE (BUSEXCH.EXE)
________________________________
*** NOTE: This program is included with the Business Card registration
** A GREAT WAY TO SHARE THE BUSINESS CARDS DATABASE BETWEEN 2 OR MORE BBS' **
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Business Card Database Exchange program will allow you to participate
in the exchange of Business Card databases with other BBS' (Any number of
BBS' can participate). The exchange program is named BUSEXCH and comes
included in the BUSCRDxx.ZIP file.
BUSEXCH performs three (3) major functions:
(1) EXPORT: Extracts all active Cards from the Business Card database.
It creates files named XXXXXXrr.CXP (XXXXXX is defined in the
CFG file, rr is a random letter/number combination) and will
bypass any Card already flagged for deletion as well as those
Cards that were previously exported.
(2) IMPORT: Imports files named XXXXXXrr.CXP (XXXXXX is defined in the CFG
file, rr is a random letter/number combination) created by the
EXPORT option and merges all Cards into the Business Card
database. It will not import any Cards that duplicate Cards
found in the existing database. NOTE that this option will
IMPORT ALL files with an extension of CXP during a single
execution of the program.
(3) IMPEXP: This option will first IMPORT (as in (2) above) then turn
around and EXPORT (as in (1) above) during one execution
of the program.
All BBS' involved in the exchange MUST run a registered version of
BUSINESS Cards.
It is critical that ALL participants in the exchange use the SAME
Category file. Failure to do so will result in Cards meant for a certain
category on one system, showing up in a category totally unrelated on
another system.
(Continued on Next Page)
Page 8
DATABASE EXCHANGE (Continued)
To run the Exchange you do the following:
*************************************************************************
* >>>>> If you are acting as a HUB you MUST signal BUSEXCH.EXE by using *
* HUBEXPORT, HUBIMPORT or HUBIMPEXP in lieu of EXPORT, IMPORT or *
* IMPEXP. If you fail to do this you will not be able to export *
* newly imported Cards. *
*************************************************************************
EXPORT: a) Change to the directory containing your BUSCARD.DAT file
b) Issue this command: BUSEXCH EXPORT BUSCARD.CFG
If you use a different name for your Config file, then
substitute that name for BUSCARD.CFG
c) Send (transmit) ALL *.CXP files to those involved in the
exchange or to the HUB.
d) Delete ALL .CXP files.
IMPORT: a) Change to the directory containing your BUSCARD.DAT file
b) Copy the *.CXP files that were sent to you by the
BBS you are exchanging with, to the directory used
in item (a) above.
c) Issue the command: BUSEXCH IMPORT BUSCARD.CFG
If you use a different name for your Config file, then
substitute that name for BUSCARD.CFG
d) Delete ALL *.CXP files
IMPEXP: a) Change to the directory containing your BUSCARD.DAT file
b) Copy the *.CXP files that were sent to you by the
BBS you are exchanging with, to the directory used
in item (a) above.
c) Issue the command: BUSEXCH IMPEXP BUSCARD.CFG
If you use a different name for your Config file, then
substitute that name for BUSCARD.CFG
d) Send (transmit) ALL *.CXP files to those involved in the
exchange or to the HUB.
NOTE: If you wish to EXPORT ALL Cards in the database regardless of whether
they have been previously exported, you can use the /ALL switch on the
BUSEXCH command line. It can only be used with HUBIMPORT, HUBEXPORT or
HUBIMPEXP and MUST be the last entry on the command line.
NOTE: All IMPORT and EXPORT transactions are recorded in a file called
BUSEXCH.LOG. If the file exists it will append the information, if not
it will create the file and add the information. Thus you are free to
delete it at any time.
Page 9
NON-STANDARD COM SUPPORT
________________________
Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
number after the configuration filename. Let's assume your Door is
called FOOBAR and you want to use COM1 and IRQ5. The command line
passed to your Door would be:
FOOBAR FOOBAR.CFG /5
The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
normally used with COM1. No /x parameter is needed for the standard
IRQ's.
As an alternative, you may use an environmental variable on the command
line. To use the variable (following the example above), place a
SET IRQ=5 in the batch file used to bring up your BBS (you would need a
different IRQ number for each node). The command line would now look
like this:
FOOBAR FOOBAR.CFG /%IRQ%
This, in combination with the use of the environmental variables
described in the MULTI-NODE SETUP section will allow you to use one
batch file and one config file to run this door on all nodes.
Page 10
MULTI-NODE SETUP
________________
All Sunrise Doors are Multi-Node capable. Each node must have the
ability to access a configuration file which will have its own system
file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
line. There are 2 ways to accomplish this:
(1) Create a separate configuration file for each node. The only
difference between each file would be the location of the system
file for that particular node. For example, on my system there are 2
nodes and the first line of the config files would look like this:
NODE1: H:\PCB1\DOOR.SYS
NODE2: H:\PCB2\DOOR.SYS
Thus, if you have a 4 node BBS, you will need 4 configuration files.
(2) Use ONE configuration file for ALL nodes. This Door will recognize
the following PCBoard/Wildcat environmental variables:
PCBDIR (Directory containing the System file)
PCBDRIVE (Drive containing the System file)
WCNODEID (Active Node Number)
Thus, the first line of the SINGLE configuration file, for this Door
would look like this:
%PCBDRIVE%%PCBDIR%\DOOR.SYS
c:\wc30\wcwork\node%wcnodeid%\door.sys
NOTE: This option, as described, assumes that you are running PCB or
Wildcat software. The environmental variables are automatically
created by the software for each node.
HOWEVER, if you are running other BBS software you should be able
to set the variables EXACTLY as described below, for EACH node
(more than likely in each batch file you use to bring up EACH node):
PCBDRIVE=C:
^^^^^^^^^
PCBDIR=\NODE2
^^^^^^^^
Info with a carat (^) under it, MUST be typed as is. The rest
depends on your naming conventions.
This, in combination with the use of the optional environmental
variable described in the NON-STANDARD COM SUPPORT section, will
allow you to use one batch file and one config file to run this
door on all nodes.
Page 11
DOWNLOAD FILE TRANSFER PROTOCOLS
--------------------------------
BUSINESS CARDS externalizes all file transfer protocols used for
Downloading of the Business Cards. This allows the Sysop to define the
file transfer protocols they wish to support.
A file called PROTOCOL.DAT is supplied with protocols already defined,
which you may alter at any time. Each entry in the PROTOCOL.DAT file
consists of the description that will be displayed to the caller on the
Protocol Menu and the 'high level' name of the protocol's batch files.
Example: ZModem Upload or Download, ZPROT
The information to the left of the comma is the description. Business
Cards requires that you have a batch file in the Business Cards directory
to handle the downloading. In the above example ZPROT is the 'high level'
portion of the batch file name required for ZMODEM. Your Business Card
directory should contain ZPROTS.BAT (the S is for downloading). The S
suffix MUST be present as that is what Business Cards will be looking for
in the Business Cards directory!
Each protocol batch file MUST contain 2 batch file variables as follows:
%1 = Business Cards will use this variable to substitute the current
ComPort
%2 = Business Cards will use this variable to substitute the file name
IMPORTANT! Place the variable (%1 and %2) ONLY in the EXACT location that
your protocol requires them, in the protocol command line. Do
NOT supply the ComPort or FileName, JUST the %1 and %2
variables themselves (%1 and %2)!
See example batch files supplied with the Business Cards. They are the
ones being used on the Sunrise-80 BBS.
*** PLEASE NOTE ***
There may come a time when you will need to supply information to the
protocol you are using, based on the node it will be used on. You can
accomplish this by supplying a node-specific PROTOCOL file. Everything
described above stays the same except that you will name the file
PROTOCOL.x (where x is the node number). For example, to use a special
set of protocols (or batch files) on node number 5, modify a copy of
PROTOCOL.DAT and name it PROTOCOL.5. Business Cards will use PROTOCOL.5
when someone logs on node 5 and will use PROTOCOL.DAT for ALL OTHERS. You
do not have to create node-specific PROTOCOL files for all nodes.. just
the node(s) that are different.
Page 12
LEGALITIES
__________
THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
OR BREACH OF ANY WARRANTY.
DISTRIBUTION
____________
You may make this file available for downloading from your BBS or you may
upload it to any BBS of your choice, provided that you do not make any
changes to the contents of the archive (ZIP file). The archive and its
individual contents may not be used by any service that charges any money
whatsoever, without the written permission of the author.
REGISTRATION
____________
Registration and the subsequent insertion of the registration number into
your configuation file, will remove all restrictions deined in the section
called "Restrictions', allows for the display of your BBS name on the
opening and closing screen
To register your copy of BUSINESS CARDS, please fill out the registration
form (REGISTER.FRM) and mail it along with the registration fee to the name
and address on the form.
Once a door is registered, any changes to registration information (Sysop
name or BBS Name) will require the doors to be re-registered at the
registration fee in effect at that time.
Be sure to use the proper upper/lower case when filling in your name and
BBS name, as they MUST match the way you entered them in the configuration
file. ^^^^
Based upon information supplied on the registration form, I will pre-
register you on my BBS. You will then be able to call SUNRISE-80 and pick
up your registration number OR you can enclose a SASE with the form/check.
Page 13
MISC
____
The latest version of BUSINESS CARDS and other fine SUNRISE DOOR programs
are always available for download from SUNRISE-80 BBS.
Remember, should you have any problems, questions or suggestions, be sure
to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.