DMS Get Documents Step

Use this feature to get a list of documents from a DMS folder.

Last published at: December 25th, 2025

Description:

This step gets a list of documents from a DMS folder. 

 

Inputs

  • DMSFolderID - Select parent folder
  • documentList - variable or global to store the document list
 

 

Returns

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

 

 

Usage:

 

 

Example:

Let’s build and execute the “DMSGetDocumentsDef” example:

  • Create a new process definition named “DMSGetDocumentsDef” and open it in designer mode. 
  • Drag a “DMSGetDocuments” step to the canvas.
  • Connect the dots between the “Start” and the “DMSGetDocuments” step, as shown above. 
  • Define a variable or a global to store the document list. 
  • On the DMS page, navigate to and select the folder to view the available documents. As seen in this example, the “Dot Net Related” folder contains four documents.  

 

  • Click the "DMSGetDocuments" step to configure its "Required" properties. Provide a name for the step. Click the button to select the DMS parent folder from the drop-down list. Provide the folder name belonging to the parent folder. Provide a variable or global reference to store the “Documents List”. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

 

  • Click the button to select the DMS folder from the drop-down list. A pop-up window is displayed for configuration. Alternatively, you can use the filter to select the Parent folder or provide a variable or global reference that contains the DMS folder ID. Click to expand or collapse the DMS folders. Select the Parent folder and click the Save button.  You need to provide one of the folder names that belongs to the parent folder.  

 

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

 

  • Save the process definition, create a new instance, and then execute it. Render the process instance to note that the status is completed. Select the Items - Latest variables menu. As observed, the process step gets the list of documents from a DMS folder, and stores it in a variable or global reference. 

 

 

 

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 any missing configuration steps after import, such as file path references and database connections. Then, save the definition to confirm the changes. 

Click here to download the sample file.