Search K
Appearance
Appearance
Performs a file or folder management operation in Autodesk Vault, including rename, copy, delete, and move actions.
Use this task when a workflow needs to reorganise content within Vault without going through the Vault client manually. Common scenarios include renaming a file after a lifecycle transition, moving a completed drawing to an archive folder, copying a template file to a new project location, or clearing out a staging folder after processing. The operation type is selected at design time, and the task exposes only the fields relevant to that operation.
| Field | Type | Required | Description |
|---|---|---|---|
| Operation Type | Dropdown | Yes | The operation to perform: Rename File, Copy File, Delete File, Move File, Rename Folder, Copy Folder, Delete Folder, or Move Folder Contents. |
| File Identifier | Text | Yes | The file to operate on. Accepts a Vault path ($/path/to/file.ext), numeric file ID, or file name. |
| Folder Identifier | Text | Yes | The folder to operate on. Accepts a Vault path ($/path/to/folder) or numeric folder ID. |
| New Name | Text | Yes | The new name for the file or folder. For files, include the extension. For folders, provide only the folder name. |
| Destination Folder Identifier | Text | No | Destination folder ID or Vault path. Use this or Destination Folder Path, not both. |
| Destination Folder Path | Text | No | Destination folder as a full Vault path. The folder is created if it does not already exist. Use this or Destination Folder Identifier, not both. |
| Include Subfolders | Checkbox | No | When enabled, recursively copies all subfolders and their contents. When disabled, only files in the root folder are copied. |
File Identifier is only shown when Operation Type is set to Rename File, Copy File, Delete File, or Move File.
Folder Identifier is only shown when Operation Type is set to Rename Folder, Copy Folder, Delete Folder, or Move Folder Contents.
New Name is only shown when Operation Type is set to Rename File or Rename Folder.
Destination Folder Identifier is only shown when Operation Type is set to Copy File, Move File, Copy Folder, or Move Folder Contents.
Destination Folder Path is only shown when Operation Type is set to Copy File, Move File, Copy Folder, or Move Folder Contents.
Include Subfolders is only shown when Operation Type is set to Copy Folder.
| Operation | What it does |
|---|---|
| Rename File | Renames a single Vault file in place using a checkout/checkin process. |
| Copy File | Downloads the file and uploads a copy to the destination folder. |
| Delete File | Permanently removes the file from its Vault folder. |
| Move File | Moves the file to a different Vault folder. |
| Rename Folder | Renames a Vault folder without moving its contents. |
| Copy Folder | Creates a copy of the folder and its files in the destination; optionally includes all subfolders. |
| Delete Folder | Deletes an empty Vault folder. Fails if the folder contains files or subfolders. |
| Move Folder Contents | Moves all files from the source folder into the destination folder, leaving the source folder empty. |
| Name | Description |
|---|---|
| VaultFile | The resulting Vault file object after the operation. Populated by Rename File, Copy File, and Move File. |
| DestinationFolder | The destination folder object. Populated by Move File and Move Folder Contents. |
| VaultFolder | The resulting Vault folder object. Populated by Rename Folder and Copy Folder. |
| SourceFolder | The source folder object used during Move Folder Contents. |
| FilesMovedCount | Number of files successfully moved. Populated by Move Folder Contents. |
| FilesFailedCount | Number of files that could not be moved. Populated by Move Folder Contents. |
| DeletedFileName | Name of the file that was deleted. Populated by Delete File. |
| DeletedFileMasterId | Master ID of the deleted file. Populated by Delete File. |
| DeletedFolderName | Name of the folder that was deleted. Populated by Delete Folder. |
| DeletedFolderId | ID of the folder that was deleted. Populated by Delete Folder. |