clsMongoGetObjects Step

Use this step to retrieve a list of objects using a JSON filter condition.

Last published at: January 13th, 2026

Description:

This step retrieves a list of objects using a JSON filter condition.

 

Inputs

  • connID – select MongoDB connection string
  • dbName - provide database name
  • collectionName - provide collection name
  • jsonFilter - provide JSON filter to match objects for update
  • storeVariable - variable/global to store JSON objects 
 

 

Returns

  • True – step executed successfully
  • False - step failed to execute
 

 

 

Usage:

 

 

Prerequisite:

Navigate to the Integration - Connections page. Create a new MongoDB connection string as shown below. Click the Test button to validate the connection response. 

 

 

Example:

Let’s build and execute the “clsMongoGetObjectsDef” example.          

  • Create a new definition named “clsMongoGetObjectsDef” and open it in designer mode. 
  • Drag “clsMongoCreateObjects, and clsMongoGetObjects” steps to the canvas. 
  • Connect the dots between the “Start” and other steps, as shown above.
  • Define a variable or a global variable to store the JSON path and the objects. 
  • Click the "clsMongoCreateObjects" step to configure its "Required" properties. Provide a name for the step. Select the MongoDB connection string from the drop-down list. Provide the database name and the collection name. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.

 

  • Click the "clsMongoCreateObjects" step to configure its "Optional" properties. Provide the JSON data as a multiline string as shown below. You may also provide the server path to a file containing the JSON data. Note: Use only one input field to provide the JSON data, not both. 

 

  • Click the "clsMongoGetObjects" step to configure its "Required" properties. Provide a name for the step. Select the MongoDB connection string from the drop-down list. Provide the database name. Provide the collection name. Provide the variable or global reference to store the JSON object fetched during execution. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.

 

  • Click the "clsMongoGetObjects" step to configure its "Optional" properties. Provide a JSON filter to match the object. Note: This configuration is optional; if left empty, the step will fetch all JSON objects. Click the Save button. 

 

  • The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and execute it. Render the process instance. The instance status “Completed” indicates that all the JSON objects have been successfully fetched from MongoDB. 

 

  • Click the process step to view its properties. The “clsMongoGetObjects” step should fetch the JSON objects as configured, as shown below. 

 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: Please verify and complete the import process steps for any missing configurations, such as file path references and database connections. Then, save the definition to confirm the changes. 

Click here to download the sample file.

The sample JSON data is provided here for reference. 

[{
"empNo":"7369",
"eName":"SMITH",
"designation":"CLERK",
"manager":"7902",
"hire_date":"12/17/1980",
"salary":"800",
"deptNo":"20"
},
{
"empNo":"7499",
"eName":"ALLEN",
"designation":"SALESMAN",
"manager":"7698",
"hire_date":"02/20/1981",
"salary":"1600",
"deptNo":"30"
},
{
"empNo":"7521",
"eName":"WARD",
"designation":"SALESMAN",
"manager":"7698",
"hire_date":"02/22/1981",
"salary":"1250",
"deptNo":"30"
},
{
"empNo":"7522",
"eName":"DESMOND",
"designation":"SALESMAN",
"manager":"7698",
"hire_date":"02/23/1981",
"salary":"1250",
"deptNo":"30"
}
]