VirtueMart 1.
VirtueMart 1.1 User Manual Sören Eberhardt-Biermann Russel Walker www.netshinesoftware.com [http://www.netshinesoftware.com/] $Date: 2008-08-02 22:53:47 +0200 (Sa, 02 Aug 2008) $, $Revision: 1497 $ Copyright © 2005-2008 Soeren Eberhardt-Biermann This document is published under the Open Content License available from www.opencontent.org/opl.shtml] Joomla!™ is a Trademark of Open Source Matters, Inc. Mambo™ is a Trademark of The Mambo Foundation Inc. http://www.opencontent.org/opl.
Table of Contents Preamble .................................................................................................................... ix 1. Introduction .............................................................................................................. 1 1.1. What is VirtueMart? ......................................................................................... 1 1.2. What does it not do? ........................................................................................ 3 1.
iv
List of Figures 1.1. Frontend: Category Overview Page ............................................................................ 3 1.2. Frontend: Product Details Page with Review Feature ..................................................... 4 1.3. Administration: Homepage / Summary / Statistics ......................................................... 5 1.4. Administration: Product List ..................................................................................... 5 4.1. The Configuration Form ....
VirtueMart 1.1 User Manual 4.44. VirtueMart Administration: Product Types Management - Advanced Search According to Parameters - Selecting Product Type ............................................................................... 70 4.45. VirtueMart Administration: Product Types Management - Advanced Search According to Parameters Form - Selecting Parameter Values ................................................................. 71 4.46.
List of Examples 4.1. ..........................................................................................................................
viii
Preamble The content of this document is related to VirtueMart. VirtueMart is free Software, licensed under GNU/GPL; VirtueMart [ http://virtuemart.net ], © 2005-2008 Sören Eberhardt-Biermann & the VirtueMart Development Team The Software 'VirtueMart' is intended for use in Joomla! (Versions 1.0, 1.5) or Mambo (Versions >= 4.5.3, 4.6.x). (Joomla! and Mambo is free Software, licensed under GNU/GPL; Joomla! is available from www.joomla.org [http://www.joomla.
x
Chapter 1. Introduction 1.1. What is VirtueMart? 1.1.1. About VirtueMart is a PHP-based Shopping Cart Application for selling goods over the internet. It's a Component (= plugin) for a Content Management System called Joomla! (and Mambo) and can't be used without Joomla!. It installs fairly easy using the automatic Component and Module Installer. It's intended for use in small / mid-sized Online Businesses / Online-Shops.
Features • Manages an unlimited Number of Products and Categories, • Can be used as a Shop or just as an Online-Catalog (you can even turn off Price Display) • quick Search for Products, Categories and Manufacturers; filter by features or discounted Products • Product Ratings & Testimonials (moderated or auto-published) • feature specific Products by setting them "on special" • Product Availability: show how fast a Customer can expect delivery • Handles downloadable Products, • "Product is back in Stock"-N
What does it not do? • flexible Shipping Carriers and Rates Configuration • Live-Shipping Rates using Shipping Modules (e.g. InterShipper, UPS, USPS, FedEx or Canada Post; Modules can use the Shipping Rate API). • extend your Shop with other Payment Modules using the Shipping Module API! 1.2. What does it not do? VirtueMart is a simple Online-Shop application. But it is surely no "out-of-the-box" killer application for professional companies. It's not tested in 100% secure environments.
Frontend Screenshots (using the Joomla! 1.5 Template JA Purity) Figure 1.2.
Administrator Screenshots Administrator Screenshots Figure 1.3. Administration: Homepage / Summary / Statistics Figure 1.4.
6
Chapter 2. Installation 2.1. Joomla! / Mambo Installation Unless you have downloaded the VirtueMart eCommerce Bundle (including Joomla!), Joomla! and Mambo must be installed prior to the Installation of VirtueMart, because VirtueMart needs a CMS as runtime environment. The Installation of Joomla! or Mambo is not covered in this Manual, because it is subject to change and would have to cover a series of Tutorials for all different versions of Joomla! and/or Mambo.
Installation and Upgrade The official Download Page is http://dev.virtuemart.net/cb/wiki/1693. [http://dev.virtuemart.net/cb/wiki/1693] 2.2.2.2. Editions VirtueMart is available in different distribution formats. Important The "Complete Package" and the "Manual Installation Package" are available in two basic versions: one for Joomla! 1.0/Mambo and one for Joomla! 1.5. The second one has the extension ".j15.zip" (or ".j15.tar.gz"). 2.2.2.2.1.
Installation and Upgrade All you need to do is install VirtueMart! It will automatically convert your installation of mambophpShop. So just follow the instructions for the automatic installation (or if you have difficulties with it: the manual installation). Note It is recommended to uninstall the old mambo-phpShop modules after you have installed the VirtueMart component and then install the new VirtueMart modules.
Automatic Installation Warning This has been said often enough before, but now once again: before you attempt to upgrade your existing Store to VirtueMart 1.1 create a BACKUP first and test the upgrade on a local copy of your store! Important Themes are a new feature introduced with VirtueMart 1.1. So the complete templating system has been changed. If you have modified the shop templates (product_details, browse, order_email) that shipped with VirtueMart 1.0.
Automatic Installation 3. In Mambo/Joomla! 1.0 click Installers # Components. In Joomla! 1.5 click Extensions # Install/ Uninstall in the Top Menu. Joomla! 1.5 Extension Manager Caution You must check if the directories listed above the component list are writable! If the directories are not writable, use ftp or JoomlaXplorer [http://joomlacode.org/gf/project/ joomlaxplorer/] to change the permissions. For proper installation, the directories should be set to 777, after that you can change back to 755.
Automatic Installation Installation Welcome Screen You can now choose whether you want to install Sample Data (some Products, with Attributes, sorted in Categories) to see how things have to be set up. Or you can 'go directly to the Shop >>' without installing Sample Data. Caution This step again takes some time & the VirtueMart Installer is performing Database Queries now. So please be patient (especially when you're on Mambo)! 6. Now you must install the VirtueMart "Main Module". In Mambo/Joomla! 1.
Automatic Installation Additional modules mod_product_categories "Product Categories Module" It can display the product categories you have set up. mod_productscroller "Product Scroller Module" It can scroll certain products somewhere on your site using a marquee tag. mod_virtuemart_allinone "All-in-one module" Can display the latest, featured, top-ten or random products in one module using tabs.
Manual Installation Click on 'Mambots' # 'Install/Uninstall' (or 'Extensions' # 'Install/Uninstall when using Joomla! 1.5) in the Top Menu. Search Bot Performs a search on the product table and delivers search results for Joomla's / Mambo's site search. Select the file 'vmxsearch.mambot_1.1.x.zip' (called 'vmxsearch.plugin_1.1.x.j15.zip' for Joomla! 1.5) and click 'Upload File & Install'. ProductSnapshot Mambot/Plugin Displays product figure/price/add-to-cart link in content items.
Language Installation 4. Login in to the Backend (Administration) of your site (http://www.your_site.com/ administrator/). 5. When having logged in, you see this URL in the address bar: http://www.yoursite.tld/administrator/index2.php In Joomla! 1.5 it's http://www.yoursite.tld/administrator/index.php 6. Now just add "?option=com_virtuemart" after index2.php, so it looks like this in your browser's address bar: http://www.yoursite.tld/administrator/index2.php? option=com_virtuemart and hit Enter. 7.
Installation FAQ doc.do?proj_id=1]. Please note that the language files of VM 1.0 and VM 1.1 are of a completely different structure and not compatible. After you have extracted the Language Pack on your local hard drive, upload its contents to the directory /administrator/components/com_virtuemart/languages If you have no access or permission to upload the files via FTP, you can upload the whole Language Package (as one complete archive) to that directory using the eXtplorer.
Installation FAQ php_value upload_max_filesize 4M 2.2.7.1.3. The installation on Joomla! 15 fails with the error “Your Extension appears to be written for an older version of Joomla!. You must enable the System - Legacy Plugin in the Plugin Manager if you wish to complete this task.”. You have probably uploaded an old Version of VirtueMart or an old Module, which is not ready for Joomla! 1.5. Make sure you have downloaded the Virtuemart Package for Joomla! 1.5 (with the file extension ".j15.zip").
Installation FAQ VirtueMart is no component-only script. It's programmed to be used together with the corresponding VirtueMart Main Module. VirtueMart will not operate properly without the VirtueMart Main Module.
Chapter 3. First Steps Do you have installed the VirtueMart Main Module? If not, do so now. Don't forget to publish it somehere on your site. This module is meant to display all categories and to control the component.
Joomla! Global Configuration Caution If you don't change your Store Information and the Email Address, VirtueMart sends Order Confirmation Emails to demo_order@virtuemart.net. Localization / Language Whatever language you set in the Global Configuration: VirtueMart tries to pick it from its own language directory: /administrator/components/com_virtuemart/ languages If the selected language isn't found, the english language file is loaded by default - so you must never delete it.
Chapter 4. Administrator Tutorial This tutorial will walk you through the setup of your site, ongoing management, and advanced administration accessed via the VirtueMart administrative interface. It assumes that you have already installed and configured your site (VirtueMart 1.1 with Joomla! 1.0.13). VirtueMart allows you to select "Simple Layout" and "Extended Layout". The simple layout is the standard layout and provides a basic cross-browser-safe layout.
Global product pages. This means the whole shop section isnt usable for customers. Administrators won't see the shop too. Offline Message This message will be displayed to customers who try to access your store. Use only as catalogue Hides all "Add to Cart" buttons. Show Prices When enabled, product prices are displayed. (useful when using "catalog-only" functionality. Note that you can't hide prices from unregistered users to show prices only to registered users.
Global location, the tax rate of the store/vendor location or - in EU Mode - the tax rate of the country, the store is located in, regardless where the goods are shipped to. Enable multiple tax rates? Check this, if you have products with different tax rates (e.g. 7% for books and food, 16% for other stuff). Discount before tax/shipping? Sets the flag whether to subtract the Discount for the selected payment BEFORE (checked) or AFTER tax and shipping.
Security Long version of the return policy (link to a content item) This is the long and detailled version of your returns policy. This text is linked in the short version and appended to each order confirmation email. Check Stock? Sets whether to check the stock level when a user adds an item to the shopping cart. If set, this will not allow user to add more items to the cart than are available in stock.
Site (Display & Layout) secure, as it actually encrypts the data, not just encodes it. AES_ENCRYPT is available in MySQL >= 4.0.2. Encryption Key The secret key for encrypting payment account data like credit card numbers and storing them encrypted in the database. Store Credit Card Information? Allows to completely disable the storage of Credit Card data. Allow Frontend-Administration... ...
Site (Display & Layout) Default Product Sort Order Here you can select by which criteria products are ordered in the product lists. Available "Sort-by" fields Here you can select the criteria which is available for the customer to reorder the product list. Show the Number of Products? default: checked Switches On or Off the Display of Products in a Category right behind the Category Name like "Power Tools (3)". "no image" image default: /components/com_virtuemart/themes/ default/images/noimage.
Shipping Tip You can check if you have GD2 support by browsing to "System" # "System Info" # "PHP Info" # gd. The Thumbnail Image quality is much better than Images which were "resized" by the browser. The newly generated Images are put into the directory /shop_image/prduct/resized. If the Image has already been resized, this copy will be send to the browser, so no image is resized again and again. Thumbnail Image Width The target width of the resized Thumbnail Image.
Getting Started "Disable download" Order Status Sets the order status at which the download is disabled for the customer. DOWNLOADROOT The physical path to the files for the custumer download. (trailing slash at the end!) Important Must be a physical path, no URL. Caution For Security Reasons you should specify a directory somewhere outside of the Document Root of your Web Server.
Getting Started Figure 4.2. Joomla! Administrator: Component Drop-Down List If you see the VirtueMart "Welcome" page when accessing VirtueMart, click "Go Directly to Shop". Navigating to the VirtueMart admin interface will bring up the "Store: Summary" page. Figure 4.3.
Store Setup 4.3. Store Setup To begin setting up your store, select "Store | Edit Store" from the VirtueMart admin interface. Figure 4.4. VirtueMart Administration: The Store Form The Information from the Store Information Form is displayed in various Locations on the Shopping Site. This is your Store's primary Identity - essentially a special "Master" Vendor. Store Information Form Fields Store Name Required The name of the Store. Store Company Name Required The name of your company.
Store Information Form Fields Zip/Postal Code The ZIP of your Store's location. Phone Your Store's Phone Number Last, First & Middle Name The Name of your Contact Person. Title The title of the Contact Person. Phone 1 & 2 Your contact's Phone number. Fax The Fax number for the Contact. Email Address Primary store contact email address Full Image Required Displays the currently configured store logo. Upload Image Optional Browse to your company logo.
Countries, Currencies, Core Modules & Functions 4.4. Countries, Currencies, Core Modules & Functions 4.4.1. Managing Countries Countries are managed in the country list, which can be accessed through "Admin" # "List Countries". Figure 4.5. VirtueMart Administration: Country List To add a new country, click "New" in the top of the list and fill out the fields in the country form. Figure 4.6. VirtueMart Administration: Country Form Don't forget to save and the new country is added to the list.
Managing Currencies To remove one or more countries from the list, either click on the "trash bin" icon in the last column of each row and confirm to remove the country or select countries and click on "Remove" in the toolbar. 4.4.2. Managing Currencies Currencies are managed in the currency list, which can be accessed through "Admin" # "List Currencies". Figure 4.7.
VirtueMart Core Modules 4.4.3. VirtueMart Core Modules VirtueMart Core Modules have absolutely nothing to do with "Joomla! Module", which are sideblocks in your Joomla! site. Core Modules build a part of your store and are used to manage the different sections and their access permissions. Caution You need to act carefully in this part of VirtueMart. Changing Core Modules and their permissions can result in locking out other users or even yourself from the store.
VirtueMart Core Functions Figure 4.10. VirtueMart Administration: Currency Form Don't forget to save and the new module is added to the list. You can modify existing modules. To do so, just click on the name of a module in that list and a form opens and you can modify the properties of this module. Again don't forget to save your changes.
VirtueMart Core Functions Figure 4.11. VirtueMart Administration: Function List To add a new function, click "New" in the top of the list and fill out the fields in the function form. Figure 4.12. VirtueMart Administration: Function Form Don't forget to save and the new function is added to the list.
Manufacturer Administration You can modify existing functions. To do so, just click on the name of a function in that list and a form opens and you can modify the properties of this function. Again don't forget to save your changes. To remove one or more functions from the list, either click on the "trash bin" icon in the last column of each row and confirm to remove the function or select functions and click on "Remove" in the toolbar. 4.5.
Manufacturers Once the manufacturers have been removed, select "Manufacturers | List Manufacturer Categories" from the VirtueMart admin menu. Click on the name of the manufacturer category you want to delete. In the Manufacturer Category Form, click on the "Remove" icon. Click "OK" to confirm that you are sure you want to delete this category. You will be returned to the Manufacturer Category List. Note that the manufacturer category you deleted is no longer listed.
Product Administration 4.6. Product Administration VirtueMart offers the ability to categorize products not only by manufacturer, but also by product category. Product categories may also contain subcategories enabling storekeepers to manage their products in as much detail as possible. Because products and product categories are associated to a particular vendor, it is important to create your vendor records before creating the product and product category records. 4.6.1.
Product Categories Product Category Fields Publish? Used to specify whether the category will be published on the site. Category Name The name that will be used to identify the category. Category Description The description that will be displayed for the category. ListOrder The Place of this category in a list with other categories. Parent The parent category with which this category will be associated.
Products • Use the "sort alphabetically" icon in the list header. You can sort all categories in your store alphabetically using this functionality. Please note that this can't be undone. Once the categories are reodered you would have to change back manually. 4.6.1.3. Removing Product Categories Before deleting an existing product category, all sub categories associated to the product category must be removed through either deletion or re-association.
Products Product Form Figure 4.16. VirtueMart Administration: Product Form, Tab 1 - General Information 42 Publish? Used to specify whether the product will be published on the site. SKU Means Article Number. Stock keeping unit ( SKU) is an identification, usually alphanumeric, of a particular product that allows it to be tracked for inventory purposes. Name The name that will be used to identify the product. URL A URL that can be displayed with a product.
Products Discounted Price This overrides the Discount Type and automatically creates a Discount Record using the Difference between the Gross Price and the discounted Price. Short Description The short description that will be displayed on the browse (overview) page for a category or search result. Product Description This is the details description that will be displayed on the Flypage (=details page) of this specific product.
Products Figure 4.18. VirtueMart Administration: Product Form, Tab 3 - Product Status Quantity in Stock The current quantity in stock for the item. Used for shipping and inventory purposes. Minimum Purchase Quantity This number specifies the minimum Quantity, which Customers can purchase of this Product Maxmimum Purchase Quantity This number specifies the maximum Quantity which Customers can purchase of this Product Availability Date When the current quantity in stock is available for distribution.
Products Adds easy attributes to the product. These are attributes which can be selected by a customer. This does not create items for each attribute value! If you want to check the stock on each item (e.g. green, red and black T-Shirts...use the Attribute Form to add Attributes and after that Items for each Attribute Value using the Item Form. Custom Attribute List Syntax: Attribute1;Attribute2;Attribute3 Adds custom attributes to the product. These are attributes which can be selected by a customer.
Products Important Allowed UOM are po / pound(s) kg /kilogram(m)(s) ou / ounces lb / LB Units in Packaging Specifies how many pieces of this Products are in one Package. Units in Box Specifies how many packages of this Product are in one Box. Figure 4.20. VirtueMart Administration: Product Form, Tab 5 - Product Images Thumbnail A thumbnail image that can be displayed along with the product. Full Image A larger image that can be displayed along with the product.
Product Price Management Figure 4.21. VirtueMart Administration: Product Form, Tab 6 - Related Products Now you're done. Just click on "Save" to make sure the changes are stored. 4.6.2.2. CSV Import/Export VirtueMart itself doesn't provide a Product CSV Import and Export. You need to install a separate Component called "CSVImproved [http://www.csvimproved.com]" to manage Export and Import of your Data. 4.6.2.3.
Product Price Management Figure 4.22. VirtueMart Administration: Product Form, Price Form in the Product Form You can also directly add and modify Product Prices from the Product List. Just click on one of the Price Entries with the yellow Background. This opens a Price Form where you can select Currency and Shopper Group this Price is for. Figure 4.23. VirtueMart Administration: Price Form in the Product List Each time you change the Shopper Group from the Drop-Down List, the Form refreshes.
Product Price Management Figure 4.24. VirtueMart Administration: Price Update Notice To add Prices for Quantity Ranges, you need to go to the Product Price List, which is available from the toolbar in the Product List. Figure 4.25. VirtueMart Administration: Product List - List Prices You can also access the Price List for a Product from its Product Form. Just click on "List Prices" as shown in the following figure.
Product Price Management Figure 4.26. VirtueMart Administration: Product Form - List Prices In the Price List for this Product you can find a List of all available Prices, for Shopper Groups and Quantities. That's where you have a great Price overview. In this List you can modify existing Prices by clicking on a Group Name or add new Prices by clicking on the "New" button in the toolbar. Figure 4.27.
Product Variations and Attributes Figure 4.28. VirtueMart Administration: Product Price Form Don't forget to save your changes when you're done. 4.6.3.2. Deleting a Price Prices can only be delete from the Product Price List. How to access this List can be read in the Section "Adding or Modifying Prices". In this List you can click on the Trash Bin Icon at the end of the row of each Price Entry to remove a Price.
Product Variations and Attributes you have to set up at least one attribute first. Hence, it is only after you have added an attribute that the New Item toolbar button and its related menu option appear. If you add Attributes to a Product, that Product becomes a Parent Product. After that you can add Child Products (called Items) each one having different Values for each Attribute. 4.6.4.1.1.
Product Variations and Attributes Figure 4.30. VirtueMart Administration: Add a new item (=child product) Click on the Add Items button in the toolbar to display the product entry form for the specific item. This form is the same as previous product entry forms only the vendor and category fields have been populated for you, and item attribute fields for the attributes you have defined are now available. Complete the product entry form and click the Save button in the toolbar to save the new item. 4.6.4.
Product Variations and Attributes 4.6.4.1.4. Deleting Items To delete an item, List the Product's Items like in the previous section. Then click on the basket at the end of the row of the item you want to delete. If you want to delete all items, you must delete each item before deleting the parent item.Once all items have been deleted, click on the Delete button at the end of the product entry form of the parent item to delete the parent item. 4.6.4.1.5.
Product Types Management Figure 4.32. Attribute Manager in the Product Form Important If you have defined Attributes, the Customer must select a Value for all of the Attributes or it won't be possible to put the Product into the Cart. 4.6.4.2.2. Custom Attributes Custom Attributes follow nearly the same Syntax as the "advanced Attributes". They allow Customers to specify their own Values for Attributes (e.g. "Your Name" or "Your Greeting").
Product Types Management Note Other developers call this magical feature "The Filter". Note To fully understand this feature, you really have to try for yourself and focus a few hours, maybe days, OR you can read and follow this easy step by step guide. 4.6.5.1. Product Types Management Product Type is very different in functionality than Product Category, but both have the mission to describe products.
Product Types Management Important "Creating Product Types" is possible only in this manner and only from this menu item. Although this sounds the same as "Creating a Product Type relation with a Product" option they are completely different. 4.6.5.1.2. Editing Product Types Information In the form below you can edit your Product Type's Information.
Product Types Management Tip We recommand not using "Image", "Page break" and "Readmore" options, because it is an unecessary work. If you want to write detailed information about your products, use the Category Description field, and further more the Product Description field. Tip Some things you need to know about "Product Type Browse Page" and "Product Type Flypage". This assumes that you already have other, specific templates files for products assigned to Product Types.
Product Types Management Figure 4.34. VirtueMart Administration: Product Types Management - Product Type List Now you see the empty Parameter List for the newly created Product Type. Click "New" and take a good long look at the Parameter Type dropdown box.
Product Types Management Figure 4.35.
Product Types Management Parameter name is actually the name of the database field for the parameter, so don't forget spaces in this field! Example: [monitor_weight]. Parameter Label is what exactly is shown in frontend as the parameter name within Advanced Search According to Parameters form.
Product Types Management flypage, and use only the Product Type Parameter List layout. Possible Values In this fileld you have to write all the values the parameter could have, and between values use only the symbol ; with no spaces before and after it. If a new product is launched on the market and has a higher value for the parameter, update this field with the new value, so you can configure your new product properly.
Product Types Management Important If you want to create a single Product Type for a NON parent category of products, witch is recommanded, you have to give your Product Type exactly the same name as the category that contain the products assigned to it. It is best thing to do, because the most important bad effect is that some products can be ignored by the parameter search.
Product Types Management Figure 4.37. VirtueMart Administration: Product Types Management - Adding new Product Type to a Product FASE 1 Figure 4.38.
Product Types Management Figure 4.39. VirtueMart Administration: Product Types Management - Adding new Product Type to a Product FASE 3 Now lets check the product flypage.
Product Types Management Figure 4.40. VirtueMart Administration: Product Types Management - Flypage of a Product assigned to a Product Type Note In this example we described the product using only Product Type Parameters, and we didn't used Product Description and Short Description fields. This is the default flypage layout, and you can change it by choosing a different flypage file specialy created for products assigned to Product Types.
Product Types Management Figure 4.41. VirtueMart Administration: Product Types Management Creating a new product already assigned to a Product Type FASE 1 Note In normal "Product List" page, you don't have the ability to create a Product already assigned to a Product Type, so ONLY from "Product Type List" you have this ability.
Product Types Management Figure 4.42.
Product Types Management Figure 4.43. VirtueMart Administration: Product Types Management Creating a new product already assigned to a Product Type FASE 3 OK! Now you have 2 products fully configured (you can realy merchandise them 4.6.5.3. Advanced Search According to Parameters In order to be able to perform this type of search, you have to enable the "Advanced Search According to Parameters" link in VirtueMart Module.
Product Types Management Figure 4.44.
Product Types Management Figure 4.45.
Product Types Management Figure 4.46.
Product Downloads, additional Images and Files 4.6.5.4. Deleting Product Types This is an important decision to make, because deleting a Product Type will delete all relations with products, and you cannot search those products according to their parameters anymore. In case you don't need a Product Type anymore, you can delete it using the folowing procedure: go to Product Type List, select the one you want to delete and click "Remove". 4.6.6.
Product Downloads, additional Images and Files Figure 4.48. VirtueMart Administration: The image icon is the link to the file manager. The number behind the icon is the total number of all files assigned to this product. The File List for a Product contains all files currently assigned to the product. Files can have different "roles" like "downloadable file (to be sold!)", "additional file" and "additional image". Figure 4.49. VirtueMart Administration: File List 4.6.6.2.
Product Downloads, additional Images and Files Important The Download Mode must be enabled globally in the Configuration first. See Section Configuration - Downloads for more information about that. Products can have one or more Files assigned to them as downloadable Product File. Warning downloadable Product Files and additional Files are two completely different Things.
Product Downloads, additional Images and Files 4.6.6.2.2. More Information about Product Downloads Customers are automatically notified about their Downloads in an Email. The Email is sent out after the Order Status has been changed automatically (e.g. when using Credit Card Payment with instant notification that the Payment could be captured) or manually (from the Order List in the Admin Section). Figure 4.51.
Product Downloads, additional Images and Files Figure 4.52. Resend Download ID When the Download has expired or the Customer has downloaded the maximum number of Times, you can re-enable the Download Possibility from the same place: Figure 4.53. Re-enable Downloads Just click the Button "Re-enable Download" and a new Email with new Download ID(s) is sent out to the customer.
Product Discounts 4.6.7. Product Discounts Discounts in VirtueMart must be created in the Product Discount Form before being able to assign a Product to a specific Discount. Caution When updating a discount, your changes apply to all products which are assigned to this discount. Adding / Updating a Discount Go to "Product" # "Add/Edit Product Discount". Figure 4.54. VirtueMart Administration: The Product Discount List Now fill in the details for this Discount Record: Figure 4.55.
Product Ratings and Reviews the amount will mean that you give a Discount of XX % to the Product Price. If "Total" is selected, the amount will be substracted (added) from the Product Price. Start Date (optional) By clicking on "..." you can specify a date from the calendar, which will be the first day, the Discount is calculated and shown to the customer. The Start Date is no must. You can also only have an End Date or leave this field blank when this discount shall begin instantly.
User Management If a Product has one or more Reviews, you can view the List of all Reviews. Figure 4.57. List of Product Reviews To edit or view a Review click on the user name in the "Name" Column - this will bring you to the Review Form. You can quickly (un)publish a Review by clicking the Icon in the "Publish" Column. To completely remove a Review, you can click the Trash Icon in the last Column or select on or more Reviews and click "Remove" in the Toolbar. 4.7.
Users Figure 4.58. VirtueMart Administration: Shopper Group List To add a new shopper group, just click on the "New" button in the toolbar. In the following shopper group form just fill out the necessary fields. Figure 4.59. VirtueMart Administration: Shopper Group Form 4.7.1.2. Deleting Shopper Groups You can delete Shopper Groups from the Shopper Group List by clicking the "Trash Bin" icon in the last column of each row in the shopper group list.
User Groups 4.7.3. User Groups User Groups are "Permission Groups" and used to restrict access to certain parts and functions of the shop. Each user is assigned to a user group. By default registered customers are members of the group "shopper". When can this be useful? Imagine you have a user, who wants to access the "Report" section of the store. Usually this is restricted to admins and stoeradmins.
User Registration Fields Here you can choose a name for the group and the group level. Note The higher the group level, the less permissions are assumed: "admin" has higher permissions than "storeadmin", because the group level number is lower. After you have saved the user group, it is available in the core module and function list/forms. Figure 4.62.
User Registration Fields 4.7.4.1. Add a new Field You can add a new field by clicking the "New" button on the toolbar in the User Field List. The Field Form allows you to choose from various field types like Text Input Field Textarea Checkbox Date drop down email Web Address Used for Web Addresses. EU VAT ID Checks for a valid EU VAT ID upon Registration. Age Verification Allows you to ask the Customer for her/his Birthday to check if she/he is old enough to purchase from your Store.
User Registration Fields Figure 4.64. VirtueMart Administration: Add a new User Field The Form Fields have the following meaning: Type The type of this field. Can't be changed afterwards! Table Field Name The name of the column that will be inserted into the table structure of the tables "jos_vm_user_info" and "jos_vm_order_user_info" in your database.
User Registration Fields Required? If this is set to yes, a value must be provided or chosen, otherwise registration will not be possible. Show on Account? This defines wether the field is shown in the account maintenance form or not. User Read Only? If this is set to yes, the field is read-only and can't be changed by the customer. Show at Registration? If this is set to yes, the field will be shown in the registration form.
User Registration Fields Reordering Fields Fields can be reordered using the blue arrows in the user field list or using the text input fields in each row of the list: Figure 4.66. VirtueMart Administration: Re-Ordering in the Field List If you have used the input fields to change the ordering of the fields, you must apply your changes by clicking the Save Icon in the top of this column. After that the fields will be reordered.
Order Administration Figure 4.67. VirtueMart Administration: Modifying a Field 4.7.4.3. Deleting Fields You can delete all non-system fields from the User Field List. You just need to click on the Trash Bin icon at the end of the row of the item you want to remove. You can also select the checkboxes of the fields which you want to delete and then click the "Remove" button in the toolbar. 4.8.
The Order List The order record has a ‘status’ to indicate where the order is in the stream of events – for example, whether it has been paid for, shipped, or cancelled. The actual values you use for status are up to you, but by default you are given status values of Pending, Confirmed, Cancelled, Refunded, and Shipped. If you want to define your own status values, you can do so by selecting "List Order Status Types’ from the ‘Order Status’ sub-menu of the "Orders" menu.
The Order Details 4.8.2. The Order Details Figure 4.69. VirtueMart Administration: Upper Part of the Order Details The Order Details View shows all details which are relevant to the store owner. You have three tabs in the upper part: Order Status Change, Order History and Modify Order. Figure 4.70. VirtueMart Administration: Bottom of the Order Details In this part of the order details screen you see the list of all purchased products.
Vendor Administration You can also change the order status for single order items using the status drop-down list in each row of the order item list. 4.9. Vendor Administration Warning THIS PART OF VirtueMart STILL IS NOT COMPLETE. IT'S NOT RECOMMENDED TO USE THIS FEATURE. Vendors and Vendor Categories represent the top most tier of VirtueMart administration. Through vendor administration, the store keeper is able to manage products, users, and orders by vendor or supplier.
Vendor Categories Figure 4.71. VirtueMart Administration: Vendor List for a Category This will open the Vendor List page. 4.9.1.2. Adding Vendor Categories To create a new vendor category, select "Vendor | Add Vendor Category" from the VirtueMart admin interface. This will bring up the Vendor Category Form. Figure 4.72. VirtueMart Administration: Vendor Category Form Vendor Category Form Vendor Category Form Fields Vendor Category Name The name used to identify the vendor category.
Vendor Categories Figure 4.73. VirtueMart Administration: Vendor Category List Vendor Category List You may also add a new vendor category with the Vendor Category Form by clicking on the "New" button in the toolbar. 4.9.1.3. Editing Vendor Categories To edit an existing vendor category, select "Vendor | List Vendor Categories" in the VirtueMart admin menu. This will return the Vendor Category List screen (shown above).
Vendors Vendor Category Deletion Click 'OK' to confirm deletion of this category. 4.9.2. Vendors Vendors are the main organizational factor in VirtueMart. Products and product categories, billing options, etc. are all configured per-vendor. Upon installation, a global, default vendor is created. This special case cannot be deleted, and is managed separately via the "Store | Edit Store" menu option.
Vendors Description This is the Vendor Store's Description which is shown on the page shop.index. Terms of Service This is the complete text for your Terms of Service that is displayed to the customer. Store Name Required The name of the Vendor Store. Store Company Name Required The name of the vendor company. URL the vendor's Internet Address. Address 1 Address Line 1 Address 2 Address Line 2 City The City where the vendor is located.
Tax Rates Before deleting an existing vendor, all products, product categories, users, and orders associated to that vendor must be removed through either deletion or re-association to another vendor. VirtueMart will not allow the deletion of a vendor while these child records still exist for that vendor. Once these child records have been removed, select "Vendor | List Vendors" to see a list of all vendors. Then click on the name of the vendor you would like to delete.
Shipping Modules Tax Rate Example: 0.0825 The tax rate, as a decimal value. For example, 8.25% would be entered as 0.0825 Click on the "Save" icon to add your new Tax Rate information. 4.11. Shipping Modules 4.11.1. Standard Shipping It is wise first of all to think about how you will charge for postage and packing. The easiest way is to have a fixed shipping price for all of your products, but this is not always practical – especially if your products vary greatly in size and/or weight.
Standard Shipping Figure 4.76. VirtueMart Administration: Shipping Rate List By clicking on the name of a shipping rate in this list, you can access the shipping rate form to edit this shipping rate. To add a new shipping rate, click the "New" button in the toolbar.
Standard Shipping Figure 4.77. VirtueMart Administration: Shipping Rate Form In this form you can specify the details of the shipping rate. Shipping Rate Description This is the name of the Shipping Rate, displayed to the customer in the checkout. List Order The order of this shipping rate in the list of all other shipping rates (numeric value). Shipper Select the carrier for this shipping rate. Country The country/countries this shipping rate applies to.
UPS Shipping Module Fee The Fee for this shipping rate = the costs. Package Fee The package fee = additional costs for packaging. Currency The currency, which applies to the costs you have filled in above. VAT ID Here you can select a tax rate which is applied to this shipping rate. If you select "none", no tax will be applied. 4.11.2. UPS Shipping Module 4.11.3. USPS Shipping Module 4.11.4. Intershipper Shipping 4.11.5. Zone Shipping 4.12.
Add and Edit Payment Methods The configuration options for each payment method are different – depending on what is required by that payment service provider. Usually your payment service provider will give you some kind of code, key, or user name which needs to be entered in the Payment Method Editor. The Payment Method Editor consists of 2 tabs – the first of which you will probably not need to touch.
Pre-Configured Payment Methods for this, but if you need to do it yourself, check with your payment service provider as to what their requirements are. Often, automatic notification is referred to as ‘IPN’ or ‘Instant Payment Notification’. 4.12.3. Pre-Configured Payment Methods VirtueMart already comes with several Payment Modules that allow accepting payments from customers after a short time for setting them up with your Account Details. 4.12.3.1. PayPal www.paypal.com [http://www.paypal.
Pre-Configured Payment Methods appropriate URL (web address) for the script file in WorldPay’s control panel. When a customer finishes the Payment, Worldpay copnnects to this script on your server and when the transaction AND the payment have been successful, updates the order status. 4.12.3.3. authorize.net www.authorize.net This payment module uses the authorize.net AIM method, which means that the customers stay on your site and enter all Credit Card details.
Coupon Administration See section "authorize.net". 4.12.3.8. NoChex TODO 4.12.3.9. PayMeNow TODO 4.13. Coupon Administration You can access the list of coupons from the menu: "Coupons" # "Coupon List". Figure 4.81. VirtueMart Administration: Coupon List Here is where you can add, modify or remove existing coupons. To add a new coupon, click the "new" button in the toolbar. The coupon form shows up. Figure 4.82.
Reports Now you need to fill in the necessary value for the new coupon: Coupon Code This is the "code" a customer needs to fill in to redeem this coupon. This can be a simple word or a secret string with numbers and characters. Percent or Total Here you can choose wether the coupon value is a percentage of the cart total or a fixed total value. Coupon Type There are two types of coupons: Gift Coupons and Permanent Coupons.
106
Chapter 5. About VirtueMart 5.1. Known Problems See Bug Tracker [https://dev.virtuemart.net/cb/proj/tracker/browseTracker.do?tracker_id=1] 5.2. To-Do List 5.2.1. Wishlist / Not implemented Features • Meta Description/Keywords for products • Quick-Add: Discount on *all* Products • allow "send as gift" with individual text on order • Shipping based on Cart Total 5.2.2. General • improve performance • Clean up Code and make it better readable • XHTML/CSS Compliance • Clean up checkout 5.3.
The Documentation The VirtueMart Developer Portal [http://dev.virtuemart.net] is an open Development + Hosting Platform for all VirtueMart-related Open Source Projects. It offers the same services as JoomlaCode [http://joomlacode.org] or Sourceforge [http://sourceforge.net], but focusses on VirtueMart Development. The Portal is powered by a free Open Source Community License of CodeBeamer [https://codebeamer.com] - the Enterprise Collaborative Development Platform by Intland [http://www.intland.com]. 5.5.