Skip to Content

Elasticsearch Update Document activity

Introduction

An Elasticsearch Update Document activity, using its Elasticsearch connection Updates a document in Elasticsearch and is intended to be used as a target in an operation.

Note

If the Elasticsearch security features are enabled in your Elasticsearch instance, you must have the index or write index privilege for the target index or index alias.

Create an Elasticsearch Update Document activity

An instance of an Elasticsearch Update Document activity is created from an Elasticsearch connection using its Update Document 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 Update Document activity can be edited from these locations:

Configure an Elasticsearch Update Document activity

Follow these steps to configure an Elasticsearch Update Document activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and enter the name of the index containing the document to be updated:

Elasticsearch Update Document 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 Update Document activity and must not contain forward slashes (/) or colons (:).

  • Index: Enter the name of the index containing the document to be updated.

  • Update Using Script: Select to update the document using a specified script. See Elasticsearch scripting for details.

  • Upsert: Select to update the document by upserting.

  • Timeout (in Milliseconds): Enter the timeout in milliseconds for the Update Document activity. A timeout of zero never expires, in which case the call blocks indefinitely. The default value is 30000.

  • Routing: Enter the routing value for the index shard.

  • Refresh Policy: Specify the refresh policy to be used, one of Immediate, or None, or Wait Until.

  • 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 Update Document 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 schemas consist of these nodes and fields:

Request Schema Node/Field Description
id The ID for the updated document
_source JSON to be passed to the index
script The script used for updating the document, if applicable
Response Schema Node/Field Description
success Indicates the successful update of the document
errorDetails Error code for unsuccessful update of the document, if applicable
errorMsg Error message if for unsuccessful update of the document, if applicable

  • 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 Update Document 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 Update Document activities can be used as a target 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.