Insert Documents activity

An activity that puts new documents into a MongoDB collection.


Insert Documents activity

Configure the Insert Documents activity

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

    Drag Insert Documents activity

General Configuration

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

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

Insert Documents Configuration

Specifies the information to put new documents into MongoDB collection.

Figure: Insert Documents Configuration screen

Insert Documents Configuration screen

Fields

Field NameDefinition

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

Payload

Function:
Specifies the payload to use when the process runs.
Accepted Values:
  • Get Request JSON from This Variable - Specifies a process data variable that stores the payload. The value of the process data variable must be in a valid JSON format.
  • Map Request JSON to Process Schema - Connects the values in your payload with your AgilePoint process schema.

    Click Map to Schema button to open the Schema Mapper screen. Use this screen to connect the response to process schema.

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?

Map Schema Map Schema icon

Opens this Screen:
Schema Mapper screen
To Open this Field:
  1. On the Insert Documents Configuration screen, click Map Request JSON to Process Schema.
Function of this Screen:
Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..
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?