Magento connector

• Starter
• Business
• Enterprise
• On-Premise
• Add-on

Overview

Etlworks Magento connector allows fast, real-time access to Magento API. The connector works just like any other connector for connected app.

Etlworks partnered with CData to provide access to the Magento API using industry-standard JDBC protocol. Read about CData Magento JDBC connector.

When to use Magento connector

Use this connector to create Flows that extract data from and load data into Magento. 

Prerequisites

1. You must have a Magento account.

2. Enable Magento connector for your Etlworks account. Contact support@etlworks.com to enable connector.

Create a Connection

Step 1. In the Connections window, click +, and type in magento.

Step 2. Enter Connection parameters.

Connection parameters

• URL: the Magento URL. For example https://shop.business.com.
• Authentication Method: select either Access Token or User and password.
• If User and password is selected enter:
  • User: the user name.
  • Password: the password.
• If Access token is selected enter:
  • Access Token: the access token. Read how to obtain Magento Access Token.

Use Other parameters to specify the Connection string options. Read about available Connection string options.

Work with Magento

Magneto data model

Our Magento connector supports data models for the API ver 1.x and 2.x.

Read about Magento data models. 

Stored procedures

Stored Procedures are available to complement the data available from the Data Model. Sometimes, it is necessary to update the data available from a view using a stored procedure because the data does not provide direct, table-like, two-way updates. In these situations, the data retrieval is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset containing the collection of tuples that constitute the response.

To call stored procure from the SQL Flow or from Before/After SQL, use EXEC sp_name params=value syntax. Example:

EXEC CreateSchema TableName = 'table', FileName = 'file'

Extract data from Magento

Note: Extracting data from Magento is similar toextracting data from the relational database.

Step 1. Create Magento Connection which will be used as a source (FROM).

Step 2. Create a destination Connection, for example, a Connection to the relational database, and if needed, a Format (Format is not needed if the destination is a database or well-known API).

Step 3. Create a Flow where the source is a connected app, and the destination is a Connection created in step 2, for example, a relational database.

Step 4. Add a new source-to-destination transformation.

Step 5. Select Magento Connection created in step 1 as a source Connection and select the data object you are extracting data from.

Step 6. Select TO Connection, Format (if needed), and object (for example, database table) to load data into.

Step 7. Click MAPPING and optionally enter Source Query (you don't need a query if you extract data from the Magento data object unconditionally).

Step 8. Optionally define the per-field Mapping.

Step 9. Add more transformations if needed.

Load data in Magento

Note: Loading data in Magento is similar toloading data into a relational database.

Step 1. Create a source Connection and a Format (if needed).

Step 2. Create a destination Magento Connection.

Step 3. Create a Flow where the destination is a connected app.

Step 4. Add new source-to-destination transformation.

Step 5. Select FROM and TO Connections and objects (also a FROM Format if needed).

Step 6. Optionally define the per-field Mapping.

Step 7. Add more transformations if needed.

Browse data in Magento

You must have Magento Connection to browse objects and run SQL queries.

Use Etlworks Explorer to browse data and metadata in Magento and execute DML and SELECT queries against Magento Connection.