Sunrise Door and Home Software Monday October 23, 2017  





BUSINESS CARDS 16-Bit Documentation

Download PDF Version

Version 1.5
Author/Contact Al Lawrence/Sunrise Door Software
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 directory you run the door from.
Non-Registered
 Restrictions
- Maximum of 15 Business Cards may be entered
- Purge option is disabled
- Unable to IMPORT or EXPORT Business Cards
Installation (1) Create a directory to hold all files
(2) Unzip the archive into the above directory
(3) Create a batch file or modify the batch file supplied. An example description of this file follows:

ECHO off
cd\PCB\DOORS\ACEY       Location of ACEY files
ACEY ACEY.CFG        filename and CFG filename (Name used in creating file in #3 above)
CD\PCB
BOARD

(4) When running in more than one node, be sure to supply a different configuration name for each node (your choice of name).

(5) If running with Fossil-based multi-port boards add /FD to the line containing the CFG name in the following example:

ACEY ACEY.CFG /FD

(6) Create a configuration file, with a name of your choice, or modify the supplied CFG file. A description follows:
 

CONFIGURATION FILE

# = Requires registration to change to a different value.


NOTE: There are NO Blank Lines in the Config File!!
** Location of system file (See Below)
SUNRISE BBS Your BBS name
Al Sysop's First name
Lawrence Sysop's Last name
1
1
Comm Port \     These 2 lines are required
      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 for Caller's name (Requires Door.Sys)
N = Use Logon Name for Caller's name
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 VERBIAGE 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
N = Do not log callers
G Door Rating. Default is G.
Maximum Characters: 5

** Replace with ONE of the following:

C:\bbs\PCBOARD.SYS         <- For PCBoard systems using PCBOARD.SYS only
C:\BBS\CALLINFO.BBS         <- For Wildcat! systems (prior to v3.0)
C:\BBS\DOOR.SYS              <- For ANY systems that support DOOR.SYS
C:\BBS\DORINFOx.DEF        <- For ANY systems that support DORINFOx.DEF
C:\BBS\SFDOORS.DAT        <- For Spitfire systems.
c:\bbs\TRIBBS.SYS             <- For TriBBS systems.
C:\BBS\GTUSER.BBS           <- For GT Power     * if using this option you must put the
                                                                         ComPort # on line 5 and the Node # on
                                                                         line 6 of the configuration file

Maintenance None
Troubleshooting (1) If you are running this Door on a 486 system and encounter errors such as

ERROR 6.... OVERFLOW Error
ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
KEYBOARD Timeout after 5 minutes

You may have to put the following line in your AUTOEXEC.BAT file:

SET NO87=ON

(2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the opening screen of the Door, your problem will more than likely be associated with the CFG file. The error 62 means that you do not have enough entries in the CFG. Compare your CFG file with the CFG definition in the DOC file.

(3) If you encounter an ERROR 70... Permission Denied, this will more than likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that comes with your version of DOS. To load it type the word SHARE at the DOS prompt. To load it permanently type the word SHARE on a line by itself in your AUTOEXEC.BAT file, any place prior to the loading of your BBS
software. There have been numerous reports that loading SHARE high causes some problems, so to be on the safe side, do not load it high.
Color Table COLOR #    NAME      INTENSITY

0                BLACK          Low
1                BLUE            Low
2                GREEN          Low
3                CYAN            Low  
4                RED              Low
5                MAGENTA      Low
6                YELLOW         Low
7                WHITE           Low
8                GRAY             High
9                LBLUE            High 
10              LGREEN          High
11              LCYAN            High
12              LRED              High
13              LMAGENTA      High
14              LYELLOW        High
15              LWHITE          High
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
Automatic 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 configuration file name

Note: This is only available in registered versions!
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.

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 Configuration 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.

 
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.
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.
Player-to-Player
MESSAGES
In the REGISTERED version of the Door, your players will be able to send messages back and forth to each other. All messages are PRIVATE and all messages are maintained within the Door itself and has no connection to the BBS' message bases. The Message file (PAIR3.MSG) will be restarted when the Door game restarts at the beginning of each month. If you do not restart your games on the first of each month then you must manually delete the MSG file. The file will continue to grow if not deleted and restarted.
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 Configuration file to run this door on all nodes.
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 Configuration 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 Configuration file to run this door on all nodes.
Adopt-A-Door The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It would be the same as sending in a donation, only this way it is earmarked for registering a particular door. In a way, the user feels he/she is "getting something in return". As a Door author I have decided to build this concept into each of my Door programs. The concept replaces the usual message "tell the Sysop to register this Door" we find in most
doors.

If the Door is unregistered then a message appears on the opening screen to that effect. After finishing or suspending a game, a message screen is displayed about the ADOPT-A-DOOR concept. The message also tells the caller to contact the Sysop to find out if there is any further details to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online time, etc to callers that ADOPT-A-DOOR.

If the Door has been registered, either by the Sysop or other callers, the names of those contributors will be displayed in the closing screen.

NOTE: If you want to display the names of the callers that contributed to registering the Door, you must create an ASCII file called ADOPT.SYS. You create it with an ASCII text editor. Enter the names of the contributors (one on each line, maximum of 5 entries, each a maximum of 30 characters long). This file must be saved, in ASCII format, and placed in the Door directory.
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 or WEB site of your choice, provided that you do not make any changes to the contents of the archive (ZIP/EXE 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 configuration file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file.

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.
Misc. The latest version this product, along with and other fine DOOR and HOME EDITION products are always available for download from this web site.


Moving Eye Line

Moving Eye Line


Last modified: August 11, 2013        Valid XHTML 1.0 Transitional