Razor Host module from DNN installed already. Customers on DNN7+ this is already installed by default however customers on older installs should check the module installed before installing Cart Viper.

jQuery 1.4.3 or greater is required for Cart Viper, you can check the jQuery version you have installed in DNN by viewing the Host > Host Settings > Advanced Settings

> JQuery Settings section

In the example below DNN has 1.3.2 installed locally however we are loading jQuery from Google Ajax Hosting. We recommend using Google Ajax Hosting since this can improve the performance of your site.

From the Host JQuery URL field we can see we are using

https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js

To install Cart Viper login to your portal as a “super account user” and navigate to:

Host - > Modules Definitions - > Install module

Page | 6

Version | 3.3.0

Browse to the zip file containing the module on your local machine and click Next to start the installation process. Follow the steps of the install wizard to complete the process.

To verify that the install has ran successfully when viewing your module definitions there should be 10 Cart Viper modules listed as shown below.

Upgrading a Previous Version

Before upgrading to the latest version of the Cart Viper you should do the following

 Backup your portal database

 Backup the folder DesktopModules/CartViper

 Backup Cart Viper templates folder (see below).

The templates folder is potentially where you will have modified things like CSS,

HTML templates, default images etc to match with your site.

If you are sure you’ve not modified the templates then you can upgrade without having to follow the backup step.

You should backup these folders

/DesktopModules/CartViper/Templates

If you are using “Portal Templates” as shown on the Store Info page then you will need to backup the individual portal templates which will be located here.

/Portals/x/CVStore/Templates

Where x is the portal home directory of the portal that has Cart Viper installed.

Page | 7

Version | 3.3.0

Once you’ve taken the backups you can then install the module using the standard

Host Menu page.

Once the install is complete we strongly suggest that you then use Winmerge

( http://winmerge.org/ ) or similar to compare the new Templates folders (and sub folders) installed by the module, this is to ensure you merge your customisations with the changes made in the core package.

In terms of the /Portals/x/CVStore/Templates/js folder we suggest just copying the files from the master template location /DesktopModules/CartViper/Templates/js since its rare to find portal folders which have customised javascript files from those we create in the package.

If you had modified your resource strings you will need to use Winmerge to compare the differences with your files compared to the files installed during the upgrade.

Most of the resource files are within this folder

DesktopModules/CartViper/App_LocalResources however some files are also located in the sub folders

 Address (checkout address controls)

 Providers/GatewayProviders (checkout payment controls)

 Providers/ShippingProviders (checkout shipping controls)

If you are in doubt please contact us so we can assist you with the migration of your customisations.

Note for customers upgrading to Cart Viper 1.6.0 or greater.

Starting Cart Viper 1.6.0 we have now created a token for the product detail tab control, if you have created a custom product details page this will not exist. So you will need to place onto the product details page the [TABS] to get this outputted.

Cart Viper Quick Start Checklist

In order to get your store up and running you’ll need to do some basic steps to define how the store functions, such as shipping and tax for example.

Follow this checklist guide to work through the required steps.

1. Create the store pages and add the Cart Viper Modules (see page 9)

2. Install your license (see page 29)

Trial users can skip this step , you have a 14 day free license to test out Cart Viper.

3. Configure the store basic (see page 30)

4. Define how you are applying tax/VAT (see page 63)

5. Define your shipping options and delivery charges (see page 73)

6. Define your payment gateway (see page 47)

7. Create your categories and products (see page 103)

Page | 8

Version | 3.3.0

Initial Store Setup

Cart Viper consists of several modules that can be placed and configured on a portal to provide the functionality of an ecommerce solution.

You need to create three separate pages within your portal as detailed below.

You can either create the pages and add the modules manually to the page as detailed

on page 9 or you can run the quick install tool to do this automatically.

Quick Setup

Cart Viper comes with a quick way to setup a typical store, Quick Setup. Using the

Quick Setup feature will automatically create a store page, my account page and the store admin page along with any modules which are needed on the page.

To start the process you first need to login to the site as Host. Once logged to this page.

http://www.yourdomain.com/desktopmodules/cartviper/quickinstall.aspx

Replace www.yourdomain.com

with the correct url for your site.

Then you just need to select the correct from the drop down then click the Install button.

Manual Initial Setup

Store Admin Page

First you need to create a page that will become your store admin page, where the host/admin users will login and configure and administrate the store.

For ease of use we will call this page “Store Admin” and install the module Cart

Viper Admin on that page.

When you create this page you must ensure that only “administrators” have access to edit and view this page via the page settings option, as per the options below.

Page | 9

Version | 3.3.0

Store Page

The next step is to create a page that will become your store again for ease of use we will call this “Store”. The recommended layout is to install the Cart Viper Catalogue module in the Content Pane, with the Cart Viper Recently Viewed Items module below it, then into the left pane insert both the Cart Viper Menu module, Cart Viper

Mini Cart module and the Cart Viper Newsletter Subscription module. However you are free to install the modules in any pane you wish.

Page | 10

Version | 3.3.0

My Account Page

Finally you need to create a page that will become your users account page, we will call this page “My Account”, place the module “Cart Viper Account” onto this page.

You now have the structure of your ecommerce store created. If you followed the examples in this document it will look like the image below.

However, you will get a warning message informing you that you have not configured your store when you view the “my account” and “store” pages, you now need to configure the store administration options before your store is ready to use.

Page | 11

Version | 3.3.0

Cart Viper Modules

Cart Viper as you will see installs multiple modules within your portal, these modules are used to provide the standard ecommerce experience that your browsers and customers expect from a store.

Module Name

Cart Viper Account

Cart Viper Admin

Cart Viper Catalogue

Cart Viper Event

Calendar

Cart Viper Menu

Cart Viper Mini Cart

Cart Viper Newsletter

Subscription

Cart Viper Product

Widget

Cart Viper Recently

Viewed Items

Cart Viper Search

Module

Description

Module that allows the customer to checkout, view their cart, view and manage their wish list, order history and digital download locker.

Module which is used by the store admin to setup the store, products, categories and orders. This should only be viewable but the administrator.

Module used to list all the products with a category, product details and search results.

Module used to display a list of all the events in a month to view calendar format.

Module which lists the categories defined within the store, this allows the customer to navigate the categories and sub categories.

Module which displays a summary of the user's cart.

Module that allows browsers to register to receive the newsletter listing new products added to the store.

Module which allows you to display a selection of products on your portal in a template driven display.

Module which lists the recently viewed items by the user.

Module displays a search input box to allow searching of the product catalogue.

Page | 12

Version | 3.3.0

Cart Viper Account

Module that allows the customer to checkout, view their cart, view and manage their wish list, order history and digital download locker.

This module is required to be available on your portal, without it customers will not be able to checkout.

This module would normally be deployed to a page called "My Account".

If you are using Paypal (Website Standard) Provider then you must have the page that contains this module viewable to All Users so that the IPN callback from Paypal can call back into this page.

Settings

The Cart Viper Account module also has a Settings page which allows you to customise difference aspects of the module.

Setting Name

Default View

Description

This allows admin to define the default view that should be shown by the module, this can either be Customer Cart, Customer Digital

Downloads or Customer Orders.

Page | 13

Version | 3.3.0

Setting Name

Allow Guest Checkout

Auto-create anon user account

Hide Download Locker

Link

Enable Express

Checkout

Show T & C Checkbox on Single Page

Checkout

Description

If checked users will be allowed to checkout as guests.

They will not be required to create a user account on the site before they are allowed to checkout. However if they have a product in their cart that is a digital download, they will NOT be able to checkout as a guest.

If selected if a user checks out anonymously we will auto-create them a user account and email them the username and password.

When checked the Digital Download Locker link is hidden from the

My Account submenu bar.

Force SSL at Checkout When checked this will force the checkout to use SSL to secure the page. This is required when using a payment gateway which collects the payment details directly in the portal.

If checked you should setup and configure a SSL certificate for your

IIS server hosting the portal.

Require Company

Name

VAT Number

If selected a textbox will be inserted on the billing section of the checkout process for the user to enter their company name. There is also the option of making this a mandatory field so the user must complete this before moving to the next step of the checkout process.

If selected a textbox will be inserted on the billing section of the checkout process for the user to enter their VAT number.

If selected during the checkout process if the user has only digital downloads in their cart they will only be shown the billing and payment steps of the checkout process. If the user has physical products in their cart as well they will be shown the standard 4 step check out.

When checked we display a check box on the Single Page Checkout which the customer needs to tick before the order can be placed.

This confirms that the customer agrees to the store's Terms and

Conditions before they are allowed to place the order.

Show Thumbnail

Product Column

Display Continue

Shopping Button

Display order notes textbox

Mini cart template

When checked this will display a thumbnail of the products in the cart for each item.

Select the product attribute to display in the product column of the cart, this can be Product Title, Model Number or Model Name.

If selected a button will be displayed on the cart page, that when clicked will redirect the user to the store catalogue page.

If selected a multi-line text box will be displayed on the cart details page where the customer can optionally enter a message relating to this order. This text will be associated with this order and be viewable by the store admin and customer once the order has been placed.

The template that is used to output the mini cart.

Page | 14

Version | 3.3.0

Setting Name

Hide Mini Cart Subtotal

Description

If selected the subtotal will be hidden in the mini cart module, this could be useful if you were running a RFQ store and did not want to display costs.

Display Prices inc

VAT/GST

Hide mini cart when empty

If checked the prices are displayed inclusive of VAT in the cart and mini cart.

This option is only available when the store is using VAT for tax calculations.

We will hide the mini cart module on the page when the cart is empty and only display it once the customer has added an item to the cart.

Show product thumbnail If selected in the customer digital download locker the product thumbnail of any products they can download will be shown.

Show Order Item

Thumbnail

If selected in the orders section along with the product title we will also display the product thumbnail image.

Hide order management section

If selected the “orders” link will be hidden from the my account module.

Check for User Order

Prefix

If selected the order number will be prefixed with the text entered into that user's DNN profile that places the order – this could be used to identify an order to a sales rep for example.

The Cart Viper Account module also contains settings for defining donations that can

be made by the customers. Please see the Donation section (page 141) of this

document for a detailed explanation of how to use this feature.

Cart Viper Admin

The Cart Viper Admin module is required to be added to a page on your portal, this module is central to allow the store administrator to manage the store.

This module should only be visible to the administrator of the store.

Please see the Store Administration Options section (page 28) which describes in

detail this module and how to use it to manage your store.

Page | 15

Version | 3.3.0

Cart Viper Catalog

Module used to list all the products with a category, product details and search results.

This is the most important module in Cart Viper, it is used to display all the products in the store.

Settings

The Cart Viper Catalog module also has a Settings page which allows you to customise difference aspects of the module.

As you will see these settings define which templates are used to render the content of the store. You can read more about the template and tokens in these sections

Template Overview (page 147) and Appendix A (page 165).

General Settings

Page | 16

Version | 3.3.0

Setting Name

Catalog Template

Default Category

Behaviour

Default Category

Show Product Detail

Enable Content

Indexing

Enable Default Image

Description

Allows you to define the template which will be used to render the

Catalog module.

Select how the catalog should behave if the user is viewing the catalog page, but as yet have not selected a category. eg. do nothing, display the selected category or display all products.

Select the default category to display.

Check to display the detail product section when listing products in the category.

Check to enable content indexing by the DotNetNuke search engine.

If you use several Cart Viper Catalog modules, you should check this setting in ONLY one Cart Viper Catalog module instance. Otherwise, your products will indexed twice (or more) by the search engine.

This does not affect the Lucene.net index used internally by the store.

When checked any products which do not have an image defined will display a standard default image.

Page to redirect user to after add to cart

If selected once the user has added an item to their basket they will be redirected to the page selected.

Enable Modal Popup for Ajax Cart

Anchor Name

If checked we display a JavaScript modal popup when an item is added to the cart successfully. Otherwise we use a notification control to display this information in the top right corner.

Optional Anchor name which should be appended to the product hyperlinks, this makes the page jump to the defined A tag when the page is displayed in the browser.

Disable price / checkout for anonymous

If selected all prices and cart will be hidden if the user is not authenticated. Once they are logged in price and cart will be enabled.

This feature allows the store to be turned into a business to business

(B2B) channel.

Page | 17

Version | 3.3.0

Category Product Settings

Setting Name

Container Template

List Template

Rows

Columns

Column Width

Repeat Direction

Show Thumbnail

Detail Page

Sub-Categories

Show Add Variant to

Cart Caption

Description

Select a template for the category product container. Default template is CategoryContainer.htm..

Select a template for the product list. Default template is

ProductList.htm.

Enter the row number to display products.

Enter the column number to display products.

Enter the column width in pixel. If the value is higher than 0, the value will be inserted to the style attribute of the corresponding table cell.

For a better control display, you should set this value to 0 and use the

CSS classes: td.StoreCategoryProductItem and td.StoreCategoryProductAlternatingItem defined in the file

StoreFront.css.

Select the direction to display product list.

When checked the thumbnail for the product will be displayed in the category product list.

Select the page where to place the Cart Viper Catalog module to display the product detail. Generally, it is the same page, unless you use multiple Cart Viper Catalog modules.

Check to include in the list products of the sub categories of the selected category.

If selected if a product has variants and the PRODUCTVARIANTS tag is not included in the category page, instead of showing the standard add to cart button we will instead show a caption explaining why this product can’t be added to the cart from this page.

Page | 18

Version | 3.3.0

Setting Name

Sort By

Sort Settings

Description

Defines the default sorting of products in the category product view. If you want to implement your own ordering select Custom Sort Order.

Setting Name

Sort By

Search Settings

Description

Select the product column on which the list should be sorted.

Setting Name

Search Results

Template

Description

Select a template for the search results list. Default templates is

SearchResultsList.htm.

Page | 19

Version | 3.3.0

Product Details Settings

Setting Name

Detail Template

Product Specification

Template

Cart Viper Events Calendar

Module that displays events in a jQuery calendar:

Settings

The Cart Viper Events calendar also has a settings page that allows you to control different aspects of the module:

Page | 22

Version | 3.3.0

Setting Name

View Events Template

Description

The template we should use to render the contents when a user clicks on the event.

The template we should use to render the contents when a user hovers the mouse over the event in the calendar view.

View event summary template

Cart Viper Menu

Module which lists the categories defined within the store, this allows the customer to navigate the categories and sub categories.

The menu module supports four different category menu types. Both of the mega menus optionally support outputting the page navigation links for the site in addition to the store category links.

Original

The module renders the categories and child sub-categories using a nested <ul> tag.

You are able to modify the CSS used by the store

Vertical Mega Menu

Displays the categories in vertical mega menu style with up to three levels of categories displayed to the user.

Page | 23

Version | 3.3.0

Horizontal Mega Menu

Displays the categories in horizontal mega menu.

Razor Script

The menu option is the most flexible. When selected a drop down list of available razor scripts defined within Cart Viper are shown.

We ship with an example menu called categoryMenu.cshtml. This file contains razor code that is used to render the category menus to html.

You are free to modify or create your own scripts which can then be used to output the menu however you like.

The script file should be placed into the /scripts folder which is off the base template folder.

Settings

The Cart Viper Menu module also has a Settings page which allows you to customise difference aspects of the module.

Setting Name

Category Menu Type

Include DNN Menu

Catalog Page

Display Product Count

Display Expand

Description

Defines the menu displayed in the store, currently we have a simple menu (Original) and vertical mega menu.

This is only displayed when the menu type is either a vertical or horizontal mega menu. When checked the pages of the site are outputted into the menu as well as the store categories.

Select the page of your site which contains the Cart Viper Catalog module, this will then enable the hyperlinks generated by the menu to link to the correct page on your portal.

When checked displays the number of items in the categories and subcategories in the category menu

If selected if a category has sub-categories, an expand or collapse

Page | 24

Version | 3.3.0

Setting Name

Collapse Options

Override Category

Sorting

Root Category

Anchor Name

Description

icon will be displayed next to the current category so when clicked it will either hide or show the subcategories.

If selected we will ignore the default sort ordering defined in the category admin, but instead will order A-Z by category name.

Optionally allows the category root menu to be selected, if not selected we show all the categories.

This option allows you to display a subset of categories in the menu by defining the root category.

Optional Anchor name which should be appended to the product hyperlinks, this makes the page jump to the defined A tag when the page is displayed in the browser.

See this blog post for more details http://blog.cartviper.com/post/2011/04/22/Anchor-Name-Support.aspx

Facet Display Mode Defines the control typed used to display the facets in the facet search. The facet options can either be displayed as check boxes or radio buttons.

Hide Empty Categories When checked any category which contains zero products will be hidden from being shown in the category menu module.

Cart Viper Mini Cart

Module which displays a summary of the user's cart. This would normally be added the page which contains the Cart Viper Catalog and Cart Viper Menu modules.

From release 1.4.1 this module is now template driven so you are free to customise this to your requirements. The file MiniCart.htm is used as the template; you can read

more about customising this module on page 154.

Cart Viper Newsletter Subscription

Module that allows browsers to register to receive the newsletter listing new products added to the store.

Page | 25

Version | 3.3.0

Further details about this module and how to use it within your store can be found in

the Product Newsletter Settings section (page 36).

Cart Viper Product Widget

Module which allows you to display a selection of products on your portal in a template driven display.

You can add this to any page in your portal and use as many number of these modules as you require. For example you can add this module to your homepage to pull a selection of products to show your visitors.

We have two default templates which are supplied with Cart Viper which you can use as they are, or as a starting point to customise.

The screenshot above is an example of the Carousal template which providers a scrolling AJAX display for the products in the widget.

Settings

The Cart Viper Product Widget module also has a Settings page which allows you to customise difference aspects of the module.

Page | 26

Version | 3.3.0

Setting Name

Query Type

Description

Defines the query type used to select the products from the

catalogue. See page 145 for further details.

Product Category Filter Optionally select a category, if selected products will only be selected from this category based on the above criteria, or choose to select from all categories in the store. Note this option is not valid id "Single

Product" is the Query Type.

Selected Product

Item Limit

Template

If we are displaying a single product, here is where you select the product to be displayed in the product widget. Note this option is only available if "Single Product" is the Query Type.

Number of products to return from the query, this should be between

1 and 25. Note this option is not valid if "Single Product" is the selected Query Type..

Template used to transform the products into the HTML mark up.

Further details about the module and template can be found in the Product Widget

Control section (page 145).

Cart Viper Recently Viewed Items

Module which lists the recently viewed items for the customer. This module will have a list of products that have been viewed for each different user. A user will only see their own list.

Page | 27

Version | 3.3.0

Settings

The Cart Viper Recently Viewed Items module also has a Settings page which allows you to customise difference aspects of the module.

Setting Name

Item Limit

Description

Number of products to return from the query, this should be between

1 and 10.

Template used to transform the products into the HTML mark up.

Template

This module also has a library of templates which are shared with the Cart Viper

Product Widget module. You can customise and create your own which are used to render the products in the control. Further details of the template system can be found

in the Product Widget Control section (page 145).

Cart Viper Search Module

This module allows you to place the search input control on any page within your portal. This is an optional module you could just stick with the search control which is displayed when viewing the store.

This module is so you can add it to a page outside of the store page.

Page | 28

Version | 3.3.0

This module has no settings.

Store Administration Options

In order to view and configure the store administration options you need to either login as a user with host or admin privileges for your DNN installation.

Licensing

The current license status of your Cart Viper store can be viewed by selecting the licensing option from the store admin page. To install or upgrade a Cart Viper license you must upload the license file via the user interface.

Trial Mode

The Cart Viper store can be used unlicensed for 14 days in trial mode, this allows you to test the functionality of the store, after the 14 days have expired you will then be required to purchase a license to continue using the module.

If you do not purchase a license after your trial has expired your users will not be able to checkout and will be faced with the following error message when the attempt to checkout.

Whilst in trial mode the store will function as if fully licensed.

The only limiting factor is that you will be able to install the store on a single portal rather than having multiple stores in different portals.

License Types

At any point during or after the trial you can purchase a license to allow you to use the store without any expiry limit.

Cart Viper has one basic license types you can purchase.

License Type

Single Portal *

Description

A single portal license enables you to install the Cart Viper store on a single portal within your DotNetNuke installation.

* To install on multiple portals you would require a single portal license for each portal.. Upgrades and bulk deals are available please contact us at

[email protected]

Page | 29

Version | 3.3.0

Premium Add-ons

In addition to the two basic license types we have Premium Add-ons which enable further advanced features within Cart Viper. These add-ons extend what the store can do and how it operates.

Currently the following Premium Add-ons are available.

Premium Add-on

Events

Mobile Commerce

Catalogue Workflow

Multi Language Store

Description

Provides the ability for the store to sell event based items.

Provide a separate mobile module which is designed for use on mobile phones.

Enables work-flow for products and categories in the store.

Enables multiple language support for products and categories in the store.

Store Info

The store info section contains the highest level details regarding your Cart Viper store installation and must be completed before any of the other sections are enabled.

If you have purchased a single host license you will be able to configure multiple Cart

Viper stores via their individual Store Info sections, so the settings here are specific to the current Cart Viper installation rather than being global across all portals.

More detailed information on each setting can be found by clicking on the contextual option hint on the left hand side of the option.

Page | 30

Version | 3.3.0

Note the Primary Store Email is used as the main email address for the store. This is the address that all emails will have as the form address.

When an order is placed the Primary Store Email address will receive a confirmation.

It is also possible to use the Additional Email Addresses field to supply a list of other email addresses which should get the new order notification email. This field accepts multiple email addresses with each one separated using a “;” e.g.

[email protected];[email protected];[email protected]

It is possible to create a new role e.g. “manage orders”,” manage catalogue” or

“manage store” in your DNN site and assign this role to manage orders, manage catalogue or manage store via the drop down lists above.

The advantage of this is that users in these roles as well as administrators and hosts can manage orders from the catalogue without having to give them a host or administrator account and all the permissions and access this would give them. For instance you could give someone the role “manage store” and they would only have access to the day to day running of the store e.g. products, orders etc. The payment, shipping information etc. would be hidden from them.

By giving a role to the “add products only” setting, you can create DNN accounts that can add products however their changes would have to be moderated by an admin account before the products would appear “live” in the store.

SMTP Settings

When the store generates an email it will be sent using the SMTP defined within the

DNN Host menu.

Starting with version 1.6.0 it’s possible to configure the store SMTP to use a different server for each portal.

The feature allows an option config file to be placed in the root of the module folder which then is read to load the SMTP server settings. If the file is not found then settings stored at the host level of DNN are used.

The file should follow the name convention smtp_portalX.config

Where X is the portalId of the current portal.

The contains of the file should be as below

<?xml version="1.0"?>

<section name="smtpSettings" type="CartViper.Modules.Store.Components.Smtp.SmtpSettings,

CartViper.Modules.Store"/>

</configSections>

Page | 31

Version | 3.3.0

</configuration>

Store Currency

The Store Currency setting in the above screen shot allows you to define the currency that the store will use to display the cost of your products and the currency that will be sent to your selected payment gateways. Cart Viper supports the following currencies

(for additional currencies please contact us at [email protected]

)

MXN

NZD

PHP

SGD

THB

USD

Currency Code

AUD

CAD

CHF

EURO

GBP

HKD

JOD

Description

Australian dollar

Canadian dollar

Swiss franc

Euro

Great British pound

Hong Kong Dollar

Jordanian Dinar

Mexican peso

New Zealand dollar

Philippine peso

Singapore dollar

Thailand Baht

United States dollar

Store Location

The below screen allows the user to define the location of the store, from these settings Cart Viper will determine if VAT or tax is applicable on the products that are sold.

Page | 32

Version | 3.3.0

Page | 33

Version | 3.3.0

General Settings

General settings allow you to set various options for your store and to customise the behaviour of the store.

Thumbnail Image Width, Medium Image Width and Large Image Width define the size of each image type in pixels.

You are free to change these values at any time and the application will resize the images to newly defined image

Product Weight Measurement defines the units of weight which are used for the product within the store, any unit of measure can be used and they are defined in

“Store units of measure”. Note if you wish to use either UPS, USPS or FedEx to calculate your shipping rates lb or kg must be selected.

Product Size Measurement defines the units to measure the products dimensions which are used within the store any unit of measure can be used and they are defined in “Store units of measure”. Note if you wish to use either UPS, USPS or FedEx to calculate your shipping rates IN or CM must be selected.

The Email a Friend functionality allows users to email a link for a product to a friend, to stop spamming this feature using reCAPTCHA. You will need to sign up for a free account here http://www.google.com/recaptcha

Enter your public and private key from your reCAPTCHA account to the Recaptcha

Public Key and Recaptcha Private Key fields.

Page | 34

Version | 3.3.0

Enable Wish list defines if you allow your users to add products they would like to purchase to their wish list.

Search Default Operator defines how multiple word searches are parsed and executed by the search engine. The default value is OR this means if we searched for "wooden dog" we are asking the search to find "wooden OR dog" in the products.

If we selected AND as the operator the same query would look like this "wooden

AND dog" so in this search we would only return products which contain all the words in the query.

Search Auto Complete defines if the auto-complete feature is enabled. When turned on as the user types a search term we suggest matching keywords which are contained within the product catalogue.

Bit.ly Username and Bit.ly API Key are credential for accessing Bit.ly ( http://bit.ly/ ) shortening URL web service. These are used on the Share with a Friend feature in the store front to create a shoran URL for the product link which is then sent to the friend of a user.

If you do not enter values here Cart Viper will simple output the full un-shortened

URL in the email.

You can create a free Bit.ly account by visiting this page http://bit.ly/a/sign_up

US State Format when outputting a US address you can define if we should output the

State Code or the full State Name, when the address is not within the US the region/state field is output as name.

Generate Registration Code – When selected if a user purchases a digital download and have not registered for an account a random 7 digit alphanumeric code will be generated and emailed to the user. Cart Viper performs no processing with this code however it could be used externally to verify a purchase etc.

Minimum Subtotal value – If a value is entered here this is the minimum subtotal amount the user must have before they can checkout. If no value is entered the user will be able to checkout with any subtotal.

Allowed Product Datasheet Extensions – A comma separated list that defines the file extension that we support for the product datasheets by default this is .pdf but could be altered to allow pdf,zip

Allowed Download Extensions – A comma separated list that defines the file extension that we support for the product digital downloads by default this is pdf,zip but could be altered to allow pdf,zi,mp3,doc

Global digital download limit – This is the global limit for how many times a user can download a digital download. This can be overridden on a per product basis.

Global Digital Download Expiry – This is the global limit for the number of days that a user has to download their digital download. This can be overridden on a per product basis.

Page | 35

Version | 3.3.0

Cart cookie expiry days – This is the number of days the cookie that is used within cart viper should expire after.

SiteMap – This feature is only available if you are using DNN 5.3 or greater. Clicking

Install SiteMap will install the Cart Viper site map provider into the DNN SiteMap service which will then output the entire product URL into the sitemap.xml file which

DNN will generate.

YouTube Video Width – Defines the width in pixels that the YouTube videos should be outputted in the store.

YouTube Video Height – Defines the height in pixels that the YouTube videos should be outputted in the store.

Quote Threshold Amount – Determines the sub-total that is required in the cart before the customer has the option to request a quote for the items. A value of less than zero

turns off the quote feature. See the quote section for more information page 97.

Quote Expiry Limit (days) – when the quote facility is enable this defines the number of days a quote is valued for once approved by the store admin. The customer can only purchase the quote when within this time limit. Once expired the quote can't be purchased. A value of less than zero means no time limit is applied to the quote.

Enable Customer Order Moderation – When enable it allows customer accounts to require approving from a manager account before the order can be placed in the

system. See here for more information about customer management, page 101.

Enable Audit Log – When checked all changes made to the products, categories, offers and reviews will be record in an audit log. Please see here for more details,

page 83.

Show Restricted Categories/Products – When selected restricted categories/products will be shown to all users even those which don't have the role required. If the user doesn't have the required permission a caption will be shown when they attempt to add the item to their cart.

The caption can be customised in the field below the check box called Products

Restriction Caption.

Product Newsletter Settings

Cart Viper has the ability to create an automated newsletter that is sent from the store on a regular basis that would highlight products that are newly added within the defined period.

Page | 36

Version | 3.3.0

By selecting Enable Product News Letter enables sending the product newsletter to your customers which have registered to receive the email. When checked this will create a scheduled job with DotNetNuke which sends the emails.

Send Frequency defines in days the period of time that will elapse between sending the next Product Newsletter to the subscribers.

Max Number of Products defines the maximum number of products to include in the newsletter email.

Include Products Added Within defines the maximum ages of the products to be included in the email.

Manually Send Newsletter allows the store administrator to send the emails to all the subscribers by clicking the button.

In order to complete the configuration of the product newsletter you must also add the

Cart Viper Newsletter Subscription module to your site, this allows users to both subscribe and unsubscribe to the newsletter.

In order to subscribe to the newsletter a user will be sent an email to the email address they have entered, until they have clicked the link contained within the email that validates they own the email address they have entered, they will not receive the product news letter.

The recipient will have the option to unsubscribe by clicking the relevant link within the product newsletter email.

It is worth noting if you define the product newsletter to be sent every 2 days and include products added within days to be 7 for example users will generally be getting

Page | 37

Version | 3.3.0

the same products in the email each day as there is an overlap. It is recommended the newsletter is configured with a send frequency to be greater than the include products within.

e.g.

Send frequency = 7 (every seven days)

Include products within = 5 (products added within the last five days)

This allows the users to receive emails with different products in each week.

It’s also possible to customise the email sent to the user, see the Customisable HTML

Email Templates (page 155) section for further details.

Newsletter Subscribers List

The menu item Newsletter Subscribers on the Store Admin page allows you to see a list of all existing users that have subscribed to the newsletter. You are also able to delete any email and download all the subscribers in a CSV file.

Order PDF Settings

Once an order has been placed it is possible to download the order in PDF format, the

PDF can be downloaded by the store admin in the Manage Orders section or by the customer from the My Orders section.

Order PDF Icon setting this value allows you to define the icon which should appear in the top left corner of the PDF.

Page | 38

Version | 3.3.0

Product Name Prefix this allows the store admin to output the Model Number or the

SKU for each product in the PDF. This will be prefixed to the model name as the line items are outputted.

If a prefix is selected then it will also be applied to the order history display in the customer's my account page.

Header Text allows you to enter up to 380 characters which can be added to the top of the PDF that is generated.

Footer Text allows you to enter up to 600 characters which can be added to the footer of the PDF that is generated.

Email to Customer When Order Is Placed defines that the order PDF will be emailed to the customer when their order is placed.

Store Email Template

Using the store email template settings allows you to create custom HTML email templates that are sent to your customers once they checkout.

For more information about defining and creating custom template see Customisable

HTML Email Templates section later in this document.

Product Comparison Settings

It is possible to allow customers to compare up to 4 products side by side to allow them to quickly and easily see key differences between products and aid them making a decision on which to purchase.

The product comparison settings allow the store admin to pick which product attributes a customer can compare to ensure they only compare attributes that are relevant to the product the store is selling:

Page | 39

Version | 3.3.0

If none of the product comparison options are selected then the product comparison feature will be removed from the store.

Google Analytics Tracking

Cart Viper supports event and ecommerce tracking using Google Analytics, turning this tracking functionality on will provide you with detailed statistics of your ecommerce transactions and how your visitors are interacting with your store.

IMPORTANT

Turning this feature on will not add the Google Analytics tracking code to your store. This should already be embedded in your skin.

This feature will simple output the snippet of code to register the event using the existing GA tracking script which has already been loaded by skin.

Ecommerce Tracking is not enabled by default in your Google Analytics account; you should follow these steps to enable tracking.

1. Login to your Google Analytics Account

2. View the Settings for the account to enable Ecommerce tracking

3. Answer Yes to E-Commerce Website.

Page | 40

Version | 3.3.0

Category

Cart

Product

Catalog

Cart Viper supports the new asynchronous JS script http://code.google.com/apis/analytics/docs/tracking/asyncTracking.html

and also the traditional synchronous JS script http://code.google.com/apis/analytics/docs/tracking/gaTrackingOverview.html

We strongly suggest that you use the asynchronous script to track your visitors since this has improved performance benefits.

In addition to record all ecommerce transaction completed we also record the following events. (Offline payment transaction will not get recorded in Google

Analytics since they are technically not completed since payment has not been received).

Action

AddToCart

ViewCart

DeleteItem

UpdateQuantity

DeleteCart

AddToQuote

EmailAFriend

ReviewAdd

ViewSpecification

ViewBundles

ViewRelatedProducts

ViewReviews

AddToComparison

ViewCategory

Label

Product Sku

CategoryName

SearchTerm

Page | 41

Version | 3.3.0

Wishlist

MyAccount

Checkout

AddToWishlist

DeleteFromWishlist

ViewWishlist

ViewOrderHistory

ViewDigitalDownload

ViewComparisonList

ViewBillingAddress

ViewShippingAddress

ViewShippingMethod

ViewPaymentDetails

OrderCompleted

Product Sku

As you can see from the table some events also record the product sku for the product that the event references.

The value used for the product sku is looked up from the product and implements a fall back lookup system. The system will use the first non-empty value from the following list.

1. Product Sku field

2. Model Number field

3. Internal database primary key for the product formatted “CV-<PKID>”

Page | 42

Version | 3.3.0

Order Notification Call back

Cart Viper allows integration into external systems such as account and order fulfilment for example; integration is facilitated using the Order Notification Call back feature.

Once an order is placed and every time an order's status is updated a notification call back is send to a URL.

Using this functionality it’s possible to then record the customer's order in your accounts package, generate some custom email with a license key/serial number and notify some external order process etc.

To notify the external system Cart Viper will send a HTTP POST request to a URL, contained within the request will be the order details as XML.

Your external system can then parse the XML and process as required.

We've already created a helper DLL for .net 3.5 so you can use this with your URL to process the data easily.

175

Enable Order Notification: when checked this will then call the Call back URL with the XML order.

Call back URL: enter the url of the page that should be called with the HTTP POST.

Shared Secret: this is an optional field but we strongly recommend that you complete it. To improve security we create a sha1 hash of the order details we send via XML to the call back URL, this means that you can validate that the request is genuine and hasn't been tampered with in transit.

A sha1 hash is only created if you enter a Shared Secret.

To read more about the hash and how to validate it please see appendix B.

Pre Checkout Notification Callback

This operates similar to the Order Notification call back but this call back to the URL occurs on the very final step of placing an order. This allows you to wire in an external system which will check some external data to make sure the order is valid and that you are willing to accept the order.

The contents of the order about to be placed are sent via a HTTP POST to the URL.

The order details are encoded using XML, the format of the XML is detailed on page

175. The call back URL then must either reply with a boolean flag to indicate if the

order should be allowed or not. If the order is not allowed then the call back URL can provide a message which is displayed to the customer.

The call back should return an XML snippet to the request in the following format.

Page | 43

Version | 3.3.0

</result>

message is optional and only displayed when valid is false, this is used to inform the customer the reason the order can't be placed.

valid a boolean flag used to indicate if the order should be placed (true) or if the order can't be placed (false).

To enable this feature configure the options below.

Enable Pre-Checkout Notification: when checked this will then call the Call back

URL with the XML order.

Pre Checkout Order Notification URL: enter the url of the page that should be called with the HTTP POST.

Shared Secret: this is an optional field but we strongly recommend that you complete it. To improve security we create a SHA1 hash of the order details we send via XML to the call back URL, this means that you can validate that the request is genuine and hasn't been tampered with in transit.

A SHA1 hash is only created if you enter a Shared Secret.

AWS Account/Azure Account

Cart Viper has the optional ability to store digital download files in the AWS or Azure cloud. This has two benefits, firstly you don't need to store the download on your web server and secondly the download of the file itself will be direct from the cloud.

To use the cloud digital download feature you first need to define your AWS and/or

Azure account to enable this feature.

See the 127 page for more information about product downloads.

Amazon Order Message Queue

Cart Viper has the ability to push details of a new placed order into the Amazon SQS service. You could then have some external process or system (ERP) that polls the queue for new orders and processes them.

To enable this feature follow the steps below.

Page | 44

Version | 3.3.0

Configuration

Create an AWS account and enable SQS. Within the AWS console create a new SQS queue. To use the SQS service you need to define your AWS account in the section above titled AWS Account.

On the Store Admin > Store Info page you need to supply the values required as shown.

Payload format defines if the message will be pushed as an XML file or if you want to encode the xml file to base64 and push that into the queue.

We recommend just pushing the file as XML into the queue.

Sample XML

Below is a sample output of the file sent to the SQS once an order is placed.

xml version="1.0" encoding="utf-8"?>

< order >

< orderId >1455</ orderId >

< orderDate >2011-11-15T11:26:31.0330000</ orderDate >

< subTotal >13.50</ subTotal >

< tax >0.95</ tax >

< shippingCost >0.00</ shippingCost >

< discountAmount >0.00</ discountAmount >

< grandTotal >14.45</ grandTotal >

< shippingDescription >Free Shipping</ shippingDescription >

< offerCode />

< orderStatus >2</ orderStatus >

< portalId >11</ portalId >

< billingAddress >

< firstName >mark</ firstName >

< lastName >mcavoy</ lastName >

< address1 >135 Lancaster Drive</ address1 >

< address2 />

< city >Davenport</ city >

< region >Florida</ region >

< country >United States</ country >

< postalCode >33897</ postalCode >

< phone >555</ phone >

< email >[email protected]</ email >

</ billingAddress >

< shippingAddress >

< firstName >mark</ firstName >

< lastName >mcavoy</ lastName >

< address1 >135 Lancaster Drive</ address1 >

< address2 />

< city >Davenport</ city >

< region >Florida</ region >

< country >United States</ country >

< postalCode >33897</ postalCode >

< phone />

< email />

</ shippingAddress >

< items >

< item >

< itemId >4321</ itemId >

Page | 45

Version | 3.3.0

< modelNumber >DM38</ modelNumber >

< name >Creamer</ name >

< unitPrice >3.00</ unitPrice >

< quantity >3</ quantity >

< variantOptions />

< sku />

< manufacturer >Cheriton Ceramics</ manufacturer >

</ item >

< item >

< itemId >4091</ itemId >

< modelNumber >FG10</ modelNumber >

< name >Anne Boleyn Toby Jug</ name >

< unitPrice >4.50</ unitPrice >

< quantity >1</ quantity >

< variantOptions />

< sku />

< manufacturer >Cheriton Ceramics</ manufacturer >

</ item >

</ items >

< hash />

</ order >

The only thing not obvious from the XML is the meaning order Status element, this is an integer which defines the current status of an order. The possible values are listed below.

Processing = 1,

AwaitingPayment = 2,

AwaitingStock = 3,

Packing = 4,

Dispatched = 5,

Cancelled = 6,

Paid = 7,

PostPaid = 8,

PartialShipped = 9

Store Units Of Measure

This sections allows you to define the units of measure the store supports for weight or dimensions, by default these are LB / KG and CM / IN. Any number of units of measure can be entered here as a comma separated list as per the below screen shot:

Once the units have been added they will appear in the dropdown list in store info → general settings and can then be selected as the units of measure to use for the store.

Page | 46

Version | 3.3.0

Additionally it is all possible to define some optional values or the Product Unit.

These can then be used on the product edit page to define the unit of measure that the product is sold in. So for example you could define Each,Box,Carton,Pallet then select the relevant option for a product.

Payment Gateways

Cart Viper comes pre-installed with a number of different payment gateways that can be used to take payment for your products. If you have a payment gateway you would wish to use and do not see it in the list below please contact us at [email protected]

and we can discuss adding the gateway for you.

Payment gateways which collect the credit card details of your customers directly on the DNN portal need to have an SSL certificate installed.

These payment gateways also display an image with the credit cards supported and a link to help the customers locate the CVV/CV2 number. These are customisable using the resource files for a portal.

Due to the large volume of payment gateways we support not all have a detailed write up in the document. Each gateway has its own easy to follow setup page which prompts you for the credentials and provides any information you need for your gateway.

We strong suggest that before going live you test the payment gateway in test/sandbox mode to validate you have anything set up correctly. Once you have determined this we suggest you place at least one live transaction when you switch to the live version of the gateway to validate the configuration in live mode.

Checkout Interfaces

It is possible to configure the checkout interface that is presented to the user.

Currently Cart Viper supports 4 stage, 3 stage or single page checkout process.

The main difference between the 4 stage and the 3 stage checkout process is that the 3 stage checkout has the billing and shipping address on the same page, with the shipping address section being hidden if the user only has digital downloads in their cart. Finally the shipping method and payment collection details are taken before the user reviews their order.

Page | 47

Version | 3.3.0

The single page checkout allows the user to enter their billing, shipping and payment details on a single page without having to click onto the next page to enter their details.

Depending on the payment gateway that is selected it determines which checkout interface can be selected, below the table illustrates the checkout interfaces that are supported by each of the payment gateways.

Payment

Gateway

Authorize.net

Authorize.net SIM

Barclays EPDQ

Buckaroo

Card Save

Comm Bank

CyberSource*

EPay

Eway Direct

Requires

SSL



Payment

Take on Site

Directly





















Supports

Recurring

Payment













Supported

Checkout interfaces

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

  

Supported

Currencies

USD, GBP,

EUR, CAD

CAD, GBP,

USD

EUR,GBP

EUR

GBP

AUD

USD

FourStage,

ThreeStage,

SinglePage

USD, GBP,

EUR, CAD,

CHF, AUD,

MXN, THB,

SGD, HKD,

PHP, NZD,

CZK, SAR,

NGN

AUD

Page | 48

Version | 3.3.0

Payment

Gateway

First Data

First Data Connect

First Data E4

Global Iris

HSBC CPI

Innovative

Gateway/

Merchant

Internet Secure

MiGS

Mollie

MultiSafePay

NAB Direct Post

Offline

Requires

SSL



Payment

Take on Site

Directly













Supports

Recurring

Payment



Supported

Checkout interfaces

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

FourStage



FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

Ogone   

Supported

Currencies

USD

USD, GBP,

EUR, AUD,

CAD

GBP

USD

CAD, USD

AUD

EUR

AUD

FourStage,

ThreeStage,

USD, GBP,

EUR,

CAD, CHF,

AUD, JOD,

MXN, THB,

SGD, HKD,

PHP

EUR

Page | 49

Version | 3.3.0

Payment

Gateway

Payment Express

Pay One Ez

PayPal Pro

PayPal Pay Flow

PayPal Standard

Pay Port

PayWay

Prepaid Payment

Points Provider

QBMS

Rabo Kassa Omni

Sage-Pay-Formintegration

Requires

SSL



Payment

Take on Site

Directly























Supports

Recurring

Payment







Supported

Checkout interfaces

FourStage,

ThreeStage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

Supported

Currencies

USD,GBP,E

URO,CAD,C

HF,AUD,TH

B,SGD,HKD

,PHP,NZD

USD FourStage,

ThreeStage

FourStage,

ThreeStage,

SinglePage

USD, GBP,

EUR, CAD,

CHF, AUD,

NZD, CZK

USD FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

USD, GBP,

EUR, CAD,

CHF, AUD,

MXN, THB,

SGD, HKD,

PHP, NZD,

CZK, SAR

NZD

AUD, NZD

USD, GBP,

EUR,CAD,

CHF ,AUD

N/A

USD

USD,GBP,

EUR, CAD,

AUD

USD,GBP,E

URO,AUD

Page | 50

Version | 3.3.0

Payment

Gateway

Secure Pay

Stripe

Total Web

Solutions

Virtual Merchant

WorldPay

Requires

SSL

Payment

Take on Site

Directly

















Supports

Recurring

Payment







Supported

Checkout interfaces

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage,

SinglePage

Supported

Currencies

AUD, GBP,

USD, EUR,

CAD, CHF,

SGD, HKD,

NZD

USD, GBP,

EUR, CAD,

CHF, AUD,

MXN, THB,

SGD, HKD,

PHP, NZD,

CZK, SAR

AUD, CAD,

CHF, EUR,

GBP, HKD,

SAR, USD

USD,CAD FourStage,

ThreeStage,

SinglePage

FourStage,

ThreeStage

USD,GDP,E

URO,CAD,A

UD,SGD,HK

D,NZD

*Due to the size of the Cyber Source provider this is a separate module to install to enable this payment gateway.

Please contract us to request this free module.

Paypal Provider (Website Payments Standard)

In order to use this payment gateway you need to sign up for an account with http://www.paypal.com

, this is the simplest gateway to use. Once the user has clicked checkout they are re-directed to the PayPal website where they enter their payment details and are then returned to your website. No SSL certificate is required for this gateway. This payment method doesn't incur a monthly fee either.

This is the easiest way for your store to accept online payment.

More information about this gateway can be found here, https://merchant.paypal.com/cgi-bin/marketingweb?cmd=_rendercontent&content_ID=merchant/wp_standard

Page | 51

Version | 3.3.0

You can enable Paypal Standard alone with an additional payment gateway like

Authorize.net or FirstData for example. This would allow the customer to checkout with their credit card on your site or they could opt to checkout using their paypal account.

Field

Use PayPal

Sandbox

PayPal ID

Secure ID

PayPal Verification

URL

PayPal Payment

URL

Language

Charset

PayPal button URL

Surcharge

Description

When checked all the requests are routed to the sandbox (test) Paypal server. In a live environment this should be unticked.

The paypal account ID which is receiving the money. This is your Paypal account Username and will look like an email address.

An optional field used to additional transaction security. This is NOT your

Paypal account password. We recommend just leaving this field blank.

Defines the URL used to verify the Paypal response. This should normally not be changed. When the Use PayPal Sandbox is ticked then we ignore this field and use the sandbox url there is no need to change this field when you wish to use the sandbox.

Defines the URL used to send the Paypal payment transaction. This should normally not be changed. When the Use PayPal Sandbox is ticked then we ignore this field and use the sandbox url there is no need to change this field when you wish to use the sandbox.

The language of the login or sign-up page that subscribers see when they click the Subscribe button

The charset used to encode the billing information/login page on the

PayPal site. This should normally be set to UTF8.

The url of the PayPal icon that should be displayed on the checkout page. This url is only used on the four or three step checkout. The single page checkout makes use of its own PayPal icon. The default value for this field is https://www.paypal.com/en_US/i/bnr/horizontal_solution_PP.

gif

Defines an optional fixed amount or percentage of the total order amount to add as a surcharge.

Page | 52

Version | 3.3.0

Field Description

If you do not wish to apply a surcharge leave this field set to 0.

Apply Surcharge As Defines if the surcharge is applied as a percentage or fixed monetary amount.

Page | 53

Version | 3.3.0

Paypal Pro Provider (Website Payments Pro)

In order to use this account gateway you need to sign up for an account with http://www.paypal.com

and enable PayPal Pro as a product on your profile. This gateway lets the user enter their credit card details on your site and they are then sent to PayPal for authorization behind the scenes, with this in mind you need to purchase a SSL certificate and enable SSL from the settings in the “Cart Viper Account” module, see below:

For more information on this gateway please see: https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-pro-overview-outside

To use PayPal Pro you should enter your credentials into the Payments settings page within the Store Admin module.

Accept Amex Cards

When the store is defined in the USA and gateway is Paypal Pro we automatically list

AMEX as a card type. This would be correct for most stores however some stores depending on their business category need to apply to process AMEX cards. This flag determines if you will accept Amex cards, if your store is not in the USA this option is not applicable.

Authorize.Net Provider

In order to use this gateway you need to sign up for an account with http://www.authorize.net/ . Again credit card details are taken on your site and sent to authorize.net for authorization, with that in mind you need to purchase a SSL certificate and enable SSL at checkout, see PayPalProProvider above for more information on this. More information on this gateway can be found at:

Page | 54

Version | 3.3.0

http://welcome.authorize.net/

Cart Viper also supports Authorize.net transactions which trigger Fraud Screening.

This transaction will be accepted by Cart Viper and marked as Awaiting Payment in the Store Admin.

You should then process the payment in the Fraud Screening Centre in Authorize.net, if you elect to accept the payment you will need to manually mark the ordered as paid in the Store Admin.

Points Provider

This gateway uses points instead of a standard currency, the idea behind this gateway is that each user is assigned a number of points and they use this to purchase the products on the site.

When this gateway is chosen offline payment is disabled, also tax / vat and shipping is not charged on any of the orders.

Assigning user points:

Assigning points to user can be completed in 2 ways:

Manually assign points:

You can manually add points to a user account by navigating to:

admin -> user accounts. Click on the user that you want assign points to then click

manage profile to see the profile for the user.

Here you will be greeted with the below screen:

The field cvStorePayPoints determines how many points the user will have to spend in your store, in this case 1000.

Import Users:

The second way to add points to a users account can be done via uploading a CSV file, when you select PaymentPointsProvider the following UI is displayed:

Page | 55

Version | 3.3.0

The advantage of this method is that you can quickly and easily create users and assign points to them. Each user in the CSV file will be created in your DNN site and emailed a randomly generated password.

Note this method can only be used to create users and assign them points, it cannot be used to update the points totals of existing users.

File Format:

The file format is defined as:

FirstName, LastName, EmailAddress, Street Address 1, Street Address 2, City, State, Zip, Country, Phone 1, Balance

Street address 2 is optional.

If no country is included it is defaulted to USA.

If the country is USA the state must be entered as “Nevada” rather than “NV”.

The 1 st line in the CSV must be header data.

An example of a valid file:

FirstName, LastName, EmailAddress, Street Address 1, Street Address 2, City, State, Zip, Country, Phone 1, Balance

Jane, Doe, [email protected]

, Tropicana ave, , Las Vegas, Nevada, 88999,,555 123 456,1000

Viewing points balance:

When a user logs into their account they will be greeted with the tab “my balance”, this informs them of how many points they have.

Offline Payment

Cart Viper allows customers at the point of checkout to pay via offline means i.e. cheque, cash on delivery, invoicing, etc.

Page | 56

Version | 3.3.0

When a user selects this option Cart Viper will not ask the user for any payment information, their order will be placed with a status of “Awaiting Payment”, the store admin and the user will be informed via email the order has been placed and there is an outstanding payment.

Once the user has paid for their order the status can be set to “Paid” via the order management section and you can complete the order process by dispatching the order.

When using the offline payment the stock level of the items in the order will not be decreased until the order is marked as paid, which is a manual process the store order would complete once they have received the offline payment.

However some stores which sell one off items might need to decrease the stock as soon as the order is placed since the item is unique. This is possible by ticking the option Decrease Stock Straight Away which will decrease the stock when the order is still pending. If the order then is marked as cancelled and never completed the stock decrease will be reversed to return the stock level to the previous value.

Using the Role Required for Offline Checkout it is possible to define the role that a user must be a member in order to use the offline checkout.

If not values are checked then all users will be able to see the offline payment method during the checkout.

A user only needs to belong to a single selected role in order to be able to see the offline checkout option.

Overdue Orders

Along with defining if your store accepts offline payment it is also possible to optionally enter a number of days a user has to make payment before the payment for their order is overdue.

It is possible to enter different payment terms for post paid or standard offline payment. The relevant payment terms are displayed at the point of checkout when a user chooses to pay offline:

In the store admin and customer orders management section it is possible to view orders that are overdue by selecting the relevant filter, orders that are overdue are marked with a red warning icon:

Page | 57

Version | 3.3.0

Note this option is only available if a number has been entered for the payment terms.

Role Required For Offline Payment

It is possible to only allow users within a given DNN role to pay via offline means, that would mean if they did not have this role this option would not be available to them at the point of checkout.

Allowing Users To Postpay

Each user will have the above property “CanPostPay”, by default this value is

“False”. If this were set to “True” and the user checked out whilst logged via the offline option their order will be marked as “PostPaid”, this would indicate it is ok to ship the order before payment has been collected.

This feature could be used to only allow trusted customers pay via offline means when they have received their goods.

Moderating Offline Orders

It is possible to moderate offline orders by selecting the option Moderate ALL Orders; by selecting this option all offline orders will require store moderation before they are formally accepted by the store.

When a user places an order that requires moderation they are sent an email informing them their order requires moderation along with the store admin.

The store admin can then login and moderate the order, it is possible to add, remove and update the quantity of products in the order or change the shipping amount and shipping method by selecting the relevant options from the order management section:

Page | 58

Version | 3.3.0

Until an order has been moderated it is not possible to change the status of the order, once the order has been moderated and the “save” button clicked the customer is then sent an email confirming their order details, within this email there is a link that will when clicked allow the user to pay for the order online.

Note once an order has been moderated it is not possible to put the same order into

“awaiting moderation”.

First Data Provider

This is a USD currency provider which allows you to take credit card payment directly on your store.

In a production environment you must have a SSL certificate installed to secure the credit card details collected on your portal.

For more information please visit the First Data website http://www.firstdata.com

The First Data gateway uses X509 certificates to secure communications with the gateway server, you will need to ensure that your web server has the WSE 3.0 extensions installed http://goo.gl/L40CB

Additionally you should follow the instructions in the First Data deployment guide which explains how to install the client SSL in the machine certificate store.

Page | 59

Version | 3.3.0

The default Web Service URL in the provider is for the testing system, when you are ready to collect live payments you should update this URL with the live gateway

URL. First Data will supply you with the URL.

You should copy the PEM file into the App Data folder of your web server, this is a safe place to deploy this file. DO NOT copy the PEM file into the portal home directory, this is not safe.

Enter the full path to the PEM file into the Certificate Path field.

First Data will also supply you with a username and password which you must enter into the provider fields.

MultiSafePay Provider

Cart Viper provides built-in support for Multi Safe Pay as a payment gateway

( http://www.multisafepay.com/ ), this payment gateway is only available when the store currency is Euros.

Field

Use Test Mode

Description

When checked the store is in test for mode transactions. This should be unchecked after testing and when the site is live.

Page | 60

Version | 3.3.0

Field

Account ID

Site ID

Site Code

API Url

Notification

Message

Include Return Link

Description

Enter your MultiSafePay Account ID into this field

Enter the SiteID as issued by MultiSafePay

Enter the Site Code as issued by MultiSafePay

This field defines the Url used to process the transaction request. By default this is the test Url of https://testapi.multisafepay.com/ewx/ the live

Url is https://api.multisafepay.com/ewx/

Once the transaction completes the browse can be shown a message on the confirmation page. Use this field to enter the message to be displayed.

On the confirmation page after the transaction is completed the user can be shown a link which allows them to return to the store. Checking this box will display this link.

When using MultiSafePay the portal doesn't need to have a SSL certificate installed since the user is taken to the MultiSafePay in order to collect the payment details.

Innovative Gateway/Merchant

Cart Viper supports using Innovative Gateway which is part of Inuit. To use this gateway you first need to visit the Innovative Gateway site

( http://www.innovativegateway.com/d_reference.aspx

) and download the latest version of Windows API at the time of writing this is version 1.0.0.5

Once installed selected the gateway InnovativeMerchantProvider on the payment page and then enter the username and password for you account.

Page | 61

Version | 3.3.0

Prepaid Payment Provider

Cart Viper also supports a prepaid payment provider, this is different to the Points provider in that rather than an internal “points” value this provider uses a monetary value for the prepaid credits that a user has on their account.

Users would purchase credits using another payment gateway you have enabled on the store. For example, using Paypal. The credits would be recorded against the user's account and would be used to purchase items in the store.

For example each authenticated user will have a “My Prepaid Balance” section in their account page, from here they can choose an amount of points that they will then purchase:

Once they have purchased prepaid credits they will then be able to use this balance to pay for items within the store.

Note if the user does not have enough prepaid credits to purchase an item the prepaid option will be hidden at checkout.

If a user chooses to purchase with their prepaid balance the total payment will be deducted from the current credit balance:

Page | 62

Version | 3.3.0

Prepaid payment can NOT be used to make a partial payment for an order; the order

MUST either be paid for in full with prepaid credit or using another payment method.

Prepaid balances can be manually adjusted for a user by editing the below property of their DNN profile, note amounts should be entered in dollars and pence, for example the below amount would be outputted as $132.56.

NOTE only the administrator can see this profile field, the user is unable to change or see this field on their profile.

Buckaroo Payment Provider

Cart Viper also supports the Buckaroo payment provider, no SSL certificate is required for this gateway, more information can be found at http://www.buckaroo.nl/

Mollie Payment Provider

In order to use this gateway you need to sign up for an account with

Mollie http://www.mollie.nl/support/documentatie/betaaldiensten/ideal/en/ , no SSL certificate is required for this gateway.

Paypal Pay Flow Payment Provider

In order to use this gateway you need to sign up for an account with Paypal https://merchant.paypal.com/us/cgi-bin/?cmd=_rendercontent&content_ID=merchant/payment_gateway no SSL certificate is required for this gateway.

Page | 63

Version | 3.3.0

Ogone Payment Provider

In order to user this gateway you need to sign up for an account at http://www.ogone.com

, an SSL certificate is not required for this gateway.

In order to configure this gateway there are a number of steps that need to be completed, you need to login to your Ogone merchant account:

1) You need to set the “SHA-IN Pass phrase”, this is defined in the “Merchants technical information” under the tab “Data and Origin Verification”:

2) You need to select “I want to receive transaction feedback parameters on the redirection URL” - this is defined in the “Merchants technical information” under the tab “transaction feedback”: You need to set the SHA-OUT Pass phrase, this is defined in the “merchant technical information” under the tab

“transaction feedback”

3) In the “global security parameters” tab ensure “each parameter followed by pass phrase” is selected:

Page | 64

Version | 3.3.0

4) Once you have configured these parameters you can then enter them into the relevant section in Cart Viper when configuring the Ogone payment provider.

CyberSource Payment Provider

This gateway allows you to collect payment directly on your site using the Cyber

Source payment gateway.

The Cyber Source gateway makes use of a P12 certificate to authenticate the remote call to the payment gateway server.

An SSL certificate is required for the store if you are using this payment provider.

Field

Merchant ID

Certificate Location

Authorization Only

Use Test

Environment

Create Debug Log

Description

Enter the Merchant ID which has been assigned to you by Cyber Source.

The folder name that contains the P12 certificate for the payment service. This should just be the folder name do not included the filename in this field.

If checked the card details will only be authorized, payment will NOT be taken - this will need to be completed by going to the Cyber Source back office gateway.

If checked we will use the demo environment rather than Cyber Sources production environment.

If checked we will create debug logs for the transactions if the folder that contains the P12 certificates.

Further details about how to deploy the required Cyber Source libraries to your server can be located in this document on chapter 2 http://apps.cybersource.com/library/documentation/dev_guides/Simple_Order_API_C lient_NET_2/20080103_NET_2_Simple_Order_Client.pdf

Page | 65

Version | 3.3.0

PayWay Provider

This gateway allows you to collect payment directly on your site using the Payway payment https://www.payway.com.au/core/AboutView . To use this gateway an SSL certificate is required.

Field

Username

Password

Merchant ID

Certificate location

Use sandbox

Description

Enter the user name you were given when you signed up for your account.

Enter the password you were given when you signed up for your account

Enter the Merchant ID you were given when you signed up for your account

The location that the certificate file is located on your server, this should be the full file path: e.g.:

M:\dnnCartViper\App_Data\ccapi.q0

For security we recommend placing this in the app_data folder of your

DNN site.

If selected we will use the sandbox rather than the live Payway gateway.

Page | 66

Version | 3.3.0

QBMS Payment Gateway

Cart Viper supports using QBMS which is part of Inuit. This gateway uses the QBMS

SDK simple model to integrate into Cart Viper.

Follow the steps 1 to 4 to create the test or live accounts required for this payment gateway.

https://ipp.developer.intuit.com/0085_QuickBooks_Windows_SDK/qbms/0030_Get_

Set_Up

Once installed selected the gateway QBMSProvider on the payment page.

Field

URL

Application Login

Description

The URL where the request should be sent, in test mode this should be https://merchantaccount.ptc.quickbooks.com/j/AppGateway

When using the payment gateway you should use this URL https://merchantaccount.quickbooks.com/j/AppGateway

The generated app login ID created by Intuit when you register your application.

The connection ticket generated on the intuit website.

Connection Ticket

The Application Login and Connection Ticket are created when you follow the steps in the URL above.

Barclays EPDQ Payment Gateway

In order to use this gateway you need to sign up for a Barclay's merchant account: http://www.barclaycard.co.uk/business/accepting-payments/epdq-ecomm/

As this is the same system that Ogone use but branded under Barclays please follow the steps outlined in the “Ogone Payment provider” when configuring your Barclay's merchant account and entering the details into Cart Viper.

Virtual Merchant Payment Gateway

In order to use this gateway you need to sign up for a merchant account with Virtual

Merchant: https://www.myvirtualmerchant.com/VirtualMerchant/

Page | 67

Version | 3.3.0

An SSL certificate is required when using this gateway as payment is taken directly on your site.

Eway Payment Gateway

In order to use this gateway you need to sign up for a merchant account with Eway: http://www.eway.com.au/

As SSL certificate is required when using this gateway as payment is taken directly on your site.

WorldPay Payment Gateway

In order to use this gateway you need to sign up for a merchant account with

WorldPay: http://www.worldpay.com/

An SSL certificate is not required for this gateway as payment is not taken directly on the site.

Rabo Kassa Omni Payment Gateway

In order to use this gateway you need to sign up for a merchant account with: http://www.rabobank.nl/particulieren/

An SSL certificate is not required for this gateway as payment is not taken directly on the site.

Sage Pay Forms Payment Gateway

In order to use this gateway you need to sign up for a merchant account with Sage

Pay: http://www.sagepay.com/sage-pay-form-integration

An SSL certificate is not required for this gateway as payment is not taken directly on the site.

First Data Connect Payment Gateway

In order to use this gateway you need to sign up for a merchant account with First

Data: https://www.firstdata.com/en_gb/connect.html

An SSL certificate is not required for this gateway as payment is not taken directly on the site.

Page | 68

Version | 3.3.0

Tax & Vat

This section allows you to define the tax or settings that will be applied to your store.

Cart Viper will automatically determine if VAT or tax should be applied to your store based on the store location information that is defined in the store admin section.

The store administrator can define if the tax for an order is calculated using either the billing or shipping address. By default the billing address is used.

The store admin can also define to only apply tax to orders which have either a billing or shipping address in the same country as the store. This allows you to not charge tax/vat on any non-domestic orders.

In addition to the manual tax configuration here Cart Viper also supports using an external service to determine the tax amount due for an order. To read more about this

feature please see page 72.

Tax

If your store is located within the USA you will be able to configure your store for tax with the following options, note if you store is based in a non- EU country you will only have the option to select standard or no tax rate.

Furthermore you can select certain products to be “tax free” regardless of the settings that are entered below, see product edit for more information.

Home State Only:

Using the example below, we would charge all users that have their billing address in our home state (Nevada) a tax rate of 25%, if they were outside this state or the USA we would not charge tax.

Tax Tables

Page | 69

Version | 3.3.0

By selecting tax tables we can configure individual tax rates based on the state the buyers billing address is located in, if the buyer’s state is not in a state you have defined a tax rate for or outside the USA they will not be charged tax.

Standard Rate

By selecting standard rate all users will be charged the standard rate regardless of their state, in the below example 15%.

New York County Tax

By selecting this tax option only users with a billing address located in the state of

New York will be eligible for tax.

This tax mode works by charging a standard rate for the state of New York in the below example 8%, then adding the individual county tax to that.

In our example below if a customer was located in the state of Albany they would be charged 8% + 20% = 28% tax.

Page | 70

Version | 3.3.0

If a tax rate has not been defined for a county that the customer selects they will just be charged the standard tax rate for New York, in our example 8%.

No Tax

By selecting this option no tax will be charged on products within the store.

Zip2Tax

This tax mode allows you to use the Zip2Tax service for the US. This is a paid for service which provides you with CSV data that defines the tax to apply based on the zip code of the customer.

Further information on the pricing and service can be found at http://www.zip2tax.com/

In addition to the tax rate for the zip code this data also defines if the shipping charge should attract tax based on the zip code.

Canadian GST

If your store has an address within Canada as defined in the Store Admin – Store Info page then the following tax options will be available.



Tax Tables



Standard Rate

Page | 71

Version | 3.3.0



No Tax

If you select Tax Tables then you are able to define a different rate for each Canadian province.

VAT

If your store is located within the EU you will have the option to charge VAT if the users billing address is also located within the EU.

If, however, the billing address is outside the EU no VAT will be charged on the user’s cart.

Using the example below you can define the different rates of VAT for each band, i.e.

zero VAT rate would not charge vat, reduced vat rate as 5% and standard vat rate at

20%.

Products are assigned to each individual VAT rate from the product edit page, see products section for more information.

The Mini Cart and Cart will display the prices exc of VAT, however it is possible to set both of these modules to display the prices inc VAT.

On the My Account > Settings module page you can check the Display Prices inc

VAT/GST option.

Vat Number

By selecting from the “my account” settings to allow a customer to enter a VAT number we will then check if they enter a VAT number and are inside the EU but not in the UK we will not charge them VAT. Note we will not validate that the VAT number is valid for the given country.

Shipping Tax & VAT

Tax or VAT can also be optionally applied to the shipping cost, to enable this select the checkbox below, when selecting your shipping provider.

External Tax Lookup Service

Page | 72

Version | 3.3.0

External Tax Providers

Cart Viper now supports using an external tax service to determine the amount of tax due on an order. This is a new feature added into version 1.6.

At the moment only a CyberSource Tax Provider is supported however if you have a third party service you would like to see implemented please contract us.

The call the web service only takes place on the checkout page. If the call to the remote server fails then Cart Viper will resort to the internal tax calculations to determine the amount. If this happens then we write an event to the DNN log to record this.

During the time the customer is browsing the store and cart we simple use the internal tax tables to determine the tax amount. This will reduce the number of calls to the external service and in turn save you money due to lowered use.

CyberSource Tax Provider

To use the CyberSource Tax Provider please request this free add-on from us, this isn't bundled with the standard product due to the size of the install.

The CyberSource Tax Provider can be confirmed on the Store Admin > Tax page.

Field

Certificate Folder

Certificate Name

Use Test Service

Merchant ID

Tax Nexus

Enable Logging

Description

Path to the folder containing the p12 certificates used during the remote call to CyberSource. This should only be the folder that contains the certificate do not include the filename.

Enter the filename and extension for the test certificate.

Defines if the service should call the live or test service from

CyberSource.

MerchantID as supplied by CyberSource

List of states that the company has a nexus. Multiple states can be separated with a space. The states should be defined by their two letter code.

When checked the Cybersource API will write a log to the same location as the Certificate Folder containing debug information for the remote web service call. In a production environment this should always be turned off.

Zip2Tax

We also support Zip2Tax as discussed on page 69 of the manual.

Shipping Options

Cart Viper comes complete with multiple shipping providers which can select the shipping provider that best fits your business model.

Page | 73

Version | 3.3.0

In conjunction with the shipping providers it is possible to configure “In Store

Pickup”, “Free Shipping” and “Free Shipping by Cart Subtotal”. These 3 options can be applied alongside any of the shipping providers to create complex shipping rules.

In addition to supporting the country of United States Cart Viper also supports the following which maybe of use to US based stores.

United States – Covers the whole of the US.

United States (Alaska) – Limits the shipping options to just AK.

United States (Hawaii) – Limits the shipping options to just HI.

United States (Lower 48) – Limits the shipping options to the Contiguous United

States.

Using these options allows you to define a different shipping option/cost for AK and

HI for example.

Customer Selected Shipping Option

By selecting “Allow customer to select delivery datetime” you will output a date and time picker that allows the customer to select when they would like their items to be delivered. This does not affect the cost of the shipping however it is recorded against the order for reference.

Furthermore it is possible to disable specific dates that the customer cannot select from e.g. weekends, public holidays etc. This can be configured by selecting “specify restrictive shipping dates” and entering the dates as necessary:

Below is an example of the UI that is presented to the customer when this option is enabled:

Page | 74

Version | 3.3.0

Multiple Shipping Providers

It is possible to select multiple shipping providers for example FedEx, UPS, USPS and the default shipping provider this will then allow the customer to select which shipping provider they would like to use when they select their shipping options. Note this option is only supported if the “SinglePageCheckout” is selected as the checkout style.

Below is a screen shot of the UI that is presented to the customer at the point of checkout:

Restrict Shipping By US State

It is also possible to define a list of states which the store will ship to. If a customer's shipping state is not in the list then they will be unable to checkout.

To use this feature enter a list of the state codes separated by “;” to define which states you are going to ship orders to.

E.g. NY;LA;NJ;IL;IN;KY

Restrict Shipping By Zip / Postal Code

It is also possible to restrict shipping by zipcode, by entering zipcodes separated by

“;” e.g. 891;100;5600

Page | 75

Version | 3.3.0

It is also possible to enter a partial zipcode, meaning that if we match this partial zipcode the customer will not be able to checkout. For example if you enter 891 as a restricted zipcode a customer than entered 89109, 89102 etc will not be able to checkout.

In Store Pickup

If selected alongside any other shipping options the user will be able to select “in store pickup”, this will mean the store will not ship the item and no shipping will be charged to the user. At the point of checkout they will be presented with the below

UI:

Free Shipping

It is also possible to configure free shipping based on the country of the shipping address. If this is configured the users shipping address is in the matrix for free shipping then shipping will NOT be charged regardless of the weight or total of the user’s cart:

In the above example we would not charge shipping if the customers shipping address was in the UK or France, anywhere else the standard shipping rules would be applied.

Free Shipping by Cart Subtotal

It is also possible to offer free shipping if the customers subtotal of the cart meets the predefined limit and their shipping address is located in the selected country:

Page | 76

Version | 3.3.0

In the example above a customer would be entitled to free shipping if their subtotal was greater than 25.00 and their shipping was in Brazil or their subtotal was greater than 40.00 and their shipping address was in the Ukraine.

If the customer did not meet the criteria for free shipping by cart subtotal then the standard shipping rules would be applied.

Default Shipping Provider

The default shipping providers offers 5 different shipping configurations

1. Shipping based on cart weight and shipping country matrix, it is also possible to define multiple options for each country and weight band to offer different shipping options (ground, 48hr, next day etc).

2. Shipping based on cart subtotal (ex VAT or tax) and shipping country matrix, it is also possible to define multiple options for each country and weight band to offer different shipping options (ground, 48hr, next day etc).

3. Shipping based on number of items in the cart and shipping country matrix, it is also possible to define multiple options for each country and weight band to offer different shipping options (ground, 48hr, next day etc).

4. Shipping by DNN role.

5. Shipping by postcode.

Postcode Shipping Bands

It is possible to create shipping bands based on zipcodes, so when a customer attempts to checkout we will first check to see if their postcode matches any postcode shipping bands that we have and if so charge them that rate. If not we will then check the country shipping bands.

This feature is useful if you wanted to charge higher rates for zipcodes that are located further away from your store.

The below UI shows the format that you would enter your zipcodes in:

Page | 77

Version | 3.3.0

Country Shipping bands

It is possible to create shipping band rates based on the total weight of the products in the users cart or the subtotal of the users cart, the country that the items will be shipped to and the priority that the user selects. Note the cart weight is calculated from the product weight which is set in the products section of the store administration.

By entering different bands for different priorities you can build up complex shipping rules based on the speed of delivery e.g. next day, saver, super saver, etc based on the precise weight or the subtotal of the products in the user’s cart.

Note shipping is not charged on products that are marked as “free shipping”, have a digital download or are a donation.

It is also possible to specify shipping by a DNN role, so as well as meeting the weight or subtotal criteria they must also be in a specific DNN role.

Using the above settings as an example would mean that if the sum total of the weight in the users cart was between 0 and 100.00 and the shipping address was in the USA the shipping cost would be $2.00 if they selected “Super Saver” or $20.00 if they selected “Next Day”, and so forth.

The only shipping band that requires the user be in a specific DNN role is the “Valued

Customer” band, to qualify for this band the customer must be shipping to the United

States and be in the DNN role “Purchaser”.

In order to indicate that the maximum weight had no upper limit enter 9999, likewise if you wished to create a flat shipping rate for a country, enter the following:

If a shipping rate has not been configured that matches the users cart weight and country location they will not be able to checkout and will receive the following error message.

Page | 78

Version | 3.3.0

However it is possible to define a ROW shipping option, meaning that if a shipping rate has not been defined for a given country Cart viper will just present the customer with the ROW shipping band, provided they meet the criteria of the band. To implement this select “ROW” as the country for this band, this is useful if your store has standard shipping costs for different countries and you do not want to enter a band for every country.

In all the examples above the cost of each shipping band is determined by the value in

“rate”, however it is possible to allow a shipping band calculate the shipping cost as a

% of the users subtotal by putting a tick in “Cost as % of Subtotal”.

In the above example for Australia if a tick was placed in “Cost as % of Subtotal” the cost would be 40% of the users subtotal. It is possible to have a combination of bands that are calculated as flat rates or as % of the users subtotal.

FedEx Shipping Provider

By selecting the FedEx shipping provider you are enabling Cart Viper to calculate the cost of shipping in real time by querying the FedEx API based on the weight of the items in the users cart, their shipping address and the stores pickup location.

When FedEx is selected as the shipping provider you are greeted with the below screen:

Page | 79

Version | 3.3.0

In order to use this shipping provider you need to sign up for an account with FedEx at: http://fedex.com/us/developer/ , once you have completed this you will be sent an email with your FedEx account number, meter number, key and password.

Until your account has been put into “production” by FedEx you need to have “Use

Test Mode” selected. This informs Cart Viper to use the FedEx sandbox API rather than their live API.

The default package sizes and weights defined above will be used in the event a customer has a product in their cart that has no defined unit of weight or length. The units are defined in the store admin settings.

The shipping address above should be the address that FedEx will collect the items from you, this address is sent to FedEx to calculate the cost of shipping from.

It is also possible to select which of the shipping methods you would like to support as well as a % markup to the prices that are returned.

When FedEx is the selected shipping provider at the point of checkout Cart Viper will query the API for the available shipping rates based on the details entered, if any rates are available the user will be able to select the rate they desire, see below:

UPS Shipping Provider

By selecting the UPS shipping provider you are enabling Cart Viper to calculate the cost of shipping in real time by querying the UPS API based on the weight of the items in the users cart, their shipping address and the stores pickup location.

Page | 80

Version | 3.3.0

When UPS is selected as the shipping provider you are greeted with the below screen:

In order to use this shipping provider you need to sign up for an account with UPS at: https://www.ups.com/upsdeveloperkit?loc=en_US , once you have completed this you will be sent a username, password and access license number you need to query the

API.

The default package sizes and weights defined above will be used in the event a customer has a product in their cart that has no defined unit of weight or length.

The shipping address above should be the address that UPS will collect the items from, this address is sent to UPS to calculate the cost of shipping from.

It is also possible to select which of the shipping methods you would like to support as well as a % markup to the prices that are returned.

When UPS is the selected shipping provider at the point of checkout Cart Viper will query the API for the cost of shipping and the result will then be presented to the user where they can select the class of postage they wish:

Page | 81

Version | 3.3.0

USPS Shipping Provider

By selecting the USPS shipping provider you are enabling Cart Viper to calculate the cost of shipping in real time by querying the United States postal service API based on the weight of the items in the users cart, their shipping address and the stores pickup location.

When USPS is selected as the shipping provider you are greeted with the below screen:

In order to use this shipping provider you need to sign up for an account with USPS at: https://secure.shippingapis.com/registration/ , once you have completed this you will be sent an email with your username to access their API.

The default package sizes and weights defined above will be used in the event a customer has a product in their cart that has no defined unit of weight or length. It is worth noting the maximum weight per shipment is 70lbs.

It is also possible to select which of the shipping methods you would like to support as well as a % markup to the prices that are returned.

The shipping address above should be the address that USPS will collect the items from you, this address is sent to USPS to calculate the cost of shipping from. Note the

Page | 82

Version | 3.3.0

shipping address that items are collected from MUST be based in the USA; however

USPS can still be used to ship items internationally.

When USPS is the selected shipping provider at the point of checkout Cart Viper will query the API for the cost of shipping and the result will then be presented to the user where they can select the class of postage they wish:

Auditing

Cart Viper has the ability to optionally enable audit logging of changes made to the products and categories within the store.

Any changes made by a user are recorded to an audit log; the store admin is able to view the audit log to see all changes made.

To enable auditing the store admin needs to tick Enable Audit Log which is located in

Store Admin > Store Info > General Settings

When auditing is enabled an extra menu option will be available to access the audit logs.

When auditing is turned on all the changes made to the product or category objects will be recorded. The audit viewer is able to filter the audit log

If the current user is a host user then an option in the lower left corner will allow them to delete all the audit log events from the database. This is only available to host users.

Coupons

By creating coupons you can create promotions or give specific users a discount at the point of checkout:

There are 3 types of coupons that can be created:

Percentage discount coupon – discount the defined % from the users subtotal.

Monetary discount coupon – discount a fixed amount from the users subtotal.

Free shipping coupon – entitle the user to free shipping.

Page | 83

Version | 3.3.0

Field

Coupon Code

Description

Minimum Subtotal

Discount Amount

Can Use Multiple

Times

Gift Certificates

Gift certificates work in a similar way in the fact they can be distributed to customers in order to receive a discount on their purchases. The key difference is that gift certificates can be segregated into groups and the generation of the gift certificates can be automated.

With this in mind if your store is going to distribute thousands of codes gift certificates would be used instead of coupons to make the process less labour intensive.

The 1 st step is to create a “gift certificate group” – each group can have an unlimited number of gift certificates assigned to it based on the rules you define for that group:

Page | 86

Version | 3.3.0

Field

Group Name

No: certificates to make

Voucher Prefix

Voucher Length

Discount Amount

Discount As Monetary

Start Date

Required Description

True

False

True

The name of the group, this value is just used internally as a reference to the name of the group.

If a number is entered Cart Viper will generate that number of gift certificates for this group, an unlimited number can be assigned to this group, however only

1000 can be generated each time.

The text that will be prefixed to the start of the gift voucher number

The number of random alphanumeric characters that will be appended to the voucher prefix to create the gift certificate number.

True

False

True

The amount to discount will either be % or monetary amount.

If checked the discount amount will be discounted as a monetary amount from the users subtotal otherwise it will be discounted as a % of the users subtotal.

The date that the gift certificates in this group will be active.

End Date

Product Model

Number

Notes

True

False

True

The date that the gift certificates in this group will expire.

If a model number is entered here the certificate will only be able to be used if the user has this product in their cart.

Internal description of the group.

Page | 87

Version | 3.3.0

Is Active False If not selected the group will not be active and all the gift certificates in this group will not be valid.

Once a group has been created and gift certificates have been generated it is then possible to view the gift certificates for this group by selecting the relevant option from the gift certificate group section:

As the above UI shows it is possible to filter your gift certificates by enabled, disabled, used and unused. Once a gift certificate has been used it is not possible for a customer to use it again, also the order that it was used for is summarized.

Furthermore it is also possible to download the selected gift certificates as a .CSV file.

Gift certificates are applied by a customer to their order in the same fashion as a coupon, so for example a user would enter “CV2EER”, at the point of checkout to receive the discount we defined.

Promotions

This section allows you to create store wide or category wide promotions within your store. The difference between a promotion and a discount that can be applied via a coupon is that promotions are available to all customers and can be applied to every product in the store or products in a specific category.

Store Wide Promotions

Page | 88

Version | 3.3.0

It is possible to create a store wide promotion; this would give every product within the store the specified discount. So in our example above we would give every product in the store a 10% discount between 1 st

May 2011 – 31 st

May 2011.

Note the discount percentage is taken from the unit price of the item, if the product is also part of a discount bundle the price will also be deducted the discount amount of the discount bundle as well. Furthermore if a category specific promotion is also specified the discount percents will be summed together and the total discount percentage taken of the unit price.

For example if there was a store wide promotion offering 5% discount and a product was in a category that had a promotion of 10%, the unit price would be deducted 15%.

Category Specific Promotions

It is possible to create category specific promotions within the store; this would mean every product that is in the assigned category would receive the specific discount during the promotion start and end dates.

In the example above we are offering a 5% discount for every product in the category

“Bears” during 2 nd

May 2011 to 24 th

May 2011.

It is only possible to create 1 promotion per category, but it is possible to create a promotion for every category in the store.

Note the discount percentage is taken from the unit price of the item, if the product is also part of a discount bundle the price will be deducted from the discount bundle as well. Furthermore if a product is in multiple categories where they have been given a promotion, the discount percents will be summed together and the total discount percentage taken of the unit price.

For example if a product was assigned to category A and category B and each had a promotion of 10%, the product would be discounted 20% from the unit price.

Page | 89

Version | 3.3.0

All the category promotion are listed in the below UI along with their current status, from the below UI it is possible to edit or delete a category promotion as per your needs.

Product Discount Bundles

It is possible to create “product discount bundles” where customers can receive a discount if they purchase 2 or more products at the same time. In order to configure this click “product discount bundles” from the product admin section.

You are then presented with the option to add a new bundle or edit an existing bundle:

From the above screen shot you can see we are going to create a bundle called

“Stephen King Special” that is going to offer a saving off 10%. Note the discount amount is taken of each item in the bundle. Once we have saved the bundle we can then add products to it:

As you type the model number Cart Viper will auto suggest matching model numbers making entering the products very simple. Once the products have been added to the bundle, the offer will then display on the product details page:

Page | 90

Version | 3.3.0

There is no limit to the number of items that can be added to a product discount bundle, or the number of different bundles that a product can be added to. The layout for the product discount bundles, is controlled by the template

ProductBundlesTemplate.htm, more information can be found in the templates section.

Mix and Match Discounts

Mix and Match discounts allows you to apply a discount based on the quantity of items purchased from a category or selection of categories. The discount can be a fixed amount or percentage of the qualifying items subtotal. It’s also possible to include free shipping with the discount band.

For example it is possible to define discounts like, purchase 3 items from the category

"Office Desks" to get 10% of the those items in the category.

It's also possible to define multiple bands for example

Any 6 items from Xbox360 Games 10%

Any 12 Items from Xbox360 Games 15% + Free Shipping

Any 18 Items from Xbox360 Games 20% + Free Shipping

Note when setting up this type of discount on quantity the discount is applied cumulatively, therefore the Xbox Games example would be setup as three discounts

Qty required 6, percentage discount 10%

Qty required 12, percentage discount 5% + Free Shipping

Qty required 18. percentage discount 5%

Since these are applied together 12 - 17 items from the category would attract a discount of 10% + 5% = 15% and the free shipping.

Page | 91

Version | 3.3.0

Field

Discount Name

Description

Role Required

Discount Amount

Quantity Required

Has Free Shipping

Description

Name of the mix and match discount, this is used only for the store admin's reference.

Optional description for the discount, again this is only used for the store admin's reference.

Defines the optional role that the user needs to be a member of to get the discount.

Defines the amount of discount to apply, this can be a fixed amount or percentage discount.

Defines the number of units needed to be purchased to get the mix and match discount.

When checked this band and any band above this one will get free domestic shipping on the order.

By domestic shipping we mean the shipping addresses must be the same as the store address as defined in the store info page.

Page | 92

Version | 3.3.0

Field

Enabled

Minimum Spend Free Product

Cart Viper also allows you to give away a free product if the customer's cart subtotal is greater than a value you define. The subtotal will not take into account any shipping or tax amounts in determining if the customer has reached the minimum spend level for the free product.

The store administrator is able to define as many “minimum spend free product” bands as required. The system will work out the highest spending band that the cart qualifies for. Only a single product will be added and the quantity of that product will be one.

To create a free product simply enter the minimum spend needed to qualify for the item. Then start typing the name of the product in the Free Product field, this will then display a list of matching product, simply select the product then click Save.

Page | 93

Version | 3.3.0

Orders

The store admin provides a convenient method to view the orders that have been placed on your store. You can choose to filter the orders by order number, order status, predictive search by the customer name, date range or view all orders for the last 30 days.

Be default we display the last 30 days of orders on the page.

Once you have found your orders you can then optionally choose to download them in

CSV format. This feature is useful if you already have order processing software and would like to easily import orders from your Cart Viper store.

You also have the option of selecting Details this allows you to see the full details of the order and allows you to modify the status of the order. When you modify the status of the order you have the option to notify the user and include a message to them via email, as shown below. Furthermore you can also download the order in

PDF format.

When logged in as a store admin there is also the option to edit the shipping and billing address that the customer entered by clicking on the “edit icon” as per the below screen shot.

Note the customer is NOT able to edit their own address information after the order has been placed.

Page | 94

Version | 3.3.0

The store admin is able to record a Shipping Tracking Number and a Shipping Date to indicate when the item was shipped. This information will then be available to the customer when they view the order details in their my account page.

When viewing the order details page the store admin is able to view the audit log for that order. This contains data about the order payment and internal values of the system at the time of the order. The audit feature is useful to track down issues with failed payments for example.

It is possible to prefix orders with a code based on the user account which placed the order. The logic behind this feature is so you can have sales reps enter orders for their customers.

To enable this feature you need to turn on Check for User Order Prefix in the Account

Module settings (see page 13). Once this has been enabled you simple need to enter

the prefix for the user in their profile. The field which holds the prefix is called

cvStoreOrderPrefix.

Only the site administrator is able to see this field on the user's profile page.

Order Status

An order will have an order status which helps the store administrator manage and process orders as they are generated.

When an order is placed and paid using for online the order will be marked as Paid.

This means the store admin can start processing that order.

When an order is placed using offline payment it will be marked as Awaiting Payment the store admin should wait until the money is received before manually changing the status to Paid then fulfil the order as per a regular order.

A complete list of all the order statuses is displayed in the table below.

Field

Awaiting Payment

Description

Used by Cart Viper to inform the store admin that order was paid using an offline payment method and that you are waiting on receiving the payment.

The store admin should update this to paid once the money has been

Page | 95

Version | 3.3.0

Field

Awaiting Stock

Cancelled

Packed

Paid

Partial Shipped

Post Paid

Description

collected.

Status that can be used by the store admin to mark an order that is on hold until new stock arrives.

Status that the store admin should assign to an order which has been cancelled.

Status to indicate the order has been assembled and packed ready for dispatch.

Used by Cart Viper to indicate the order placed has been paid using some online payment method. Orders with this status are ready to be fulfilled.

Status that the store admin could assign to an order which has been partially shipped while waiting for other out of stock items.

This status would be assigned to an order by Cart Viper when the customer has checked out with offline payment and selected the post pay option. Please see the offline gateway for more details about this

status on page 56.

This status is not commonly used.

Processing

Shipped

Status used internally by Cart Viper

Status to indicate the order has been sent to the customer.

Awaiting Moderation An order has been placed which needs to be moderated before it is officially accepting in the store. See the Quote and Customer moderation section for further information.

As the store admin you are free to use the statuses in the table to update the order so you are aware of each orders status. You are free to use which statuses you prefer, for example you might just go from a Paid order status to Shipped (skipping Packing).

The store administrator can permanently delete any order which marked as cancelled to remove it from the order list completely.

Batch Print Orders

Cart Viper has the ability to batch print a range of order details for a give date range.

This allows you to print out all your daily/weekly orders in a single click.

Page | 96

Version | 3.3.0

When an order is printed out using the batch printing feature a flag is set so that order will not appear in another batch of orders. You are able to override this by checking

Include already printed to have any orders which match the search criteria included in the print outs.

When printing orders each order is printed in a separate page. We have currently created a template that is suitable for customers using A4 Double Label (see below for layout details) paper. If you have another template you would like to see included in

Cart Viper please contact us.

Quote Feature

Cart Viper has the ability to offer a quote feature; this allows orders over a given threshold to be submitted to the store owner to see if the customer can get a better price.

This feature is turned off by default. To enable see the quote settings in the Store Info

page 34

From the customers prospective the store operates the same as normal with the quote feature enabled, they are able to assemble a cart of products they would like to

Page | 97

Version | 3.3.0

purchase.

On the cart page, if the cart sub total is greater than the quote threshold they will be presented with an option to request a quote.

If the cart is below the quote threshold the Request a Quote button is not visible.

Clicking the Request a Quote option displays a similar page to the standard checkout to collect additionally data for the order (shipping address, shipping options etc).

Note in the demo we are using a single page checkout

Once the quotes have been placed both the store admin and customer will receive an email informing them of the pending quote.

The template used for the email message is defined in the Store Admin > Store Info >

Store Email Templates the setting is called Order Confirm Awaiting Moderation. By default the file is OrderAwaitingModerationEmail.htm

The other fields in the page relate to the templates sent once the quote have been moderated.

When the quotes have been created the customer and store admin will see this listed in the orders section differently from regular orders. By default we apply a bold style to the row and also display the quote status for the item.

At this stage the customer has completed the process and needs to wait until the store admin approves the quote.

Using the standard UI to moderate/edit a quote the store admin is able to change the items, quantities, prices and delivery amounts for the quote.

Once the quote is updated as being moderated the customer will receive an email with a link to purchase the quote, additionally the customer will also see the link the on the order details page.

The customer would then pay for the order using a credit card, the amount charged would be the value as defined from the moderated quote, so this could be lower (or higher) than the original amount when the cart was first submitted as a quote

Once the customer has paid for the quote it is then converted to a normal order in the store.

Note

A quote can only be purchased ONCE, it is not possible to create multiple orders for the same quote.

Page | 98

Version | 3.3.0

Sales Stats

The below dashboard lets you see how your store is performing in relation to product sales and gives a snapshot of key metrics for the last 30 days. Using this section you can see at a glance how well your store is selling.

Orders by Status Graph

This graph plots the status of the orders your store has received in the last 30 days.

Order Amounts Graph

This graph plots the total sales amount for each day in the last 30 days.

Order Counts Graph

This graph plots the number of sales for each day for the last 30 days.

Page | 99

Version | 3.3.0

Abandoned Carts Graph

This graph plots the number of carts that have been abandoned in the last 30 days.

Reports

The reports section of the admin area allows you to drill down into your store and see how well products and categories are performing in relationship to sales.

As well as the ability to view the reports online in the web interface it is also possible to download the data to a XLS file for further analysis using a spreadsheet application.

The image below shows the various options that are available during report creation, i.e. Start date, end date, category or product filtering.

Page | 100

Version | 3.3.0

Customer Hierarchy and Management

Functionality has been created to allow customer manager and sub accounts to be defined; using these accounts allows the orders to be moderated first by the customer manager before they can be purchased.

This allows you to allow organisation you sell to moderate the purchases of their buyers before the orders are placed into the store.

Orders which are in the moderated state are not visible to the store admin, it is only when the order have been approved and paid for will it be visible to the store admin.

Setting up Customer Moderation

All accounts within the store, unless set ,are normal user accounts, this means they are able to purchase the items without requiring moderation.

The store admin is responsible for defining the customer manager accounts and the sub accounts they are responsible to moderate.

By default customer management and moderation is turned off in the store. To enable this go to the Store Admin > Store Info > General Settings then check the setting

Enable Customer Order Moderation.

This will then mean the admin menu gets an additional menu bar item used to manage the users.

Click the Manage User Hierarchy lists all the users for the current portal.

A user can be one of three possible types.

Normal User - This is a standard user and does not have any moderation process

Customer Manager Account - This account is a manager and is used to moderate orders places by the sub account users which are assigned to the manager. A customer manager account will have this icon next to it

Sub Account - Orders placed with this account maybe subject to moderation if the value is above a given value. A sub account will have this icon next to it

When the icon? is shown this means the user is marked as being except from tax.

The Customer Management page allows you to set the type of user account and other settings.

Any account type can have the Tax Exempt set, when checked the customer will not be charged Tax during the checkout.

Page | 101

Version | 3.3.0

Moderate All Orders - Only available when the account is a Sub Account. When checked all orders placed will need to be moderated by the customer.

Moderation Order Threshold - Only available when the account is a Sub Account.

This defines the maximum sub total of an order which can be purchased without having to be moderated. If the order sub total is greater than this value then the customer will need to have the customer manager account approve the order before it can be purchased and placed into the store.

Customer Manager Account - Only available when the account is a Sub Account.

Defines the manager account which is responsible for moderating the customer.

Customer Manager Process

When a customer manager logs into their my account page they can use the User

Account Admin to manage their sub accounts and set the moderation status and threshold.

Any orders which are submitted to the customer manager for approval are listed in the

Order Moderation page.

The customer manager is able to approve or decline an order placed by a sub account, an optional comment can be submitted which is visible to the sub account user.

When an order is declined it can take no further action. Approved orders are sent back to the sub account and they are able to purchase the order using a credit card.

Suppliers

It is possible to create suppliers within Cart Viper and then optionally assign products to a single supplier. When adding a supplier it is possible to record their contact information, this information can be used internally or can be outputted on the product details page:

From the supplier list page you can then edit or delete existing suppliers, note if a supplier is deleted any products that have been assigned to them will be unassigned.

Page | 102

Version | 3.3.0

Custom Product Sorting

The order in which products are displayed in the category is defined by the setting on the Catalog module setting Category Product > Sort By. If you have set this as

Custom Sort Order then you can arrange the products in whatever sort order you prefer. Sorting the products is a great way to improve sales and place your important products above the fold.

To sort products for a category you should select the Sort Products from the category action menu.

To arrange the products in the correct order enter a numerical value next to each item.

Items with are displayed in ascending order, so lower numbers are displayed first.

Category Importing

Cart Viper supports importing categories using CSV data. The first line in the CSV file should be column headers for the file, this defines each column.

Page | 105

Version | 3.3.0

The application will then look for column names which match the supported import fields; other columns which don’t match will be ignored.

Please note that the column headers are not case sensitive.

The table below details the supported column names.

Field Name

Products

There is no limit to the amount of products that can be added to the Cart Viper store.

Products can be added, edited or deleted from the products section of the store admin.

A single product can be assigned to zero on many categories within the store. For a product to be displayed in the store front it must be assigned to at least one category.

The product edit page uses tabs to group related edit controls.

Page | 106

Version | 3.3.0

Tab Name

Details

Recurring Products

Cart Viper supports products which have a recurring payment; this includes products like memberships or products which are paid for over a fixed number of payments.

To define recurring products the store needs to have the payment options set up correctly. This means that the only payment gateway which can be enabled in

Authorize.net, this is the only gateway which allows for recurring payment options.

All the other options (Paypal, offline payment and Google Checkout) should be turned off.

Page | 107

Version | 3.3.0

When the store is enabled for recurring payment as per the above then the details tab of the product will allow you to define the initial and recurring amounts for the product.

Field Name

Initial Amount

Recurring Amount

Recurring Interval

No. of Billing Cycles

Description

The amount charged to the customer's credit card at the time of checkout

The amount to be charged at recurring intervals to the customer's credit card.

The amount of time between each recurring billing event. This can be in days or months.

No. of time to charge the recurring amount, this can be left blank or set to 0 to allow the system to keep billing at the recurring interval.

All prices entered into the recurring billing pricing should ex tax/VAT/GST.

When a product is defined as having recurring payments then the Qty Discount and

User Pricing tabs are not available for the product.

During the checkout the initial amount for the product will be charged to the customer's credit card and the recurring billing cycle set-up on Authorize.net ARB so that future payments will be automatically taken.

Events

Events can only be added if you have the relevant license to support events (see premium add ons section), events can be listed in the store as standard products, however they can also be listed in the Cart Viper Events Calendar module.

Adding an event follows a similar form to adding a standard product to the store, many of the same options still exist such as digital downloads and product tabs, however there are a number of options that are specific to events.

Page | 108

Version | 3.3.0

Setting Name

Users cannot sign up to event

No: Spaces Available

Buy It Now Price

Description

If selected the user will not be able to sign up the event however it will still be listed in the store. This setting allows you to list upcoming events without letting users sign up to them.

The number of places that are available for this event.

Optionally enter a price here and the user will be able to purchase this “event” at the given price, note they wont need to select a date and time when they chose to buy it now.

Event Colour

All day event

Event Start Date

Event End Date

This is the hexadecimal colour that is used as the colour for the background of the event when in calendar view. Any valid hexadecimal colour can be entered e.g. #6490e6.

Just click the text box to see the colour picker dialog which lets you select this colour.

If selected the event will last all day and a start and end time will not be able to be set.

The start date of the event.

The end date of the event, events can span multiple days.

Recurring Events

By selecting Is Recurring Event an interface will be displayed where it is possible to define the rules that will allow the event to recur. Note if an event is recurring, it will be listed as a single product within Cart Viper with many dates that the user will be able to select from when adding the item to their cart.

Page | 109

Version | 3.3.0

With Cart Viper it is possible to create events that recur on a daily, weekly, monthly or yearly basis, each of these options have a self explanatory interface that needs to be completed before the recurring event can be added.

There are a couple of points to note when creating recurring events:

1. The start date is the date Cart viper will start calculating the recurring dates from, based on your selection the event may not start on that exact date. For example if your start date is 01/01/2012 and you have defined the recurring event to start on “every weekday for 5 weeks” if the 1 st is a Sunday the actual event start date will be 01/02/2012. The same logic also applies for a given end date.

2. “End after occurrences” option defines how many times an event can recur; this can override the logic in step 1. If for example you enter “recur every weekday” and only set the “end after occurrences” value to 3 your event will only recur on Monday, Tuesday and Wednesday.

Page | 110

Version | 3.3.0

Details Tab

This tab is used to collect the main details for the product.

Page | 111

Version | 3.3.0

The table below listed each field allow with a description.

Field Name

Supplier

Manufacturer

Product SKU

Model Number

Product Name

SEO URL

Product Name

Page Title

SEO Keywords

SEO

Description

Summary

Price Mode

Unit Price

Is Free Product

Tax Free

VAT Rate

Description

From here you can optionally assign this product to a supplier, all suppliers entered into the “Suppliers” section will appear in this drop down list. The supplier details can be outputted on the product details page.

This holds the name of the manufacturer for the product. This value is displayed on the product details page.

Allows you to enter your own product SKU for the item.

The model number for the product. This value is displayed on the product details page.

Name of the product.

This is the product name SEO value which should be used in the url of the product. This value can contain only letter, numbers, “_” or “-“.

This value is only used the SEO Feature in the Store Admin is enabled.

Optional text to display as the page title in the browser, this allows you to improve the site's SEO ranking. If this value is blank then the product name will be outputted as the page title.

Optional keywords which should be added on the product details page to the keywords meta tag, this can be used to improve the search engine ranking of the product.

This value is only used if the SEO Feature in the Store Admin is enabled.

Enter some descriptive text for the current product, this is outputted into the

META description tag when browsing the product details page and can help get you a better SEO ranking.

Short summary of the product, this value is displayed when browsing the category page in the store front.

Defines if the product is a simple one off purchase price or if the item has some recurring payment. This allows you to create a product which occurs every month for example as in a membership. See Recurring Products on

page 107.

The price of a single product.

When checked the item will be free to purchase and the customer will not be charged for purchasing this item.

When using tax you can check this item to exclude it from having tax applied to the unit price.

If you are using VAT as the tax method you will be able to define the VAT

Page | 112

Version | 3.3.0

Field Name

Request a

Quote

Use modal RFQ dialogue

User Role to

View/Purchase

Is Free To Ship

Quantity

Required

Instore Pickup

Only

Description

rate which applies to this product.

When checked the product is not available to purchase directly on the site but the user can request a quote for the item via the checkout process.

This option is only available if the product is marked as “request for quote” by selecting this option when a user selects “request quote” instead of the product being added to a cart a modal dialogue window will appear and the user can fill in their details to request a quote from the store.

Defines the role that a user must be a member of in order to see the product and be able to purchase it.

The user only needs to have one of the selected roles in order to be able to see the product and purchase it.

When checked the item will not incur any shipping or delivery charges.

If this item is marked as free to ship it is also possible to enter a number that the customer must purchase in order to get the free shipping for this product.

When checked the item can't be shipped to the customer. The customer would need to collect the item from the store.

If just a single item is defined as instore pickup then the whole order must be collected from the store.

Shipping Weight Defines the weight of the item. The units for this field are not defined so you are free to use g/lb/kg etc. However you will need to use the same unit on

ALL products and during the shipping band creation.

This value is also displayed in the Product Specification tab on the product details page.

Shipping Height Height of the item. The units for this field are not defined therefore you can use any size unit however you will need to use the same unit for ALL products.

This value is also displayed in the Product Specification tab on the product details page.

Shipping Length Length of the item. The units for this field are not defined therefore you can use any size unit however you will need to use the same unit for ALL products.

This value is also displayed in the Product Specification tab on the product details page.

Shipping Width Width of the item. The units for this field are not defined therefore you can use any size unit however you will need to use the same unit for ALL products.

This value is also displayed in the Product Specification tab on the product details page.

Shipping

Surcharge

Optional shipping surcharge that should be applied when purchasing this product. This number will be multipled by the quantity of items purchased.

This allows you to add an additional charge to the shipping for a large or heavy item.

Page | 113

Version | 3.3.0

Field Name

Handling

Charge

Quantity Limit

Per Customer

Order

Archived

Featured

Dnn Role

Description

Optional handling charge which is applied to the order when the customer purchases this item. This will be multipled by the quantity of items purchased.

If a number is entered here, a single customer will not be able to purchase more of this item per order than the value entered. E.g. if 5 is entered a single customer cannot purchase more than 5 of this item per order. Leave blank if this settings is not required.

When checked the product is not displayed in the store front.

When checked the item is a featured product and as such it can be displayed in the Product Widget Module.

For every role you wish to be assigned to the user when they purchase the product simply select the checkbox next to the corresponding role. It is also possible to define in days how long the user should be assigned this role from the date of purchase. If no role expiry is entered the user will be assigned this role until they are removed by an admin / host user.

Use Global QTY

Restriction

Qty Restriction

When checked the globally defined product restriction would apply to the current product. This restricts the number of items which can be purchased for a given product.

Allows a restriction on the number of items that can be purchased.

Message in order confirmation email

Out Of Stock

If this product is purchased you can optionally include a message that will be outputted in the order confirmation email. This is controlled by the token

[PRODUCTEMAILMESSAGE]

If selected the product will be marked as “out of stock” in the database.

Depending on the Product Behaviour setting for the store this can then hide or stop the product from being purchased.

Defines the current stock level for the product.

Quantity

Low Threshold Defines the low threshold warning for the product. See below for details about this field.

Back order date If this product is a back order item the date the item will be back in stock.

This can be outputted on the product details page.

Est number of days until delivery

If this item needs to ordered this is the number of days it will take until it has arrived. Based on the order date and the number of days entered here an est delivery date will be calculated and displayed to the customer in the order confirmation email.

Purchase Price

MSRP

This is the price you paid for the item; this is never shown to the user. It is purely there for your own reference on this page.

This is the manufacturers recommended retail price, and can be outputted

Page | 114

Version | 3.3.0

Field Name

Product

Barcode

Description

alongside the product in the category or product details page.

Optional field that can be populated with the bar code number of the product.

Page | 115

Version | 3.3.0

Global and Product Quantity Restrictions

Cart Viper supports the ability to define purchasing quantity restrictions for products; the product edit page allows the valid qualities to be defined for the item.

To make administration easier a default store wide value can be assigned to a product, then only products which have a custom quantity requirement need to be edited. See

page 34 on how to set this for the store.

The system will support two different methods of defining the quantities in the store admin.

1. A simple list of comma separated values i.e. 1,2,4,6,8,10

2. A range of values, i.e. 1-10 (this will output each number in the range)

It is possible to create an entry for a product using both methods, 1,2,4,6-12

The checkout page will have the quantity text box removed and replaced with a text label which displays the quantity. This stops the customer from entering a number for the quantity during the checkout.

The stock level for the product will also be taken into account when displaying the drop down list, if the quantity drops down contains a value which is greater than the actual quantity available it will be removed from the drop down list.

Low Threshold

When a product is purchased the quantity purchased is subtracted from the Quantity field defined for the product.

Once a product quantity falls below the low threshold it will become visible in the

“Low Stock Products” search on the Products admin page.

Categories Tab

The category tab allows you to assign a product in an unlimited number of categories on your store, changes are saved instantly and do not require you to click “update”.

To remove an item from a category simple remove the tick next the category.

Page | 116

Version | 3.3.0

Description Tab

The description tab allows you enter details about your product. This field allows you to enter HTML using the WYSIWYG editor.

The description for the product is shown on the product details page in the store front.

Images Tab

This allows you to define and manage images for the product. An unlimited number of images can be uploaded for a product.

We are use a Silverlight control that allows you to upload multiple images simultaneously, if you are not using IIS7 or greater you may need to enable the MIME type for Silverlight, the below link explains how to complete this: http://blog.cartviper.com/post/2012/03/05/Cart-Viper-Silverlight-Image-Uploader-

Control.aspx

If more than one image is uploaded the main image (image marked by yellow box) will be the first image. The main image is displayed in the category list and product details page.

Other images will be shown as thumbnails on the product details page, clicking the thumbnail will display a large image.

To change the main image for a product you should simply use the order sort arrows under the image to move the chosen image to be first in the list.

Optionally you can enter a short caption for each image; this is then shown in the product details page when the user clicks on the thumbnail image.

To add or edit the caption for an image simple click the caption under the image to switch to edit mode. Click save to store the caption.

Page | 117

Version | 3.3.0

Products which do not have an image defined will use the default image. The standard default image is shown below.

You can use your own default image by replacing the file default_product_image.jpg in the Images folder which is located within the Templates folder.

Variants Tab

Optionally you can define variants for each product within your store, so for example you could create a T-shirt product and define different sizes.

A single product could define many variants, so you could add colour options to the

T-shirt example in addition to the size variant.

Variants can be marked as mandatory or optional; additionally you can add or reduce the unit price of the item when a variant option is selected. So for example if the customer selects XXL as the size for the T-shirt we could add $5 to the unit price.

However if Add Price Adjustment as % is selected it would add 5% to the base price of the product.

Page | 118

Version | 3.3.0

When you define the variants you can also select the user interface control which is used to present the options to the user.

You are also able to define a weight and dimension adjustment for the variant product. This is useful for store owners which use online shipping providers to work out the shipping costs.

An option can also be defined as tax free should it be required.

Note that the number of options you can define for a variant is unlimited. When you place your cursor into the available Option Name field a further 10 fields will be created below the last item.

Control Type

Checkbox

Description

Each option is displayed with a checkbox control. This allows the user to select more than one variant option.

Dropdown The options are displayed in a dropdown list allowing the user to select a single item.

Radiobutton The options are displayed using radio buttons, with the user able to select a single item.

ImageUploader This outputs the control needed for a user to upload an image, the image will be associated with this variant option and will be viewable by the customer and store admin when the order is placed via their Order history section.

Textbox -

Multiline

Textbox

This variant displays a multi line text box; this option is for when the user can enter a large amount of text rather than a single line.

The variant displays a textbox allowing the user to enter free text into it.

Page | 119

Version | 3.3.0

When a product has definitions for multiple variants you can define the order to display them to the user. This is achieved using the Sort Order field; lower numbered variants are shown first.

This ordering feature also extends to the variant options as well, allowing you to control the display order of each item.

When creating a variant with the control type of Dropdown it is possible for you to define some default option which is displayed as the selected option. This allows you to enter a helpful option like “Select Size” for example. When variant is marked as mandatory then the user will need to select a size from the drop down list other than the default caption.

When creating or editing a variant please ensure you click the Save hyperlink within the variant tab to commit your changes.

Textbox and ImageUploader Variants

When defining a variant which uses the textbox control to display the option you can optionally adjust the shipping weight or unit price of the product by completing the first option as shown. Option name and Sort Order have no affect when using a textbox control.

Page | 120

Version | 3.3.0

Product Variant Inventory Management

As previously explained a product has a stock quantity field that allows the admin to record how many are currently in stock, and for inventory purposes when an item is sold the quantity in stock is updated to reflect this.

It is also possible to setup stock inventory management, based on each variation a product can have, therefore allowing you to accurately track the quantity in stock for each variation of your product:

When you select “Product Variant Management” from the products variants page, you are presented with the above screen. From here you can define a product SKU and a quantity in stock for each combination of variants. Note the product SKU must be unique, if not a warning message is displayed:

Page | 121

Version | 3.3.0

Product Visualizer

If a product has variants it is possible to display to a customer a mock-up image of what the product will look like with the combination of variants the user has selected.

To configure the product visualizer first create the variants that will make up your product, in the example above we have created 3 different variants. The product visualizer can support any control type as well as any number of variants and combination of variant options.

The first step is to upload a base image, this will be the canvas that all the users variant options will be injected into to show them what there customized product will look like.

The size of the base image is defined in the store admin -> general settings. Only 1 base image can be uploaded per product, therefore if a front and back view is required, these 2 images will need to be edited into a single image and then uploaded.

The next step is then to add a “marker” for each of the product variant options, a marker represents the area on the image that the user’s content will be inserted into.

Page | 122

Version | 3.3.0

As per the above screen shot the marker position can be resized and positioned anywhere on the base image. If the variant option inserts text into the marker then the admin can define the maximum number of characters, font style, colour and alignment of the text.

If however an image will be inserted into the marker these options should be left blank. Note when an image is placed in the marker the user’s image will be autoscaled to fit into the marker.

Finally once the store admin has defined all the markers required, a hyperlink will then be displayed on the product details page of all products where the product visualizer has been configured. When the user has entered all their variant options and clicked the hyperlink the mock-up of the product will then be displayed to them in a modal popup box:

Page | 123

Version | 3.3.0

Once the user has placed the order, they along with the store admin will be able to view the mock-up image at any time by navigating to the relevant order.

Variant Images

By selecting variant images it is possible to define an image for each of the variant combinations you have entered, then when the user selects that combination that image will automatically displayed as the main image.

In order to use this feature you first need to upload your variant images via the standard method, then once this is completed click “variant images” from the variants tab:

You will then be presented with the above UI, in the drop down list you will be able to select the variant combination for the relevant image. Note you do not need to specify an image for every variant combination, if a variant combination is selected that does not have an image defined the default product image will be returned instead.

Qty Discounts

It is possible to create quantity discount bands that offer a discount to the customer based on the number of items of the product they purchase; there is no limit to the number of discount bands that can be created for a product:

Page | 124

Version | 3.3.0

In the above example we are offering 3 discount bands:

Band 1: Purchase 1 – 10 and get each item at $5.00.

Band 2: Purchase 11 – 20 and get each item at $3.00

Band 3: Purchase 21 – 30 and receive a 10% discount from the unit price of the product.

In the product details section this is outputted as:

User Pricing Tab

Products can optionally have a specific price which applies to a single user or a specific DNN role that many users can belong to. This allows you to create special prices for your best customer, trade customers etc.

A single product can contain multiple user pricing definitions. A pricing definition can be applied to an individual users or individual role.

The pricing is not the discount of the unit cost, but the actual unit price that a user who matches the user specific pricing will receive.

If a user matches multiple user specific pricing rules for a single product then the cheapest unit price will be used based on the matching rules.

If the product also has variants which apply a price change these are also applied to the user specific pricing.

When adding a user pricing to the product you can either define it for a user or role as described above, it’s not possible to define both for a single entry.

To aid in creating user specific pricing the User Name field uses AJAX to auto suggest the user as you type. This uses the display name of the user as the field which is searched. You should enter the user's display name into this field.

If a user is not found that you submit then the pricing will not get added.

Page | 125

Version | 3.3.0

Offers Tab

By creating an offer you allow the product to be sold at this offer price during the start and end dates that you have selected.

In the example below the product will be sold at a unit price of 50.00 during the 4 th

July 2010 - 13 th August 2010 – subject to the standard tax or VAT that is applicable for this product.

Once the offer period has elapsed the product will revert back to its standard purchase price you defined in the products details section.

Related Tab

The related products section allows you to cross-sell your products.

To get started type the name of the product into the search box within the page, this will return a list of products which match the term. Simply tick the products in the results which you would like to mark as related to the current item.

The related products are then displayed to the customer when they are viewing the product details page.

There are two ways in which the related products can be outputted to the product details page.

1. Using a template token the product can be outputted in a jQuery carousel

2. Outputted in the Related Product tab on the tab control

To output the related products as a carousel simply add the token

[RELATEDPRODUCTS] to the product details page.

Page | 126

Version | 3.3.0

To output the related products as a tab check Show Related Products in Tab on the

catalog module settings page 16.

Regardless of which method is used a htm file is used as template to output the product information. By default we use the template RelatedProducts.htm please see

page 147 for more information about templates in Cart Viper.

If a product has no related products then neither option will output anything to the product details page.

Downloads Tab

The Cart Viper store can support products that can be delivered digitally to the user, the advantage of this is that the customer can receive their products without any human intervention or waiting for the item to be delivered. You can assign an unlimited number of files per product as the download.

The digital file can be stored locally on the web server or it can be stored in the cloud

(Amazon AWS or Microsoft Azure).

The benefit to using the cloud are

1. The file is not taking up space on the web server.

2. When the file is downloaded by the customer it come directly from the cloud to the customer's browser. This saves on using bandwidth for the website.

Local File

Upload the file to the portal using the standard File Manager in the Admin menu in

DotNetNuke.

By default only PDFs and ZIPs are valid files for downloads, however its possible to change this to any file extensions using the settings Store Admin > Store Info >

General Settings > Allowable Download Extensions.

AWS File

To define the download as being stored on Amazon S3, click the Amazon S3 button then enter the bucket and file name.

The file should be stored as private since we generate a time limited (5 minutes) link which allows the customer to access the file.

Azure File

To define the download as being stored on Azure Blob Storage, click the Microsoft

Azure button then enter the container and blob name.

The file should be stored as private since we generate a time limited (5 minutes) link which allows the customer to access the file.

It is possible to set a limit on the number of times a digital download of a product can be downloaded or how long in days the user has from the date of purchase to download the product. This can be set globally from the Store Info settings or overridden above on a per product basis.

Page | 127

Version | 3.3.0

It is also possible to define if this digital download product should still attract a shipping charge, this would allow you to sell a product that had a digital download and physical component.

Once the order has a status of Paid the product will appear in the My Account - >

Digital Download Locker section for the user to download all the specified files.

When the user downloads a file which is stored locally they do so via a custom HTTP

Handler this means the file URL is never revealed to the user, thus ensuring the security of your download files.

The cloud stored files have a signed url which makes the link valid for only 5 minutes.

Product Tabs

Product Tabs allows you to create additional information about a product which is displayed on the product details page in a tabbed control to the customer.

In addition to any custom tabs defined for the product there are some standard tabs which are included in the control, these tabs are listed below.

 Product Specification



Discount Bundles



Product Reviews



Product Serial Number Assignment

When an order has a status of Paid it is possible to have Cart Viper assign any product in that order a pre-defined serial number.

Import Product Serial Numbers

In order to assign a product a serial number, 1 st the store admin must upload a .CSV with serial numbers for the given product. This is done via the “Import Product

Serials” tab of the product edit section:

Page | 130

Version | 3.3.0

The .CSV should contain no header data, with each serial number on a new line with no end of line deliminator. An example format would be:

CV001

CV002

CV003

CV004

Viewing Product Serial Number Assignment

The store admin can view the number of available and assigned serials for any of the products in the store by clicking “Product Serial Number Assignment” on the product management page.

From here the store admin can search for the product in their store they would like to view the serial numbers for – as they type Cart Viper will auto-suggest a product.

Once a product has been entered the store admin can select to filter the serials for this product by “assigned”, “unassigned” or “all” serial numbers.

If the serial number has been assigned, the order ID, purchaser name, email and the date the token was assigned is displayed. Once a token has been assigned it cannot be deleted from the system.

Page | 131

Version | 3.3.0

Note if the serial number has been assigned to an order item, it is possible to view that order by clicking “order”, however once a serial number has been assigned it is not possible to the delete it from the system.

Furthermore the store admin can choose to export the currently selected product serial data to .CSV file format.

Product Serial Number Assignment

Once an order has been placed and has the status of “paid” it will be assigned the next available serial number in the list – the serials are assigned alphabetically.

If the user pays via an instant method (Paypal, Authorize.net, etc) and the payment is approved the product in the order will then be assigned a serial number and the serial number will be included in the order confirmation email next to the product it relates to.

If however the user pays via an offline method, the serial will only be assigned once the store admin marks the order as “paid” in the order management section:

Note if the store admin selects “Confirm by email” the assigned serial number will be included in the email that is sent to the user.

The store admin or customer will be able to view any serial numbers that are assigned to each of the products in the order by viewing the order details via the order management / my orders section or by downloading the order as a PDF.

YouTube Video

Using the YouTube video tab the store administrator is able to assign videos to display on the product details page.

To add a YouTube video to a product you simply enter the video ID. So for example the following video http://www.youtube.com/watch?v=D_kFbTUdfuM

Would have an ID of D_kFbTUdfuM

To output YouTube videos defined for a category the template file ProductDetail.htm

needs to contain this token [YOUTUBEVIDEOS] in the file see page 147 for more

information about templates in Cart Viper.

Facet Search

By configuring facet searching it is possible to allow a user to filter products by the defined facets when browsing the store category.

Page | 132

Version | 3.3.0

Adding a New Facet

In order to add a new facet select “Facet Search” from the store admin menu, a facet can be thought of as a filter option, once a facet has been added you are then able to assign it to multiple categories and then assign values to the facet.

We are going to create the facet “colour”.

Now that we have created our facet we are going to assign it to a number of categories by selecting the relevant option from the Actions menu, these are the categories that when a user is browsing they will be able to filter by this facet.

In the above example we have defined that the facet “colour” should appear when browsing the “sports wear” and “t-shirt” categories.

Next we need to define the values for this facet - again select this option from the facets Actions menu, the values will then be assigned to individual products to allow the filtering to occur.

Following on our example we have defined a number of values for the facet “colour”.

The final step is to assign the facet values for individual products. To do this, navigate to the product edit page and select the “facet search” tab, attributes which the product exhibits should be checked.

The resulting output when browsing the store is as follows when browsing the “tshirt” category.

T-shirt category with facet “red” selected.

Product Data Sheets

An unlimited number of product datasheets can be uploaded for a given product, we only support .PDF files and the files must be uploaded via the admin → file manager menu before they can be selected here. Once the files have been uploaded they will be available to download from the product details page.

Product Import

In addition to adding products using the web interface is it also possible to upload products using CSV data.

Page | 133

Version | 3.3.0

Summary

Description

SeoKeywords

ProductWeight

ProductHeight

ProductLength

ProductWidth

StockQuantity

IsTaxFree

VatRate

Reviews

Using the settings options on the Cart Viper Catalogue module it is possible to enable or disable the feature that allows users to submit reviews for products.

Note if this feature is disabled the tab in the product details section where the product reviews are displayed is hidden.

All product reviews that are submitted by users need to be moderated by the store admin before they are displayed on the store front. To do this you select the relevant review and then you have the option to edit the rating, comments etc.

If you choose to not approve the review it will not be displayed on the store. If however it is approved it will be displayed on the Review tab on the product details page and the rating will be used to calculate the average rating of the product.

Review Responses

Once a review has been submitted it is then possible for the admin to respond to a review and here they response outputted below the original review. In order todo this select “admin response” for a selected review and enter your response in the dialogue box:

This will then be outputted in the product review section:

Page | 140

Version | 3.3.0

Request a Quote Only Products

In addition to selling items which have a price you can also list items which need to have a quote before they can be purchased. This allows you to list items which are one off, expensive or customisable.

Items are marked as Request a Quote in the product admin area by checking the box.

This will then disable the product from being added to the cart and instead create a link to allow users to add the item to a special cart we call the “quote cart”.

Once the user has added any other items they would like to receive a quote for they then proceed to the checkout where they can complete the quote details. Once submitted these details along with the items selected for a quote are emailed to the store admin.

It should be noted that to avoid confusion we allow the user to have either a normal cart or quote cart, not both at the same time. The user will need to complete their current cart type (or delete the cart) before they can create the other type.

Donations

Cart Viper can also be configured to accept donations; by default this feature is disabled. To enable donations login with a host/ admin account and select the Settings for the module “My Account Module”, you will be presented with the following screen:

Page | 141

Version | 3.3.0

Selecting “Accept Donations”, enables the rest of the settings that you are then free to configure. As with all the pages in Cart Viper, the donations page uses templates to create the page; all valid tokens for the donations template are listed in the template

section of this document.

There is also an option to display a thank you message once the user has made a donation, the message will faded in once the donation has been placed. Furthermore you can also choose to display the “Proceed to Checkout” button from your standard checkout page below the thank you message.

By adding donation amounts via the above UI you are able to define pre-selected donations amounts the user can select from in the example above the user will have the option of selecting $10.00, $100.00, $250.00, etc as a donation amount.

Alternatively the user can enter their own amount as the below screenshot demonstrates. Also when the user places a donation they can optionally add some information relating to the donation, in this case the name associated with the donation.

Page | 142

Version | 3.3.0

Donations are treated like a normal product and as such need to be added to the cart, the donation product name is defined in the resource file SharedResources.ascx.resx under the key donationProductName.Text

By default this is set to “Donation”, however this can be changed to suit your needs.

A user has two options on how to arrive at the donations page, there is a button on the cart details page, see below:

Note the user does not have to have any items in their cart to make a donation.

Or the donations control can be accessed directly via query string parameters and you can create a “standalone” page for the donations.

For example if the “My Account” module is on a page called “MyAccount.aspx” you could then create a 2 nd

page on your portal called “Donations.aspx” via the page settings for Donations.aspx if you enter the below in the link type location as per the screen: http://www.YOURDOMAIN.COM/MyAccount.aspx?pageId=donations

Now when you click the “Donations” page on your site you will be presented with the donations control.

Anonymous Checkout

Cart Viper also supports the ability for the user to checkout anonymously without creating a user account in your DNN portal first. By default this option is disabled, to

Page | 143

Version | 3.3.0

enable it login as a host / admin user and navigate to the settings page of the “My

Account” module and select allow anonymous checkout:

With this feature enabled the user will then be able to checkout as a guest, once the user has completed the checkout process, they will then be able to create an account based on the information they have entered:

If a user has an item in their cart that is delivered as a digital download the ability to checkout as a guest will be disabled and they will be prompted to either login or create a new account in order to checkout.

Abandon Cart Clean-up

Cart Viper installs a scheduler job which runs daily to remove any old abandon shopping carts. Only carts which are 90 days or older are removed from the system.

If you wish to disable this from happening you can stop the scheduler job called Cart

Viper - Abandon Cart Purge by editing it using the Host > Schedule page.

Product RSS Feeds

Cart Viper also supports the ability to expose RSS 2.0 feeds based on the product data that is held within the store. To enable this feature login as a host / admin user and via the settings of the Cart Viper Catalogue module select “enable RSS feeds”:

Page | 144

Version | 3.3.0

By selecting the above checkbox we are enabling RSS feeds and defining the maximum number of products to appear in the feed to be 25. Cart Viper supports 3 different RSS feeds:

 Newly added products.

 Featured products.

 Top Sellers.

The content of each feed is self explanatory and they can be positioned on the store via the Catalog.htm template in the standard way.

Product Widget Control

The module Cart Viper Product Widget module is designed to be a flexible way for you to display products from your store on any page in your DNN portal in manor that suits your needs.

Template

The product widget comes preloaded with 2 different templates to output the products you want to display. One of the templates is a simple grid display the other is a jQuery carousel. However there is no limit to the number of templates that can be created so you have the ability to build up a library of templates you can use to display products throughout your store.

Through the template settings you have complete control over the HTML and the details of the products that are outputted:

Page | 145

Version | 3.3.0

For more information on the product tokens that are supported click “Show Template

Help” as per the above screen shot.

Product Selection

There are a number of different methods to select products to appear in the product widget:

 Featured Items

 New Items

 Random Item

 Single Product

 Top Sellers

 Items Currently on Special Offer

 Manual section by product ID's

 Manual selection by product model numbers.

The selectors are self explanatory however it is worth noting that it is possible to further filter the featured, new, random, special offer and top seller’s selectors by entering a category that the products should be selected from.

Note for a product to be classed as New it needs to have been added within the last 30 days.

The end result gives you ability to display your products anywhere on your portal:

Page | 146

Version | 3.3.0

Templates Overview

Cart Viper has been designed in such a way so that store owners can implement their own design and branding without the need for any programming knowledge or custom code. This has been achieved through implementing a multi-level template hierarchy.

Cart Viper has two built in templates which can be used as the starting point for your store design.

Template Type

Original Templates

Description

These are the standard templates which have been built-in to Cart Viper from the first release, all stores before release 3.0.0 will be based on these

Page | 147

Version | 3.3.0

Responsive Templates templates.

These are new templates that have a responsive design built-in, the responsive design is based on the Twitter Bootstrap 3.0.

When using this template the store will adjust its layout based on the screen screen and this is ideal for desktop, tablet and mobile users.

Using the Responsive Template

When selecting the responsive templates the skin that the site is using must be using

Twitter Bootstrap 3.0.0 or greater. Cart Viper does not install the Twitter Bootstrap

CSS this is something which the skin is responsible for doing.

It should be noted to that to get the responsive functionality the skin should be using a doctype of HTML5.

<!DOCTYPE html>

Additional the page header needs to contain this element.

Template Location

The location of the templates used by the store depends on a number of factors. By default all templates are store in the CartViper module folder, this would mean all stores in a single DNN instance would use the same template.

It is possible however to tell Cart Viper to use a cloned copy of the templates that are specific to each portal instance. Using this option means you can have multiple stores each with their own templates.

To enable each portal to have their own local copy of the templates you need to check the Portal Templates option on the Store Info section.

The following table defines the location of the templates based on the selection.

Portal Templates Template Type Location

Off Original

Templates

/DesktopModules/CartViper/Templates

Off Responsive

Templates

/DesktopModules/CartViper/ResponsiveTemplates

Page | 148

Version | 3.3.0

Original

Templates

Responsive

Templates

/Portals/x/CVStore/Templates

/Portals/x/CVStore/ResponsiveTemplates

Where x is the portalId for the portal.

Templates are assigned to each section of the Cart Viper store be logging in as a host or admin user and editing the settings of the Cart Viper Catalogue module, see below:

Tokens

Each template is made up of HTML and tokens, HTML is static and is used to format and display the content in conjunction with style sheets when the template is used to create a Cart Viper page. Tokens are dynamically replaced by content, by convention all tokens are in capital letters; however the tokens are not case sensitive.

The next section contains a list of templates and all the valid token options that can be applied, you are free to create your own templates and only include tokens you wish to use/display in your design.

All valid tokens and their usage are listed in appendix A.

Skin Object Token Support

A new and advanced feature which has been added to the template engine is that you can now load Skin Objects into your Cart Viper templates.

Page | 149

Version | 3.3.0

This allows you to use an existing or write a custom Skin Object which can provide additionally functionality that you required to render your store.

To define a skin object in your template you would add the this token to your template

[SKINOBJECT:MYSKINOBJECT]

Where MYSKINOBJECT would be the name of the skin object you want to load into the template.

Additionally it is also possible to set public properties of the skin object using the following token.

[SKINOBJECT:MYSKINOBJECT(CssClass,myCustomStyle)]

This allows you to any number of key value pairs which will be used to set the properties for the object. The key should be the name of the property and the value whatever the property should be set to.

In addition to the existing skin objects you are also free to create your own custom skin objects using Visual Studio.

Creating a custom skin object and implementing a special interface from

CartViper.Modules.Store.dll also the template engine to pass in the Product and

Category object of the current item being rendered.

The interface can be found in the namespace

CartViper.Modules.Store.Components.SkinObject and is called

ICartViperSkinObject.

A very simple example is shown below. The code will take the current product and reverse the model name then render this to the UI.

namespace CVSkinTester

{ public partial class ProductNameReverse : SkinObjectBase , ICartViperSkinObject

{ protected void Page_Load( object sender, EventArgs e)

{

} protected override void Render( HtmlTextWriter writer)

{ if (Product != null )

writer.Write( "<div>{0}</div>" , Reverse(Product.ModelName)); else

writer.Write( "<div>No product</div>" );

} string Reverse( string input)

{

StringBuilder builder = new StringBuilder (); foreach ( char c in input.Reverse().ToList())

{

builder.Append(c);

} return builder.ToString();

} public CartViper.Modules.Store.Catalog.

CategoryInfo Category

{ get ;

Page | 150

Version | 3.3.0

set ;

} public CartViper.Modules.Store.Catalog.

ProductInfo Product

{ get ; set ;

}

If we then add this skin object into DNN with the name MODELNAMEREVERSE we can then use this in our template ProductList.htm.

<p class="Normal">[EDIT][PRODUCTNAMELINK]</p>

<p>[SKINOBJECT:MODELNAMEREVERSE]</p>

<p class="Normal">[THUMBNAILIMAGE]</p>

<p class="productSummary StoreClear">[SUMMARY]</p>

<p class="Normal StoreClear"><span class="productPrice">[PRICE]</span>

[VATPRICE]</p>

</div>

<p>[LINKDETAIL][LINKDETAILIMG]</p>

<p class="Normal StoreClear">[ADDTOCOMPARISONLIST]</p>

<p class="Normal StoreClear addToCartWrapper">[ADDQUANTITY]

[ADDTOCART]</p>

</div>

When we look at the store front we can see we’ve got a reverse product name for each product.

This was a trivial example however you can see that you now an in your own logic and UI controls to make Cart Viper work however you like. You could write a skin object which pulls in data for the product from some external data source for example.

Page | 151

Version | 3.3.0

Razor Support

Cart Viper supports injecting razor scripts into all template pages. This is the most powerful and quickest way to customize Cart Viper with advance UI features.

We would recommend this over using Skin Objects.

Any razor scripts which you want to reference in your template files need to reside in

the /scripts folder of the base template location. See page 148.

If a razor script is used on a template page that has ProductInfo, CategoryInfo or

ItemInfo context then this will be available in the Model.

Here is an example script used to render the product rating using glyphicon font.

@using System.Dynamic;

@using System.Collections;

@using DotNetNuke.Common;

@using DotNetNuke.Entities.Portals;

@using CartViper.Modules.Store.Catalog;

@inherits DotNetNuke.Web.Razor.DotNetNukeWebPage<dynamic>

@{ int stars = Convert.ToInt32(Model.Product.AverageRating); int emptyStars = 5 - stars;

}

@for(int i = 0; i < stars; i++){

}

@for(int i = 0; i < emptyStars; i++){

}

</p>

To use this script in the productdetails.htm page we would just add the token

[RAZOR:productrating.cshtml]

It important that all razor scripts inherit for the correct base object. This means you need to have have the inherits statement.

@inherits DotNetNuke.Web.Razor.DotNetNukeWebPage<dynamic>

The Cart Viper blog contains more examples of using Razor scripts in your templates.

http://blog.cartviper.com

Razor support is available to DNN 6 users by installing the DNN Razor Host module. Later versions of DNN have this installed by default.

Page | 152

Version | 3.3.0

Module Import Token

Another advanced feature of the template system is the ability to load an existing module from the portal into the template.

The syntax to do this would be [MODULEID:123] where 123 would be the moduleId of the module to include in the tab.

Its also possible to define the TabId of the module that should be imported, this means if a module is installed on different tabs then its possible to load the correct module.

To load the a module with a TabId you would use this token

[MODULEID:124 @TabId=12]

Localization Strings

New to Cart Viper 3.0.0 is the ability to access the resource strings. This token will provide access to the resource file for the usercontrol which is render the template.

This provides a simple way to get access to any strings which are in the resource files.

To render a string from the resource file you would use a token like this.

[LOCALIZATION:lblDeleteSingleItemFromCart.Text]

You would simply replace the yellow highlighted string with the name of the resource key to output into the template.

Conditional Statements

New to Cart Viper 3.0.0 is the ability to define conditional rendering blocks in the template. If the token in the statement is not null then the block of code will be outputted to the page. If however the token equates to null then the block will not be outputted.

When using conditional blocks you need to have a start and end definition.

#if(SHOWTAX)

...

#end

The value in the parenthesis should be a token. The template engine will then evaulate the token and if its not null the contents of the conditional block will be rendered.

Note at the moment the conditional blocks don not support and else statement.

Example

#if(SHOWTAX)

<span class="cartLabels">[LOCALIZATION:lblTotal]</span>

[GRANDTOTAL]</span>

</div>

Page | 153

Version | 3.3.0

#end

So if the token SHOWTAX is not null we will output the grand total details.

Template Pages Overview

CartDetails.htm

This template is used to layout the customer's cart.

CartDetailsItem.htm

This sub template is used by the CartDetails.htm template to layout each row of items in the cart.

Catalog.htm

Is used as the high level detail of the product category view, and defines the basic look of the controls on the page.

CategoryContainer.htm

Defines where within the catalog.htm the products are displayed along with the footer information.

DonationsTemplate.htm

The template is used to create the page where the user can place a donation.

MiniCart.htm

The template used to output the mini cart.

ProductBundlesTemplate.htm

This template is used to output the product discount bundles for a product.

ProductDetail.htm

Defines when a user has clicked view product details how the product details should be displayed.

ProductList.htm

Defines how the individual products are listed when viewing the products in a list should be displayed.

ProductSpecification.htm

When viewing product details the product specification is displayed in tab form, this template defines how the specification should be outputted.

RelatedProducts.htm

When viewing product details related products are displayed in tab form, this template defines how the related products should be outputted.

Page | 154

Version | 3.3.0

SearchResults.htm

When a user performs a search this template defines how the search results should be presented to the user.

Customisable HTML Email Templates

In addition to the templates used to display the store in a web browser we also support custom HTML email templates which are sent to customer when they complete the checkout process and when an order has the status updated.

By default we use the standard plain text emails built into Cart Viper for emails. To enable HTML email templates you need check Enable Custom Order Emails on the

Store Admin > Store Info page.

The emails which are customisable are detailed below.

Email

Registered User

Order Confirm

Anonymous user order confirmation

Trigger

Registered user placing an order

Anonymous user placing an order.

Description

This email lists all the order details sent the user.

This email lists all the order details and is sent to the user.

Page | 155

Version | 3.3.0

Admin Order

Confirmation

Order Status

Changed

Order Status

Awaiting

Payment

Order confirm awaiting moderation

Moderation complete

Purchase Order

Product

Newsletter

Manager

Approved Users

Order

User (either registered or anonymous) placing an order.

Order being updated by the store admin

Order be placed with offline payment gateway or the status of the order set to

“Awaiting payment”

Order being placed that requires moderation.

Store admin moderates order.

This emails lists all the order details and is sent to the store admin.

Updates the customer with the new status of the order when the store admin changes the status.

Prompts the user that the order is placed but not paid.

Store admin moderates order.

Scheduler sends product newsletter

This email confirms to the customer their order has been placed and requires moderation, a copy is also sent to the store admin.

This email lists all the details of the moderated order and is sent to the customer to inform them their order has been moderated.

If the create purchase orders option is enabled, once an order has been moderated by the store admin purchase order emails will be generated and emailed to the store admin. This email lists the details of each purchase order.

If the product newsletter is enabled for the store this email will be sent to any users that have registered informing them about new products.

Orders created by a sub account that needs to get approval for the purchase from a manager.

Emails used during the sub account order process to inform the manager that an order is pending.

These are only used when Customer Account Hierarchy is

enabled. Page 101

Registered, Anonymous and Admin Order Confirm Email

These emails makes use of two templates, one for the overall look and general details while a second template is used to output each order line item.

The overall template is defined within the file orderConfirmEmail.htm, while the order details template is orderDetailsConfirmEmail.htm.

The email subject for this email is contained with the SharedResources.resx resource file under the name of OrderSubjectToAdmin.Text. Therefore if you wish to change the subject you should edit the value of this entry.

The tokens which are supported by the template orderConfirmEmail.htm are listed in the table below.

Page | 156

Version | 3.3.0

Token

[BILLADDRESS.ADDRESS1]

[BILLADDRESS.ADDRESS2]

[BILLADDRESS.CITY]

[BILLADDRESS.COUNTRY]

[BILLADDRESS.EMAIL]

[BILLADDRESS.FULLNAME]

[BILLADDRESS.PHONE]

[BILLADDRESS.POSTALCODE]

[BILLADDRESS.REGION]

[BILLADDRESS]

[COMPANYNAME]

[CUSTOMERNAME]

[DOWNLOADSOFTWARE]

[FIRSTNAME]

[LASTNAME]

[ORDERDATE]

[ORDERDETAILS]

[ORDERNOTES]

[ORDERNUMBER]

[ORDERREGISTRATIONCODE]

Description

Outputs the Address 1 field from the billing address.

Outputs the Address 2 field from the billing address.

Outputs the City field from the billing address.

Outputs the Country field from the billing address.

Outputs the Email field from the billing address.

Outputs the first and last name for the customer’s bill address.

Outputs the Phone Number field from the billing address.

Outputs the Postal Code field from the billing address.

Outputs the Region field from the billing address.

Billing address for the customer. This will be formatted with each item that makes up the address on a new line.

If the store admin has defined this should be captured, the users company name will be outputted.

Displays the customer’s name outputted as

“firstname lastname”

If the order contains a digital download, this token will generate and include a link to the digital download locker.

Displays the customer's firstname.

Displays the customer's lastname

Date the order was placed.

Indicates that the sub-template order confirmation details should be used to output all the line items.

Contains any notes the user has entered for this order.

Order number for the order.

If the setting to generate an order registration code is enabled, this token will output the code generated.

Page | 157

Version | 3.3.0

Token

[SHIPPING]

[SHIPPINGADDRESS.ADDRESS1]

[SHIPPINGADDRESS.ADDRESS2]

Description

Charge for shipping the item.

Outputs the Address 1 field from the shipping address.

Outputs the Address 2 field from the shipping address.

[SHIPPINGADDRESS.CITY]

[SHIPPINGADDRESS.COUNTRY]

[SHIPPINGADDRESS.FULLNAME]

[SHIPPINGADDRESS.PHONE]

[SHIPPINGADDRESS.POSTALCODE] Outputs the Postal Code field from the shipping address.

[SHIPPINGADDRESS.REGION]

[SHIPPINGADDRESS]

Outputs the Phone Number field from the shipping address.

Outputs the Region field from the shipping address.

Shipping address for the customer. This will be formatted with each item that makes up the address on a new line.

[SHIPPINGDATE] Outputs the date and time the order was shipped if the value has been entered.

[SHIPPINGMETHOD]

[SHIPPINGTRACKINGNUMBER]

Outputs the City field from the shipping address.

Outputs the Country field from the shipping address.

Outputs the first and last name for the customer’s shipping address.

[STORENAME]

[SUBTOTAL]

[TAX]

[TOTAL]

[VATNUMBER]

Method used to ship the item to the customer.

Outputs the shipping tracking number if available for the order.

Name of the store.

Sub total of the order.

Tax amount that the order is subject to.

Total amount for the order.

If the store admin has defined this should be captured the users VAT number will be outputted.

The tokens which are supported by the template orderDetailsConfirmEmail.htm are listed in the table below.

Page | 158

Version | 3.3.0

Tokens Description

[DONATIONHONOUREENAME] When a user places a donation they can optionally enter a name associated with the donation.

[ITEMNAME]

[LINETOTAL]

Name of the item.

Contains the line total for an order, this the unit price of the item multiplied by the quantity.

[MODELNUMBER]

[PRODUCTEMAILMESSAGE]

[PRODUCTID]

[PRODUCTSKU]

[PRODUCTUOM]

The Model Number for the item purchased

Output's any message that has been entered for a product that the customer has purchased.

The primary key ID of the product purchased.

The Product SKU for the item purchased.

Outputs the unit of measure which has been defined for the product.

[QUANTITY]

[SERIALNUMBER]

[UNITPRICE]

[VARIANTS]

Quantity of the item purchased.

If a serial number was assigned to any product in this order this will output the serial number assigned.

The unit price for this item

If the product is a variant then the details of the variant option(s) selected are contained with in this token.

Order Status Changed Email

This template is defined within the file orderStatusChangeEmail.htm.

The email subject for this email is contained with the SharedResources.resx resource file under the name of StatusChanged.Text. Therefore if you wish to change the subject you should edit the value of this entry.

The tokens which are supported by this template are listed in the table below.

Token

[COMPANYNAME]

[CUSTOMERNAME]

[MESSAGE]

Description

Outputs the company name that was entered for this order.

Displays the customer’s name outputted as “firstname

lastname”

Outputs the optional message that the store admin entered into the text field when updating the order in the back office.

Page | 159

Version | 3.3.0

Token

[ORDERID]

Description

Displays the order number for the order.

[ORDERREGISTRATIONCODE] If the setting to generate an order registration code is enabled, this token will output the code generated.

[PRODUCTSERIALNUMBERS] If a serial number was assigned to any product in this order this will output the serial number assigned.

[SHIPPINGTRACKINGNUMBER] Outputs the shipping tracking number for the order if the value has been defined.

[STATUS]

[STOREEMAIL]

New status of the order

Email address of the store admin

[STORENAME]

[STOREURL]

Name of the store.

URL for the store

Order Status Awaiting Payment

This template is defined within the file orderStatusChangeEmail.htm.

The tokens which are supported by this template are the same as per the Order Status

Changed Email so please see the table above.

Order Confirm Awaiting Moderation

This template is defined in orderAwaitingModerationEmail.htm

The email subject for this email is contained with the SharedResources.resx resource file under the name of OrderAwaitingModeration.Text. Therefore if you wish to change the subject you should edit the value of this entry.

The tokens which are supported by this template are the same as per the Order Status

Changed Email so please see the table above.

Moderation Complete

This email makes use of two templates, one for the overall look and general details while a second template is used to output each order line item.

Page | 160

Version | 3.3.0

The overall template is defined within the file orderModeratedConfirmEmail.htm, while the order details template is orderModeratedDetailsConfirmEmail.htm.

The tokens which are supported by the template are the same as “Registered and

Anonymous” order confirmation emails listed above.

Purchase Order Email

This email makes use of two templates, one for the overall look and general details while a second template is used to output each order line item.

The overall template is defined within the file PurchaseOrderEmail.htm, while the order details template is PurchaseOrderDetailsEmail.htm.

The email subject for this email is contained with the SharedResources.resx resource file under the name of PurchaseOrderCreatedSubject.Text. Therefore if you wish to change the subject you should edit the value of this entry.

The tokens which are supported by the template PurchaseOrderEmail.htm are listed in the table below.

Token

[BILLADDRESS.ADDRESS1]

[BILLADDRESS.ADDRESS2]

[BILLADDRESS.CITY]

[BILLADDRESS.COUNTRY]

[BILLADDRESS.EMAIL]

[BILLADDRESS.FULLNAME]

[BILLADDRESS.PHONE]

[BILLADDRESS.POSTALCODE]

[BILLADDRESS.REGION]

[BILLADDRESS]

[COMPANYNAME]

Description

Outputs the Address 1 field from the billing address.

Outputs the Address 2 field from the billing address.

Outputs the City field from the billing address.

Outputs the Country field from the billing address.

Outputs the Email field from the billing address.

Outputs the first and last name for the customer’s bill address.

Outputs the Phone Number field from the billing address.

Outputs the Postal Code field from the billing address.

Outputs the Region field from the billing address.

Billing address for the customer. This will be formatted with each item that makes up the address on a new line.

If the store admin has defined this should be captured the users company name will be outputted.

Page | 161

Version | 3.3.0

Token

[CUSTOMERNAME]

[DOWNLOADSOFTWARE]

[ORDERDATE]

[ORDERDETAILS]

[ORDERNOTES]

[ORDERNUMBER]

[ORDERREGISTRATIONCODE]

[PURCHASEORDERSUBTOTAL]

[PURCHASEORDERTAX]

[PURCHASEORDERTOTAL]

[SHIPPING]

[SHIPPINGADDRESS.ADDRESS1]

[SHIPPINGADDRESS.ADDRESS2]

[SHIPPINGADDRESS.CITY]

[SHIPPINGADDRESS.COUNTRY]

[SHIPPINGADDRESS.FULLNAME]

[SHIPPINGADDRESS.PHONE]

[SHIPPINGADDRESS.POSTALCODE]

[SHIPPINGADDRESS.REGION]

[SHIPPINGADDRESS]

[SHIPPINGMETHOD]

[SHIPPINGTRACKINGNUMBER]

Description

Displays the customer’s name outputted as “firstname

lastname”

If the order contains a digital download, this token will generate and include a link to the digital download locker.

Date the order was placed.

Indicates that the sub-template order confirmation details should be used to output all the line items.

Contains any notes the user has entered for this order.

Order number for the order.

If the setting to generate an order registration code is enabled, this token will output the code generated.

The subtotal of the items in this purchase order.

The tax for this purchase order.

The total for this purchase order including shipping, subtotal and tax.

Charge for shipping the item.

Outputs the Address 1 field from the shipping address.

Outputs the Address 2 field from the shipping address.

Outputs the City field from the shipping address.

Outputs the Country field from the shipping address.

Outputs the first and last name for the customer’s shipping address.

Outputs the Phone Number field from the shipping address.

Outputs the Postal Code field from the shipping address.

Outputs the Region field from the shipping address.

Shipping address for the customer. This will be formatted with each item that makes up the address on a new line.

Method used to ship the item to the customer.

Outputs the shipping tracking number if available for the order.

Outputs the shipping tracking number if available for the

Page | 162

Version | 3.3.0

Token

[STORENAME]

[SUPPLIERADDRESS]

[SUPPLIEREMAIL]

[SUPPLIERNAME]

[SUPPLIERPHONE]

[VATNUMBER]

Description

order.

Name of the store.

If this purchase order has a supplier that suppliers address will be outputted.

If this purchase order has a supplier that suppliers email will be outputted.

If this purchase order has a supplier that suppliers name will be outputted.

If this purchase order has a supplier that suppliers phone number will be outputted.

If the store admin has defined this should be captured the users VAT number will be outputted.

The tokens which are supported by the template PurchaseOrderDetailsEmail.htm are listed in the table below.

Tokens

[DONATIONHONOUREENAME]

[ITEMNAME]

[MODELNUMBER]

[PRODUCTID]

[PRODUCTSKU]

[PRODUCTUOM]

[QUANTITY]

[SERIALNUMBER]

[UNITPRICE]

[VARIANTS]

Description

When a user places a donation they can optionally enter a name associated with the donation.

Name of the item.

The Model Number for the item purchased

The primary key ID of the product purchased.

The Product SKU for the item purchased

Outputs the unit of measure which is defined for the product.

Quantity of the item purchased.

If a serial number was assigned to any product in this order this will output the serial number assigned.

The unit price for this item

If the product is a variant then the details of the variant option(s) selected are contained with in this token.

Product Newsletter

Page | 163

Version | 3.3.0

This email makes use of two templates, one for the overall look and general details while a second template is used to output each order line item.

The overall template is defined within the file ProductNewsLetter.htm, while the order details template is ProductNewsLetterProductDetails.htm.

The email subject for this email is contained with the SharedResources.resx resource file under the name of ProductNewsletterSubject.Text. Therefore if you wish to change the subject you should edit the value of this entry.

The tokens which are supported by the template ProductNewsLetter.htm are listed in the table below.

Tokens

[NUMBEROFDAYS]

[PRODUCTDESCRIPTION]

[PRODUCTDETAILS]

[PRODUCTIMAGEURL]

[PRODUCTPRICE]

[PRODUCTTITLE]

[PRODUCTURL]

[STORENAME]

[UNSUBSCRIBEURL]

Description

How long since the last email was sent.

The description of the product we are outputting.

The token to specify we are outputting the product details.

The URL to the image of the product we are outputting.

The price of the product we are outputting.

Title of the product we are outputting.

The URL to the product we are outputting.

The name of the store.

The url the customer needs to click to unsubscribe from the newsletter.

The below tokens are supported by ProductNewsLetterProductDetails.htm:

Page | 164

Version | 3.3.0

Tokens

[PRODUCTDESCRIPTION]

[PRODUCTIMAGEURL]

[PRODUCTPRICE]

[PRODUCTTITLE]

[PRODUCTURL]

Description

The description of the product we are outputting.

The URL to the image of the product we are outputting.

The price of the product we are outputting.

Title of the product we are outputting.

The URL to the product we are outputting.

Page | 165

Version | 3.3.0

Appendix A: Token List

Below are the names of all valid tokens and the templates listed above are the templates the tokens are valid with.

CartDetails.htm

Token

[CARTITEMS]

[COUPONCODE]

[DISCOUNT]

[DISCOUNTLABEL]

[GRANDTOTAL]

[HANDLING]

[HANDLINGLABEL]

[LINETOTALHEADER]

[NOTES]

[PRICEHEADER]

[PRODUCTHEADER]

[QUANTITYHEADER]

[SHIPPING]

[SHIPPINGLABEL]

[SHOWHANDLINGFEE]

[SHOWNOTES]

[SHOWTANDC]

[SHOWTAX]

[SUBTOTAL]

Description

Renders the sub template for each item in the cart.

Renders the coupon input control, this allows the user to enter a coupon code to receive a discount on their cart.

Displays the discount amount for the cart.

Displays the discount caption for the cart.

Outputs the grand total for the user's cart.

Outputs the handling charge amount for the cart.

Displays the handling caption for the cart.

Displays the line total header caption on the cart.

Renders the control to allow the customer to enter some notes which are saved with the order.

Displays the price header caption on the cart.

Displays the product header caption on the cart.

Displays the quantity header caption on the cart.

Outputs the shipping estimate amount for the cart.

Displays the shipping caption.

Conditional token used to determine if the cart needs to show a handling fee.

Conditional token used to determine if the cart will show the notes field to the user.

Conditional token used to determine if the customer's cart show a

Terms and Conditions checkbox. If this is shown the customer can only checkout when this has been checked.

Conditional token used to determine if the cart has the setting turned on to display the estimated tax amount.

Outputs the subtotal for the user's cart.

Page | 166

Version | 3.3.0

Token

[SUBTOTALLABEL]

[TAX]

[TAXLABEL]

Description

Displays the sub total caption.

Outputs the estimated tax amount for the cart.

Displays the tax caption for the cart.

CartDetailsItem.htm

Token

[BACKORDERDETAILS]

[INSTOREPICKUP]

[ITEMID]

[LINETOTAL]

[PRODUCTHYPERLINK]

[PRODUCTTHUMBNAIL]

[PRODUCTUOM]

[QUANTITY]

Description

If the item is out of stock and defines some back order availability details then this token will render that to the cart.

If the item is only available as instore pickup this token will output that information to the page.

Outputs the itemID of the cart item. This is the primary key of the item in the database.

Renders the line total of the item, this will be the unit price multiplied by the quantity of items in the cart.

Renders the name of the product and a hyperlink back to the product details page.

Renders a thumbnail image of the product.

Outputs the unit of measure which is defined for the product.

Renders the control to the display and edit the quantity of the item in the cart.

Renders the unit price of the item to the cart.

Renders any selected variants for the product to the cart.

[UNITPRICE]

[VARIANTDETAILS]

Catalog.htm

Token

[BREADCRUMB]

[CATEGORY]

[DETAIL]

[RSSFEEDFEATUREDPRODUCTS]

Description

Displays the list of categories from the root of the selected category. The categories are hyperlinked so the user can easily navigate back up the path they have taken.

Loads the selected template (CategoryContainer.htm by default) to display the products list by category.

Loads the selected template (ProductDetail.htm by default) to display the product detail view.

Displays a link to an RSS 2.0 feed showing featured products.

Page | 167

Version | 3.3.0

Token

[RSSFEEDNEWLYADDED]

[RSSFEEDTOPSELLERS]

[SEARCH]

[SEARCHRESULTS]

Description

Displays a link to an RSS 2.0 feed showing newly added products.

Displays a link to an RSS 2.0 feed showing the top sellers on the store.

Displays a group of controls to search and sort the catalog. The text can be changed via the resource file Catalog.ascx.resx.

Loads the selected template (SearchResultsList.htm by default) to display the list of products found.

CategoryContainer.htm

Field Name

[CATEGORYDESCRIPTION]

[CATEGORYSORTOPTIONS]

[CATEGORYTITLE]

[CATEGORYYOUTUBEVIDEOS]

[ITEMSCOUNT]

[PAGEINFO]

[PAGENAV]

[PRODUCTS]

[SEARCHSORTOPTIONS]

[SUBCATEGORYIMAGES]

Description

Outputs the category description of the current category if the user is browsing the catalogue.

Displays a dropdown menu allowing the customer to change the sort order of the products in the category. If this token is not used the customer will only see the products sorted using the Catalog Module sorting setting. This control is only outputted when displaying the category page.

Displays the category name of the current category if the user is browsing the catalogue.

Displays the YouTube videos assigned for the category.

Displays the number of items in the list (e.g. 5 items). The text can be changed via the resource Items. Text in the file

ProductList.ascx.resx

Displays the current page number and the number of pages (e.g. page 1 of 3). The text table can be changed in the resource

PageInfo.Text in the file ProductList.ascx.resx.

Displays the page navigation system (e.g. << 1 2 3 >>). The text links can be changed in the resources Next.Text and Previous.Text in the file ProductList.ascx.resx. This token can be used only within a container to display the product list by category.

Loads the selected template to display the products belonging to the list.

Displays a dropdown menu allowing the customer to change the sort order of the search results. If this token is not used the search results will only be order by relevance. This control is only outputted when displaying the search results.

Displays the images of the entire current category sub categories; if the sub categories do not have an image defined no image will be displayed for that sub category.

Page | 168

Version | 3.3.0

Field Name

[SUBCATEGORYLINKS]

[TOPLEVELCATEGORIES]

Description

Displays a list of subcategories for the current category. Each subcategory will be a hyperlink to allow the customer to navigate into that category.

If no category is selected this token will output all the top level categories that are in the store.

DonationsTemplate.htm

Field Name

[ADDTOCART]

[CUSTOMAMOUNT]

[DONATIONUSERDETAILS]

[PREDEFINEDDONATIONAMOUNTS]

[WELCOMEMESSAGE]

Description

Once the user has either selected the predefined donation amount or entered their own this allows the user to add the donation to the cart.

Displays a radio button and textbox that allows the user to enter their own donation amount rather than select one of the admin predefined ones.

When a user places a donation they can enter some details associated with the donation. E.g. honouree name and title.

Displays the predefined donation amounts the admin has created, in radio button style.

Displays a welcome message that is displayed to the user, this message is defined in Donations.ascs.resx lblWelcomeMessage.Text

MiniCart.htm

Field Name

[CARTDETAILSLINK]

[CARTOTOTAL]

[CARTTOTALLABEL]

[CURRENTPOINTSTOTAL]

[NUMBEROFITEMSINCART]

[NUMBEROFITEMSINCARTLABEL]

[POINTSTOTALLABEL]

[YOURCARTLABEL]

Description

Outputs a hyperlink to the cart summary page.

Outputs the total of the cart.

Displays the text label stating the cart total.

Outputs the current points total, this is only valid if the payment points provider is selected.

Outputs the number of items in the cart.

Displays the text label stating how many items are in the cart.

Outputs the text label for the number of points used – only valid if using payment points provider

Outputs the title of the mini cart.

Page | 169

Version | 3.3.0

ProductBundlesTemplate.htm

Field Name

[ADDTOCART]

[BUNDLEDESCRIPTION]

[BUNDLENAME]

[BUYSEPERATLYPRICE]

[BUYTOGETHERPRICE]

[BUYTOGETHERSAVING]

[PRODUCTIMAGES]

Description

Displays a link to add all items in the bundle to the user’s cart.

Displays the description of the discount bundle.

Displays the name of the product discount bundle.

Displays the sum total of the product in the bundles without the saving.

Shows the total price the user would pay if they purchased all items in the bundle.

Displays the total amount the user would save by purchasing them together e.g. $5.00

Displays the main image for each product in the discount bundle.

ProductDetail.htm

ProductList.htm

ProductSpecification.htm

RelatedProducts.htm

SearchResults.htm

Field Name

[ADDITIONALIMAGESGALLERY]

[ADDQUANTITY]

[ADD_QUANTITY_NOT_VARIANTS]

[ADDTOCART]

[ADDTOCOMPARISIONLIST]

[ADDTOWISHLIST]

Description

If multiple product images have been uploaded you can display them in gallery format, and when clicked upon will display in modal colorbox window.

Display a textbox where the user can optionally enter the quantity of the product they would like to add to cart, if the user does not enter a quantity 1 will be added.

Hides the add to cart quantity textbox on the product list page when the product has variants.

Displays link to add the item to the user’s cart.

Displays a link to add the item to the user’s product comparison list.

Displays the link to add the item to the user’s wish list

[AVERAGERATNG]

[DATASHEET]

If product reviews are enabled, the average product rating will be calculated and displayed to the user in graphical format using stars.

Outputs a link to the product datasheet, the link is displayed as a

PDF icon. If the product does not define a datasheet the token

Page | 170

Version | 3.3.0

Field Name

[DESCRIPTION]

[DIMENSIONS]

[EMAILAFRIEND]

[FACEBOOKLIKEBUTTON]

[HEIGHT]

[LARGEIMAGE]

[LENGTH]

[LINKDETAIL]

[LINKDETAILIMG]

[MANUFACTURER]

[MEDIUMIMAGE]

[MODELNUMBERVALUE]

[MSRP]

[NUMBERINSTOCK]

[NUMBERINSTOCKVALUE]

[PRICE]

Description

does not output anything.

Displays the description of the product.

Displays a label containing the dimensions of the product (e.g.

Dimensions H=0.00, L=0.00, W=0.00). The text can be changed in the resource Dimenstions.Text in the file

ProductDetails.ascx.resx.

Displays the link to allow a user to send an email to friend with details of the current product in the message.

Displays the Facebook Like button on your site. This only works when you are on a public facing URL, if you are testing the site on local host this will not work.

Displays the label containing the height of the product (e.g.

Height : x M). The text can be changed in the resource

HeightText.Text in the file ProductDetails.ascx.resx

Displays the main product image in the image size that is defined for the large image setting.

Displays the label containing the length of the product (e.g.

Length: x M). The text can be changed in the resource

LengthText.Text in the file ProductDetails.ascx.resx

Displays a link to show the product detail, the text “More Info” can be changed in the resource LinkDetail.Text in the file

ProductDetail.ascx.resx.

Displays an image button to show the product detail. The file name and locale pattern (linkdetailimg_{0}.gif) can be changed in the resource LinkDetailImg.Text in the file ProductDetails.ascx.

Displays the manufacturer of the product.

Displays the medium product image using the size that is defined for the medium image setting.

This is similar to the [PRODUCTNUMBER] token in that it outputs the product number; however it only outputs the model number value without any caption.

Displays the manufacture recommended retail price for the product.

Displays the number of products that are left in stock. This prepends a caption to the numerical value.

Displays the number of products that are left in stock. This token only outputs the numerical value.

Displays the price of the product excluding vat or tax with any offer that may be defined for the product.

Page | 171

Version | 3.3.0

Field Name

[PRINTDETAIL]

[PRODUCTDETAILURL]

[PRODUCTNAME]

[PRODUCTNAMELINK]

[PRODUCTNUMBER]

[PRODUCTSKU]

[PRODUCTUOM]

[PRODUCTVARIANTS]

[QTYDISCOUNTPRICES]

[RELATEDPRODUCTS]

[SUMMARY]

[SUPPLIERADDRESS.ADDRESS1]

[SUPPLIERADDRESS.ADDRESS2]

[SUPPLIERADDRESS.CITY]

[SUPPLIERADDRESS.COUNTRY]

[SUPPLIERADDRESS.POSTCODE]

[SUPPLIERADDRESS.REGION]

[SUPPLIERADDRESS.TELEPHONE]

[SUPPLIERADDRESS]

[SUPPLIERNAME]

[SURFACE]

Description

Displays a link to the print product detail. The text link “Print” can be changed in the resource PrintDetail.Text in the file

ProductDetail.ascx.resx.

Returns the full URL of the product detail page.

Displays the name of the product.

Displays the name of the product; however the name of the product is hyperlinked to the main product details page.

Displays the product number.

Displays the product SKU.

Outputs the unit of measure which is defined for the product.

Displays a set of controls that are used to output the product variant option if the product has variants. If the product does not have variants, nothing will be displayed.

If qty discount prices have been entered for this product the different bands will be outputted along with the price for each discount band.

Outputs a jQuery carousel with any related products. See page

126

Displays the summary of the product.

Displays the supplier's address1 field

Displays the supplier's address2 field.

Displays the supplier's city field.

Displays the supplier's country field.

Displays the supplier's postcode field.

Displays the supplier's region field.

Displays the supplier's telephone field.

Displays the supplier's address details. If the product is not assigned to a supplier this will be blank.

Displays the supplier name. If the product is not assigned to a supplier this will be blank.

Computes the surface of the product (width*length) and displays a label containing the result. The text model and the unit can be changed in the SurfaceText.Text resource in the

ProductDetail.ascx.resx file.

Page | 172

Version | 3.3.0

Field Name

[TABS]

[THUMBNAILIMAGE]

[THUMBNAILIMAGEURL]

[TITLE]

[VATPRICE]

[VOLUME]

[WEIGHT]

[WIDTH]

[YOUTUBEVIDEOS]

Description

Outputs the product tabs control, see page 128 for more

information.

Displays the thumbnail product image in the size that is defined for the thumbnail image setting. This will be the main image that is displayed as a thumbnail.

Returns the full URL to the location of the main thumbnail image for the product.

Displays the title of the product.

Displays the product price when VAT or tax has been applied.

Computes the volume of the product (Width*Length*Height) and displays the result. The text model and the unit can be changed in the VolumeText.Text resource file ProductDetail.ascx.resx

Displays a label containing the product weight e.g. 10kg. The text and the unit can be changed in the WeightText.Text resource of the ProductDetail.ascx.resx file.

Displays a label containing the width of the product e.g. width

7cm. The text and unit can be changed via the WidthText.Text resource in the file ProductDetail.ascx.resx.

Outputs the YouTube vidoes which have been defined for the product.

ViewEventSummary.htm

When a user hovers over an event a summary of the event is displayed to the user:

Supported Tokens:

Token Name

[EVENTTITLE]

[STARTDATE]

[ENDDATE]

[EVENTSUMMARY]

Description

The title of the event.

The start date of the event.

The end date of the event.

The event summary.

ViewEventDetails.htm

When a user clicks on an event a modal window is displayed:

Supported Tokens:

Page | 173

Version | 3.3.0

Token Name

[EVENTTITLE]

[STARTDATE]

Description

The title of the event.

The start date of the event.

[ENDDATE]

[EVENTDESCRIPTION]

The end date of the event.

The event description.

[EVENTCOST] The cost per place.

[SIGNUPTOEVENTLINK] The url of the page to sign up to the event.

Page | 174

Version | 3.3.0

Appendix B: Order Notification

Cart Viper allows integration into external system once an order is placed and every time an order has the status updated.

Using this functionality it’s possible to then record the customer's order in your accounts package, generate some custom email with a license key/serial number or notify some external order process etc.

To notify the external system Cart Viper will send a HTTP POST request to a URL, contained within the request will be the order details as XML.

You're external system can then parse the XML and process as required. We've already created a helper DLL for .net 3.5 so you can use this with your URL to process the data easily.

Remember that an order notification event is raised whenever an order has its status changed; therefore you need to handle the correct event occurring for your integration requirements.

The status of an order is contained within the element Order/OrderStatusId the integer values represent the following statuses.

Processing = 1,

AwaitingPayment = 2,

AwaitingStock = 3,

Packing = 4,

Dispatched = 5,

Cancelled = 6,

Paid = 7

When an order is first generated after completing an online payment gateway the status is marked as Paid. So potentially an order notification of this type is when you would want to generate the order in your accounts package, create a license key etc.

XML Order Details

Cart Viper will send the order to the call back URL as a HTTP POST with the form variable data containing the xml for the order. An example of the XML document is shown below.

xml version = " 1.0

" encoding = " utf-8 " ?>

< order >

< orderId > 1150 </ orderId >

< orderDate > 2011-02-12T12:46:34.3570000

</ orderDate >

< subTotal > 5.50

</ subTotal >

< tax > 0.44

</ tax >

< shippingCost > 0.00

</ shippingCost >

< discountAmount > 0.00

</ discountAmount >

< grandTotal > 5.94

</ grandTotal >

< shippingDescription > Free Shipping </ shippingDescription >

< offerCode />

< orderStatus > 2 </ orderStatus >

< portalId > 1 </ portalId >

< billingAddress >

< firstName > SuperUser </ firstName >

< lastName > Account </ lastName >

< address1 > address 1 </ address1 >

< address2 > address 2 </ address2 >

< city > Las Vegas </ city >

< region > Nevada </ region >

< country > United States </ country >

Page | 175

Version | 3.3.0

< postalCode > 33897 </ postalCode >

< phone > 555 555 1224 </ phone >

< email > [email protected]

</ email >

</ billingAddress >

< shippingAddress >

< firstName > SuperUser </ firstName >

< lastName > Account </ lastName >

< address1 > address 1 </ address1 >

< address2 > address 2 </ address2 >

< city > Las Vegas </ city >

< region > Nevada </ region >

< country > United States </ country >

< postalCode > 33897 </ postalCode >

< phone > 555 555 1224 </ phone >

< email > [email protected]

</ email >

</ shippingAddress >

< items >

< item >

< itemId > 7711 </ itemId >

< modelNumber />

< name > Bear </ name >

< unitPrice > 1.00

</ unitPrice >

< quantity > 1 </ quantity >

< variantOptions />

< sku />

< manufacturer />

</ item >

< item >

< itemId > 7709 </ itemId >

< modelNumber > AN010 </ modelNumber >

< name > Lion Cub </ name >

< unitPrice > 2.25

</ unitPrice >

< quantity > 1 </ quantity >

< variantOptions />

< sku />

< manufacturer />

</ item >

< item >

< itemId > 7714 </ itemId >

< modelNumber > AN013 </ modelNumber >

< name > Seal Cub </ name >

< unitPrice > 2.25

</ unitPrice >

< quantity > 1 </ quantity >

< variantOptions />

< sku />

< manufacturer />

</ item >

</ items >

< hash > 16GHrwGqWGdigBxK1RqbekDKrzA= </ hash >

</ order >

This can then be parsed and processed as required by your external system. Before processing we strong recommend that you validate the hash element to ensure the message is genuine.

Validating the Hash

To validate the hash you simply need to extract all the element values from the XML document excluding the hash element.

These values should be concatenated together with the secret shared as entered into the Order Notification Callback section in the Store Info.

A SHA1 hash of the string should be generated, convert the resulting hash into a base64 encoded string and compare to the supplied hash value in the XML document.

If both the supplied hash and the hash you have generated match then you can assume the HTTP POST is genuine.

Page | 176

Version | 3.3.0

If the hashes do not match then you should STOP processing and discard the message.

When extracting the hash value from the XML document be aware that sometimes the base64 can get mangled in that the base64 character "+" can get encoded as " " during the parsing of the form data. If this occurs simple replace any spaces in the extracted hash with a "+" character.

.net Order Notification Helper

If you are using ASP.net 3.5 to process the call back then you don't need to process the XML manually or validate the hash yourself since we've got a free helper assembly (which also comes with an example and source) that you can use to process the notification.

You can download a zip file from our website here http://www.cartviper.com/portals/0/ordernotification.zip

The helper is very easy to use and allows you to simply pass in your XML data and the shared secret then the helper will raise the event to tell you what the order status is of the order.

The helper method will also parse the XML and return a strongly typed object that you can then use in your event handler code.

If the hash is invalid then the event

Invalid Data

is raised which allows you to log the event for example.

Below is a sample block of code that is used to write the order to display if the order is valid and has a status of paid.

string sharedSecret = "marktest" ; protected void Page_Load( object sender, EventArgs e)

{ string data = Request.Form[ "data" ]; if (!

string .IsNullOrEmpty(data))

{

Processor processor = new Processor ();

processor.InvalidData += new

EventHandler < EventArgs >(processor_InvalidData); processor.AwaitingPayment += new

EventHandler < OrderNotifyEventArgs >(processor_AwaitingPayment); processor.AwaitingStock += new

EventHandler < OrderNotifyEventArgs >(processor_AwaitingStock); processor.Cancelled += new

EventHandler < OrderNotifyEventArgs >(processor_Cancelled); processor.Dispatched += new

EventHandler < OrderNotifyEventArgs >(processor_Dispatched); processor.Packing += new

EventHandler < OrderNotifyEventArgs >(processor_Packing); processor.Paid += new

EventHandler < OrderNotifyEventArgs >(processor_Paid);

Page | 177

Version | 3.3.0

processor.ProcessingOrder += new

EventHandler < OrderNotifyEventArgs >(processor_ProcessingOrder); processor.SharedSecret = sharedSecret; processor.ParseData(data);

}

We can then simple write code in whichever event we want to do something.

void processor_Paid( object sender, OrderNotifyEventArgs e)

{

WriteOrderToDisk( "Paid" , e.OrderInfo);

} private void WriteOrderToDisk( string status, Order order)

{ string path = Server.MapPath( string .Format( "~/App_Data/

{1}_{0:yyyyMMddHHmmss}.txt" , DateTime .Now, status.ToUpper().Replace( "

" , "" ))); using ( StreamWriter writer = File .CreateText(path))

{

writer.Write(Request.Form[ "data" ]);

writer.WriteLine();

XmlSerializer serializer = new XmlSerializer ( typeof ( Order ));

serializer.Serialize(writer, order);

writer.Flush();

}

This is just a very simple example of what you can do but it demonstrates the principles of handling an order notification.

Page | 178

Version | 3.3.0

Appendix C: Customising the Captions in Cart Viper

Cart Viper allows you to customise the captions used throughout the module, this allows you to change the captions to better suit your requirements for example or client.

All the captions are stored in a resource files (.resx) within the module folder, however we do not recommend that you edit these files since any future upgrade of

Cart Viper will replace your modified files ones from the new package.

Instead you should use a portal specific resource file which will not get over written with future upgrade and also means the change won’t affect other portals.

DotNetNuke first looks for a resource key it needs in a portal specific resource file before falling back to general resource file if unable to locate the key.

Since we have this fall back feature our portal specific resource file only needs to contain the resource caption we want to change, the standard resource file will supply the other captions.

Let’s take a look at an example; I’m going to change the caption on the mini cart module to use the world “Basket” in place of “Cart”.

The first thing we need to do is locate the correct resource file.

The resource files are located in the folder

/DesktopModules/CartViper/App_LocalResources

Page | 179

Version | 3.3.0

Each ASP.net ascx control has 4 resource files, each for the 4 different languages we support. For the demo here I’m just going to change the English version however the same principle can be applied to any of the other languages.

Additionally we have a SharedResources.resx file which contains captions used by the AJAX code to return the correct messages to display.

Since we are going to change the captions on the Mini Cart control the file we need to look at is MiniCart.ascx.resx

Lets go ahead and open that file with notepad or similar, the file itself is just a XML document that has key value pairs for the captions.

Most of the file contains comments and boiler plate entries, the place we need to look at are the elements with the <data> element.

The name attribute of the entry will be the name of ASP.net control that is rendering the caption.

Page | 180

Version | 3.3.0

We created a blank resource file which you can use as the basis for the new file

( http://www.cartviper.com/portals/0/resourceTemplate.zip

). Into this file we are going to copy the entries we want to change. We’re going to copy the following entries into my new file.

< data name ="btnViewCart.Text" xml:space ="preserve">

< value >

View my Cart

</ value >

</ data >

< data name ="AddAnother.Text" xml:space ="preserve">

< value >

Add one or more {0} to the cart.

</ value >

</ data >

< data name ="lblNumberItemsText.Text" xml:space ="preserve">

< value >

Items In Cart:

</ value >

</ data >

< data name ="lblYourCart.Text" xml:space ="preserve">

< value >

Cart Summary

</ value >

</ data >

After copying these into the template file I’m going to change the word “cart” to

“basket” in the value elements.

The most important part of implementing the change is to name the file correctly, the file needs to be named with the original file name but needs .Portal-X (where X is the

ID of the portal you are wanting to apply the change for) inserted just before the .resx extension ending.

Since the original file name was MiniCart.ascx.resx the new portal specific change needs to be named MiniCart.ascx.Portal-2.resx (my demo portal has an ID of 2) and placed into the folder /DesktopModules/CartViper/App_LocalResources

Page | 181

Version | 3.3.0

Refreshing the page shows the new resource file has been picked up by DotNetNuke.

My complete resource file is listed below for reference.

MiniCart.ascx.Portal-2.resx

xml version ="1.0" encoding ="utf-8"

< root >

< xsd:schema id ="root" xmlns ="" xmlns:xsd =http://www.w3.org/2001/XMLSchema

xmlns:msdata ="urn:schemas-microsoft-com:xml-msdata">

< xsd:import namespace ="http://www.w3.org/XML/1998/namespace" />

< xsd:element name ="root" msdata:IsDataSet ="true">

< xsd:complexType >

< xsd:choice maxOccurs ="unbounded">

< xsd:element name ="metadata">

< xsd:complexType >

< xsd:sequence >

< xsd:element name ="value" type ="xsd:string" minOccurs ="0" />

</ xsd:sequence >

< xsd:attribute name ="name" use ="required" type ="xsd:string" />

< xsd:attribute name ="type" type ="xsd:string" />

< xsd:attribute name ="mimetype" type ="xsd:string" />

< xsd:attribute ref ="xml:space" />

</ xsd:complexType >

</ xsd:element >

< xsd:element name ="assembly">

< xsd:complexType >

< xsd:attribute name ="alias" type ="xsd:string" />

< xsd:attribute name ="name" type ="xsd:string" />

Page | 182

Version | 3.3.0

</ xsd:complexType >

</ xsd:element >

< xsd:element name ="data">

< xsd:complexType >

< xsd:sequence >

< xsd:element name ="value" type ="xsd:string" minOccurs ="0" msdata:Ordinal ="1" />

< xsd:element name ="comment" type ="xsd:string" minOccurs ="0" msdata:Ordinal ="2" />

</ xsd:sequence >

< xsd:attribute name ="name" type ="xsd:string" use ="required" msdata:Ordinal ="1" />

< xsd:attribute name ="type" type ="xsd:string" msdata:Ordinal ="3" />

< xsd:attribute name ="mimetype" type ="xsd:string" msdata:Ordinal ="4" />

< xsd:attribute ref ="xml:space" />

</ xsd:complexType >

</ xsd:element >

< xsd:element name ="resheader">

< xsd:complexType >

< xsd:sequence >

< xsd:element name ="value" type ="xsd:string" minOccurs ="0" msdata:Ordinal ="1" />

</ xsd:sequence >

< xsd:attribute name ="name" type ="xsd:string" use ="required" />

</ xsd:complexType >

</ xsd:element >

</ xsd:choice >

</ xsd:complexType >

</ xsd:element >

</ xsd:schema >

< resheader name ="resmimetype">

< value > text/microsoft-resx

</ value >

</ resheader >

< resheader name ="version">

< value >

2.0

</ value >

</ resheader >

< resheader name ="reader">

< value >

System.Resources.ResXResourceReader,

System.Windows.Forms, Version=2.0.0.0, Culture=neutral,

PublicKeyToken=b77a5c561934e089

</ value >

</ resheader >

< resheader name ="writer">

< value >

System.Resources.ResXResourceWriter,

System.Windows.Forms, Version=2.0.0.0, Culture=neutral,

PublicKeyToken=b77a5c561934e089

</ value >

</ resheader >

<!--

CART VIPER - CUSTOM resx TEMPLATE

ADD YOUR CUSTOM DATA ENTRIES INTO THE FILE BELOW THIS COMMENT

-->

Page | 183

Version | 3.3.0

< data name ="btnViewCart.Text" xml:space ="preserve">

< value >

View my Basket

</ value >

</ data >

< data name ="AddAnother.Text" xml:space ="preserve">

< value >

Add one or more {0} to the basket.

</ value >

</ data >

< data name ="lblNumberItemsText.Text" xml:space ="preserve">

< value >

Items In Basket:

</ value >

</ data >

< data name ="lblYourCart.Text" xml:space ="preserve">

< value >

Basket Summary

</ value >

</ data >

</ root >

Page | 184

Version | 3.3.0

Appendix D: DNN Profile Mapping in the Checkout

When a customer checks-out in the store the checkout page is populated with the address from the the last order they placed. If however the customer has yet to make a purchase then the address is loaded from the customer's DNN profile.

Using an XML file its possible to override the standard mapping built into Cart Viper with a custom mapping that maps the DNN profile to the address field used in Cart

Viper. This allows for example to swap the fields used to populate Address1 and

Address2.

To define a mapping you need to create a file named ProfileMapping_X.config where

X is the portalID that the mapping should apply to. This file needs to be placed into the folder /DesktopModules/CartViper.

The contains of this file should be as below.

xml version = " 1.0

" encoding = " utf-8 " ?>< ArrayOfMappingDefinition xmlns:xsi = " http://www.w3.org/2001/XMLSchema-instance " xmlns:xsd = " http://www.w3.org/2001/XMLSchema " >

< MappingDefinition >

< AddressInfoProperty > Address1 </ AddressInfoProperty >

< DnnProfileProperty > Street </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > Address2 </ AddressInfoProperty >

< DnnProfileProperty > Unit </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > City </ AddressInfoProperty >

< DnnProfileProperty > City </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > Region </ AddressInfoProperty >

< DnnProfileProperty > Region </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > Country </ AddressInfoProperty >

< DnnProfileProperty > Country </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > PostalCode </ AddressInfoProperty >

< DnnProfileProperty > PostalCode </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > Phone1 </ AddressInfoProperty >

< DnnProfileProperty > Telephone </ DnnProfileProperty >

</ MappingDefinition >

< MappingDefinition >

< AddressInfoProperty > Phone2 </ AddressInfoProperty >

< DnnProfileProperty > Fax </ DnnProfileProperty >

</ MappingDefinition >

</ ArrayOfMappingDefinition >

Each MappingDefinition entry defines the Cart Viper address property and the DNN profile property which will be loaded into that field.

To change the mapping you would edit the DnnProfileProperty to the name of the property which should be loaded into the Cart Viper address field.

Page | 185

Version | 3.3.0

Advanced Ecommerce for DotNetNuke

Table of Contents

Overview

Initial Install

Install Cart Viper

Upgrading a Previous Version

Cart Viper Quick Start Checklist

Initial Store Setup

Quick Setup

Manual Initial Setup

Cart Viper Modules

Cart Viper Account

Settings

Cart Viper Admin

Cart Viper Catalog

Settings

Cart Viper Events Calendar

Settings

Cart Viper Menu

Original

Vertical Mega Menu

Horizontal Mega Menu

Razor Script

Settings

Cart Viper Mini Cart

Cart Viper Newsletter Subscription

Cart Viper Product Widget

Settings

Cart Viper Recently Viewed Items

Settings

Cart Viper Search Module

Store Administration Options

Licensing

Trial Mode

License Types

Premium Add-ons

Store Info

SMTP Settings

Store Currency

Store Location

General Settings

Product Newsletter Settings

Newsletter Subscribers List

Order PDF Settings

Store Email Template

Product Comparison Settings

Google Analytics Tracking

Order Notification Call back

Pre Checkout Notification Callback

AWS Account/Azure Account

Amazon Order Message Queue

Store Units Of Measure

Payment Gateways

Checkout Interfaces

Paypal Provider (Website Payments Standard)

Paypal Pro Provider (Website Payments Pro)

Authorize.Net Provider

Points Provider

Offline Payment

First Data Provider

MultiSafePay Provider

Innovative Gateway/Merchant

Prepaid Payment Provider

Buckaroo Payment Provider

Mollie Payment Provider

Paypal Pay Flow Payment Provider

Ogone Payment Provider

CyberSource Payment Provider

PayWay Provider

QBMS Payment Gateway

Barclays EPDQ Payment Gateway

Virtual Merchant Payment Gateway

Eway Payment Gateway

WorldPay Payment Gateway

Rabo Kassa Omni Payment Gateway

Sage Pay Forms Payment Gateway

First Data Connect Payment Gateway

Tax & Vat

Tax

Canadian GST