Created : 15 April 2015
Last Modified : 27 April 2018

***********************************************************************************
Contents:

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. CHANGES
E. CONFIGURATION SETTINGS
F. DATABASE TABLES MODIFIED
G. LANGUAGE SETTINGS CHANGED
H. CHANGE LOGS
I.
TROUBLESHOOTING
J.
FAQ
K. COPYRIGHT NOTICE
L. TERMS AND CONDITIONS

***********************************************************************************

A. SUMMARY
==========

This is a summary of how to use VP-Cart's Pin Number add-on.

The full set of facilities of the Pin Number add-on are
described in the Add-Ons section of the VP-Cart Help Notes -

http://helpnotes.vpcart.com

The pin number enhancement will do the following:

1. At the end of an order, a pin number is looked up for
each product purchase and e-mailed to the customer.
Each product can have their own set of pin numbers.

2. Pin Numbers are included in the merchant confirmation

3. When Pin numbers reach a low level, a warning is sent
to the merchant

4. When Pin Numbers reach a critical level another warning
is sent to the merchant

5. Validates that payment is made according to your
specification before pin numbers are sent

***********************************************************************************

B. FILE STRUCTURE
===================

Files included in the zip are:
- $READ_ME_FIRST_pinnumbers900.html
- shoppinformat.asp
- shoppinnumbers.asp
- admin\shopa_pinadmin.asp
- admin\shopa_pincodes.asp
- admin\shopa_pinorder.asp
- admin\shopa_pinreport.asp
- admin\shoppinformat.asp
- admin]help\shoph_pincodes.asp
- admin]help\shoph_pinorder.asp
- templates\default\tmp_pincustomer.txt
- templates\default\tmp_pinorderfail.txt
- templates\default\tmp_pinproduct.txt

***********************************************************************************

C. INSTALLATION INSTRUCTION
============================

1. Back up the following VPASP files:

- shoppinformat.asp
- shoppinnumbers.asp
- admin\shopa_pinadmin.asp
- admin\shopa_pincodes.asp
- admin\shopa_pinorder.asp
- admin\shopa_pinreport.asp
- admin\shoppinformat.asp
- admin]help\shoph_pincodes.asp
- admin]help\shoph_pinorder.asp
- templates\default\tmp_pincustomer.txt
- templates\default\tmp_pinorderfail.txt
- templates\default\tmp_pinproduct.txt

* If you DO NOT made any changes to the above files, please ignore below section.

***********************************************************************************

If you HAVE made significant changes to your above files,
then please use winmerge to compare your codes.

To do this, please follow these steps.

1. Download a program called WinMerge (http://winmerge.sourceforge.net/), which will allow you to compare your files with those in the patch.

2. Unzip the patch files to a folder on your computer

4. Download the files included in the patch from your live site into another folder on your computer.

5. Run WinMerge and compare the contents of 2 folders.

6. Save the patched files.

7. Back up the files to be patched on the server.

8. Upload the patched files to your server

9. Test your site to ensure there have been no problems.

***********************************************************************************

2. Upload all the files into your shopping cart folder.

3. The Pin Number enhancement requires the VP-ASP Option Package.

4. New Shop Configuration

xpinnumber=Yes Turns on Pin Number Handling
xpinnumberlowlimit Set limit for Low Pin Number Merchant message
xpinproductmatch=CatalogId The default field to match in products table

Used to generate Pin Number confirmation email
xpinproductTemplate tmp_pinproduct.txt 'contains format for customer details
xpincustomerTemplate tmp_pincustomer.txt 'contains format for Pin Number display in email

-The two files are merged to create a single confirmation email.

Pin numbers will only be sent if a valid payment has been made.
In the Shop Configuration you need to set:
xendofordervalidpayments to include the valid payment type for a pin number
to be sent in the email.


***********************************************************************************

D. CHANGES
===============

NONE

***********************************************************************************

E. CONFIGURATION SETTINGS
=================

NONE


F. DATABASE TABLES MODIFIED
===========================

NONE

***********************************************************************************

G. LANGUAGE SETTINGS CHANGED
============================

NONE

***********************************************************************************

H. CHANGE LOGS
============================

2016.02.01 - Enhancement: Must always commit transaction if execute sql execute
2017.04.27 - Better handling on creating new records on huge tables
2018.04.26 - Compatible with v9

***********************************************************************************

I. TROUBLESHOOTING
============================

Please submit a ticket to our helpdesk at https://helpdesk.vpcart.com and our support team will assist you.

***********************************************************************************

J. FAQ
============================

NONE

***********************************************************************************
K. COPYRIGHT NOTICE
============================

Copyright (c) 1999-2019 Rocksalt International Pty. Ltd.
All rights reserved.

This software and documentation constitute a published work and
contains valuable trade secrets and proprietary information
belonging to Rocksalt International Pty. Ltd. .
None of the foregoing material may be copied,
duplicated or disclosed without the express written permission
of Rocksalt International Pty. Ltd. .

LICENSEE ACCEPTS VP-ASP Shopping Cart "AS IS" "WITH ALL FAULTS",
Rocksalt International Pty. Ltd. accepts no responsibility for the
operation or performance of the VP-ASP Shopping Cart.
The entire risk of use and consequences of use of the
VP-ASP Shopping Cart falls completely on the Licensee
and Rocksalt International Pty. Ltd. shall not be liable in any respect
for any claims, loss or injury alleged to have resulted
from use of or in reliance on VP-ASP Shopping Cart.

Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability
and understands that Licensee assumes
the entire risk of using VP-ASP Shopping Cart.


***********************************************************************************

L. TERMS AND CONDITIONS
============================
ROCKSALT INTERNATIONAL GRANTS TO THE LICENSEE A NON-EXCLUSIVE,
NON-SUB LICENSABLE, NONTRANSFERABLE LICENSE
TO INSTALL AND USE THIS APPLICATION ON A SINGLE DOMAIN FOR
A SINGLE SHOP.

THE CODE IN THE APPLICATION MAY BE MODIFIED FOR USE IN
SETTING UP A SINGLE SHOPPING SITE ON THE WORLD WIDE WEB.

LICENSEE MAY MAKE A COPY OF THE APPLICATION FOR
BACK-UP AND ARCHIVAL PURPOSES, PROVIDED THAT ANY COPY
MUST CONTAIN ALL PROPRIETARY NOTICES INCLUDED
WITH THE APPLICATION.

LICENSEE IS PROHIBITED FROM SELLING OR DISTRIBUTING
THE APPLICATION IN ANY MANNER.

LIMITATION OF LIABILITY.

ROCKSALT INTERNATIONAL AND ITS LICENSORS SHALL
NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING THIS
APPLICATION.

IN NO EVENT WILL ROCKSALT INTERNATIONAL OR ITS LICENSORS
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA,
OR FOR DIRECT, INDIRECT, SPECIAL,
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES,
HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LI
ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE,
EVEN IF ROCKSALT INTERNATIONAL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.