Home Search

DriveWorks Pro 22
PDMPro: Check Out Folder Content

Send Feedback

PDMPro: Check Out Folder Content

This Specification Flow Task will check out a folders content from the vault.

Note: Before checking out a folders contents, review the PDM plugin settings, specify a path for the vault and the user that the folder will be checked out with. Without these specifications, the task will fail to run.


Property NameDescription
Source Folder PathPath to the folder whose contents are to be checked out (must be inside the vault).
Include SubfoldersTRUE to check out files in all subfolders, FALSE to only check out files in this folder.
Constant NameThe name of the Constant into which the result should be driven (Optional).


When this task is added, the properties are static by default.

See How To: Change A Static Property To A Dynamic Property to enable rules to be built on these properties.

Property NameExample RuleExample ResultMeaning
Source Folder Path"C:\DriveWorks\MyVault\" & DWSpecificationC:\DriveWorks\MyVault\MyProject 0001The contents of this folder will be checked out of the vault
Constant NameDWConstantCheckOutResultDWConstantCheckOutResultWhen the task is run, the result of whether the folders contents were successfully checked out or not will be written to this Constant.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:


  • Folder was checked out with all files.

Success with Warnings

  • Constant of the name <Name> does not exist.
  • Folder was checked out but not all files were.

Failed (one of the following occurred)

  • Couldn’t connect to the vault.
  • Folder not in vault.
  • Folder not found.
  • Couldn’t check out.
  • General failure - Check the specification report for more details.