MAGENTO Migration Tools User Guide Copyright 2014 LitExtension.com. All Rights Reserved. Magento Migration Tools: User Guide Page 1
Content 1. Preparation... 3 2. Setup... 5 3. Plugins Setup... 7 4. Migration Speed Optimization... 8 5. Enter License Key... 9 6. Migration... 10 7. Migration Resuming... 14 8. Advanced Configuration... 16 9. Use Cases... 17 10. Data Verification... 18 11. Frequently Asked Questions... 19 Magento Migration Tools: User Guide Page 2
1. Preparation For Source Store: - Please ensure you have the right permission to upload files into your Source Store. - It must not block access from Target Store to the connector. Source Store can operate normally during migration as it requires a very limited resource for the process. PHP Compatibility: PHP 4.x or later. For Target Store: It is strongly recommended to backup Magento Target Store first. - Target Store should be placed in a stable hosting or in localhost. - It also must not block connection to Source Store. - Webserver (mostly apache) should have full permission to write on /media folder. PHP Compatibility: PHP 5.3 or later. Magento Compatibility: 1.7 or later. Required PHP extensions: - pdo_mysql - simplexml - mcrypt - hash - GD - DOM - curl - mb_strings Required PHP configurations: - memory_limit no less than 256Mb - allow_url_fopen must be On - base64_decode should be allowed Magento Migration Tools: User Guide Page 3
Disable email notification To prevent email notification during customer import, it is recommended to disable it via Magento backend and reenable when migration is completed. Login to Magento backend Go to the System->Configuration menu. On the left hand menu under the Advanced tab (at the bottom) select the System menu item. Select Mail Sending Settings from the selection on the right hand side. Set Disable email communications to Yes, then no email will send through Magento. Magento Migration Tools: User Guide Page 4
2. Setup After downloading the product zip file from our Store, please extract it into a folder. The module consists of two main parts: Magento Data Migration Module ( app and skin folder) and Source Cart Connector ( Magento_connector folder) 1. Magento Data Migration Module Setup Magento Data Migration Module is a Magento Module which acts like a hub at Magento side to receive data and import it into Magento database. It can be installed just like all other Magento Modules, please follow our general Installation Guide: http://litextension.com/docs/litextension_installation_guide.pdf 2. Source Cart Connector Setup Extract Magento_connector into Source Cart root folder. After finished please make sure Migration Connector can be reached at: http(s)://yourstore.com/magento_connector/connector.php Magento Migration Tools: User Guide Page 5
If you have any problem reaching the link please ensure you have htaccess configured correctly and the file has execution permission. For security, please open connector.php, find this very first line: define('lecm_token', '123456'); And change "123456" to another string, this will be used to enter to the Migration Form (Cart Token) and acts like "password" to prevent unauthorized data access to your source store. Note: please do not use special characters in token or else the migration tool might fail to work, it should contain number and alphabet characters only. Examples: - Good token: 12ab34cd56 - Bad token: #Fr35h#Mi!5 Magento Migration Tools: User Guide Page 6
3. Plugins Setup Plugins are purchased and setup separately into Magento Data Migration Module. They will provide additional functionalities to the tool. Normally plugins need to be customized and tweaked by LitExtension Team to fit customers requirements and will be sent to customers later on. There are a few types of plugin: - Products and Categories SEO Urls Plugin: helps migrate Products and Categories urls. Old urls will be saved in Target Magento Store and will be maintained to keep all current SEO ranking you have built up for years. - Custom Fields Plugin: help migrate custom fields from Source Store to Target Magento Store. This is useful in case customers have customized their store, for example: adding fields to database tables, and also want to migrate these fields into Magento Store. - Customer Password Plugin: special plugin which adds the ability to read passwords encrypted by Source Stores to Magento. All passwords are migrated over and remains encrypted, customers can login to the new shop right away without the need of resetting passwords. "Zencart to Magento" and "Magento to Magento" tools natively support migrating passwords and do not need this plugin. To install plugins, just copy plugin files into the instructed folder inside Cart Migration Magento Module, new functionalities will be enabled. Magento Migration Tools: User Guide Page 7
4. Migration Speed Optimization For Source Store: - The faster Source store can be accessed, the faster migration speed will be. For Target Store: - As migration process is processed mostly on Target store, it is critical to have a fast magento server. Recommended server configuration: 4 cores or higher, 4G memory or higher. - Compilation should be enabled to improve speed ( System > Tools > Compilation ). - Cache should be enabled to improve speed ( System > Cache Management ). Magento Migration Tools: User Guide Page 8
5. Enter License Key License Key is an encoded string which comes with your download package. This key is needed to activate your Migration Tool. 1. After purchasing the product, please login to our store and enter My downloadable products section. Here you will find download link and license key for the download package. 2. Login your Magento Target Store backend, select Cart Migration > Configuration, and copy and paste your license key here: Magento Migration Tools: User Guide Page 9
6. Migration Please login your Magento Target Store backend, select Cart Migration > Migration The migration will go through 3 simple steps. Just hit Next when you finish one step to advance. Step 1: Source Cart Configuration Cart Type: select corresponding source cart type (oscommerce, ZenCart, VirtueMart, WooCommerce,..) Cart Url: source cart full url Cart Token: the token string which has been configured in connector.php Magento Migration Tools: User Guide Page 10
Step 2: Migration Configuration Root Category: the category of current Magento store to import all source cart categories into. Product Attribute Set: select an Attribute Set which is used to import products, all necessary attributes in migration process will be created in to this set. Languages Mapping: If your Source Cart is multilingual, corresponding languages ( or storeviews) should be available in Target Magento Store. You may need to create additional languages in Magento Store to avoid data loss. Currencies Mapping: Assign Source Cart currencies to proper Target Magento Store currencies. Creating currencies in Target Magento Store may be needed. Orders Status Mapping: Assign Source Cart order statuses to proper Target Magento Store order statuses. Creating additional order statues in Target Magento Store may be needed. Entities to Migrate: select all entities to migrate or just a part of them. Magento Migration Tools: User Guide Page 11
Additional Options: Migrate recent data: if you choose this option, it will migrate new data only. Supposed you have just finished a full migration from your current Source store to Target store, after that Source store is still live and continue getting new data, and you want to get your Target store updated with the new data, select this feature to avoid starting over again. Clear current data on Target Store before Migration: if you choose this option, all current products, categories, manufacturers, customers, orders, product reviews, taxes will be cleared. Migrate categories and products SEO URLs: if you choose this option, old SEF urls of source will be preserved in Target Magento Store, allowing you to maintain your Pagerank. Transfer images in product descriptions to Target Store: download all images in product description into your store so that it won t have to refer back to your source store or anywhere else for images. Preserve Customer IDs on Target Store: this will help you preserve your old Customer IDs for easier reference. Magento Migration Tools: User Guide Page 12
Preserve Order IDs on Target Store: this will help you preserve your old Order IDs for easier reference Step 3: Migration The migration will take place automatically in this final step. In order for it to progress, you should not close your browser of remove Source Cart Connector. After the migration is completed, click on Clear Cache and ReIndex Data to finish. If you don t want to run it right here or it returns false for any reason, you can do that manually in System > Cache Management and System > Index Management. Magento Migration Tools: User Guide Page 13
7. Migration Resuming When a problem occurring on the migration process, Magento Migration Tool provides the ability to resume the process: 1. Automatically resume on the spot: the tool will automatically resume after a failure until all data is imported. 2. Manually resume: you can refresh the page to go back to Step 1 and click on Resume, this is helpful when you want to temporarily stop migration and resume when you want to. Magento Migration Tools: User Guide Page 14
Magento Migration Tools: User Guide Page 15
8. Advanced Configuration Access Advanced Configuration by going to Cart Migration > Configuration from Magento backend menu. All default values are configured to work with most cases, thus it is recommended to change these values only when it is necessary to. XXX Per Batch: Cart Migration splits each entity data into small batches (or chunks) and import them in turn. This option defines batch size to process in each turn. Depending on your Magento hosting resource you can change the values accordingly. The lower the value is, the less time and resource Magento spends to process a batch, also the longer overall time to import full data. Delay Time: the sleeping time between each batch. This option defines the break time for both Source Store and Target Store. It is also helpful to prevent Timeout issue if Source Store has been setup to limit the number of requests in a period of time. Auto Retry After: if by some reason, the batch process fails, the tool will automatically retry after a period of time defined by this option. Magento Migration Tools: User Guide Page 16
9. Use Cases 1. Clear current data and fresh migrate all data Proceed normaly to Step 2, here please choose All entities and Clear current data of target store. Hit next to proceed to Step 3. 2. Clear current data and fresh migrate some specific entities Proceed normaly to Step 2, here please choose only entities you want to migrate and Clear current data of target store. Hit next to proceed to Step 3. Note: Clear current data of target store will only clear data of selected entities. 3. Incremental migration Lets say you have successfully performed first migration from Source store to Target store for a few/all entities. Data has been imported properly. A few days later, your Source store has some more data and you want to import this new data only ( incremental migration ). Here is how to do it: - Incremental migration can only be done for most recent migrated entities. Example: if you have migrated all entities for the first time, in the second time you can incrementally migrate new data of all entities. If you only migrated for example Customers + Orders only, the next time you can only perform incremental migration for Customers + Orders. - Proceed normally to Step 2. Here please choose entities you want to migrate ( must be the same entites you migrated last time ) and Migrate recent data. - Proceed to Step 3. Magento Migration Tools: User Guide Page 17
10. Data Verification 1. Default data Migrated data should be checked in Target Store backend because information displayed on frontend might go through filters, modifications by the store template which does not fully justify how the data was migrated. 2. SEO Urls How SEO Urls Plugin works: "Products and Categories SEO Urls Plugin" helps migrate Products and Categories urls. Old urls will be saved in Target Magento Store and will be maintained to keep all current SEO ranking you have built up for years. In most cases, you would likely have an old source store at : http://my-source-store.com and want to migrate your data to another location http://my-target-store.com, after that you want to put this store back to your old domain ( http://my-source-store.com ). If you have used SEO Plugin to migrate old product and category urls over to target store, you can check the result by following these steps: 1) Pick a product url ( or category url ) from your source store, example: http://my-sourcestore.com/troika-black-carbon-pen 2) When this product (category) is migrated to your target store, it would likely a new url, example: http://my-target-store.com/troika-black-carbon-pen-new-url-123. This url is auto generated by your new store platform and can not be changed. Type the old relative url on your target domain, example: http://my-target-store.com/troika-blackcarbon-pen. This url should work and display the correct product/category, and would be identical to the new url (http://my-target-store.com/troika-black-carbon-pen-newurl-123). 3) When you replace the source store with your new target store, this link (http://mysource-store.com/troika-black-carbon-pen) will be maintained and can help preserve search ranking. Please note: along with it, the new link (http://my-sourcestore.com/troika-black-carbon-pen-new-url-123) will also be available. 3. Customer Password If you have Customer Password Plugin, after migration, customers can immediately use their old passwords to login in the new store, without the need of resetting or any further action. Magento Migration Tools: User Guide Page 18
11. Uninstall After migration is completed, the migration tool might not be needed anymore. It is recommended to uninstall/disable the tool. 1. Remove the connector: the connector can be safely deleted on your source store. 2. Disable migration module: this is helpful when you want to quick disable the module and don t want to remove it: Open /app/etc/modules/litextension_cartmigration.xml change: <active>true</active> to: <active>false</active> After that, clear Magento cache. 3. Uninstall migration module: Manually delete all files/folders you of the modules. After that, clear Magento cache. Magento Migration Tools: User Guide Page 19
12. Frequently Asked Questions 1. Product import stops permanently at some specific point, how to resolve? Cause: php execution time too low Solution: Go to Cart Migration Configuration, change value Products per Batch to a lower number Increase you server php max_execution_time value 2. At step 2, the tool can not read my mapping data? Magento Migration Tools: User Guide Page 20
Cause: migration tool can not read your source store database Solution: check Cart Migration Configuration and ensure you enter correct table prefix for your source database 3. Magento database isn't working when hitting Next on Step 1? Cause: there was an issue with the installation, the module could not create its additional tables into Magento database. Solution: login mysql admin, run this script: Magento Migration Tools: User Guide Page 21
DELETE FROM `core_resource` where code = "lecamg_setup" After that, refresh the Step 1 page. 4. Can the tool migrate customer passwords? Yes! The tool can migrate passwords with "Customer Password Plugin". This is a special plugin which adds the ability to read passwords encrypted by source stores to Magento. All passwords are migrated over and remains encrypted, customers can login to the new shop right away without the need of resetting passwords. "Zencart to Magento" and "Magento to Magento" tools natively support migrating passwords and do not need this plugin. 5. Can the tool migrate products and categories old Urls to preserve SEO ranking? Yes! "Products and Categories SEO Urls Plugin" helps migrate Products and Categories urls. Old urls will be saved in Target Magento Store and will be maintained to keep all current SEO ranking you have built up for years. For us to create the plugin, please provide your source cart url, we will diagnose and create the plugin to send to you within 24 hours. There are cases which we also require FTP of your source cart. 6. My Source Store has some custom data which I have manually added, can we migrate such data to my target store? Yes! "Custom Fields Plugin" helps migrate custom fields from Source Store to Target Magento Store. This is useful in case customers have customized their store, for example: adding fields to database tables, and also want to migrate these fields into Magento Store. For us to create the plugin, please provide FTP of your source cart, we will diagnose and create the plugin to send to you within 24 hours. 7. More questions? Please drop us a message at: http://litextension.com/contacts/ Or email us at: contact@litextension.com We are striving to get your questions answered within 24 hours. Magento Migration Tools: User Guide Page 22