| WebFarm-Shop 2.0 Manual |
|
Welcome to the WebFarm-Shop 2.0 Manual.
|
| Domain Settings |
Domain Name:
This is the Domain Name where WebFarm-Shop 2.0 is running; you do not need to enter 'http://' or 'www' just the Domain Name.
License Key:
You need a license key to use WebFarm-Shop 2.0, this is issued to you when you sign up for your WebFarm-Shop 2.0 account. If you do not use a valid license WebFarm-Shop 2.0 will not function.
Version:
This is the current version of WebFarm-Shop 2.0 that you are running.
|
| User Configuration |
Username:
This is the Username that you use to log into the admin system, you can change this to anything you like, if you change it you should record it somewhere so you don't forget it, as you can't login to the admin system without it.
Password:
This is the Password that you use with your "Username" to log into the admin system, you can change this to anything you like, if you change it you should record it somewhere so you don't forget it, as you can't login to the admin system without it.
|
| Basic Configuration |
Basket timeout:
This is the time in seconds that data will remain in the baskets database, this is usually set to '3600' (1 hour), so if a customer adds products to the shopping baskets and decides to leave the site and not purchase the goods, the data will stay there for 3600 seconds and then be deleted. If you find that your customers are losing items from their baskets you may need to increase this to a higher value
Currency:
The store currency symbol (NZD, USD, etc) this has no effect on the actual value of the goods, it is simply placed before the dollar symbol next to the price on the viewbasket and checkout pages.
Example:
NZD $100.00 (The 'NZD' is the store currency symbol, and is placed before the dollar symbol, see below).
Dollar symbol:
The store dollar symbol ($, £, ¥, etc) this has no effect on the actual value of the goods; it is simply placed between the currency symbol and the price value on the viewbasket and checkout pages. This tells the customer that the goods are listed in the currency stated with the dollar symbol.
Example:
NZD $100.00 (The '$' is the store dollar symbol, and is placed after the currency symbol and before the price value).
Minimum order amount:
The minimum amount in dollars, eg. 100.00 that must be reached before an order can completed. You would use this if you wanted to make sure each customer ordered a certain dollar amount of goods.
Mail server: (Important)
This is the server that will handle the mail that gets sent from the system, this is usually your Domain Name, where WebFarm-Shop is running, if you are unsure you can use ' localhost ' You will want to place dummy orders to test that you have got this set correctly before you set your store live. Please check that the mail server is valid before updating the settings.
Basket Empty Message:
This message is displayed when a customer checks their baskets contents and there are no products in their basket. Example: Your shopping basket is currently empty
Thanks Message:
Message displayed when the order is complete
Example: Thank you for your order, we will contact you as soons as we ship your order ...
Look and Feel Template:
A large part of the WebFarm-Shop 2.0 customisation options, the look and feel templates allow you to easily change between colour schemes and layouts to find one that suites your store. You can also edit these templates by downloading the files within the '/WFShop2/templates/template-name/' directory. Contact support@webfarm.co.nz for more info on this.
Customer accounts/login:
This allows you to enable the customer login option. If enabled a login box is displayed before you enter the checkout process. The customer can either login, bypass, or create an account. Once an account is created it can be used each time the customer enters your store. (You can manage the accounts with the 'Customer Accounts' option). This is handy for Business-To-Business customers.
|
| Advanced Configuration |
Required field icon:
Within WebFarm-Shop 2.0 you are able to set different form variables as required, (see below) this feature allows you to choose the 'icon' to be displayed next to all required field boxes. If you don't want to display an icon you can set to blank.
Form Boxes Configuration:
Within WebFarm-Shop 2.0 you are able to set different form variables as required. These variables are used to obtain details from your customers that are required to process their orders. You can select whether you want to make any of these variables Required, Optional, or Off (not shown). When a variable is Required the 'Required field icon' (see above) will be displayed next to the form box, these boxes will be required to be entered before the customer can move onto the next step.
Delivery/Billing Address Fields:
Use this option to display either the delivery address boxes only or both delivery and billing address boxes. This is handy as you may want to give your customers the choice of having items purchased sent to a different place than that of the purchaser.
|
| Look/Feel Templates |
Installed Templates:
Installed templates lists the templates that are currently installed. The path is the directory where the template is installed (relative to /WFShop2/templates/). If you no longer need a template you can click remove and the template will be removed from the stores available templates. (It will not be deleted off the server)
Install a new Template:
Over time new templates will be designed and released, if you want to use these templates you will need to add them to the stores available templates. Installing a template will allow you to select it under the 'Basic Configuration' section. Each template has a different look giving WebFarm-Shop 2.0 more flexibility.
|
| Tax Configuration |
Installed Tax Options:
This will list the tax modules installed and show you the current status. Click on the configure button to enable/disable and customise.
Sales tax:
Use this option to enable/disable sales tax. When disabled sales tax will not be calculated or displayed.
Sales tax: - Tax/Percentage:
This allows you to enter a name and a value for your tax. The name would usually be something like 'GST' or 'VAT' and the value is a percentage, eg. 12.5 or 17.5.
|
| Shipping Configuration |
Installed Shipping Options:
This will list the shipping modules installed and show you the current status. Click on the configure button to enable/disable and customise.
Message shipping:
Use this option to enable/disable the message shipping option.
Message shipping: - Shipping Message:
Enter a message to be displayed under the shipping heading on the checkout/payment page. You might use this option if you wanted to alert the customer that you will contact them later regarding shipping.
Flat rate shipping:
Use this option to enable/disable the flat rate shipping option.
Flat rate shipping: - Shipping Region/Value:
This allows you to enter a region and a value for your shipping options. You can enter as many as you like - one per line, if you require more entries save what you have and more options will become available. The region would usually be something like 'New Zealand Wide Shipping' or 'North Island Shipping' and the value is the cost, eg, 7.50 or 10.0.
Percentage based shipping:
Use this option to enable/disable the percentage based shipping option.
Percentage based shipping: - Shipping Region/Value:
This allows you to enter a region and a percentage of scale value for your shipping options. You can enter as many as you like - one per line, if you require more entries save what you have and more options will become available. The region would usually be something like 'New Zealand Wide Shipping' or 'North Island Shipping' and the value is a percentage, eg, 7.50 or 10.0. Remember this is a percentage of the total order value, so an order of $100.00 would create a shipping value of $10.00 if the value was set to 10.0.
|
| Payment Configuration |
Installed Payment Options:
This will list the payment modules installed and show you the current status. Click on the configure button to enable/disable and customise.
Basic Credit Card Payment:
Use this option to enable/disable the basic credit card option. Exampe card number to use for testing: 4444 3333 2222 1111 and any valid expiry date.
Basic Credit Card Payment: - Card Type:
Add various credit card types, eg, Visa, MasterCard, etc. You can add as many as you like. The card types added will show in the card type drop down box on the credit card payment page.
WorldPay (Select JNR) Payment:
Use this option to enable/disable the WorldPay (Select JNR) payment option. WorldPay is a multi-currency Online Payment system provided by WebFarm. Contact worldpay@webfarm.co.nz for more info.
WorldPay (Select JNR) Payment: - WorldPay Call back file:
For orders to be completed correctly WorldPay needs to pass payment info back to WebFarm-Shop 2.0. There is a file called 'resultY.html' in the /WFShop2/worldpay/ folder. The file needs to be edited (change the location to your domain name) and uploaded to your WorldPay account.
Point your browser here: https://select.worldpay.com/wcc/admin
1. Login to your WorldPay CMS admin.
2. Find the Select JNR account you are using for your WebFarm-Shop 2.0 integration.
3. Click 'File Management'
4. Browse to the /WFShop2/worldpay/ directory and upload the file called 'resultY.html' (once you have edited it.)
5. Click on home.
If you are unsure how to do any of this contact WebFarm Support. You will need to send them your WorldPay CMS username and password. As well as your WorldPay InstID.
It is up to you to customize the WorldPay pages, to make them look more like your WebFarm-Shop 2.0 integration. Refer to the 'WorldPay Select JNR Manual' for more information on how to do this.
WorldPay (Select JNR) Payment: - Install ID:
When you sign up with WorldPay you are set-up with a integration ID (InstID) this ID tells WorldPay what account to use, and where the transaction dollars should go, see your WorldPay manual for more info.
WorldPay (Select JNR) Payment: - Test Mode:
WorldPay can run in 'test mode' or 'live mode', test will accept all cards, no money changes hands, 'live mode' will only accept real valid cards, and money will change hands, see the WorldPay manual for more info. Note: WorldPay need to set your InstID live before you can place orders in 'live mode' See your WorldPay manual for more info.
WorldPay (Select JNR) Payment: - Currency:
This is the currency that WorldPay will display your order in, this is also the currency that the transaction will take place in unless the customer changes this to their choice on the WorldPay server.
WorldPay (Select JNR) Payment: - Line Item Message:
This is the line item message displayed on the WorldPay server, line item for the products you are selling, eg. 'Total for your order'
Cheque Payment:
Use this option to enable/disable the cheque payment option. The cheque payment option allows a total to be generated for the order. You would then need to await receipt of cheque to fill the order.
Cheque Payment: - Length:
Set the min and max length of a cheque number. WebFarm-Shop 2.0 will make sure that the numbers entered by a customer will fit within the length provided.
Account Payment:
Use this option to enable/disable the account payment option. Account payment is very simple, the customer is required to enter a reference for the order. The total order amount is manually (bank transfer) paid into the merchant account using the same reference, the merchant can then match the payment and fill the order.
|
| Download Configuration |
If you have products that can be downloaded, ie ebooks, then this option is for you. WebFarm-Shop 2.0 allows your customers to purchase downloadable products. WebFarm-Shop 2.0 and will send the customer an email with a link to the download area, from which the customer can downlaod the products purchased.
Expire time:
This is the time that the URL sent in the thank you message will remain valid, the time allowed for the customer to download the product, this is a global setting and is set for all orders that have been placed. This can be set to '-- Never Expire --' this will allow all Download ID's to be valid, regardless of when they were created. (does not include ID's that are not valid - or from old installs.)
Download directory:
This is the directory where all '.zip' downloadable product files are stored. You need to upload your downloadable products into this directory.
Download expired message:
Message that is displayed when the product download URL has expired.
|
| Customer Accounts |
Customer Username:
Select a username from the list to view, edit or delete that account. You are able to change the password for the account as well as all other user data.
|
| Orders/Configuration |
View Order Details:
This will list the orders and the order configuration options, as well as show you the current status or various order settings. Click on the configure button to enable/disable and customise.
View Order:
Select an order from the list to either view, process, cancel or delete.
Order Configuration:
Use this option to configure the order configuration.
Order Configuration: - Order Number Prefix:
Prefix to be displayed before the order number, leave blank for no prefix.
Order Configuration: - Order Processed Email:
Once an order is processed an automated email can be sent to the customer with a message, eg 'Thanks, your order is now processed' If you leave this box blank then no email is sent.
Order Configuration: - Order Cancelled Email:
Once an order is cancelled an email automated can be sent to the customer with a message, eg 'Sorry, your order has been cancelled' If you leave this box blank then no email is sent.
Merchant Order Notification:
Use this option to configure the merchant order configuration.
Merchant Order Notification: - To Mail:
This is the email address where new merchant order notification emails will be sent. This should be an address at the domain where WebFarm-Shop 2.0 is running, something like: orders@www.webfarm.co.nz You will want to check this address daily as this is where all order notification emails will be sent. Please check that the email address is valid before updating the settings.
Merchant Order Notification: - Merchant Order Notification Subject:
This is the subject line of merchant order notification messages sent to store owner when an order is placed. Usually: 'Web Order' (You might want to make this something simple so you can use your mail checking software to place these messages in a separate mail box, for safe keeping).
Merchant Order Notification: - Merchant Order Notification (header):
Displayed above the 'Store Order Message' email, can contain only text. eg. New Order, Order details follow:
Merchant Order Notification: - Merchant Order Notification (footer):
Displayed below the 'Store Order Message' email, can contain only text. eg. End Of Order
Customer Order Notification:
Use this option to configure the customer order configuration.
Customer Order Notification: - From Mail:
This is the email address displayed as the from (where the email has be sent from) address from all order emails. You would usually use something like: weborder@www.webfarm.co.nz so that the customer knows it has been sent by the order system, you will want to make sure you can check this email address, as customers will reply with questions and maybe additional order information. Please check that the email address is valid before updating the settings.
Customer Order Notification: - Customer Order Notification Subject:
This is the subject line of order notification messages sent to customer (customers email address) when an order is placed. Thank you - your order details !
Customer Order Notification: - Customer Order Notification (header):
Displayed above the 'Customer Order Message' email, can contain only text. eg. Thanks for your order, your order details are below:
Customer Order Notification: - Customer Order Notification (footer):
Displayed below the 'Customer Order Message' email, can contain only text. eg. Thanks, Regards, ....
|
|
|