This is version 9.6.0.0 of the KonaKart User Guide
This User Guide can be downloaded in PDF format from https://www.konakart.com/docs/KonaKart_User_Guide.pdf
Legal Notices
(c) 2006-2018 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
- 2. KonaKart Information
- 3. KonaKart Features
- General Functionality
- JSR 286 Liferay Portlet
- ERP Integration
- Content Management System Integration
- Basic Content Management
- Setup/Installation
- Design/Layout
- Multi-Store
- Multi-Vendor
- Customer Functionality
- Customer Groups - Wholesale/Retail
- B2B Features
- Call Center Functionality
- Social Login
- One page checkout
- Checkout without registration
- Products
- Digital Downloads
- Bookable Products
- Product Stock Reservation
- Product Bundles
- Gift Certificates
- Product Recommendations
- Reward Points
- Indexed Search
- Suggested Search
- Product Tags and Tag Groups (Faceted Search)
- Merchandising
- Promotions
- Marketing - Customer Tags and Expressions
- Advanced Search Engine Optimization (SEO)
- Reporting
- Payment Functionality
- Recurring Billing
- Shipping Functionality
- Tax Functionality
- Order management
- Returns
- Refunds
- PDF Invoices
- Java Message Queue Integration
- Customer Events
- Exchange Rate Updates
- Filters
- KonaKart and KonaKartAdmin Tiles
- Facebook Messenger Bot.
- Export for Google Merchant Center / Google Retail
- 4. Architecture
- 5. Installation
- 6. Installation of KonaKart Business and Enterprise Editions
- 7. Installation of KonaKart on other Application Servers
- General Notes on Installing KonaKart on Application Servers
- Installing KonaKart on BEA's WebLogic Application Server
- Installing KonaKart on JBoss or Wildfly
- Installing KonaKart on IBM's WebSphere Application Server
- Installing KonaKart on IBM's WebSphere Application Server Community Edition
- Installing KonaKart on GlassFish
- Installing KonaKart on JOnAS with Tomcat
- Installing KonaKart on JOnAS with Jetty
- 8. Upgrading
- Recommended Upgrade Steps
- Backup
- Installation of the new Version
- Database Upgrade
- Test new Installation against Upgraded Database
- Re-build Custom Code
- Upgrade the Struts Storefront
- Assess Changes to WebApp Configuration files
- Assess Changes to Tomcat Configuration files
- KonaKart Directory Structure Changes
- KonaKart Message Changes
- Documentation and javadoc Changes
- Admin App Changes
- 9. Administration and Configuration
- KonaKart Administration Application
- Launching the Admin App
- Configuring KonaKart for HTTPS / SSL
- Editing the KonaKart Configuration Files
- Changing the Editable File List in the Admin App
- KonaKart Properties Files
- Configuration of Messages
- Logging
- Internationalization of KonaKart
- Changing the Logo on the KonaKart Admin Application
- Changing the Date Format in the KonaKart Application
- Formatting of Addresses
- Email Configuration
- Modifying the Email Templates
- Using an External Email Delivery Service
- Using a email barcode generator
- Using Google reCAPTCHA Service
- Search Engine Optimization (SEO) Features
- Sitemap Generation
- Caching
- Adding Custom Functionality to the Admin App
- Searching with wildcards
- Case In-Sensitive Searching
- Making something happen when a product needs to be reordered
- Making something happen when the state of an order changes
- PDF Invoices
- Activating a Promotion
- Testing a Promotion
- Applying Promotions to Products
- Displaying Coupon Entry Fields in your Store
- Configuring Digital Downloads
- Configuring Bookable Products
- Import/Export of KonaKart Data
- Multiple Prices for Products
- Future Product Prices
- Sale Price
- Variant Pricing
- Tier Pricing
- Dynamic product prices
- Tax Configuration
- Validation of Order Totals
- Multiple Quantities for Products
- Default Sort Order for Products
- Bundle Configuration
- Product Options
- Product Tags
- Managing Product Reviews
- Using CLOBs for Product Descriptions
- Credit Card Refunds
- Saving and Editing of Credit Card details
- Edit Order Number and Custom Fields
- Shippers and Shipments
- Wish Lists
- Gift Registries
- Gift Certificates
- Enable Gift Certificates
- Creating a Gift Certificate
- Creating a new Admin App User
- Creating New Roles
- Default Customer Configuration
- Making Customers Invisible
- Customer Groups
- Auditing
- Forgotten Password
- Set User Password
- Authentication with Username or Telephone
- Double Opt-In for Registration and Newsletter
- Custom Credential Checking
- Custom Credential Checking - LDAP
- Multi-Store Configuration and Administration
- Scheduling in KonaKart
- Deletion of Expired Data
- Data Integrity
- Configuring KonaKart to use Analytics Tools
- Setting up RMI Services
- Integrating a Java Message Queue
- kkCmd - Command line tool
- Changing the standard password encryption algorithm
- 10. KonaKart Content
- 11. Marketing - Customer Tags and Expressions
- 12. Using Artificial Intelligence to derive Product Recommendations
- 13. Reward Points
- 14. Solr Search Engine
- 15. Payment, Shipping and OrderTotal Modules
- Module Types
- 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
- How to Create a Promotion Module
- 16. Recurring Billing
- 17. Multi-Vendor Functionality
- 18. Product Stock Reservation
- 19. Order Management
- 20. KonaKart B2B features
- 21. KonaKart ERP Integration
- 22. Custom Validation
- 23. Custom Product Attributes and Miscellaneous Items
- 24. Programming Guide
- Using the Java APIs
- Using the SOAP Web Service APIs
- Using the JAX Web Service Storefront APIs
- Using the JAX Web Service Admin APIs
- Step-by-step guide to using the JAXWS SOAP APIs:
- Using the RMI APIs
- Using the JSON APIs
- Using the JSON APIs to build a JavaScript client
- HTML character escaping
- Running Your Own SQL
- Database Layer Changes from v7.2.0.0
- Customizable Source Code
- Customization of the KonaKart Engines
- Building with Maven
- Pluggable Managers
- 25. Reporting
- 26. Liferay Portal Integration
- 27. Social Login
- 28. TaxCloud Integration
- 29. Thomson Reuters Integration
- 30. PunchOut