Parent page: Altium Vault
While installation and use of Altium Vault Technology - in the form of an Altium Vault and its related services - is detailed across other pages within the altium.com/documentation site, the aim of this page is to provide a single, detailed resource for an organization's IT department. A place to come for answers to typically asked questions regarding this technology, including:
- What are the hardware requirements to install the Altium Vault?
- What is installed?
- What programs and processes are running?
- Where is the data stored?
- What ports are used?
- What protocol is used for communications?
- How is data backed-up?
The following sections provide detailed answers to these and other questions, including a high-level overview of the architecture and data flows.
The Altium Vault can be installed on a PC running one of the following Operating Systems:
- Windows 10 (32-bit or 64-bit)
- Windows 8.1 (32-bit or 64-bit)
- Windows 8 (32-bit or 64-bit)
- Windows 7 (32-bit or 64-bit)
- Windows Server 2016 Standard Edition
- Windows Server 2008/2012 R2 (32-bit or 64-bit, where applicable)
The following are the recommended system requirements to install and run an Altium Vault. Note that these recommendations are for 10 to 30 concurrent users.
- OS: Windows Server 2012 R2
- RAM: 8GB+
- Processor: Intel® Xeon® processor or equivalent (4 or more cores)
- Disk space: 20GB (in case NIS will not be used); 200GB (in case NIS will be used)
- Database: Firebird
The following are the minimum system requirements to install and run an Altium Vault. Note that these recommendations are for 10 to 30 concurrent users.
- OS: Windows 7
- RAM: 6GB+
- Processor: Intel Core i3/i5 processor or equivalent (2 or more cores)
- Disk space: 20GB (in case NIS will not be used); 200GB (in case NIS will be used)
- Database: Firebird
Altium Designer Requirements
Installation & Other Software
Due to the observed unpredictable behavior of antivirus software, it is recommended to disable such software during the installation of the Altium Vault.
If the computer is also running Microsoft Exchange Server, you might receive an HTTP Error 503 error when you first attempt to log in. The installation of the Exchange Server can change the Internet Information Services (IIS) configuration in a way that conflicts with the Vault. To resolve this, the following changes must be made to the
handlers accessPolicy="Read, Script">
<add name="kerbauth" image="C:\Program Files\Microsoft\Exchange Server\V15\Bin\kerbauth.dll" preCondition="bitness64" />
<add name="WSMan" image="C:\Windows\system32\wsmsvc.dll" preCondition="bitness64" />
<add name="exppw" image="C:\Program Files\Microsoft\Exchange Server\V15\ClientAccess\Owa\auth\exppw.dll" preCondition="bitness64" />
<add name="cafe_exppw" image="C:\Program Files\Microsoft\Exchange Server\V15\FrontEnd\HttpProxy\bin\exppw.dll" preCondition="bitness64" />
Additional Software Installed or Configured
- Internet Information Services (IIS). For correct operation, the Altium Vault requires, at minimum, version 7.5 (IIS 7.5) to be installed. Installation of the Altium Vault will simply install the version of IIS native to your operating system:
- IIS 10.0 - Windows 10 and Windows Server 2016 Standard Edition
- IIS 8.5 - Windows 8.1 and Windows Server 2012 R2
- IIS 8.0 - Windows 8
- IIS 7.5 - Windows 7 and Windows Server 2008 R2
- Firebird 2.5 database engine (where the option to install using a Firebird database is chosen)
- .NET Framework 4.0
As part of IIS configuration, the ISAPI Extensions feature is enabled. This feature can be found in the
\Internet Information Services\World Wide Web Services\Application Development Features section of the Windows Features dialog - accessed from Window's Programs and Features window.
Installation of the Altium Vault enables the Windows ISAPI Extensions feature, part of IIS configuration.
The following application pools are installed on the IIS server:
- Altium Vault
- Altium Vault - Applications Registry Service
- Altium Vault - Comments Service
- Altium Vault - Configurations Management
- Altium Vault - Data Acquisition Service
- Altium Vault - Data Storage Service
- Altium Vault - Discovery Service
- Altium Vault - Event Dispatching Service
- Altium Vault - Home
- Altium Vault - Identity Service
- Altium Vault - LicenseManager Service
- Altium Vault - LicenseManager UI
- Altium Vault - MCAD Collaboration Service
- Altium Vault - Network Installation Management
- Altium Vault - Network Installation Service
- Altium Vault - Notifications Service
- Altium Vault - NTLM Authentication
- Altium Vault - Part Catalog Management
- Altium Vault - Part Catalog Service
- Altium Vault - Part Catalog2 Service
- Altium Vault - Part Requests Management
- Altium Vault - Plm Sync Service
- Altium Vault - Projects Management
- Altium Vault - Projects Service
- Altium Vault - Reports Management
- Altium Vault - Search Service
- Altium Vault - Search Templates Service
- Altium Vault - Security Service
- Altium Vault - Settings Service
- Altium Vault - Simple Lock Service
- Altium Vault - Tasks Service
- Altium Vault - Team Configuration Service
- Altium Vault - User Management
- Altium Vault - Vault Explorer
- Altium Vault - Vault Service
- Altium Vault - VCS Management
- Altium Vault - WebSocket Service
Verification that the Altium Vault is running can be performed from the Windows Internet Information Services (IIS) Manager panel - accessed from Window's Administrative Tools window. Simply check to confirm each of these application pools are in the
Altium-related application pools running on the IIS server.
Altium Vault-related applications that are running as IIS ISAPI modules are:
Default Installation Paths
The following is a list of default installation paths when installing the Altium Vault:
- Altium Vault Installation Folder -
\Program Files (x86)\Altium\Altium Vault.
- Firebird Installation Folder -
\Program Files (x86)\Firebird\Firebird_2_5.
- Vault Application Folder -
\Program Files (x86)\Altium\Altium Vault\Vault.
- Firebird Database -
- Revision Files Folder -
- Search Index Data Folder -
The following default communication port numbers are used by the Altium Vault:
- HTTP Port - 9780
- HTTPS Port - 9785
- Synchronization Service Port - 9791
- LDAP Service Port - 9790
- Websocket Port - 4649
- Firebird Server Port - 3050
- SVN Port - 3690
The first four in the list can be configured during initial vault installation, on the Altium Vault Configuration page of the Installer.
When choosing a port, note that it must not clash with any ports used by other applications - if a port is currently in use, you will be notified by the installer.
HTTPS Protocol Support
For those that require an additional layer of security for exchanging data with the Altium Vault, the server provides for secure communication over networks using the HTTPS protocol to protect the privacy and integrity of the data.
The configuration and server bindings for the Altium Vault can be accessed from the Windows Internet Information Services (IIS) Manager panel - available from the Administration Tools window (
Control Panel\System and Security\Administrative Tools). Select the 'Altium Vault' entry in the panel's Connections list, and choose the Features View tab.
Access configuration and server binding settings for the Altium Vault.
The available ports and server names for the Altium Vault are shown as selectable links in the Actions pane. Use the links to note and test the vault connection protocols, or access the current name/port bindings by selecting the Bindings link in the Edit Site section of the pane.
A Binding, including its protocol port number, can be edited from the Site Bindings dialog via the Edit button.
Configure bindings through the Site Bindings dialog.
Note that the server name
localhost only applies to the local machine, so PCs other than the one that is hosting the Altium Vault need to use the actual (server) name of that host machine to connect.
To confirm the name of the host PC on which the Altium Vault is installed and running, on that machine go to
Control Panel\System and Security\System and note both the Computer name and Full computer name (its qualified domain name) - the latter will be that used by the Altium Vault for secure connections over the network (as also indicated in the Site Bindings dialog, above).
Checking the name of the PC on which the Altium Vault is running.
To establish a secure connection to the Altium Vault:
- From Altium Designer - simply use a HTTPS prefixed server address and the configured HTTPS port. By default, this is
https://localhost:9785 when using the PC that hosts the Vault, or
https://<computername>:9785 for a remote connection (where
[computername] is the host machine's Computer Name or qualified domain name).
- From a Web Browser - enter the address of the local service (
https://localhost:9785) or the host computer name equivalent (
Protocol used for Service-to-Service Communications
SOAP over HTTP.
Service Architecture – Overview
The Altium Vault installs a number of core services, as well as browser-based management consoles, and a Vault Explorer (also browser-based). In order to access any of these services, a user's identity must be recognized and authenticated. The Altium Vault comes with one predefined user (Username:
admin). The Users page of the vault's browser-based interface can be used to add and manage more users. There is no limit to the number of users that may be registered to access and use the vault, but there is a limit on simultaneous connections, as determined and enforced by required licensing.
Altium Designer uses an unencrypted channel (SOAP over HTTP) for communicating with the following services:
- Applications Registry Service (when the Network Installation Service is being used as a source for extensions/updates)
- Comments Service
- Data Acquisition Service
- Data Storage Service (DSS)
- Identity Service (IDS)
- Notifications Service
- Part Catalog Service
- Part Catalog2 Service
- Projects Service
- Simple Lock Service (SLS)
- SVN (through the SVN:// protocol)
- Team Configuration Service (TC2)
- Vault Service
All other services communicate with each other.
The majority of services require access to the same vault database, in which to store data applicable to them. The following are examples of the data stored by some of these services:
- Part Catalog Service/Part Catalog2 Service - stores supplier and manufacturer items, price and quantity history changes, etc...
- Identity Service - stores users, roles, licensing configuration, and session information.
- Vault Service - stores its structure (folders, items, revisions, content types, lifecycle states, etc...).
Actual documents are stored on the file system, in the Revisions folder (
The following browser-based applications use SOAP API to communicate to the applicable services - they do not require access to the vault database, nor are any other files required for them to function:
- User Management - the application behind the USERS page and sub-pages in the vault's browser interface.
- Vault Explorer - the application behind the VAULT page of the vault's browser interface.
- Catalog Management - the application behind the PART PROVIDERS page of the vault's browser interface.
- Projects Management - the application behind the PROJECTS page of the vault's browser interface.
- TC2 Console - the application behind the CONFIGURATIONS page of the vault's browser interface.
Related article: Altium Vault Licensing
Licensing for the Altium Vault essentially consists of the following two components, that together comprise a two-tiered licensing system:
- Server License - this license makes the features and services of the Altium Vault installation available to the organization.
- Client Access License - this license enables users within an organization to access, and sign-in to the organization's Altium Vault.
Licensing for the Altium Vault can be handled through the cloud, or locally through license files (*.alf). Acquisition of the latter is performed through the Altium Dashboard (accessed using the DASHBOARD control at the top of the Altium website). From the Licenses tab, locate the applicable license (in the Server Applications grouping of licenses) then click through to the detailed license management page. Once there, click the Activate button to generate and download the associated license file.
Backup/Restore of Vault Data
Backup and restoration of your vault data is performed from the command line, in automated fashion, using the dedicated Backup & Restore Tool. This tool - avbackup.exe - can be found in the folder
\Program Files (x86)\Altium\Altium Vault\Tools\BackupTool\ (for a default installation of the Altium Vault).
Manually Updating the Vault Installation
To manually upgrade an Altium Vault to a later version, first uninstall the existing version. This is performed from the standard Programs and Features page (accessed from the Control panel). Simply right-click on the entry for the
Altium Vault <VersionNumber> and use the Uninstall command from the context menu.
Once this is done, install the later version of Altium Vault software. Just remember to install with the same settings for vault data locations and the same communications port numbers.
Re-Indexing Vault Content after Data Migration
To re-index vault content, for example after data migration:
- Stop all IIS application pools associated to the Altium Vault.
- Delete the content of the
SearchData folder, which contains the search indexing data (
\ for a default install).
- Restart the IIS application pools.
On finding the
SearchData folder empty, the vault will re-index its content once it starts.
Local SVN Design Repository - Storage
A Design Repository that is created through the local Version Control Service has its internal data stored in a corresponding sub-folder in the \ProgramData\Altium\VaultServerData\Repository folder (for a default installation of the Altium Vault).
Internal data storage location for a Design Repository created through the Altium Vault installation's local SVN-based Version Control Service.
Using Oracle for the Vault Database
When installing the Altium Vault, the Oracle database type facilitates streamlined installation of the Altium Vault within organizations already utilizing this type of database as the back-end for their existing systems. Hosting the vault on their existing infrastructure, reduces installation and management complexity.
Getting the Altium Vault installed and running with Oracle as its back-end database is essentially a two-fold process:
- Setting up the Oracle database
- Setting up the Altium Vault.
Preparing the Altium Vault
To be installed and run successfully, the Altium Vault requires not only the OCI client, but also relevant .Net connectors. It is recommended to install the relevant 32-bit Oracle Data Access Components (ODAC) with Oracle Developer Tools for Visual Studio, in accordance with the version of Oracle you are running. For testing, the ODAC 11.2 Release 5 and Oracle Developer Tools for Visual Studio (18.104.22.168.20) download was installed on the dedicated machine used to accommodate the vault.