Magento Integration Suite:Magento DPD DELISprint Connector

From XTENTO Support Wiki
Jump to: navigation, search
DPD DELISprint Logo

Contents

Overview

The XTENTO DPD DELISprint Connector provides a bidirectional connection between Magento and DPD DELISprint. The connector consists of two packages:

Using these two packages, you will be able to import your orders into DELISprint, and later on after shipping the parcels, you will be able to import the tracking information (parcel number, tracking link) back into Magento to provide the customer with the tracking number to track their order, and you'll be able to notify the customer that their order has been shipped, making shipping using DPD DELISprint a breeze.

Exporting shipments into DPD DELISprint and importing tracking information back into Magento has never been easier.

Got questions? Feel free to contact us! Contact Form

Interested in this Magento connector?

Head over to our store to purchase this connector: Magento DPD DELISprint Connector

Setting up the Integration

This guide will help you setting up the DPD DELISprint integration.

Order Export / Shipment Import

Preparing Magento for Export

  1. Open the connector ZIP file downloaded after your purchase. (Located in our store at My Account > My Downloadable Products)
  2. Set up the Magento Order Export Module (located inside the OrderExport folder) following this guide: Installation Guide
  3. Log into the Magento backend and go to System > XTENTO Extensions > Sales Export Configuration and enter the license keys you received via email.
  4. After activating the module in the configuration, go to Sales > Sales Export > Tools and import the "DPD_DELISPrint_Configuration.json" file.
  5. The export has been configured now and is ready to use. Go to Sales > Sales Export and export a couple of orders. If this succeeds, you've successfully installed the export module.

Automatic shipment import into DPD DELISprint

If you want exported orders to be downloaded from Magento to the DPD DELISprint import directory automatically, follow these steps.

You can also manually download exported orders by going to Sales > Order Export and click on Download after exporting orders. If you want to download orders manually, please still create a directory somewhere on your hard drive which will be used for the Import into DELISprint. We'd suggest to use C:\XTENTO\Download\data\.

  1. Open the 'FTPSync - Download' ZIP file located inside the Integration ZIP file and extract the contents to a local directory on the DELISprint computer. We'd suggest placing the files in C:\XTENTO\Download\.
  2. Run the init_configuration.bat file to create the configuration and synchronization files. A couple new files and one new folder will be created. The newly created folder called data will contain the files which will be imported into DELISprint and should be used for the 'Defined Path' required when setting up the DELISprint import. This folder will be also used if you want to manually download files from Magento to DELISprint.
  3. Open the newly created sync.ini file using a text editor and enter the credentials (server address, username, password, path) of the FTP server where Magento is installed on. Make sure to use the absolute path when entering the path. The path should be the absolute path to the /export/ directory inside the Magento root directory. For example, this could be: /export/ or, depending on the FTP home directory, for example: /domains/mydomain.com/html/export/. To find out the absolute path, use your FTP client and log in using the credentials you're using for the synchronization and navigate to the export directory inside the Magento root folder. Then, copy the path you see in your FTP client. Be careful: Entering the wrong path could lead to deleted / synced files. Enter the right path with /export/ appended.
  4. Click on batch_sync_debug_mode.bat to test-run the synchronization and to see if the synchronization fails/succeeds. If necessary, adjust the configuration inside the sync.ini configuration.
  5. Run the init_windows_task_creation.bat file to set up the automated synchronization. The synchronization task will be run every 5 minutes in the background from now.

If you want to initiate the download manually - for example if you're ready to process orders but don't want to wait for the synchronization task to run - simply run the sync.bat file manually.

Setting up the DPD DELISprint Import

DELISprint Version 5

This guide only applies if you're using DELISprint version 5

  1. Install DELISprint and write down the location of the installation directory where DELISprint has been installed. Not required if you've already installed DELISprint.
  2. After installing DPD DELISprint, start it once and do the initial configuration. Not required if you've already installed DELISprint.
  3. Exit DELISprint. Important.
  4. Inside the downloaded connector ZIP file, look for a file called IMPORTFORMAT_MAGENTO_IMPORT.ini. Extract and move this file into the DPD DELISprint root directory, usually located at C:\DPD\DELISprint\.
  5. Start DELISprint and go to Configuration > Configuration..
    22-07-2011 09-59-30.png
  6. Select the Cyclic Import tab and activate Activation of the cyclic import of parcels. Click Configuration.
    22-07-2011 10-02-31.png
  7. The Cyclic import configuration window will be opened. Apply exactly the same configuration as seen on the screenshot below. Replace the Defined Path value with the path of the import data directory which was created by the FTPSync tool above. It's the data directory inside the Download directory. If you used the suggested path, this would be C:\XTENTO\Download\data.
    XTENTO-Screenshot-0002.png
  8. Click Test. A success message should appear. If not, try to interpret the error message and see if it's about your Magento configuration. Also, once again, make sure the Cyclic import configuration is exactly the same as on the screenshot above. If you can't fix it yourself, send us the error log and we'll try to help.
  9. Click Ok to save the cyclic import configuration. Click Ok once again to close the Configuration window.
  10. You're done with setting up the automatic import! To start the automatic import, simply click on Parcels > Start automatic import...
    XTENTO-Screenshot-0003.png

From now on, simply export your orders at Sales > Order Export in the Magento backend and wait for them to synchronize with the DELISprint computer. The shipments will be imported and deleted from this directory automatically.

DELISprint Version 6

This guide only applies if you're using DELISprint version 6

  1. Open DELISprint 6
  2. Click the "DPD" button in the top left corner to open the menu. Click on "Data Import" and press the "Configure import structure for orders" button.
  3. In the top right corner press the "New" button. Make the following settings:
  4. Name: XTENTO Import, Import Format: CSV, Source: Select the file in the import data directory which was created by the FTPSync tool above. It's the data directory inside the Download directory. If you used the suggested path, this would be C:\XTENTO\Download\data\DPD_Export.csv. If the file is not there yet, you have to run an export at Sales > Orders using the "Export orders" action using the profile you created previously.
  5. User / Password: Leave empty, Table: CSV, Encoding: UTF-8, CSV Enclosure and Field Limiter: " and ; (semi-colon), Header rows: 1
  6. Now press the "Automatic Mapping" button in the top left corner of the window. All fields should be mapped now. Press OK to save the import profile. That's it.

From now on, simply export your orders at Sales > Order Export in the Magento backend and wait for them to synchronize with the DELISprint computer. To import them into DELISprint, press the "DPD" button in the top left corner of DELISprint and select "Data Import" and press the "Import Orders" button, select the profile you created in the step above and press "Import".

Tracking Information Export / Magento Import

Provided you have purchased the tracking number import add-on as well, follow this guide to set up the tracking information export from DELISprint to Magento.

Preparing Magento for Import

  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.
  4. Please make sure the Magento cronjob (cron.php inside the Magento root directory) has been set up to be called every 5 minutes. This is important. Follow this guide if you don't know how to set up the cronjob: Setting up the Magento cronjob

Configuring Tracking Import in Magento

The extensions configuration section is located at Sales > Tracking Import. We will now show you how to set up and configure the tracking number import. First of all, go to Sales > Tracking Import > Import Sources and set up a new import source for the type "Local Directory", give it any name, then make the following settings on the next page:

  1. Directory/Path: ./var/trackingimport (spelled out: a dot, slash, var, slash, trackingimport)
  2. Filename Pattern: /csv/i
  3. Archive directory: Leave empty
  4. Delete imported files: Yes

After saving the import source, now you have to set up the import profile.

We will now show you how to set up and configure the tracking number import. Please go to Sales > Tracking Import > Import Profiles, create a new profile for the type "CSV / TXT / Tab", give it any name like "DELISPrint Import", 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. Skip header line: Yes
  2. Field Delimiter: ; (this is a semi-colon)
  3. Field Enclosure Character: Leave empty - no value
  4. Field Mapping:
  5. Magento Field: Order Identifier - Enter in the "File Field Name / Index" field: 2
  6. Magento Field: Tracking Number - Enter in the "File Field Name / Index" field: 19
  7. Magento Field: Shipping Carrier Name - Enter in the "Default Value" field: DPD

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: No
  4. Create shipment for imported order: Yes
  5. Notify customer about shipment Yes / no - as you prefer
  6. Import shipments without tracking numbers: Yes
  7. Add tracking numbers to existing shipments & import multiple tracking numbers: Yes
  8. Import partial shipments: No
  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 import source you created a couple steps ago. Simply check the checkbox in the first column of this grid to enable the "Local Directory" import source for this profile.

Automatic Import

  1. Enable Cronjob: Yes
  2. Import Frequency: Every 15 minutes

Now save the profile. You are done.

Automatic tracking export to Magento

If you want to export tracking numbers from DELISprint to Magento automatically, follow these steps.

  1. Open the 'FTPSync - Upload' ZIP file located inside the Integration ZIP file and extract the contents to a local directory on the DELISprint computer. We'd suggest placing the files in C:\XTENTO\Upload\.
  2. Run the init_configuration.bat file to create the configuration and synchronization files. A couple new files and one new folder will be created. The newly created folder called data will contain the files which will be sent to Magento and should be used for the 'Export Path' required when setting up the DELISprint parcel data / tracking export.
  3. Open the newly created sync.ini file using a text editor and enter the credentials (server address, username, password, path) of the FTP server where Magento is installed on. Make sure to use the absolute path when entering the path. The path should be the absolute path to the /var/trackingimport/ directory inside the Magento root directory. Create this directory if it doesn't exist. For example, this could be: /var/trackingimport/ or, depending on the FTP home directory, for example: /domains/mydomain.com/html/var/trackingimport/. To find out the absolute path, use your FTP client and log in using the credentials you're using for the synchronization and navigate to the var/trackingimport/ directory inside the Magento root folder. Then, copy the path you see in your FTP client. Be careful: Entering the wrong path could lead to deleted / synced files. Enter the right path with /var/trackingimport/ appended.
  4. Click on batch_sync_debug_mode.bat to test-run the synchronization and to see if the synchronization fails/succeeds. If necessary, adjust the configuration inside the sync.ini configuration.
  5. Run the init_windows_task_creation.bat file to set up the automated synchronization. The synchronization task will be run every 15 minutes in the background from now.

Half-automatic tracking export to Magento

If you don't want to use the full-automatic mode of DELISprint, you can still export your tracking numbers to Magento. This also applies in case you only purchase the tracking export to Magento, and did not purchase the shipment import into Magento feature.

When you're done with shipping for the day in DELISprint, you have to click Parcels > Close parcels... This needs to be done regardless whether you're using our integration our not.

Now, to export your tracking numbers, when doing the Close Parcels action, you would select the Own-booking list and Expand filename with timestamp options under Save statistics into file when doing the Close parcels action. Click the Select Directory button and select the upload directory you just created a step ago (for example C:\XTENTO\Upload\) and then click on OK to close parcels for the day, and to save tracking numbers in the selected directory.

The directory usually has to be selected only once when doing the first export.

If this is your first export with tracking numbers, now open the exported CSV file in Excel or Notepad and locate the column with the tracking number in it. Count it from 0, so the first column is index 0, second column is index 1 and so on. So if your tracking number is in the 5th field, the "index" would be 4. Then log into the Magento admin and go to System > XTENTO > Tracking Number Import, CSV Processor, Import Mapping and enter the index number (for example 4) you just found out in the "Tracking Number" index field.

From now on your tracking numbers should correctly import into DELISprint even in half-automatic mode.

Setting up the DPD DELISprint Tracking Number Export

  1. Start DELISprint and go to Configuration > Configuration..
    22-07-2011 09-59-30.png
  2. Select the Cyclic Import tab and activate Activation of the cyclic import of parcels. Click on Configuration.
    22-07-2011 10-02-31.png
  3. The Cyclic import configuration window will be opened. Look for Parcel Data Export and set it to Export data into this directory. Select the FTP Upload\data\ directory which was created by the FTPSync tool. It's the data directory inside the Upload directory. If you used the suggested path, this would be C:\XTENTO\Upload\data. Also select Expand file name with time stamp. Do not select Generate Semaphore File.
  4. Click Ok to save the cyclic import/export configuration. Click Ok once again to close the Configuration window.
  5. You're done with setting up the automatic export! To start the automatic import (and export), simply click on Parcels > Start automatic import... Parcel data and tracking numbers will be exported immediately after the shipments have been imported in full automatic mode.
    XTENTO-Screenshot-0003.png

Questions, Troubleshooting

Got pre-sales questions? Need to change anything in the connector or the output files? A field missing that you want to add? Feel free to contact us! Contact Form

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