Access Microsoft Dataverse Data in Mule Applications Using the CData JDBC Driver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Microsoft Dataverse JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft Dataverse.



Create a simple Mule Application that uses HTTP and SQL with the CData JDBC Driver for Microsoft Dataverse to create a JSON endpoint for Microsoft Dataverse data.

The CData JDBC Driver for Microsoft Dataverse connects Microsoft Dataverse data to Mule applications enabling read , write, update, and delete functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Microsoft Dataverse data.

This article demonstrates how to use the CData JDBC Driver for Microsoft Dataverse inside of a Mule project to create a Web interface for Microsoft Dataverse data. The application created allows you to request Microsoft Dataverse data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver 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 Database Select Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties.
    • Set Connection to "Generic Connection"
    • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.cds.jar).
    • Set the URL to the connection string for Microsoft Dataverse

      You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
      • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
      • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

      When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Microsoft Dataverse JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.cds.jar

      Fill in the connection properties and copy the connection string to the clipboard.

    • Set the Driver class name to cdata.jdbc.cds.CDSDriver.
    • Click Test Connection.
  6. Set the SQL Query Text to a SQL query to request Microsoft Dataverse data. For example: SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'
  7. Add a Transform Message Component to the flow.
  8. Set the Output script to the following to convert the payload to JSON:
    %dw 2.0
    output application/json
    ---
    payload
            
  9. To view your Microsoft Dataverse data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Microsoft Dataverse 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 Microsoft Dataverse 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 JDBC Driver for Microsoft Dataverse and see the CData difference in your Mule Applications today.