Ready to get started?

Learn more about or download the TIBCO DV Adapters

Learn More

Access Live Magento Data in TIBCO Data Virtualization

Use the CData TIBCO DV Adapter for Magento to create a Magento data source in TIBCO Data Virtualization Studio and gain access to live Magento data from your TDV Server.

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the CData TIBCO DV Adapter for Magento, you get federated access to live Magento data directly within TIBCO Data Virtualization. This article walks through deploying an adapter and creating a new data source based on Magento.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live Magento data. When you issue complex SQL queries to Magento, the adapter pushes supported SQL operations, like filters and aggregations, directly to Magento. Its built-in dynamic metadata querying allows you to work with and analyze Magento data using native data types.

Deploy the Magento TIBCO DV Adapter

  1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

    .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name Magento
    
  2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.magento.jar) to the server from the extract location.

    .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.magento.jar
    

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Authenticate with Magento Using OAuth

Since Magento authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to Magento directly from the adapter.

The following code sample shows how to authenticate with Magento. You will simply need to execute the Java application with the tdv.magento.jar file in the class path.

MagentoOAuth oauth = new MagentoOAuth();  
oauth.generateOAuthSettingsFile("InitiateOAuth=GETANDREFRESH;" + 
                                  "OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;" + 
                                  "OAuthSettingsLocation=C:\magento\OAuthSettings.txt;");

Once you deploy the adapter and authenticate, you can create a new data source for Magento in TDV Studio.

Create a Magento Data Source in TDV Studio

With the CData TIBCO DV Adapter for Magento, you can easily create a data source for Magento and introspect the data source to add resources to TDV.

Create the Data Source

  1. Right-click on the folder you wish to add the data source to and select New -> New Data Source.
  2. Scroll until you find the adapter (e.g. Magento) and click Next.
  3. Name the data source (e.g. CData Magento Source).
  4. Fill in the required connection properties.

    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".

    NOTE: Set the OAuthSettingsLocation property in the DV Adapter to the same value you used when performing the OAuth authentication (see above).

  5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected Magento tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with Magento data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.