Qualiteam Help - Recent changes [en]

X-Cart:Customizing storefront

2010-09-10T11:39:29Z

Using Webmaster mode

← Older revision		Revision as of 11:39, 10 September 2010
Line 158:		Line 158:
	==Using Webmaster mode==		==Using Webmaster mode==

-	Webmaster mode allows you to define the right template and modify it within the admin interface. You may edit language variables (denoted as "$lng.XXX" in templates) by changing those values in WYSIWYG mode.	+	{{X-Cart:Using_Webmaster_mode}}
-		+
-	1) Before entering the webmaster mode, close any template windows & label windows. Enter your admin zone, go to the 'Administration' menu, 'Webmaster mode' page. Click on 'Start webmaster mode' button.	+
-		+
-	~~2) The additional "templates" window will appear. It displays the list of templates composing a current page. You can call the template editor from this window by clicking a template.~~	+
-		+
-	3) Go to the page you want to change. To define the right template, look at the browser status line (at the page bottom). When the mouse is pointing at some text, this status line indicates the corresponding template and label.	+
-		+
-	~~4) To change a label, click on it. If the label is under a hyperlink, move the mouse over it and press "e" (Edit) on the keyboard. The label dialog will appear.~~	+
-		+
-	~~5) After you set a new label content you can~~	+
-	~~(a)preview the site with the changed label,~~	+
-	~~(b)save the text in the database, and~~	+
-	~~(c)copy the label name into the clipboard (IE only).~~	+
-		+
-	~~6) The webmaster mode is based on sessions~~: it applies only to the computer it has been set up on. I.e., when the 'Webmaster mode' is launched, it isn't displayed at the customer's end and doesn't affect the store performance. The changes will show up only after the admin clicks on 'save' button.	+
-		+
-	~~7) To quit the webmaster mode, go to admin zone, to the 'Administration' menu, 'Webmaster mode' page. Click on "Quit webmaster mode" button.~~	+
-		+
-	~~<div class="note">~~	+
-	~~'''NOTE''': Webmaster mode will not work with compiled templates.~~	+
-	~~</div>~~	+

	==FAQ==		==FAQ==

X-Cart:FAQs

2010-09-10T11:38:49Z

How to work with 'webmaster mode'?

← Older revision		Revision as of 11:38, 10 September 2010
Line 434:		Line 434:
	===How to work with 'webmaster mode'?===		===How to work with 'webmaster mode'?===

-	~~Webmaster mode allows you to edit templates within the admin interface. You may edit language variables (denoted as "$lng.XXX" in templates) by changing those values in WYSIWYG mode.~~	+	{{X-Cart:Using_Webmaster_mode}}
-		+
-	~~1) Before entering webmaster mode, close any template windows & label windows. Enter your admin zone, go to the 'Administration' menu, 'Webmaster mode' page. Click on 'Start webmaster mode' button.~~	+
-		+
-	~~2) The additional "templates" window will appear. It displays the list of templates composing a current page. You can call the template editor from this window by clicking a template.~~	+
-		+
-	3) Go to the page you want to change. To define the right template, look at the browser status line (at the page bottom). When the mouse is pointing at some text, this status line indicates the corresponding template and label.	+
-		+
-	~~4) To change a label, click on it. If the label is under a hyperlink, move the mouse over it and press "e" (Edit) on the keyboard. The label dialog will appear.~~	+
-		+
-	~~5) After you set a new label content you can~~	+
-	~~(a)preview the site with the changed label,~~	+
-	~~(b)save the text in the database, and~~	+
-	~~(c)copy the label name into the clipboard (IE only).~~	+
-		+
-	~~6) The webmaster mode is based on sessions~~: it applies only to the computer it has been set up on. I.e., when the 'Webmaster mode' is launched, it isn't displayed at the customer's end and doesn't affect the store performance. The changes will show up only after the admin clicks on 'save' button.	+
-		+
-	~~7) To quit the webmaster mode, go to admin zone, to the 'Administration' menu, 'Webmaster mode' page. Click on "Quit webmaster mode" button.~~	+
-		+
-	~~<div class="note">~~	+
-	~~NOTE: Webmaster mode will not work with compiled templates.~~	+
-	~~</div>~~	+

	===How to mark up all our product prices at once?===		===How to mark up all our product prices at once?===

X-Cart:Using Webmaster mode

2010-09-10T11:37:37Z

Created page with 'Webmaster mode allows you to edit templates within the admin interface. You may edit language variables (denoted as "$lng.XXX" in templates) by changing those values in WYSIWYG m…'

New page

Webmaster mode allows you to edit templates within the admin interface. You may edit language variables (denoted as "$lng.XXX" in templates) by changing those values in WYSIWYG mode.

1) Before entering the webmaster mode, close any template windows & label windows. Enter your admin zone, go to the 'Administration' menu, 'Webmaster mode' page. Click on 'Start webmaster mode' button.

2) The additional "templates" window will appear. It displays the list of templates composing a current page. You can call the template editor from this window by clicking a template.

3) Go to the page you want to change. To define the right template, look at the browser status line (at the page bottom). When the mouse is pointing at some text, this status line indicates the corresponding template and label.

4) To change a label, click on it. If the label is under a hyperlink, move the mouse over it and press "e" (Edit) on the keyboard. The label dialog will appear.

5) After you set a new label content you can
:(a) preview the site with the changed label,
:(b) save the text in the database, and
:(c) copy the label name into the clipboard (IE only).

6) The webmaster mode is based on sessions: it applies only to the computer it has been set up on. I.e., when the 'Webmaster mode' is launched, it isn't displayed at the customer's end and doesn't affect the store performance. The changes will show up only after the admin clicks on 'save' button.

7) To quit the webmaster mode, go to admin zone, to the 'Administration' menu, 'Webmaster mode' page. Click on "Quit webmaster mode" button.

{{Note|Note:Webmaster mode will not work with compiled templates.}}

For additional information about Webmaster mode please refer to [[X-Cart:Customizing_Text_Labels#Using_Webmaster_Mode | this article]].

[[Category:X-Cart user manual]]

X-Cart:Customizing storefront

2010-09-10T11:34:28Z

Templates structure

← Older revision		Revision as of 11:34, 10 September 2010
Line 49:		Line 49:
	* <u>customer/main/products_t.tpl</u> - controls the products display under a category for a multi-column layout (if your setting in General Settings/Appearance options has a number in it)		* <u>customer/main/products_t.tpl</u> - controls the products display under a category for a multi-column layout (if your setting in General Settings/Appearance options has a number in it)
	* <u>customer/main/product.tpl</u> - the product detail page		* <u>customer/main/product.tpl</u> - the product detail page
-	* <u>customer/main/order_message.tpl</u> - the confirmation screen for checkout. Where you would place tracking conversion codes (Google AdWords, Yahoo, etc)<	+	* <u>customer/main/order_message.tpl</u> - the confirmation screen for checkout. Where you would place tracking conversion codes (Google AdWords, Yahoo, etc)
		+
		+	For additional information please refer to: [[X-Cart:Editing_Skin_Files#Overview_of_Templates \| Overview of Templates]].

	===General template editing notes===		===General template editing notes===

X-Cart:Customizing Text Labels

2010-09-10T11:32:45Z

Using Webmaster Mode

← Older revision		Revision as of 11:32, 10 September 2010
Line 117:		Line 117:
	Other browsers may support Webmaster mode, but we cannot guarantee it as thorough testing has not been carried out.		Other browsers may support Webmaster mode, but we cannot guarantee it as thorough testing has not been carried out.

-	{{Note1\|Important: Webmaster mode cannot be used in stores where a compilation of templates was done (For details on template compilation, see the chapter [[#~~Using Template Editor~~]]).}}	+	{{Note1\|Important: Webmaster mode cannot be used in stores where a compilation of templates was done (For details on template compilation, see the chapter [[X-Cart:Editing_Skin_Files#Compiling_templates \| Compiling templates]]).}}

	===Starting Webmaster mode===		===Starting Webmaster mode===

X-Cart:UPS OnLine Tools

2010-09-10T11:29:16Z

The administartor is logged out when registering at UPS Online Tools

← Older revision		Revision as of 11:29, 10 September 2010
Line 106:		Line 106:

	==Troubleshooting==		==Troubleshooting==
		+
		+	===UPS not showing up as a shipping option for customers during checkout===
		+
		+	1) Try to re-register UPS Online Tools in your X-Cart admin back-end, as described in the [[X-Cart:UPS_OnLine_Tools#Enabling_and_Configuring_.27UPS_Online.C2.AE_Tools.27 \| Enabling and Configuring 'UPS Online® Tools']] section, step 3.
		+
		+	2) Apply the following SQL patch ([[X-Cart:Applying_Patches#Applying_SQL_Patches \| wonder how to apply SQL patches?]]):
		+
		+	<pre>
		+	DELETE FROM xcart_shipping_cache;
		+	</pre>
		+
		+	If the problem still persists, please contact our tech support for assistance.

	===The administartor is logged out when registering at UPS Online Tools===		===The administartor is logged out when registering at UPS Online Tools===

X-Cart:User manual contents

2010-09-10T11:26:36Z

Modules

← Older revision		Revision as of 11:26, 10 September 2010
Line 260:		Line 260:
	* [[X-Cart:Stop List\|Stop List]]		* [[X-Cart:Stop List\|Stop List]]
	* [[X-Cart:Special Offers\|Special Offers]]		* [[X-Cart:Special Offers\|Special Offers]]
-	* [[X-Cart:Subscriptions\|Subscriptions]]	+	* [[X-Cart:Subscriptions\|Subscriptions]] (For versions before X-Cart 4.4 only!)
	* [[X-Cart:Survey\|Survey]]		* [[X-Cart:Survey\|Survey]]
	* [[X-Cart:UPS OnLine Tools\|UPS OnLine Tools]]		* [[X-Cart:UPS OnLine Tools\|UPS OnLine Tools]]

X-Cart:Subscriptions

2010-09-10T11:25:53Z

← Older revision		Revision as of 11:25, 10 September 2010
Line 1:		Line 1:
		+	{{XC_4.3}}
		+
		+	{{Note1\|IMPORTANT! <br/>The Subscriptions module is available only for X-Cart versions before 4.4.}}
	== What Subscriptions module does ==		== What Subscriptions module does ==

X-Payments:PA-DSS implementation guide

2010-09-10T11:24:56Z

Audit trails

← Older revision		Revision as of 11:24, 10 September 2010
Line 168:		Line 168:
	The following types of activity are logged:		The following types of activity are logged:

-	* ~~Authentication events. The logs include user identity, date~~ and ~~time~~ of the ~~action~~ and ~~its type~~, ~~success or failure indication~~ and ~~IP address of~~ the ~~user (PCI-DSS requirement 10~~.3).	+	* All actions taken by any individual with root or administrative privileges
-	* ~~Errors~~ of ~~all kinds.~~	+	* Successes and failures of all individual accesses to application sections and functions
		+
		+	* Initialization of the audit logs
		+	* User sign in and sign out.
		+
		+	Individual access to cardholder data is not logged, because cardholder data is not stored before and after authentication. Access to audit trails must be provided on the operating system level. Audit trails are written to the file system, to files access.log and error.log.
		+
		+	Each log event includes:
		+
		+	* Type of event
		+	* Date and time of event
		+	* Username and IP address
		+	* Success or failure indication
		+	* Action which led to the event
		+
		+	* Component which led to the event

	There is also a meta-log which contains information about other log files being created.		There is also a meta-log which contains information about other log files being created.

X-Cart:Shipping Settings

2010-09-10T10:05:53Z

How to set up: shipping cost for 1-4 items e.g. $3.00, and then any additional item e.g. +$1.10?

← Older revision		Revision as of 10:05, 10 September 2010
Line 432:		Line 432:

	If you are using methods of the second group, getting the ‘no shipping methods’ error means the settings of your real-time shipping methods are incorrect.		If you are using methods of the second group, getting the ‘no shipping methods’ error means the settings of your real-time shipping methods are incorrect.
		+
		+	==FAQ==
		+
		+	===How to set up: shipping cost for one item e.g. $2.49, and then any additional e.g. +$1.99?===
		+
		+	You should set up your shipping charges as follows:
		+
		+	<u>Flat charge</u>: 0.50 (calculated as $2.49 - $1.99)
		+	<u>Per item charge</u>: 1.99
		+
		+	[screen shot goes here]
		+
		+	{{Note1\|Note: Both charges should be specified for the same shipping rule}}
		+
		+	In this case the shipping cost will be calculated as follows:
		+
		+	<u>1 item</u>: 0.5 + (1.99 * 1) = 2.49
		+	<u>2 items</u>: 0.5 + (1.99 * 2) = 4.48
		+	<u>3 items</u>: 0.5 + (1.99 * 3) = 6.47
		+	etc.

	===How to set up: shipping cost for 1-4 items e.g. $3.00, and then any additional item e.g. +$1.10?===		===How to set up: shipping cost for 1-4 items e.g. $3.00, and then any additional item e.g. +$1.10?===

X-Cart:Google Checkout

2010-09-10T09:53:04Z

Adjusting the settings that will enable your store to accept callbacks from Google Checkout

← Older revision		Revision as of 09:53, 10 September 2010
Line 145:		Line 145:
	=== Adjusting the settings that will enable your store to accept callbacks from Google Checkout ===		=== Adjusting the settings that will enable your store to accept callbacks from Google Checkout ===

-	When processing orders, Google Checkout and X-Cart exchange data in the form of various notifications and messages. To enable your store to receive notifications and other callbacks from Google, you need to provide Google with an HTTPS API callback URL (an HTTP URL may be used for Test mode). An API callback URL tells Google Checkout where to send notifications about new orders, order state changes, and other events. Your API callback URL needs to be entered into the field 'API callback URL' in your Google Checkout merchant account ('Settings' tab->'Integration'). The URL that you need to specify needs to point to the script <u>payment/ps_gcheckout.php</u>.	+	When processing orders, Google Checkout and X-Cart exchange data in the form of various notifications and messages. To enable your store to receive notifications and other callbacks from Google, you need to provide Google with an HTTPS API callback URL (an HTTP URL may be used for Test mode). API callback URL tells Google Checkout where to send notifications about new orders, order state changes, and other events.
		+
		+	Your API callback URL needs to be entered into the field 'API callback URL' in your Google Checkout merchant account ('Settings' tab->'Integration'). The URL that you need to specify needs to point to the script <u>payment/ps_gcheckout.php</u>.

	{{Note1\|Note: A URL pointing to the location of the payment/ps_gcheckout.php script in your store is provided on the General settings/Modules options->Google Checkout options page in the Admin area.}}		{{Note1\|Note: A URL pointing to the location of the payment/ps_gcheckout.php script in your store is provided on the General settings/Modules options->Google Checkout options page in the Admin area.}}

-	Your API callback URL needs to be secured by SSL v3 or TLS using a valid certificate from a major Certifying Authority. Please note that the certificate being used needs to be signed: Google Checkout does not trust unsigned certificates~~, so if~~ the certificate used at your site is not signed, your store will not be able to receive any messages or notifications from Google Checkout, so the module will not be able to function correctly.	+	Your API callback URL needs to be secured by SSL v3 or TLS using a valid certificate from a major Certifying Authority. Please note that the certificate being used needs to be signed: Google Checkout does not trust unsigned (or self-signed) certificates. If the certificate used at your site is not signed (or self-signed), your store will not be able to receive any messages or notifications from Google Checkout, so the module will not be able to function correctly.

	Please also note that, for Live mode, you need to provide HTTP authentication for access to the script payment/ps_gcheckout.php, for example, an .htaccess file if you are using Apache web server. According to http://code.google.com/apis/checkout/developer/index.html#security_precautions it only accepts messages that are authenticated by HTTP Basic Authentication, using your Merchant ID and Merchant Key as the username and password.		Please also note that, for Live mode, you need to provide HTTP authentication for access to the script payment/ps_gcheckout.php, for example, an .htaccess file if you are using Apache web server. According to http://code.google.com/apis/checkout/developer/index.html#security_precautions it only accepts messages that are authenticated by HTTP Basic Authentication, using your Merchant ID and Merchant Key as the username and password.

X-Cart:Special Offers

2010-09-10T09:48:20Z

Promo texts

← Older revision		Revision as of 09:48, 10 September 2010
Line 380:		Line 380:
	4. Create a detailed description of the offer for use in a promo block, which will be shown on the cart page, if the offer applies. To do so enter the necessary offer info into the ‘Checkout promo’ field. You can use either plain or HTML-formatted text. If you need to include images, create links to them using the href attribute. To save the changes, click on '''Update'''.		4. Create a detailed description of the offer for use in a promo block, which will be shown on the cart page, if the offer applies. To do so enter the necessary offer info into the ‘Checkout promo’ field. You can use either plain or HTML-formatted text. If you need to include images, create links to them using the href attribute. To save the changes, click on '''Update'''.

-	5. Create a detailed description of the offer for use in a promo block, which will be shown on the cart ~~page, if~~ the ~~cart~~ total ~~is below the total, for which the offer applies or the number of items is below the number, for which the offer applies~~. To do so enter the necessary offer info into the ~~‘Items~~/total ~~promo’~~ field. You can use either plain or HTML-formatted text. If you need to include images, create links to them using the href attribute. To save the changes, click on '''Update'''~~. The conditions for displaying this promo text are defined in the "Conditions -> Products" ("Promote") è "Conditions -> Amount" sections respectively~~.	+	5. Create a detailed description of the offer for use in a promo block, which will be shown on the cart and product pages on specific conditions (see the information about ‘<u>Items/total promo</u>’ provided above). To do so enter the necessary offer info into the ‘<u>Items/total promo</u>’ field. You can use either plain or HTML-formatted text. If you need to include images, create links to them using the href attribute. To save the changes, click '''Update'''.

	{{Note1\|Note. If you want to create promo blocks in languages other than the default store language, choose the necessary language from the drop-down box in the top right corner of the ‘Promo texts’ section, enter the text in that language into the ‘Short promo’ and ‘Detailed promo’ fields and click on Update.}}		{{Note1\|Note. If you want to create promo blocks in languages other than the default store language, choose the necessary language from the drop-down box in the top right corner of the ‘Promo texts’ section, enter the text in that language into the ‘Short promo’ and ‘Detailed promo’ fields and click on Update.}}

Using your Qualiteam Account

2010-09-10T09:43:22Z

Communication center

← Older revision		Revision as of 09:43, 10 September 2010
(One intermediate revision not shown)
Line 7:		Line 7:
	This section enables you to communicate to Qualiteam staff by submitting inquiries (tickets).		This section enables you to communicate to Qualiteam staff by submitting inquiries (tickets).

-	~~'''~~Tickets "life cycle"~~'''~~	+	====Tickets "life cycle"====

	# You submit a support ticket with your question. Our dispatchers classify the request and rate it or forward to a necessary department,		# You submit a support ticket with your question. Our dispatchers classify the request and rate it or forward to a necessary department,
Line 63:		Line 63:
	This checkbox allows you to set your ticket to the highest priority, i.e. to be processed out of turn. This service is called HotRush support. If you want to get an urgent assistance tick the "HotRush" box when creating a new ticket or modifying ticket properties.		This checkbox allows you to set your ticket to the highest priority, i.e. to be processed out of turn. This service is called HotRush support. If you want to get an urgent assistance tick the "HotRush" box when creating a new ticket or modifying ticket properties.

-	'''~~Recommendations~~'''	+	'''f. How to rate a ticket?'''
		+
		+	The ticket rate is used to track your experience working with our staff. It allows us to improve the service quality based on customer feedback and to guarantee customer satisfaction.
		+
		+	Only closed tickets can be rated. Thus to rate a ticket you should close it first.
		+
		+	Once the ticket is closed click on the "Rate us" link next to the ticket name in the "Rate a ticket" column and follow the instructions.
		+
		+	====Recommendations====

	Below is a guide to help things run smoother. By following these recommendations you will facilitate usage of your personal message board and save your time and money.		Below is a guide to help things run smoother. By following these recommendations you will facilitate usage of your personal message board and save your time and money.
Line 87:		Line 95:

	* All the notifications on messages posted in the communication center are sent to the email address you indicated upon registration. Please, keep it in mind while waiting for an answer and (what is more important) when you decide to change your contacts. You should notify us beforehand or you can change your contact email using 'Profiles' -> 'Edit self-profile' section of your {{QA}}.		* All the notifications on messages posted in the communication center are sent to the email address you indicated upon registration. Please, keep it in mind while waiting for an answer and (what is more important) when you decide to change your contacts. You should notify us beforehand or you can change your contact email using 'Profiles' -> 'Edit self-profile' section of your {{QA}}.
		+
		+	'''How to hide closed messages from the Communication index?'''
		+
		+	In order to reduce the number of tickets shown in the communication index, you should select the "Hide closed and rated tickets" option. It will hide all the closed and rated tickets from the Communication index. This way only open tickets will be shown in the index.

	===File area===		===File area===

X-Payments:System requirements

2010-09-10T09:40:18Z

PHP configuration

← Older revision		Revision as of 09:40, 10 September 2010
(2 intermediate revisions not shown)
Line 30:		Line 30:

	* PCRE;		* PCRE;
		+	* HASH;
	* PDO with the MySQL driver;		* PDO with the MySQL driver;
	* mcrypt; (To encrypt general data through the AES encryption algorithm)		* mcrypt; (To encrypt general data through the AES encryption algorithm)
Line 35:		Line 36:
	* cURL; (To send secure HTTPS requests)		* cURL; (To send secure HTTPS requests)
	* OpenSSL. (To encrypt cardholder data and API requests)		* OpenSSL. (To encrypt cardholder data and API requests)
		+

	'''Miscellaneous:'''		'''Miscellaneous:'''

X-Cart:Backup and Restore

2010-09-10T08:55:44Z

Overview

← Older revision		Revision as of 08:55, 10 September 2010
Line 9:		Line 9:
	For detailed instructions on how to handle store backups and carry out specific tasks, please refer to the following sections later in this chapter:		For detailed instructions on how to handle store backups and carry out specific tasks, please refer to the following sections later in this chapter:

-	* [[#Backing up the Store]]	+	* [[#Backing up the Store \| Backing up the Store]]
-	* [[#Restoring the Store from a Backup]]	+	* [[#Restoring the Store from a Backup \| Restoring the Store from a Backup]]
-	* [[#Safety Tips]]	+	* [[#Safety Tips \| Safety Tips]]
-	* [[#Troubleshooting]]	+	* [[#Troubleshooting \| Troubleshooting]]

	Remember that making a backup copy of a store and restoring the store from the backup are rather complicated tasks, which may become associated with a series of difficulties or even involve unpredictable effects. This document only provides a general description of the backup and restore procedures, and it does not intend to cover all types of situations that can occur while you back up or restore your store.		Remember that making a backup copy of a store and restoring the store from the backup are rather complicated tasks, which may become associated with a series of difficulties or even involve unpredictable effects. This document only provides a general description of the backup and restore procedures, and it does not intend to cover all types of situations that can occur while you back up or restore your store.

X-Cart:Upgrading X-Cart

2010-09-10T08:29:04Z

Created page with '== Introduction == The X-Cart team regularly improves and updates the X-Cart shopping cart by releasing new software versions and branches. With each new release, X-Cart gains …'

New page

== Introduction ==

The X-Cart team regularly improves and updates the X-Cart shopping cart by releasing new software versions and branches. With each new release, X-Cart gains a series of fixes and advances that make the software even more powerful, efficient and secure. Some of these improvements only fine-tune the existing X-Cart behavior, but other change it dramatically by introducing new features and opportunities, affecting the software hard core, database structure and user interfaces. And it seems quite natural that at some point you may decide to upgrade your store to the latest version so that to be able to use all the advantages of newer releases.

Specially for those store owners who already use earlier X-Cart versions and want to upgrade their stores, together with new software versions we release special upgrade packs that allow store owners to iron differences between their existing copies of X-Cart and the latest X-Cart versions. Both the new releases and the upgrade packs are available for download to registered X-Cart license owners through their personal Help Desk accounts at [https://secure.qtmsoft.com/ https://secure.qtmsoft.com] .

Follow these stages to upgrade an X-Cart based store:

* [[X-Cart:Before_the_upgrade | Consider the environment and make a development copy of your store]]
* [[X-Cart:Upgrading_the_store | Upgrade the store]]
* [[X-Cart:After_the_upgrade | Complete post-upgrade tasks]]

== Understanding X-Cart upgrade procedure ==

In order to understand the X-Cart upgrade procedure you should first have a look at the X-Cart version numbering scheme, which is determined by the current software architecture. X-Cart uses the sequence-based software versioning scheme of three-sequence identifiers like 4.2.2 or 4.3.1. In the sequence, the first two numbers mean the major X-Cart version, which is commonly referred to as a branch, and the third number means the minor X-Cart version, the software version within a branch. The major version numbers get increased when there has been a significant revision of the software functionality, behavior and template structure while the minor version number is incremented when only minor features and significant fixes have been added to the software but the overall software structure and behavior have remained untouched. This stipulates two different approaches to the upgrade depending on whether you upgrade to a later minor version within one branch or to a later major version (branch).

== Upgrading to a later minor version ==

When you upgrade the store to a later minor version within one branch (for example, from X-Cart 4.2.1 to X-Cart 4.2.2), you can smoothly upgrade the default software code, database and design. In order to upgrade the store you will need to apply an upgrade pack - a set of patch files - that will iron out the differences between your copy of X-Cart and the X-Cart version to which you upgrade. The packs are applied automatically through a special section of the X-Cart Admin area.

Nonetheless this task can become a more complicated one if you upgrade the store within one of the earlier branches like 3.5.x or 4.0.x as there may be no direct pack to upgrade from a given version of the store to the required version, and you will need to successively apply several upgrade packs until you upgrade the required version then. For example, if the current version of your store is X-Cart 4.0.6 and you want to upgrade to X-Cart 4.0.19, the latest version within the branch 4.0.x, first you will need to upgrade to version 4.0.17, then from version 4.0.17 to version 4.0.18, and eventually you will be able to upgrade to version 4.0.19. Besides, you will need to re-install the skin template and the add-on modules, if you use any.

Important: Take note that if your store utilizes some custom code or has serious design changes, the files and database tables that were modified within a custom development project will be skipped or updated partially, which is likely to damage the custom functionality and design, and even affect the default X-Cart functionality. If you are not sure whether the custom functionality and design will remain intact after the upgrade, consult the X-Cart Support team (see section [[X-Cart:Getting_Help Getting Help]).

== Upgrading to a later major version (branch) ==

When you upgrade your store to a later major version (e.g. from X-Cart 4.2.x to X-Cart 4.3.x), you can only upgrade the default store database, but you will need to install a fresh copy of X-Cart and point it to the upgraded database. This approach is conditioned by the X-Cart architecture that changes significantly with every new branch leaving no technical feasibility to upgrade the software code and design automatically.

In order to upgrade the database, you need to run a special script that will convert the data in the database so that it could be used with a particular X-Cart version to which you upgrade the store. For convenience, a particular database structure is referred to in accordance with the X-Cart version that the database is compatible with. For example, the database version 4.2.1 means that the database can be used with X-Cart version 4.2.1.

Frustratingly, the set of available upgrade scripts is rather limited, and there may be no upgrade script that can convert the given database to the required one directly. In this case, you will need to convert your store database several times until you get the database that is compatible with the X-Cart version to which you upgrade your store. The list of available direct database upgrades is shown in the table below: The column on the left contains a source database version; the column on the right contains the list of direct database upgrades available for a particular source database.

{| border="1"
| Source X-Cart DB Version
| Direct X-Cart DB Upgrades
|-
| 3.5.10
| X-Cart Branch 4.0.x * 4.0.1
|-
| 3.5.12
| X-Cart Branch 4.0.x * 4.0.6
|-
| 3.5.14
| X-Cart Branch 4.0.x * 4.0.12 X-Cart Branch 4.1.x * 4.1.11 * 4.1.12
|-
| 4.0.19
| X-Cart Branch 4.1.x * 4.1.11 * 4.1.12
|-
| 4.1.11
| X-Cart Branch 4.2.x * 4.2.0
|-
| 4.1.12
| X-Cart Branch 4.2.x * 4.2.1 * 4.2.2 X-Cart Branch 4.3.x * 4.3.0
|-
| 4.2.3
| X-Cart Branch 4.3.x * 4.3.0
|}

In the situation when you have to to upgrade the database several times, it is recommended that you follow these simple rules:

* When you have to upgrade within a branch, carry out the in-branch upgrade on a more recent branch, if there is an alternative.

The upgrade engine improves with each new X-Cart release, and the upgrade on a more recent branch keeps a risk of a failure or mistake to a minimum. For example, when you upgrade the database for X-Cart 4.1.11 to the database for X-Cart 4.2.2 the two alternatives are as follows:

{| border="1"
| '''(A)''' 4.1.11 -> 4.2.1 -> 4.2.2
| '''(B)''' 4.1.11 -> 4.1.12 -> 4.2.2
|}

(A) is the recommended alternative as the in-branch upgrade is carried out on a more recent branch X-Cart 4.2.x.

[[Image:Pic_1.png|460px|center]]

* When you need to leap over a branch (e.g. from X-Cart 4.1.x to X-Cart 4.3.x), minimize the number of branch-to-branch upgrades.

With a branch-to-branch upgrade the data in the database is converted, which theoretically increases a possibility of a fault or data loss. For example, when you upgrade the database for X-Cart 4.1.11 to the database for X-Cart 4.3.0 the two alternatives are as follows:

{| border="1"
| '''(A)''' 4.1.11 -> 4.1.12 -> 4.3.0
| '''(B)''' 4.1.11 -> 4.2.1 -> 4.3.0
|}

(A) is the recommended alternative as it supposes only one branch-to-branch upgrade while the (B) alternative supposes two branch-to-branch upgrades.

[[Image:Pic_2.png|460px|center]]

{{Note1|Important: You must be aware that with the upgrade to a later major version it is impossible to transfer the custom code and design automatically. So if you use any in your store, you will need to re-implement the custom code and design after the upgrade, which is rather a resource-consuming task that requires adequate experience in PHP, HTML and MySQL.}}

==Associated Difficulties==

New releases not only enrich the software with new features and capabilities, but they get rid of obsolete elements and techniques that are no longer in great demand. But you may have gotten used to the current logics and behavior of the X-Cart version that you use; or you may extensively use the elements that are not supported in later X-Cart releases. In such a situation, the upgrade may involve extra inconvenience. It is recommended that you study the CHANGELOG, which is updated with each new release and is included into every distribution package. The CHANGELOG provides a complete list of fixes and improvements that were introduced to a new X-Cart release.

Another critical issue about the upgrades is that seamless upgrade is only possible if the store uses a default database and template structure, and has only minor changes like its own store logo and similar. Yet, if the store has serious design changes or it utilizes some custom code and third-party add-on modules that interfere with the original software behavior, '''you will need to re-implement custom code and design after the upgrade''', which requires adequate experience in PHP, HTML and MySQL. So, if you use some custom functionality, find out if it is possible to keep it after the upgrade.

On the whole, upgrading X-Cart is a resource-consuming task, which demands that you understand what you are going to do and why. The rule here is not to upgrade to a newer version if there is no need to do this and you are satisfied with how the store works at the moment.

If you decide that your store needs to be upgraded, be honest when estimating your abilities: If you are not sure you have enough resources to perform this task on your own, do not start it. Leave it to professional engineers, and it will save your time, money and nerves.

==See also==

* [[X-Cart:Before_the_upgrade | Before the upgrade]]
* [[X-Cart:Upgrading_the_store | Upgrading the store]]
* [[X-Cart:After_the_upgrade | After the upgrade]]
* [[X-Cart:Upgrade:Troubleshooting | Troubleshooting]]

[[Category:X-Cart user manual]]

X-Cart:Before the upgrade

2010-09-10T07:56:09Z

Created page with ' Before you start upgrading your store, first you should consider the development environment in which you will carry out the upgrade. The two alternatives here are to upgrade t…'

New page

Before you start upgrading your store, first you should consider the development environment in which you will carry out the upgrade. The two alternatives here are to upgrade the store on a local server or on a remote server. Both options have their pros and cons, which are described in the section [[#Considering the Environment | Considering the Environment]]. Please examine this section thoughtfully and consider which of the two options meets your preferences and capabilities best.

Whichever option you choose, you must never carry out the upgrade on a live store, but you should use a development copy instead. For instructions and recommendation on how to create and use a development copy of the store, refer to the section [[#Making a Development Copy | Making a Development Copy]] further in this document.

==Considering the Environment==

The upgrade can be carried out on a local server or on a remote server. Each of the alternatives has its advantages and disadvantages

===Local server (localhost)===

In this context, a local server means the environment where a web server and associated resources (e.g., PHP, MySQL, etc.) are installed directly on your local machine or your local network, and you do not need internet access to connect to the server.

The '''advantages''' of upgrading the store on a local server are as follows:

* You can complete the upgrade (including the post-upgrade testing ) in the offline mode without the necessity to connect to the internet.
* You can carry out the whole task with the help of your favorite tools and facilities.

The '''disadvantages''' of upgrading the store on a local server include:

* You need to install and set up a local web server together with PHP and MySQL, which requires adequate technical knowledge and experience.
* The environment on the local server is likely to be different from the one on the remote server, which can affect the upgrade and reduce the accuracy of the post-upgrade testing.
* Third-party add-on modules may stop working if they utilize the per-domain licensing scheme.

===Remote server===

A remote server means the type of environment where a web server and associated resources are installed on a remote host, and you need internet access to connect to the server. A remote server can be a dedicated or a virtual server, or a simple shared hosting account.

The '''advantages''' of upgrading the store on a local server are as follows:

* The web server together with PHP and MySQL are already up and running.
* The environment is the same as the operational environment.
* All third-party add-on modules will work correctly.

The '''disadvantages''' of upgrading the store on a remote server include:
* You need to be online all the time during the upgrade.
* You are limited to the tools and facilities supplied by your hosting provider.

==Making a Development Copy==

Under no circumstance must you ever upgrade a live store. Instead, use a development copy of the store, a store backup deployed on a local server or outside the directory on a remote server where your live store is physically located.

A development copy does not imply that you need to obtain an additional X-Cart license as the X-Cart Software License Agreement (http://www.x-cart.com/software_license_agreement.html) does not prohibit you from having a copy of the store that is used for development and testing purposes. At that, the development copy must not be accessible through the Internet, that is it must be installed on a local server or local network or be protected by password authentication.

For detailed instructions on how to make a backup copy of a store and then deploy it at a new location, refer to the section [[X-Cart:Backup_and_Restore | Backup and Restore Procedures]] earlier in this manual.

After you have upgraded the development copy, test it thoroughly as advised in the [[Post-Upgrade Checklist]] section further in this manual. When you make sure that everything works correctly, transfer the store to the live server (if you upgraded the development copy on a local computer or network) and test it on the live server as well. Then back up the existing store (both the store files and the database) and replace the live store with the one you have just upgraded.

[[Category:X-Cart user manual]]

X-Cart:Upgrading the store

2010-09-10T07:55:47Z

Created page with 'This chapter provides instructions on how to fulfill tasks involved into the upgrade process directly. The tasks include obtaining and applying upgrade packs and database upgrade…'

New page

This chapter provides instructions on how to fulfill tasks involved into the upgrade process directly. The tasks include obtaining and applying upgrade packs and database upgrades.

==Upgrading to Branch 4.3.x==

Depending on what X-Cart branch and version your store belongs to, you can upgrade the store to branch 4.3.x either directly or through a series of transitional steps (upgrades). You will probably have to deal with the second option if you do not upgrade your store regularly because every new X-Cart branch is bundled with database upgrade packs for latest minor versions for two X-Cart branches antecedent to the current branch only.

This presumes that prior to upgrading to branch 4.3.x you must fulfill the following upgrade tasks:

* If your store belongs to branch 3.5.x, successively upgrade the database to version 4.1.12.
* If your store belongs to branch 4.0.x, successively upgrade the database to version 4.1.12.
* If your store belongs to branch 4.1.x, successively upgrade X-Cart to version 4.1.12.
* If your store belongs to branch 4.2.x, successively upgrade X-Cart to version 4.2.3.

===Obtaining upgrade packs===

====Obtaining in-branch upgrade packs====

To obtain an upgrade pack to a later minor version within a branch:

'''Branch 3.5.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart supporting files for prev versions -> X-Cart 3.5 -> Upgrade kits 3.5.x branch.
# Locate an archive with the required upgrade pack. The archive must have one of the following formats:
#* [current_version]-[target_version]-gold_upgrade.tgz or [current_version]-[target_version]-gold_upgrade.zip
#* [current_version]-[target_version]-pro_upgrade.tgz or [current_version]-[target_version]-pro_upgrade.zip ''where the [current_version] part is the version of your current X-Cart installation, and the [target_version] part is the X-Cart version to which you are upgrading the store. Take note that the gold or pro part must coincide with the X-Cart edition you use: X-Cart Gold or X-Cart Pro, respectively.''
# Download the archive with the upgrade pack to your local computer.

'''Branch 4.0.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart supporting files for prev versions -> X-Cart 4.0 -> Upgrade kits 4.0.x branch.
# Locate an archive with the required upgrade pack. The archive must have one of the following formats:
#* [current_version]-[target_version]-gold_upgrade.tgz or [current_version]-[target_version]-gold_upgrade.zip
#* [current_version]-[target_version]-pro_upgrade.tgz or [current_version]-[target_version]-pro_upgrade.zip ''where the [current_version] part is the version of your current X-Cart installation, and the [target_version] part is the X-Cart version to which you want to upgrade the store. Take note that the gold or pro part must coincide with the X-Cart edition you use: X-Cart Gold or X-Cart Pro, respectively.''
# Download the archive with the upgrade pack to your local computer.

'''Branch 4.1.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and click the Get upgrade pack tab. ''This will open the section Get upgrade pack.''
# Use the controls in the Get upgrade pack section to configure the required upgrade pack:
#* License: Select an X-Cart license that is registered for the store you want to upgrade.
#* Modules (optional): Select commercial add-on modules and skin templates that you want to upgrade together with the store.
#* Free modules: Select free add-on modules and skin templates that you want to upgrade together with the store.
#* Upgrade pack: Select a pack to upgrade your store from the current version to the target version.
#* Archive type: Select the type of an archive for the configured pack.
# Click the '''Get upgrade pack''' button. ''The system will generate the upgrade pack and open a dialog box asking you what to do with the archive.''
# Select to save the archive to your local computer.

'''Branch 4.2.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and click the Get upgrade pack tab. ''This will open the section Get upgrade pack.''
# Use the controls in the Get upgrade pack section to configure the required upgrade pack:
#*License: Select an X-Cart license that is registered for the store you want to upgrade.
#* Modules (optional): Select commercial add-on modules and skin templates that you want to upgrade together with the store.
#* Free modules: Select free add-on modules and skin templates that you want to upgrade together with the store.
#* Upgrade pack: Select a pack to upgrade your store from the current version to the target version.
#* Archive type: Select the type of an archive for the configured pack.
# Click the '''Get upgrade pack''' button. ''The system will generate the upgrade pack and open a dialog box asking you what to do with the archive.''
# Select to save the archive to your local computer.

====Obtaining database upgrade scripts====

To obtain a database upgrade pack:

'''Branch 3.5.x to branch 4.1.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart supporting files for prev versions -> X-Cart 3.5 -> Upgrade kits for 3.5.x branch.
# Locate an archive with the required database upgrade script. The archive must have one of the following formats:
#* [current_version]-[target_version]_sql_upgrade.tgz
#* [current_version]-[target_version]_sql_upgrade.zip
# Download the archive with the database upgrade script to your local computer.

'''Branch 4.0.x to branch 4.1.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart supporting files for prev versions -> X-Cart 4.0 -> Upgrade kits 4.0.x branch.
# Locate an archive with the required database upgrade script. The archive must have one of the following formats:
#* [current_version]-[target_version]_sql_upgrade.tgz
#* [current_version]-[target_version]_sql_upgrade.zip
# Download the archive with the database upgrade script to your local computer.

'''Branch 4.1.x to branch 4.3.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart 4.3.0 -> DB upgrader 4.1.12->4.3.0.
# Locate an archive with the required database upgrade script. The archive must have one of the following formats:
#* [current_version]-[target_version]_sql_upgrade.tgz
#* [current_version]-[target_version]_sql_upgrade.zip
# Download the archive with the database upgrade script to your local computer.

'''Branch 4.2.x to branch 4.3.x'''

# Log in to your Help Desk account at https://secure.qtmsoft.com .
# Go to the File Area section and open the folder X-Cart -> X-Cart 4.3.0 -> DB upgrader 4.2.3->4.3.0.
# Locate an archive with the required database upgrade script. The archive must have one of the following formats:
#* [current_version]-[target_version]_sql_upgrade.tgz
#* [current_version]-[target_version]_sql_upgrade.zip
# Download the archive with the database upgrade script to your local

X-Cart:Applying Upgrade Packs

2010-09-10T07:55:07Z

Created page with '==Applying in-branch upgrade packs== To apply an upgrade pack: ===Branch 3.5.x=== 1. Obtain an upgrade pack for your version of X-Cart as described in the section [[X-Cart:Upg…'

New page

==Applying in-branch upgrade packs==

To apply an upgrade pack:

===Branch 3.5.x===

1. Obtain an upgrade pack for your version of X-Cart as described in the section [[X-Cart:Upgrading_the_store#Obtaining_upgrade_packs | Obtaining Upgrade Packs]].

Make sure the pack is intended for the source and target versions of your X-Cart installation.

2. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>

3. Make sure that the files that will be patched during the upgrade have world writable permissions. Names of the files to be patched are listed in the file <xcart_dir>/upgrade/[source-version]-[target-version]/file.lst.

If you use a UNIX-based server, to set world writable permissions to the required files you can run the following shell command

<pre>for i in `sed -e 's/,.*$//g' < upgrade/[source]-[target]/file.lst`; do chmod 666 $i ; done</pre>

replacing the [source] and [target] parts with the source and target versions of the X-Cart installation that you upgrade.

{{Note1|Important! You must run the command from the X-Cart root directory.}}

4. Log in to the X-Cart Admin area.

5. Go to the section Patch/Upgrade Center (Administration menu -> Patch/Upgrade).

You will see the Upgrade box.

6. Select the target version from the drop-down box and click the Apply button.

X-Cart will test whether the required files can be patched successfully and list the files showing their status. The file statuses mean as follows:

* OK - File can be patched successfully.
* Checksum error - Patch is corrupted. Try to download the patch again.
* Non-writable - File does not have writable permissions. Set up writable permissions to the file.
* Not a file - Target is not a file. The original X-Cart structure has been modified and you need to apply the patch manually.
* Not exists - File is missing. The original X-Cart structure has been modified and you need to apply the patch manually.
* Could not patch - Patch cannot be applied to the file automatically as the original X-Cart structure has been modified and you need to apply the patch manually.
* Already patched - File has been patched already.

7. Click the '''Apply patch''' button at the bottom of the page.

X-Cart will start patching the files. When the patch is applied, X-Cart will display the list of patched files and a detailed report about what changes has been made.

8. Click the '''Finish''' button at the bottom of the page.

===Branch 4.0.x===

1. Obtain an upgrade pack for your version of X-Cart as described in the section Obtaining Upgrade Packs earlier in this chapter.

Make sure the pack is intended for the source and target versions of your X-Cart installation.

2. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename></pre>

3. Make sure that the files that will be patched during the upgrade have world writable permissions. Names of the files to be patched are listed in the file <xcart_dir>/upgrade/[source-version]-[target-version]/file.lst.

If you use a UNIX-based server, to set world writable permissions to the required files you can run the following shell command

<pre>for i in `sed -e 's/,.*$//g' < upgrade/[source]-[target]/file.lst`; do chmod 666 $i ; done</pre>

replacing the [source] and [target] parts with the source and target versions of the X-Cart installation that you upgrade.

{{Note1|Important! You must run the command from the X-Cart root directory.}}

4. Log in to the X-Cart Admin area.

5. Go to the section Patch/Upgrade Center (Administration menu -> Patch/Upgrade).

You will see the Upgrade box.

6. Select the target version from the drop-down box and click the Apply button.

X-Cart will test whether the required files can be patched successfully and list the files showing their status. The file statuses mean as follows:

* OK - File can be patched successfully.
* Checksum error - Patch is corrupted. Try to download the patch again.
* Non-writable - File does not have writable permissions. Set up writable permissions to the file.
* Not a file - Target is not a file. The original X-Cart structure has been modified and you need to apply the patch manually.
* Not exists - File is missing. The original X-Cart structure has been modified and you need to apply the patch manually.
* Could not patch - Patch cannot be applied to the file automatically as the original X-Cart structure has been modified and you need to apply the patch manually.
* Already patched - File has been patched already.

7. Click the '''Apply patch''' button at the bottom of the page.

X-Cart will start patching the files. When the patch is applied, X-Cart will display the list of patched files and a detailed report about what changes has been made.

8. Click the '''Finish''' button at the bottom of the page.

===Branch 4.1.x===

1. Obtain an upgrade pack for your version of X-Cart as described in the section Obtaining Upgrade Packs earlier in this chapter.

Make sure the pack is intended for the source and target versions of your X-Cart installation.

2. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename></pre>

3. Make sure that the files that will be patched during the upgrade have world writable permissions. Names of the files to be patched are listed in the file <xcart_dir>/upgrade/[source-version]-[target-version]/file.lst.

If you use a UNIX-based server, to set world writable permissions to the required files you can run the following shell command

<pre>for i in `sed -e 's/,.*$//g' < upgrade/[source]-[target]/file.lst`; do chmod 666 $i ; done</pre>

replacing the [source] and [target] parts with the source and target versions of the X-Cart installation that you upgrade.
{{Note1|Important! You must run the command from the X-Cart root directory.}}

4. Log in to the X-Cart Admin area.

5. Go to the section Patch/Upgrade Center (Administration menu -> Patch/Upgrade).

You will see the Upgrade box.

6. Select the target version from the drop-down box and click the Apply button.

X-Cart will test whether the required files can be patched successfully and list the files showing their status. The file statuses mean as follows:

* OK - File can be patched successfully.
* Checksum error - Patch is corrupted. Try to download the patch again.
* Non-writable - File does not have writable permissions. Set up writable permissions to the file.
* Not a file - Target is not a file. The original X-Cart structure has been modified and you need to apply the patch manually.
* Not exists - File is missing. The original X-Cart structure has been modified and you need to apply the patch manually.
* Could not patch - Patch cannot be applied to the file automatically as the original X-Cart structure has been modified and you need to apply the patch manually.
* Already patched - File has been patched already.

7. Click the '''Apply patch''' button at the bottom of the page.

X-Cart will start patching the files. When the patch is applied, X-Cart will display the list of patched files and a detailed report about what changes has been made.

8. Click the '''Finish''' button at the bottom of the page.

===Branch 4.2.x===

1. Obtain an upgrade pack for your version of X-Cart as described in the section Obtaining Upgrade Packs earlier in this chapter.

Make sure the pack is intended for the source and target versions of your X-Cart installation.

2. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>

3. Make sure that the files that will be patched during the upgrade have world writable permissions. Names of the files to be patched are listed in the file <xcart_dir>/upgrade/[source-version]-[target-version]/file.lst.

If you use a UNIX-based server, to set world writable permissions to the required files you can run the following shell command

<pre>for i in `sed -e 's/,.*$//g' < upgrade/[source]-[target]/file.lst`; do chmod 666 $i ; done</pre>

replacing the [source] and [target] parts with the source and target versions of the X-Cart installation that you upgrade.

{{Note1|Important! You must run the command from the X-Cart root directory.}}

4. Log in to the X-Cart Admin area.

5. Go to the section Patch/Upgrade Center (Administration menu -> Patch/Upgrade).

You will see the Upgrade box.

6. Select the target version from the drop-down box, select all the check boxes above and click the Apply button.

X-Cart will test whether the required files can be patched successfully and list the files showing their status. The file statuses mean as follows:

* OK - File can be patched successfully.
* Checksum error - Patch is corrupted. Try to download the patch again.
* Non-writable - File does not have writable permissions. Set up writable permissions to the file.
* Not a file - Target is not a file. The original X-Cart structure has been modified and you need to apply the patch manually.
* Not exists - File is missing. The original X-Cart structure has been modified and you need to apply the patch manually.
* Could not patch - Patch cannot be applied to the file automatically as the original X-Cart structure has been modified and you need to apply the patch manually.
* Already patched - File has been patched already.

7. Click the '''Apply patch''' button at the bottom of the page.

X-Cart will start patching the files. When the patch is applied, X-Cart will display the list of patched files and a detailed report about what changes has been made.

8. Click the '''Finish''' button at the bottom of the page.

==Applying database upgrade packs==

To upgrade the database:

===Branch 3.5.x to branch 4.1.x===

1. Make sure the current version of your X-Cart installation can be upgraded to the target version directly.

Consult the chart in the opening section of the chapter Upgrading X-Cart. If there is no a direct upgrade pack, you will need to upgrade to the required version through several transitional steps (upgrades).

2. Obtain the database upgrade pack as described in the section Obtaining Upgrade Packs earlier in this chapter.
3. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>

4. In a web browser, run the upgrade script <xcart_dir>/upgrade_sql.php replacing the <xcart_dir> part with the true URL of your X-Cart installation. For example, http://www.example.com/xcart/upgrade_sql.php.

The script will display the progress of the upgrade task and finally report about the results.

5. Retrieve the value of the variable $blowfish_key from the file config.php in the root directory of your existing X-Cart installation and temporarily save it somewhere on your local computer.

You will be asked to provide the Blowfish key later in order that X-Cart to decrypt the data in the upgraded database.

6. Install a fresh copy of X-Cart 4.1.x. Make sure the copy of X-Cart that you are going to install is the same as the the version of the upgraded database.

When installing X-Cart:

* If you install X-Cart to the directory on your server or hosting account where a previous version of X-Cart is located, at the first step of the installation wizard select the radio button New Installation and enter the Auth code for the existing X-Cart installation. If you do not remember the code, retrieve the value of the variable $installation_auth_code from the file <xcart_dir>/include/install.php.
* At the step Preparing to Install X-Cart Database of the installation wizard, select the check box Update config.php only and enter Blowfish key for the upgraded database.

===Branch 4.0.x to branch 4.1.x===

1. Make sure the current version of your X-Cart installation can be upgraded to the target version directly.

Consult the chart in the opening section of the chapter Upgrading X-Cart. If there is no a direct upgrade pack, you will need to upgrade to the required version through several transitional steps (upgrades).

2. Obtain the database upgrade pack as described in the section Obtaining Upgrade Packs earlier in this chapter.
3. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>

4. In a web browser, run the upgrade script <xcart_dir>/upgrade_sql.php replacing the <xcart_dir> part with the true URL of your X-Cart installation. For example, http://www.example.com/xcart/upgrade_sql.php.

The script will display the progress of the upgrade task and finally report about the results.

5. Retrieve the value of the variable $blowfish_key from the file config.php in the root directory of your existing X-Cart installation and temporarily save it somewhere on your local computer.

You will be asked to provide the Blowfish key later in order that X-Cart to decrypt the data in the upgraded database.

6. Install a fresh copy of X-Cart 4.1.x. Make sure the copy of X-Cart that you are going to install is the same as the the version of the upgraded database.

When installing X-Cart:

* If you install X-Cart to the directory on your server or hosting account where a previous version of X-Cart is located, at the first step of the installation wizard select the radio button New Installation and enter the Auth code for the existing X-Cart installation. If you do not remember the code, retrieve the value of the variable $installation_auth_code from the file <xcart_dir>/include/install.php.
* At the step Preparing to Install X-Cart Database of the installation wizard, select the check box Update config.php only and enter Blowfish key for the upgraded database.

===Branch 4.1.x to branch 4.3.x===

1. Make sure the current version of your X-Cart installation can be upgraded to the target version directly.

Consult the chart in the opening section of the chapter Upgrading X-Cart. If there is no a direct upgrade pack, you will need to upgrade to the required version through several transitional steps (upgrades).

2. Obtain the database upgrade pack as described in the section Obtaining Upgrade Packs earlier in this chapter.
3. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>

4. In a web browser, run the upgrade script <xcart_dir>/upgrade_sql.php replacing the <xcart_dir> part with the true URL of your X-Cart installation. For example, http://www.example.com/xcart/upgrade_sql.php.

5. Read the X-Cart License Agreement that has been modified since X-Cart 4.1.x and click the Proceed with Upgrade button.

The script will display the progress of the upgrade task and finally report about the results.

6. Retrieve the value of the variable $blowfish_key from the file config.php in the root directory of your existing X-Cart installation and temporarily save it somewhere on your local computer.

You will be asked to provide the Blowfish key later in order that X-Cart to decrypt the data in the upgraded database.

7. Install a fresh copy of X-Cart 4.3.x as described in the section Installing X-Cart earlier in this manual. Make sure the copy of X-Cart that you are going to install is the same as the the version of the upgraded database.

When installing X-Cart:

* If you install X-Cart to the directory on your server or hosting account where a previous version of X-Cart is located, at the first step of the installation wizard select the radio button New Installation and enter the Auth code for the existing X-Cart installation. If you do not remember the code, retrieve the value of the variable $installation_auth_code from the file <xcart_dir>/include/install.php.
* At the step Preparing to Install X-Cart Database of the installation wizard, select the check box Update config.php only and enter Blowfish key for the upgraded database.

===Branch 4.2.x to branch 4.3.x===

1. Make sure the current version of your X-Cart installation can be upgraded to the target version directly.

Consult the chart in the opening section of the chapter Upgrading X-Cart. If there is no a direct upgrade pack, you will need to upgrade to the required version through several transitional steps (upgrades).

2. Obtain the database upgrade pack as described in the section Obtaining Upgrade Packs earlier in this chapter.
3. Put the upgrade pack to the X-Cart root directory on your server or hosting account.

* If you use a Windows-based server, or a UNIX-based server without terminal access:
** Decompress the archive with the upgrade pack to a directory on your system using your favorite compression program (WinZIP or any other archiver with support for TAR files).
** Use an FTP client to upload all the files contained in the archive (retaining the directory structure) to the X-Cart root directory on your server or your hosting account.

* If you use a UNIX-based server with terminal access:
** Use an FTP client to upload the archive with the upgrade pack to the X-Cart root directory on your server or your hosting account.
** Decompress the package using the following commands.

<pre>tar -xzvf <archive_filename>
</pre>
4. In a web browser, run the upgrade script <xcart_dir>/upgrade_sql.php replacing the <xcart_dir> part with the true URL of your X-Cart installation. For example, http://www.example.com/xcart/upgrade_sql.php.

5. Read the X-Cart License Agreement that has been modified since X-Cart 4.1.x and click the Proceed with Upgrade button.

The script will display the progress of the upgrade task and finally report about the results.

6. Retrieve the value of the variable $blowfish_key from the file config.php in the root directory of your existing X-Cart installation and temporarily save it somewhere on your local computer.

You will be asked to provide the Blowfish key later in order that X-Cart to decrypt the data in the upgraded database.

7. Install a fresh copy of X-Cart 4.3.x as described in the section Installing X-Cart earlier in this manual. Make sure the copy of X-Cart that you are going to install is the same as the the version of the upgraded database.

When installing X-Cart:

* If you install X-Cart to the directory on your server or hosting account where a previous version of X-Cart is located, at the first step of the installation wizard select the radio button New Installation and enter the Auth code for the existing X-Cart installation. If you do not remember the code, retrieve the value of the variable $installation_auth_code from the file <xcart_dir>/include/install.php.
* At the step Preparing to Install X-Cart Database of the installation wizard, select the check box Update config.php only and enter Blowfish key for the upgraded database.

X-Cart:After the upgrade

2010-09-10T07:54:27Z

New page

After you have upgraded the development copy of your store, it is important to make sure that everything works correctly before your start replacing your live store with the upgraded copy. The [[X-Cart:Post-Upgrade_Checklist | Post-Upgrade Checklist]] section covers the basic X-Cart functionality and is intended to help you test most critical features.

Besides, after an upgrade it is important to carry out a number of tasks that pertain to the store maintenance (see section [[#Basic Maintenance Jobs | Basic Maintenance Jobs]]) and restore the original file permissions that were modified during the upgrade (see section [[#Restoring File Permissions | Restoring File Permissions]]).

==Basic Maintenance Jobs==

After you have upgraded the store you need to carry out some basic maintenance-related tasks, which include regenerating the Blowfish key and cleaning the template cache.

===Regenerating the Blowfish key===

To regenerate the Blowfish key:

# Log in to the X-Cart Admin area.
# Go to the the Summary section (Administration menu -> Summary).
# In the Summary section, go to the section Tools/Re-generate Blowfish encryption key.
# Click the '''Regenerate''' button.

===Cleaning the template cache===

To clean the template cache:

# Log in to the X-Cart Admin area.
# Go to the the Summary section (Administration menu -> Summary).
# In the Summary section, go to the section Tools/Clear templates cache.
# Click the '''Clean''' button.

==Restoring File Permissions==

Original file permissions get changed during an upgrade, and you need to restore them after the upgrade to ensure correct functioning of the store. The instructions below describe what permissions must be set for X-Cart files and folders. The examples are provided for the Apache web server running on a UNIX-based operating system. If you use a different bundle, please refer to the documentation for the web server and operating system you use, or contact your hosting team for help.

===General info===

The exact set of file permissions would depend on whether the scripts are run in the privileged mode or non-privileged mode. The privileged mode means that scripts are run under the user who is the owner of the files while in the non-privileged mode scripts are run under a different user. This implies two different approaches to setting up file permissions:

* In the privileged mode, permissions must be granted to the owner of the files only as the scripts run under that user. Permissions for the members of the files' group and other users must be disabled then.
* In the non-privileged mode, permissions must be granted to the owner of the files, members of the files' group and other users who are not the owner of the file or members of the group.

On the Apache web server running on a UNIX-based operating system you can find out the current mode by running in a web browser the PHP script below. The script will display two user names: the name of the script owner who put the files to the server through FTP or SSH, and the name of the user who runs the scripts. If the two names coincide, the privileged mode is enabled; otherwise, you work in the non-privileged mode.

<pre>
<?php

$processUser = posix_getpwuid(posix_geteuid());

print get_current_user() . " / " . $processUser['name'];

?>
</pre>

On a UNIX-based operating system file permissions for a file are changed through the the following shell command.

<pre>chmod <permissions_code> <file_path></pre>

The permissions_code part must be a three-digit number where each digit represents a different component of the permission set: file owner, members of the group who the file owner belongs to and other users who are not the file owner or group members. Each digit is a sum of three digits, which can be 0 (no permission), 1 (execute a file or search in a directory), 2 (write) or 4 (read). Below is a list of all available values and their meaning:

* 0 : No permission
* 1 : Execute/search
* 2 : Write
* 3 : Write and execute/search
* 4 : Read
* 5 : Read and execute/search
* 6 : Read and write
* 7 : Read, write and execute/search

For example, the permissions code 740 for a file would mean that the file owner can read, write and execute the file (7), the group members can only read the file (4) and other users can do nothing with the file (0); the permissions code 511 for a directory would mean that the file owner read the contents of the directory and search in the directory (5) while the group members and other users can only search in the directory (1).

===Setting up file permissions for X-Cart files and directories===

====Scripts and directories containing scripts====

{| cellspacing="0" cellpadding="5" border="1"
|-
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 711

* Owner: read, write and search
* Group: search
* Other: search

Files: 600

* Owner: read and write
* Group: no permission
* Other: no permission
| Directories: 777

* Owner: read, write and search
* Group: read, write and search
* Other: read, write and search

Files: 644

* Owner: read and write
* Group: read
* Other: read
|}

These permissions must be set for directories admin, customer, include, mail, modules, partner, payment, provider, shipping and upgrade and their subdirectories, and for all *.php files from these directories and the X-Cart root directory.

==== Templates and directories containing templates ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 711

* Owner: read, write and search
* Group: search
* Other: search

Files: 644

* Owner: read and write
* Group: read
* Other: read
| Directories: 777

* Owner: read, write and search
* Group: read, write and search
* Other: read, write and search

Files: 666

* Owner: read and write
* Group: read and write
* Other: read and write
|}
</div>

These permissions must be set for the directory skin1 and all its subdirectories, and for all files in the directory skin1 and its subdirectories.

==== Temporary and service directories: Directory .pgp ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 700

* Owner: read, write and search
* Group: no permission
* Other: no permission

Files: 600

* Owner: read and write
* Group: no permission
* Other: no permission
| Directories: 755

* Owner: read, write and search
* Group: read and search
* Other: read and search

Files: 644

* Owner: read and write
* Group: read
* Other: read
|}
</div>

These permissions must be set for the directory .pgp and its subdirectories, and for all files in the directory .pgp and its subdirectories.

==== Temporary and service directories: Directories catalog and images ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 711

* Owner: read, write and search
* Group: search
* Other: search

Files: 644

* Owner: read and write
* Group: read
* Other: read
| Directories: 755

* Owner: read, write and search
* Group: read and search
* Other: read and search

Files: 644

* Owner: read and write
* Group: read
* Other: read
|}
</div>

These permissions must be set for the directories catalog and images and their subdirectories, and for all files in the directories catalog and images and their subdirectories.

==== Temporary and service directories: Directory files ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 700

* Owner: read, write and search
* Group: no permission
* Other: no permission

Files: 600

* Owner: read and write
* Group: no permission
* Other: no permission
| Directories: 777

* Owner: read, write and search
* Group: read, write and search
* Other: read, write and search

Files: 666

* Owner: read and write
* Group: read and write
* Other: read and write
|}
</div>

These permissions must be set for the directory files and its subdirectories, and for all files in the the directory files and its subdirectories.

==== Temporary and service directories: Subdirectories of directory var (excl. var/cache) ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 700

* Owner: read, write and search
* Group: no permission
* Other: no permission

Files: 600

* Owner: read and write
* Group: no permission
* Other: no permission
| Directories: 755

* Owner: read, write and search
* Group: read and search
* Other: read and search

Files: 644

* Owner: read and write
* Group: read
* Other: read
|}
</div>

These permissions must be set for all subdirectories in the directory var (excluding the subdirectory cache), and for all files in the subdirectories of the directory var (excluding the subdirectory cache).

==== Temporary and service directories: Directories var and var/cache ====

<div>
{| cellspacing="0" cellpadding="5" border="1"
| '''Privileged Mode'''
| '''Non-privileged Mode'''
|-
| Directories: 711

* Owner: read, write and search
* Group: search
* Other: search

Files: 600

* Owner: read and write
* Group: no permission
* Other: no permission
| Directories: 755

* Owner: read, write and search
* Group: read and search
* Other: read and search

Files: 644

* Owner: read and write
* Group: read
* Other: read
|}
</div>

These permissions must be set up for the directory var and its subdirectory cache, and for all files in the directory var and its subdirectory cache.

==Post-Upgrade Checklist==

{{X-Cart:Post-Upgrade_Checklist}}

[[Category:X-Cart user manual]]

X-Cart:Post-Upgrade Checklist

2010-09-10T07:52:31Z

New page

After you have upgraded the development copy of the store, you must not proceed to replacing the live store until you have tested it thoroughly as advised in the checklist below and made sure that the store functions correctly. For convenience, the checklist is divided according to the available user interfaces: Customer area, Admin area, Provider area (X-Cart PRO) and Partner area (X-Affiliate).

=== Customer area ===

Make sure you can successfully carry out the following tasks:

==== Registration and login ====

* Log in to the store as an existing customer.
* Register in the store as a a new customer.

====Product catalog====

* Browse the product catalog and see products in subcategories of all levels.
* Find products using the built-in search and advanced search tool.
* Add a product to the cart from the product details page and from the product list.

====Ordering and checkout====

* Place several test order and proceed to checkout with every of them.
* Apply a discount coupon to the order.
* Make sure discounts of different types are calculated correctly.
* Make sure orders include taxes and taxes are calculated correctly.
* Make sure orders include shipping cost and the shipping charges are calculated correctly for different destination zones.
* Partially pay for the order with a gift certificate and pay for the rest of the order amount with a credit card.
* Place several orders that include the same set of products but use different discounts and discount coupons.

{{Note1|Important: When placing test orders and testing the checkout mechanism, use sandbox merchant accounts that are normally provided by every payment gateway/system. To test credit card payments, use test credit card numbers. To find out what test credit card you should use, please refer to the documentation for your payment gateway/system.}}

===Admin area===

Make sure you can successfully carry out the following tasks:

==== Registration and login ====

* Log in to the Admin area.

====Product catalog====

* Create a new product category.
* Edit and save category properties.
* Remove a category from the catalog.
* Re-assign a category to a different parent category.

* Create a new product.
* Edit and save product properties.
* Remove a product from the catalog.
* Clone a product.
* Re-assign a product to a different category.
* Search for a product using basic and advanced search mechanisms.
* Edit properties of several products at once.

* Add a product to the list of featured products.
* Remove a product from the list of featured products.

====Ordering and payment options====

* Access the store orders.
* Search for orders and sort orders according to search criteria.
* Change order statuses in bulk.
* Delete selected orders.
* Issue invoices for the selected orders.
* Generate shipping labels for the selected orders.
* Export selected/all orders.
* Navigate between orders.
* Add tracking number to the order.
* Make sure order total is calculated correctly.
* Make sure order statuses get changed correctly.

* Create a new payment method.
* Edit and save existing payment methods.
* Enable a new real-time shipping method.

====User management====

* Create an administrator account.
* Edit and save administrator account details.

* Create a customer account.
* Edit and save customer account details.

* Create a provider account (X-Cart PRO).
* Edit and save provider account details (X-Cart PRO).
* Assign a product to a provider (X-Cart PRO).

* Block and unblock accounts of different types.
* Delete test provider and customer accounts.

====Company details====

* Edit company details and make sure they are displayed correctly.
* Make sure company details are displayed correctly in orders, invoices and email notifications.
* Make sure company details are used correctly when calculating shipping cost.

====Shipping options====

* Enable shipping in the store.
* Edit general shipping options.
* Enable real-time shipping rate calculation.
* Make sure shipping rates are calculated correctly depending on customers' address.

* Create a new shipping method.
* Edit details of an existing shipping method.
* Edit shipping rates for an existing shipping method.
* Make sure shipping markup is calculated correctly.

====Taxes====

* Create a new tax rule.
* Delete a tax rule.
* Edit tax rates for a tax rule.
* Make sure taxes are calculated correctly both in the Customer and Admin area.

====Import/export====

* Make sure data can be exported correctly according to the defined options.
* Make sure data can be imported correctly.

[[Category:X-Cart user manual]]

X-Cart:Antifraud

2010-09-10T06:56:59Z

Using the 'IP Lookup service' tool

← Older revision		Revision as of 06:56, 10 September 2010
Line 139:		Line 139:
	The sequence of four decimal numbers separated by dots that is displayed in this section is the IP address from which the order originated.		The sequence of four decimal numbers separated by dots that is displayed in this section is the IP address from which the order originated.

-	To look up a customer's location by his or her IP address and to find out, how far this location is from ~~your company location~~:	+	To look up a customer's location by his or her IP address and to find out, how far this location is from the customer's billing address:

	1. Click on the '''Lookup''' button below the customer's IP address in the <u>'Order details</u>' form. A window will be opened with a dialog titled '<u>Lookup address</u>'.		1. Click on the '''Lookup''' button below the customer's IP address in the <u>'Order details</u>' form. A window will be opened with a dialog titled '<u>Lookup address</u>'.
Line 147:		Line 147:


-	In the '<u>Lookup address</u>' dialog, the fields '<u>City</u>', '<u>State</u>', '<u>Country</u>' and '<u>Zip/Postal code</u>' will show the address ~~of your company as provided under <u>General settings->Company options</u>~~, the '<u>IP</u>' field will show the IP address of your customer.	+	In the '<u>Lookup address</u>' dialog, the fields '<u>City</u>', '<u>State</u>', '<u>Country</u>' and '<u>Zip/Postal code</u>' will show the customer's billing address, the '<u>IP</u>' field will show the IP address of your customer.

	2. Click the '''Lookup address''' button. This should induce Antifraud service to find out the actual location of the computer whose IP address is provided. The address received from Antifraud service will appear below the '<u>IP</u>' field:		2. Click the '''Lookup address''' button. This should induce Antifraud service to find out the actual location of the computer whose IP address is provided. The address received from Antifraud service will appear below the '<u>IP</u>' field:
Line 163:		Line 163:


-	If you would like to ~~use~~ some other address ~~instead of your company location (for example, the address provided by the customer as his billing address)~~, simply type the desired address into the address fields of the '<u>Lookup address</u>' dialog and click the '''Measure distance''' button.	+	If you would like to check some other address, simply type the desired address into the address fields of the '<u>Lookup address</u>' dialog and click the '''Measure distance''' button.

	If you are sure that the IP address from which the order originated was used by a malicious person, you can report this IP to Antifraud service. Use the '<u>Send IP</u>' subsection of the order details page to describe the reason why you believe this IP to be a source of fraudulent orders, then click on '''Send'''.		If you are sure that the IP address from which the order originated was used by a malicious person, you can report this IP to Antifraud service. Use the '<u>Send IP</u>' subsection of the order details page to describe the reason why you believe this IP to be a source of fraudulent orders, then click on '''Send'''.

X-Cart:General Options

2010-09-10T06:45:45Z

Miscellaneous

← Older revision		Revision as of 06:45, 10 September 2010
Line 117:		Line 117:

	{{Note1\|If you access Internet via proxy and fail to enter the proxy data here, you will not be able to specify external URL addresses for product/category images.}}		{{Note1\|If you access Internet via proxy and fail to enter the proxy data here, you will not be able to specify external URL addresses for product/category images.}}
		+
		+	If the web path used for work via HTTPS proxy differs from the path used for work via HTTP (for example, HTTP xcart web root: <tt>'/xcart/'</tt>; HTTPS xcart web root: <tt>'/~example/xcart/'</tt>), you also need to set the variable <tt>$HTTPS_RELAY</tt> in the <tt>include/https_detect.php</tt> file to 'true'.
		+
		+	Please find an example of processing such a situation below (In the example the HTTPS proxy IP address is 192.160.1.1):
		+
		+	<source>
		+	if ($_SERVER['REMOTE_ADDR'] == '192.160.1.1') {
		+	$HTTPS_RELAY = true;
		+	$HTTPS = true;
		+	}
		+	</source>

	* <u>Allow provider users to edit their Seller Address</u>: This option is available only in X-Cart PRO. Using this option, you as a store administrator can allow/forbid your store's providers to access the Seller Address section in their user profile and edit its contents. If this option is enabled, your store's providers will be able to define the address from which their products will be shipped by themselves; they will also be able to edit this address at any time. If this option is disabled, only you (and other store administrators, if any) will be able to define and edit provider seller addresses.		* <u>Allow provider users to edit their Seller Address</u>: This option is available only in X-Cart PRO. Using this option, you as a store administrator can allow/forbid your store's providers to access the Seller Address section in their user profile and edit its contents. If this option is enabled, your store's providers will be able to define the address from which their products will be shipped by themselves; they will also be able to edit this address at any time. If this option is disabled, only you (and other store administrators, if any) will be able to define and edit provider seller addresses.
	* <u>Key for launch of the cron.php script</u>: This field allows you to set a key that you will use to launch <u>cron.php</u> from the command line. <u>cron.php</u> is X-Cart's script that launches execution of periodic tasks. The key is needed to prevent unauthorized access to this script. The key must be an alphanumeric code no less than 6 characters in length. After the value entered into this field is saved, X-Cart will automatically generate a command that you will be able to use to launch <u>cron.php</u> from the command line. This command will be displayed below the '<u>Key for launch of the cron.php script</u>' field like the following:		* <u>Key for launch of the cron.php script</u>: This field allows you to set a key that you will use to launch <u>cron.php</u> from the command line. <u>cron.php</u> is X-Cart's script that launches execution of periodic tasks. The key is needed to prevent unauthorized access to this script. The key must be an alphanumeric code no less than 6 characters in length. After the value entered into this field is saved, X-Cart will automatically generate a command that you will be able to use to launch <u>cron.php</u> from the command line. This command will be displayed below the '<u>Key for launch of the cron.php script</u>' field like the following:

-	~~{{Note1\|Note:~~ Command for launch of the cron.php script: php /home/user/public_html/xcart/cron.php --key=XXXXXXXXXXXXX}}	+	<pre> Command for launch of the cron.php script:
		+	php /home/user/public_html/xcart/cron.php --key=XXXXXXXXXXXXX</pre>

	* <u>Run the script that launches execution of periodic tasks once per N user sessions (Set to 0 or leave empty if you do not wish to use this script)</u>: This setting allows you to set up X-Cart to automatically launch the script <u>cron.php</u> once per a predetermined number of user sessions (The desired number of user sessions can be entered into this field).		* <u>Run the script that launches execution of periodic tasks once per N user sessions (Set to 0 or leave empty if you do not wish to use this script)</u>: This setting allows you to set up X-Cart to automatically launch the script <u>cron.php</u> once per a predetermined number of user sessions (The desired number of user sessions can be entered into this field).

	[[Category:X-Cart user manual]]		[[Category:X-Cart user manual]]

X-Cart:Special Offers

2010-09-10T06:40:08Z

Go to the ‘Bonuses’ section of the offer configuration dialog.

← Older revision		Revision as of 06:40, 10 September 2010
Line 267:		Line 267:

	* '''Give free shipping''' - allows you to provide free shipping on qualified orders. Please note that free shipping can be applied to specific products, specific categories or the whole customer’s shopping cart.		* '''Give free shipping''' - allows you to provide free shipping on qualified orders. Please note that free shipping can be applied to specific products, specific categories or the whole customer’s shopping cart.
-	* '''Offer products for free''' - allows you to enable your customers to receive free products. Please note that free products ~~will only be~~ added to a qualified order ~~if the~~ customer who is placing that order ~~declares his wish~~ to ~~get some~~ products ~~free~~ of ~~charge in addition~~ to ~~the order~~.	+	* '''Offer products for free''' - allows you to enable your customers to receive free products. Please note that free products are not added to a qualified order automatically. The customer who is placing that order has to click the "Check for special offers" link before checking out, and then add products from the list of available free products to cart.
	* '''Offer membership''' - allows you to enable your customers to sign up for a membership that grants privileges in using the store. If a special offer that gives ability to sign up for some membership is applied to a purchase, the customer is informed about it by a message displayed in the shopping cart before checkout. As soon as the order gets the status Complete, the customer can visit the section ‘My bonuses’ available via Your cart menu and select a membership that he would like to have. The chosen membership will be granted to him automatically upon request. Please note that memberships are only given to customers who declare their wish to get them by signing up.		* '''Offer membership''' - allows you to enable your customers to sign up for a membership that grants privileges in using the store. If a special offer that gives ability to sign up for some membership is applied to a purchase, the customer is informed about it by a message displayed in the shopping cart before checkout. As soon as the order gets the status Complete, the customer can visit the section ‘My bonuses’ available via Your cart menu and select a membership that he would like to have. The chosen membership will be granted to him automatically upon request. Please note that memberships are only given to customers who declare their wish to get them by signing up.

X-Cart:Special Offers in Customer zone

2010-09-10T06:38:34Z

Cart and checkout

User:Ksluebke

2010-09-09T18:11:35Z

New user account

New page

User:Aqpearl

2010-09-09T14:57:37Z

New user account

New page

X-Cart:Customizing storefront

2010-09-09T13:25:20Z

Templates structure

← Older revision		Revision as of 13:25, 9 September 2010
Line 11:		Line 11:
	===Templates structure===		===Templates structure===

-	Below are the major templates in X-Cart along ~~what~~ what each controls. All of them are located in your '<u>~~skin1~~</u>' directory:	+	Below are the major templates in X-Cart along what each controls. All of them are located in your '<u>skin</u>' directory:

	* <u>rectangle_top.tpl</u> - it controls the overall width and height of your layout. By default, it is set to 100% high and 100% width. You can set it to a fixed width (like 900px) or a percentage. Keep in mind that this is a shared template between the admin and customer sides, so you might want to put in an {if} statement to show something different for each side.		* <u>rectangle_top.tpl</u> - it controls the overall width and height of your layout. By default, it is set to 100% high and 100% width. You can set it to a fixed width (like 900px) or a percentage. Keep in mind that this is a shared template between the admin and customer sides, so you might want to put in an {if} statement to show something different for each side.

User:Kruno

2010-09-09T13:13:55Z

New user account

New page

X-Payments:Viewing payments

2010-09-09T11:21:46Z

Auth and Capture

← Older revision		Revision as of 11:21, 9 September 2010
Line 73:		Line 73:
	Additional info includes payment gateway response messages and details about CVV check and AVS check results.		Additional info includes payment gateway response messages and details about CVV check and AVS check results.

-	~~===Auth and Capture===~~	+	{{X-Payments:Auth_and_Capture}}
-		+
-	~~'''~~X-Payments~~''' allows to perform '''''Auth''' and '''Capture''''' and partial '''''Capture''''' transactions.~~	+
-		+
-	~~To enable '''X-Payments''' to perform '''''Auth''' and '''Capture''''' transactions, take the following steps:~~	+
-		+
-	# Make sure '''X-Payments''' supports the required types of transaction with the payment gateway you are going to use. Consult [index.php?title=X-Payments:User_manual#Appendix_A._Supported_payment_gateways the list of supported payment gateways] and find out whether multiple (m) and partial (p) transactions for your payment gateway are supported.	+
-	~~# Go to the payment configuration page (<u>Settings</u> > <u>Payment configurations</u> > select the required payment from the list).~~	+
-	~~<u>Initial transaction</u>: select ''''Auth''''. If you select ''''Auth''' and '''capture'''' you will not be able to '''capture''' funds manually.~~	+
-		+
-	~~: [[Image:Auth_capture1.gif\|376px\|border]]~~	+
-		+
-	~~To '''capture''' funds after an automatic '''''Auth''''' transaction, take the following steps:~~	+
-		+
-	When a customer makes a payment, the payment amount is authorized automatically, and then you need to '''capture''' the required amount. Go to payment details page (<u>Payments</u> > select the necessary payment from the list). Use the 'Handle transaction' section:	+
-		+
-	~~: [[Image:Auth_capture2.gif\|324px\|border]]~~	+
-		+
-	* Make sure the authorized amount is correct. If it is, click ''''''Capture''''''.	+
-	* If necessary, change the amount in the input box and click ''''''Capture''''''. Only the specified amount will be captured as a result.	+
-		+
-	If you know you do not need to change the '''capture''' amount (or your payment gateway does not support partial transactions), you can '''capture''' funds directly from the Payments page. To do so find the necessary payment in the payment list and click the <u>'''Capture'''</u> link below the payment status.	+
-		+
-	~~: [[Image~~:~~Auth_capture3.gif\|606px\|border]]~~	+
-		+
-	If your payment gateway supports multiple transactions, you can '''capture''' funds several times, gradually decreasing the authorized amount. When funds are not possible to '''capture''', the ''''''Capture'''''' button disappears.	+

	===Deleting payments===		===Deleting payments===

X-Payments:Auth and Capture

2010-09-09T11:20:24Z

Created page with '==Auth and Capture== To enable X-Payments to perform ''Auth and Capture'' transactions, take the following steps: # Make sure X-Payments supports the required types of transact…'

New page

==Auth and Capture==

To enable X-Payments to perform ''Auth and Capture'' transactions, take the following steps:

# Make sure X-Payments supports the required types of transaction with the payment gateway you are going to use. Consult [[X-Payments:User_manual#Appendix_A._Supported_payment_gateways | the list of supported payment gateways]] and find out whether multiple (m) and partial (p) transactions for your payment gateway are supported.
# Go to the payment configuration page (Settings > Payment configurations > select the required payment from the list). Initial transaction: select 'Auth'. If you select 'Auth and capture' you will not be able to capture funds manually. [[Image:Auth_capture1.gif|center|border]] 

To capture funds after an automatic ''Auth'' transaction, take the following steps:

When a customer makes a payment, the payment amount is authorized automatically, and then you need to capture the required amount. Go to payment details page (Payments > select the necessary payment from the list). Use the 'Handle transaction' section: [[Image:Auth_capture2.gif|center|border]] 
* Make sure the authorized amount is correct. If it is, click '''Capture'''.
* If necessary, change the amount in the input box and click '''Capture'''. Only the specified amount will be captured as a result. 
If you know you do not need to change the capture amount (or your payment gateway does not support partial transactions), you can capture funds directly from the Payments page. To do so find the necessary payment in the payment list and click the Capture link below the payment status. [[Image:Auth_capture3.gif|center]] 
If your payment gateway supports multiple transactions, you can capture funds several times, gradually decreasing the authorized amount. When funds are not possible to capture, the '''Capture''' button disappears.

==Emulating transactions==

Sometimes a situation may occur when you need to "mark" a payment as captured in X-Payments without actually capturing the funds using a payment gateway. For example, when you know that the funds have been already captured but the payment gateway is down and no information about the transaction has been sent to X-Payments. In this case you should use the Emulate transaction section of the payment details page. [[Image:Auth_capture4.gif|center|border]] 

It looks just the same as the Handle transaction section, so you need to do the same thing - check and correct the captured amount and click '''Capture'''. The transaction will receive the ''Captured'' status.

{{Note1|Please note that when you have emulated a transaction, you will not be able to capture the funds using the payment gateway backend.}}

[[Category:X-Payments user manual]]

[[Category:X-Payments user manual]]

File:Shipping charges1.gif

2010-09-09T11:18:05Z

uploaded "[[File:Shipping charges1.gif]]"

New page

X-Cart:Clean URLs

2010-09-09T10:01:02Z

Clean URLs causing 404 error in X-Cart backend

← Older revision		Revision as of 10:01, 9 September 2010
(3 intermediate revisions not shown)
Line 82:		Line 82:
	The clean URL value for any object can be defined manually through the '<u>Clean URL</u>' field on the object's Details page.		The clean URL value for any object can be defined manually through the '<u>Clean URL</u>' field on the object's Details page.

-	To define the clean URL value for an object, go the Details page of this object and use the '<u>Clean URL</u>' field to enter a string of characters that you wish to be used as the object's clean URL.The value entered into the '<u>Clean URL</u>' field must be unique within your store and must not be used as a path to any actual file located in your X-Cart installation directory. The maximum allowed length for a clean URL value is 255 characters. Allowed are alphanumeric characters (A-Z, a-z, 0-9), slash (/), dot (.), hyphen (-) and underscore (_). '''Important:''' When defining a clean URL value, do not use spaces, and do not include slashes at the beginning or at the end. Also, do not include the web path to your store’s directory, or any extensions, like ".html" (Extensions are set separately for each type of pages using the '<u>Clean URL extension for </u><page type><u> pages</u>' option group in the '<u>General settings/SEO options</u>' section).	+	To define the clean URL value for an object, go the Details page of this object and use the '<u>Clean URL</u>' field to enter a string of characters that you wish to be used as the object's clean URL.The value entered into the '<u>Clean URL</u>' field must be unique within your store and must not be used as a path to any actual file located in your X-Cart installation directory. The maximum allowed length for a clean URL value is 255 characters. Allowed are alphanumeric characters (A-Z, a-z, 0-9), slash (/), dot (.), hyphen (-) and underscore (_).
		+
		+	{{Note1\|'''Important:''' When defining a clean URL value, do not use spaces, and do not include slashes at the beginning or at the end.}}
		+	Also, do not include the web path to your store’s directory, or any extensions, like ".html" (Extensions are set separately for each type of pages using the '<u>Clean URL extension for </u><page type><u> pages</u>' option group in the '<u>General settings/SEO options</u>' section).

	Please note that, after the object's name is entered on the Details page, X-Cart offers a clean URL value suggestion for the '<u>Clean URL</u>' field. This suggestion is, in fact, the value entered into the object's name field, in which all unallowed characters are replaced by hyphens. The suggestion of a clean URL value is offered solely for your convenience; you can accept it, or replace it by a value of your own.		Please note that, after the object's name is entered on the Details page, X-Cart offers a clean URL value suggestion for the '<u>Clean URL</u>' field. This suggestion is, in fact, the value entered into the object's name field, in which all unallowed characters are replaced by hyphens. The suggestion of a clean URL value is offered solely for your convenience; you can accept it, or replace it by a value of your own.
Line 88:		Line 91:
	At any moment, you can re-define the clean URL value previously defined for an object. To accomplish this, you must edit the contents of the '<u>Clean URL</u>' field on the object's Details page.		At any moment, you can re-define the clean URL value previously defined for an object. To accomplish this, you must edit the contents of the '<u>Clean URL</u>' field on the object's Details page.

-	{{Note1\|Note: When you re-define an object's clean URL value, you can specify whether its previous clean URL value should be saved to the Clean URL history. For information on Clean URL history, see the section [[#Using Clean URL History]].}}	+	{{Note1\|Note: When you re-define an object's clean URL value, you can specify whether its previous clean URL value should be saved to the Clean URL history. For information on Clean URL history, see the section [[#Using Clean URL History \| Using Clean URL History]].}}

	===Defining clean URL values through import===		===Defining clean URL values through import===
Line 94:		Line 97:
	When product or category data is imported into your store from a CSV file, the field CLEAN_URL can be used to import clean URL values. The format requirements for the CLEAN_URL field are exactly the same as for the field '<u>Clean URL</u>' on the Details page (see above).		When product or category data is imported into your store from a CSV file, the field CLEAN_URL can be used to import clean URL values. The format requirements for the CLEAN_URL field are exactly the same as for the field '<u>Clean URL</u>' on the Details page (see above).

-	As a result of import, clean URL values are added/updated for all the products and categories for which a clean URL value is provided in the CLEAN_URL field. For the products and categories, for which the CLEAN_URL field is empty, clean URL values are generated automatically (See [[#Automatic Generation of Clean URL Values]]).	+	As a result of import, clean URL values are added/updated for all the products and categories for which a clean URL value is provided in the CLEAN_URL field. For the products and categories, for which the CLEAN_URL field is empty, clean URL values are generated automatically (See [[#Automatic Generation of Clean URL Values \| Automatic Generation of Clean URL Values]]).

	== Using Clean URL History ==		== Using Clean URL History ==
Line 184:		Line 187:

	<pre>RewriteCond %{REQUEST_URI} !^/(payment\|admin\|provider\|partner)/</pre>		<pre>RewriteCond %{REQUEST_URI} !^/(payment\|admin\|provider\|partner)/</pre>
		+
		+	==See also==
		+
		+	[[X-Cart:404_Error_Page \| X-Cart 404 Error Page]]

	[[Category:X-Cart user manual]]		[[Category:X-Cart user manual]]

X-Cart:Summary Page

2010-09-09T09:57:36Z

Clean URLs info

← Older revision		Revision as of 09:57, 9 September 2010
Line 69:		Line 69:
	== Clean URLs info ==		== Clean URLs info ==

-	This subsection provides information about missing clean URLs. It tells you the overall number of products, categories, manufacturers and embedded static pages in your store and tells you, how many objects of each type do not have a clean URL value. If your store has any objects for which clean URL values are missing, you can use X-Cart's '<u>Generate clean URL values</u>' tool to generate the missing clean URL values. The '<u>Generate clean URL values</u>' tool is available in the <u>'Summary/Tools</u>' section of the store's Admin area (See the section [~~http://www.x~~-~~cart.com/xcart_manual/online/generate_clean_url_values.htm~~ Generate Clean URL Values]).	+	This subsection provides information about missing clean URLs. It tells you the overall number of products, categories, manufacturers and embedded static pages in your store and tells you, how many objects of each type do not have a clean URL value. If your store has any objects for which clean URL values are missing, you can use X-Cart's '<u>Generate clean URL values</u>' tool to generate the missing clean URL values. The '<u>Generate clean URL values</u>' tool is available in the <u>'Summary/Tools</u>' section of the store's Admin area (See the section [[X-Cart:Advanced_Tools#Generate_Clean_URL_Values \| Generate Clean URL Values]]).

	== Payment methods info ==		== Payment methods info ==

X-Cart:Customizing storefront

2010-09-09T09:55:50Z

Templates structure

← Older revision		Revision as of 09:55, 9 September 2010
Line 23:		Line 23:
	* <u>auth.tpl</u> - this is the side menu login box. Shared between admin and customer side		* <u>auth.tpl</u> - this is the side menu login box. Shared between admin and customer side
	* <u>authbox.tpl</u> - this is the side menu login box for logged in customers. Shared between admin and customer side.		* <u>authbox.tpl</u> - this is the side menu login box for logged in customers. Shared between admin and customer side.
-	* <u>currency.tpl</u> - this controls the format of the currency. If you want to change the location of the symbol, this is the place to do it. * help.tpl - this is the side menu help box containing links to the help pages. It also contains the code that automatically adds a link when you add a new embedded static page	+	* <u>currency.tpl</u> - this controls the format of the currency. If you want to change the location of the symbol, this is the place to do it.
		+	* <u>help.tpl</u> - this is the side menu help box containing links to the help pages. It also contains the code that automatically adds a link when you add a new embedded static page
	* <u>location.tpl</u> - contains the code for the breadcrumb navigation (at the top of the main content area)		* <u>location.tpl</u> - contains the code for the breadcrumb navigation (at the top of the main content area)
	* <u>news.tpl</u> - the side menu newsletter sign-up box		* <u>news.tpl</u> - the side menu newsletter sign-up box

X-Cart:Orders

2010-09-09T09:52:42Z

Orders in X-Cart

← Older revision		Revision as of 09:52, 9 September 2010
Line 10:		Line 10:
	* total amount.		* total amount.

-	Each order has its unique order id number and, at any moment in time, is characterized by a status. For information on the system of order statuses used in X-Cart, see the section [[#Order Statuses]].	+	Each order has its unique order id number and, at any moment in time, is characterized by a status. For information on the system of order statuses used in X-Cart, see the section [[#Order Statuses \| Order Statuses]].

	== Roles in order management ==		== Roles in order management ==

X-Cart:User manual contents

2010-09-09T09:51:38Z

Maintaining Your Store

← Older revision		Revision as of 09:51, 9 September 2010
Line 216:		Line 216:

	* [[X-Cart:Upgrading\|Upgrading]]		* [[X-Cart:Upgrading\|Upgrading]]
		+
		+	* [[X-Cart:Moving store to another host\|Moving store to another host]]
		+
		+	* [[X-Cart:Moving store to web-root directory\|Moving store to web-root directory]]

	== Modules ==		== Modules ==

X-Cart:Moving store to web-root directory

2010-09-09T09:47:58Z

Created page with 'Here are general instructions on how to move your cart to the web-root directory: 1. Make sure your product and category images are stored in the database. If they are stored on…'

New page

Here are general instructions on how to move your cart to the web-root directory:

1. Make sure your product and category images are stored in the database. If they are stored on the filesystem, you should temporarily move them to the database. You can do this under the "Images location" section of the admin interface.

2. Move all files from the directory where X-Cart installed to the root web directory. You can do this using either FTP or (better) SSH access. File permissions must be preserved during the copying, otherwise you will need to adjust the permissions manually.

3. Edit config.php file adjusting '''$xcart_web_dir''' parameter. If your cart was installed in the "store" directory, you should replace the following string:

<source>
$xcart_web_dir ="/store";
</source>

with this:

<source>
$xcart_web_dir ="";
</source>

4. Check if X-Cart is working fine on the new location.

5. Move products and category images back to the filesystem if necessary.

[[Category:X-Cart user manual]]

X-Cart:Gift Certificates

2010-09-09T09:46:32Z

What Gift Certificates module does

← Older revision		Revision as of 09:46, 9 September 2010
Line 24:		Line 24:

	: [[Image:gc6.gif\|679px]]		: [[Image:gc6.gif\|679px]]
		+
		+	When a gift certificate is used to pay for an order, the gift certificate's amount is changed accordingly. If the order, paid by a gift certificate, is declined by the store admin, the order total amount is returned to the gift certificate and its amount is restored.

	Any holder of a gift certificate has the ability to check the current amount and status of his or her gift certificate by using X-Cart's gift certificate verification service. The remaining balance and the status of a gift certificate can be found out at any time by entering the certificate code into the '<u>Gift certificate verification</u>' form.		Any holder of a gift certificate has the ability to check the current amount and status of his or her gift certificate by using X-Cart's gift certificate verification service. The remaining balance and the status of a gift certificate can be found out at any time by entering the certificate code into the '<u>Gift certificate verification</u>' form.

← Older revision		Revision as of 11:26, 10 September 2010
Line 260:		Line 260:
	* [[X-Cart:Stop List\|Stop List]]		* [[X-Cart:Stop List\|Stop List]]
	* [[X-Cart:Special Offers\|Special Offers]]		* [[X-Cart:Special Offers\|Special Offers]]
-	* [[X-Cart:Subscriptions\|Subscriptions]]	+	* [[X-Cart:Subscriptions\|Subscriptions]] (For versions before X-Cart 4.4 only!)
	* [[X-Cart:Survey\|Survey]]		* [[X-Cart:Survey\|Survey]]
	* [[X-Cart:UPS OnLine Tools\|UPS OnLine Tools]]		* [[X-Cart:UPS OnLine Tools\|UPS OnLine Tools]]

← Older revision		Revision as of 06:38, 10 September 2010
(3 intermediate revisions not shown)
Line 3:		Line 3:
	After you create and enable some special offers, the visitors of the Customer area of your store can obtain information about currently available special offers from a page titled ‘Special offers’. This page can be accessed by clicking on <u>Special offers</u> in the <u>Special</u> menu.		After you create and enable some special offers, the visitors of the Customer area of your store can obtain information about currently available special offers from a page titled ‘Special offers’. This page can be accessed by clicking on <u>Special offers</u> in the <u>Special</u> menu.

-	[[Image:xc-so-31.gif\|150px\|<br> Figure 1. Special menu -> Special offers.]]	+	[[Image:xc-so-31.gif\|150px\|center\|<br> Figure 1. Special menu -> Special offers.]]

-	The ‘Special offers’ page displays detailed offer descriptions which you create while configuring your special offers (Information on how to create detailed offer descriptions is available in the [[#Promo texts]] section.	+	The ‘Special offers’ page displays detailed offer descriptions which you create while configuring your special offers (Information on how to create detailed offer descriptions is available in the [[X-Cart:Special_Offers#Promo_texts \| Promo texts]] section.

	Please note that the set of offers displayed on the ‘Special offers’ page may change depending on who is viewing the page. Special offers which may be used only by customers with a certain membership or customers from a specific geographic location are displayed on the ‘Special offers’ page only to customers logged into the store with a profile corresponding to that membership or geographic location:		Please note that the set of offers displayed on the ‘Special offers’ page may change depending on who is viewing the page. Special offers which may be used only by customers with a certain membership or customers from a specific geographic location are displayed on the ‘Special offers’ page only to customers logged into the store with a profile corresponding to that membership or geographic location:
Line 17:		Line 17:
	===Promo blocks and 'Special offer' labels===		===Promo blocks and 'Special offer' labels===

-	In addition to the ‘Special offers’ page, information about available special offers can be provided to customers via short promo blocks. A short promo block is a compact offer description which may appear at the top of store pages displaying text and/or graphics and providing a link to the detailed description of the corresponding offer. Short descriptions for use in promo blocks may be easily created in the process of configuring individual special offers (Information on how to create short offer descriptions is available in the [[#Promo texts]] section).	+	In addition to the ‘Special offers’ page, information about available special offers can be provided to customers via short promo blocks. A short promo block is a compact offer description which may appear at the top of store pages displaying text and/or graphics and providing a link to the detailed description of the corresponding offer. Short descriptions for use in promo blocks may be easily created in the process of configuring individual special offers (Information on how to create short offer descriptions is available in the [[#Promo texts \| Promo texts]] section).

	'''Short promo blocks '''concerning specific products or product categories appear at the top of product and category pages (on the pages of the product/category itself and the pages of their parent categories).		'''Short promo blocks '''concerning specific products or product categories appear at the top of product and category pages (on the pages of the product/category itself and the pages of their parent categories).
Line 31:		Line 31:
	You can adjust the module so that multiple short promo blocks appearing on one product/category page will be displayed in 1-3 columns. The number of columns can be defined by setting the option <u>Display offers list in multiple columns (1-3)</u> in <u>General settings/Special Offers options</u>.		You can adjust the module so that multiple short promo blocks appearing on one product/category page will be displayed in 1-3 columns. The number of columns can be defined by setting the option <u>Display offers list in multiple columns (1-3)</u> in <u>General settings/Special Offers options</u>.

-	More information on <u>Special Offers options</u> is available in the [[#Configuring]] section.	+	More information on <u>Special Offers options</u> is available in the [[#Configuring \| Configuring]] section.

	The link ‘more offers >>’ which may appear on category/product pages allows your customers to access a list of detailed descriptions of all the offers available for the category/product they are currently viewing. The link is especially helpful for situations in which the number of special offers available for a category/product exceeds the number of short promo blocks which can be displayed on one page.		The link ‘more offers >>’ which may appear on category/product pages allows your customers to access a list of detailed descriptions of all the offers available for the category/product they are currently viewing. The link is especially helpful for situations in which the number of special offers available for a category/product exceeds the number of short promo blocks which can be displayed on one page.
Line 159:		Line 159:


-	Important! Please be aware that when a free product that gets added to a shopping cart comes from the same category as some of the products already contained in the shopping cart, the zero price is assigned to the most expensive of the category products added to the cart.	+	{{Note1\|Important! Please be aware that when a free product that gets added to a shopping cart comes from the same category as some of the products already contained in the shopping cart, the zero price is assigned to the most expensive of the category products added to the cart.}}

-	Example: Suppose, there is a special offer that allows anyone to order any 2 books and get a third book free (all the books are in the same category). If a customer adds to cart book A ($3) and book B ($5), and then selects some book C ($2) as a free gift to go with his purchase, X-SpecialOffers will readjust the prices of the products in the shopping cart so that the books A and C will cost $3 and $2 respectively, while the book B will be offered at zero price.	+	'''Example''': Suppose, there is a special offer that allows anyone to order any 2 books and get a third book free (all the books are in the same category). If a customer adds to cart book A ($3) and book B ($5), and then selects some book C ($2) as a free gift to go with his purchase, X-SpecialOffers will readjust the prices of the products in the shopping cart so that the books A and C will cost $3 and $2 respectively, while the book B will be offered at zero price.

	The link '''All offers for cart''' located at the top of the ‘Items’ form on the shopping cart page provides access to descriptions of special offers available for the current state of the shopping cart. Customers can use this link to view the complete list of offers which can be applied or are already being applied to their cart.		The link '''All offers for cart''' located at the top of the ‘Items’ form on the shopping cart page provides access to descriptions of special offers available for the current state of the shopping cart. Customers can use this link to view the complete list of offers which can be applied or are already being applied to their cart.
Line 188:		Line 188:
	The line '''Minimum allowed amount of bonus points to convert''' shows the minimum amount of bonus points which can be converted to a Gift Certificate. If the number of bonus points that a customer has equals or is larger than this amount, he can convert the bonus points to a Gift Certificate by clicking on the '''Convert to a Gift Certificate''' button.		The line '''Minimum allowed amount of bonus points to convert''' shows the minimum amount of bonus points which can be converted to a Gift Certificate. If the number of bonus points that a customer has equals or is larger than this amount, he can convert the bonus points to a Gift Certificate by clicking on the '''Convert to a Gift Certificate''' button.

-	The store administrator can set the minimum amount of bonus points which can be converted to a Gift Certificate and the conversion rate via the section <u>General settings/Special Offers options</u> (See: [[#Configuring the module]]). He may also edit the number of bonus points earned by any customer by editing the customer’s profile (See: [[#Managing bonus points]]).	+	The store administrator can set the minimum amount of bonus points which can be converted to a Gift Certificate and the conversion rate via the section <u>General settings/Special Offers options</u> (See: [[#Configuring the module \| Configuring the module]]). He may also edit the number of bonus points earned by any customer by editing the customer’s profile (See: [[#Managing bonus points \| Managing bonus points]]).

	===='Membership' subsection====		===='Membership' subsection====