Skip to Content

Elasticsearch Connector

Summary

The Elasticsearch connector establishes access to Elasticsearch.

The connector provides an interface for creating an Elasticsearch connection, the foundation used for generating instances of Elasticsearch activities. These activities, once configured, interact with Elasticsearch through the connection.

The Elasticsearch connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure an Elasticsearch connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (providing data) or targets (receiving data) in an operation.

Together, a specific Elasticsearch connection and its activities are referred to as an Elasticsearch endpoint:

Elasticsearch activity types

  • Search: Retrieves existing records from Elasticsearch and is intended to be used as a source in an operation.

  • Get Index: Retrieves a list of indices from Elasticsearch and is intended to be used as a source in an operation.

  • Get Document: Retrieves a document from Elasticsearch and is intended to be used as a source in an operation.

  • Delete Document: Deletes a document from Elasticsearch and is intended to be used as a target in an operation.

  • Open Index: Opens a previously closed index in Elasticsearch and is intended to be used as a target in an operation.

  • Close Index: Closes an index in Elasticsearch and is intended to be used as a target in an operation.

  • Create Index: Creates a new index in Elasticsearch and is intended to be used as a target in an operation.

  • Create Document: Creates a new document in Elasticsearch and is intended to be used as a target in an operation.

  • Delete Index: Deletes one or more indices from Elasticsearch and is intended to be used as a target in an operation.

  • Update Document: Updates a document in Elasticsearch and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Elasticsearch connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Elasticsearch connector uses the Elasticsearch REST API 7.14.1. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Elasticsearch connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.elasticsearch" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.