Ready to get started?

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

Download Now

Connect to Magento Data from PowerBuilder

This article demonstrates how to access Magento data from PowerBuilder using the Magento JDBC Driver.

The CData JDBC Driver for Magento is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Magento in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Magento to perform reads and writes.

Connect to Magento Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Magento. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.magento.MagentoDriver
    • URL: Enter the JDBC URL.

      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. A typical JDBC URL is below:

      jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Magento Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Magento data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.magento.MagentoDriver',URL='jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH"; CONNECT USING SQLCA; dw_products.SetTransObject(SQLCA); dw_products.Retrieve();