Update Documents activity

An activity that changes one or more documents in a MongoDB collection.


Update Documents activity

Configure the Update Documents activity

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

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the MongoDB tab.

    Open MongoDB tab
  3. On the MongoDB tab, drag the Update Documents activity onto your process.

    Drag Update Documents activity

General Configuration

Specifies the basic settings for the Update Documents activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

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

Fields

Field NameDefinition

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

Update Documents Configuration > Update Data

Configures the request settings to change one or more documents in a MongoDB collection.

Figure: Update Documents Configuration > Update Data tab

Update Documents Configuration Update Data tab

Fields

Field NameDefinition

MongoDB
Description:
Specifies the access token that connects to your MongoDB.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for MongoDB
Function of this Screen:
Configure an access token to connect to MongoDB.

Database
Description:
Specifies the name of your MongoDB database.

When you select an access token, the databases associated with the MongoDB shows in this field.

Allowed Values:
A database name from the list.
Default Value:
None
Accepts Variables:
Yes

Collection
Description:
Specifies the MongoDB database table name.

When you select a database, the table names associated with the database show in this field.

Allowed Values:
A table name from the list.
Default Value:
None
Accepts Variables:
Yes

Column Name
Description:
Specifies the name of the MongoDB column.

When you select a table name, the column names associated with the table show in this field.

Allowed Values:
An column name from the list.
Default Value:
None
Accepts Variables:
No

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?

Data Type
Description:
Specifies the data type for your column.
Allowed Values:
  • String
  • Number
  • Boolean
  • ObjectId
Default Value:
String

Action
Description:
Specifies how to change the fields in the documents.
Allowed Values:
  • Current Date - Sets the value of a field to current date, either as a Date or a Timestamp.
  • Inc - Increments the value of the field by the specified amount.
  • Min - Only updates the field if the specified value is less than the existing field value.
  • Max - Only updates the field if the specified value is greater than the existing field value.
  • Multiply - Multiplies the value of the field by the specified amount.
  • Rename - Changes the name of a field.
  • Set - Sets the value of a field in a document.
  • Set On Insert - Sets the value of a field if an update results in an insert of a document. Has no effect on update operations that modify existing documents.
  • Unset - Removes the specified field from a document.
Default Value:
Set

Create Create icon
Function:
Adds more than one condition.

Delete Delete icon

Function:
Deletes the row.

Update Documents Configuration > Condition

Specifies the query conditions to change one or more documents in a MongoDB collection.

Figure: Update Documents Configuration > Condition tab

Update Documents Configuration Condition tab

Fields

Field NameDefinition

MongoDB
Description:
Specifies the access token that connects to your MongoDB.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon
Opens this Screen:
Access Token for MongoDB
Function of this Screen:
Configure an access token to connect to MongoDB.

Database
Description:
Specifies the name of your MongoDB database.

When you select an access token, the databases associated with the MongoDB shows in this field.

Allowed Values:
A database name from the list.
Default Value:
None
Accepts Variables:
Yes

Collection
Description:
Specifies the MongoDB database table name.

When you select a database, the table names associated with the database show in this field.

Allowed Values:
A table name from the list.
Default Value:
None
Accepts Variables:
Yes

Code Snippet
Description:
Shows the SQL code snippet that is created when you configure the filter condition for your query.
Allowed Values:
Read only.
Default Value:
None

Create Create icon

Opens this Screen:
Update Documents Configuration > Create Conditions
Function of this Screen:
Configures the condition to use in your query to filter documents.
Limitations:
This field is available in these releases:

Delete Delete icon

Function:
Deletes the query from the code snippet.

Edit Edit icon

Function:
Lets you change the query.

Update Documents Configuration > Create Conditions

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

Figure: Update Documents Configuration > Create Conditions

Update Documents Configuration Create Conditions screen

Prerequisites

Fields

Field NameDefinition

Add expression Add Expression icon

Function:
Creates a condition row.

Add group Add Group icon

Function:
Creates a new conditional expression group.

Delete Delete icon

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.

Allowed Values:
  • And - Specifies the logical AND operator.
  • Or - Specifies the logical OR operator.
Default Value:
AND

Column Name
Description:
Specifies the name of the MongoDB column.

When you select a table name, the column names associated with the table show in this field.

Allowed Values:
An column name from the list.
Default Value:
None
Accepts Variables:
No

Condition
Description:
Specifies the operator to use in your condition.
Allowed Values:
  • =
  • >
  • >=
  • <
  • <=
  • !=
  • Exists
Default Value:
=

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?

Data Type
Description:
Specifies the data type for your column.
Allowed Values:
  • String
  • Number
  • Boolean
  • ObjectId
Default Value:
String

Back Back icon

Function:
Saves the rule and goes back to the activity configuration screen.