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

Ready to get started?

Download for a free trial:

Download Now

Learn more:

IBM Cloud Object Storage MuleSoft Connector



Embed the CData MuleSoft Connector for IBM Cloud Object Storage in a Mule Application and deploy it to the MuleSoft CloudHub or an on-premise server.

The CData Mule Connector for IBM Cloud Object Storage connects IBM Cloud Object Storage data to Mule applications enabling read functionality with familiar SQL queries. The Connector allows users to easily create Mule applications with access to live IBM Cloud Object Storage data that can be deployed to an on-premise server for internal access or to the MuleSoft CloudHub for direct cloud access.

Add IBM Cloud Object Storage Connectivity to Mule Apps

This article walks through embedding the CData Mule Connector for IBM Cloud Object Storage 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 IBM Cloud Object Storage Connector.

Embed IBM Cloud Object Storage Connectivity

The steps below outline adding the IBM Cloud Object Storage Connector to your project and configuring the connection and connector.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add a CData IBM Cloud Object Storage Connector to the application.
  3. Create a new Connection (or edit an existing one) and configure the properties to connect to IBM Cloud Object Storage (see below). Once the connection is configured, click Test Connection to ensure the connectivity to IBM Cloud Object Storage.

    Register a New Instance of Cloud Object Storage

    If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

    1. Log in to your IBM Cloud account.
    2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

    Connecting using OAuth Authentication

    There are certain connection properties you need to set before you can connect. You can obtain these as follows:

    API Key

    To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

    1. Log in to your IBM Cloud account.
    2. Navigate to the Platform API Keys page.
    3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
    4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

    Cloud Object Storage CRN

    If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

    • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
    • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

    Connecting to Data

    You can now set the following to connect to data:

    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • ApiKey: Set this to your API key which was noted during setup.
    • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

    When you connect, the connector completes the OAuth process.

    1. Extracts the access token and authenticates requests.
    2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Configure the CData IBM Cloud Object Storage 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 IBM Cloud Object Storage data. Download a free, 30 day trial of the Mule Connector for IBM Cloud Object Storage and see the CData difference in your Mule applications today.