home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The World of Computer Software
/
World_Of_Computer_Software-02-387-Vol-3of3.iso
/
r
/
rats130a.zip
/
RATS.DOC
< prev
next >
Wrap
Text File
|
1992-12-15
|
28KB
|
661 lines
- RATS -
RemoteAccess TimeBank System
Version 1.30
Copyright 1990,91,92
Motor City Software
All Rights Reserved
Documentation by Rick Luquette
-----------------------------------------------------------------
Introduction
-----------------------------------------------------------------
A Time Bank is a door program that allows BBS users to
deposit, withdraw, borrow and repay online time and file transfer
credits.
The RemoteAccess TimeBank System (better known as RATS) for
RemoteAccess and QuickBBS has many features for the user and is
easy to set up and use for the sysop.
Here are just a few of RATS' features:
Interfaces with programs that automatically deposit minutes
in user accounts via an external support file.
Works with RemoteAccess versions 1.00 through 1.11 and
QuickBBS 2.75 through 2.76.
Includes a separate data file maintenance utility.
Provides hot-key support. If the user is familiar with the
commands, the current screen output can be interrupted when
a command key is pressed.
Uses a graphic transaction screen and Sysop-definable colors
for most fields and prompts.
Automatically detects a logon by the sysop or a named co-
sysop, allowing access to sysop functions.
Allows the sysop to define values for maximum deposit,
withdrawal, and balance for both time and file transfer
credits.
Allows users to purchase file transfer credits with online
time, and to borrow time or transfer credits from the bank.
Includes full multi-node support.
1
-----------------------------------------------------------------
Table of Contents
-----------------------------------------------------------------
Introduction . . . . . . . . . . . . . . . . . . . . . . . . 1
Table of Contents . . . . . . . . . . . . . . . . . . . . . . 2
Licensing Information . . . . . . . . . . . . . . . . . . . . 3
Distribution Files . . . . . . . . . . . . . . . . . . . . . 4
Getting Started -- Installation . . . . . . . . . . . . . . . 4
Creating a Batch File (RATS.BAT) . . . . . . . . . . . . . . 10
Performing Nightly Maintenance (RMU.EXE) . . . . . . . . . . 10
Loan Repayment System (RATPAY.EXE) . . . . . . . . . . . . . 11
A Final Note . . . . . . . . . . . . . . . . . . . . . . . . 11
2
-----------------------------------------------------------------
Licensing Information
-----------------------------------------------------------------
Motor City doors are commercial programs marketed under the
"User Supported" or "Shareware" concept. You are allowed to
install this program on Your system and evaluate it before
deciding whether to purchase a license to continue using it. This
program is not public domain or freeware. If you use this program
for more than 30 days after successful installation, you are
legally required to register it or remove all working copies from
your system.
The User Supported or Shareware concept works only if you
and your fellow sysops support it. If you find this program
useful, you can register it for only $15.00 in U.S. funds. This
will help offset the development costs, and encourage us to write
other programs that might be useful to you. After all, no one
likes to work for nothing! A Registration Form is included in the
RATS distribution archive.
RATS is Copyrighted 1990,91,92 by Motor City Software, ALL
RIGHTS RESERVED. You may copy this program and documentation for
backup purposes. You also may copy and share UNMODIFIED copies of
the original program archive. The copyright notice must remain
attached to all copies.
You may not sell Motor City Software products for a fee, or
distribute it along with other products without written permis-
sion of Motor City Software, nor may you modify or remove the
Copyright Notice from the program or the documentation. BBS
operators who charge for access to their systems are exempt from
this provision as long as no additional payment is required for
access to Motor City Software products beyond basic file access.
All Motor City Software products are extensively tested
before being publicly released, but as with any software, bugs
may still occur. Motor City Software products are provided as is,
and neither Motor City Software nor any BBS operator distributing
this software is responsible for any damage incurred during the
operation of the RATS program. You are advised to test all Motor
City Software products thoroughly on a backup copy of your BBS
before putting them online.
Comments, suggestions and bug reports are welcome. If you
have any, you may call one of the Motor City Software Support
Systems listed in SUPPORT.DOC and leave a message to the Sysop.
If you're reporting a bug, please give as much detail as possible
about the problem you are having, your system configuration, and
if you would be willing to test possible corrections to the
problem.
3
-----------------------------------------------------------------
Distribution Files
-----------------------------------------------------------------
The original program is distributed in archive format using
the ARJ archiving format. Additions or deletions are prohibited.
The distribution archive contains the following files:
RATSCFG.EXE The RATS configuration program
RATS.EXE The program executable
RATS.DOC This documentation file
RATPAY.EXE Loan Repayment Maintenance Utility
RMU.EXE RATS maintenance utility
ZEROLOAN.EXE Clear Loan Fields (Initial Install)
RATS.BAT Sample Batch File for running RATS
RATS.HLP The program help file
RATS.NEW Program revision history (read this!!)
REGISTER.* Registration forms
SUPPORT.DOC Location of Support Systems
-----------------------------------------------------------------
Getting Started -- Installation
-----------------------------------------------------------------
Upgrades from prior versions
The current version of RATS is compatible with data file
formats introduced in version 1.20. Users of prior versions will
have to install version 1.30 as though this were an initial
installation.
If you're been running any version since 1.20, you will be
able to keep your data files. Run RATSCFG in the directory
containing your RATS.DAT file and add any new information, and
run ZeroLoan to clear the Loan Balance field.
Initial Installations
Unpack the distribution archive into the directory where you
want to keep your RATS.DAT file. RATS can be run in any subdirec-
tory as long as paths are setup properly in RATSCFG.EXE. We
recommend creating a RATS subdirectory off your main BBS direc-
tory, or where your other DOORS are kept.
Run the RATSCFG.EXE program to create the RATS configuration
files, or to edit and update any existing configuration files.
4
RATSCFG.EXE
After starting RATSCFG, you'll see a list of selections
across the screen. As you make your selections, menus will drop
down and present you with various choices.
Information
Credits: Information on the authors of RATS.
Registration: How to register RATS.
RATSCFG Colors: You can reset the colors to make RATSCFG
easier or More pleasant to use.
Bank Setup
Pick Node #: If you're upgrading, you'll see a list of your
current configuration files. Select the one you wish to change.
If you're setting up a new node, press <ESC> and then enter the
node number you want to configure. If this is your first time
setting up, then simply enter the node number that you wish to
configure. If you run a single node system, enter a 0. You won't
be allowed to modify any information until after you've chosen
the node number to be modified. Remember to save your changes
before selecting another node.
Files And Paths: RATS needs to know where to find your BBS
drop files and its own configuration files for this node.
Node Number: The node number is shown here to remind you
what node you're working on. If you change this number, you will
not create a new data file.
Path To DORINFO1.DEF / EXITINFO.BBS: Enter the FULL PATH to
your drop files for this node. This should be the directory from
which you run your BBS batch file or EXE file for this node. It's
not necessary to add a backslash at the end of the line, but you
can if you wish.
Path To THEBANK.EXT: Some other doors create a file called
THEBANK.EXT to generate automatic deposits and withdrawals from
RATS. This file is usually stored in your main BBS directory. See
the documentation for the program that creates THEBANK.EXT for
more information.
Path To RA Semaphore Directory: If you're running Remote
Access, RATS will look for and read semaphore files in this
directory, including RAXIT#.## files. See the RA manual for more
information.
Error Log: Specify a full path and filename for the error
log generated by RATS. If you like, this may be written into your
5
BBS System log. If blank, RATS will create RATS_ERR.LOG in the
current directory when an error occurs.
Usage Log: RATS will log all user activity to the file you
name here. If you wish, you may have it added to your BBS System
Log.
Log UserStats?: If you choose Yes, RATS will write the users
time and KBytes in the bank, and on hand, to the usage log each
time the user enters or exits the bank. You might wish to ac-
tivate this feature if you are having problems with RATS.
Sysop Name: Enter the name of the BBS operator. This will
most likely be your name.
BBS Name: Enter the name of the BBS.
Bank Limits
This is the heart of RATS. The limits you set here will
control the usefulness of RATS for your users.
Name Of Bank: The name you enter here will be displayed on
the top line of the screen whenever a user is in RATS. Be crea-
tive!
CoSysop Name: If you allow someone else to help you run your
BBS (a CoSysop), enter his or her name here. Your cosysop will
have access to RATS sysop functions while online within the door
program.
Minimum Security: The minimum security level needed to
access RATS. If a user with a lower security level enters RATS,
he/she will be told that he/she cannot use the TimeBank. You may
assign any level from 1 through 64,000
Usage Before Deposit: This setting tells RATS how much time
a user must spend on the BBS before being allowed to access the
time bank. If this field is set to 0, a user can log onto the
BBS, deposit all of his or her available time, and then log off.
You can enter a figure from 0 to 30 minutes.
Inactivity Timeout: If a user falls asleep, or otherwise
becomes occupied, RATS will abort back to the BBS after this
time, which can be set from 2 to 10 minutes.
Time Remaining To Access: A user who is running out of time
may want to frantically dash to the time bank, borrowing or
withdrawing at the last minute. An entry here forces the user to
use a little advance planning rather than make last minute
decisions. Entries from 1 to 60 minutes are permitted.
6
Maximum Time Deposit: This is the MAXIMUM time that a user
can deposit into his/her account in one day. Entries from 0 to
1440 are permitted. An entry of 0 disables deposits; while 1440
minutes equals 24 hours, effectively negating this feature.
Maximum Time Withdraw: A user with a high enough balance
could conceivably withdraw enough time to tie up your BBS for an
entire day. An entry in this field regulates the amount that can
be withdrawn in one day. Entries from 0 to 1440 are permitted,
with 0 disabling withdrawals.
Maximum Time Transfer: One of the more powerful features of
RATS is the ability of one user to transfer time to another,
provided both have RATS accounts. This controls the MAXIMUM time
a user may transfer to another user. Entries from 0 to 1440
minutes are permitted, with 0 disabling transfers.
Maximum Time Balance: This sets the maximum a user can have
on deposit in his/her account. Entries from 0 to 64000 are
permitted, with 0 allowing unlimited deposits.
Maximum Time Loan: This setting determines how much time a
user is allowed to borrow from the time bank. If set to 0, then
Time loans are disabled. The maximum setting is 1440 minutes.
Maximum K-Byte Loan: This setting determines how many KBytes
of file transfer credits a user is allowed to borrow from the
time bank. If set to 0, K-Byte loans are disabled. The maximum
setting is 9000K.
(If Both Time and K-Byte loans are set to 0, then the
<C>redit Department will not show up on the users screen.)
Maximum K-Byte Deposit: Sets the maximum KBytes of file
transfer credits a user can deposit into his/her account in one
day. A setting of 0 disables deposits; the maximum setting is
32000K.
Maximum K-Byte Withdraw: Sets the maximum KBytes of file
transfer credits a user may withdraw from his/her account in one
day. An entry of 0 disables withdrawals; the maximum is 32000K.
Maximum K-Byte Transfer: Users may transfer KBytes of file
transfer credits to one another, as long as both users have
accounts in RATS. This field determines the maximum that can be
transferred. An entry of 0 disables transfers; the maximum
setting is 30,000.
Maximum K-Byte Balance: Sets the maximum KBytes of file
transfer credits a user is allowed to have on deposit. An entry
of 0 makes this field unlimited; the highest limit is 64,000.
7
Maximum K-Byte Purchase: RATS allows users to spend online
time from their balance to purchase KBytes of file transfer
credits. A setting of 0 disables purchasing; the maximum is 5000.
K-Byte Cost in Minutes: If purchasing is allowed, this field
sets the price in time for each KByte of file transfer credit
purchased. Entries of 1 to 5000 minutes per KByte are permitted.
Bank Hours
This section controls the hours during which sections of
your bank are "open" to users.
Deposit Time: Beginning and ending time that deposits can be
made.
Withdraw Time: Beginning and ending time that a withdrawal
can be made.
Borrow Time: Beginning and ending time that a user can
borrow time from the credit department.
Transfer Time: Beginning and ending time that a user can
transfer time to another user.
If Start And End times are 00:00 then that option is available at
all times.
Override Level: Restrictions set above will not apply to any
user with a security level above this setting.
Loan Flag: This flag setting is used by RATS and RATPAY to
handle the checking and repayment of borrowed time. This uses the
BBS's security flags, and will modify them in the Exitinfo.bbs so
make sure you pick one thats NOT being used for any other purpose.
Bank Loan Interest Rate: Just like a regular bank, you can
charge interest when a user borrows time or file transfer cred-
its. If you enter 10, a user who borrows 100 minutes will be
charged a one-time 10 minute interest fee, and will have to repay
110 minutes. Interest rates of 0 to 100% are permitted.
Min Payment K: Minimum payment that a user must make when
paying back file transfer credits. This prevents a user from
borrowing 50 megabytes, and paying back 1 K per day. This should
be a percentage of the amount borrowed.
Min Payment: Minimum payment that a user must make when
paying back borrowed time. As above, this is a percentage of the
amount borrowed.
HangUp: Determines whether RATPAY will hang up on a user who
does not want to make a mandatory payment.
Colors: Allows you to customize RATS display colors. Keep in
mind that some color combinations are invisible to monochrome
callers.
8
Save Config: Be sure to save your changes before exiting
RATSCFG. You'll be shown the current filename, and asked whether
you want to save your changes. Answer No if you're not sure of
your answers and you want to start over. If you try to exit
RATSCFG without saving configuration, you will be given the
chance to save it before exiting.
Maintenance
View Users: List all users who have an account in RATS,
showing their name, current Time/KByte balance, the last date
they accessed RATS, and if the user is marked for deletion.
Add User: Allows you to open a user account. You may specify
the user's name, and the time and KByte balance.
Edit Users: Allows you to search for, and edit any users
account. You may modify their time or KByte balance.
Delete User: You'll be prompted for a search string, then
asked if you want to delete matching names. If the user was
already marked for deletion, you'll be asked if you want to
reverse the deletion, providing the database has not been purged.
Purge Users: This selection rewrites the data files, per-
manently removing any users marked for deletion. (RMU also purges
users during nightly maintenance.)
Reports
BankBook Records: Creates an ASCII file named BANKBOOK.RPT
in the current directory, listing the transaction reports. RMU
will trim this file to the last 7 days transactions. You may
automatically have RatsCfg generate this report in a batch file
by using the /U parameter. Example : ratscfg /U
User Balances: Creates an ASCII file named USERS.RPT in the
current directory, listing information about each user's account.
You may have RatsCfg generate this file in automatically by using
the /B commandline parameter. Example : ratscfg /B
Exit
Quit To DOS: Exits RATSCFG.
9
-----------------------------------------------------------------
Creating a Batch File (RATS.BAT)
-----------------------------------------------------------------
Here's a sample batch file that you might use to run RATS:
@ECHO OFF
D:
CD \BBS\RATS
RATS /N%1
CD \BBS
The only parameter accepted on the command line is the node
number, indicated here by the variable %1. With QuickBBS and
Remote Access, you can use this command line to call up RATS
using a Type 7 menu call:
*C /C RATS.BAT *N *M
The *N parameter will send the node number to RATS.BAT,
while the *M parameter will force a memory swap.
If you're running a single line system, leave off the /N%1
parameter.
-----------------------------------------------------------------
Performing Nightly Maintenance (RMU.EXE)
-----------------------------------------------------------------
RMU.EXE (RATS Maintenance Utility) is designed to be run
nightly during your system's maintenance event to perform these
functions:
Deletes users whose account balances are zero minutes and
zero kilobytes. To retain an account in RATS, a user must
have at least one minute of time or one kilobyte on account.
Removes users who no longer exist in the USERS.BBS file.
Sorts all accounts in alphabetical order by last name.
Trims the BANKBOOK.DAT file so that only the last 7 days
transactions are kept.
Ensures that there are no duplicated records in the RATS
database.
10
RMU.EXE requires the path to your USERS.BBS file as a
command line parameter. If you keep USERS.BBS in C:\BBS, RMU
would be called with this command line:
RMU C:\BBS\
-----------------------------------------------------------------
Loan Repayment System (RATPAY.EXE)
-----------------------------------------------------------------
RATPAY is a separate door program that forces users to make
payments on their account before they are allowed online. In
other words, it's your "collection department"! If a User has
borrowed time or file transfer credits, RATS will set a chosen
flag, and then check to see if the user has a payment due. If the
user has already made a payment that day, RATPAY will exit after
checking the account. If a payment is due, the treatment of the
user will be determined by the way you have set the "HangUp"
parameter in RATSCFG. If set to "Yes", the user will be discon-
nected if they do not make their minimum payment. Ratpay can be
run from your TOP menu as a door.
-----------------------------------------------------------------
A Final Note
-----------------------------------------------------------------
RATS is just one of the many fine products marketed as
Shareware. As a BBS operator, you will be setting a fine example
for your users by registering Shareware BBS programs and doors
that you run on your system. Please support the Shareware con-
cept. Thank you for trying RATS!
At Motor City Software, we feel that crippling our software
is not the answer to generating registrations. If the software is
good enough, then Sysops will register. Some authors place lines
in the program that ask the users to help the sysop register this
door, but we feel this would not be the case for all systems. For
example, a pay bbs would not want to solicit their users to help
pay for the software when they have already paid to join the BBS.
To get around this problem, we have tried something new with
this release of RATS. If the door is NOT registered, then you may
create an ASCII and ANSI version of a file called BEGWARE.A?? and
this file will be displayed to the users when they enter the door.
If you wish to ask your users to pitch in for the door, then this
is the ideal way to do it. Once the door is registered, you may
create an ASCII and ANSI version of a file called ADOPTED.A??
This is a good way to let your users know who actually donated
the money to register this program.
You may use many of the Textfile Control Codes supported by
your bbs in these files.
11