KonaKart Logo Documentation
Search
KonaKart User Guide

KonaKart User Guide

This is version 2.2.6.0 of the KonaKart User Guide

A PDF version of this User Guide can be downloaded from http://www.konakart.com/docs/KonaKart_User_Guide.pdf

Legal Notices

(c) 2006 DS Data Systems UK Ltd, All rights reserved.

DS Data Systems and KonaKart and their respective logos, are trademarks of DS Data Systems UK Ltd. All rights reserved.

The information in this document is free; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.


Table of Contents

1. Introduction
osCommerce Compatibility
2. Product Information
KonaKart licensing
Is KonaKart Open Source?
How do the owners of KonaKart make a living?
How much does KonaKart cost?
Escrow Agreements
3. Product Features
General Functionality
Setup/Installation
Design/Layout
Customer Functionality
Customer Groups - Wholesale/Retail
Call Center Functionality
One page checkout
Checkout without registration
Products
Product Bundles
Product Tags and Tag Groups
Digital Downloads
Merchandising
Promotions
Advanced Search Engine Optimization (SEO)
Reporting
Payment Functionality
Shipping Functionality
Tax Functionality
Returns
4. Architecture
Software Architecture
5. Installation
Before You Begin
Platforms Supported
Pre-requisites
Install Java
Create a Database
If you already have an osCommerce database
Upgrading the Database between releases of KonaKart
Install KonaKart
Installing KonaKart on Windows
Installing KonaKart on Unix/Linux
Silent Mode Installations
Graphical Installation Wizard
Manual Installation
Starting Up and Shutting Down KonaKart
Starting up KonaKart
Shutting down KonaKart
Default Admin App Credentials
Installation Notes for Databases
Defining the Database Parameters
Notes for DB2 and Oracle
Notes for Postgresql
Notes for MySQL
6. Administration and Configuration
KonaKart Administration Application
Changing the Date Format in the KonaKart Application
Internationalization of KonaKart
Translating the KonaKart Admin Application
Translating the KonaKart Application
Modules
Payment Modules
Shipping Modules
Order Total Modules
How to Create a Payment Module
Introduction
Study the "KonaPay" APIs
Choose which Interface Type you want for your users
Sign up for a Test Account with "KonaPay"
Determine which of the existing payment modules is the closest match
Copy the files of the closest match as the starting point
Define the configuration parameters
Understanding the Configuration Options
Add the "KonaPay" gateway to the Admin App
Implement the PaymentInterface
NameValue[] Parameters
Implement the Action code
Save IPN details
Save the gateway response to a file
Send payment confirmation email
Struts mapping
Build, Deploy and Test
Modifying the Email Templates
Making something happen when a product needs to be reordered
Making something happen when the state of an order changes
Configuring KonaKart for HTTPS / SSL
Editing the KonaKart Configuration Files
Changing the Editable File List in the Admin App
Activating a Promotion
Displaying Coupon Entry Fields in your Store
Enabling / Disabling One Page Checkout
Search Engine Optimization (SEO) Features
Creating a new Admin App User
Creating New Roles
Auditing
Email Configuration
Changing the Skin for the KonaKart Application
Customer Groups
Import/Export of Product Data
Multiple Prices for Products
Default Sort Order for Products
Custom Credential Checking
Bundle Configuration
Product Tags
Credit Card Refunds
Adding Custom Functionality to the Admin App
Adding Panels
Adding Buttons
Default Customer Configuration
7. Custom Validation
Custom Validation for the Application
Configuring validation on data entered through the UI
Configuring validation for Custom Fields
Custom Validation for the Admin Application
CustomValidaton.properties file
Fields Supported by Custom Validation
8. Programming Guide
Using the Java APIs
Using the SOAP Web Service APIs
Running Your Own SQL
Customizable Source Code
Source Code Location
Building the Customizable Source
Customization of the KonaKart Engines
KonaKart Customization Framework
Adding a New API call
Modifying an Existing API call
Enabling Engine Customizations
9. Reporting
KonaKart Reporting from the Admin App
Modifying the Reports
Adding New Reports
Defining a Chart to appear on the Status Page of the Admin App
Reports Configuration
Defining the Set of Reports Shown in the Admin App
Accessing the Database in the Reports