Extending Your Altium Designer Develop Installation

Altium Designer Develop's installation management system allows you to handcraft your installation of the software at any time after the initial installation. This includes the ability to install or remove additional functionality which is made possible through the provision of optional Extensions. This functionality could include a new importer or exporter, a tool for schematic symbol generation, or maybe support for mechanical CAD collaboration. In short, any targeted packages of functionality that extend and enhance the feature set of the software.

This document takes a dedicated look at the concept of extensions and, more importantly, their management.

Types of Extensions

As a concept, an optional extension is a single entity – a package of functionality that installs seamlessly into Altium Designer Develop's wider platform environment. However, from the designer's perspective, optional extensions can be further categorized to provide a greater depth of meaning as to just what is being installed. As a result, an optional extension can be classified into one of the following types:

  • System Extension – a dedicated package of core platform functionality that has been 'brought out' of the platform and delivered in the guise of an extension.

  • Software Extension – a dedicated add-on for the software that extends its features and functionality in some measurable way. Software extensions can be delivered by Altium itself or be developed by third parties and traded for a defined purchase price.

From the software's perspective, an extension is an extension. The back-end mechanics of handling extensions, i.e., integrating them into the platform's unified design environment, is the same regardless of the type of extension being installed.

Browsing Installed and Available Extensions

Additional software functionality, provided through optional extensions, can be browsed, installed, and managed through the Extensions view in Altium Designer Develop. It is from here that you can see which extensions are currently installed or if additional functionality is available through further extensions. Additionally, you are not constrained in any way – you can freely install or remove extension-based functionality at any time as your needs change.

The view is accessed by clicking the Current User control at the top right of the design space and selecting  from the menu.

Accessing the Extensions view – command central from which to efficiently manage the functionality available to the software.
Accessing the Extensions view – command central from which to efficiently manage the functionality available to the software.

The view itself consists of the following distinct 'pages' (use tabs at the top of the view to switch between them):

  • Installed – functionality currently installed as part of your Altium Designer Develop installation.

  • Available – system extensions and software extensions that are available for installation to your instance of Altium Designer Develop.

  • The Extensions view also provides controls to modify the core features and functionality installed with the platform (learn more).

  • When accessing a page in the view, extension information is retrieved from the location in which that extension is stored. Altium's own extensions are stored in, and information, therefore, retrieved from, a dedicated cloud-based Altium Repository. To force a manual refresh of the extension data, use the Refresh control –  – at the top right of a page.

Currently installed extensions are listed in the System Extensions and Software Extensions regions of the Installed page.

Browse through a listing of currently installed extensions.
Browse through a listing of currently installed extensions.

Access the Available page of the view to browse a listing of all extension-based functionality currently available for your installation of Altium Designer Develop, including system extensions and software extensions. This is functionality that can be optionally added to or removed from your Altium Designer Develop installation.

Note that some extensions require dedicated licensing to use their functionality in Altium Designer Develop.

Browse through a listing of available extensions
Browse through a listing of available extensions

  • By default, only those extensions that have not yet been added to your installation are presented on the Available page. To view all available extensions regardless of their installation status, disable the Available but not installed option at the top right of a region. An extension that has not yet been installed will reveal the download icon () when you hover over it, while one that is currently installed is indicated by the installed icon ().

  • For each installed extension, its associated installation files are stored in a dedicated folder that is named after that extension. Extension folders can be found along the following path: \ProgramData\Altium\Altium Designer Develop <GUID>\Extensions. In addition, the root Extensions folder contains a registry file – ExtensionsRegistry.xml – which is used to keep track of all extensions currently installed for that instance of Altium Designer Develop.

  • On the Available page, extensions will be listed that are available in the source of extensions and updates specified in the preferences of the current Altium Designer Develop installation. Click the icon at the top of the view to open the System – Installation page of the Preferences dialog where you can configure this source. Note that when using the global installation service, you must be signed in to your Altium Account – a link will be provided on the page with which to do so if you are not currently signed in. After changing the settings, click OK to save changes and close the Preferences dialog. Click the icon at the top right of the Available page to refresh the list of available extensions from the specified source.

Click on the name of an extension (of any type) on the Installed or Available page to access a detailed page for that extension.

Examine and manage your installation at the individual extension level.
Examine and manage your installation at the individual extension level.

Information includes:

  • Who created the extension

  • Its version

  • Its release date

  • Where it is sourced from (the Global Repository or the organization's local server, for example)

  • A more detailed description

  • Any pertinent release notes

To return to the page from which the extension detailed page was accessed (either Installed or Available), click the page tab at the top.

Installing an Extension

An individual extension can be installed in one of two ways:

  • From the summary-level Available page of the Extensions view, hover over the extension and click the  icon at the top right of its entry. Hover the mouse over the download icon to view details of the version available.

  • From the extension's detailed page, click the button.

Alternatively, if you want to install all software extensions, click the Install All control above the Software Extensions region on the summary-level Available page.

Install an extension from the Extensions view.
Install an extension from the Extensions view.

At the summary-level Available page, a progress bar will appear that shows the progress of the download (getting the file set for that extension from the source repository) and subsequent installation. You can click to install as many extensions as you like; they will be added to a queue, with up to four extensions being downloaded and installed at any given time. Should you need to cancel installation of an extension, click its associated cancel icon ().

A restart of Altium Designer Develop is required after an extension finishes installing in order for the functionality it provides to take effect. A dialog will open alerting you to this; click Yes to restart at that time, or No if you want to install additional extensions. If you click No, the extension will appear on the Installed page with the  icon to indicate a restart is required for its installation to be completed.

System extensions can also be installed from the Configure Platform page when making changes to the core functionality of the installation (learn more).

Uninstalling an Extension

A currently installed extension can be uninstalled in one of two ways:

  • From the summary-level Installed page of the Extensions view, hover over it and click on the  icon at the top right of its entry.

  • From its detailed page, click the  button.

Alternatively, if you want to uninstall all currently installed software extensions, click the Delete All control above the Software Extensions region on the summary-level Installed page.

Be sure to restart Altium Designer Develop after you have finished uninstalling the required extensions in order for their functionality to be removed from the installation. A dialog will pop up alerting you to this; click Yes to restart at that time or No if you want to make additional changes to your installation. If you click No, the extension will appear on the Available page with the  icon to indicate a restart is required for its removal to be completed.

System extensions can also be removed from the Configure Platform page when making changes to the core functionality of the installation (learn more).

For each extension that is uninstalled, its associated installation folder and files will be removed from the following path: \ProgramData\Altium\Altium Designer Develop <GUID>\Extensions. In addition, the registry file – ExtensionsRegistry.xml – will be updated to remove entries for those uninstalled extensions.

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

The features available depend on your Altium Platform solution access level. Compare features included in Altium Develop and editions of Altium Agile.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Legacy Documentation

Altium Designer documentation, in service of the platform solutions from Altium (Altium Develop and Altium Agile), is no longer versioned. If you need to access documentation for older, standalone versions of Altium Designer, visit the Legacy Documentation section of the Other Installers page.

Content