X-Cart:Upgrading - Revision history

Dohtur at 07:55, 15 August 2016

2016-08-15T07:55:54Z

Dohtur: /* Video tutorial */

2016-08-12T10:40:28Z

‎Video tutorial

Dohtur at 08:57, 14 June 2016

2016-06-14T08:57:04Z

Dohtur: /* Upgrading from versions 4.5.0-4.6.x */

2016-06-14T08:49:04Z

‎Upgrading from versions 4.5.0-4.6.x

Dohtur: /* Upgrading to X-Cart 4.6.x step by step */

2016-03-31T02:43:56Z

‎Upgrading to X-Cart 4.6.x step by step

Dohtur at 02:22, 31 March 2016

2016-03-31T02:22:32Z

Dohtur at 22:22, 29 March 2016

2016-03-29T22:22:07Z

Dohtur: /* General information on upgrading */

2016-03-05T07:46:45Z

‎General information on upgrading

Dohtur at 10:24, 15 September 2014

2014-09-15T10:24:43Z

Show changes

Dohtur: /* Video tutorial */

2014-04-28T09:37:21Z

‎Video tutorial

← Older revision		Revision as of 07:55, 15 August 2016
Line 243:		Line 243:

	[[Category:X-Cart user manual]]		[[Category:X-Cart user manual]]
		+	[[Category:X-Cart video tutorials]]

@@ Line 11: / Line 11: @@
 The steps taken should cover most everything you will encounter while upgrading X-Cart 4 (Classic).
-<videoflash>SlbbQ6waWAk|800|476</videoflash>
+<youtube>SlbbQ6waWAk</youtube>
 <br /><br />

@@ Line 182: / Line 182: @@
 If you choose the second option (to upgrade just the database), you will need to follow these steps:
 # In your development environment, create a copy of your existing store. For details, see the chapter [[X-Cart:Before the upgrade | Before the upgrade]].
-# Retrieve the value of the variable $blowfish_key from the file <xcart_dir>/config.php of the development copy of your store and temporarily save it somewhere on your local computer.
+# Retrieve the value of the variable $blowfish_key from the file <xcart_dir>/config.php of the development copy of your store and temporarily save it somewhere on your local computer.  Also take note of the following values:
 # In the File Area section of your {{QA}}, obtain an X-Cart distribution package of the same version as the version ''from'' which you are upgrading. For example, if you need to upgrade from 4.5.2 to 4.6.1, get a distribution package for X-Cart 4.5.2. In your development environment, install a fresh copy of X-Cart from this distribution package pointing it to the database of the development store copy you created at Step 1. To do so, during the installation process, provide to the installation wizard the database connection details of the development store copy you created at Step 1, enable the option "Update config.php only" and enter the Blowfish key value you saved at Step 2.
 # Obtain the upgrade pack(s) needed to bring your store to the desired version. For example, if you need to upgrade from 4.5.2 to 4.6.1, there is not a direct upgrade pack that would allow you to upgrade from 4.5.2 to 4.6.1., so you will need to download two upgrade packs: 4.5.2->4.6.0 and 4.6.0->4.6.1. <br />For instructions on obtaining upgrade packs, see [[X-Cart:Obtaining_Upgrade_Packs_and_Database_Upgrade_Scripts | Obtaining upgrade packs and database upgrade scripts]].
 # Apply the obtained upgrade pack(s) to your development store copy (If there are more than one upgrade packs, apply them consecutively, one pack at a time. For example, first apply the pack to bring the store version from 4.5.2 to 4.6.0, then apply the pack to bring the store version from 4.6.0 to 4.6.1. For instructions on the application of upgrade packs, see [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts | Applying upgrade packs and database upgrade scripts]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].

@@ Line 133: / Line 133: @@
 If you choose the second option (to upgrade just the database), you will need to follow these steps:
 # In your development environment, create a copy of your existing store. For details, see the chapter [[X-Cart:Before the upgrade | Before the upgrade]].
-# Retrieve the value of the variable $blowfish_key from the file <xcart_dir>/config.php of the development copy of your store and temporarily save it somewhere on your local computer.
+# Retrieve the value of the variable $blowfish_key from the file <xcart_dir>/config.php of the development copy of your store and temporarily save it somewhere on your local computer. Also take note of the following values:
 # In the File Area section of your {{QA}}, obtain an X-Cart distribution package of the same version as the version ''from'' which you are upgrading. For example, if you need to upgrade from 4.6.2 to 4.7.5, get a distribution package for X-Cart 4.6.2. In your development environment, install a fresh copy of X-Cart from this distribution package pointing it to the database of the development store copy you created at Step 1. To do so, during the installation process, provide to the installation wizard the database connection details of the development store copy you created at Step 1, enable the option "Update config.php only" and enter the Blowfish key value you saved at Step 2.
 # Obtain the upgrade pack(s) needed to bring your store to the desired version. For example, if you need to upgrade from 4.6.2 to 4.7.5, there is not a direct upgrade pack that would allow you to upgrade from 4.6.2 to 4.7.5, so you will need to download two upgrade packs: 4.6.2->4.7.2 and 4.7.2->4.7.5. <br />For instructions on obtaining upgrade packs, see [[X-Cart:Obtaining_Upgrade_Packs_and_Database_Upgrade_Scripts | Obtaining upgrade packs and database upgrade scripts]].
 # Apply the obtained upgrade pack(s) to your development store copy (If there are more than one upgrade packs, apply them consecutively, one pack at a time. For example, first apply the pack to bring the store version from 4.6.2 to 4.7.2, then apply the pack to bring the store version from 4.7.2 to 4.7.5. For instructions on the application of upgrade packs, see [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts | Applying upgrade packs and database upgrade scripts]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].

@@ Line 154: / Line 154: @@
 ==Upgrading to X-Cart 4.6.x step by step==
-===Upgrading from version 4.5.0 or later===
+===Upgrading from version 4.6.0 or later===
 If the version of X-Cart on which your current store is based is 4.6.0 or later, to upgrade your store to a newer minor version within the 4.6.x branch (for example, from version 4.6.0 to version 4.6.1) you will need to follow these steps:
@@ Line 160: / Line 160: @@
 # Obtain the upgrade pack(s) for the direct upgrade from your current version to the desired version. For details, see the chapter [[X-Cart:Obtaining_Upgrade_Packs_and_Database_Upgrade_Scripts#Obtaining in-branch upgrade packs | Obtaining in-branch upgrade packs]].
 # Apply the upgrade pack to your X-Cart installation. For details, see the chapter [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts#Applying_upgrade_packs | Applying Upgrade Packs]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].
@@ Line 176: / Line 195: @@
 # Apply the upgrade packs. For details, see the chapter [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts#Applying_upgrade_packs | Applying Upgrade Packs]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].
 ==Upgrading to X-Cart 4.5.x step by step==

@@ Line 32: / Line 32: @@
 When you need to upgrade your store to a later major version (for example, from X-Cart 4.2.x to X-Cart 4.3.x), the available upgrade options depend on the versions involved.
 For some versions, we can provide packs for a direct full upgrade. For example, we can provide the following upgrade packs:
-.5.х -> 4.6.0
+* 4.5.х -> 4.6.0
-.6.х -> 4.7.0
+* 4.6.х -> 4.7.0
-.6.х -> 4.7.1
+* 4.6.х -> 4.7.1
-For other versions, there are no ready-made upgrade packs, and for such versions it is only possible to upgrade the store database connecting it to a fresh X-Cart installation.
+For other versions, there are no ready-made full upgrade packs, and for such versions, it is only possible to upgrade the store database, connecting the database to a fresh X-Cart installation.
 In order to upgrade the database, you need to run a special script that will convert the data in the database so that it will be compatible with the X-Cart version to which you are going to upgrade your 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, database version 4.2.1 means that this database can be used with X-Cart version 4.2.1.
@@ Line 124: / Line 124: @@
 * to upgrade your entire store (both the software and the database) to 4.7.x;
 * to upgrade just your store's database to 4.7.x and install the X-Cart software anew.
 If you choose the first option (to upgrade both the software and the database), you will need to use our upgrade packs. Note that if there is not a direct upgrade pack to bring your store to the desired version, you will need to go through one or more transitional upgrades. To complete the upgrade:
 # In your development environment, create a copy of your existing store. For details, see the chapter [[X-Cart:Before the upgrade | Before the upgrade]].
@@ Line 129: / Line 130: @@
 # Apply the upgrade pack(s) to your X-Cart installation. For details, see the chapter [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts#Applying_upgrade_packs | Applying Upgrade Packs]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].
 If you choose the second option (to upgrade just the database), you will need to follow these steps:
@@ Line 139: / Line 139: @@
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].
 ==Upgrading to X-Cart 4.6.x step by step==
-===Upgrading from version 4.6.0 or later===
+===Upgrading from version 4.5.0 or later===
-If the version of X-Cart on which your current store is based is 4.6.0 or later, to upgrade your store to a newer minor version within the 4.6.x branch (for example to version 4.6.1) you will need to follow these steps:
+If the version of X-Cart on which your current store is based is 4.6.0 or later, to upgrade your store to a newer minor version within the 4.6.x branch (for example, from version 4.6.0 to version 4.6.1) you will need to follow these steps:
 # Consider the environment and make a development copy of your store. For details, see the chapter [[X-Cart:Before the upgrade | Before the upgrade]].
-# Obtain an upgrade pack for the direct upgrade from your current version to the desired version. For details, see the chapter [[X-Cart:Obtaining_Upgrade_Packs_and_Database_Upgrade_Scripts#Obtaining in-branch upgrade packs | Obtaining in-branch upgrade packs]].
+# Obtain the upgrade pack(s) for the direct upgrade from your current version to the desired version. For details, see the chapter [[X-Cart:Obtaining_Upgrade_Packs_and_Database_Upgrade_Scripts#Obtaining in-branch upgrade packs | Obtaining in-branch upgrade packs]].
 # Apply the upgrade pack to your X-Cart installation. For details, see the chapter [[X-Cart:Applying_Upgrade_Packs_and_Database_Upgrade_Scripts#Applying_upgrade_packs | Applying Upgrade Packs]].
 # Complete the required post-upgrade tasks. For details, see the chapter [[X-Cart:After the upgrade | After the upgrade]].
-===Upgrading from versions 3.5.x-4.5.x===
+===Upgrading from versions 3.5.x-4.4.5===
 ==Upgrading to X-Cart 4.5.x step by step==

@@ Line 22: / Line 22: @@
 === Upgrading to a later minor version ===
-When you upgrade the store to a later minor version within the same 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 are upgrading. The packs are applied automatically through a special section of the X-Cart Admin area.
+When you need to upgrade the store to a later minor version within the same 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 are upgrading. The packs are applied automatically through a special section of the X-Cart Admin area.
 Nonetheless, this task can become more complicated if you are upgrading 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 to the required version. For example, if the current version of your store is X-Cart 4.0.6, and you want to upgrade it to X-Cart 4.0.19, which is the latest version within the 4.0.x branch, first you will need to upgrade from version 4.0.6 to 4.0.17, then from 4.0.17 to 4.0.18, and only after that to version 4.0.19. Besides, you will need to re-install the skin template and the add-on modules, if you use any.
@@ Line 30: / Line 30: @@
 === 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. There are no ready-made upgrade packs to be used on your X-Cart copy; instead, you need to install a fresh copy of X-Cart and point it to the upgraded database. This approach is conditioned by the architecture of  X-Cart which changes significantly with each new major release leaving no technical feasibility to upgrade the software code and design automatically.
+When you need to upgrade your store to a later major version (for example, from X-Cart 4.2.x to X-Cart 4.3.x), the available upgrade options depend on the versions involved.
 In order to upgrade the database, you need to run a special script that will convert the data in the database so that it will be compatible with the X-Cart version to which you are going to upgrade your 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, database version 4.2.1 means that this database can be used with X-Cart version 4.2.1.
-Unfortunately, the set of available upgrade scripts is rather limited, and there may not be an upgrade script that will convert your given database to the version you require directly. In this case, you will need to convert your store database several times until you get a database compatible with the desired X-Cart version.
+The set of available database upgrade scripts is rather limited, and there may not be an upgrade script that will convert your given database to the version you require directly. In this case, you will need to convert your store database several times until you get a database compatible with the desired X-Cart version.
 The table below provides a list of available direct database upgrades: the column on the left contains source database versions; the column on the right shows direct database upgrades available for each particular source database version.
@@ Line 70: / Line 75: @@
 |}
 <br />
-In the situation when you have to upgrade the database several times successively, there may be more than one upgrade paths available. Please follow these recommendations for choosing the optimal upgrade path:
+In the situation where you have to upgrade the database several times successively, there may be more than one upgrade paths available. Please follow these recommendations for choosing the optimal upgrade path:
 * Among the alternative upgrade paths involving an upgrade within a branch, choose the one in which the upgrade within a branch is carried out on a more recent branch.
@@ Line 106: / Line 111: @@
 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.
-==Upgrading to X-Cart 4.5.x step by step==
+==Upgrading to X-Cart 4.7.x step by step==
 ===Upgrading from version 4.6.0 or later===
-If the version of X-Cart on which your current store is based is 4.6.0 or later, to upgrade your store to a newer minor version within the 4.6.x branch (for example to version 4.6.1) you will need to follow the same steps as described in the below section "Upgrading from version 4.5.0 or later".
+If the version of X-Cart on which your current store is based is 4.6.0 or later, to upgrade your store to a newer minor version within the 4.6.x branch (for example to version 4.6.1) you will need to follow these steps:
 ===Upgrading from version 4.5.0 or later===
 If the version of X-Cart on which your current store is based is 4.5.0 or later, to upgrade your store to a newer minor version within the 4.5.x branch (for example to version 4.5.5) you will need to follow these steps:

@@ Line 16: / Line 16: @@
 ==General information on upgrading==
-=== Understanding X-Cart upgrade procedure ===
+=== Understanding the 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 a 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 the branch, and the third number means the minor X-Cart version, which is the software version within the branch. The major version numbers are increased when there has been a significant revision of the software functionality, behavior and template structure, whereas 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).
+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 a 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 the branch, and the third number means the minor X-Cart version, which is the software version within the branch. The major version numbers are increased when there has been a significant revision of the software functionality, behavior and template structure, whereas 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 are upgrading to a later minor version within the same branch or to a later major version (different 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 are upgrading. The packs are applied automatically through a special section of the X-Cart Admin area.
+When you upgrade the store to a later minor version within the same 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 are upgrading. The packs are applied automatically through a special section of the X-Cart Admin area.
 Nonetheless, this task can become more complicated if you are upgrading 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 to the required version. For example, if the current version of your store is X-Cart 4.0.6, and you want to upgrade it to X-Cart 4.0.19, which is the latest version within the 4.0.x branch, first you will need to upgrade from version 4.0.6 to 4.0.17, then from 4.0.17 to 4.0.18, and only after that 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]]).
+Important: 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 [[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. There are no ready-made upgrade packs to be used on your X-Cart copy; instead, you 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 each new major release leaving no technical feasibility to upgrade the software code and design automatically.
+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. There are no ready-made upgrade packs to be used on your X-Cart copy; instead, you need to install a fresh copy of X-Cart and point it to the upgraded database. This approach is conditioned by the architecture of  X-Cart which changes significantly with each new major release 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 will be compatible with the X-Cart version to which you are going to upgrade your 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, database version 4.2.1 means that this database can be used with X-Cart version 4.2.1.
-Unfortunately, the set of available upgrade scripts is rather limited, and there may not be an upgrade script that will convert your given database to the version you require directly. In this case you will need to convert your store database several times until you get a database compatible with the desired X-Cart version.
+Unfortunately, the set of available upgrade scripts is rather limited, and there may not be an upgrade script that will convert your given database to the version you require directly. In this case, you will need to convert your store database several times until you get a database compatible with the desired X-Cart version.
 The table below provides a list of available direct database upgrades: the column on the left contains source database versions; the column on the right shows direct database upgrades available for each particular source database version.
@@ Line 98: / Line 98: @@
 ===Associated difficulties===
-New releases not only enrich the software with new features and capabilities, but they also get rid of outdated elements and techniques that are no longer in great demand. If you have gotten used to the logics and behavior of your current X-Cart version, or if you extensively use the elements that are not supported in later X-Cart releases, an 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 the new X-Cart release.
+New releases not only enrich the software with new features and capabilities, but they also get rid of outdated elements and techniques that are no longer in great demand. If you have gotten used to the logics and behavior of your current X-Cart version, or if you extensively use the elements that are not supported in later X-Cart releases, an upgrade may involve extra inconvenience. It is recommended that you study the CHANGELOG, which is updated with each new release and is included with every distribution package. The CHANGELOG provides a complete list of fixes and improvements that were introduced to the new X-Cart release.
-Another critical issue with X-Cart 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 the like. Yet, if the store has serious design changes, or if 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.
+Another critical issue with X-Cart 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 the like. Yet, if the store has serious design changes, or if it utilizes some custom code and third-party add-on modules that interfere with the original software behavior, '''you will need to re-implement the custom code and design after the upgrade''', which requires adequate experience in PHP, HTML and MySQL. So, if you are using 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 you are satisfied with how the store works at the moment.

← Older revision		Revision as of 09:37, 28 April 2014
Line 12:		Line 12:

	<videoflash>SlbbQ6waWAk\|800\|476</videoflash>		<videoflash>SlbbQ6waWAk\|800\|476</videoflash>
		+	<br /><br />

	==General information on upgrading==		==General information on upgrading==