Build Elasticsearch-Connected Apps in Mendix


Use CData Connect Cloud to create an OData feed for Elasticsearch 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 Elasticsearch 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 Elasticsearch, allowing you to import data from live Elasticsearch 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 Elasticsearch, leveraging server-side processing to return the requested Elasticsearch data quickly.

About Elasticsearch Data Integration

Accessing and integrating live data from Elasticsearch has never been easier with CData. Customers rely on CData connectivity to:

  • Access both the SQL endpoints and REST endpoints, optimizing connectivity and offering more options when it comes to reading and writing Elasticsearch data.
  • Connect to virtually every Elasticsearch instance starting with v2.2 and Open Source Elasticsearch subscriptions.
  • Always receive a relevance score for the query results without explicitly requiring the SCORE() function, simplifying access from 3rd party tools and easily seeing how the query results rank in text relevance.
  • Search through multiple indices, relying on Elasticsearch to manage and process the query and results instead of the client machine.

Users frequently integrate Elasticsearch data with analytics tools such as Crystal Reports, Power BI, and Excel, and leverage our tools to enable a single, federated access layer to all of their data sources, including Elasticsearch.

For more information on CData's Elasticsearch solutions, check out our Knowledge Base article: CData Elasticsearch Driver Features & Differentiators.


Getting Started


Configure Elasticsearch Connectivity for Mendix

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

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Elasticsearch" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Elasticsearch.

    Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

    The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

    Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

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

Configure Elasticsearch Endpoints for Mendix

After connecting to Elasticsearch, 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 Elasticsearch connection (e.g. Elasticsearch1) 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 Elasticsearch data from Mendix.

Build a Elasticsearch-Connected App

With the Workspace added to Connect Cloud, you can build an app in Mendix with live access to Elasticsearch 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 Elasticsearch 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

In this article

Related articles