Description:
This step downloads the DMS document.
Inputs
- documentID - variable or global that holds the Document ID
- docRevisionType - Document revision (Current Revision, Approved Revision)
- downloadFilePath - variable or global to store the file download path
- folderName - Folder name to download from
- fileName - File name to download
Returns
- True – step executed successfully
- False - step failed to execute
Usage:

Example:
Let’s build and execute the “DMSDownloadDocumentDef” example:
- Create a new process definition named “DMSDownloadDocumentDef” and open it in designer mode.
- Drag a “updateVariables, DMSDownloadDocument” step to the canvas.
- Connect the dots between the “Start” and other steps, as shown above.
- Define a variable or global to hold the “Document ID”.
- On the DMS page, navigate to and select the document shown in this example. Click the ellipsis button for context features. Select the “Get URL” menu.

- A pop-up window displays the document link. Copy the “docID” value to the clipboard.

- Click the ellipsis button to access context features. Select the “View Revisions” menu. The page displays the document revision information as shown in the example below.

- Click the ellipsis button to access context features. Select the “Details” menu. The page displays the document details as shown in the example below. As observed, the approved version is 1.1

- Click the "updateVariables" step to configure its "Required" properties. Provide a name for the step. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description.

- Click the "updateVariables" step to configure its "Optional" properties. Provide a variable reference to hold the “Document ID” value. Copy-paste the value from the clipboard. Click the Save button.

- Click the "DMSDownloadDocument" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference that contains the “Document ID” value. Select the document revision (Current Revision or Approved Revision) from the drop-down list. Provide the variable or global reference to store the downloaded document file path. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description.

- Click the "DMSDownloadDocument" step to configure its "Optional" properties. Provide the folder name from the DMS to download. Provide the file name to download. 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 execute it. Render the process instance to confirm that the status is “completed”.

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.