The MuleSoft Anypoint Platform enables the building, deployment, and management of APIs and integrations, facilitating seamless connectivity across applications and systems. When combined with CData Connect AI, it provides access to Elasticsearch data for visualizations, dashboards, and more. This article explains how to use CData Connect AI to create a live connection to Elasticsearch and how to connect and access live Elasticsearch data from the MuleSoft Anypoint Platform.
Prerequisites
Before configuring and using MuleSoft with CData Connect AI, you must first connect a data source to your CData Connect AI account. For more information, see the Connections section.
Additionally, you need to generate a Personal Access Token (PAT) on the Settings page. Be sure to copy it down, as it serves as your password during authentication.
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 MuleSoft
Connectivity to Elasticsearch from MuleSoft is made possible through CData Connect AI. To work with Elasticsearch data from MuleSoft, we start by creating and configuring a Elasticsearch connection.
-
Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection
- Select "Elasticsearch" from the Add Connection panel
👁 Selecting a data source
-
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.
👁 Configuring a connection (Salesforce is shown)
-
Click Save & Test
-
Navigate to the Permissions tab in the Add Elasticsearch Connection page and update the User-based permissions.
👁 Updating permissions
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
-
Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
-
On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
👁 Creating a new PAT
-
The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
With the connection configured and a PAT generated, you are ready to connect to Elasticsearch data from Mulesoft.
Connecting to CData Connect AI
Follow these steps to establish a connection from Mulesoft to CData Connect AI through the JDBC driver:
-
Download and install the CData Connect AI JDBC driver.
-
Open the Integrations page of CData Connect AI.
-
Search for and select JDBC.
-
Download and run the setup file.
-
When the installation is complete, the JAR file can be found in the installation directory (inside the lib folder).
- Log into Mulesoft Anypoint Studio or launch the desktop application.
- Create a new Mulesoft project.
👁 Create a new MuleSoft project
👁 Add the project name
The new project appears in a project folder.
👁 The new project is created
- In the Mule Palette located on the right, drag an HTTP Listener to the Message Flow area.
👁 Drag the HTTP Listener to the Message Flow area
- Click on the HTTP Listener to configure it.
👁 Click on the HTTP Listener to configure it
- Click the + sign on the right of Connector configuration. The HTTP Listener config dialog appears.
- Configure the HTTP Listener, providing a Port on which to query your data, and click OK.
👁 Add the port number to configure the HTTP Listener
- Provide a path on which to perform the actions. The HTTP Listener is now configured.
👁 Provide a path to perform the actions
- In the Mule Palette on the right, type database in the search bar.
👁 Search for database in Mule Palette search bar
- Drag the database operation you want to perform to the Message Flow area. For this example, we choose Select.
👁 Drag the database operation in the Message Flow area
- Select Generic Connection from the Connection dropdown in the Database Config dialog.
👁 Select Generic Connection from the Connection dropdown
- Click the Configure button to configure the JDBC driver. Select Use local file from the drop-down list.
👁 Select Use local file from the dropdown
- Locate the CData Connect AI JAR file from the JDBC driver installation and click OK.
👁 Add the CData Connect AI JAR file path
- Provide the following information:
- Click Test Connection.
👁 Click on Test Connection
- If the connection is successful, provide the SQL Query Text in the editor. You can see the table metadata on the right side in the Output tab.
👁 Write the SQL Query
- In the Mule Palette, drag Transform Message to the Message Flow area.
👁 Drag Transform Message to the Message Flow area
- Click Transform Message to configure it. Change the Output as follows:
👁 Configure Transform Message
- Save your project and run it. In the console, Mulesoft starts initializing the dependencies.
👁 Save and Run the project
- Once you see the message, "Message source 'listener' on flow your_project_name successfully started", you can start querying your data at the endpoint you provided.
👁 Check for the 'Message source 'listener' on flow your_project_name successfully started' message to get started
- Query to check out the data using the Postman application (as shown below).
👁 Send an API request from Postman to check the Elasticsearch data
SQL Access to Elasticsearch Data from Cloud Applications
Now you have a direct connection to live Elasticsearch data from MuleSoft Anypoint Platform. You can create more connections to ensure seamless data flow, automate business processes, and manage APIs - all without replicating Elasticsearch data.
To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources (including Elasticsearch) directly from your cloud applications, explore the CData Connect AI.
