Query Documents (Elasticsearch) activity

An activity that retrives one or more documents from Elasticsearch.

Configure the Query Documents 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 Query Documents activity onto your process.

General Configuration

Specifies the basic settings for the Query Documents 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

Query Documents Configuration > Where tab

Specifies the information about the documents to retrieve from 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 from which to retrieve the documents. 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?
Row Limit	Description: Specifies the maximum number of documents to retrieve from Elasticsearch. Allowed Values: An integer. Range 1-10000 Default Value: 10000 Accepts Variables: No
Enter Filter Condition / Build Filter Condition / Advanced Query	Description: Specifies how to configure a filter condition for your query. Allowed Values: Enter Filter Condition – Specifies a filter condition to retrieve information about one or more documents from Elasticsearch. Build Filter Condition – Shows the SQL code snippet that is created when you configure the filter condition for your query. You can configure the filter condition on the Query Documents Configuration > Where tab > Create Conditions screen. . Advanced Query – Specifies the SQL WHERE clause to retrieve one or more documents from Elasticsearch. Default Value: Enter Filter Condition Accepts Variables: No 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?
Create	Opens this Screen: Query Documents Configuration > Where tab > Create Conditions Function of this Screen: Configures the condition to use in your query to filter documents.
Delete	Function: Deletes the query from the code snippet.
Edit	Function: Lets you change the query.

Query Documents Configuration > Where tab > Create Conditions

Configures the condition to use in your query to filter documents.

Fields

Field Name	Definition
Add expression	Function: Creates a condition row.
Add group	Function: Creates a new conditional expression group.
Delete	Function: Deletes the condition row.
Select Nest Type	Function: Specifies a Boolean clause to filter the documents from Elasticsearch. You must set the condition first, before you specify the nest type. Allowed Values: must should must_not Default Value: must
Column Name	Description: Specifies the name of the document column from Elasticsearch to use in your query. Allowed Values: The name of a column in Elasticsearch. 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?
Comparer	Description: Specifies the operator to use in your query. Allowed Values: is equal to is less than is less than or equal to is greater than is greater than or equal to contains starts with Default Value: is equal to
Value	Description: Specifies the value for the column. Allowed Values: A valid column value. 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?
Back	Function: Saves the rule and goes back to the Query Documents Configuration screen.

Query Documents Configuration > Response tab

Specifies where to store the response from 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 from which to retrieve the documents. 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?
Row Limit	Description: Specifies the maximum number of documents to retrieve from Elasticsearch. Allowed Values: An integer. Range 1-10000 Default Value: 10000 Accepts Variables: No
Enter Response Payload / Store Response In This Variable	Description: Specifies where to store the response from Elasticsearch. Allowed Values: Enter Response Payload – Specifies a payload to use to map the response to the AgilePoint process schema. Click the Map Response button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Store Response In This Variable – Select this option if you want to store the information from Elasticsearch to a variable in the AgilePoint NX app. In the text field, specify a variable that accepts an alphanumeric string in JSON format. Default Value: Enter Response 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?