Build Magento-Connected Web Apps in Servoy

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Magento including Customers, Inventory, Products, Orders, and more!



Use Servoy Developer to easily connect to Magento data and build web apps with connectivity to live Magento data.

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for Magento, users can build Magento-connected apps that work with live Magento data. This article describes how to connect to Magento from Servoy and build a simple web app to display and search Magento data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Magento data. When you issue complex SQL queries to Magento, the driver pushes supported SQL operations, like filters and aggregations, directly to Magento and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Magento data using native data types.

Connect to Magento in Servoy Developer

To build Magento-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for Magento.

  1. Install the JDBC Driver.
  2. Copy the JDBC Driver JAR file. (cdata.jdbc.magento.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
  3. Open Servoy Developer.
  4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
    1. Name the server.
    2. Click to show the advanced server settings.
      • Set the URL, for example: jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH

        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.

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

      • Select the Driver class you just copied, for example, cdata.jdbc.magento.MagentoDriver

Build a Magento-Connected Web App

Once you have configured the connection to Magento in the Servoy Developer resources, you are ready to build apps with access to live Magento data.

Create a New Solution

  1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
  2. Name the solution.
  3. Select the checkbox to include the "search" module.
  4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

  1. Name the form.
  2. Select a Datasource.
  3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

  1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.
  2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the Magento "table" (e.g., Name from the Products table).

    Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

  1. Drag a Text Field component onto the Form.
  2. Right-click the Form and select "Open in Script Editor."
  3. Create a new variable (JavaScript) to hold the search value:
    var searchText = '';
    
  4. Back on the Form, in the Text Field properties:
    1. Set the "dataprovider" property to the Form variable you just created.
    2. Double-click to add a method for the onAction event.
    3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
    4. Click "OK & Show."
  5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:
    var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
    search.setSearchAllColumns();
    search.loadRecords(foundset);
    

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for Magento and start building Magento-connected apps with Servoy. Reach out to our Support Team if you have any questions.