Elasticsearch Connection¶

Introduction¶

An Elasticsearch connection, created using the Elasticsearch connector, establishes access to Elasticsearch. Once a connection is configured, you can create instances of Elasticsearch activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit an Elasticsearch Connection¶

A new Elasticsearch connection is created using the Elasticsearch connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing Elasticsearch connection can be edited from these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
• The Global Connections page (see Edit a Global Connection in Global Connections).

Configure an Elasticsearch Connection¶

Configuration of an Elasticsearch connection includes these fields:

• Connection Name: Enter a name to use to identify the Elasticsearch connection. The name must be unique for each Elasticsearch connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Elasticsearch endpoint, which refers to both a specific connection and its activities.

• Host: Enter the network host. If a scheme (HTTP or HTTPS) is not provided, HTTP is assumed when making requests.

• Port Number: Enter the port number.

• Use Authentication: If selected, your Elasticsearch username and password will be used. If unselected, only the host and port number will be used.

• Username: Enter the username associated with your Elasticsearch account.

• Password: Enter the password associated with your Elasticsearch account.

• Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After an Elasticsearch connection has been created, you place an activity type on the design canvas to create an activity instance to be used either as a source (to provide data in an operation) or as a target (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

• 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.