Query Documents activity

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

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

Create

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

Code Snippet

Function:

Shows the SQL code snippet that is created when you configure the filter condition for your query.

Accepted Values:

Read only.

Default Value:

None

Create

Opens this Screen:

Query Documents Configuration > Create Filter Condition

Function of this Screen:

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

Limitations:

This field is available in these releases:

• AgilePoint NX OnDemand (public cloud)
• AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher

Delete

Function:

Deletes the query from the code snippet.

Edit

Function:

Lets you change the query.

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 the use of logical AND and OR operators to nest conditions to filter documents.

You must set the condition first, before you specify the nest type.

Accepted Values:

• And - Specifies the logical AND operator.
• Or - Specifies the logical OR operator.

Default Value:

AND

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:

• =
• >
• >=
• <
• <=
• !=
• Exists

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. 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?

Data Type

Function:

Specifies the data type for your column.

Accepted Values:

• String
• Number
• Boolean
• ObjectId

Default Value:

String

Back

Function:

Saves your rule and goes back to the activity configuration screen.

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

Create

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 process 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

Example:

Refer to:

• (Example) Schema Mapper