Magento Integration Suite:Barrett Distribution Centers Integration

From XTENTO Support Wiki
Jump to: navigation, search

Contents

Overview

The XTENTO Barrett Distribution Centers (BTD) integration provides a bidirectional connection between Magento and Barrett Distribution Centers. The integration consists of four stand-alone packages:

Extension to be purchased: http://www.xtento.com/magento-extensions/magento-order-export-module.html

Extension to be purchased: http://www.xtento.com/magento-extensions/magento-product-feed-export-module.html

Extension to be purchased: http://www.xtento.com/magento-extensions/magento-tracking-number-import-module.html

Extension to be purchased: http://www.xtento.com/magento-extensions/magento-stock-inventory-import-module.html

You just need to purchase the extensions for the above features you want to integrate. The configuration is supplied free of charge by BTD and XTENTO.

XTENTO also offers a paid installation and configuration service. If you want XTENTO to install and configure the integration for you, please add the "XTENTO Installation Service" option to the extensions when purchasing.

Got questions? Feel free to contact us! Contact Form

Setting up the Integration

This guide will help you setting up the BTD integration.

Important: Please make sure the Magento cronjob has been set up for the Magento installation you're installing the integration in. If the Magento cronjob hasn't been set up, you won't be able to automate exports/imports.

Order Export to BTD

Installation

  1. Open the "Xtento_OrderExport" extension ZIP file downloaded after your purchase. (Located in our store at My Downloads)
  2. Set up the Magento Order Export Module (located inside the Xtento_OrderExport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Sales Export Configuration and enter your license key to activate the module. Eventually enter your email address and enable debug mode to be notified about errors/warnings.

Configuration

The extensions configuration section is located at Sales > Sales Export. You will need to set up a new export profile for BTD, as well as a FTP destination where exported files are sent to.

Destination setup

  1. Go to Sales > Sales Export > Export destinations and create a new destination.
  2. You can choose any name for the destination, choose "FTP Server" for the "Destination Type". Click "Continue". You can now configure the destination.
  3. Please enter all the FTP credentials for the BTD FTP server, provided by BTD. Make sure to use the directory where order exports should be sent to.
  4. "Enable Passive Mode" should be set to "Yes" usually.
  5. Click "Save Destination".

Profile setup

  1. Go to Sales > Sales Export > Export Profiles and create a new profile
  2. You can choose any name for the profile, choose "Orders" for the "Export Type". Click "Continue". You will be presented with several tabs on the left which contain different configuration sections. Please configure them as following.
  3. Tab General Configuration: Save local copies: Yes, Export each order separately: Yes
  4. Tab Export Destinations: This is a very important step. This will activate the FTP export to BTD. You now have to "activate" the previously created export destination. To do so, simply check the checkbox in the first column of the destinations grid that shows up in the tab.
  5. Tab Output Format: Output Type: XSL Template. Please paste the contents of this file into the XSL Template editor: XSL Template
  6. Tab Filters & Actions: Item Filters - Hidden Product Types: Configurable Product
  7. Tab Automatic Export: Event-based Export - Export Events: After invoice has been paid (Event: sales_order_invoice_pay)
  8. Save the profile. That's it. Whenever a new order is placed now and it's paid, it will be sent to the BTD FTP server automatically.

Product Export to BTD

Installation

  1. Open the "Xtento_ProductExport" extension ZIP file downloaded after your purchase. (Located in our store at My Downloads)
  2. Set up the Magento Product Export Module (located inside the Xtento_ProductExport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Product Export Configuration and enter your license key to activate the module. Eventually enter your email address and enable debug mode to be notified about errors/warnings.

Configuration

The extensions configuration section is located at Catalog > Product Export. You will need to set up a new export profile for BTD, as well as a FTP destination where exported files are sent to.

Destination setup

  1. Go to Catalog > Product Export > Export destinations and create a new destination.
  2. You can choose any name for the destination, choose "FTP Server" for the "Destination Type". Click "Continue". You can now configure the destination.
  3. Please enter all the FTP credentials for the BTD FTP server, provided by BTD. Make sure to use the directory where product exports should be sent to.
  4. "Enable Passive Mode" should be set to "Yes" usually.
  5. Click "Save Destination".

Profile setup

  1. Go to Catalog > Product Export > Export Profiles and create a new profile
  2. You can choose any name for the profile, choose "Products" for the "Export Type". Click "Continue". You will be presented with several tabs on the left which contain different configuration sections. Please configure them as following.
  3. Tab General Configuration: Save local copies: Yes, Export each product separately: No, Remove HTML in exported data: No, Remove store parameter from URL: Yes
  4. Tab Export Destinations: This is a very important step. This will activate the FTP export to BTD. You now have to "activate" the previously created export destination. To do so, simply check the checkbox in the first column of the destinations grid that shows up in the tab.
  5. Tab Output Format: Output Type: XSL Template. Please paste the contents of this file into the XSL Template editor: XSL Template
  6. Tab Stores & Filters: Store View: Select the store view from which the values should be exported.
  7. Tab Automatic Export: Enable Cronjob Export: Yes; Export Frequency: Daily
  8. Save the profile. That's it. Your product data will now be sent to the BTD FTP server automatically.

Tracking Import from BTD

Installation

  1. Open the "Xtento_OrderStatusImport" extension ZIP file downloaded after your purchase. (Located in our store at My Downloads)
  2. Set up the Tracking Number Import Module (located inside the Xtento_OrderStatusImport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Tracking Number Import and enter your license key to activate the module. Eventually enter your email address and enable debug mode to be notified about errors/warnings.

Configuration

The extensions configuration section is located at System > XTENTO > Tracking Number Import. We will now show you how to set up and configure the automated tracking number import. There are several tabs and we will explain each tab.

General Settings

  1. Enter your license key
  2. Set module enabled to "Yes"

Import Settings

  1. Import Processor: CSV
  2. Enable Cronjob: Yes
  3. Import Frequency: Every hour
  4. Create invoice for imported order: Yes / no - as you prefer
  5. Notify customer about invoice: Yes / no - as you prefer
  6. Import partial invoices: No
  7. Create shipment for imported order: Yes
  8. Notify customer about shipment Yes / no - as you prefer
  9. Import shipments without tracking numbers: Yes
  10. Add tracking numbers to existing shipments & import multiple tracking numbers: Yes
  11. Import partial shipments: Yes
  12. Change order status after importing partial order: No change
  13. Change order status after import: Complete (Suggested)

FTP Import Settings

  1. FTP Import Enabled: Yes
  2. IP/Hostname, Port, Username, Password, Base Path: Logins/path supplied by BTD
  3. Use FTP SSL connection: No
  4. Use SFTP connection: No
  5. Enable Passive Mode: Yes
  6. Filename Pattern: /csv/i
  7. Delete imported files: Yes

Local Directory Import Settings

  1. Local Import Enabled: Yes
  2. All other settings can remain as set out of the box in this section

CSV Import Processor Settings

  1. Skip header line: Yes
  2. Field Delimiter: , (this is a semicolon)
  3. Field Enclosure Character: Leave empty - no value
  4. Create Chunk Files: No
  5. Field Mapping:
  6. Import Field: Order Number - Enter in the "Field Name / Index" field: reference
  7. Import Field: Tracking Number - Enter in the "Field Name / Index" field: TrackingNo
  8. Import Field: Shipping Carrier Name - Enter in the "Field Name / Index" field: carrier
  9. Import Field: SKU - Enter in the "Field Name / Index" field: ItemEntered
  10. Import Field: Quantity - Enter in the "Field Name / Index" field: QtyEntered
  11. SKU and Quantity in one field: No

XML Import Processor Settings
No changes required.

Stock Level Import from BTD

Installation

  1. Open the "Xtento_StockImport" extension ZIP file downloaded after your purchase. (Located in our store at My Downloads)
  2. Set up the Magento Stock Import Module (located inside the Xtento_StockImport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Stock Import Configuration and enter your license key to activate the module. Eventually enter your email address and enable debug mode to be notified about errors/warnings.

Configuration

The extensions configuration section is located at Catalog > Stock Import. You will need to set up a new import profile for BTD, as well as a FTP source where files to import are downloaded from.

Source setup

  1. Go to Catalog > Stock Import > Import sources and create a new source.
  2. You can choose any name for the source, choose "FTP Server" for the "Source Type". Click "Continue". You can now configure the source.
  3. Please enter all the FTP credentials for the BTD FTP server, provided by BTD. Make sure to use the directory where stock files are located in on the FTP server.
  4. "Enable Passive Mode" should be set to "Yes" usually.
  5. Click "Save Source".

Profile setup

  1. Go to Catalog > Stock Import > Import Profiles and create a new profile.
  2. You can choose any name for the profile, choose "Stock level" for the "Import Type", select "CSV" for the "File Processor". Click "Continue". You will be presented with several tabs on the left which contain different configuration sections. Please configure them as following.
  3. Tab General Configuration: No changes required.
  4. Tab Import Settings: Reindex mode: No reindexing (just set this to reindex if you have problems with the stock status not being updated in the frontend), If stock qty is 0 or less mark as out of stock: Yes, Import relative stock level: No, Product Identifier: SKU (This is the attribute code of products that match the identifier of products in the stock file, usually the SKU)
  5. Tab File Configuration: Skip header line: No, Field Delimiter: , (this is a comma), Field Enclosure Character: No value - must remain empty. File Mapping: Select Import Field "Product Identifier" and input 0 (just a zero) into the "Field Name/Index" field, then click "Add field to mapping" and add another Import Field for "Qty in Stock" and input 1 (just the digit 1) into the "Field Name/Index" field.
  6. Tab Import Sources: This is a very important step. This will activate the FTP import from BTD. You now have to "activate" the previously created import source. To do so, simply check the checkbox in the first column of the sources grid that shows up in the tab.
  7. Tab Automatic Export: Enable Cronjob Import: Yes; Import Frequency: Every 30 minutes
  8. Save the profile. That's it. Your stock level will now be imported from the BTD FTP server automatically.

Troubleshooting

Personal tools
Namespaces
Variants
Actions
General Information
Magento 1 Guides
Magento 1 Extensions
Magento 2 Guides
Magento 2 Extensions
Magento Integration Suite
Product Feed Guides
Toolbox