ReadMe File for the BizDB Lead Generator Facility

####################################################################
#                                                                  #
# BizDB Lead Generator - An Add On Facility of BizDB Database S/W  #
#                                                                  #
####################################################################
#
# E-mail: cnctek@cnctek.com
# 
# MINIMUM SERVER REQUIREMENTS:
#
# Runs on any Unix, Linux or Windows NT Operating System;
# Provides full FTP access (or access via a Control Panel);
# Supports Perl and cgi-bin; Allows creation of files and
# directories by cgi programs; Needs BizDB Advance already installed.
#
#
# COPYRIGHT NOTICE                                                         
# All BizDB products are products of CNC Technology. All rights reserved. 
# Only the user with our permission can use and modify this software.         
# Also permission is granted to execute this software on one domain name
# only. Without CNC Technology's permission, no part of this script can be           
# reproduced ( other than the backup copy ), resold or redistributed to
# any other indivituals, companies and organizations. 
#                     
# DISCLAIMER:
#
# All software and templates are provided on a "As Is" basis. CNC
# Technology will not be liable ( nor responsible ) whatsoever for
# any direct or indirect damages caused by the use of this Software
# ( or Scripts ).
#
##################################################################


Please read the following paragraphs carefully. This is essential
if you want to have a smooth and successful installation.


IMPORTANT NOTE: This Web based "BizDB Lead Generator" software
is an add on facility of our BizDB Database Software. Before installing
and using this software, you must have either "BizDB Starter" or
"BizDB Standard" or "BizDB Advance" database system installed on
your server. Through your BizDB installation, you have demonstrated
that you are able to add, update, delete, search and display BizDB
database records. You should have no problem to define BizDB
database fields and the associated Html templates.

(You can test and order our BizDB software directly from our Web site
located at http://www.cnctek.com/bizdb-html/ . Thank you.)



##################################################################

TABLE OF CONTENTS:
A.  Contents in our ZIP file
B.  System Configuration Parameters
C.  How the "BizDB Lead Generator" System Works
D.  How to build the "Company Contact (Lead) Request" Report Template
E.  How to build the "Review Basket" Html Template
F.  How to build the "Company Contact (Lead) E-mail Message" Template
G.  Installation Notes

##################################################################


A. Contents in our ZIP file

After decompressing the ZIP file by WinZIP/Win 95/98/2000, you should
find the following files:

    (1) contacts-search.cgi -  CGI script used for Searching and
        (program)           displaying multiple database records at
                            one time. This is an enhanced version
                            of the BizDB Advance bizdb-search.cgi
                            script with capacity to support the new
                            online contacts facility.

                            NOTE: "contacts-search.cgi" can be used
                            to replace the "bizdb-search.cgi" script.
                            You can either use "contacts-search.cgi"
                            or "bizdb-search.cgi" for general search
                            purposes. However you must use
                            "contacts-search.cgi" for sending e-mails
                            to companies displayed on the search report.

    (2) contacts-add     -  The sample Add DB record Html template.
        (template)          All database fields are defined and
                            referenced here. (See BizDB readme.txt)

    (3) contacts-edit    -  The sample Edit/Delete/Show DB record
        (template)          Html template. You will use this template
                            to retrieve and edit/delete a specific
                            DB record ( based on record key ). (See
                            BizDB readme.txt)

    (4) contacts-delete  -  The sample Delete DB records (Batch) Html
        (template)          template. You will use this template
                            to delete multiple database records
                            by matching their creation dates against
                            the date range specified by the Webmaster.
                            (See BizDB readme.txt)

    (5) contacts-search  -  The sample Search DB records Html
        (template)          template. You will use this template
                            to specify search criteria ( keywords )
                            for the contacts-search.cgi program.
                            (See BizDB readme.txt)

    (6) contacts-report  -  The sample Display DB Records Html
        (template)          template. You will use this template
                            to define which and how DB fields are to be
                            displayed in the search report. Fields
                            belonging to the same record will be
                            displayed in a group. This will be repeated
                            for each record until all records are
                            displayed.

    (7) contacts_review_basket
        (template)       -  The sample "Review Records in Basket" Html 
                            template. You will use this template
                            to define which and how DB fields are to be
                            displayed in the "Review Basket" report.
                            Fields belonging to the same record will be
                            displayed in a group. This will be repeated
                            for each record until all records are
                            displayed.
                    
    (8) contacts_email_msg.tmpl
        (template)       -  This template defines the format and content
                            of the e-mail message to be sent to the
                            requested companies.
                    
    (9) contacts-index.html 
                         -  The sample home page for calling various
                            Lead Generator database functions, such as
                            Add, Edit, Delete and Search. You can use
                            this home page to test your database.
                            **NOTE** You must have BizDB installed
                            to support the Add, Edit, Delete and Search
                            functions. Use this add on feature only
                            if you want to send a standard e-mail to
                            each of the companies selected from the
                            Search Result report.

   (10) contacts-readme.txt
                         -  It's this document.

   (11) contacts-db      -  Sample service provider (company) database
                            file. The format of this file is a standard
                            BizDB database file. You can use a different
                            name for this file if you like. Please reflect
                            the correct name in the "dbname" FORM statement
                            in your various BizDB templates.
                            (See BizDB readme.txt)


If you have used our development assistance, we will include more files
to meet your specific needs. This will be mentioned in a separate document
or e-mails.



B.  System Configuration Parameters:

Please make sure you have the following parameters in the new
contacts-search.cgi program properly configured before uploading it to the
CGI-BIN directory.

NOTE: You should use bizdb-aed.cgi, bizdb_upload.cgi and contacts-search.cgi
to set up your "Lead Generator" database system. Both bizdb-search.cgi and
contacts-search.cgi are search engine programs, but only contacts-search.cgi
is designed for the "Lead Generator" database.


     Parameter Name    Where                Description

 (1) $maxfields        contacts-search.cgi  Maximum number of DB Fields.

 (2) $maxdisplay       contacts-search.cgi  Maximum number of records
                                            to be extracted in each search.

 (3) $maxdispscreen    contacts-search.cgi  Max Records to be displayed
                                            per screen.

 (4) $database_dir     contacts-search.cgi  Full pathname of the directory
                                            in which your database is
                                            stored. If possible, location of
                                            your database file should be
                                            stored outside the Html directories.

 (5) $template_dir     contacts-search.cgi  Full pathname of directory in
                                            which all Html templates are
                                            stored.

 (6) $upload_dir       contacts-search.cgi  Full pathname of directory
                                            where the uploaded (image) file
                                            will be stored.

 (7) $return_url       contacts-search.cgi  Return URL link used by OK and
                                            error messages.

 (8) @valid            contacts-search.cgi  These are the urls (separated
                                            by comma) that are allowed to
                                            execute this database system.
                                            This prevents any of our
                                            programs to be accessed by
                                            unauthorized Websites.

 (9) $this_cgi_url     contacts-search.cgi  Url of the CGI script you are
                                            working on. Include http://

(10) $sorttype_default contacts-search.cgi  Define the sequence of sorting
                                            if "sortfield" exists. Default
                                            setting is "alpha-ascend",
                                            i.e. sort alphabets in
                                            ascending sequence.

              ################################################
        * * * Parameters (11,12) are to be used together * * *

(11) $days_for_new_entries                  If the record was just 
                       contacts-search.cgi  submitted in the last so many
                                            days, the new.gif or new.jpg 
                                            will be displayed.

(12) new_image         contacts-search.cgi  Url of new.gif or new.jpg
                                            This image is used to indicate
                                            the record is a new one.

              #############################################
        * * * Parameters (13,14,15) are to be used together * * *

(13) $rotate_db_records                     Set this parameter to "yes"
                       contacts-search.cgi  if you want to rotate the
                                            database records at the change
                                            of a day when the database is
                                            searched. The program will
                                            ensure that this is done once
                                            a day. Otherwise set it to "".

(14) $rotation_count   contacts-search.cgi  This defines how many records
                                            are to be rotated to the top
                                            of the database file each time.

(15) $last_rotated_date_file                This is the file containing
                       contacts-search.cgi  the date of last rotation.

              #############################################

(16) @inhtml_array     contacts-search.cgi  Webmasters can allocate 1
                                            or more database fields to
                                            point to system files
                                            containing fixed Html codes
                                            which can be used for
                                            advertising purpose. Normally
                                            these database fields are
                                            defined as hidden fields
                                            in the ADD, EDIT and/or
                                            ACTIVATE templates, therefore
                                            their contents are not
                                            updatable by general users.
                                            For details of the use of
                                            this feature, please read
                                            Section J.

              #############################################
        This parameter is used for generating the "Company Contact" e-mails.

(17) $mailprog         contacts-search.cgi  Location of the "sendmail"
                                            program. You will need "sendmail"
                                            to send the generated e-mails if
                                            the "send_report_option" input
                                            form field exists in your
                                            "Search Report" Html template.
                                            Check with your ISP.

              #############################################

(18) $delimitor        contacts-search.cgi  Field delimitor. 
                                            The setting here must be identical
                                            to that used in the bizdb-aed.cgi
                                            script.

(19) $uid_pwd_sep      contacts-search.cgi  Used in field-1 (f1) for 
                                            separating the UserID(RecordID)
                                            from the password.
                                            The setting here must be identical
                                            to that used in the bizdb-aed.cgi
                                            script.

              #############################################

(20) $charset          contacts-search.cgi  Define the character set to
                                            be used by your database software
                                            and Html templates. This is
                                            required for some foreign
                                            languages. (See BizDB readme.txt)



C.  How the "BizDB Lead Generator" System Works:

The "BizDB Lead Generator" system works as follows:

(1) User displays the "Add Contact Record" screen ( sample template
    fielname = contacts-add ) to add a new company record. This is a
    standard BizDB database function (see BizDB readme.txt).

(2) User displays the "Edit Contact Record" screen ( sample template
    filename = contacts-edit ) to start editing an existing record. Before
    Editing or Deleting a record, the user must display the content of an
    existing Record ID first using the "Show Record" function. This is a
    standard BizDB database function (see BizDB readme.txt).

(3) User displays the "Search Contact Records" screen ( sample template
    filename = contacts-search ) to start searching the company database.
    The user may use either the Quick Search or Complex Search method to
    search the database. This is a standard BizDB database function
    (see BizDB readme.txt).

(4) If there are records matching the user's request, a report ( defined by
    the sample template with filename = contacts-report ) containing the
    key information of each company record will be displayed on the screen.
    Also on the report will be a number of fields available for the user to
    complete when he is ready to raise a company contact (lead) e-mail request.
    Some of the important fields are "Email address", "Contact Person,
    "Subject" and the "Check to Request" checkbox next to each record displayed.

(5) By checking the checkboxes on the left of the search result, the user
    may select as many company records as he like for inclusion into the 
    e-mail list. If one search is not enough, the user may carry out multiple
    searches. All record selected by the user will be saved in a cookie basket
    for later use until the basket is cleared or the browser is restarted. The
    user may also click the "Review Basket" button to review the records he has
    selected so far. If necessary, he can remove some of them by clicking the
    "Remove Item" link displayed next to each item.

(6) When the system receives the company contact (lead) request, it will
    generate an e-mail with identical message content to each of the companies
    selected. The content of the e-mail message can be pre-installed in the
    server using the "contacts_email_msg.tmpl" template.



D.  How to build the "Company Contact (Lead) Request" Report Template:

    Our sample template filename is "contacts-report".

    The structure of the template is as follows:

       <html>
       <head>
        .........
        <script language="Javascript">
        function getCookieVal(offset) {
              ......
        }
        function GetCookie(name) {
              ......
        }
        function SetCookie(name,value) {
              ......
        }
        function DeleteCookie(name) {
              ......
        }
        function add(key,flag) {
              ......
        }
        function sendQuoteRequest() {
              ......
        }
        function resetBasket() {
              ......
        }
        function reviewBasket() {
              ......
        }
        function setCheckbox(val) {
              ......
        }
        </script>
       </head>
       <body>
          ......
          ......
          <form name="cboxform">
          <table ...>
          <!--repeat-->
             ......
             ......
             <input type="checkbox" name="**cbox**" value="KEY_**key**" onClick="add('**key**',this)">
             ......
             ......
          <!--endrepeat-->
          </table>
          </form>
          ......
          ......
          <div align=center>
          <a href="javascript:setCheckbox('1')">Check All</a>
          -- 
          <a href="javascript:setCheckbox('0')">Clear All</a>
          </div>
          ......
          ......
          <div align=center>
          <form method="post" action="/cgi-bin/contacts-search.cgi">
          <input type=hidden name="template" value="contacts-search">
          <input type=hidden name="action" value="showblank">
          <input type=button name="button" value="Search Again" onClick="submit()">
          </form>
          </div>
          ......
          ......
          <form name="contactsform" method=Post action="/cgi-bin/contacts-search.cgi">
                ......
          </form>
          ......
          ......
          <div align=center>
          <form>
          <input type=button name="button" value="Review Basket"
                 onClick="reviewBasket()">
          </form>
          </div>
          <div align=center>
          <form>
          <input type=button name="button" value="Send Contact Request"
                 onClick="sendContactsRequest()">
          </form>
          </div>
          <div align=center>
          <form>
          <input type=button name="button" value="Clear Basket"
                 onClick="resetBasket()">
          </form>
          </div>
          ......
       </body>
       </html>


    (1) JavaScripts:

        <!-- Start of Javascript -->
        <script language="Javascript">
        function getCookieVal(offset) {
           var endstr = document.cookie.indexOf (";", offset);
           if (endstr == -1) {
              endstr = document.cookie.length;
           }
           return unescape(document.cookie.substring(offset, endstr));
        }
        function GetCookie(name) {
           var arg = name + "=";
           var alen = arg.length;
           var clen = document.cookie.length;
           var i = 0;
           while ( i < clen ) {
              var j = i + alen;
              if (document.cookie.substring(i,j) == arg) {
                 return getCookieVal(j);
              }
              i = document.cookie.indexOf(" ",i) + 1;
              if (i==0) break;
           }
           return "";
        }
        function SetCookie(name,value) {
           document.cookie = name + "=" + escape(value);
        }
        function DeleteCookie(name) {
           if (GetCookie(name)) {
              document.cookie = name + "=";
           }
        }
        function add(key,flag) {
           cookieContent = GetCookie('cookie3');
           if (flag.checked) {
              if (cookieContent == "") {
                 SetCookie('cookie3',key);
              } else {
                 var regexp = /]/;
                 var newArray = new Array;
                 newArray = cookieContent.split(regexp);
                 var itemCount = newArray.length;
                 zz = "";
                 for (var i=0; i<itemCount; i++) {
                    if (newArray[i] != key) {
                       if (newArray[i]) {
                          zz += newArray[i] + "]";
                       }
                    }
                 }
                 zz += key;
                 SetCookie('cookie3',zz);
              } 
           } else {
              if (cookieContent != "") {
                 var regexp = /]/;
                 var newArray = new Array;
                 newArray = cookieContent.split(regexp);
                 var itemCount = newArray.length;
                 zz = "";
                 for (var i=0; i<itemCount; i++) {
                    if (newArray[i] != key) {
                       if (newArray[i]) {
                          zz += newArray[i] + "]";
                       }
                    }
                 }
                 SetCookie('cookie3',zz);
              } 
           }
        }
        function sendContactsRequest() {
           cookieContent = GetCookie('cookie3');
           if (cookieContent == "") {
              alert ("No items selected! Please check your selections.");
           } else {
              var regexp = /]/;
              var newArray = new Array;
              newArray = cookieContent.split(regexp);
              var itemCount = newArray.length;
              list = "";
              for (var i=0; i<itemCount; i++) {
                 if (newArray[i]) {
                    j = itemCount - 1;
                    if (i < j) {
                       list += newArray[i] + ",";
                    } else {
                       list += newArray[i];
                    }
                 }
              }
              document.contactsform.key_list.value = list;
              document.contactsform.submit();
           }
        }
        function resetBasket() {
           for(var i=0; i<document.cboxform.elements.length; i++) {
              indexName = document.cboxform.elements[i].name.indexOf("cbox_");
              if (indexName == 0) {
                 document.cboxform.elements[i].checked=0;
              }
           }
           DeleteCookie('cookie3');
           alert ("Your basket has been reset!");
        }
        function reviewBasket() {
           cookieContent = GetCookie('cookie3');
           if (cookieContent == "") {
              alert ("Your basket is empty at the moment!");
           } else {
              var regexp = /]/;
              var newArray = new Array;
              newArray = cookieContent.split(regexp);
              var itemCount = newArray.length;
              list = "";
              for (var i=0; i<itemCount; i++) {
                 if (newArray[i]) {
                    j = itemCount - 1;
                    if (i < j) {
                       list += newArray[i] + ",";
                    } else {
                       list += newArray[i];
                    }
                 }
              }
              document.contactsform.key_list.value = "[review]," + list;
              document.contactsform.submit();
           }
        }
        function setCheckbox(val) {
           cookieContent = GetCookie('cookie3');
           var regexp = /]/;
           var oldArray = new Array;
           var itemCount = 0;
           if (cookieContent != "") {
              oldArray = cookieContent.split(regexp);
              itemCount = oldArray.length;
           }
           var keyCount = 0;
           var newArray = new Array;
           for(var i=0; i<document.cboxform.elements.length; i++) {
              indexName = document.cboxform.elements[i].name.indexOf("cbox_");
              if (indexName == 0 && document.cboxform.elements[i].type == 'checkbox') {
                 if (val == '1' || val == '0') {
                    indexValue = document.cboxform.elements[i].value.indexOf("KEY_");
                    if (indexValue == -1) {
                       alert ("Incorrect key detected! Please contact Webmaster!");
                    }
                    else {
                       begin = 4;
                       end = document.cboxform.elements[i].value.length;
                       key = document.cboxform.elements[i].value.substring(begin,end);
                       newArray[keyCount] = key;
                       keyCount = keyCount + 1;
                    }
                 }
                 if (val == "0") {
                    document.cboxform.elements[i].checked=0;
                 } else {
                    document.cboxform.elements[i].checked=val;
                 } 
              }
           }
           zz = "";
           for (var i=0; i<itemCount; i++) {
              if (oldArray[i]) {
                 for (var j=0; j<keyCount; j++) {
                    if (oldArray[i] == newArray[j]) {
                       newArray[j] = "";
                       if (val == '0') {
                          oldArray[i] = "";
                       }
                    }
                 }
                 if (oldArray[i] != "") {
                    zz += oldArray[i] + "]";
                 }
              }
           }
           for (var j=0; j<keyCount; j++) {
              if (newArray[j] != "" && val == '1') {
                 zz += newArray[j] + "]";
              }
           }
           SetCookie('cookie3',zz);
        }
        function openwindow(url,winname,width,height) {
           xposition=0; yposition=0;
           args = "width=" + width + ",height=" + height + "," + "location=0,menubar=0,resizable=0,scrollbars=1,status=0,titlebar=0,toolbar=0,hotkeys=0";
           window.open(url,winname,args);
        }
        </script>
        <!-- End of Javascript -->


        You must copy the whole block of this Javascript to the header
        section (between <head> and </head>) of your search report template
        without any modifications.


    (2) <form name="contactsform" method=Post action="/cgi-bin/contacts-search.cgi">
        <input type=hidden name="dbname" value="contacts-db">
        <input type=hidden name="wordmatch-f5" value="yes">
        <input type=hidden name="f5" value="Active">
        <input type=hidden name="action" value="searchdbdisplay">

        <input type=hidden name="template" value="contacts_email_msg.tmpl">
        <input type=hidden name="review_template" value="contacts_review_basket">
        <input type=hidden name="send_report_option" value="by email">
        <input type=hidden name="vendor_email" value="f8">

        <input type=hidden name="key_list" value="">

        Your E-mail: <input name="email" value="">
        Contact Person: <input name="contact" value="">
        Company: <input name="company" value="">
        Address: <input name="address" value="">
        City: <input name="city" value="">
        State: <input name="state" value="">
        Country: <input name="country" value="">
        ZIP / Postcode: <input name="zip" value="">
        Phone: <input name="phone" value="">
        Subject: <input name="subject" value="">
        Your Message: <input name="message" value="">

        </form>
      
        This form defines how the "Company Contact (Lead) E-mails" are generated.

        You must have the name="contactsform" defined in the <form> statement.
        You must also have the parameter "key_list" defined as empty ("").

        You must also include the following INPUT statements in your "contactsform" form:

           <!-- See our "contacts-report" template for a real example -->

           Your E-mail: <input name="email" value="">
           Contact Person: <input name="contact" value="">
           Company: <input name="company" value="">
           Address: <input name="address" value="">
           City: <input name="city" value="">
           State: <input name="state" value="">
           Country: <input name="country" value="">
           ZIP / Postcode: <input name="zip" value="">
           Phone: <input name="phone" value="">
           Subject: <input name="subject" value="">
           Your Message: <input name="message" value="">

        Our "contacts-search.cgi" program will use this formation to generate
        the Company Contact (Lead) E-mails.

        For definitions of other parameters, please refer to descriptions
        below.


    (3) <input type="checkbox" name="**cbox**" value="KEY_**key**"
               onClick="add('**key**',this)">

        This form statement must be defined once within the
              <!--repeat--> and <!--endrepeat-->
        statements. Everything defined in this FORM statement must not be changed.

        It is also important to know that the pair of <form name="cboxform">
        ... </form> statements must be inserted just outside the
        <table ..> ... </table> which is used to contain the
        <!--repeat--> .... <!--endrepeat--> block.

        Now if the checkboxes in this FORM is checked by the visitor, the "add"
        JavaScript function will be activated. It will extract the corresponding
        Record ID (record key) defined in this form and add it to the cookie
        basket for later use (The cookie basket will be used by the
        "sendContactsRequest" JavaScript function when the "Send Contact Request"
        button is clicked).


    (4) <div align=center>
        <a href="javascript:setCheckbox('1')">Check All</a>
        -- 
        <a href="javascript:setCheckbox('0')">Clear All</a>
        </div>

        The above optional statements can be inserted just before or after the
        record display table. If used, they will allow your user to set or clear
        all checkoxes on the current page at one goal.

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

        <div align=center>
        <form method="post" action="/cgi-bin/contacts-search.cgi">
        <input type=hidden name="template" value="contacts-search">
        <input type=hidden name="action" value="showblank">
        <input type=button name="button" value="Search Again" onClick="submit()">
        </form>
        </div>
        ......
        <div align=center>
        <form>
        <input type=button name="button" value="Review Basket"
               onClick="reviewBasket()">
        </form>
        </div>
        <div align=center>
        <form>
        <input type=button name="button" value="Send Contact Request"
               onClick="sendContactsRequest()">
        </form>
        </div>
        <div align=center>
        <form>
        <input type=button name="button" value="Clear Basket"
               onClick="resetBasket()">
        </form>
        </div>

        The "Review Basket", "Send Contact Request" and "Clear Basket" forms
        must be inserted without change after the following template statements:

           <form name="cboxform">
           <table ..>
              ......
           <!--repeat-->
              ......
           <!--endrepeat-->
              ......
           </table>
           </form>

        If the "Send Contact Request" button is clicked, the "sendContactsRequest"
        JavaScript function will be activated. The value of the "key_list"
        parameter (defined in the "contactsform" FORM) will be constructed based
        on the content stored in the cookie basket. The content of the "contactsform"
        will then be forwarded to the "contacts-search.cgi" program for the
        generation of the Company Contact (Lead) E-mails.

        If the "Clear Basket" button is clicked, the "resetBasket" JavaScript
        function will be activated. The content of the cookie basket as well as
        all the checkboxes on the current page will be cleared.

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

    The report defined by this template serves two purposes.

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

    (1) Firstly it defines the exact content and layout of the search report to
        be displayed on the screen.


Example: In the following Html codes, **key**, **f6**, **f7**, **f9**, **f10**
tell the system that only the record key and the content of field # 6, 7, 9
and 10 of each of the selected records are to be displayed on the specified
page position.


<!--repeat-->
<tr valign=top align=center>
<td width=5% bgcolor=**bgcolor**><font size=2 face="arial"><input type="checkbox" name="**cbox**" value="KEY_**key**" onClick="add('**key**',this)"></font></td>
<td width=20% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>
<!-- check-display-f10-
<a href="**f10**" onClick="openwindow('**f10**', '','500','440');return false;">
check-display-f10- -->
**f6**
<!-- check-display-f10-
</a>
check-display-f10- -->
&nbsp;</div></font></td>
<td width=40% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>**f7** &nbsp;</div></font></td>
<td width=35% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>**f9** &nbsp;</div></font></td>
</tr>
<!--endrepeat-->


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

    (2) Secondly it acts as an interface for the visitor to tell the system
        what database records are to be retrieved and how the Company Contact
        (Lead) E-mails are generated and transmitted to the requested companies.


Example: The following codes tell the "contacts-search.cgi" program to search
the "contacts-db" database file, generate the Company Contact (Lead) E-mails
based on the message stored in the "contacts_email_msg.tmpl" template.


<form name="contactsform" method=POST action="/cgi-bin/contacts-search.cgi">
       --> This statement is to call the new version of contacts-search.cgi
           which can support the "BizDB Lead Generator" feature.
       --> Your must include this ' name="contactsform" ' clause into
           this <Form ...> statement. This form will be used by the JavaScript
           on the same template.

<input type=hidden name="dbname" value="contacts-db">
       --> This dbname statement defines the name of the company
           database to be searched.

<input type=hidden name="wordmatch-f5" value="yes">
<input type=hidden name="f5" value="Active">
<input type=hidden name="action" value="searchdbdisplay">
       --> This are standard BizDB command statements.
           See BizDB readme.txt

<input type=hidden name="template" value="contacts_email_msg.tmpl">
       --> This template stores the content of the standard message to
           be e-mailed to the selected companies.

<input type=hidden name="review_template" value="contacts_review_basket">
       --> This template statement defines the content and layout
           of the "Review Basket" report to be generated.

<input type=hidden name="send_report_option" value="by email">
       --> This statement is to turn on the "BizDB Lead Generator"
           facility.

<input type=hidden name="vendor_email" value="f??">
       --> This statement defines which field number in the company database
           stores the company e-mail address.

<input type=hidden name="key_list" value="">
       --> This statement must exist in the "contactsform" FORM and must
           not be modified. The value of the "key_list" will be evaluated
           by the supplied "add" JavaScript.

          :          :          :
<input type=text name="email" size=15 maxlength=60>
       --> User input field. The content is the contactable e-mail address
           of the visitor.
          :          :          :
<input type=text name="contact" size=15 maxlength=30>
       --> User input field. The content is the name of the visitor.
          :          :          :
<input type=text name="company" size=30 maxlength=80>
       --> User input field (optional). The content is the company name of the visitor.
          :          :          :
<input type=text name="address" size=30 maxlength=80>
       --> User input field (optional). The content is the street address of the visitor.
          :          :          :
<input type=text name="city" size=30 maxlength=80>
       --> User input field (optional). The content is the city location of the visitor.
          :          :          :
<input type=text name="state" size=30 maxlength=80>
       --> User input field (optional). The content is the state location of the visitor.
          :          :          :
<input type=text name="country" size=30 maxlength=80>
       --> User input field (optional). The content is the country location of the visitor.
          :          :          :
<input type=text name="zip" size=15 maxlength=30>
       --> User input field (optional). The content is the ZIP code / Postcode of the visitor.
          :          :          :
<input type=text name="phone" size=15 maxlength=30>
       --> User input field (optional). The content is the phone number of the visitor.
          :          :          :
<input type=text name="subject" size=15 maxlength=80 value="Company Inquiry Request">
       --> User input field. The content is the subject title of the e-mail
           to be generated.
          :          :          :
<textarea name="message" cols=40 rows=6>
       --> User input field. The visitor can specify his own message. This
           message will be sent to the selected companies.
       --> NOTE: If this field is empty or if this field is removed, the system
           will use the content stored in the "Company Contact E-mail Message"
           Template (See section E) to build the e-mails.
          :          :          :


    Please pay special attention to the Checkbox FORM statement:
    <input type="checkbox" name="**cbox**" value="KEY_**key**" onClick="add('**key**',this)">

    This must be inserted between the <!--repeat--> and 
    <!--endrepeat--> tags.

    >>> It is also important to know that the pair of <form name="cboxform">
    >>> ... </form> must be inserted just outside the <table ..> ... </table>
    >>> used to contain the <!--repeat--> .... <!--endrepeat--> block.

    On the search report displayed on the screen, if the Record ID of the
    record to be displayed is "123",  this form statement will be displayed
    as:
        <input type="checkbox" name="cbox_n" value="KEY_123" onClick="add('123',this)">

    This INPUT form statement will be generated repeatly for each record
    displayed on the screen.

    If this checkbox on the screen is checked by the visitor, the system will
    know that a "Request for Information" e-mail will have to be generated to
    this particular company.



E.  How to build the "Review Basket" Html Template:

    Our sample template filename is "contacts_review_basket".

    The structure of the template is as follows:

       <html>
       <head>
        .........
        <script language="Javascript">
        function getCookieVal(offset) {
              ......
        }
        function GetCookie(name) {
              ......
        }
        function SetCookie(name,value) {
              ......
        }
        function DeleteCookie(name) {
              ......
        }
        function sendQuoteRequest() {
              ......
        }
        function resetBasket() {
              ......
        }
        function reviewBasket() {
              ......
        }
        function removeItem() {
              ......
        }
        </script>
       </head>
       <body>
          ......
          <form name="contactsform" method=Post action="/cgi-bin/contacts-search.cgi">
                ......
          </form>
          .....
          ......
          <table ...>
          <!--repeat-->
             ......
             ......
             ......
             <td> ... **remove** ... </td>
             ......
          <!--endrepeat-->
          </table>
          ......
          ......
          <div align=center>
          <form method="post" action="/cgi-bin/contacts-search.cgi">
          <input type=hidden name="template" value="contacts-search">
          <input type=hidden name="action" value="showblank">
          <input type=button name="button" value="Search Again" onClick="submit()">
          </form>
          </div>
          ......
          <div align=center>
          <form>
          <input type=button name="button" value="Review Basket"
                 onClick="reviewBasket()">
          </form>
          </div>
          <div align=center>
          <form>
          <input type=button name="button" value="Send Contact Request"
                 onClick="sendContactsRequest()">
          </form>
          </div>
          <div align=center>
          <form>
          <input type=button name="button" value="Clear Basket"
                 onClick="resetBasket()">
          </form>
          </div>
          ......
       </body>
       </html>


    (1) JavaScripts:

        <!-- Start of Javascript -->
        <script language="Javascript">
        function getCookieVal(offset) {
           var endstr = document.cookie.indexOf (";", offset);
           if (endstr == -1) {
              endstr = document.cookie.length;
           }
           return unescape(document.cookie.substring(offset, endstr));
        }
        function GetCookie(name) {
           var arg = name + "=";
           var alen = arg.length;
           var clen = document.cookie.length;
           var i = 0;
           while ( i < clen ) {
              var j = i + alen;
              if (document.cookie.substring(i,j) == arg) {
                 return getCookieVal(j);
              }
              i = document.cookie.indexOf(" ",i) + 1;
              if (i==0) break;
           }
           return "";
        }
        function SetCookie(name,value) {
           document.cookie = name + "=" + escape(value);
        }
        function DeleteCookie(name) {
           if (GetCookie(name)) {
              document.cookie = name + "=";
           }
        }
        function add(key,flag) {
           cookieContent = GetCookie('cookie3');
           if (flag.checked) {
              if (cookieContent == "") {
                 SetCookie('cookie3',key);
              } else {
                 var regexp = /]/;
                 var newArray = new Array;
                 newArray = cookieContent.split(regexp);
                 var itemCount = newArray.length;
                 zz = "";
                 for (var i=0; i<itemCount; i++) {
                    if (newArray[i] != key) {
                       if (newArray[i]) {
                          zz += newArray[i] + "]";
                       }
                    }
                 }
                 zz += key;
                 SetCookie('cookie3',zz);
              } 
           } else {
              if (cookieContent != "") {
                 var regexp = /]/;
                 var newArray = new Array;
                 newArray = cookieContent.split(regexp);
                 var itemCount = newArray.length;
                 zz = "";
                 for (var i=0; i<itemCount; i++) {
                    if (newArray[i] != key) {
                       if (newArray[i]) {
                          zz += newArray[i] + "]";
                       }
                    }
                 }
                 SetCookie('cookie3',zz);
              } 
           }
        }
        function sendContactsRequest() {
           cookieContent = GetCookie('cookie3');
           if (cookieContent == "") {
              alert ("No items selected! Please check your selections.");
           } else {
              var regexp = /]/;
              var newArray = new Array;
              newArray = cookieContent.split(regexp);
              var itemCount = newArray.length;
              list = "";
              for (var i=0; i<itemCount; i++) {
                 if (newArray[i]) {
                    j = itemCount - 1;
                    if (i < j) {
                       list += newArray[i] + ",";
                    } else {
                       list += newArray[i];
                    }
                 }
              }
              document.contactsform.key_list.value = list;
              document.contactsform.submit();
           }
        }
        function resetBasket() {
           DeleteCookie('cookie3');
           alert ("Your basket has been reset!");
        }
        function reviewBasket() {
           cookieContent = GetCookie('cookie3');
           if (cookieContent == "") {
              alert ("Your basket is empty at the moment!");
           } else {
              var regexp = /]/;
              var newArray = new Array;
              newArray = cookieContent.split(regexp);
              var itemCount = newArray.length;
              list = "";
              for (var i=0; i<itemCount; i++) {
                 if (newArray[i]) {
                    j = itemCount - 1;
                    if (i < j) {
                       list += newArray[i] + ",";
                    } else {
                       list += newArray[i];
                    }
                 }
              }
              document.contactsform.key_list.value = "[review]," + list;
              document.contactsform.submit();
           }
        }
        function removeItem(key) {
           cookieContent = GetCookie('cookie3');
           if (cookieContent == "") {
              alert ("Your basket is empty at the moment!");
           } else {
              var regexp = /]/;
              var newArray = new Array;
              newArray = cookieContent.split(regexp);
              var itemCount = newArray.length;
              list = "";
              zz = "";
              for (var i=0; i<itemCount; i++) {
                 if (newArray[i] && newArray[i] != key) {
                    j = itemCount - 1;
                    if (i < j) {
                       list += newArray[i] + ",";
                    } else {
                       list += newArray[i];
                    }
                    zz += newArray[i] + "]";
                 }
              }
              SetCookie('cookie3',zz);
              document.contactsform.key_list.value = "[review]," + list;
              document.contactsform.submit();
           }
        }
        function openwindow(url,winname,width,height) {
           xposition=0; yposition=0;
           args = "width=" + width + ",height=" + height + "," + "location=0,menubar=0,resizable=0,scrollbars=1,status=0,titlebar=0,toolbar=0,hotkeys=0";
           window.open(url,winname,args);
        }
        </script>
        <!-- End of Javascript -->


        You must copy the whole block of this Javascript to the header
        section (between <head> and </head>) of your search report template
        without any modifications.


    (2) The "contactsform" used by the "Review Basket" template must be identical
        to that used by the "Company Contact (Lead) Request" Report Template
        (see Section D above).

        <form name="contactsform" method=Post action="/cgi-bin/contacts-search.cgi">
        <input type=hidden name="dbname" value="contacts-db">
        <input type=hidden name="wordmatch-f5" value="yes">
        <input type=hidden name="f5" value="Active">
        <input type=hidden name="action" value="searchdbdisplay">

        <input type=hidden name="template" value="contacts_email_msg.tmpl">
        <input type=hidden name="review_template" value="contacts_review_basket">
        <input type=hidden name="send_report_option" value="by email">
        <input type=hidden name="vendor_email" value="f8">

        <input type=hidden name="key_list" value="">
        <input type=hidden name="email" value="**email**">
        <input type=hidden name="contact" value="**contact**">
        <input type=hidden name="company" value="**company**">
        <input type=hidden name="address" value="**address**">
        <input type=hidden name="city" value="**city**">
        <input type=hidden name="state" value="**state**">
        <input type=hidden name="country" value="**country**">
        <input type=hidden name="zip" value="**zip**">
        <input type=hidden name="phone" value="**phone**">
        <input type=hidden name="subject" value="**subject**">
        <input type=hidden name="message" value="**message**">

        </form>
      
        This form defines how the "Company Contact (Lead) E-mails" are generated.

        You must have the name="contactsform" defined in the <form> statement.
        You must also have the parameter "key_list" defined as empty ("").

        You must also include the following INPUT statements in your "contactsform" form:

           <!-- See our "contacts-report" template for a real example -->

           <input type=hidden name="email" value="**email**">
           <input type=hidden name="contact" value="**contact**">
           <input type=hidden name="company" value="**company**">
           <input type=hidden name="address" value="**address**">
           <input type=hidden name="city" value="**city**">
           <input type=hidden name="state" value="**state**">
           <input type=hidden name="country" value="**country**">
           <input type=hidden name="zip" value="**zip**">
           <input type=hidden name="phone" value="**phone**">
           <input type=hidden name="subject" value="**subject**">
           <input type=hidden name="message" value="**message**">

        Our "contacts-search.cgi" program will replace the following tags by
        the values input by the user:

           **email**
           **contact**
           **company**
           **address**
           **city**
           **state**
           **country**
           **zip**
           **phone**
           **subject**
           **message**


    (3) In the table that controls the display of database fields, you should
        remove the "CHK" column which contains the following FORM statement:
 
           <input type="checkbox" name="**cbox**" value="KEY_**key**"
                  onClick="add('**key**',this)">

           (See "Company Contact (Lead) Report" template on Section D above)

        Instead, a new "Remove Item" column should be introduced at the last
        column of the table containing the <td> .. **remove** .. </td> statement.

        Example - See our sample "review_basket" Html template:


<!--repeat-->
<tr valign=top align=center>
<td width=15% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>
<!-- check-display-f10-
<a href="**f10**" onClick="openwindow('**f10**', '','500','440');return false;">
check-display-f10- -->
**f6**
<!-- check-display-f10-
</a>
check-display-f10- -->
&nbsp;</div></font></td>
<td width=40% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>**f7** &nbsp;</div></font></td>
<td width=35% bgcolor=**bgcolor**><font size=2 face="arial"><div align=left>**f9** &nbsp;</div></font></td>
<td width=10% bgcolor=**bgcolor**><font size=2 face="arial">**remove** &nbsp;</font></td>
</tr>
<!--endrepeat-->


        When the "contacts-search.cgi" program receives a "Review Basket"
        request, it will replace the **remove** tag by a "Remove Basket Item"
        URL link. When the user clicks on this link which is displayed on the
        Web browser, the associated "Record" will be removed from the Basket.

        NOTE: The <form name="cboxform"> and </form> statements which exists in
        the "Company Contact (Lead) Request" Report template (see Section D above)
        do not exist anymore in this "Review Basket" template.


    (4) <div align=center>
        <form method="post" action="/cgi-bin/contacts-search.cgi">
        <input type=hidden name="template" value="contacts-search">
        <input type=hidden name="action" value="showblank">
        <input type=button name="button" value="Search Again" onClick="submit()">
        </form>
        </div>
        ......
        <div align=center>
        <form>
        <input type=button name="button" value="Review Basket"
               onClick="reviewBasket()">
        </form>
        </div>
        <div align=center>
        <form>
        <input type=button name="button" value="Send Contact Request"
               onClick="sendContactsRequest()">
        </form>
        </div>
        <div align=center>
        <form>
        <input type=button name="button" value="Clear Basket"
               onClick="resetBasket()">
        </form>
        </div>

        The "Review Basket", "Send Contact Request" and "Clear Basket" forms
        must be inserted without change after the following template statements:

           <table ..>
              ......
           <!--repeat-->
              ......
           <!--endrepeat-->
              ......
           </table>



F.  How to build the "Company Contact (Lead) E-mail Message" Template:

    Sample template filename is "contacts_email_msg.tmpl".

    The default message is:
   
       **********************************************************
       Dear Sir,

       We are interested in your company's service.

       My requirements and contact information is provided in this email:

       Contact Person: **contact**
       Company Name: **company**
       Street Address: **address**
       City: **city**
       State: **state**
       Country: **country**
       ZIP / Postcode: **zip**
       Phone: **phone**

       Our Interests: **message**

       Thank you.


       _______________________________________________

       Below are your listing details found on the website ?????? :

       Name: **f6**

       Business: **f7**

       Products: **f9**

       E-mail: **f8**

       URL: **f10**


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

    Please note that the following tags (optional) will be replaced by the
    value of the corresponding fields (if configured) input by the user
    through the Company Contact (Lead) Request Form:

       **contact**
       **company**
       **address**
       **city**
       **state**
       **country**
       **zip**
       **phone**
       **message**

    All tags in the form of **fxx** (eg. **f6**) will be replaced by the value
    of the corresponding fields extracted from the matched database record.

    
    <<NOTE:>> 

    You can change the message to anything you like, but must make sure
    that the last 2 lines of the file must contain:

       <!--repeat-->
       <!--endrepeat-->

    in order to make the system works.


G.  Installation Notes:

    1. Configure and copy contacts-search.cgi to the cgi-bin directory.
       Make sure the file access modes of this script is set to 0755
       ( Unix command to set modes: chmod 0755 contacts-search.cgi )
       Please refer to Section B.

    2. Configure and copy all new template files to the template directory 
       defined by $template_dir in contacts-search.cgi.

    3. Initialize your database files and start testings. Make sure the
       "add", "edit", "search", "report", "image upload", and "e-mailing"
       functions are fully tested before releasing the system to production.



--------------------------------------------------------------------------

Now you are ready to run your "BizDB Lead Generator System". Good Luck!


Best regards,
Webmaster
CNC Technology
Web Site Design, Hosting and Marketing Services