Toolbox

Main Page

Upload file

What links here

Recent changes

Help

Search

Participate

Projects:Integration Magento Connector

Introduction

This documentation describes the functional and technical details for the standard Openbravo connector to Magento, delivered as set of extension modules including:

Magento Connector - Core Infrastructure

Magento Connector - Mappings

Magento is a digital commerce platform that provides online merchants with flexibility and control over the look, content and functionality of their online stores.

The aim of the Openbravo connector to Magento is to enable the integration between the two systems, therefore Magento can act as another POS processing sales, but online as an “e-commerce” sales channel.

The version of Magento to be used needs to be starting from 2.0. New versions of Openbravo connector to Magento module can be released if required, depending on the functionality added in further published Magento versions.

Magento Configuration

Before using the connector, a clean Magento instance is needed with a basic configuration.

Current connector only supports single store configuration:

Then, it is needed to configure the country, currency, payment methods, shipping methods, etc. to use.

Following document explains how to do a clean set up and a basic configuration of Magento 2:

File:MagentoConfiguration.pdf

More documentation can be found in Magento documentation

Openbravo Configuration

Now, we will explain how to set up the connector in Openbravo and how to run it.

Dataset

Before starting Openbravo configuration, it is necessary to apply Magento Connector - Mappings module's dataset.

This dataset will create in Openbravo some Magento default values like:

Default Magento Customer, Customer Category and Customer Tax Category
Default Magento Product Category and Attribute
Default Magento Payment Methods
Default Magento Shipping Methods
Countries and Regions

Those new records will be mapped in External ID Mappings window using the default External Instance Identifier: MAGCON_MAGENTO.

Connection

To be able to communicate with your Magento instance, you need to set it up in Magento Access Configuration window, introducing the instance URL and the access token.

Once configured, you can check connection by clicking on Check Magento Access Configuration button.

After checking the connection, you need to click on Get Hierarchy button to map Magento Web Site, Store and Store View and be able to link it with Magento Touchpoint.

Touchpoint

A new Organization should be created to map with Magento store including default values in Retail Configuration section.

This organization will be used to define the master data exported to Magento and to register the orders imported from Magento. Magento orders could be accessed from other stores using Cross Store operations.

Another option would be to link Magento touchpoint to an existing physical store, sharing the same master data.

Current connector doesn't support multi warehouse integration. Thus, Magento organization must define a one unique warehouse. The stock of this warehouse will be the one integrated with Magento.

A new Magento Touchpoint Type should be created for E-commerce Channel, including needed Magento Payment Methods.

A new Magento Touchpoint should be created for above Organization and Touchpoint Type, including needed Magento Payment Methods and linked to Magento Store View.

Export/Import Process

Two new records need to be created in EDL Configuration window for Retail API Based Export Process and JSON Based Import Process processes and DebugAndStore output type.

We can schedule export and import background processes from Process Request window.

It is possible to run the process exporting/importing all configured entities or to define in the Entity to Integrate tab which entities we want to integrate.

The first time the integration process is run, it will search for every data to integrate using Retail API (full refresh). Next time, it will only search for data pending to integrate since last synchronization (incremental refresh).

Integration Entities

This section describes the entities to exchange between the two systems, together with the import and export flow to take into account.

Integration entities are defined in Entity Mapping window, using Retail API integration API type.

Entities to Export: Openbravo -> Magento

Export To Magento Synchronization Process will export Openbravo master data visible for Magento touchpoint to Magento, in order to automatically set up Magento store.

Taxes

Openbravo will export Taxes to Magento to be able to define which rate applies to each Product available in Magento.