Since 1994
Application Systems Design, Development, Training, Support & Support Services
Ready-made Customizable Solutions

Solutions: Ecommerce : Banner Associate: Install & Use

:

Description - Installation & Use - FAQs

Banner Affiliate System - Installation and Use

FILENAME: BA-ReadMe.html

DEPENDENCIES:

bas.pl - Banner Affiliate System configuration and common logic modules (see: pg.html)
pr.pl
jhzcs.pl - JHZ-CS configuration and common logic modules (see: jhzcs.html)
IID (Item Information Dataset)

REQUIREMENTS:

bas.cgi
ceptor.cgi
display.cgi
ssl/be/admin.cgi
ssl/be/maint.cgi
ssl/fe/activity.cgi
ssl/fe/admin.cgi
ssl/fe/links.cgi
ssl/fe/maint.cgi

NOTE: Front End (fe) and Back End (be) components are reflected by the subdirectory where they reside; i.e., "ssl/be/admin.cgi" is the Back End admin module, as opposed to "ssl/fe/admin.cgi" is the Front End admin module.

PACKING (PARTS) LIST

PACKING LIST
PRODUCT ID: BA
COMPONENT TYPE SIZE AUTH*
BAS/policy.html TEXT 426 750
cgi-bin/geog.pl TEXT 11601 750
cgi-bin/jhzcs.pl TEXT 35038 750
cgi-bin/license.incl TEXT 7907 700
cgi-bin/pr/bas/bas.incl TEXT 24024 700
cgi-bin/pr/bas/bas.pl TEXT 21275 750
cgi-bin/pr/bas/ceptor.cgi TEXT 9272 750
cgi-bin/pr/bas/display.cgi TEXT 12372 750
cgi-bin/pr/pr.pl TEXT 1184 750
cgi-bin/ssl/pr/bas/be/admin.cgi TEXT 17853 750
cgi-bin/ssl/pr/bas/be/maint.cgi TEXT 62123 750
cgi-bin/ssl/pr/bas/fe/activity.cgi TEXT 52983 750
cgi-bin/ssl/pr/bas/fe/admin.cgi TEXT 8403 750
cgi-bin/ssl/pr/bas/fe/links.cgi TEXT 25266 750
cgi-bin/ssl/pr/bas/fe/maint.cgi TEXT 56276 750
css/pr/bas/bas.css TEXT 1811 750
css/pr/bas/be/func.css TEXT 3481 750
css/pr/bas/be/proc.css TEXT 827 750
data/bas/access.dat TEXT 2616 700
data/bas/banners.dat TEXT 298 700
data/bas/dispctrs/index.html TEXT 251 750
data/bas/privctrs/index.html TEXT 251 750
data_ssl/bas/fe/ba_secure.dat TEXT 0 700
images/JHZCS.gif BINARY 745 750
images/bas/banners/BAS_sample_lg1.gif BINARY 2050 750
images/bas/banners/BAS_sample_lg2.gif BINARY 2060 750
images/bas/banners/BAS_sample_sm1.jpg BINARY 2152 750
images/bas/banners/BAS_sample_sm2.jpg BINARY 2160 750
images/bas/banners/ba_ht.gif BINARY 49 750
images/bas/report/BAS_hori_TB_gray.gif BINARY 45 750
images/bas/report/BAS_hori_gray.gif BINARY 59 750
images/bas/report/BAS_vertbar.gif BINARY 64 750
images/bas/report/BAS_vertbar_blank.gif BINARY 55 750
images/bas/report/clicks.gif BINARY 287 750
images/bas/report/t12am.gif BINARY 143 750
images/bas/report/t12pm.gif BINARY 140 750
images/bas/report/t3am.gif BINARY 136 750
images/bas/report/t3pm.gif BINARY 135 750
images/bas/report/t6am.gif BINARY 139 750
images/bas/report/t6pm.gif BINARY 138 750
images/bas/report/t9am.gif BINARY 139 750
images/bas/report/t9pm.gif BINARY 139 750
images/bas/report/tick.gif BINARY 61 750
images/items/sample_lg.jpg BINARY 2572 750
images/items/sample_sm.jpg BINARY 1707 750
images/products/BAS_sample_product_image.jpg BINARY 3358 750
logs/errorlog.txt TEXT 91 750
*AUTH - Authorization/permissions octal equilvalents where:
7=RWX, 6=RW, 5=RX, 4=R (R=Read W=Write X=Executable)
1 char indicates Octal number
2 char Owner
3 char Group
4 char All Others

INSTALLATION:

It is recommended that you read the entire installation process steps prior to performing installation. Each solution has specific instructions.

Installation Sequence

  1. Download solution to desktop
  2. Expand installation package (use any standard archive application; such as WinZip®, StuffIt Expander® or TAR command)
  3. Set configuration settings
  4. Upload components to server
  5. Set file permissions
  6. Test installation
  7. Customize Templates as desired
  8. Test customizations

Authorize non-Logic Components

  • Authorize graphic files for Read and Execute access; see "NOTE FOR NON-LOGIC COMPONENTS" below.
  • Authorize static HTML ".html" files for Read access; see "NOTE FOR NON-LOGIC COMPONENTS" below.
  • Authorize HTML Templates ".htm" files for Read access; see "NOTE FOR LOGIC COMPONENTS" below.

NOTE FOR NON-LOGIC COMPONENTS: Specify minimum required access permissions to achieve a more secure configuration; permission requirements for non-logic modules are dependent on server configuration where authorizations are required for either "group" only or for "owner", "group" and "other".

Modify Logic Components

Modify all logic components "*.cgi" and "*.pl" logic modules as follows:

  • First line of code (#!) correctly points to the PERL executable binary on the server (use command "which perl" or consult your server administrator)
  • All PERL "requires" statements contained in "*.cgi" and "*.pl" logic modules must use "absolute" directory paths (beginning with a forward slash "/")

Authorize Logic Components

Authorize logic components and dependent components (HTML and Email templates, and others) as follows:

  • Authorize "*.pl" logic modules for read access; see NOTE FOR LOGIC COMPONENTS below.
  • Authorize "*.cgi" logic modules for read and execute access; see NOTE FOR LOGIC COMPONENTS below.
  • Authorize all HTML and Email Templates documents for read access at the logic level; see NOTE FOR LOGIC COMPONENTS below.

NOTE FOR LOGIC COMPONENTS: Use minimum required permissions to achieve a more secure configuration; permission requirements for logic modules are dependent on the server configuration whether authorization is required for "owner" only (i.e., Apache with SUExec active), or "owner" and "group."

Modify "BAS/policy.html" to reflect the desired policies for your affiliate members.

Determine which existing banners you desire to use for your affiliate banners, or create new ones. Then, following initial installation, use the back-end Administrator (cgi-bin/ssl/pr/bas/be/admin.cgi) facility to define them to your system.

Uploading to Web Server

All dependent and required components must be successfully installed and configured. All components, with the exception of images, must be FTP uploaded as TEXT. Images must be FTP uploaded as BINARY.

TEMPLATES:

Customize new account special markup template contain in "links.cgi". Use care not to modify the logic code in that module. This section is marked as follow:

sub set_tmpls {
############################################################
#
#	MODIFY THIS SECTION TO CHANGE APPEARANCE OF
#	CODE GENERATION SECTION
#
#	IMPORTANT!  Use caution not to modify the logical references
#	indicated by "$" variables; e.g., $BAS_css and $BAS_fe_disp
#
############################################################

...


############################################################
#
#	END OF MODIFIABLE SECTION - DO NOT MODIFY BELOW THIS POINT
#
############################################################
}

It is recommended that you make a backup copy of this module each time you make modifications. This will allow you to recover in the event an error is introduced when you make changes.

Add links to invoke the account management front-end interfaces using "ssl/fe/admin.cgi" as the link URL or appropriate if installed using a modified configuration.

USAGE:

Front End

Accessed by non-members and members using the same URL:

/cgi-bin/ssl/pr/bas/fe/admin.cgi

New members - click "New Account" to enter their information to establish an account. Member considering joining may click the "Images & Links" to learn what is required to add affiliate banners and links at their website once they become a member.

Existing members - enter the member administrative functions automatically when accessing from the same web browser where their affiliate cookie has been set; otherwise, they enter their email address and password to access the functions. If they have forgotten their password, they may request it and it will be automatically emailed to them.

Front End Functions
  • NEW ACCOUNT - to establish a new account

  • IMAGES & LINKS - affiliate markup code generator. When accessed by an existing member that has logged in with their email and password, or their affiliate cookie is present, the code is dynamically generated using their account specific information and instructions are significantly simplified with a simple copy and paste. When accessed by a non-member or a member that is not logged in, the code generated contains placeholders which are to be replaced by the user according to the instructions that are displayed.

  • REVIEW ACCOUNT - affiliate report showing displays, click-thrus and click-thru sales for the current day, past seven days and past three quarters. The current day is reflected in a graphical bar chart. The statistics are generated in real time to give up to the minute reporting.

  • REQUEST PASSWORD - request a forgotten password. The user enters their security word they provided at time of registration and their password is automatically emailed to the email address defined to their account.

  • UPDATE ACCOUNT - modify affiliate account information

  • CHANGE PASSWORD - change affiliate password

  • TERMINATE ACCOUNT - request termination of affiliate account.

Back End

Accessed by website administrator using URL:

/cgi-bin/ssl/pr/bas/be/admin.cgi

There are a series of functions available for managing the affiliate accounts. Each functions contains instructions. Use these functions to perform the various tasks including debiting and crediting accounts, updating accounts, viewing reports and others.

Back End Functions
  • BANNER MANAGEMENT - define banners making them available to affiliates and automatically causing them to be included in the Front End "Links & Images" affiliate markup code generator function. Banners may be added or modified. Banner definitions are not permitted to be deleted as they may be currently referenced by affiliates at their websites; to effectively remove a banner from use, simply modify it to be the same as a existing banner. Banner images may be modified without changing the banner's definition as long as the width and height of the image is not modified.

  • ACCOUNT REPORTS - displays reports for one or more accounts.

  • PROCESS COMMISSIONS - generates a payout report for the current payment cycle.

  • CREDITS/RETURNS - process click-thru sales credits and returns for sales that are modified following initial check out; such as exchanges of different values, returns of sold items and cancellation of orders.

  • UPDATE ACCOUNT - modify a members account information and status. (when an account is terminated the members information may be retained for later use if the member decide to reactivate their account. use the "Clear Account" and "Delete Account" to permanently remove a member account.)

  • CLEAR ACCOUNT - clear information for a terminated account.

  • DELETE ACCOUNT - permanently remove a terminated account. (If a member decided to later reactivate their account and their account has been deleted, it is necessary for them to establish a new account.)

Operational Components

The operational components provide the back-end functions supporting the transmission of banners referenced at affiliate websites and routing of affiliate link click-thrus. In addition, when JHZ-CS Banner Affiliate and JHZ-CS Shopping Cart are configured to support click-thru sales crediting to affiliates, the operational components provide support to register the level of credit to be awarded if a sale results from a click-thru session.

JHZ-CS Solutions are offered exclusively under the terms and conditions of the JHZ-CS Software License Agreement.