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. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the MongoDB MongoDB icon tab.
      2. On the MongoDB MongoDB icon tab, drag the Update Documents Update Documents icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Update Documents activity.

Figure: General Configuration screen

General Configuration screen

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

Update Documents Configuration > Request Data

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

Figure: Update Documents Configuration > Request Data tab

Update Documents Configuration Request Data tab

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 Add Token icon
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

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?

Action
Function:
Specifies how to change the fields in the documents.
Accepted 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 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 Add Token icon
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 Create icon
Function:
Adds more than one condition.

Delete Delete icon

Function:
Deletes the row.