Connect to Magento Data from PowerBuilder

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento ODBC Driver

The Magento ODBC Driver is a powerful tool that allows you to connect with live Magento data, directly from any applications that support ODBC connectivity.

Access Magento like you would a database - read, write, and update Customers, Inventory, Products, Orders, etc. through a standard ODBC Driver interface.



This article demonstrates how to use the CData ODBC Driver for Magento to connect to Magento data and execute queries in PowerBuilder.

The CData ODBC Driver for Magento can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to Magento data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to Magento as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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

Create a Profile for the ODBC Driver for Magento

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for Magento. In the Database Painter, you can use wizards and the UI to work with Magento data.

  1. In PowerBuilder, click Tools -> Database Painter.
  2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
  3. On the Connection tab, enter a name for the profile and select the Magento DSN in the Data Source menu.
  4. 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 ODBC 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 = "ODBC" SQLCA.DBParm = "ConnectString='DSN=CData Magento Source'" CONNECT USING SQLCA; dw_products.SetTransObject(SQLCA); dw_products.Retrieve();