Skip to end of metadata
Go to start of metadata

Introduction

A MongoDB delete activity deletes data from a MongoDB connection and is used as a target in an operation. After configuring a MongoDB connection, you can configure as many MongoDB activities as you like for each MongoDB connection.

Creating a MongoDB Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the MongoDB connection block to display activities that are available to be used with a MongoDB connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a MongoDB activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a MongoDB Delete Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a MongoDB Delete Activity

Follow these steps to configure a MongoDB delete activity:

  • Step 1 - Select an Object
  • Step 2 - Specify Filter, Locale, and Writing of DocumentID
  • Step 3 - Review Data Schema

Step 1 - Select an Object

Connectivity tab

  • Name: Enter a name to use to identify the MongoDB delete activity. The name must be unique for each delete activity and must not contain forward slashes (/) or colons (:).

  • Select an Object: This section displays objects (collections) available in the MongoDB endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • Selected MongoDB Object: After an object is selected, it will be listed here.
    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the MongoDB endpoint. This may be useful if you have recently added objects to the MongoDB instance. This action refreshes all metadata used to build the table of objects displayed in the configuration.
    • Select an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the MongoDB endpoint:
      • Name: The object name from MongoDB.
      • Description: The object description from MongoDB.

    TIP: If the table does not populate with available objects, the MongoDB connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2 - Specify Filter, Locale, and Writing of DocumentID

Connectivity tab

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Filter: Enter a filter (in MongoDB Extended JSON format) to use to match the documents to be deleted from the selected collection.

  • Locale: Enter a locale to specify a language for the documents in the selected collection (optional).

  • Write Document IDs in Response: Select to specify that the document IDs of deleted documents are written in the response (optional).

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 3 - Review Data Schema

Connectivity tab

  • Data Schema: The request and response data schemas for MongoDB will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The MongoDB connector uses the MongoDB Java SDK v3.10. Refer to the SDK documentation and the MongoDB reference for information on the fields used in the request and response schemas.

    The values in the input request take precedence over what is provided in the configuration.

    • Request:

      Request Schema Field/NodeTypeNotes
      deleteRequestRequest to delete documents from the database
      filterStringA filter in MongoDB Extended JSON format used to match the documents to be deleted from the selected collection
      localeStringLocale to specify a language for the documents in the selected collection (optional)
      documentIdBooleanWhether to write document IDs in the response (optional)
    • Response:

      Response Schema Field/NodeTypeNotes
      deleteResponseResponse from deleting documents in the database
      number_of_deleted_documentsIntegerNumber of documents (records) deleted
      documentsnodeNode representing the documents
      documentIdStringID of the deleted document
      errornodeNode representing the error
      errorMessageStringError message
  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a MongoDB delete activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

MongoDB delete activities can be used as a target with these operation patterns:

Other patterns are not valid using MongoDB delete activities. See the validation patterns on the Operation Validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jul 29, 2019

  • No labels