Upgrading Zen Cart(tm) in 3 Easy Steps!



Welcome to Zen Cart™ ...

The Zen Cart™ software is made available to you for use, additions, changes, modifications, etc. without charge, under the GNU General Public License.


While we do not charge for this software, donations are greatly appreciated each time you download a new version, to help cover the expenses of maintenance, upgrades, updates, the free support forum and the continued development of this software for your online e-commerce store.


Donations can be made at:
The Zen Cart™ Team Page


We appreciate your support.
The Zen Cart™ Team



Zen Cart™ is derived from: Copyright 2003 osCommerce
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
and is redistributable under the GNU General Public License







This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.





3 EASY STEPS TO UPGRADE ZEN CART™

Paypal IPN NOTE

If you are using the PayPal IPN payment module, you will need to Remove and re-Install the PayPal IPN module in Admin->Modules->Payment->PayPal IPN in order to take advantage of the bugfixes in the module.
Getting Started ...
This is a basic guide to upgrading Zen Cart™. If you have not yet installed Zen Cart, please see the 1.readme_installation.html file for installation instructions.

To upgrade Zen Cart™, you'll need the same basic tools you used to install and customize it in the first place: An FTP program, a text editor friendly to HTML/PHP code, phpMyAdmin or equivalent access to your MySQL database, and your Control Panel for managing your webspace.

Additionally, you will find a file-comparison tool like WinMerge, Beyond Compare or ExamDiff (Linux) to be very helpful.
(There's also BBedit for the Mac.)

Upgrading follows 3 easy steps. We suggest you take your time going through each stage carefully and methodically. Don't rush the process. And as always, be sure you keep good backups first.

We highly recommend you pay special attention to getting familiar with the demo data in the new version, so that you can become comfortable with the many new features contained in the new release.

1. Preparation
Unzip a copy of the new version of Zen Cart™, upload it to your webserver into a "demo" folder, and install the new version into a separate database, and include the Demo products.
This is just for a place for you to play with the new version and get used to its new features. These can be deleted after conversion is complete.

Study the new features, and the documented changes to the template structures, as well as the "changelog". Use the demo products in the demo shop as examples. See also the supporting documentation provided with the new release.


Make a full backup of your database (dump to SQL file). Store this file on your PC for later reference.

Make a full backup of your site files (ftp to your PC and zip it up for safe-keeping).
Keep the backup on your PC to use in next steps. Perhaps call this folder "\zen_backup".


Now let's find out the differences/customizations details between your site and the original Zen Cart files.

Unzip a copy of the original Zen Cart™ files for the version you originally installed or last upgraded from (ie: perhaps v1.2.7 or even 1.3.6). This should be placed in a separate working folder on your PC (perhaps "\zen_orig").

Make a list of any add-ons you have installed, for later reference.

Run a tool like WinMerge to compare the "Original" Zen Cart™ files in "\zen_orig" against your working backup files in "\zen_backup".
Note all the files that are "different". In WinMerge, double-click on each file and note what the differences are.
If the differences are just language defines for display text, those will be simple to carry forward.
If the differences are actual programming/code differences, you will need to make detailed notes in order to carry over those changes to the new new new version.
Any mods/add-ons you've installed will likely contain many programming changes, and may not be fully compatible with the newer Zen Cart™ release.

Your list of add-on's may help you narrow down the source of any differences you're finding between versions. You may have to download the add-on again to take a look at the readme or code contained in it. You may have to contact the author to ask for an updated version.


As you make your list of changed files, etc, at this stage, you may want to move things into the Zen Cart™ template-override structure, if you haven't already done so. See the Zen Cart™ site for FAQ's on the template system.

2. Execution
Download and unzip the latest Zen Cart™ version to your PC. This will be in a 3rd directory (perhaps "\zen_new"), separate from the other two folders compared above.

Using the list of files you made earlier, go through each "changed" file, and make your changes from the old version into the new version.
Simple language edits will be just a matter of copy-and-paste.
Programming changes to core components will be more difficult and require significant testing.
You may find WinMerge handy at this stage to apply edits as well. However, you will see many extra differences that may not be related to your own customizations, or that may conflict. Be careful making changes to program code.

Note that there will be several changes you will have to make to files that you have overridden using the template overrides system. Thus, you'll want to compare files from /includes/templates/MYTEMPLATE/* to /includes/template/template_default/* ... and the same with language file overrides, sideboxes, etc.


3. Testing
Make a NEW database to install the new version of Zen Cart™ into. Use your hosting control panel to do this.

If the last backup you made of your data is older than the last order that might have been processed or customer registration, make a fresh database backup.
Restore your database from the backup in step #1 earlier into your NEW database just created.

If your /zen_new folder doesn't have "/includes/configure.php" and "/admin/includes/configure.php" files, copy them from your old store folder.

EDIT your "/zen_new/includes/configure.php" file and ensure that your DATABASE_NAME matches your NEW database. Also verify database username and password in case that information has changed. Save this file, and be sure to upload it as part of the next step. Repeat for the /admin/includes/configure.php file as well:

Upload the files from your modified "new version" (created in step 2) to your server, into an alternate folder, perhaps called "/store_new".

Ensure that you have uploaded the "/zen_new/zc_install" folder to your server.
Using your browser, surf to /zc_install/index.php and choose "Database Upgrade" when prompted. (Don't select "Install", or you will overwrite your database.) (If "Upgrade" is not offered, then the installer was unable to connect to your database to confirm what version its structure is at. Check your configure.php settings.)

Test your customizations. Edit as needed. Compare with the test/demo install performed earlier, as needed.

When satisfied that all is OK, go live.
If significant time has passed since you did your last backup, you may want to repeat the steps in this "Testing" section again, using a fresh backup from your live shop. You don't need to re-upload files again ... simply do the database restore, and run the installer to do the database upgrade again.

To go live, put your shop into "Down for Maintenance" mode in the admin area. Be sure to add your IP address to the list of allowed addresses to get into the site for previewing.
This can be done easiest by renaming "store_new" to "store". (You'll have to rename "store" to something else first.)
Test it to be sure that things are operating as desired. If you have small problems to repair, turn "Down for maintenance" on and off again as necessary.




Help and Support
For additional help and support issues, check out our FAQs and visit our Support Forums on the web at: www.zen-cart.com

Good Luck with your upgrade. We're glad you're enjoying the Zen Cart™ Experience!



Special Upgrade Steps Specific to Zen Cart™ Versions
Upgrading to v1.3.5+ from earlier 1.3.x
NOTE: for HTMLarea users

The /htmlarea folder has been MOVED into /editors/htmlarea
You should move your old files to the new location before editing, as this will make things go a little smoother. Note that a couple files have changed in the htmlarea folder to accomodate the new folder path.

Activating the PayPal IPN Payment Module
In almost every release, the PayPal IPN module had overhauls. If you are using the PayPal IPN module, you'll need to reactivate it after installing the new files:
To activate it, you'll need to "Remove" and "Install" the module via Admin | Modules | Payment.

Take note of the email addresses and other settings already configured in your PayPal IPN module before removing, so you can re-enter them after Installing the module again.
Other Payment Modules
The Authorize.net AIM module had a few minor changes in v1.3.7.
To activate it, you'll need to "Remove" and "Install" the PayPal module in Admin | Modules | Payment.

Take note of the login ID, transaction key, and other settings already configured in the module before removing, so you can re-enter them after Installing the module again.




Zen Cart™ Copyright 2006