OS/2 Shareware BBS: 2 BBS/02-BBS.zip/mccd2-1.zip/mccd2.doc

Text File | 1995-02-16 | 8KB | 204 lines

                     Max Credit Card Door/2 Version 1.00

          Copyright (C) 1995 by Craig Morrison, All Rights Reserved.


What is MCCD2?
--------------

MCCD2 is a credit card processing door for BBS systems running Maximus(**)
version 2.xx under OS/2 2.x and higher. Through the use of a simple text file
you can allow your callers to use their credit cards to make purchases through
your BBS.

MCCD2 was written specifically to handle BBS subscriptions using the Expiration
features built-in to Maximus. You can define exactly what type of subscription
a user can purchase and MCCD2 will write the necessary information to the
online user record to tell Maximus to begin their subscription period.

MCCD2 provides complete logging of all actions by the user while they are in
the door. MCCD2 writes out all purchases to a comma delimited text file to make
it easy to import purchase information into any database package.

MCCD2 supports both ANSI and TTY callers. ANSI callers will be displayed neatly
formatted menus and input boxes in color. TTY callers, well, they get the best
one can do to make the purchasing system look nice. :-) The intro and exit
screens are simple text files that can be customized to suit your BBS.


How much is MCCD2?
------------------

To non-commercial users MCCD2 is _absolutely_ free. If you don't make a profit
from your BBS you are considered a non-commercial user. This is a bit tricky to
define, if there are any doubts see the contact information included at the end
of this file. Drop me a note and we can discuss it. I'm very flexible when it
comes to working out some sort of agreement.

Commercial users are required to pay a licensing fee. For that licensing fee
the Borland C source code is provided, if desired. Toll call telephone support
is provided as part of the licensing fee.

Developers may purchase the source code for their own private use by paying the
commercial licensing fee.

See the included REGISTER.FRM for more information about licensing MCCD2.


Legalese
--------

MAX CREDIT CARD DOOR/2 IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. YOU
ASSUME ALL LIABILITY FOR ANY DAMAGES OR ALLEDGED DAMAGES ARISING FROM OR
ALLEDGEDLY ARISING FROM THE USE OF THIS PROGRAM. CRAIG MORRISON, THE AUTHOR,
HAS TO THE BEST OF HIS ABILITY TAKEN ALL PRECAUTIONS TO PROVIDE FOR SAFE AND
RELIABLE OPERATION OF THE PROGRAM.

It goes without saying, as with all other software; timely and reliable backups
should be performed to insure minimal data loss if something does go wrong.


How to Use MCCD2
----------------

   MCCD2 <port_handle> <LASTUSxx.BBS> <cfg_file> <log_file> <minutes_on>

You must use the `ReRead' menu option modifier when calling MCCD2 from a menu
item or the `@' modifier inside a MECCA script. This is NECESSARY so that
Maximus will reread and record the user modifications made by MCCD2. Please
read the sections in the Maximus documentation on running external programs.

    port_handle     Hot comm port _FILE_HANDLE_ from Maximus. (%P)
                    Use 0 for local mode operation.

    LASTUSxx.BBS    Path and filename of the LASTUSxx.BBS file
                    for the node you are running MCCD2 for. For
                    single node systems with a task number of 0
                    this will be LASTUSER.BBS, multi-node systems
                    this will be LASTUSxx.BBS where `xx' is the
                    node number in hexadecimal format. I.E, Node 1
                    would be 01.

    <cfg_file>      The path and filename of a configuration file
                    for MCCD2. The format for this file is discussed
                    later.

    <log_file>      Path and filename of a file for MCCD2 to log the
                    actions that it performs to. This MUST be a unique
                    name for each instance of MCCD2.

    <minutes_on>    How long the user has been this call. (%j)

CFG file format:

   Line 1:      MUST be the number of item lines, 12 items max.
   Line 2-n:    One line each up to the number listed on line 2.
                Following the format below.

IT IS *YOUR* RESPONSIBILITY TO MAKE SURE THE FORMAT OF THIS FILE IS CORRECT!

Item line format:

 cost, shown_cost, desc, time, priv, keys, x_type, days/mins, x_action, x_priv

   Lines should be limited to 255 characters or less.

   ALL FIELDS MUST BE PRESENT!

   Commas `,' are no-no's! They can only be used to separate the fields.

   If all you are doing is selling products or services that aren't
   related to BBS subscriptions; fill in the cost, shown_cost and desc
   fields with the appropriate information and use 0 for the rest of them.

   A 0 entry in the priv field means that the users priviledge level will
   not be altered. Only the first letter of the priviledge level is needed,
   although you can spell out the entire priviledge level name for clarity.

   A 0 entry in the keys field means no keys will be added.

   A 0 in the x_type field turns off expiry modifications. If you specify
   an x_type you MUST provide the information for that type of expiration
   on the user record. I.E, x_type of M; You must fill in days/mins with
   the number of minutes to expiry, you must also specify x_action. If
   x_action is A, x_priv is ignored, otherwise you must enter a priviledge
   level for demotion.

  Examples:

   2500,  $25.00,  MaxFile/PM Registration, 0,   0,   0,   0,  0,    0,  0
   1000,  $10.00,  4 Hour Subscription,     30,  E,   R,   M,  480,  A,  0
   3000,  $30.00,  1 Year Subscription,     45,  E,   R,   D,  365,  D,  N

    cost:           Integer representation of the cost of the item
    shown_cost:     Displayable (formatted) version of the cost field
    desc:           Description of the item for display and logging
    time:           Upgrade time. This is the maximum amount of time that
                    will be added to a users time remaining. IOW, if they
                    have been online for 30 minutes and you have 90 for
                    this field, 60 minutes will get added to their time
                    remaining for the call. 0 disables this modification
    priv:           Priviledge level granted for purchasing this item
    keys:           Keys granted for purchasing this item. Valid keys for
                    Maximus are; 1-8 and A-X, you can enter more than one
                    key in this field, simply string them all together. E.G,
                    1AFR would set the keys 1, A, F and R
    x_type:         Expiry type, M = expires in minutes, D = expires in days
    days/mins:      The number of minutes or days to expiry
    x_action:       Expiry action, A = Axe (hangup and delete) D = demote
    x_priv:         Priviledge level to demote user to after expiry


Output File Format
------------------

MCCD2 appends each confirmed transaction to a comma delimited ASCII file. Each
line is formatted like the following:

  1            2                3          4          5
"1500","4256835942726582","123-456-7890","0796","Craig Morrison", ...
            6             7       8        9        10        11
 ... "1316 Ferry St","Lafayette","IN","47901-1533","USA","02-16-1995"

The fields are:

    1       Integer cost of the item.
    2       Credit card number.
    3       Phone number.
    4       Card expiration date.
    5       Cardholder name.
    6       Street address.
    7       City.
    8       State or province.
    9       Postal code.
    10      Country
    11      Date of purchase.

The above information is written all on one line in the file BBSCHARG.CHG to
the directory that MCCD2 is run from.


Contact Information
-------------------

If you need to get a hold of me, I can be reached at one of the following:

Fidonet:        Craig Morrison, 1:201/[e-mail]

Internet:       [e-mail]

Snail-mail:     Craig Morrison
                1316 Ferry St.
                Lafayette, IN 47901-1533
                USA



Trademarks
----------

(**) Maximus is a trademark of Lanius Corporation.