Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Build Cosmos DB-Connected Apps in Mendix
Use CData Connect Cloud to create an OData feed for Cosmos DB 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 Cosmos DB 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 Cosmos DB, allowing you to import data from live Cosmos DB 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 Cosmos DB, leveraging server-side processing to return the requested Cosmos DB data quickly.
Configure Cosmos DB Connectivity for Mendix
Connectivity to Cosmos DB from Mendix is made possible through CData Connect Cloud. To work with Cosmos DB data from Mendix, we start by creating and configuring a Cosmos DB connection.
- Log into Connect Cloud, click Connections and click Add Connection
- Select "Cosmos DB" from the Add Connection panel
-
Enter the necessary authentication properties to connect to Cosmos DB.
To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:
- AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
- AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
- Click Create & Test
- Navigate to the Permissions tab in the Add Cosmos DB Connection page and update the User-based permissions.
Configure Cosmos DB Endpoints for Mendix
After connecting to Cosmos DB, create a workspace and virtual dataset for your desired table(s).
- Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
- Click Add to add new assets to the Workspace.
- Select the Cosmos DB connection (e.g. CosmosDB1) and click Next.
- Select the table(s) you wish to work with and click Confirm.
- 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 Cosmos DB data from Mendix.
Build a Cosmos DB-Connected App
With the Workspace added to Connect Cloud, you can build an app in Mendix with live access to Cosmos DB 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:
- 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.
- 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.
-
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
- 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:
- Login to Mendix and open the Data Hub page.
- In the Register a Data Source section, select OData.
- Upload the metadata.xml file from the steps above and click Next.
- 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.
- On the Application information page, click Register a new application.
- Enter a name in Application Name and select a technical owner (by default, this is the user who is currently logged in).
- 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.
- Click Done! to create your connection.
You can now use your connection in Mendix Studio Pro to easily create applications with access to live Cosmos DB 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!