Query Documents activity

An activity that executes a query to get one or more documents from a MongoDB collection.

Configure the Query Documents activity

To configure the Query Documents activity, do the procedure in this topic.

Prerequisites

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

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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?
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, in the Activity Library, open the MongoDB tab.
  2. On the MongoDB tab, drag the Query Documents activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Query Documents activity.

Fields

Field Name	Definition
Display Name	Function: Specifies the activity name that shows in your process. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data 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	Function: Specifies an optional text description for your activity. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No

Field Name

Definition

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data 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

Function:: Specifies an optional text description for your activity.
Accepted Values:: More than one line of text.
Default Value:: None
Accepts Process Data Variables:: No

Query Documents Configuration > Condition

Specifies the conditions for a query to get one or more documents from MongoDB collection.

Fields

Field Name	Definition
MongoDB	Function: Specifies the access token that connects to your MongoDB. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No
Add Token	Opens this Screen: Access Token for MongoDB Function of this Screen: Configure an access token to connect to MongoDB.
Database	Function: Specifies the name of your MongoDB database. When you select an access token, the databases associated with the MongoDB shows in this field. Accepted Values: A database name from the list. Default Value: None Accepts Process Data Variables: Yes
Collection	Function: Specifies the MongoDB database table name. When you select a database, the table names associated with the database show in this field. Accepted Values: A table name from the list. Default Value: None Accepts Process Data Variables: Yes
Column Name	Function: Specifies the name of the MongoDB column. When you select a table name, the column names associated with the table show in this field. Accepted Values: An column name from the list. Default Value: None Accepts Process Data Variables: No
Condition	Function: Specifies the operator to use in your condition. Accepted Values: = > >= IN NOT IN < <= != Default Value: =
Value	Function: Specifies the value for the column. Accepted Values: A valid column value. Default Value: None Accepts Process Data Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
Operator	Function: Specifies the logical operator for your condition. Accepted Values: AND NOT NOR OR Default Value: AND
Create	Function: Adds more than one condition.
Delete	Function: Deletes the row.

Query Documents Configuration > Response tab

Configures the connection from MongoDB database response parameter to your schema.

Fields

Field Name	Definition
MongoDB	Function: Specifies the access token that connects to your MongoDB. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No
Add Token	Opens this Screen: Access Token for MongoDB Function of this Screen: Configure an access token to connect to MongoDB.
Database	Function: Specifies the name of your MongoDB database. When you select an access token, the databases associated with the MongoDB shows in this field. Accepted Values: A database name from the list. Default Value: None Accepts Process Data Variables: Yes
Collection	Function: Specifies the MongoDB database table name. When you select a database, the table names associated with the database show in this field. Accepted Values: A table name from the list. Default Value: None Accepts Process Data Variables: Yes
Save Response To This Variable	Function: Specifies the process data variable to store the JSON payload at runtime. Accepted Values: A process data variable that accepts an alphanumeric string in JSON format. Default Value: None Accepts Process Data Variables: Yes Example: [{ "_id" : ObjectId("59a392f9469ab4a19adaa0fe"), "title" : "Star Wars: Episode IV - A New Hope", "year" : 1977.0, "rated" : "PG", "runtime" : 121.0, "genres" : ["Action", "Adventure", "Fantasy"], "director" : "George Lucas" …}]
Map Response to Process Schema	Function: Specifies the connection from the MongoDB API response parameter to your schema. Accepted Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?