Module ECommerce NG (Magento)

Retour index
Documentation développeur

Return to user
documentation index

<keywords content="Magento, Dolibarr, synchro, synch, interface" />

Informations

Module name	Magento
Editor / Editeur	Teclib - www.teclib.com
Download or buy page / Page achat ou téléchargement	External module - www.dolistore.com
Status / Statut / Estado	Development / Développement
Prerequisites / Prérequis	Dolibarr min version: See on Dolistore    Dolibarr max version: See on Dolistore
Last update date / Date mise à jour fiche / Fecha última actualización	2016-05-26
Note / Nota

Features

Integrates a Magento - Dolibarr synchronyzation. It is a module to be installed in Dolibarr. Access to Magento is done by dolibarr using default Magento's WebServices.

Installation

Magento

We suppose you have a Magento already available. If not, this is quick steps to install it:

• Go on www.magento.com to download last version.
• Unzip package on a magento root directory
• Create an empty database on your mysql/mariadb server
• Create a virtual host on your apache server to point to this magento directory and call this url. Use external url for your localhost. A wizard will start to initialize Magento. Note: If you need to work locally only, with an internal URL, you must known than with magento < 2, the name of the virtual host can't be "localhost". But you can edit your /etc/hosts file to add an entry like magento.local on ip 127.0.0.1 and use this (this suppose you want to work locally only).

Note: To reset password of an admin user: UPDATE admin_user SET password = MD5('NEWPASSWORD') WHERE username = 'adminlogin';

From the application

• Download the archive file of module (.zip file)
• Go on menu Home -> Setup -> Modules -> Deploy external module and submit the file.
• Module is then visible into list of available modules (Home -> Setup -> Modules) and can be activated.

Manually

• Download the archive file of module (.zip file)
• Put the file into the root directory of Dolibarr.
• Uncompress the archive file, for example with command

unzip modulefile.zip

• Module is then visible into list of available modules (Home -> Setup -> Modules) and can be activated.

Setup

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

Setup on Magento side

• Create first a Webservice SOAP/XML RPC role from admin interface System - Webservices - SOAP/XML RPC Roles, for example role soaprole. Grant this role Access to *All resources*.
• Create a Webservice SOAP/XML RPC account from admin interface System - Webservices - SOAP/XML RPC User, for example account soapuser. Remember the password you used into field API key during user creation. Set this user to the role you created at previous step. Note: A user with no role set is useless and Dolibarr won't be able to login with it.
• The parameter System - Configuration - Services - Maento Core API - WS/I Compliant can be set to true or false.

Setup on Dolibarr side

Aller sur la page de configuration Dolibarr du module Magento.

• Saisir l'URL des services SOAP Magento.
• Renseigner le login et l'API key créé à l'étape précédente dans Magento (soapuser).
• Choisir la catégorie à utiliser pour marquer les tiers issus de Magento ou ceux à pousser sur Magento. Le tiers assigné à cette catégorie seront poussés en temps réel sur Magento.
• Choisir la catégorie mère dans laquelle sera créée les catégories produits issues de Magento. Les produits créés ou modifiés qui sont assignés à une catégorie ou sous-catégorie de cette dernière seront poussés sur Magento en temps réel.

Usage

Synchronize from Magento to Dolibarr

Synchronizing can be done manually from page Synchronizing Site ...:

Action into Magento	Effect into Dolibarr	When	Note
Categories created/modified into Magento	Created into Dolibarr as sub-categories of the parent category used for Mangeto categories (defined into module setup)	Manual click on "Magento to Dolibarr sync" button	Table llx_ecommerce_category is updated to store link of dolibarr id and remote magento id
Products created/modified into Magento	Created into Dolibarr with categories	Manual click on "Magento to Dolibarr sync" button	Table llx_ecommerce_product is updated to store link of dolibarr id and remote magento id
Thirdparties and contact/addresses created/modified into Magento	Created into Dolibarr	Manual click on "Magento to Dolibarr sync" button	Table llx_ecommerce_societe and llx_ecommerce_socpeople is updated to store link of dolibarr id and remote magento id
Orders created/modified into Magento	Created into Dolibarr	Manual click on "Magento to Dolibarr sync" button	Table llx_ecommerce_commande is updated to store link of dolibarr id and remote magento id
Shipment created/modified in Magento	Creating a shipment in Magento is changing status of the Order from "pending" to "processing". Because it is changing status of order, see case "Order created/modified into Magento". The shipment is not downloaded into Dolibarr, only status of Dolibarr Order will be changed like is the Magento order		You must choose if you manage shipment on Dolibarr or Magento.
Invoices created/modified into Magento	Created into Dolibarr	Manual click on "Magento to Dolibarr sync" button	Table llx_ecommerce_facture is updated to store link of dolibarr id and remote magento id TODO

TODO In a future version, the "Magento to Dolibarr sync" button could be replaced with a scheduled job/script to launch it automaticaly every hour for example.

Synchronize from Dolibarr to Magento

Synchronizing is done in real time.

Action into Dolibarr	Effect into Magento	When	Note
Categories created/modified into Dolibarr	No update is currently done on Magento. In a future version, creation/update into Magento if category is inside the parent category for Magento, defined into module setup	Real time	TODO
Products created into Dolibarr	None. In a future, creation will be done into Magento if product has a category inside tree of Magento categories	No creation is currently done on Magento. In a future version, sync will be in real time	TODO
Products modified into Dolibarr	Update into Magento is done if product is linked to Magento	Real time
Thirdparties created	None. In a future version, creation will be done into Magento if thirdparty has the category of Magento thirdparties (defined into setup)	No creation is currently done on Magento. In a future version, sync will be in real time	TODO
Thirdparties modified into Dolibarr	Udate into Magento is done if thirdparty is linked to Magento	Real time
Contact/addresses created/modified into Dolibarr	None		No update done on Magento
Orders created into Dolibarr	None		Orders created directly into backoffice does not need to appear into ecommerce. See next line for Orders update.
Orders modified into Dolibarr	Order will be updated into Magento if order was created by a "Magento to Dolibarr sync"	Real time	TODO
Shipments created/modified into Dolibarr	Shipment will be created/modified into Magento if source order of shipment was created by a "Magento to Dolibarr sync"	Real time	TODO
Invoice created/modified into Dolibarr	None. In a future, invoice will be created/modified into Magento if source order was coming from Magento	Real time	TODO
Stock of a product modified into Dolibarr (because of a shipment processed or because of an order or invoice validation, depending on your Dolibarr setup of the stock change rule, or because of a manuel change of stock or an inventory)	Stock is updated on Magento if product exists also in Magento	Real time	TODO

Development

Development of this module is not included into standard GIT repository of Dolibarr but inside a dedicated repository managed by TecLib.

• GIT Repository: https://github.com/TECLIB/dolibarr