KB: Safeguard against unexpected errors/glitches during on-premise server upgrade
Created: May 07, 2024 | Updated: November 15, 2024
Altium On-Prem Enterprise Server
[Why] Safeguard against unexpected errors/glitches during on-premise server upgrade
[What] Backup the snapshot of the production server running currently, restore it onto a test server to make sure everything works as expected, invoke the installer on the production server for whatever version to be upgraded to, say, when you have been using Vault and want to upgrade to Concord Pro or Altium Enterprise Server.
[How] Run avbackup.exe first to backup/restore the current snapshot as detailed in https://www.altium.com/documentation/enterprise-server/backing-up-restoring, and download/run an installer of the version you need to upgrade to, upon which the current installed version is recognized automatically to carry on with the upgrade.
Solution Details
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.If you are upgrading to a different version (Vault or NEXUS to Enterprise Server) use your company dashboard to get the *.alf license files that you currently use for your server (CALs too) so that you will have them if needed. Then you can work with your account manager to get your Vault/NEXUS licenses converted to Enterprise Server (or whatever the next version is) licenses. This may take a day, but is not necessary if you are not upgrading to a differently named version.
Install the same version of your current managed content server software that is running on your production server onto a new "Test" server. Next, run a backup of your production server with avbackup.exe and restore it onto your test server and make sure everything looks good. Here's a link with more information:
https://www.altium.com/documentation/enterprise-server/backing-up-restoring
Note the backup also contains the configuration file LocalVault.ini which may come in handy in case any customized configuration need to be restored after the upgrade.
Install the software for whatever version you are upgrading to, on the test computer. You can download our current version from here:
https://www.altium.com/products/downloads
The installation will recognize the current installation and perform an upgrade. You should then delete all the license files (CALs too) and install the current license files after you've had them converted by your account manager if necessary (see above.). Here's a link to the installation, licensing & Management documentation for Concord Pro (notice there are lots of other documents in the left pane (above and below) that may be of interest):
https://www.altium.com/documentation/altium-designer/altium-concord-pro-installation-licensing-management
And here is the documentation for Altium Enterprise Server:
https://www.altium.com/documentation/enterprise-server/installing-licensing-managing
Check out the new installation on the test server and if everything went smoothly, it should be safe now to perform the upgrade on your production server but be sure to get a backup first if not already.
You may confront error such as: "ERROR Occurred in the secure channel support". This could be caused by an accidental overwrite to the customized configuration specified in the aforementioned LocalVault.ini file (for example, the port number, website domain property etc.). From the backup, replace the file, whose default path is C:\Program Files(x86)\Altium\Altium[ Concord Pro/NEXUS Server/Vault/365]\LocalVault.ini
In another scenario, SVN repository support may be disabled in the configuration inadvertently after the upgrade, as only GIT is supported by default. In the same LocalVault.ini, change the line from
SvnMode=Noneto
SvnMode=FullTo get the modified .ini file re-read by the system, use IISreset /Restart from an elevated command prompt. If that doesn't work, a restart of the server will be required. Also dis/re-connect your client to the server.
After updating you may experience some of these issues: The "500 Internal Server Error" error message. Component cannot be released. Health monitor may show index errors. Re-indexing likely will resolve these issues. This article tells you how:
https://www.altium.com/documentation/knowledge-base/altium-concord-pro/resolve-issues-induced-after-on-premise-server-update-and-data-migration
Please note, You should be using the Altium Designer client with Concord Pro and later versions. If you were using the NEXUS client, you will need to download and install Altium Designer which you can do from here:
https://www.altium.com/products/downloads
Altium Vault, NEXUS, and Concord Pro have been discontinued and are therefore no longer being developed. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer (with appropriate Altium Designer Software Subscription) and a connected Altium 365 Workspace. Check out the FAQs page for more information. If you are interested in our current On-Site Workspace (Altium On-Prem Enterprise Server), please contact your account manager.