Add-in - AutoCAD

A vault is a repository where documents and files are stored and managed. Autodesk Vault is an engineering data management system that offers file security, version control, and multi-user support. Autodesk Vault integrates with AutoCAD and AutoCAD Mechanical software using an AutoCAD Vault ARX application.

Note: Vault commands are not supported in SDI (Single Document) mode. The SDI system variable must be set to '0' for vault commands to be supported.

Autodesk Vault is both a server and a client interface.

• The server provides the following:
  • Centralized file store: Autodesk Vault server stores the master copies of all your documents and designs and keeps the master copies of all user files in a common, secure, and centralized location. By storing all of your data in a common, centralized location, you can easily share and manage all of your information with your design team. The files are stored on the server in such a way that they can be easily retrieved using the server console. However, this file store can reside on a different drive or even on a completely different server from the vault database.
  • Relational database: Autodesk Vault server contains a database that stores data about the files, such as file names, user names, properties, versions, and relationships between files. The database is managed using the server console.
  • Access and information: The Autodesk Vault Server software provides users with access to their files and maintains information about the status of those files including which users have permission to change and update the files. When changes are made to files Autodesk Vault maintains a version history of all changes and provides a convenient mechanism for users to gain access to the latest versions as well as previous versions.
• The client consists of two components:
  • Autodesk Vault: Autodesk Vault is a stand-alone client providing full access to the vault. This is the user interface for managing all data within the vault.
  • AutoCAD Vault ARX: This is a tool that performs many of the same vault tasks as Autodesk Vault within AutoCAD and AutoCAD Mechanical.

Autodesk Vault basics

Autodesk Vault software is a client-server application. In a typical installation, you install the server portion of the software on a shared computer, and then install the client software (Autodesk Vault and AutoCAD Vault ARX) on individual workstations. During installation, you have the option to install each of the components required for each workstation and, when applicable, for each server.

The vault server stores and maintains the files and metadata that make up the vault. The server software can be installed on a server or workstation that is shared by all users or, for a single user, the server can be installed along with the client on a single, isolated workstation. The database is managed by the server console.

The vault client consists of Autodesk Vault and AutoCAD Vault ARX. The client is installed on all workstations that need to access the vault.

Key concepts

The essential rules to remember when working with AutoCAD Vault ARX are:

1. The files in the vault are the master files.
2. You must check a file out of the vault to modify it.
3. To check out a file for editing you must use the working folder on the local disk. Each user can optionally set a local working folder (physical location on disk) for the root of the vault or use the default working folder (My Documents\Vault).

AutoCAD Vault ARX for AutoCAD and AutoCAD Mechanical

AutoCAD Vault ARX is tightly integrated into AutoCAD and AutoCAD Mechanical. You can perform vault tasks using the AutoCAD Menus, command line, or the External References palette for files containing xrefs.

Check out and check in capabilities prevent more than one user from editing a file at one time, so all members of the design team to work together. In host files containing Xrefs, you can view the status of vaulted files displayed by icons and properties in the External References palette. The status icons in the External References palette keep all members of the design team informed of the status of files.

Note: Vault commands are not supported in SDI (Single Document) mode. The SDI system variable must be set to '0' for vault commands to be supported.

AutoCAD Vault ARX understands the relationship between a host file, and all files that it references so you can manage all files in a model within the External References palette.

AutoCAD Vault ARX for AutoCAD Electrical

AutoCAD Vault ARX is tightly integrated into AutoCAD Electrical. You can perform vault tasks using the AutoCAD Menus, command line, or Project Manager.

AutoCAD Vault ARX understands the relationship between a project file, and all files that it references so you can manage all files in a model within the Project Manager. The AutoCAD Electrical project file (*.wdp) lists all drawing files included in the project. The drawing file names are maintained with relative paths from the location of the project definition file. When you make a change in one drawing, all files related to that drawing are automatically updated as well. To maintain the relationship between the drawing files that are defined in the project file you must check out all files specified in a project file when you need to modify one or more files.

Check out and check in capabilities prevent more than one user from editing a file at one time, so all members of the design team work together. The Project vault commands do not require that the selected project is active; it only needs to be open in the current Project Manager.

Essential Vault Skills

Essential Vault skills are shared across many different add-ins as well as the Vault Client. Click on the link for the Command/Function in the list to go to that topic in the help.

Command/Function	Short Description
Go to vault	Launch the Autodesk Vault stand-alone client.
Log in to a vault	Log into the vault.
Log out of a vault	Log out of the vault.
Open from vault	Open a file stored in the Vault.
Attach from Vault	Attaches a file from the Vault to the open file.
Go to workspace	Launches the local working folder for Vault files.
Refresh file	Updates the selected file(s) with the properties in the vault.
Check in	Check file in for the first time or check a file back into the vault.
Check out	Checks a file out of the vault. Note: This command only performs a quick check out, so only the latest version of the latest revision is retrieved. To get a particular revision, click Get Revision on the Vault ribbon.
Undo checkout	Undoes a file checkout.
Vault Options	Launches the Vault Options dialog where you can configure your settings for the Vault add-in.
Update Properties	Updates file properties with the properties in the vault.
Change State	Changes the lifecycle state of the file to another valid state in the lifecycle.
Revise File	Changes the file's revision to the next appropriate increment in the revision scheme.
Manage Ownership	Grants ownership of the selected file to the current workgroup. Note: This command is available in Vault Collaboration and Vault Professional.
Change Category	Changes the category assigned to a file.