Elasticsearch Get Document activity
Introduction
An Elasticsearch Get Document activity, using its Elasticsearch connection, retrieves a document from Elasticsearch, and is intended to be used as a source to provide data 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.
Create an Elasticsearch Get Document activity
An instance of an Elasticsearch Get Document activity is created from an Elasticsearch connection using its Get 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 Get Document activity can be edited from these locations:
- The design canvas (see Component actions menu in Design canvas).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
Configure an Elasticsearch Get Document activity
Follow these steps to configure an Elasticsearch Get Document activity:
- Step 1: Enter a name and specify settings
Provide a name for the activity and enter the name of the index containing the document to be retrieved. - Step 2: Review the data schemas
Any request or response schemas generated from the endpoint are displayed.
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 retrieved:
Tip
Fields with a 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 Get Document activity and must not contain forward slashes (
/) or colons (:). -
Index: Enter the name of the index containing the document.
-
Routing: Enter the routing value for the index shard.
-
Version Type: Specify the version type to be used, one of Internal, External, or External GTE.
-
Refresh: Specify the refresh to be used, one of True or False.
-
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:
- 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 of the document |
| version | The document version |
| Response Schema Node/Field | Description |
|---|---|
| index | Name of the index containing the document |
| type | Type of document |
| id | The ID of the document |
| version | The document version |
| seq_no | The document's assigned sequence number |
| primary_term | The document's assigned primary term |
| found | Indicates whether the document exists |
| source | If found is true, contains the document data formatted in the JSON |
-
Refresh: Click the 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 Get 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 Get Document activities can be used as a source with these operation patterns:
- Transformation pattern
- Two-target archive pattern (as the first source only)
- Two-target HTTP archive pattern (as the first source only)
- Two-transformation pattern (as the first or second source)
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.