                     CREDITcard Subscription PPE v2.04

                          Compiled On: 01-31-94
                Written By: Raymond Cava, SysOp ERGONET BBS
                  +1 609 522 6825 - Hayes Optima 288 V.FC
                     PO BOX 836  -  Wildwood, NJ 08260



CREDITS:
========

Documentation Edited By       : Raymond Cava

Documentation, original draft : William P. Stewart, Computers & Dreams BBS
                                (212) 888-6565

Overall style inspired by     : The VERIFIER door written by LANCE WILLIAMS,
                                SysOp KADET PCBOARD BBS (315) 245-3815
                                (New York).

Extensive testing performed by: Adam Shiffman
                                The Graphics Alternative BBS
                                (510) 524-2780


Please do not call any of the above listed people except for me, if you run
into a problem of any type.


SUMMARY OF FEATURES:
===================

        - Extremely Configurable
        - Is Not Crippled In Any Way
        - Has its own Configuration program to make configuring even easier
        - Allows A Caller To Download Their Invoice
        - Allows For Sales tax BY State or for ALL States on a per menu
          menu option basis
        - Allows For Credit Card Processing Fee on a per menu option basis
        - Allows for optional IMMEDIATE updating of caller account on a per
          menu option basis
        - Leaves a Message to the SysOp alerting him/her of a purchase
        - Leaves the Message to the Sysop, to ANY defined caller AND
          conference, incase you collect registrations for a third party.
          This option is definable on a per menu option basis
        - Logs Purchase To Callers Log
        - Logs BAD numbers or dates to the callers log
        - Logs ALL purchases to CREDIT.LOG
        - Allows for Optional "Thank You" letter to be sent to the caller.
          This "Thank You" letter can be custom for each menu option
        - Allows additional fee specific to each option
        - Allows downloading of Membership form
        - All Text displayed to Callers is SysOp definable
        - Allows for Complete Customization of the Invoice with |variables|
        - Theoretically, as many as 500 menu options are allowable; however,
          only 11 have been tested by me.
        - Ten (10) available Sub-Menus



LICENSE AGREEMENT:
==================

By running this program you are hereby licensed to use this program for
as long as you like, free of charge.

LEGAL DISCLAIMER:
=================

This program and its documentation are licensed on an "as is" basis.
No warranties, either expressed or implied, are made by the developer or
distributor with respect to this program, its merchantability, or its fitness
for a particular purpose. The entire risk as to quality and performance is
with the licensed user of the software.

Ray Cava, the author of the CREDITcard PPE, will not be held liable for
any direct, incidental, or consequential damages, including loss of
anticipated profits, arising out of use of the program or the breach of
any warranty. Some states do not allow limitations on implied warranties
or liability for incidental or consequential damages, so the above may not
apply to you.



FEES:
=====
        There are none, but...

        A registration of $25 would be appreciated.

        Keep in mind, those who register are more likely
        to get features added that other wise wouldn't have been thought
        up by me and placed in the PPE for quite a while.

        THIS PRODUCT will NOT be crippled in ANY WAY, nor will any nagging
        advertisements or messages be displayed if you choose not to
        register. This utility will remain free and continue to look as
        though it is built into the BBS Package.

        A postcard; however, would be appreciated if you continue to use this
        PPE. I already have about 10 in my collection from this PPE.


Files needed by this PPE:
=========================

- The Welcome file (can be any name) If not present, it just doesn't
  Display, and no error message is given.

- The MENU OPTION file (Can Have Any Name. You really should have this)
  If this FILE does NOT exist, then this menu option becomes IN-VALID and
  can NOT be selected by the caller.
  THE ONLY MENU COMMAND THAT REMAINS CONSTANT IS  E  for EXIT

- CREDIT.CNF  , the configuration file

- #.CNF       , the MENU OPTION configuration file(s)

- INVOICE.    , created by the PPE Holds the next INVOICE NUMBER

- THANKS.     , file containing the thank you letter left to the caller
                  If you do not want a thank you note left to the caller, 
                  then erase this file.

- CREDIT.     , File containing ALL the displayable prompts.

- INVFORM.    , File holding the INVOICE, itself, as definable by the SYSOP.

- Any file pertaining to a MENU option, such as OPT1 or OPT2 etc... .


Files created by this PPE:
==========================

- CREDIT.LOG    - Log file holding credit card and subscription information.

- INVOICE.      - File holding the next invoice number to be used.

- REG.TXT       - File containing information notifying the SysOp
                    of the purchase. Written to message base.

- #.            - # being the invoice number

- USERNAME.INV  - Name of the file which can be downloaded by the user


Specialty Files Included:
=========================

- CREDITCF.EXE  - Helps in the configuration of this PPE
                - *NOTE* Please read this doc file for extended information
                  that can be placed on the different lines. THIS PROGRAM,
                  CREDITCF.EXE, only gives short help displays for each item,
                  NOT detailed information.

- OPTMAKE.EXE   - Creates menu option display screens, based up the info
                  contained in the #.CNF files.

- MKCDTTXT.EXE  - Creates a CREDIT (prompt file) text file containing the
                  standard prompts with no special colors.

         +----------------------------------------------------+
         | Credit Card Subscription PPE: Installation & Setup |
         +----------------------------------------------------+


*NOTE* DELETE ALL PRIOR CONFIGURATION FILES FOR THIS PPE. ALL FORMATS HAVE
       CHANGED.

INSTALLATION:
============
         
         1) Make a directory for the PPE, or just put it with any other
            PPE you might have running. Unzip the file.

         2) Now enter PCBSETUP and go to File Locations, Configuration Files,
            and down to 'Name/Loc of Default CMD.LST File'.
            Edit the CMD.LST to reflect your setup. Pick a command like 
            'CR' and enter the security level and path to the PPE and PPE name.
Example:
             Command           Security          PPE/MNU File
             =======           ========          ============
              CR                  0              C:\PCB\PPE\CREDIT.PPE

QUICK INSTALLATION:
===================

         1) Follow the installation step above
         2) Run the file CREDITCF.EXE
         3) Run the file OPTMAKE.EXE
         4) Run the file MKCDTTXT.EXE


Setup:
======

The CREDIT.CNF file:
====================

*** The config file MUST be named CREDIT.CNF        ***
*** The First TEN (10) lines MUST ALL BE FILLED OUT ***

Line 1: RAY CAVA                'SysOp's Name
Line 2: ErgoNet                 'BBS Name
Line 3: c:\ccnum\welcome        'Path and File Name for the WELCOME
                                 Screen. You MUST fill out this line,
                                 even if you are not displaying the
                                 file. If you do NOT want to display
                                 a WELCOME file, then leave the path
                                 and name set AS IS and erase the
                                 actual file in your directory
                                 
Line 4: c:\ccnum\options        'Path and file name of your Main selection
                                 screen within the PPE.

Line 5: c:\ccnum\               'The PATH (A trailing Back-Slash '\'
                                 is REQUIRED) to where the PPE will place
                                 the SysOp's copy of each invoice
                                 which will be named as the invoice's number. No Extension.
                                 EX: #. (valid ranges are 1 through 99999999)

Line 6: c:\pcb\upload\          'The PATH (A trailing Back-Slash '\'
                                 is REQUIRED) to where the PPE will place 
                                 the copy of the invoice which the user
                                 can download. The naming method used is as 
                                 follows: The FIRST 3 letters of the callers 
                                 first name, followed by the FIRST 5 letters
                                 of the callers last name, and an extension
                                 of .INV; Example:
                                 If USERNAME = William Stewart, then the 
                                 invoice name would be WILSTEWA.INV
                                 
                                N.B. IF the callers first or last name 
                                 is LESS than the 3 or 5 letter minimum
                                 mentioned above, then the remaining space 
                                 will be filled with Dashes (the "-" sign)
                                 Example: 
                                 If USERNAME = RAY CAVA, then the invoice
                                 name would be RAYCAVA-.INV
                                 or USERNAME = JO DO, then the invoice name
                                 would be JO-DO---.INV


Line  7: $                      'This should indicate your country's
                                 monetary symbol, such as '$' for the USA. 

Line  8: JOINBBS.TXT            'This should be the NAME of your membership
                                 form. This should be in the BBSs download
                                 path. (There must be something in this spot)

Line  9: 11                     'This is the NUMBER of menu options you have,
                                 excluding the default (E)xit and (D)ownload.

Line 10: 1234567                +Here on LINE #10 is where you tell the PPE
                                 which credit cards NOT to accept. Put the
                                 number of the credit card on the line. If
                                 there are MORE than 1 credit card, just put
                                 the other numbers on the same line. The
                                 order of these numbers as well as the
                                 spacing method used, or even no spaces at
                                 all, does not matter.

                                        1 = Discover Card
                                        2 = Carte Blanche
                                        3 = Diners Club
                                        4 = Optima
                                        5 = American Express
                                        6 = Visa
                                        7 = MasterCard

The #.CNF file:
===============

Line  1: Membership             - Brief description of this menu option
Line  2: c:\ccnum\opt1          - The path to the options display file
Line  3: 55                     - The security level assigned to that menu
                                  option. If a DASH  -  is placed on this
                                  line, then NO change is made at all in
                                  the security level.
Line  4: 365                    - The length of this subscription. If a DASH
                                     -   is placed on this line, then NO
                                  CHANGE is made in the subscription length.
Line  5: 15                     - The price for this level
Line  6: 5                      - Any additional charges
Line  7: 11                     - Their expired security level. If this is
                                  set to 999 then their CURRENT expired
                                  security level will be left as the expired
                                  level.
Line  8: 50                     - The lowest "Subscriber" level
Line  9: inv1                   - The name of the invoice form to use. MUST
                                  be in the PPEs directory and contain no
                                  path information on this line. This invoice
                                  as all others, may have any language file
                                  equivalents.
Line 10: TNXOPT1                - This is the text file thanking the CALLER
                                  for purchasing that PARTICULAR option.
Line 11: 2                      - This is your credit card processing fee
                                  (if you collect it). Here's how it works:
                                  Instead of entering .02 for 2%, you
                                  should enter the number for the percentage,
                                  BUT NEVER ENTER THE DECIMAL POINT!
                                  Examples:
                                           2%    is entered as 2
                                           2.5%  is entered as 25
                                           2.25% is entered as 225

                           +---- LEAVE this as 0 (zero) if you do not collect
                           |     this fee.
                           |
Line 12: 100               |    +Here you tell the PPE where your decimal
                           |     is in the above percentage.
                           |     What you should enter here:                                 
                           |     If rate is a "no decimal",    then 100
                           |     If rate is a "single decimal" then 1000
                           |     If rate is a "double decimal" then 10000
                           |     Example:                                            
                           |     2%    fee would require a 100   on line 8
                           |     2.5%  fee would require a 1000  on line 8
                           |     2.25% fee would require a 10000 on line 8
                           |
                           +--> NOTE! If line 11 is 0 then line 12 must be 0!

Line 13: 825                   - This is the State & City Sales Tax.
                                 It functions in the exact same way as the
                                 Credit Card processing fee.
                                 Here, for instance, I have selected 8.25%
                                 tax rate, based on the number in line 10.

Line 14: 10000                 - The same applies here as for Line 8
                                 Again, If line 9 is 0 then line 10 is 0
                                 I should point out that if you wish to
                                 collect, for example, 13.25% you would
                                 enter 1325 on line 9 and 10000 on line 10;
                                 or if you want to collect 13.5%, you will
                                 enter 135 on line 9 and 1000 on line 10.

Line 15: NY                    - This line should indicate the STATE that
                                 you wish to collect taxes from, normally
                                 your own state.
                                 Should you wish to collect taxes from ALL
                                 states, then you should enter 'ALL' on
                                 line 15.
                          +----> Making THIS line say ALL, overrides
                          |      WHATEVER is placed on line 17
                          |
Line 16: Y                |    - Allow users to download their invoices?
                          |      Valid Flags are Y for YES or N for NO
                          |
Line 17: Y                |    - Ask the users if they are eligible
                          |      to be charged YOUR state sales tax.
                          |      Valid Switches are: Y for YES or N for NO.
                          +----> This option is OVERRIDDEN by the
                                 ALL switch on line 15.

                                 If you are not collecting taxes at all,
                                 then place an N here and set line 13 and
                                 line 14 to 0 (zero).

Line 18: Y                     - Allow IMMEDIATE upgrading after purchase?
                                 Valid Switches are: Y for YES or N for NO.

Line 19: PUT ANY NUMBER HERE   - This tells the PPE WHICH conference to send
                                 the letter which contains the ordering
                                 information to.
Line 20: Joe Shmoe             - This tells the PPE WHO to send the letter,
                                 which is going to be sent to the above
                                 conference, to.

Line 21: Y                      - Y(yes) N(no), Add the CREDIT CARD number
                                  in the comment left to the person.

Line 22: !!!!!!                 - This is SIX (6) Exclamation Points (!) in
                                  a row. If this is not read in as the 11th
                                  line, then the PPE knows there is a problem
                                  as far as the #.CNF file not containing the
                                  proper number of lines.
16                              - From here to the End of the file, you may
                                  list the conferences in which to register
                                  this caller followed bye the proper flags
                                  on the VERY next line.
RXS                             - Beneath EACH conference number you MUST put
                                  the FLAGS to use when registering the
                                  person in that conference.
                                  Valid flags are: R, X, S, RX, RS, SX, RXS .
17
RS
99
RXS


Sub-Menuing:
============

There are ten (10) available sub menus. The file names are: MENUF, MENUG,
MENUH, MENUI, MENUJ, MENUK, MENUL, MENUM, MEUNN, MENUO. These sub-menus MUST
have these names! Only if these names exist would the corresponding menu
try to display. From ANY sub menu ANY command is available. You cannot
have a menu option 1 on one menu do something and a menu option 1 on
another menu do something else.

Reserved keys:
==============

Of course keys F through O are for use for sub menus only and will only
react in that fashion. The key E is for exiting the ppe and D is for
downloading a membership form.


Making an INVOICE
=================

- The name of the file to be created is can have any name, but it MUST
  coincide with the name given in the #.CNF file.(Language Extensions are
                                                               acceptable)

- You Can Use ANY PCBoard @X color code in the INVFORM file. These
  Will Be Stripped From The Actual Invoice That Is Printed To Disk.

- THIS IS IMPORTANT! The VERY last line of the INVFORM file MUST BE
  a Triple Asterisks  *** , or this process will NOT WORK AT ALL!

- All Invoice Variables MUST begin with a pipe symbol, | , and END with the
  SAME symbol. The characters in the center MUST be CAPITALIZED or they will
  NOT be recognized. For Example: |INV| (which prints the invoice number)...
  |inv. will be translated into nothing and be printed as you typed it.
  *** THE PROGRAM will NOT recognize the SAME macro TWICE on the SAME line


' Miscellaneous Information
' -------------------------
 |INV| = The Invoice Number
 |DAE| = Today's Date

' Information. Retrieved From The Configuration File
' -------------------------------------------
 |TXS| = The State you are collecting taxes for, as defined in CREDIT.CNF.
 |SYS| = The SysOp Name As Defined In The CREDIT.CNF File
 |BOA| = The Board Name As Defined In The CREDIT.CNF File

' Information About The Level Chosen
' ----------------------------------
 |OPT| = The Subscription Level Chosen By The Caller
 |OPP| = The Price Of The Subscription Option Chosen
 |DAT| = The NEW Expiration Date Of The Callers Membership
 |EXT| = The Additional Fee added to line 5 of the #.CNF file

' Mathematical Information
' ------------------------
 |ILL| = The Sum Of The (Processing Rate * The Cost Of The Membership) or in
          other words, The Total Processing Fee
 |TAX| = The Sum Of The (TAX Rate * The Cost Of The Membership) or in
          other words, The Total Tax Collecting
 |TOT| = The Total (Tax + Processing Fee + Base Cost of Membership)

' Credit Card Information
' -----------------------
 |NAC| = The Name Of The Credit Card Holder
 |STR| = The Street # Or PO BOX Of The Credit Card Holder
 |CIC| = The City, State And ZIP Of The Credit Card Holder
 |NUM| = The Phone Number Of The Credit Card Holder
 |CCT| = The Credit Card Type
 |FMT| = The Credit Card Number In Formatted Form, With Proper Spaces Added
 |EXP| = The Expiration Date On The Credit Card

' Caller Information
' ------------------
 |NAF| = The Full Name of The Caller

     +----------------------------------------------------------------+
     | Credit Card Subscription PPE: Replaceable lines in CREDIT file |
     +----------------------------------------------------------------+

Only CERTAIN lines in the CREDIT (prompt) file can use either a REGULAR line
of text OR the PCBoard way of displaying an entire file (%C\PATH\FILE.EXT)

These Lines are: 2, 3, 5, 17, 20, 21, 24, and 25.

* NOTE! - All files that do not use an EXTENSION can have ANY graphical
           indicator and/or language specific extension.

<End of file>
