Checking out a file changes the read-only attribute of the local copy to read/write. Once a file is checked out, it can be
edited. Only one member of a team can check out a file at one time. No one else can modify a checked out file until it has
been checked back into the vault. Refer to the User Name column to determine who has a certain file checked out. You can check
out one file, multiple files, or all files in a folder depending on the options you select in the Check Out dialog box.
Understand Get Revision and Check Out Files
The Get Revision and Check Out commands retrieve writable files from the vault and place them in your working folder, so that
you can modify them. Only one user can have a file checked out for editing at one time. If a user needs to get the latest
version of a file that has been checked out, use the Refresh command.
There is an important difference between the Get Revision and Check Out commands. The Get Revision command allows you to check
out a specific revision of a file and copy it to your local folder. The Check Out command gets only the leading version of
the leading revision of a file. See Understanding Revisions for more information.
NoteIf you are using Autodesk Vault Basic, the most recent version of the file is retrieved.
To return the file to the vault, you can use the Check In command to confirm your changes and copy your local, modified file into the vault. You can also use the Undo Check Out command. Undo Check Out does not update the vault. All the changes made to the local copy since you last checked out the
file are lost.
Roles with Permissions for this Feature
Roles with permission for this feature.
| Role |
Access |
| Administrator |
X |
| Change Order Editor |
|
| Content Center Administrator |
X |
| Content Center Editor |
|
| Document Consumer |
X |
| Document Editor (Level 1) |
X |
| Document Editor (Level 2) |
X |
| Document Manager (Level 1) |
|
| Document Manager (Level 2) |
|
| ERP Manager |
X |
| Item Editor (Level 1) |
X |
| Item Editor (Level 2) |
X |
| Item Reviewer |
X |
Get/Checkout Files Workflows
The Get/Check Out dialog has different options based on the edition of Autodesk Vault. Additionally, certain add-ins have
different work flows than the stand-alone client. The different work flows for checking files out of a vault are listed in
this section.
Vault Client–Get/Checkout
Note You must set your working folder before checking out a file. See Set a Working Folder for more information.
Learn About the Get/Checkout DialogSelect Revision
NoteThis drop-down only appears for the Autodesk Vault Workgroup, Collaboration, and Professional editions.
Select the revision that you want to retrieve from the drop-down. If you choose the Latest, then the latest version of the
leading revision is retrieved.
View Settings
Click one of the view icons to control how files in the vault are displayed.
View the contents of the vault in a tree structure.
View the contents of the vault in a flat list.
View the contents of the vault as they relate to a design.
Include Parents or Dependents
- Click the parent icon
to include the parent files of the selected file(s).
- Click the dependents icon
to include children files of the selected file(s).
Get/Checkout Settings
Click the Settings icon 
to launch the Settings dialog and configure the Get/Checkout Settings.
- Include Children–Applies the vault operation to all files on which the selected file depends.
- Include Parents–Applies the vault operation to all files that depend on the selected file.
- Direct Parents Only–Applies the vault operation to only the files that depend on the selected file within one level. Include Parents must be selected
for this option to be available.
- Create DWF Attachment–Creates and attaches a .dwf file to the design file being checked in.
NoteThe paper clip icon is not displayed for automatically published .dwf files.
- Apply to All Files–The .dwf attachments are only created for files that have changed or for files that do not have .dwf files published already.
This option must be turned on to create .dwf files for children. This option is on by default.
Comments
- Click the Comments icon to add a note about the checkout event.
Get/Check Out Files with the Vault Client (Basic Only)
Perform these steps to get/checkout files in Vault Basic only.
- In Autodesk Vault, select the files you want to get from the vault.
- Click Actions > Get/Check Out.
- In the Get/Check Out dialog box, specify whether or not you want to get the latest version of the file. This option is on
by default.
- If the file has parents and dependents to check out, click the parent > or child > icon to specify which related files will
be checked out as well.
- Click >> to display more options.
- Clear the Download files check box to check out files without downloading them to the local folder.
- Change the download path in the text box at the bottom of the screen.
- Click the Comments > icon and enter any comments for this checkout.
- Click OK.
The selected files are copied from the vault to your local folder if Download files is enabled. You can now edit the files.
Get/Checkout Files with the Vault Client (Workgroup, Collaboration, and Professional)
Follow these steps to get/checkout files in Vault Workgroup, Collaboration, and Professional editions.
- In Autodesk Vault, select the files you want to get from the vault.
- Select Actions ► Get/Check Out.
- In the Get/Check Out dialog box, specify which revision of the file you want to retrieve from the vault. The Select Revision
setting automatically defaults to the latest.
- Click the released bias icon ► to retrieve file versions that have been released.
- If the file has parents and dependents to check out, click the parent ►or child ►icon to specify which related files will
be checked out as well.
- Click >> to display more options.
- Clear the Download files check box to check out files without downloading them to the local folder.
- Change the download path in the text box at the bottom of the screen.
- Click the Comments ►icon and enter any comments for this checkout.
- Click OK.
The selected files are copied from the vault to your local folder if Download files is enabled. You can now edit the files.
You can also right-click on a folder in the vault, and then select Check Out Entire Folder to check out a vault folder and
all of its contents.
Get/Checkout Multiple Files in a Folder using the Vault Client (All Editions)
Follow these steps to check out multiple files located in a single folder.
- In the Autodesk Vault client, select the folder with the files that you want to check out.
- Select Actions ► Get/Check Out.
- On the Get/Check Out dialog, right-click in the tree-view and select Check All from the context menu.
Note: When you check out multiple files, only the latest version or revision is retrieved.
- If the file has parents and dependents to check out, click the parent ► or child ► icon to specify which related files will
be checked out as well.
- Click >> to display more options.
- Clear the Download files check box to check out files without downloading them to the local folder.
- Change the download path in the text box at the bottom of the screen.
- Click the Comments ► icon and enter any comments for this checkout.
- Click OK.
The folder contents are copied to the working folder.
Get/Checkout Multiple Files in a Folder using the Vault Client (Workgroup, Collaboration, and Professional)
Perform these steps to get/checkout multiple files located in the same folder. This features is available only in Vault Workgroup,
Collaboration, and Professional editions.
- In the Autodesk Vault client, select the folder with the files that you want to check out.
- Select the Get/Check Out command from the context menu or the Actions menu.
- From the Get/Check Out dialog, click on the Settings button to view the related data to be included in the download and check
out.
- Select the Include Links combo box and choose what related data you want to download and check out.
The image represents the Include links dialog for Vault Professional. Links to Files and Folders will be the only options
for Vault Workgroup and Vault Collaboration.
- If the selected files have parents and dependents to download and check out, click the Include Parents ►or Include Children
► button to specify which related files will be included.
Note: When you check out multiple files, only the latest version or revision is retrieved.
- Click >> to display more options.
- Clear the Download files check box to check out files without downloading them to the local folder.
- Change the download path in the text box at the bottom of the screen.
- Click the Comments ► icon and enter any comments for this checkout.
- Click OK.
AutoCAD Vault Add-in–Get/Checkout a File
The following options are available when checking out a file with the AutoCAD Vault Add-in:
- Get Revision allows the user to specify which revision is retrieved from the server.
NoteThis feature applies to Autodesk Vault Workgroup, Collaboration, and Professional editions.
- Check-out, also known as a Quick Check-Out, allows the user to check out the latest version of the latest revision of files or files
that have been edited out of turn. Files that do not meet these requirements are not displayed as options for checkout with
this command.
You also have the options to apply the vault operation to any children of the file.
The following vaulting options are available when a file is checked out:
- Check In checks your updated file into the vault, storing your changes to Vault Folder.
- Undo Check Out cancels changes both in Vault and in your local Folder. The file or folder can return to the way it was before you checked
it out if you select the Replace Local Copy option.
Perform a Quick Checkout
- Select the file that you want to check out by performing one of these options:
- In the Vault ribbon, click Check Out.
- At the command prompt, type vltcheckout, and then press Enter.
Get a Particular Revision of a File
NoteThis feature applies to Autodesk Vault Workgroup, Collaboration, and Professional editions.
- Select the file that you want to check out by performing one of these options:
- In the Vault ribbon, click Get Revision.
- In the External References palette, right-click one or more files, and then select Get Revision.
The Get/Check Out Files dialog box is displayed.
- Select the revision that you want to check out from the Select Revision list.
- If you want to give related files with a released status priority, click Released Biased for Related Files.
- Select the check box for the files that you want to check out.
- If you want to check out children of the selected files, click the Include Dependants icon.
- Click OK to check out the files. The vault places the files in your local folder. You can now edit the files.
Inventor Vault Add-in– Get/Checkout Files
The following options are available when checking out a file with the Inventor Vault Add-in:
- Get Revision allows the user to specify which revision is retrieved from the server.
NoteThis feature applies to Autodesk Vault Workgroup, Collaboration, and Professional editions.
- Check-out, also known as a Quick Check-Out, allows the user to check out the latest version of the latest revision of files or files
that have been edited out of turn. Files that do not meet these requirements are not displayed as options for checkout with
this command.
You also have the options to apply the vault operation to any children, or parents of the file.
The following vaulting options are available when a file is checked out:
- Check In checks your updated file into the vault, storing your changes to Vault Folder.
- Undo Check Out cancels changes both in Vault and in your local Folder. The file or folder can return to the way it was before you checked
it out if you select the Replace Local Copy option.
To Perform a Quick Checkout
- In the Vault browser, select the file that you want to check out. You can also select multiple files by pressing the Control
or Shift keys.
- Right-click the selection, and then select Check Out or select Check Out from the Autodesk Vault ribbon. The Check Out dialog box is displayed.
- If you want to check in parents or children of the selected files, click Settings. Enter a comment in the Comment box describing
why you want to check out the file, if appropriate.
- Click OK to check out the files. the vault places the files in your local folder. You can now edit the files.
To Get a Particular Revision of a File
NoteThis feature applies to Autodesk Vault Workgroup, Collaboration, and Professional editions.
- In the Vault browser, select the file that you want to check out.
- Right-click the selection, and then select Get Revision or select Get Revision from the Autodesk Vault ribbon. The Get/Check Out Files dialog box is displayed.
- Select the revision that you want to check out from the Select Revision list.
- If you want to give related files with a released status priority, select the Released Biased for Related Files check box.
- If you want to check out children of the selected files, click Settings. Enter a comment in the Comment box describing why
you want to check out the file, if appropriate.
- Click OK to check out the files. The vault places the files in your local folder. You can now edit the files.
Vault Office–Get/Checkout Files
NoteThe check out command is only available if the selected file is the latest version or if the file has been edited out of turn.
To check out the specific revision of a file, use the Get Revision command.
You can check out one file, multiple files, or all files in a folder depending on the options you select in the Check Out
dialog box.
NoteUse the Autodesk Vault client to see who has a file checked out. This information can be obtained from the User Name column.
Other Add-ins–Get/Checkout a File
Checking out a file copies the file version or revision in the vault to your local working folder. Once a file is checked
out, it can be edited. Only one member of a team can check out a file at one time. No one else can modify a checked out file
until it has been checked back into the vault.
Launch the Autodesk Vault client application to see who has a file checked out. The person to whom a file is checked out will be listed in the User
Name column.
You can check out one file, multiple files, or all files in a folder depending on the options you select in the Check Out
dialog box.
The following options are available when checking out a file in Vault Workgroup, Vault Collaboration, and Vault Professional:
- Get Revision allows the user to specify which revision is retrieved from the server.
- Check Out, also known as a Quick Check-Out, allows the user to check out the latest version of the latest revision of files or files
that have been edited out of turn. Files that do not meet these requirements are not displayed as options for checkout with
this command.
All Vault editions have the option of checking out any children of the file as well.
Once you are finished editing a file, you can check the file back into the vault to store your changes or Undo Checkout to
cancel any changes and return the file to the Vault as the version it was before you checked it out.
Check a File out of a Vault
- Click Check Out on the Autodesk Vault ribbon.
The Get/Checkout File dialog is displayed.
- Navigate to the file that you want to check out and select it.
- If you want to check out children of the selected files, click the Include Dependants icon.
- Click OK to check out the files. The vault places the files in your local folder. You can now edit the files.
Get a Revision from a Vault
This feature is available in Vault Workgroup, Vault Collaboration, and Vault Professional.
- Click Get Revision on the Autodesk Vault ribbon.
The Get/Checkout File dialog is displayed.
- Select the revision of the file that you want to check out from the Select Revision list. If you want to give related files
with a released status priority, click Released Biased for Related Files
.
- Select the check box for the files that you want to check out.
- If you want to check out children of the selected files, click the Include Dependants icon.
- Click OK to check out the files. The vault places the files in your local folder. You can now edit the files.
