OSF INTEGRATION for SYNNEX Integration Guide

Transcription

1 OSF INTEGRATION for SYNNEX Integration Guide

2 Table of Contents 1 General extension information How to install the Synnex extension Disable the extension Uninstall the extension How to setup the Synnex extension How the extension works How does the import of products work? How does category map work? How does the purchase order work? How does the ship notice work? Pg. 2 11

3 1 General extension information Products are imported in the first website created. Products are imported with visibility hidden and status disabled. This is so you do not add a product to your shop that does not have your selected price. You need to manually add the price. You will have access to the cost (the Synnex Price). Products are imported as simple products. There is no tier price on import. Category Map file: - Category paths do not include the root category. - Synnex categories must not have 0 in front of the category ID. For the import of the products, the following conditions are set by default: - The column 39 - The column 40 2 How to install the Synnex extension Please follow these steps to install your extension. Warning: it is highly recommended to back up 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 that you 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. Back up your database and your Magento files. 2. Unzip the extension into a temporary location. 3. Switch off the Magento Compiler if enabled under System->Tools->Compilation 4. Copy the extension into its design location (The extension has the normal Magento structure so you can copy the unzipped extension directly to the root of your Magento installation). Pg. 3 11

4 5. Refresh the Magento cache. 6. Log out from the Magento admin. 7. Log in back to Magento admin. 8. If you re using the complier, you need to recompile via System -> Tools -> Compilation 9. Refresh the Magento Cache. 10. 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 Synnex and price values. A new table will also be added to the database synnex_queue. 3 Disable the extension Opening the relevant extension file in app/etc/modules (Osf_Synnex.xml) Set active to false Save file Refresh cache 3.1 Uninstall the extension There may be occasions when you need to install our extension completely. In those cases, please follow the next steps: Pg. 4 11

5 Disable cache Remove the following directory and included files from app/code/community/osf/synnex Remove the relevant Osf_Synnex.xml file from app/etc/modules Verify removal on admin/frontend Enable cache 3.2 How to setup the Synnex extension 1. Go to the admin backend, go to System > Configuration, find the OSF tab on the left and click on Synnex Configuration. 2. You should have a screen like the following: 3. Fill out the all the fields as follows: Field Synnex Account Number Definition The account number provided by Synnex Pg. 5 11

6 FTP Server FTP Username FTP Products Filename XML Endpoint XML Username XML Password Upload Category Map File Import Conditions Column Definitions for import Conditions Column ID Synnex Name Synnex Description 01 Trading Partner Code 02 Detail Record ID The Synnex FTP server, where they store the file with the products to be imported and with the ship notices prepared by Synnex. Usually the FTP server is: FTP.synnex.ca The username provided by Synnex The name of the file that holds the products to be imported. Usually it is the letter c followed by the Synnex account number. Important: Please, if you are provided with a.zip file, add the name of the.zip file. The Synnex entry point for the Purchase Order. Usually the XML endpoint is: There is also a testing environment: after install please use the testing environment to place a few orders, to see that the extension works as you expect it. The username provided by Synnex for the XML endpoint The password provided by Synnex for the XML endpoint Select the file that has the category mapping. The file has to follow a standard. Please see Appendix A. The conditions for import, The conditions for import, delimited by ";" and space between the elements of the condition Available operands "=","!=",">","<". Ex: "column number" = "value" TP Code assigned to customer to provide unique ID for process. Code used to designate Detail portion of file: DTL Manufacturer 03 Manufacturer s Part Number Part# SYNNEX SYNNEX Part Number (Alpha numeric 04 Internal Use Part #) 05 SYNNEX SKU # Unique SYNNEX SKU Number sku 06 Status Code Product Update Status Code = A Added, C or S Changed, D Deleted 07 Part Description Product Description Manufacturer 08 Manufacturer s Name Name SYNNEX 09 SYNNEX Assigned Use Internal Use (For Internal Use Only) 10 Qty Total Qty On-Hand from ALL SYNNEX Stock Magento Field Name, short_description, description Pg. 6 11

7 11 (Total) SYNNEX Internal Use Locations SYNNEX Assigned Use Internal Use Only) 12 SYNNEX SYNNEX Assigned Use Internal Use (For Internal Use Only) 13 Contract Price SYNNEX Contract (Grid) price to (With Promo / Rebate) customer (with Promo/Rebate) 14 MSRP Manufacturer Suggested Retail Price Msrp 15 Qty US: Miami, FL; CA: Chicago, IL (Refer to Listing Below) 16 Qty US: Fremont, CA; CA: Halifax, N.S. 17 Returnable Flag Product Returnable Flag (Y/N) 18 Qty US: Chantilly, VA 19 Parcel Shippable Parcel Shippable Flag (Y/N) Note: N value=heavyweight/special Handing Product Qty Unit Cost (w/o Promo/Rebate) Qty 23 Media Type Qty SYNNEX CAT Code US:Richardson,TX; CA: Calgary Alberta (For Customer Price (w/o Promo/Rebate) US: Chicago, IL; CA: Guelph, Ontario Product Media Type RTL Retail, SWL -Software License, SWMP Software (Physical Media), SWMV Software (Virtual Media) US: Olive Branch, MS; CA: Markham, ON SYNNEX Product Categorization Code (Refer to SYNNEX Categorization Listing Below) US: 26 Qty Keasby, NJ; CA: Richmond, BC 27 SYNNEX Internal Use SYNNEX Assigned Use (For Internal Use Only) 28 Ship Weight Item Ship Weight Weight 29 Serialized Flag Is this item Serialized Y = Yes, N = No 30 Qty US: Beaverton, OR 31 Qty US: Norcross, GA 32 SYNNEX Reserved SYNNEX Reserved for Future Use Use (formerly City of Industry warehouse) 33 SYNNEX HC Price Healthcare Pricing EDI Code (HC) 34 UPC Code 35 UNSPSC Code Universal Product Code UPC CODE Online Resource UNSPSC Code UNSPSC CODE Online Resource SYNNEX 36 SYNNEX Assigned Use Internal Use (For Internal Use Only) 37 SKU Created Date this SKU was created in SYNNEX osf_vendor_cost upc Pg. 7 11

8 Date 38 SKU ATTRIBUTES SKU ATTRIBUTES Classification Coding Please Note: This is a fixed field value representing multiple Purchasing Requirement data elements as is available, represented as follows: Drop Ship Only Flag (1 Character Y or N) Refurbished Product Flag (1 Character Y or N) Manufacturer UPC Code Available Flag (1 Character Y or N) Additional Values will be added as needed. 39 ETA Date Estimate Time of Arrival Date (Backorder) 40 ABC Code ABC Status Code A Active, B Special Order, C EOL (End of Life), T To Be Discontinued 41 Kit/Stand K Kit SKU Alone Flag S Standard Alone SKU 42 State GOV Price State Government Pricing EDI Code (PAS) 43 Federal GOV Price 44 EDUcational Price Federal Government Pricing EDI Code (PAF) Educational Pricing EDI Code (EDK / EDH) 45 TAA Flag Trade Agreement Act Flag (Y/N) 46 GSA Pricing GSA Pricing 47 Promotion Flag SKU Promotion Flag Promotion 48 Comment SKU Promotion Comments Promotion 49 Expiration Date SKU Promotion Expiration Date 50 Long Description (1) Long Product Description (Part 1) (Available Upon Request) 51 Long Description (2) Long Product Description (Part 2) (Available Upon Request) 52 Long Description (3) Long Product Description (Part 3) (Available Upon Request) 53 Length Product Dimensions - Length Item_length 54 Width Product Dimensions - Width Item_width 55 Height Product Dimensions - Height Item_height 56 Qty Consumer Gaming Products & Accessories US: Olive Branch, MS 57 GSA NTE Price GSA NTE (Not to Exceed) Price 58 Platform Type Platform Type Code Values: ALL, LINUX, MAC, PC, SUN, UNIX Product Description (FR) SYNNEX Reserved Use Qty Qty Qty Product Description (Au Francias) SYNNEX Reserved for Future Use (formerly Las Vegas, NV warehouse) US: Ontario, CA (formerly Carson, CA) Consumer Gaming Products & Accessories US: Keasby, NJ Consumer Gaming Products & Accessories US: Ontario, CA Pg. 8 11

9 64 Qty 65 Replacement Sku Minimum Order Qty Purchasing Requirements 68 Gov Class Qty MFG Drop Ship QTY Consumer Gaming Products & Accessories US: Columbus, OH SYNNEX Replacement SKU for EOL or Discontinued Product Please Note: This is only populated if there is a replacement for current product. Minimum Order Quantity Please Note: This field represents the minimum buying / ordering quantity for this SKU. Purchasing Requirements Classification Coding Please Note: This is a fixed field value representing multiple Purchasing Requirement data elements as is available, represented as follows: End-User Information Required (1 Character Y or N) SWL / Warranty (Virtual Product Flag) (1 Character Y or N) Additional Values will be added as needed. Government Classification Coding Please Note: This is a fixed field value representing multiple Government data elements as is available, represented as follows: COO Value (2 Characters Country Code) Energy Star (1 Character Y or N) Section 508 Compliant (1 Character Y or N) Warranty Period (7 Characters Max - ### Months or ## Years) EPEAT Level (1 Character - "B" = Bronze, "S" = Silver, "G" = Gold, "N" = n/a - not EPEAT SKU) US: Columbus, OH MFG Drop Ship Quantity (Limited to Participating Manufacturers) Please Note: This data, when available, is displayed to all customers unless blocked through Customer EDI Profile. 4 How the extension works The extension has 3 parts, the import of the products, the purchase order and the ship notice. 4.1 How does the import of products work? This module comes with a scheduled cronjob set to run each day at 2:00 AM. This will handle import and updates. Import can be manually triggered as well as by accessing the following URL: To check if new products have been imported from Synnex, simply access from backend: Catalog > Products All products imported from Synnex will be set as Not visible individually, vendor as Synnex and they will be placed in the corresponding category if there is one found. Pg. 9 11

10 Once the product import is finished, you'll need to set the product accordingly: visibility, price, etc. During updates, all of this information is protected. The only information that will be updated is the inventory and cost information. 4.2 How does category map work? Upload a.csv file to map Synnex imported products with your custom category tree. The root category should not be included. A row should look like this: {Category Code} {Magento category tree} E.g Computers/Desktop Computers 4.3 How does the purchase order work? Once an order is placed on Magento, the module will identify and isolate products that are coming from Synnex and it will place though API an order on Synnex systems. Also a shipment is created for Synnex products that will be marked as shipped once the Ship Notice is found on the Synnex FTP server. 4.4 How does the ship notice work? This module comes with a scheduled cronjob set to run every 2 hours, which will handle ship notice retrieval from the Synnex FTP Server and the processing of the ship notice. This will set the shipment to its according status, and if the status is ok, an invoice will be created. If the order contains only products from Synnex, and if the Synnex order is successful, the Magento order will have the status completed. The extension adds a column to the shipments list, on both lists, named Synnex Shipment Status, which displays the status of the shipment. Pg

11 Pg