Insert Document (Elasticsearch) activity

An activity that inserts a document in Elasticsearch.

Configure the Insert Document activity

Examples

(External) AgilePoint NX Connector For Elasticsearch
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Elasticsearch tab.
On the Elasticsearch tab, drag the Insert Document activity onto your process.

General Configuration

Specifies the basic settings for the Insert Document activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Insert Document Configuration

Specifies the information to insert a document in Elasticsearch.

Fields

Field Name	Definition
Elasticsearch	Description: Specifies the access token that connects to your Elasticsearch service. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No
Create	Opens this Screen: Access Token for Elasticsearch Function of this Screen: Configure an access token to connect to Elasticsearch.
AgilePoint Index / Custom Index	Description: Specifies whether the Index Name field shows AgilePoint indexes or custom indexes from Elasticsearch. Allowed Values: AgilePoint Index - Shows indexes that are configured for AgilePoint NX in Elasticsearch. Custom Index - Shows all the predefined indexes from Elasticsearch. Default Value: AgilePoint Index Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Index Name	Description: Specifies the name of the index in which to insert the document. Allowed Values: An index name from the list. When you select the index type from the AgilePoint Index / Custom Index field, this field shows the indexes associated with the index type. Default Value: None Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Provide Custom Document ID	Description: Specifies whether to create a custom ID for the document inserted in Elasticsearch. Allowed Values: Deselected - Specifies a variable in the Store Response Document ID In This Variable field to store the document ID from Elasticsearch. Selected - Specifies a new custom ID. Default Value: Deselected
Document ID	Description: Specifies the ID of the document to create in Elasticsearch. To Open this Field: On the Insert Document Configuration screen, select Provide Custom Document ID. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Enter Request Payload / Get Request Payload From This Variable / Form Data	Description: Specifies how to connect the request data from Elasticsearch to the AgilePoint process schema. Allowed Values: Enter Request Payload – Specify a payload to use to connect to the process schema. In the text field, specify a payload in JSON format. Click Map Request To App Schema to open the Schema Mapper screen. Use this screen to connect the payload values to the AgilePoint process schema. Get Request Payload From This Variable – Sends a request with a variable in the AgilePoint NX app. In the text field, specify a variable that stores the request payload. Form Data – Sends a request using the form fields in the AgilePoint NX app. If this option is selected, it converts all the form fields in the app to JSON format and uses the result as the request payload. Default Value: Enter Request Payload Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Store Response Document ID In This Variable	Description: Specifies a variable to store the document ID from Elasticsearch. To Open this Field: On the Insert Document Configuration screen, deselect Provide Custom Document ID. Allowed Values: A process data variable that accepts an alphanumeric string with no spaces or special characters. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?