VOOZH about

URL: https://www.cdata.com/kb/tech/elasticsearch-cloud-runmyprocess.rst

⇱ Connect to Elasticsearch Data in RunMyProcess through Connect AI

Connect to Elasticsearch Data in RunMyProcess through Connect AI

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to create on OData API for Elasticsearch Data and connect to Elasticsearch data in Akorbi Digital RunMyProcess.

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect AI creates a live connection to Elasticsearch and can be used to generate an OData API (natively supported in RunMyProcess) for Elasticsearch. By pairing RunMyProcess with CData Connect AI, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect AI from RunMyProcess as you would any other REST service and get instant, live access to your Elasticsearch data.

In this article, we walk through connecting to Elasticsearch from CData Connect AI and accessing Elasticsearch data through an OData feed in RunMyProcess.

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


Connect to Elasticsearch from RunMyProcess

To work with live Elasticsearch data in RunMyProcess, we need to connect to Elasticsearch from Connect AI, provide user access to the connection, and create a Workspace for the Elasticsearch data.

Connect to Elasticsearch from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
    2. 👁 Adding a Connection
  2. Select "Elasticsearch" from the Add Connection panel
    3. 👁 Selecting a data source
  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.

    👁 Configuring a connection (Salesforce is shown)
  4. Click Save & Test
  5. 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.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. 👁 Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Elasticsearch Endpoints for RunMyProcess

After connecting to Elasticsearch, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). 👁 The Workspaces page.
    👁 Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the Elasticsearch connection (e.g. Elasticsearch1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Elasticsearch data from RunMyProcess.

Retrieve Elasticsearch Data from RunMyProcess DigitalSuite Studio

With the connection to Elasticsearch and OData endpoints created, we are ready to add Elasticsearch data to RunMyProcess for Retrieval.

Create a Provider

  1. Log into RunMyProcess and open DigitalSuite Studio.
  2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab. 👁 Connectors page
  3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm. 👁 Create a new provider
  4. In the provider settings page, configure the following properties.
    • URL: Set the OData endpoint in the Connect AI OData page: https://cloud.cdata.com/api/odata/{workspace_name}.
    • Authentication Schema: Select Login/Password.
    • Login: Specify a CData Connect AI username (e.g. [email protected]).
    • Password: Specify the PAT of the Connect AI user.
    👁 Selecting a connector
  5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
  6. Click Save to save the properties.

Retrieve Elasticsearch Data by Creating a Connector

  1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
  2. In the following page, set Connector URL to the OData endpoint configured in Connect AI (e.g. https://cloud.cdata.com/api/odata/{workspace_name}) 👁 Connector settings page
  3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information. 👁 Execution test page

More Information & Free Trial

Now, you have created a provider and connector to retrieve Elasticsearch data. For more information on creating OData feeds from Elasticsearch (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Elasticsearch data in RunMyProcess.