Installing, Licensing & Managing Altium On-Prem Enterprise Server

Created: August 10, 2022 | Updated: September 1, 2022
All Contents

Parent page: Altium On-Prem Enterprise Server

Installation of any software application should be straightforward, intuitive and, perhaps above all, fast. Furthermore, when you have that software installed you want to be able to update it as and when you deem necessary, and in a streamlined fashion.

The Altium On-Prem Enterprise Server is installed through use of an efficient, intuitive installer – an installer that not only expedites the initial installation process, but lets you update with ease to a later version, at any time in the future. In addition, tools are available to monitor the health of your server and to back-up and restore your valuable design data.

For information on how to access your Enterprise Server Workspace from within Altium Designer and working with it from a design perspective, see Accessing Your Workspace from within Altium Designer, and Designing with a Connected Workspace, respectively.

Initial Install

Related page: Installing the Altium On-Prem Enterprise Server

Installation of the Altium On-Prem Enterprise Server is performed using the Altium On-Prem Enterprise Server Setup wizard. This is accessed by running an executable – Altium On-Prem Enterprise Server <VersionNumber>.exe . This executable is downloaded from the Downloads page of the Altium site and can be saved anywhere on your hard disk. Note that the installer is only made available provided you have Altium Designer Enterprise Subscription.

  • Some users have experienced issues with the installation of Microsoft .NET Core apps when running the installer.
    ► See the Install on a New Operating System section in the Possible Installation Issues page for a workaround install and optional repair information.
  • Due to the observed unpredictable behavior of antivirus software, it is recommended to disable such software during the installation of the Altium On-Prem Enterprise Server.
Each version of the Altium On-Prem Enterprise Server has its own dedicated installer.

Streamlined installation, courtesy of the Altium On-Prem Enterprise Server Setup wizard.
Streamlined installation, courtesy of the Altium On-Prem Enterprise Server Setup wizard.

Licensing the Altium On-Prem Enterprise Server

Related page: Altium On-Prem Enterprise Server Licensing

Licensing for the Altium On-Prem Enterprise Server 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 On-Prem Enterprise Server installation available to the organization.
  • Client Access License – this license enables users within an organization to access and sign-in to that organization's Altium On-Prem Enterprise Server.

Licensing for the Altium On-Prem Enterprise Server can be handled through the cloud, or locally through license files (*.alf).

A single licensing pair is available, irrespective of whether you are using an Altium On-Prem Enterprise Server with the standard Firebird database or your own Oracle database – Altium Enterprise Server and Altium Enterprise Server CAL.

Getting your Altium On-Prem Enterprise Server licensed is a breeze, thanks to self-serve licensing from those licenses available to you through your account.
Getting your Altium On-Prem Enterprise Server licensed is a breeze, thanks to self-serve licensing from those licenses available to you through your account.

Both Server and Client Access Licenses are timed licenses. Subscription must be renewed in order to provide continued access to the Altium On-Prem Enterprise Server for the users in an organization, as well as to access new features and functionality developed by Altium as part of the Altium On-Prem Enterprise Server. If this subscription renewal lapses, a single Server and CAL license will be provided to access your data for backup and configuration purposes.

Updating to a Later Version

When you want to upgrade to a later version of the Altium On-Prem Enterprise Server, the Altium On-Prem Enterprise Server Setup Wizard can handle this automatically for you. Run the installer for the later version. The older version will be detected and you will be asked if you wish to upgrade to the later version – click Yes. As part of the installation process the Installer will make a backup of the current server data, using the Backup & Restore tool. The default backup folder is \ProgramData\Altium\Altium365Data, but can be changed as required. The backup data is stored in a file with the format _Altium365<Version>_backup.zip.

  • While the Altium On-Prem Enterprise Server installer includes automated backup of your existing installation, it is always a good idea to make a pre-update backup of your data yourself – taking a redundancy copy off to one side as it were. This provides additional safety, should any unforeseen technical difficulties arise (see Backing up and Restoring Your Installation). It is advised to test out a new release of the Altium On-Prem Enterprise Server on a different machine, before updating your production instance. Use of Virtual Machines can be invaluable in this respect.
  • In addition, please ensure that you refresh your Altium On-Prem Enterprise Server licensing. From the Admin – Licenses page of the Enterprise Server's browser interface, delete the existing licenses (Altium Enterprise Server and Altium Enterprise Server CAL) and then add fresh instances back in. This will ensure you have the latest licensing, incorporating any licensing-related feature changes.
  • Before updating an Altium On-Prem Enterprise Server installation, it is also recommended to switch the server's Private License Service mode back to the default No PLS setting.

When updating to a later version of the server, a backup of your data will be made, before the old server is removed, and the new one installed.
When updating to a later version of the server, a backup of your data will be made, before the old server is removed, and the new one installed.

Switching over from your existing Altium Vault, to the Altium On-Prem Enterprise Server is a case of upgrading, by running the Altium On-Prem Enterprise Server installer – just as you would have updated your Vault in the past. The existing Altium Vault will be detected, and you will be asked if you wish to upgrade to the Altium On-Prem Enterprise Server – click Yes. As part of the installation process, the Installer will make a backup of the existing vault data, using the Backup & Restore tool. The default backup folder is \ProgramData\Altium\VaultServerData, but can be changed as required. The backup data is stored in a file with the format _VaultServer<Version>_backup.zip.

Upgrading to Altium On-Prem Enterprise Server requires that the existing Firebird database PAGE_SIZE be 16kb. Depending on the version of Altium Vault you currently have installed, this may well be 4kb. The installer will handle this page size update automatically for you, where needed.

When moving to the Altium On-Prem Enterprise Server from Altium Concord Pro or Altium NEXUS Server, the existing server installation can be upgraded to an Altium On-Prem Enterprise Server directly using its standard installer.

When the Altium On-Prem Enterprise Server installer is run, it will detect the existing installation and ask if you wish to upgrade to the Enterprise Server. After confirmation, it will backup the existing server data to the default location (unless you specify otherwise), and then re-apply that dataset to the new Enterprise Server installation. Thanks to this automated process, your previous design data, user profiles, and server settings are all transferred to the new Enterprise Server installation.

  • The Enterprise Server installation will adopt the locations and paths from the previous server installation.
  • You will need to update/refresh the Enterprise Server’s licenses.

Uninstalling

Uninstalling the Altium On-Prem Enterprise Server is performed from the standard Programs and Features page (accessed from the Control panel in Windows). Right-click on the entry for the Altium On-Prem Enterprise Server <VersionNumber> and use the Uninstall command from the context menu. A couple of dialogs will appear, in turn, asking:

  1. If you want to completely remove the server – click Yes.
  2. If you want to delete all your data – click Yes.
  3. You will be asked to confirm this a second time – click Yes.

A final confirmation dialog will appear once the uninstall is complete.

For the 'cleanest uninstall' it is a good idea to also uninstall the installation of your Firebird database software.
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: