Manual for OliveCart Version 1.0


  1. Introduction
    • Introduction
      With OliveCart you can convert your web site into an e-commerce online store.

    • What is OliveCart?
      OliveCart is an e-commerce shopping cart software that enables you to sell your products on your web site.

    • How it works
      Here is how it works. A customer goes to your web site, selects the products he likes, and provides the shipping and billing information, and receives an automatically generated purchase order/invoice. Then you login to your control panel and fulfill that order.

  2. Minimum Requirements
    • Introduction
      In order to use OliveCart on you web site and take advantage of all of the features that it offers, your web server needs to meet or exceed some minimum requirement.

    • Web server requirements
      OliveCart is written in PHP language. As a result, it can run on Microsoft IIS and Apache and every server that supports PHP. Most web hosting companies provide PHP enabled web hosting packages, so that you don't have to worry about it. However, if PHP is not installed on your server, you can get a free copy of PHP at http://www.php.net. We suggest that you use the latest version of PHP.

    • Database requirements
      OliveCart take advantage of power of MySql database. Most web hosting companies provide MySql. You can get a free copy of MySql at http://www.mysql.com. Remember that you need to have username and password to access your database. Your web hosting provider should provide you with  this information.

    • Programming language requirements
      OliveCart is written in PHP language. Most web hosting companies provide PHP enabled web hosting packages, so that you don't have to worry about installing any programming packages. However, if PHP is not installed on your server, you can get a free copy of PHP at http://www.php.net. We suggest that you use the latest version of PHP.

  3. Getting Started
    • Introduction
      This section will provide you with general information about setting up OliveCart on you web site.

    • The OliveCart software
      When you purchase OliveCart software, you get 2 files, olivecart_setup.php and olivecart_setup.pkg, that includes all of the OliveCart files. These files include a license for use on your domain.

    • Obtaining a license
      A license is required to use OliveCart software on you web site. OliveCart license is sold per domain name. Please read OliveCart license agreement for further information. When you purchase OliveCart software, you get 2 files, olivecart_setup.php and olivecart_setup.pkg, that includes all of the OliveCart files. These files include a license for use on your domain.

    • Choosing a server
      OliveCart can run on any web server that supports PHP. Most of the web servers in the market including Microsoft IIS and Apache support PHP.

    • Files and folders
      All of the files and folders required to utilize OliveCart are included in those two files that you download.

    • Updates and upgrades
      OliveCart versioning system is based on number system: M.n where M part is considered to be a major version and n part is the minor version. With your OliveCart license, you are entitled to receive all of the minor version upgrades free of charge if available. For example if you obtain a license for version 1.0, you will receive version 1.1, 1.2, ... but NOT version 2.0 or greater. You are encouraged to visit http://www.OliveCart.com website on regular basis and request updates if they are available.
      Minor versions include corrections and problem solving. Major versions, on the other hand, include added features.

  4. Installation
    • Introduction
      This section will guide you thru installing OliveCart on you site.

    • Choosing a location on the server
      Location of files and folders/directories in OliveCart is preconfigured to make the installation process easy. Do not modify any of these files except as noted in this manual. Please read the next section on how to install OliveCart.

    • Installing the OliveCart
      Follow these steps to install OliveCart on you web site. Change xxx.xxx.xxx with your domain name like www.yourdomain.com
      1. Save these two files, olivecart_setup.php and olivecart_setup.pkg, on your computer and upload them to your server.
      2. Put these two files in the root directory of your web site. Please consult with your web hosting provider for the exact location of your root website folder.
        Example: on MS IIS place these folders in c:\inetpub\wwwroot\ so that it will read c:\inetpub\wwwroot\olivecart_setup.php and c:\inetpub\wwwroot\olivecart_setup.pkg
        on Apache place these folders in /var/www/ so that it will read /var/www/olivecart_setup.php and /var/www/olivecart_setup.pkg
      3. Open your browser and go to the following address on your server:
        http://www.yourdomain.com/olivecart_setup.php
      4. The installation wizard will start and will walk you thru the installation process.
      5. Once finished, you can log into your control panel.
      6. You can access your control panel via http://www.yourdomain.com/olive/cart/controlpanel/index.php
        The demo can be accessed via http://www.yourdomain.com/store/index.php


  5. Configuration
    • Introduction
      This section will guide you thru configuring your OliveCart so that you can take advantage of OliveCart e-commerce.

    • First things first
      OliveCart comes with initial default username and password to access the control panel. We strongly advise you that you change this user name and password upon your first successful login to the OliveCart control panel.
      The default username is: admin
      The default password is: password

    • Accessing the control panel
      Here is how you would access the control panel:
      if your web site address is http://www.example.com for example, then you access the control panel via the following address:
      http://www.example.com/olive/cart/controlpanel/index.php

    • Creating the database
      Once you login to the control panel, click on "Create Database" link under setup section. This will take you to a page to create the database. On this page, click on "Create Database" button to create the database. You will receive a success message after successfully creating your database.

    • Changing the administrator user name and password
      Under Setup section in control panel, click on "Settings" link to change the administrator user name and password. This will take you to a page that shows you the current administrator user name and password along with other settings that you can change/edit. Click on the "Edit" link next to administrator user name to change the administrator user name. Click on the "Edit" link next to administrator password to change the administrator password.

  6. How to plug-in OliveCart into your site
    • Introduction
      This section will guide you thru utilizing your OliveCart so that you can take advantage of OliveCart e-commerce.

    • What steps to follow
      As we have said before, you can design your website any way you like. To make OliveCart function on your site, you need to follow the following steps. At this point we assume that you have set up OliveCart and have a working database.

      Open "olive/cart/code_for_top_of_each_page.php" file with notepad and copy its content. "code_for_top_of_each_page.php" contains a single line of code. There should be no line breaks. Note: Do not modify this file. This is part of your license code.

      Paste the content of "code_for_top_of_each_page.php" file into each page of your site. This MUST be the first line of each page even before <html> tag or anything else. You can examine the demo files and see how this is done.

      Grab the modules and place them into your page by doing the following:
      Type this code in the place holder where you want OliveCart modules to show.

      <?php
      require $PathToLicenseFolder."/_plugin_design_modules/NAME_OF_THE_MODULE";
      ?>

      Change the NAME_OF_THE_MODULE with the desired module name. Modules are in the following folder: olive/cart/_plugin_design_modules
      For example if you want to show the view cart module then you will type the following:

      <?php
      require $PathToLicenseFolder."/_plugin_design_modules/view_cart.php";
      ?>

    • Modifying the modules
      Remember that these modules are designed to meet most expectations. If you are skilled with HTML, you can edit these modules and design them according to your satisfaction. If you do so, make sure that you keep the PHP code unchanged.
      Note: It is a good idea to make a backup before you modify any of these files.

  7. Setting Options Definitions
    • Introduction
      Setting options are the options that apply to the entire web site. To change any of these setting options, click on the "Edit" link next to them.

    • Administrator username
      This is the administrator user name used in conjunction with administrator password to log in to the control panel.
      Example: admin

    • Administrator password
      This is the administrator password used in conjunction with administrator username to log in to the control panel
      Example: password

    • Tax rate
      This is the applicable sales tax rate for your state. Do not use percentage sign (%) when setting this option. Set to zero if you don't want to charge tax.
      Example: 8.25

    • Taxable state
      This is the state that the sales tax would apply. Usually it is the state that you are in.
      Example: CA

    • Start order number from
      Order numbers start from zero. However, if you like your order numbers start from a different number, then you set it here. For example if you want the first order number to be 1000, then you set this option to 1000.
      Example: 1000

    • Category page URL
      This is the path to the page where you list the products that belong to a particular category.
      Example: if your visitors use the following link http://www.example.com/view/all/products/in/this/category.html to view the category listing then you set this option to /view/all/products/in/this/category.html

    • Product long detail page URL
      This is the path to the long product detail page.
      Example: /product_long_detail.html

    • Product short detail page URL
      This is the path to the short product detail page.
      Example: /product_short_detail.html

    • View cart page URL
      This is the path to the view cart page.
      Example: /view_your_cart.html

    • Check out page URL
      This is the path to the check out page.
      Example: /check_out.html

    • Invoice page URL
      This is the path to the invoice page.
      Example: /invoice.html

    • Use edit/save button
      Set this to 1 if you want your customer to be able to save/edit his information so that he/she doesn't have to enter them again. Otherwise, set this to 0.
      Example: 1

    • Edit button type
      Use this to indicate the type of Edit/Save button to use. This is used only if you set "Use edit/save button" to 1. Read "Use edit/save button. Options are: button, path to picture, link
      Example: /path/to/picture.gif

    • Number of products to show on each row on category view page
      If you have a page that lists the products in a specific category, then you can set this value to indicate how many products/item should be listed on each row.
      Example: 3

    • Add to cart button URL
      This is the path to add to cart button image.
      Example: /path/to/add/to/cart/image.gif

    • Check out button URL
      This is the path to check out button image.
      Example: /path/to/check/out/image.gif

    • Confirm button on check out page URL
      This is the path to confirm button image on check out page.
      Example: /path/to/confirm/check/out/image.gif

    • Finish button on check out page URL
      This is the path to finish button image.
      Example: /path/to/finish/image.gif

    • Continue shopping button URL
      This is the path to continue shopping button image.
      Example: /path/to/continue/shopping/image.gif

    • Small shopping cart picture on top of the page URL
      This is the path to add to the small shopping cart image on top of each page if any.
      Example: /path/to/cart/image.gif

    • Picture to show instead of a product that does not have any picture
      If a product doesn't have any picture, you can use this to show a default picture.
      Example: /path/to/no/image/image.gif

    • Whether to use https SSL certificate for check out page
      If you set this value to 1, OliveCart will make sure that your check out page is accessed via a secure connection (https). Please note that you will get an error message if you don't have any SSL certificate installed on your server and you set this option to 1. Default is set to 1. To turn this feature off, simply set this value to 0 (zero).

    • Whether to use https SSL certificate for invoice page
      If you set this value to 1, OliveCart will make sure that your invoice page is accessed via a secure connection (https). Please note that you will get an error message if you don't have any SSL certificate installed on your server and you set this option to 1. Default is set to 1. To turn this feature off, simply set this value to 0 (zero).

  8. How To...
    • Change administrator username
      Log in to the control panel. Click on "Settings" in  "Setup" section; this will take you to settings page. Once you are on settings page, click on "Control Panel" tab. Type your new administrator username and then click save.

    • Change administrator password
      Log in to the control panel. Click on "Settings" in  "Setup" section; this will take you to settings page. Once you are on settings page, click on "Control Panel" tab. Type your new administrator password and then click save.

    • Initialize database
      Log in to the control panel. Click on "Create Database"; this will take you to create database page. Once you are on create database page, click on "Create Database" button and click ok to confirm. You will get a success message if all the steps of creating database is completed successfully.

    • Change notification e-mails
      Log in to the control panel. Click on "E-mail" under setup menu; this will take you to e-mail page. Once you are on view e-mail page, click on "Edit" link next to the e-mail that you want to edit. Type your new values and click save.

    • Add/edit a category
      Log in to the control panel. Click on "Add Category" to add a new category; or "View Categories" to see a list of categories and edit them.

    • Add/edit a product
      Log in to the control panel. Click on "Add Product" to add a new product; or "View Products" to see a list of products and edit them.

    • Add/edit a shipping Options
      Log in to the control panel. Click on "Add Shipping Option" to add a new shipping option/method; or "View Shipping Options" to see a list of shipping options and edit them.

    • Add/edit a shipping rate
      Log in to the control panel. Click on "Add Shipping Rate" to add a new shipping rate; or "View Shipping Rates" to see a list of shipping rates and edit them.

    • Add/edit a handling method
      Log in to the control panel. Click on "Add Shipping Rate" to add a new shipping rate; or "View Shipping Rates" to see a list of shipping rates. Once you are on this page, you can change the handling methods.

    • Add/edit a handling rate
      Log in to the control panel. Click on "Add Shipping Rate" to add a new shipping rate; or "View Shipping Rates" to see a list of shipping rates. Once you are on this page, you can change the handling rate.

    • Add/edit an opt-in question
      Log in to the control panel. Click on "Add Opt-ins" to add a new opt-in; or "View Opt-ins" to see a list of opt-ins and edit them.

    • Add/edit coupon
      Log in to the control panel. Click on "Add Coupon" to add a new coupon; or "View Coupons" to see a list of coupons and edit them.

Examine the demo files to see how you can plug OliveCart into your own design.

Home Features Demo Manual Purchase FAQ My Account Support Policy Contact us Earn Commission
Copyright ©2008. OliveCart.com All rights reserved.