Data Port Utility FAQ

From AbleCommerce Wiki
Revision as of 10:34, 15 August 2013 by Sohaib (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This collection of frequently asked questions (FAQ) provides brief answers to many common questions about the DataPort and its functionality. It also provides links to more detailed information available on forums or help sites. Please check here for answers before posting a question on forums.


1. Which version of DataPort utility is for me?

Using the new Universal DataPort you can now connect to any version of your store. You can download the latest available version of Universal DataPort at:

2. How to correctly install/setup DataPort utility for my store?

3. What is AbleCommerece.ClientApi.dll file and where and how to upload it?

Download location: (

Download the latest version of DataPort available for your store. After downloading unzip/extract the files. The download package may contain following files:

   * The DataPort Installer ( .msi  installer)
   * The Client Api dll and other related files 
   * ReadMe file

Run the installer to get DataPort installed on your system. The correct Client API dll file should be deployed (uploaded) to /Bin folder of your AC7 store website. You can replace the existing file if it exists.

If the download package contains any other files then use the instructions at ReadMe file to properly deploy them to correct locations.

4. I am experiencing DataPort connection problem?

If you are not able to successfully connect DataPort to your server then make sure:

• You have correctly deployed (uploaded) the CommerceBuilder.DataClient.Api.dll file to your server Bin directory. The API dll version should match the DataPort version you are using. You can confirm the uploaded API dll version from your store admin page (Admin -> Help -> About AbleCommerce page).

• You are correctly specifying the “Service URL” at login screen.

• The user account you are using to connect is a “Supper User”.

Please have a look for details regarding how you can connect DataPort to your server:

5. Why am I getting DataPort version mismatch error/warning?

If you are getting version mismatch error/warning message while connecting to your server then it means that either you are not using correct version of DataPort or you have not deployed (uploaded) correct version of API dll file to your store Bin directory. By using the correct version of DataPort and uploading the correct version of API dll file will solve this issue.

6. Getting “Authentication Error! - Password is null.” error after successful connection.

If you are getting this or similar error when you try to export or import some data using DataPort after a successful connection, then check the “Save Password” option while connecting to server on Login screen. There is a bug in DataPort and previous versions causing this issue. The bug is however fixed for later versions of DataPort.

7. Where can I find a “user manual” for DataPort?

You can find the user manual for DataPort at:

8. How to migrate from AC5x to AC7x? Is there any guide available?

Here is a must read step by step guide for “Migrating from AC5x to AC7x”:

9. What pre-cautions should I do while using DataPort utility?

10. How can I avoid un-desired results while using DataPort utility?

  1. It is recommended to use the latest release of AbleCommerce 7.x.x store and the latest compatible version of DataPort to get the latest features and smooth experience.
  2. Read the DataPort user manual carefully to get an overview of DataPort functionality.
  3. Before using DataPort on LIVE stores try to play with it on local development installs. This way you will be able to avoid un-predictable results.
  4. Always take database backups before using DataPort with your live stores to avoid/remedy any un-desired and un-predictable results.

11. How to import existing user records with passwords using DataPort users CSV import feature?

12. Is there any “Command-Line” interface available for DataPort utility?

No, no command line interface is available for DataPort.

13. My products export fails after exporting some records. Is there any limitation of records?

There is no limitation of records. You can process (import/export) any number of records your computer or your web server allows. If you are getting some error while exporting some data then there may be something inconsistent with your store data. You should post the details regarding problem on forums for guidance.

14. I want to import a really large AC5x exported xml file? How big the DataPort support?

There is no limitation by file size. You can import very large files, however you may encounter out of memory errors if your computer ran out of memory. You can avoid such issues by adding some extra memory to your system.

15. Some (special) characters in my exported data are corrupted while editing in MS Excel?

To avoid any such issues, it is recommended to use MS Excel 2003 or later for editing CSV files. For a detailed discussion have a look at:

16. What are different import options available while uploading data to server?

There are three options:

i. IMPORT new objects, UPDATE existing objects: Use this options when your data contains a mix of new records (which you want to import) and existing records (which you want to update).

ii. Only IMPORT new objects (SKIP UPDATING the existing objects): If you will use this option only new records in your data will be imported and if some existing object will match the record in your data, the record will be skipped.

iii. UPDATE MODE: The import record will be searched for a matching object on server based upon some key fields (math fields), and if any matching object if found the object will be updated. Note that for CSV only one matching object will be updated per CSV record.

17. What are the “Update Options” for CSV upload and how they can be used effectively? (only valid for DataPort vs. or higher)

18. How can I use CSV import feature for batch updating?

You can use CSV import feature for batch updating as well. For example, you can update the product prices in bulk. For CSV update feature you have to specify match criteria based upon which the CSV records are matched for existing objects, and any matching object is updated as specified in CSV data. For DataPort vs. and older version the match was performed using fixed pre-defined criteria. While for DataPort 7.0.3 (not yet released) the user can select his/her own match criteria.

19. Can I use xml import feature for batch updating?

Yes, the XML import can be used for batch updating in similar way as the CSV import.

20. Can I run DataPort programmatically?

No, there is no such interface available for DataPort to run it programmatically.

21. Can I install multiple versions of DataPort applications side by side on the same system?

Yes, multiple versions of DataPort can be installed on same system. The only restriction is that you have to install older versions first and newer versions later.