Tips & Tricks with the Explorer Panel

This document is no longer available beyond version 4. Information can now be found here: Explorer Panel for version 5

Applies to NEXUS Client version: 4

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.

 

Parent page: Workspace Configuration

Altium NEXUS's Explorer panel provides a direct interface to your connected Workspace. From the Explorer panel, you can perform many activities, including:

  • Create and manage the organizational structure used in the Workspace
  • Create any number of Items, each representative of a design object
  • Review and manage the lifecycle of Item revisions
  • Interrogate the usage of a particular Item revision (Where-Used)
  • Browse and manage supply chain information for Component Items

This page pulls together some tips, tricks, and cool functionality that may otherwise be missed amongst the feature-rich environment of the panel. Think of this page more as a 'crib sheet', presenting a collection of features that can really enhance your productivity when working with the Explorer panel.

For your day-to-day activities in the realm of component management, you'll make frequent use of the Components panel. This panel provides a powerful interface with which to interact with all your components. For your Workspace components, the panel provides a filter-based parametric (faceted) search capability, for specifying target component parameters. In addition, the panel also offers options to edit a Workspace component through the Component Editor (in its Single Component Editing mode), view the component in its source Workspace, and perform component management functions such as component creation and cloning, or editing the selected component's Part Choices and Type. In short, the Components panel offers a streamlined, targeted interface to aid your component management activities, without having to venture into the Explorer panel.
This page is by no means an exhaustive 'one-stop shop' of all that the Explorer panel has to offer. Many of its features are discussed elsewhere in the documentation, as part of dedicated documents pertaining to features and functionality relating to Designing with a Connected Workspace, specifically Working with Components, and Board Design Release.

The Explorer panel provides a direct interface to your Workspace from within Altium NEXUS.
The Explorer panel provides a direct interface to your Workspace from within Altium NEXUS.

Changing the Browsable Workspace

The Explorer panel can only interface to one Workspace at a time. The field at the top-left of the panel indicates the currently active Workspace – the Workspace whose content you will be able to browse and modify. To select a different Workspace, click on the Workspace name and choose a different Workspace from those currently connected.

Access controls for changing the browsable Workspace.
Access controls for changing the browsable Workspace.

All currently connected Workspaces – the currently active Workspace and those from the Known Servers list for your instance of Altium NEXUS – are presented on the Data Management – Servers page of the Preferences dialog. Note that in the Explorer panel all connected Workspace will be listed, but only one will be active and is distinguished by the inclusion of the icon, and its name in bold.

Folder Content Loading

When you click on any folder within the Server Folders structure region of the Explorer panel, only a portion of that folder content will be initially loaded, where applicable to do so. This greatly decreases the folder's initial load time. As you scroll to the end of the initial content, an additional portion of the folder content will be loaded.

To have all content for the folder loaded, click the button at the top of the panel, and use the Load all pages option on the associated menu to switch from portion loading of folder content (option disabled) to full loading of folder content (option enabled).

Moving Folders and Items

One or more Workspace folders, or Items within a folder, can be quickly moved using the drag and drop technique:

  • Folders – select the folder(s) to be moved (using standard Ctrl+Click, or Shift+Click techniques), then click, drag, and drop the selected folder(s) at the required place in the structure, as indicated by a horizontal indicator.
  • Items – select the Item(s) to be moved (using standard Ctrl+Click, Shift+Click, or Ctrl+A techniques), then click, drag, and drop the selected Item(s) onto a different folder in the structure.
Folders and Items can also be moved using the corresponding command available from the right-click menu (the command will reflect whether one or multiple folders/Items are being moved). Launching a command will give access to a dialog in which to select the target folder under which the folder(s) should be moved, or the Item(s) should be placed into, respectively.

Drag & Drop Placement

Placement of certain Workspace Items into a PCB design project in Altium NEXUS is streamlined with the ability to drag & drop revisions of these Item types onto the active (and applicable) document, directly from the Explorer panel. Support is available to drag:

  • A revision of a Component Item onto the active schematic document (or PCB document). The applicable model for the chosen domain will appear floating on the cursor accordingly.
  • A revision of a Managed Schematic Sheet Item onto the active schematic document. A sheet symbol that references the sheet will float attached to the cursor.
  • A revision of a 3D Model Item onto a PCB or PCB Library document, creating a 3D Body object that references that Item Revision.

Browse your Workspace for the required Item to be placed. Placement involves a specific revision of that Item, so be sure to expand the main Item entry to list all of its available revisions (click the button at the top-right of the panel and disable the Show only latest option to see all previous revisions). Then click on the required revision and drag an instance of it onto the design document.

Drag and drop the top-level entry for an Item itself, to place an instance of the latest revision of that Item.
Drag & Drop places a single instance of the Item Revision. If you need to place multiple instances, right-click on the required Item Revision (or top-level Item entry for the latest revision) and use the Place command.

In addition, Altium NEXUS supports access to, and placement of components from, the Components panel. For more information, see the section Placement from the Components Panel, on the page Working with Components.

Batch Download of Items

The Explorer panel supports the ability to select multiple Items in a Workspace, and have the source entities for those Items downloaded, en masse, into a newly created single source library or folder, as applicable. The following Item types are supported by this feature:

  • Symbols – with the selected symbols downloaded into a Schematic Library (*.SchLib).
  • Footprints – with the selected 2D/3D component models downloaded into a PCB Library (*.PcbLib).
  • Components – with the selected components downloaded into a Zip archive file containing source symbol and model libraries, and a source Integrated Library Package (*.LibPkg).
  • Simulation Model Items – with the released data applicable to each Item in the selection (*.SimModel, *.mdl, *.ckt) downloaded to a separate sub-folder.

Batch Lifecycle State Changes

Related page: Defining Lifecycle Definitions for a Workspace

All of the design Items stored in your Workspace have a Lifecycle State. The lifecycle state is used to reflect the readiness of that Item for use, for example, an Item might be New From Design, In Production, or Deprecated. The lifecycle state of multiple Items can be changed in a single batch process.

To perform a batch change:

  1. Select the required Items in the Explorer panel.
  2. Right-click and choose the Operations » Change state command from the context menu.
  3. The Batch state change dialog will open. The Next State column will default to the next lifecycle state for each Item involved. This can be changed on an individual Item basis, but editing of multiple selected entries in the column is also supported, for quickly setting the required state across Items.
  4. Once the Next State has been set as required, click the Process button to effect the lifecycle state changes.
  5. A Confirm dialog will appear, enter a comment if required (this is stored as part of the Item History) and click Yes to complete the batch lifecycle state change.

An example of quickly changing the lifecycle state of two components.
An example of quickly changing the lifecycle state of two components.

Clickable URLs

Further improving the usability of Workspaces, the Explorer panel supports clickable URLs. This functionality can be found in a variety of relevant areas, including:

  • Clicking on a component parameter whose value is a URL, opening the target page in an external web browser.
  • Clicking on a URL in the supply chain data for a component, opening the target page in an external web browser.
  • Clicking on a document in the Released Documents region – from the Preview aspect view tab for a revision of a PCB Fabrication Data Item, PCB Assembly Data Item, or PCB Project Design Item – to open that document.
For component parameters and Released Documents of a Project-related Item, this functionality is also available when viewing the full details for an Item, directly in Altium NEXUS. To access this view, right-click on the Item's entry in the Explorer panel, and choose History from the context menu.

Support for Multi-Part Components

When viewing the symbol for a multi-part component, the Preview aspect view tab will present each part – each with its own distinct symbol graphic – as a separate tab. In addition, the Place menu will present a sub-menu of all applicable parts that can be placed for that component.

Ability to Copy-Paste Workspace Folder Structure

Adding greater flexibility to the management of your Workspace content, the Explorer panel provides the ability to copy and paste a folder (and its descendant structure). This essentially allows you to quickly clone areas of your Workspace folder structure, which can prove a real time-saver when readying your Workspace for a deluge of component data, for example, where the structure is similar, with a parent folder and sub-folders for the various domain models.

To use this feature:

  1. Select a folder in your existing folder structure, whose structure you wish to copy.
  2. Right-click and choose the Operations » Copy Folder Structure command from the context menu.
  3. Select the folder under which you want the cloned folder structure to be pasted.
  4. Right-click and choose the Operations » Paste Folder Structure command from the context menu.

Once pasted, you can make adjustments to the cloned folder structure as required.

You can only copy a single selected folder (and its descendant structure). The commands will be unavailable if multiple folders are selected.
Note that on paste, only the folder structure is pasted – Items within the copied folder structure are not copied.
Remember that when pasting, two folders cannot have the same name in the same area of the folder structure. Trying to do so will result in a Duplicate Folder HRID error. And while the parent folder will not be pasted, its descendant structure will be, and at the top level of the folder structure. So if you are trying to quickly create a set of cloned folders under the same parent area of the 'tree', what you can do is paste the folder structure to another temporary area of the main Workspace folder structure. Then rename the top-level folder, make any other adjustments, then drag and drop back to where you really want the folder to be.

Item Revision Comparison

Using the power of Altium NEXUS's native file format comparison technology, the Workspace supports the visual comparison of two revisions – of the same, or different Items – for a range of supported content types, directly from within the Explorer panel. Revisions of Items of the following content types can be compared:

  • Component Item
  • Symbol Item
  • Footprint Item
  • Managed Schematic Sheet Item
  • Schematic Template Item
  • PCB Fabrication Data Item
  • PCB Assembly Data Item
  • PCB Project Design Item

Within the Explorer panel, browse to the relevant folder, select the two Item-Revisions that you wish to compare, then right-click and choose Operations » Compare from the context menu.

Ability to Clone Workspace Content

The Explorer panel provides the ability to clone a variety of Workspace Items. So rather than creating that required component, domain model, schematic sheet, or template from scratch, you can simply clone it. Direct Editing ensures any required changes – to a copy of the source data from the original Item Revision – is a streamlined affair, with the resulting changes released into an initial revision of a new Item of the same type. Done and dusted in record time, you can quickly expand your Workspace content without facing a blank canvas.

The following content types can be cloned:

  • Component
  • Footprint
  • Symbol
  • Simulation Model
  • Component Template
  • Managed Schematic Sheet
  • Schematic Template
  • Project Template
  • Draftsman Document Template
  • Draftsman Sheet Template
  • Layerstack
  • OutputJob

The command to clone one of the supported content types is accessed from the Explorer panel in the following ways:

  • By right-clicking over the entry for the source Item-Revision, and choosing the Operations » Clone command from the context menu.
  • By selecting the entry for the source Item-Revision and using the Ctrl+D keyboard shortcut.

The Clone command is available throughout the Explorer panel, wherever the applicable Item-Revision is presented, including:

  • The main Item listing within a folder.
  • Children aspect view tab (when viewing a Managed Schematic Sheet Item).
  • Where-used aspect view tab (when viewing a Component Item, Symbol Item, Footprint Item, Simulation Model Item, Component Template Item, or Schematic Template Item).
  • Preview aspect view tab (when viewing a Component Item, Managed Schematic Sheet Item, or Schematic Template Item).
When browsing the main listing of Items in a particular folder, access the Clone command from the top-level entry for an Item, to clone the latest revision of that Item.

Accessing a Parametric View of Your Components

The Components type folder supports two viewing modes – the Classic View and the Components View. The latter, which is the default view for this folder type, allows you to browse the parametric data associated with all components in the current folder. What's more, you can set up the view exactly how you like it for different folders of components, and those configurations will remain between sessions.

To toggle between these two viewing modes, browse to a Components folder in the Explorer panel, click the button at the top-right of the components listing, and choose either the View » Classic View, or View » Components View command from the associated menu.

Access the Components View for a Components-type folder, presenting the components in terms of their parametric data. Hover over the image to see the result of switching back to the Classic View.
Access the Components View for a Components-type folder, presenting the components in terms of their parametric data. Hover over the image to see the result of switching back to the Classic View.

Take a look at the following sections for more information on working with the Components View.

Showing only the Latest Item Revisions

Over time, the content in your Workspace may undergo changes as they evolve, with each change resulting in a new revision to accommodate the modified data. When browsing Items, it is typically only the latest revision that is required. All other previous revisions tend to become a level of noise, cluttering the designer's field of view. To alleviate this, the Explorer panel defaults to show only the latest revisions of Items.

To display all revisions of Items in the Explorer panel, click the control, at the top-right of the Items region of the panel, and disable the Show only latest option from the associated menu.

This option is a global setting that applies to all Items in the Workspace, irrespective of type, and the visual folder in which they reside.

By default, the Explorer panel shows only the latest revisions of Items. Hover over the image to see an example of the command disabled.
By default, the Explorer panel shows only the latest revisions of Items. Hover over the image to see an example of the command disabled.

To declutter and return to only presenting the latest revisions, click on the option again to toggle it ON.

Showing Hidden Revisions

Related page: Defining Lifecycle Definitions for a Workspace – Controlling Item Revision Visibility and Applicability

For an Item Revision entering a lifecycle state that has its Visible in Vault panels attribute disabled, that revision will, by default, not be displayed in the Explorer panel. And if it is the latest revision of the Item, then the entire entry for that Item will effectively be hidden from view. This visibility state – defined at the state level – can be overridden globally for all Items.

To display all Item Revisions that are currently not visible, click the control, at the top-right of the Items region of the panel, and enable the Show Hidden Revisions option, on the associated menu.

Displaying hidden Item Revisions while browsing content in the Explorer panel. Hover over the image to see the result.
Displaying hidden Item Revisions while browsing content in the Explorer panel. Hover over the image to see the result.

Controlling Parameter Visibility when Placing Components

When placing components directly from the Explorer panel, control over the visibility of parameters associated with those components – or more specifically, their values – is performed from within the properties dialog for the parent folder.

The folder must be of type Components.

Right-click on the parent folder and choose the Properties command. The Edit Folder dialog will appear. Enable the Configure Parameters Visibility on Add option on the right-hand side. The parameters, taken from all components in the folder, will appear listed in the region. Use the Visible On Add checkbox associated with each parameter to control its visibility, when a component that has that parameter is placed on a schematic sheet.

The Name/Comment parameter is also included in the list. This is a system parameter.
Parametric visibility data is stored as part of the Workspace folder properties, in the Workspace itself, and is global to all users of the Workspace, and with whom the relevant folder(s) have been shared. Folder hierarchy is also taken into account, so parameter visibility configured for a parent folder will be passed down to (inherited by) all child folders below.

Determine, at the folder level, which parameters should be visible when components that use them are placed in a design.
Determine, at the folder level, which parameters should be visible when components that use them are placed in a design.

Copying Component Parameter Information to the Clipboard

Parametric information for a revision of a component can be copied to the clipboard for subsequent use elsewhere in the design, or for pasting to an external application (such as Microsoft Excel). When browsing the Preview aspect view tab for a Component Item revision, select the required parameters – in the Parameters region of the view – and either use the Ctrl+C keyboard shortcut or right-click in the region and use the Copy command on the context menu.

Select multiple parameters as required using standard multi-select techniques (Ctrl+Click, Shift+Click).

Copy a Component Item revision's parametric information to the clipboard, for use elsewhere as required.
Copy a Component Item revision's parametric information to the clipboard, for use elsewhere as required.

Export of Grid Data

The Explorer panel supports the export of data from grid views, to a csv- or xls-formatted file. Examples of where this functionality is available include:

  • Component Items grid (both Classic and Component views).
  • Items grid.
  • Linked models grid on the Preview aspect view tab (for a selected Component Item).
  • Search results grid.
  • Item grid on the Where-used aspect view tab.
  • Item grid on the Children aspect view tab.

Right-click within a grid and choose the Operations » Export Grid command from the context menu. The Select columns for data export dialog will appear. Use this to determine the data you wish to export. The dialog contains all possible columns for the grid, with those that are currently displayed in the panel enabled for export by default. After clicking OK, the standard Windows Save As dialog will appear. Use the dialog to define where, and with what name, the exported file is to be saved. Use the Save as type field to choose the format of the file – either Comma-Separated Values Files (*.csv) or Excel Files (*.xls).

Progress of the export is displayed in the Export Data dialog. Once successfully exported, use the Explore button to quickly explore the export folder. Alternatively, use the Open button to open the exported file directly.

An example of exporting data – the linked models for a selected Component Item revision – to an Excel-formatted file.
An example of exporting data – the linked models for a selected Component Item revision – to an Excel-formatted file.

Changing a Released Component Type On-the-Fly

It is possible to change the component type for one or more components after release to a completely different type, on-the-fly. In the Explorer panel, select the component revision(s) that you want to change, then right-click and choose the Operations » Change component type command from the context menu. The Choose component type dialog will appear from which you can select the new component type.

An example of changing the component type for selected revisions of Component Items that have already been released – with the wrong type to begin with, to underline the feature!
An example of changing the component type for selected revisions of Component Items that have already been released – with the wrong type to begin with, to underline the feature!

Soft Deletion

Your Workspace provides you with flexible functionality for removing content from that Workspace directly from within Altium NEXUS, from the Explorer panel. This allows you to quickly delete:

  • Folders of content
  • One or more specific items
  • Projects
You will know if a Delete-based command within Altium NEXUS's Explorer panel is of the soft delete variety, as the subsequent confirmation dialog will confirm that the deleted item(s) will be moved to the Trash.

To delete a folder or project, right-click on that folder's entry in the panel and choose the Delete Folder command from the context menu. To delete a specific item, right-click on that Item's entry in the panel and choose the Delete Item command from the context menu. The Delete Items dialog will appear, in which to confirm the deletion. The action is actually a 'soft delete', whereby the folder/Item will be moved into the Trash area of the Workspace. The Trash is essentially a recycle bin into which any Item within your Workspace can be moved (through a soft delete action). It is isolated from the rest of the Workspace.

When deleting a Workspace folder (non-project) bear in mind that all sub-folders and items contained within the folder hierarchy will also be soft deleted.
With the soft-delete facility, you are able to delete an item that is currently being used. For a Component Item, you can also opt to delete the component's related items (e.g. symbol, footprint model(s), simulation model, datasheet). Note that these can only be deleted if they are not being used elsewhere (by one or more other components). When deleting a project, the project repository will be moved to the Trash and also all Releases and Packages (Manufacturing Packages).
Multiple Items can be deleted in a single action. Select all required Items using standard multi-select controls (Shift+Click, Ctrl+Click), then right-click and choose the Delete Items command from the context menu.

Example soft deletion of a Component Item, along with its associated Symbol and Footprint Items. All Items will be moved to the Workspace's Trash area.
Example soft deletion of a Component Item, along with its associated Symbol and Footprint Items. All Items will be moved to the Workspace's Trash area.

To proceed with the deletion, click the button. The item will be removed and a Deletion Summary dialog will confirm successful deletion. If there was an issue with deletion, this will be flagged to you.

All items deleted in this manner can be found on the Trash page of the Workspace's browser interface. Note that you can only view items that you have personally soft deleted. Administrators will be able to see the full content of the Trash page – so all items that have been soft deleted.

Things to consider in relation to a soft-deleted item:

  • The item will not be available from your design software, or from within the browser interface.
  • Anywhere the item was being used will reflect that the item has been deleted.

    Example of a soft deleted component being flagged as such elsewhere in the software.
    Example of a soft deleted component being flagged as such elsewhere in the software.

  • An item can be restored, or permanently deleted from the Trash page, provided you have editing rights. Permanent deletion is only possible provided it is not being used by a parent item (on a managed schematic sheet, or within a design).

    For a Project, only the owner or an administrator can permanently delete or restore.
Note that if you have soft deleted an item – moving it to the Trash – you can create a new item with that same name again. If you were to subsequently restore the original item, and the original name is taken, an integer suffix will be used, to keep its name unique within the Workspace.
Content