Difference between revisions of "Acme XML Import module"

From E-Abi.ee Wiki
Jump to: navigation, search
Line 18: Line 18:
 
Each time when Magento is moved to a different host of to a different directory, software should be re-licensed.
 
Each time when Magento is moved to a different host of to a different directory, software should be re-licensed.
 
License terms can be found here: [http://www.e-abi.ee/litsents E-Abi License terms]
 
License terms can be found here: [http://www.e-abi.ee/litsents E-Abi License terms]
 
Before registering your license, you should prepare yourself with the following data:
 
* Order number
 
* e-mail address, that was used to place an order
 
  
  
Line 52: Line 48:
  
 
If your system is using any of the namespaces or components, which are not manufactured by Aktsiamaailm LLC, then the current module may not install correctly to your system. Contact developer if you have any doubts.
 
If your system is using any of the namespaces or components, which are not manufactured by Aktsiamaailm LLC, then the current module may not install correctly to your system. Contact developer if you have any doubts.
 +
 +
== Installation ==
 +
Before installation prepare yourself with the following information:
 +
* FTP login details
 +
* Magento admin login details
 +
 +
Unzip the module to find the following zip files in install directory:
 +
* Eabi-Generic-Ajaxhandler.zip
 +
* Eabi-Attribute.zip
 +
* Product-Synchronizer.zip
 +
* Acme-Warehouse.zip
 +
 +
Unzip each file, one at a time, in the specified order. Each time file is unzipped, navigate in a way, that the contents would display the "app" folder.
 +
Copy the contents to Magento's root directory in way that unzipped app folder would match Magento's app folder and directory contents must be merged, not replaced.
 +
No file should be overwritten, if you are installing the extension for the first time.
 +
 +
When successful, delete the temporary unzipped files and repeat the procedure until all the listed zip file contents are installed.
 +
If you have installed any of the E-Abi.ee's XML import modules earlier, then you may find that you already have installed some of the zip files. In that case you only need to install the last zip file in the list.
 +
 +
After copying the files, log to Magento's admin and clear the Magento's cache.
 +
Log out of Magento and in again, this is required to re-load the newly defined permissions.
 +
Navigate to Admin -> System -> Configuration -> E-Abi Acme Acc Product Import
 +
 +
License your copy
 +
 +
 +
== License registration process ==
 +
Before registering your license, you should prepare yourself with the following data:
 +
* Order number
 +
* e-mail address, that was used to place an order
 +
 +
Click on the © icon on top right of the "Show Current status" label to display the license registration link, if not already displayed
 +
You are redirected to E-Abi.ee page, where you need to enter the Order Number and email address.
 +
After successful entry you are asked which product to license - check all the ordered products you wish to license
 +
If you are licensing for second or greater time, then you also need to provide a reason for re-licensing. For example "Change of server" or "Magento reinstall" are adequate reasons.
 +
 +
When successful, you are automatically redirected back to E-Abi Remote Product importer with success message. If not, then click on the button to enter the license data.
 +
By default license registration link should not be displayed any more.
 +
 +
 +
== Setting it up ==
 +
Module settings can be found at:
 +
Admin -> System -> Configuration -> E-Abi Acme Acc Product Import
 +
Each field is defined separetely below
 +
 +
=== Current State ===
 +
Displays information about the currently running process, which is initiated by E-Abi XML Import module.

Revision as of 20:19, 25 October 2012

Introduction

Current end user guide is about the module for Magento, which adds the following functionality to Magento webshop:

  • Imports products to Your Magento e-shop from Acme Acc Warehouse
  • Updates product prices and stock levels at pre-defined regular intervals or by user initiation
  • Allows Magento administrator to replicate the category structure from remote warehouse very easily
  • Allows to import all products or import products from certain categories only
  • Allows to monitor what is currently going on, as each time a procedure is run, it is shown at the configuration panel
  • Allows to create external modules, which can affect the import process for each product. This way if you want a product to be imported differently, module can be written for this task


Licensing

This software is Licensed by Aktsiamaailm LLC and contains one time online activation. Software itself is open source and contains the licensing logic. Removal or alteration of such logic is prohibited and may cause software not to function correctly and removes the right for technical support. License is tied to the following components (which are also sent to the Aktsiamaailm LLC-s server):

  • Hostname
  • Magento's base directory
  • Modules to be licensed

Each time when Magento is moved to a different host of to a different directory, software should be re-licensed. License terms can be found here: E-Abi License terms


Requirements for using this extension

  • Contractual relationship with Acme Acc (without it, only test account is available)
  • Magento Community Edition 1.3 or greater (Magento 1.5 or greater is recommended)
  • Soap Extension must be enabled
  • Ability for the PHP script to raise memory limit up to 512M
  • Magento Cron should be configured


Systematic changes to Magento when installing this module

  • New added attribute set with name Eabi_EE, which is based on Default attribute set and adds under General tab the following attributes:
    • eabi_mpn - Holds Manufacturers product number
    • eabi_manufacturer - Holds the Manufacturer name as drop-down menu
    • eabi_warranty - Holds the product warranty lenth information in months
    • eabi_dateExpected - If product is out of stock, then the expected date, when product should be in stock
    • eabi_disableRemoteUpdate - When this field is filled, automatic updates for the product are disabled
    • eabi_margin - Holds the Margin amount to be added on top of the warehouse product price
    • eabi_marginType - Defines whether the margin amount is represented as absolute or as percent
  • New category attribute with code
    • remoteId - Holds the warehouse ID of the imported category
  • Uses class prefix of Eabi_Acmew
  • Uses Model prefix of eabi_acme
  • Uses Helper prefix of eabi_acme
  • Uses the following Eabi_Components
    • Eabi_Synchronizer - XML import framework
    • Eabi_Attribute - Framework to manipulate custom product and category attributes
    • Eabi_Livehandler - Framework to inject helper functions anywhere in Magento by ajax and fetch configuration data

If your system is using any of the namespaces or components, which are not manufactured by Aktsiamaailm LLC, then the current module may not install correctly to your system. Contact developer if you have any doubts.

Installation

Before installation prepare yourself with the following information:

  • FTP login details
  • Magento admin login details

Unzip the module to find the following zip files in install directory:

  • Eabi-Generic-Ajaxhandler.zip
  • Eabi-Attribute.zip
  • Product-Synchronizer.zip
  • Acme-Warehouse.zip

Unzip each file, one at a time, in the specified order. Each time file is unzipped, navigate in a way, that the contents would display the "app" folder. Copy the contents to Magento's root directory in way that unzipped app folder would match Magento's app folder and directory contents must be merged, not replaced. No file should be overwritten, if you are installing the extension for the first time.

When successful, delete the temporary unzipped files and repeat the procedure until all the listed zip file contents are installed. If you have installed any of the E-Abi.ee's XML import modules earlier, then you may find that you already have installed some of the zip files. In that case you only need to install the last zip file in the list.

After copying the files, log to Magento's admin and clear the Magento's cache. Log out of Magento and in again, this is required to re-load the newly defined permissions. Navigate to Admin -> System -> Configuration -> E-Abi Acme Acc Product Import

License your copy


License registration process

Before registering your license, you should prepare yourself with the following data:

  • Order number
  • e-mail address, that was used to place an order

Click on the © icon on top right of the "Show Current status" label to display the license registration link, if not already displayed You are redirected to E-Abi.ee page, where you need to enter the Order Number and email address. After successful entry you are asked which product to license - check all the ordered products you wish to license If you are licensing for second or greater time, then you also need to provide a reason for re-licensing. For example "Change of server" or "Magento reinstall" are adequate reasons.

When successful, you are automatically redirected back to E-Abi Remote Product importer with success message. If not, then click on the button to enter the license data. By default license registration link should not be displayed any more.


Setting it up

Module settings can be found at: Admin -> System -> Configuration -> E-Abi Acme Acc Product Import Each field is defined separetely below

Current State

Displays information about the currently running process, which is initiated by E-Abi XML Import module.