Access X-Cart Data in Anypoint Using SQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart MuleSoft Connector



Create a simple Mule Application that uses HTTP and SQL with the CData Mule Connector for X-Cart to create a JSON endpoint for X-Cart data.

The CData Mule Connector for X-Cart connects X-Cart data to Mule applications enabling read functionality with familiar SQL queries. The Connector allows users to easily create Mule Applications to backup, transform, report, and analyze X-Cart data.

This article demonstrates how to use the CData Mule Connector for X-Cart inside of a Mule project to create a Web interface for X-Cart data. The application created allows you to request X-Cart data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData Mule Connector to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a CData X-Cart Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties to connect to X-Cart (see below). Once the connection is configured, click Test Connection to ensure the connectivity to X-Cart.

    An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

    • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
    • Search for REST API Module. Install the Module.
    • After the module has been installed, you need to set it up.
      • Go to the Settings section for the REST API Module.
      • On the settings page specify the API Key (only read)
    • Set the ApiKey and Url to the connection property to connect to data.
  6. Configure the CData X-Cart Connector.
    1. Set the Operation to 'Select with Streaming'.
    2. Set the Query type to Dynamic.
    3. Set the SQL query to SELECT * FROM #[message.inboundProperties.'http.query.params'.get('table')] to parse the URL parameter table and use it as the target of the SELECT query. You can customize the query further by referencing other potential URL parameters.
  7. Add a Transform Message Component to the flow.
    1. Map the Payload from the input to the Map in the output.
    2. Set the Output script to the following to convert the payload to JSON:
      %dw 1.0
      %output application/json
      ---
      payload
              
  8. To view your X-Cart data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default) and pass a table name as the table URL parameter: http://localhost:8081?table=PROFILES
    The PROFILES data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with X-Cart data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the Mule Connector for X-Cart and see the CData difference in your Mule Applications today.