Offline Installation of Altium NEXUS

Now reading version 1.0. For the latest, read: Offline Installation of Altium NEXUS for version 5

Nexus message

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

 

The standard Altium NEXUS Installer requires an internet connection to complete the installation process. If it is not possible to run the installer from the target PC, then you can install Altium NEXUS using an Offline Installation package (commonly referred to as the Offline Installer).

Pre-Install Preparation

Contact your local Altium office or Value Added Reseller to organize your copy of the Offline Installation package. This is simply a zipped collection of the necessary installables (including extensions), along with the relevant Altium NEXUS Installer. The latter simply runs, as per the standard internet-based Installer, only getting the required files from elsewhere in the local unzipped content, rather than the Altium Cloud repository.

With the Offline Installer acquired, unzip to the required target PC on which you wish to install Altium NEXUS.

Each version of the software has its own dedicated installer, and therefore requires a dedicated offline installation package.

Running the Installer

Browse to the location on your hard disk into which you have unzipped the offline installation package, and double-click the AltiumNEXUSSetup.exe file. The Altium NEXUS Installer welcome page will appear.

Initial welcome page for the Altium NEXUS Installer.
Initial welcome page for the Altium NEXUS Installer.

The installer itself is wizard-based, providing a set of progressive (and intuitive) pages that collectively gather the information needed to install the software, with its initial feature set, as you require.

Click Next to continue. The following sections provide a summary of the various pages you will encounter.

License Agreement

This page of the Installer presents you with the Altium End-User License Agreement (EULA).

Read and accept Altium's End-User License Agreement.
Read and accept Altium's End-User License Agreement.

Before you can continue with the installation of the software, you must read through, and accept, the terms of this agreement. The agreement can be viewed in different languages, including English (the default), German, Chinese and Japanese.

Clicking the Advanced button will display the Advanced Settings pop-up window, where proxy-settings can be specified. These settings are only needed for the online installer, if applicable for that installation environment. They can simply be ignored as part of offline installation.

With the EULA read, continue with the install by checking the I accept the agreement box and clicking the Next button.

Installation Mode

If you have an existing installation of Altium NEXUS, and that installation can be updated to the new version you are trying to install now, then this additional page of the Altium NEXUS Installer wizard will be available.

Install a new instance of Altium NEXUS, or update an existing instance.
Install a new instance of Altium NEXUS, or update an existing instance.

This page gives you the choice between:

  • Installing a separate new instance of Altium NEXUS - use this option the first time you install Altium NEXUS with the Offline Installer.
  • Updating an existing installation of Altium NEXUS - use this option when you are updating your offline installation of Altium NEXUS. If you are updating an existing installation, you can select the product instance being updated.

Select the required installation mode, and click Next to continue.

Select Design Functionality

This next page of the Installer allows you to specify which features are installed initially. The PCB Design option provides the base software and core technologies required to perform PCB design. It is always installed and cannot be deselected. Use the remaining options to tailor the install to suit your needs.

Click to expand an area for greater control over sub-functionality available.

Enable the initial functionality you would like in your installation of Altium NEXUS, this can be changed later if required.
Enable the initial functionality you would like in your installation of Altium NEXUS, this can be changed later if required.

Platform Extensions offer extended functionality to the core platform. Each platform extension is a dedicated package of core platform functionality that has been 'brought out' of the platform and delivered in the guise of an extension. By delivering this functionality as an extension, Altium can deliver updates to that core functionality without having to release an update to the entire platform itself.

Simply click to enable the functionality you require. As you select and deselect functionality, text at the bottom of the page dynamically updates to reflect the space required for installation. Note that the figure given for the amount of downloaded data does not apply to the Offline Installer.

Click to enable functionality at the parent level, to quickly enable all of its child functionality too.

Remember, no matter what decision you take at initial install, you can add or remove features and functionality at any stage after installation. This puts you in the driving seat as it were, to fully customize your installation in-line with your, possibly ever-changing, design needs.

After defining what functionality you'd like, click Next to proceed.

Destination Folders

This next page of the Installer allows you to specify the destination folders for the install, in terms of both the Program Files for the software and the Shared Documents that are accessed and used by the software.

Specify where the software and associated documents are to be installed.
Specify where the software and associated documents are to be installed.

These locations become especially important when installing multiple instances of Altium NEXUS. If one or both of these destinations is not currently an empty folder (i.e. devoid of content) you will be prevented from proceeding with the installation until you specify alternate (and empty) destination(s).

The default destinations (Windows 7 and above) are:

Program Files

C:\Program Files\Altium\Nexus

Shared Documents

C:\Users\Public\Documents\Altium\Nexus

To specify alternate locations, simply type the location directly into the applicable field, or click the folder icon at the right of a field and browse for the required destination folder.

Once the install locations are specified, click Next to continue.

Ready To Install

The Installer now has all the information it requires to proceed with the installation. If you need to change anything, click the Back button. If you want to cancel out of the install, click Cancel.

Ready to begin the install!
Ready to begin the install!

To go ahead and proceed with the installation, click Next.

Installing Altium NEXUS

The page will change from Ready to Install to Installing Altium NEXUS and the installation will proceed, with the required files first being prepared (from the set of files contained within the unzipped Offline Installation package). Progress of this preparation is displayed within the Installer itself.

Installation commences by preparing the required set of install files.
Installation commences by preparing the required set of install files.

Once the preparation of files is complete, they will be installed, again with progress displayed in the Installer.

After the file preparation is complete, the software is then installed.
After the file preparation is complete, the software is then installed.

Installation Complete

When the installation itself completes, you have reached the end of the Installer wizard.

That's it, installation is complete!
That's it, installation is complete!

An option is provided to launch Altium NEXUS when you exit the Installer, enabled by default. Simply click Finish to exit the wizard.

That's it. You have installed Altium NEXUS on your computer, and initially tailored its functionality to suit your design needs. You can now import any preferences from an earlier build, and then license the software to work in an offline, standalone fashion.

Sign in to Server

After installing and launching your new version of Altium NEXUS, the Sign in to Server dialog will appear. Use this dialog to sign in to a target server in which all your managed content is stored.

Sign in to your company's managed content Server.Sign in to your company's managed content Server.

Simply enter the URL for the target server's address into the Server Address field, and your server access credentials (User Name and Password), then click the Sign in button.

If you don't sign in to your company's Server - for example you click Cancel in the Sign in to Server dialog - then Altium NEXUS will not launch. Conversely, if you are using Altium NEXUS and sign out of your company's Server, Altium NEXUS will also close. Offline (unconnected) mode, if it is permitted by your organization's policies, can be enabled by enabling the NEXUS.OfflineMode option in the Advanced Settings dialog - accessed by clicking the Advanced button, on the System - General page of the Preferences dialog. You will need to restart Altium NEXUS for the change to this setting to take effect.
 It can be a good idea to enter your server access credentials, and then enable the Automatically sign in after start option.
If you already have an Altium Vault (version 2.0 and later), you can still use this as your managed content server, and connect to it from your Altium NEXUS installation. Bear in mind that development of the standalone Altium Vault product has ceased at version 3. And while the Altium Vault will continue to be supported, it is recommended to upgrade to the Altium NEXUS Server - the native managed content server for the Altium NEXUS product - to take advantage of new capabilities that are being developed in the realms of collaboration, data management, and process management. Should you not require to install the on-poremise Altium NEXUS Server, it is also possible to use a cloud-based Altium NEXUS Workspace.

Importing Preferences from a Previous Version

After signing in to your managed content Server, Altium NEXUS will continue to launch and the Import Settings dialog will appear, from where you are given the opportunity to import preferences from the most recent previous installation at startup.

Import settings from your previous version's installation.
Import settings from your previous version's installation.

Not only will the preferences be imported, but the user settings will be copied across too - ensuring the new version opens with the same look and feel created in the previous version, even down to the last opened workspace and panel positioning!

If the option to import preferences on initial startup is not taken, don't worry - preferences can be quickly imported, at any time, from within the Preferences dialog. Simply click the  button, at the bottom of the dialog. The associated menu will list all previous versions currently installed on the computer, and that can be imported from.

Preferences can be imported from any individually installed version instance of Altium NEXUS.
The benefit of importing at initial startup is getting the working environment looking exactly the way it was set up in the previous installation. Importing preferences at a later stage will only 'restore' a subset of this environment.

Altium Product Improvement Program

Also as part of the initial launch of your newly installed version of Altium NEXUS, you will be asked if you would like to participate in Altium's Product Improvement Program. Since this requires connection with Altium, it is not required for an offline installation, and so you can simply choose the No, I don't want to participate in the program option, in the Altium Product Improvement Program dialog that appears, and click OK.

Licensing the Software

When Altium NEXUS starts, it will display the License Management page, as shown in the image below.

The License Management page - command central for getting Altium NEXUS licensed.
The License Management page - command central for getting Altium NEXUS licensed.

There are now two actions to perform in order to setup the software to work effectively offline:

  1. Configure Altium NEXUS to operate in an offline mode, so that it will not attempt to contact Altium to validate licensing.
  2. Add a standalone license file, required to unlock Altium NEXUS's functionality.

Switching to Offline Mode

To switch Altium NEXUS to an offline mode, essentially severing the connection to Altium:

  1. Click on the Account preferences link. This gives access to the System - Account Management page of the Preferences dialog.
  2. Enable the No, I wish to remain disconnected from Altium option. By enabling this option, your installation of Altium NEXUS will stay completely disconnected from Altium. While disconnected, you will not be able to access or use any of the on-demand services that require a connection with Altium. In essence, this option is a 'full offline' switch.
  3. Click OK to accept the change and close the Preferences dialog.

Sever the connection with Altium's online services, to place your installation in a fully Offline mode.
Sever the connection with Altium's online services, to place your installation in a fully Offline mode.

In addition, confirmation that you are using an offline installation of the software can be seen on the System - Installation page of the Preferences dialog. The Offline installation option will be enabled, with the path to the unzipped offline installation package folder.

Additional confirmation that you are using an offline installation.
Additional confirmation that you are using an offline installation.

Note that the offline installation does not check for updates or new extensions, regardless of the status of the Altium Connection setting. To perform an update you will need a later copy of the Offline Installation package.

Adding the License File

First, you need to procure the required Standalone license file. This can be downloaded by signing in to the AltiumLive community area of the Altium website, opening the Dashboard (clicking the Dashboard link at the top of the page) and going to the Licenses section. When you click on a license to examine the details there is an Activate button, click this to download the licensing file (*.alf) for that license.

To learn more about licensing visit Altium Dashboard - Managing Licenses.

With the Standalone license file acquired, you can now proceed to use that file to license your offline instance of Altium NEXUS. To do so:

  1. On the License Management page (within Altium NEXUS), click the Add standalone license file link.
  2. The Open dialog will appear, browse to and select the license file you just acquired.

Add the Standalone license file to complete the process.
Add the Standalone license file to complete the process.

Once you have selected the license file and returned to Altium NEXUS, the License Management page will display the license details, as shown below.

The details for the added Standalone license are displayed.
The details for the added Standalone license are displayed.

An offline installation can also be licensed using a Private License Server. This can be achieved using the Private License Service available as part of an Altium Infrastructure Server.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content