Build Microsoft Dataverse-Connected Apps in Mendix



Use CData Connect Cloud to create an OData feed for Microsoft Dataverse Data and create custom apps in Mendix.

Mendix is a high-productivity app platform that allows you to build and maintain both mobile and web applications at-scale. When paired with CData Connect Cloud, Mendix provides instant, cloud-to-cloud access to Microsoft Dataverse data for applications. This article demonstrates how to connect to a CData Connect Cloud data source from within Mendix.

CData Connect Cloud provides a pure cloud-to-cloud interface for Microsoft Dataverse, allowing you to import data from live Microsoft Dataverse data in Mendix — without replicating the data to a natively supported database. As you build web and mobile applications from within Mendix, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Microsoft Dataverse, leveraging server-side processing to return the requested Microsoft Dataverse data quickly.

About Microsoft Dataverse Data Integration

CData provides the easiest way to access and integrate live data from Microsoft Dataverse (formerly the Common Data Service). Customers use CData connectivity to:

  • Access both Dataverse Entities and Dataverse system tables to work with exactly the data they need.
  • Authenticate securely with Microsoft Dataverse in a variety of ways, including Azure Active Directory, Azure Managed Service Identity credentials, and Azure Service Principal using either a client secret or a certificate.
  • Use SQL stored procedures to manage Microsoft Dataverse entities - listing, creating, and removing associations between entities.

CData customers use our Dataverse connectivity solutions for a variety of reasons, whether they're looking to replicate their data into a data warehouse (alongside other data sources)or analyze live Dataverse data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Configure Microsoft Dataverse Connectivity for Mendix

Connectivity to Microsoft Dataverse from Mendix is made possible through CData Connect Cloud. To work with Microsoft Dataverse data from Mendix, we start by creating and configuring a Microsoft Dataverse connection.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Microsoft Dataverse" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to 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.

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Microsoft Dataverse Connection page and update the User-based permissions.

Configure Microsoft Dataverse Endpoints for Mendix

After connecting to Microsoft Dataverse, create a workspace and virtual dataset for your desired table(s).

  1. Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
  2. Click Add to add new assets to the Workspace.
  3. Select the Microsoft Dataverse connection (e.g. CDS1) and click Next.
  4. Select the table(s) you wish to work with and click Confirm.
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection and Workspace configured, you are ready to connect to Microsoft Dataverse data from Mendix.

Build a Microsoft Dataverse-Connected App

With the Workspace added to Connect Cloud, you can build an app in Mendix with live access to Microsoft Dataverse data.

Downloading the OData Metadata File

When creating a connection in Mendix, the connection flow requires a Data Source Contract File. Follow these steps to download the OData metadata file for CData Connect Cloud using curl, a command line tool:

  1. Open a command-line window for your operating system. On Windows, open the start menu, type cmd, and press the Enter key to open a command prompt. On macOS and Linux, open a Terminal window.
  2. To check if curl is installed on your system, type curl -help and press the enter key. If it is not installed, install it from the curl website.
  3. Issue the following curl command, replacing USER with your CData Connect Cloud username and PAT with the PAT you generated above: curl -u USER:PAT https://cloud.cdata.com/api/odata/{workspace_name}/$metadata -o metadata.xml
  4. Locate the metadata.xml file that the curl command created and move it to an accessible location.

Connecting to CData Connect Cloud in Mendix

Follow these steps to establish a connection from Mendix to CData Connect Cloud:

  1. Login to Mendix and open the Data Hub page.
  2. In the Register a Data Source section, select OData.
  3. Upload the metadata.xml file from the steps above and click Next.
  4. Enter your desired values for Data Source Name and Data Source Version. In the Data Source Relative Path field, enter /api/odata/{workspace_name} and click Next.
  5. On the Application information page, click Register a new application.
  6. Enter a name in Application Name and select a technical owner (by default, this is the user who is currently logged in).
  7. Click Next. In the Environment Name field, enter a desired name (for example, CData Connect Cloud). In the Environment Location field, enter https://cloud.cdata.com and select the appropriate Environment Type (e.g. Production), depending on what is needed.
  8. Click Done! to create your connection.

You can now use your connection in Mendix Studio Pro to easily create applications with access to live Microsoft Dataverse data.

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect Cloud today!

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial