Delete Documents activity

An activity that deletes one or more documents from a MongoDB collection.


Delete Documents activity

Configure the Delete Documents activity

To configure the Delete 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 Delete Documents activity onto your process.

    Drag Delete Documents activity

General Configuration

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

Delete Documents Configuration

Specifies the settings to delete one or more documents from a MongoDB collection.

Figure: Delete Documents Configuration screen

Delete Documents Configuration screen

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

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?

Operator

Description:
Specifies the logical operator for your condition.
Allowed Values:
  • AND
  • NOT
  • NOR
  • OR
Default Value:
AND

Create Create icon

Function:
Adds more than one condition.

Delete Delete icon

Function:
Deletes the row.