Installation

 

Installation Steps



Please follow these steps to install your extension. These installation instructions have been refined over the past 2 years and provide comprehensive installation guidance. If you do not follow these steps as indicated you may well see issues with your install, which may take some time to resolve. So please follow each step carefully and if the install fails re-check the steps.
 
Warning: It is highly recommended to backup your server files and database before installing this module. No responsibility can be taken for any adverse effects it may cause. It is also recommended you install on a test server initially to carry out your own testing. For more information regarding our disclaimer see here.

 

    1. Switch off the Magento Compiler if enabled under System->Tools->Compilation

    2. Ensure Cache is enabled in Admin
       
    3. Extract all the zip archive(s). On some installations you may have a separate archive called WsaCommon. This is required by the extension and must be installed

    4. Copy the app directory from src into your Magento base directory overwriting any files. *
             Note: This does not overwrite any core files~



    5. If the folder app/design/frontend is present in your extension zip please ensure these files are merged into your theme

    6. If the folder app/design/adminhtml is present in your extension zip please ensure these files are merged into your theme

    7. If in the zip archive you have a folder skin please ensure these files are merged into your theme

    8. Copy over any other files under the src area to your Magento install (e.g. lib changes, etc)

    9. Log out of admin and back in. If you do not do this you will get 404 Access Denied errors

    10. Disable cache in admin


    11. Flush the magento cache storage in cache management by clicking the 'Flush Magento Cache' Button. (Or you can manually remove '/var/cache' and 'var/session' contents)

    12. Open frontend of website to force extension to load (this will ensure that the sql updates within extension are performed).

    13. If you're using the compiler you need to recompile via System->Tools->Compilation (it will say here if it's compiled, if you're using 1.4 and it's compiled but disabled you may need to re-compile anyway)
      If you do not you will see an error similar to 'Call to a member function toOptionArray() on a non-object...' when accessing shipping methods. You may also see Fatal Errors for missing files
    14. You have now installed your extension and should see it present in relevant area of backend

    15. On Magento 1.4.* re-index all data in Index Management (Configuration)

    16. Re-enable cache in admin.

You should now return to your extension specific installation instructions.

 

Problems After Installation



If you are experiencing problems after installing, please first go through each step above again and ensure you have installed correctly. Then see our troubleshooting guide here.
 
If you cannot resolve the issues then disable the extension by navigating to Root Magento Install/app/etc/modules/ and find the .xml file for the extension you just installed. Rename this file to filename.xml.disable

This totally disables the extension and all functionality of the extension. If you're still having issues after this the problem is not being caused by the extension but by some external factor. Refreshing the cache will cause all latest files to be uploaded, so it could be as a result of doing this.
 
 

Uninstalling an Extension


There may be ocassions when you are upgrading that you need to uninstall our extension completely. Follow these steps.
  1. Disable cache
  2. Remove files from app/code/local/community (matrixrate) or app/code/local relating to the extension. These may be under a Webshopapps or Auctionmaid banner
  3. Remove the relevant .xml file from app/etc/modules
  4. Run the workaround to delete the extension from the list of shipping carriers - see here
  5. Verify removal on admin/frontend
  6. Enable cache
All our extensions sit in the app/code/local or app/code/community areas, so there is no impact on core code.