Difference between revisions of "Acme XML Import module"

From E-Abi.ee Wiki
Jump to: navigation, search
(Created page with " == 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-sho...")
 
Line 22: Line 22:
 
* Order number
 
* Order number
 
* e-mail address, that was used to place an order
 
* e-mail address, that was used to place an order
 +
 +
 +
== 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.

Revision as of 20:00, 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

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

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


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.