Deploy CData Mule Connectors (On-Premise or to the Cloud)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart MuleSoft Connector



Embed the CData MuleSoft Connector for X-Cart in a Mule Application and deploy it to the MuleSoft CloudHub or an on-premise server.

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 with access to live X-Cart data that can be deployed to an on-premise server for internal access or to the MuleSoft CloudHub for direct cloud access.

Add X-Cart Connectivity to Mule Apps

This article walks through embedding the CData Mule Connector for X-Cart in an application and deploying the application to MuleSoft CloudHub and to on-premise servers. You will need Mule and Anypoint Studio installed, in addition to the CData X-Cart Connector.

Embed X-Cart Connectivity

The steps below outline adding the X-Cart Connector to your project and configuring the connection and connector.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add a CData X-Cart Connector to the application.
  3. 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.
  4. Configure the CData X-Cart Connector with the Operation, Query type, and SQL query.
  5. Finish and save your application.

Once you have completed your application, you can use Anypoint Studio in conjunction with Anypoint Platform to deploy the application to your MuleSoft CloudHub instance or an on-premise server.

Deploy to MuleSoft CloudHub

  1. Right-click your Project and select Anypoint Platform -> Deploy to Cloud
  2. Configure the deployment and click "Deploy Application"
  3. When the deployment completes, navigate to the Anypoint Platform Runtime Manager to manage the deployed application

Once the application is deployed, you will be able to access it from anywhere on the web by navigating to the App URL, adding any parameters needed.

Deploy to an On-Premise Server

In order to deploy a Mule application to an on-premise server through the Anypoint Platform, you will need to have a Mule server instance installed on the machine. The steps below walk through adding the on-premise server to Anypoint Platform and deploying the Mule application.

Add the On-Premise Mule Server to Anypoint Platform

  1. Stop your on-premise Mule server (if it is currently running)
  2. Navigate to the Anypoint Platform and click Add Server to see the command for adding a server, including the security token.
  3. Setup the MuleSoft Runtime Manager Agent (on Windows, run amc_setup.bat ... ).

    %MULE_HOME%\bin> amc_setup -H 12ab3cd4-567e-8fa9-0123-4b56c7de8901---234567 MYSERVER
  4. Start the on-premise Mule Server (on Windows, run mule.bat ).

    %MULE_HOME%\bin> mule

Deploy the Mule Application

  1. In Anypoint Studio, right-click the project -> Export
    • In the Mule folder, choose "Anypoint Studio Project to Mule Deployable Archive" and click "Next" to create the deployable file
  2. In the Anypoint Platform Runtime Manager, navigate to Applications and click Deploy Application
    • Name the application
    • Select the on-premise server as the Deployment Target
    • Under "Application File," click "Choose file" -> "Upload file" and select the project you exported
    • Click "Deploy Application"

Once the application is deployed to the on-premise server, you will be able to access it from any browser with access to the server. Simply navigate to the server address and port, adding any URL parameters needed for the application.

At this point, you have deployed a Mule Application for working with X-Cart data. Download a free, 30 day trial of the Mule Connector for X-Cart and see the CData difference in your Mule applications today.