Get or Check Out a File with Other Vault Add-ins
Checking out a file with a Vault Add-in copies the file version or revision in the vault to your local working folder. Once a file is checked out, it can be edited.
You can check out one file, multiple files, or all files in a folder depending on the options you select in the Get/Check Out dialog box. All Vault editions have the option of checking out any children of the file as well.
If you have Autodesk vault-professional, you can also select a specific revision for download or checkout.
Get/Check Out (vault-basic)
Perform these steps to get/checkout files and folders in vault-basic.
Click Check Out on the Vault Ribbon.
The Get/Check Out dialog displays in collapsed or expanded view, depending on whether you have pinned
it in the expanded view. The collapsed view is default.Enable the Include Children button if you want dependent files also available for check out.
The Include Children settings can be changed by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Enable the Include Parents button if you want parent files also available for check out.
The Include Parents settings can be changed by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Enable the Check button if you want to quickly select all of the files from steps 2 through 4. If Source selection is enabled instead, then just the files and folders you originally selected for check out are selected.
You can configure whether this button gets all of the files or just the original selection set by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Optional. Leave a comment about the reason for the checkout by clicking the Comment button.
If you want to simply get the latest version of the selected files and folders, click OK.
If you want to see all of the files listed with the Include Children and Include Parents buttons enabled, or if you want to manually select files for checkout, click the Expand button
to see the complete list and make your selections.If you have selected only one file for check out and you want to specify the version of the file, click the Expand button
and select the version from the Version drop-down list.Click OK.
The selected files are copied from the vault to your local folder if Working Folders is selected. You can now edit the files.
Get/Check Out (vault-professional)
Perform these steps to get/checkout files in vault-professional.
Click Check Out on the Vault Ribbon.
The Get/Check Out dialog displays in collapsed or expanded view, depending on whether you have pinned
it in the expanded view. The collapsed view is default.Enable the Include Children button if you want dependent files also available for check out.
The Include Children settings can be changed by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Enable the Include Parents button if you want parent files also available for check out.
The Include Parents settings can be changed by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Enable the Check button if you want to quickly select all of the associated files for check out as well as the initial selection set. If Source selection is enabled instead, then just the files you originally selected for checkout are selected.
You can configure whether this button gets all of the files or just the original selection set by clicking the arrow beneath the button and making changes to the settings.
Tip: Hover your mouse over the icon at any time to see the current settings.Optional. Leave a comment about the reason for the check out by clicking the Comment button.
If you want to simply get the latest version of the leading revision of the selected files, folders, or custom objects, click OK.
If you want to see all of the related files with the Include Children, Include Parents, or Include Links buttons enabled, or if you want to manually select objects for checkout, click the Expand button
to see the complete list and make your selections.If you have selected only one file for checkout and you want to specify the revision of the file, click the Expand button
and select the revision from the Revision drop-down list.Enable the Use released for related files check box to get the released versions of all selected related files.
Click OK.
The selected files are copied from the vault to your local folder if Working Folders is selected. You can now edit the files.
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.