Skip to Content

Elasticsearch Search activity

Introduction

An Elasticsearch Search activity, using its Elasticsearch connection, retrieves existing records from Elasticsearch and is intended to be used as a source in an operation.

Note

If the Elasticsearch security features are enabled in your Elasticsearch instance, you must have the read index privilege for the target index or index alias. For cross-cluster search, see Configure privileges for cross-cluster search. To search a point in time (PIT) for an alias, you must have the read index privilege for the alias' data streams or indices.

Create an Elasticsearch Search activity

An instance of an Elasticsearch Search activity is created from an Elasticsearch connection using its Search activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Elasticsearch Search activity can be edited from these locations:

Configure an Elasticsearch Search activity

Follow these steps to configure an Elasticsearch Search activity:

Step 1: Enter a name and query

In this step, provide a name for the activity and enter a query:

Elasticsearch Search activity configuration step 1

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to identify the activity. The name must be unique for each Elasticsearch Search activity and must not contain forward slashes (/) or colons (:).

  • Query: Enter a search query.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas generated from the endpoint are displayed:

Elasticsearch Search activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

!!! note Data supplied in a transformation takes precedence over the activity configuration.

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

The data schema consists of these nodes and fields:

Response Schema Node/Field Description
results Results of the search
item Item
_index Name of the index
_type The document's type
_id The document's ID
_score The document's relevance score
_source Indicates which source fields are returned for matching documents

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Elasticsearch endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an Elasticsearch Search activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Elasticsearch Search activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.