A MongoDB connection is configured via the MongoDB connector to establish access to an account on the MongoDB server. Once a connection is established, you can configure one or more MongoDB activities associated with that connection to use as a source or target within an operation.
Creating or Editing a MongoDB Connection
From the design canvas, open the Connectivity tab of the design component palette:
To configure a new MongoDB connection, within the Connectors filter, click the MongoDB connector block:
To configure an existing MongoDB connection, within the Endpoints filter, double-click the MongoDB connection block:
This will open a configuration screen for the MongoDB connection, covered next.
Configuring a MongoDB Connection
Configuration of a MongoDB connection includes these fields:
TIP: Fields with a variable icon
[ into the field or click the
variable icon to display existing variables to choose from.
Endpoint Name: Enter a name to use to identify the MongoDB connection. The name must be unique for each MongoDB connection and must not contain forward slashes (
/) or colons (
Username: Enter the MongoDB username. See MongoDB Registration.
Password: Enter the MongoDB password. See MongoDB Registration.
Host: Enter the MongoDB host of the MongoDB cluster. See MongoDB Registration.
Database: Enter the MongoDB database. See MongoDB Registration.
Test: Click this button to verify the connection. The server will check only that the specified user can make a connection.
Save Changes: Click this button to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message will ask you to confirm that you want to delete the connection.
After a MongoDB connection has been created, menu actions for that connection are accessible from the project pane's Components tab. See Connection Actions Menu for details.
After configuring a MongoDB connection, you can configure one or more MongoDB activities associated with that connection to use as a source or target within an operation. For more information, see these pages:
Query Activity: Retrieves data from a MongoDB connection and is used as a source in an operation.
Insert Activity: Inserts new data into a MongoDB connection and is used as a target in an operation.
Update Activity: Updates data from a MongoDB connection and is used as a target in an operation.
Delete Activity: Deletes data from a MongoDB connection and is used as a target in an operation.