OSF INTEGRATOR for INGRAM MICRO Integration Guide

(1)

(2)

1 Installation

Please follow these steps to install your extension.

Warning: it is highly recommended to backup your server files and database before installing this module.

No responsibility can be taken from any adverse effects it may cause. It is also recommended to install on a test server initially to carry out your own testing.

This extension was developed in accordance with Magento standards, but we do not guarantee it will work with other third-party extensions.

1. Switch off the Magento Compiler if enabled under System->Tools->Compilation 2. Ensure cache is enabled

3. Extract all the zip archive into your Magento base directory overwriting any files. *Note: This doesn’t overwrite any core files.

(4)

6. Flush the magento cache storage in the cache management by clicking the “Flush Magento Cache” Button (or you can manually remove /var/cache and /var/session contents)

7. If you’re using the complier you need to recompile via System -> Tools -> Compilation 8. Re-enable cache.

9. Reindex the Magento Indexes

During installation, two attributes will be created and associated with products: Vendor and Cost. This will be automatically populated during import with “Ingrammicro” and price values. A new table will also be added to the database “osf_ingrammicro_queue”

1.1 Disabling Extension

Disable any Magento extension by:

 Opening the relevant extension file in app/etc/modules (Osf_IngramMicro.xml)  Set active to false

 Save file  Refresh cache

1.2 Uninstalling Extension

There may be occasions when you need to install our extension completely

 Disable cache

 Remove the following directory and included files from app/code/community/Osf/Ingrammicro  Remove the relevant .xml (Osf_IngramMicro.xml) file from app/etc/modules

(5)

2 Configuration

Before using this extension, you’ll need to configure it.

The configuration can be found in System -> Configuration -> OSF -> Ingram Micro Configuration. You should have a screen like the following:

The settings are described in the below sections.

Field Definition

Ingram Micro Account number The account number received from Ingram Micro

(6)

{Category Code}_{CPU Code}|{Magento category tree} E.g. 0001_DESKTP|All Products/Computers/Desktop Computers

Ftp Server FTP host provided by Ingram micro. This will be the location used by the module to pull inventory file.

Ftp Username FTP user provided by Ingram micro.

Ftp Password FTP password provided by Ingram micro

Ftp Remote Directory FTP relative path to the inventory file, provided by Ingram micro. E.g. DIRECTORY/SUBDIRECTORY

Ftp Products Filename Inventory filename. Provided by Ingram micro. E.g.

FILENAME.ZIP

Filtered SKUs File Upload a .csv file with SKUs you want to import. If no file is uploaded then all Ingram Micro products from

inventory file will be imported

XML Endpoint Ingram micro load balanced URL to post documents to.

XML Username Username provided by Ingram micro

XML Password Password provided by Ingram micro

3 Usage

This module is designed to automate Ingram Micro operations:

 automated product loading

 inventory updates

 _{order placement}

 Shipment and invoice generation

3.1 Automated product loading and inventory updates

(7)

To check if new products have been imported from Ingram Micro, simply access from backend: Catalog > Products

All products imported from Ingram Micro will be set as Not visible Individually, vendor as Ingrammicro and they will be placed in the corresponding category if there is one found.

Once the product import finished, you'll need to set the product accordingly: visiblity, price etc.

During updates, all these information is protected. The only information that will be updated is the inventory and cost information.

3.2 Category Mapping Import

Upload a .csv file to map Ingram micro imported products with your custom category tree. A row should look like this:

{Category Code}_{CPU Code}|{Magento category tree}

E.g. 0001_DESKTP|All Products/Computers/Desktop Computers

3.3 Filter Ingram Micro Inventory file

Since Ingram Micro inventory file is very large and contains a lot of SKUs, some of our clients requested a filter solution implemented in the module. Therefore a new option has been introduced to allow store admins to upload a csv file with preferred SKUs

3.4 Order Placement

Once an order is placed on Magento, the module will identify and isolate products that are coming from Ingram Micro and it will place though API an order on Ingram Micro systems. This can be easily verified in the Order View / Comments History, where ingram micro branch order number will be listed:

(8)

4 Shipment and Invoice Generation

In order to automate shipments and invoices, the module is built to accept an ASN response from Ingram Micro. Based on the response an invoice will be created and the shipment will be set as shipped.

In order to accept ASN data from Ingram Micro you'll need to contact your Ingram Micro representative and to communicate the callback URL. This is the following:

http://{magento-url}/index.php/ingrammicro/callback/api