Ready to get started?

Learn more about the CData JDBC Driver for Magento or download a free trial:

Download Now

ETL Magento in Oracle Data Integrator

This article shows how to transfer Magento data into a data warehouse using Oracle Data Integrator.

Leverage existing skills by using the JDBC standard to read and write to Magento: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Magento connects real-time Magento data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with Magento just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Magento APIs in real time instead of working with flat files.

This article walks through a JDBC-based ETL -- Magento to Oracle. After reverse engineering a data model of Magento entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR and .lic file, located in the installation folder, into the ODI userlib directory:

On Unix: ~/.odi/oracledi/userlib On Windows: %APPDATA%\Roaming\odi\oracledi\userlib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of Magento data. After reverse engineering, you can query real-time Magento data and create mappings based on Magento tables.

  1. In ODI, connect to your repository and click New -> Model and Topology Objects.
  2. On the Model screen of the resulting dialog, enter the following information:
    • Name: Enter Magento.
    • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
    • Logical Schema: Enter Magento.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter Magento.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.magento.MagentoDriver
    • URL: Enter the JDBC URL containing the connection string.

      Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

      You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

      • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

      • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

        If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Magento JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.magento.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      Below is a typical connection string:

      jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH
  4. On the Physical Schema screen, enter the following information:
    • Schema (Schema): Enter Magento.
    • Schema (Work Schema): Enter Magento.
  5. In the opened model click Reverse Engineer to retrieve the metadata for Magento tables.

Edit and Save Magento Data

After reverse engineering you can now work with Magento data in ODI. To edit and save Magento data, expand the Models accordion in the Designer navigator, right-click a table, and click Data. Click Refresh to pick up any changes to the data. Click Save Changes when you are finished making changes.

Create an ETL Project

Follow the steps below to create an ETL from Magento. You will load Products entities into the sample data warehouse included in the ODI Getting Started VM.

  1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

    Alternatively you can use SQLPlus. From a command prompt enter the following:

    sqlplus / as sysdba
  2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the Products table in Magento: CREATE TABLE ODI_DEMO.TRG_PRODUCTS (PRICE NUMBER(20,0),Name VARCHAR2(255));
  3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
  4. Click Reverse Engineer. The TRG_PRODUCTS table is added to the model.
  5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
  6. Drag the TRG_PRODUCTS table from the Sales Administration model onto the mapping.
  7. Drag the Products table from the Magento model onto the mapping.
  8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
  9. Open the Physical tab of the Mapping Editor and click PRODUCTS_AP in TARGET_GROUP.
  10. In the PRODUCTS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load Magento data into Oracle.