Magento Integration Suite:Mailcom Integration

From XTENTO Support Wiki
Jump to: navigation, search

Contents

Overview

The XTENTO Mailcom Integration provides a bidirectional connection between Magento and Mailcom. 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 Mailcom 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 each of 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 Mailcom 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 Mailcom

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 Mailcom, as well as a SFTP 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 "SFTP Server" for the "Destination Type". Click "Continue". You can now configure the destination.
  3. Please enter all the SFTP credentials for the Mailcom SFTP server, provided by Mailcom. Make sure to use the directory where order exports should be sent to, the path will be provided by Mailcom as well. Usually this is the "/orders" folder.
  4. 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 SFTP export to Mailcom. 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: Export only new orders: YES, Status: Processing (and any other status that marks paid orders in your store), Date From: Specify yesterdays date, Item Filters - Hidden Product Types: Configurable Product, Virtual Product, Downloadable Product
  7. Tab Automatic Export: Cronjob Enabled: Yes, Export every 30 minutes
  8. Save the profile. That's it. Whenever a new order is placed now and it's paid, it will be sent to the Mailcom SFTP server automatically.

Product Export to Mailcom

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 Mailcom, as well as a SFTP 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 "SFTP Server" for the "Destination Type". Click "Continue". You can now configure the destination.
  3. Please enter all the SFTP credentials for the Mailcom SFTP server, provided by Mailcom. Make sure to use the directory where product exports should be sent to, the path will be provided by Mailcom as well.
  4. 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 SFTP export to Mailcom. 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 Mailcom SFTP server automatically.

Tracking Import from Mailcom

Installation

  1. Open the "Xtento_TrackingImport" 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_TrackingImport ZIP file) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO > Tracking 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 Sales > Tracking Import. We will now show you how to set up and configure the automated tracking number import. First of all, go to Sales > Tracking Import > Import Sources and set up a new import source for the type "SFTP", give it any name, then make the following settings on the next page:

  1. IP/Hostname, Port, Username, Password, Base Path: Logins/path supplied by Mailcom (usually the /tracking/ folder)
  2. Server Type: SFTP
  3. Timeout: 20
  4. Filename Pattern: /OrderStatus/i
  5. Path: /tracking/
  6. (---Archive directory: /tracking/archive/---)
  7. Delete imported files: Yes

After saving the import source, now you have to set up the import profile. Please go to Sales > Tracking Import > Import Profiles, create a new profile for the type "XML", give it any name, and press continue. Then make the following settings on the next page:

General Configuration

  1. Set "Enabled" to "Yes"

Settings & Filters

  1. No changes required

File Mapping

  1. Data XPath: //orders/shipment/Order
  2. Field Mapping:
  3. Magento Field: Order Identifier - Enter in the "File Field Name / Index" field: OrderId
  4. Magento Field: Tracking Number - Enter in the "File Field Name / Index" field: TrackingNumber
  5. Now click on the "Additional Configuration" button right next to the Tracking Number field and paste this: <?xml version="1.0" encoding="UTF-8"?><configuration><nested_xpath xpath="//tracking/tracker"/></configuration>
  6. Magento Field: Shipping Carrier Name - Enter in the "File Field Name / Index" field: CarrierCode
  7. Now click on the "Additional Configuration" button right next to the Shipping Carrier Name field and paste this: <?xml version="1.0" encoding="UTF-8"?><configuration><nested_xpath xpath="//tracking/tracker"/></configuration>
  8. Magento Field: SKU - Enter in the "File Field Name / Index" field: Sku
  9. Now click on the "Additional Configuration" button right next to the SKU field and paste this: <?xml version="1.0" encoding="UTF-8"?><configuration><nested_xpath xpath="//items/item"/></configuration>
  10. Magento Field: QTY - Enter in the "File Field Name / Index" field: Qty
  11. Now click on the "Additional Configuration" button right next to the Qty field and paste this: <?xml version="1.0" encoding="UTF-8"?><configuration><nested_xpath xpath="//items/item"/></configuration>

Actions

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

Import Sources

  1. Here you have to enable the SFTP import source you created a couple steps ago. Simply check the checkbox in the first column of this grid to enable the import source for this profile.

Automatic Import

  1. Enable Cronjob: Yes
  2. Import Frequency: Every hour

Now save the profile. You are done, the automatic tracking import has been set up and can be checked at Sales > Tracking Import > Execution Log. There will only be entries if orders were found on the Mailcom SFTP server.

Stock Level Import from Mailcom

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 Mailcom, as well as a SFTP 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 "SFTP Server" for the "Source Type". Click "Continue". You can now configure the source.
  3. Please enter all the SFTP credentials for the Mailcom SFTP server, provided by Mailcom. Make sure to use the directory where stock files are located in on the SFTP server, the path will be provided by Mailcom as well.
  4. Filename Pattern: /stock/i
  5. Path: /stockinfo/
  6. (---Archive directory: /stockinfo/archive/---)
  7. Delete Files: Yes
  8. 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 "XML" 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, Adjust stock level by pending/processing orders: 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: Data XPath: //INVRPT/ITEM_DATA File Mapping: Select Import Field "Product Identifier" and enter "ITEM_ID" (without the quotes) into the "Field Name/Index" field, then click "Add field to mapping" and add another Import Field for "Qty in Stock" and input "QTY_PHYS" (without the quotes) into the "Field Name/Index" field.
  6. Tab Import Sources: This is a very important step. This will activate the SFTP import from Mailcom. 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 Mailcom SFTP server automatically.

Troubleshooting

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