Altium NEXUS Documentation

Accessing Your Workspace from within Altium NEXUS

Created: May 4, 2021 | Updated: September 14, 2021

Parent page: Designing with a Connected Workspace

Interaction with your connected Workspace can be made from various areas, but there are two main places:

From a purely component management perspective, much of the day-to-day interaction with your Workspace will be performed from within Altium NEXUS, through the Components panel.

This page takes a look at accessing your Workspace from within Altium NEXUS.

After installing and launching a new version of Altium NEXUS, you will be required to sign in straight away to your NEXUS Server Workspace. If you don't sign in to the Workspace, Altium NEXUS will not launch. Conversely, if you are using Altium NEXUS and sign out of the Workspace, 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, which is 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.

Signing in to Your Workspace

The following procedure is for when using Altium NEXUS in its offline (unconnected) mode and wanting to sign in to your NEXUS Server Workspace.

Sign in to your NEXUS Server Workspace from within Altium NEXUS by clicking the Current User control, at the top-right of the main application window (e.g. ). This will be the user that is currently signed into AltiumLive through this instance of Altium NEXUS. In the subsequent menu choose the Custom connection command. The Sign in dialog will appear, with which to sign in to the target Workspace. Enter the URL for the Workspace and your Workspace access credentials, then click the button.

It can be a good idea to enable the Sign in automatically option so that the entered URL and access credentials are stored, and you don't have to repeatedly enter them to access the Workspace when starting Altium NEXUS.

Signing in to your NEXUS Server Workspace from within Altium NEXUS.Signing in to your NEXUS Server Workspace from within Altium NEXUS.

The Workspace's URL (Server Address) will be in the format http://<ComputerName>:<PortNumber> (e.g. http://impala:9780 for a NEXUS Server installed using the default port assignment). If the Workspace is being accessed from an instance of Altium NEXUS that is running on the same computer on which the NEXUS Server is installed, you may also use http://localhost:9780. If you want to sign in using your Windows login credentials – taking advantage of the Workspace's support for Windows Authentication – enable the Use Windows Session credentials option.
The Altium NEXUS Server relies on a number of Microsoft runtime components for successful operation and access, in some situations these may not be present on the target machine. If you receive an error message about a missing library (DLL) when you attempt to sign in to the NEXUS Server Workspace, it indicates that there are missing Microsoft runtime components. Obtain and install the relevant Microsoft Visual C++ Redistributable Package for your OS.

Signing in to a 'Known' Workspace

If you have previously connected to your NEXUS Server Workspace from within the same instance of Altium NEXUS, it will become a Known Server. If this is the case, you can sign in to that Workspace from within Altium NEXUS in a more streamlined fashion. To do so, click on the control at the top-right of the main application window. In the subsequent menu, choose the entry for your Workspace, in the CUSTOM CONNECTIONS grouping. If you enabled the Sign in automatically option when accessing that Workspace previously, you will be signed in straight away. If this option was not enabled, the Sign in dialog will appear, with which to sign in to the target Workspace. Enter the URL for the Workspace, and your Workspace access credentials, then click the button.

Signing in to your NEXUS Server Workspace from within Altium NEXUS, when that Workspace is already known.Signing in to your NEXUS Server Workspace from within Altium NEXUS, when that Workspace is already known.

Note that when the Sign in automatically option is enabled, you will be signed in to the Workspace as the user that last signed in through the Sign in dialog. If you need to sign in as a different user, you will need to use the Custom connection command in the menu associated with the Current User control, at the top-right of the main application window (e.g. ).
You can also access your 'known' Workspace from the Open Project and Create Project dialogs, when wanting to open an existing project, or create a new project, respectively. In either case, select the entry in the Locations region of the dialog, then click the button relevant to that Workspace on the right-hand side. Again, if you need to sign in as a different user, you will need to use the Custom connection command in the menu associated with the Current User control, at the top-right of the main application window (e.g. ).

Signing into a Workspace from Different Computers

Support is provided for signing into your NEXUS Server Workspace using the same credentials but from different computers (other than the computer on which the NEXUS Server is installed). If you attempt to sign in to a Workspace that you are already signed into from another computer – either through Altium NEXUS or the Workspace's browser-based interface – a pop-up dialog will alert you to this. You can choose from two options offered in the dialog:

  • Terminate existing session – close the existing session that you have on the other computer and continue to login to the Workspace from the current computer.
  • Start new session – login to the Workspace from the current computer by using an additional connection license and thereby keep logged into the Workspace from the other computer as well.
The same user can be accessing a NEXUS Server Workspace concurrently in different ways (e.g. connected through Altium NEXUS AND signed-in through an external web browser) and it only counts as a single connection from the licensing perspective, when access is made from the same PC. If the same user accesses that NEXUS Server Workspace from different PCs, each different PC access will require a separate connection (so extra seat of a Client Access License). You will therefore only be able to log in from the current computer as well, provided you have enough Workspace Connector licenses (CAL) remaining.

Checking Sign-in Status

You can check whether you are currently signed in to your NEXUS Server Workspace from the following places:

  • The menu associated with the Active Server control, at the top-right of the main application window. When actively signed in to your Workspace, the control will reflect the name of that Workspace (e.g. ). The Workspace will also be highlighted in the associated menu within the section CUSTOM CONNECTIONS (and is distinguished by the icon). Clicking the entry provides access to browse the content of that Workspace through Explorer panel in Altium NEXUS. Clicking the icon provides access to the Workspace's browser interface (through your default web browser).

    Verification of being signed in to your NEXUS Server Workspace.Verification of being signed in to your NEXUS Server Workspace.

    The Current User control itself reflects the user who is currently signed in to the active NEXUS Server Workspace (e.g. ).
  • The Data Management – Servers page of the Preferences dialog. When signed in to the NEXUS Server Workspace that Workspace will be presented as the Active Server.

    You can only be actively connected to one Workspace through the software at a time. If you have previously connected to other Workspaces from that instance of Altium NEXUS, they will be listed as Known Servers. While actively signed in to one Workspace, you could also be connected to another (it will not be the active server).

    Once signed in to your NEXUS Server Workspace it will become the Active Server, as can be seen here.Once signed in to your NEXUS Server Workspace it will become the Active Server, as can be seen here.

  • The Explorer panel. When signed in, the Workspace will be available from the menu associated with clicking on the name of the Workspace currently being browsed.

    Note that all connected Workspaces will be listed, but only one will be active and is distinguished by the inclusion of the icon, and its name boldened.

    Browsing the Active Server through the Explorer panel in Altium NEXUS.Browsing the Active Server through the Explorer panel in Altium NEXUS.

Switching Workspaces

You can quickly switch between any of the Workspaces available to you. To do so, click the Active Server control at the top-right of the main application window (e.g. ). In the subsequent menu choose the entry for the Workspace you wish to switch to. You will be disconnected from the current Workspace, then after a few moments connected to the chosen Workspace.

When multiple Workspace are available, you can quickly switch between them. When multiple Workspace are available, you can quickly switch between them.

If switching to a NEXUS Server Workspace and the Sign in automatically option was enabled when accessing that Workspace previously, you will be signed in straight away. If this option was not enabled, the Sign in dialog will appear with which to sign in to the target Workspace. Enter the URL for the Workspace and your Workspace access credentials, then click the button. Note that when the Sign in automatically option is enabled, you will be signed in to the Workspace as the user that last signed in through the Sign in dialog. If you need to sign in as a different user, you will need to use the Custom connection command in the menu associated with the Current User control, at the top-right of the main application window (e.g. ).

Managing Your Workspace from Altium NEXUS

From within Altium NEXUS, you have the ability to manage certain aspects of your connected Workspace. This is performed from the Data Management – Servers page of the Preferences dialog. Click the Properties control associated with the Workspace – in the Active Server region of the page – to access the commands, illustrated in the following image and detailed thereafter.

Accessing commands to manage various properties of the Workspace to which you are actively signed in.Accessing commands to manage various properties of the Workspace to which you are actively signed in.

  • Server configuration – use this command to access the Workspace's browser interface in your default web browser. If you are an Administrator for the Workspace you will be taken to the Admin – Settings page of the browser interface.
  • Lifecycles – use this command to access the Edit Lifecycle Definitions dialog, with which to manage the defined lifecycles for the Workspace.
  • Naming schemes – use this command to access the Edit Revision Naming Schemes dialog, with which to manage the defined revision naming schemes for the Workspace.
  • Operations – use this command to access the Edit Operation Permissions dialog, with which to define and manage global operation permissions for the Workspace.
  • Connection – use this command to access the Connection Properties dialog, with which to configure your connection to the Workspace.
For another Altium NEXUS Server Workspace to which you have a connection (connected or disconnected), you will only have access to the Server configuration and Connection commands.

Signing Out from Your Workspace

You can sign out from your NEXUS Server Workspace from within Altium NEXUS in the following ways:

  • By clicking the Active Server control, at the top-right of the main application window (e.g. ). In the subsequent menu click the sign out control () at the far right of the entry for the currently connected Workspace.

  • By clicking the button, associated with the Active Server, on the Data Management – Servers page of the Preferences dialog. A confirmation dialog will appear – click Yes.

Your access to the Workspace will also be terminated when you exit Altium NEXUS. In addition, and for an Administrator of your Workspace, there is the provision to drop a session from the Admin – Sessions page of the Workspace's browser interface, and thereby free up a connection to that Workspace.

Working in the Workspace

Related page: Tips & Tricks with the Explorer Panel

Once you are connected to your Workspace, you can access and create content. The primary interface to the Workspace from Altium NEXUS is the Explorer panel.

From a purely component management perspective, much of the day-to-day interaction with your Workspace will be performed from within Altium NEXUS through the Components panel.

When you are working in Altium NEXUS you access full Workspace content through the Explorer panel. For component management only, you'll tend to use the Components panel.When you are working in Altium NEXUS you access full Workspace content through the Explorer panel. For component management only, you'll tend to use the Components panel.

To display a panel:

  • Click the button at the bottom-right of Altium NEXUS and select the required panel from the menu that appears.
  • Choose the required panel entry from the View » Panels main menu.
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: