DMS Archive Folder Step

Use this step to archive a DMS folder.

Last published at: December 27th, 2025

Description:

This step archives a DMS folder. 

 

Inputs

  • DMSFolderID - Uses the selected folder ID 
 

 

Returns

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

 

 

Usage:

 

 

Example:

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

  • Create a new process definition called “DMSArchiveFolderDef” and open the definition in designer mode. 
  • Drag an “DMSArchiveFolder” step to the canvas.
  • Connect the dots between the “Start” and the “DMSArchiveFolder" step, as shown above. 
  • Define a variable or a global to hold the DMS Folder ID. 
  • Click the "DMSArchiveFolder" step to configure its "Required" properties. Provide a name for the step. Click the button to select the DMS folder from the drop-down 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 folder or provide a variable or global reference that contains the DMS folder ID. Click to expand or collapse the DMS folders. Select the folder and click the Save button. 

 

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

 

  • On the DMS page, select the folder, then click View > Archive.  

 

  • The list of archived folders is displayed in the table below. You can use the Search textbox to filter the results. 

 

  • Select the item from the table and click the Actions menu to navigate to “Restore, Destroy, and Empty” features. 

 

  • Restore an Archive. Select the folder in the table, then click Actions > Restore. 

 

  • A confirmation pop-up window appears. Click the OK button. 

 

  • The archived folder is “undone” and removed from the DMS Archive folder. A confirmation message is displayed in the top-right corner.  

 

  • Destroy an Archive. Select the folder in the table, then click Actions > Destroy. 

 

  • A pop-up is displayed for confirmation. Click the OK button. The archived folder is “removed permanently,” and a confirmation message is displayed in the top-right corner.  

 

  • Empty an Archive. Select Actions > Empty menu option to remove all archived folders.

 

  • Type “REMOVE” in the text box and click the “Empty Archive” button to start. All archived folders and their contents are removed, and a confirmation message appears in the top-right corner. 

 

 

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.