Browsing a Connected Workspace with the Explorer Panel in Altium Designer

Parent page: System & Environment Panels

The Explorer panel gives access to data stored in a server.

Summary

The Explorer panel is the primary interface between Altium Designer and a connected managed content server, making it an integral part of the Design Data Management System. A managed content server stores your valuable company design data, including components, managed sheets and templates, and completed designs. From the Explorer panel, you create and manage the organizational structure used in the managed content server and also create any number of Items, each representative of a design-side object. From the panel you also can access detailed Item information and manage the revision and lifecycle settings for the Items well as where-used and supply chain detail.

Panel Access

To display the Explorer panel, click the Panels button on the bottom-right of the workspace then select Explorer. Alternatively, you can access the panel through the View » Panels » Explorer.

A variation of the Explorer panel that is essentially a 'trimmed-down' version and titled Choose Item is opened in some instances, for example, when you need to choose a model or template. A few examples include: from an ActiveBOM document (*.BomDoc) when adding a new server item and from the Properties panel in Component mode after clicking in the Design Item ID field.

If the Vault Explorer extension needs to be installed, go to the Purchased tab under the Extensions & Updates tab and find the Vault Explorer icon. Hover the cursor over the extension icon then click to install. Altium Designer must be restarted to complete the installation process.

Choosing the Working Server

The Explorer panel can only interface to one server at a time. The field at the top-left of the panel indicates the currently open server – the server whose content you will be able to browse and modify. To refresh the content display for the active server, click the icon at the end of the Address Bar or right-click in the Server Folders region then select Refresh Server.

Use the drop-down arrow to the right of the server name or click on the server name itself to select a different server.

Organizing a Server

Maintain order within a server by creating a tree of folders for the various Items stored in the server. A number of folder types are available. Use these folders to categorize the server content. Right-click in the Server Folders region of the panel to add folders and define a storage structure of folders and sub-folders that suits your organization.

The right-click menu includes commands for defining a folder hierarchy. Note that the options change depending where you click.

Server Folder Types

You have full control over the folder type and it can be changed at any time by right-clicking on a folder then selecting Properties to open the Edit Folder dialog.

Server Folder Properties

When you add or edit a folder a dialog will appear in which you can define the properties of the folder. The content of the dialog is the same whether a top-level or sub-folder is being added.

The dialog presents the following folder-related properties:

• Folder Name – enter a meaningful name for the folder, perhaps an umbrella term that reflects the relationship of the Items that will be stored within it. The name can be a maximum of 160 characters.

• Folder Type – this is already set to the folder type selected on adding the folder, either through a menu entry or through the Choose Folder Type dialog. If you need to change the type, click the arrow at the far right of the field then choose the required type from the drop-down list.

• Description – enter any description for the folder, perhaps describing the content it is to hold. This field has a maximum of 255 characters.

• Item Naming Scheme – this field provides a set of default naming schemes that can be used to quickly define the unique ID for any item subsequently created within the folder. Using a default naming scheme, the software will automatically assign the next available unique ID based on that scheme, having scanned the entire server and identifiers of existing items. You can create your own scheme for a folder by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g., SYMBOL-001-{J000}). See the Defining Naming Schemes for Item Revisions page for more information.

• Share – click this link to access the Share For Folder dialog in which you can specify the visibility of the folder in terms of who can 'see' and access it.

Navigating a Server

You can navigate the content in a server in several ways:

• Click on a folder whose contents you want to peruse.

• Use the Address Bar at the top of the panel. The Address Bar reflects the current folder being browsed along with the hierarchical path to that folder.

• Use a server's search feature. Enter a keyword based on a comment or description then press Enter or click the magnifying glass icon.The entire server will be scanned and results of the search listed in terms of matching Items.

Moving a Server Folder

Server folders can be moved to a different location within a server's folder structure in the following ways:

• Click and drag the folder entry to the desired position within the Server Folders hierarchy structure.
• Right-click on the folder entry then choose Move Folder. The Move Folder dialog will appear. Select which of the existing folders your chosen folder should be moved under. You also can move the folder to be a top-level folder in the server.

Deleting a Folder

A folder can only be deleted if it is empty, that is, it contains no sub-folders or items. To delete a folder, right-click then select Delete Folder.

Server Items

Each entity that is stored in the server is called an Item. To support the need to be able to update an Item over time, what is actually stored in the server is a series of Item Revisions that are specific revisions of that Item whose name is based on the chosen Revision Naming Scheme. Each new Item is created in a folder and once you have defined the required folders within a server, you can create new Items in the selected folder in the Item region of the panel.

► Refer to the Server Items page to learn more about server items.

Viewing Revisions

You can configure the revisions that are displayed in the panel by clicking the icon to access a drop-down of revision choices.

• Load all pages – select to load all revisions.
• Show Hidden Revisions – select to show any hidden revisions.
• Show only latest – select to only show the latest revisions.

Interpreted Views

The panel also offers two special, interpreted views that apply to Components and Projects. The view will automatically switch to this style when a Component or Project is selected, unless the panel display option has been changed to the Classic View mode.

The Classic or interpreted view (Component View / Project View) options are available from the view menu when one of the special item types has been selected.

• Classic View – select to show just Items and their Revisions.
• Components View – select to show revisions and interpreted component data.
• Project View – select to show a structured graphic version of the project that includes access to Project Release data and project Parameters. See Project View below for more information.

General Item Commands

Along with the view options, the panel's options area also includes the Add <item> command button, which applies to the currently selected type of component.

This command invokes the creation of a new server item of the selected type. When a component is selected in the panel for example, an button is offered. This will open a newly created component of that type in the Component Editor. Similarly, a button is shown when an Output Job Template has been selected, and so on. The button will follow a component search, as entered in the component path field at the top of the panel, which creates a Part Request activity that applies to the component selected in the search results.

The exception is when a project is selected, where the and buttons are presented:

• Open - use to open the currently selected project in the Projects panel.
• Clone - use to create a copy of the selected project via the Clone Project dialog.

Browsing Items

For each Item revision in a server, the Explorer panel allows you to browse different aspects of that revision, where applicable. This is done using one or more views for that revision by using the tabs at the bottom of the panel.

The default-level view is the Preview. Click additional tabs to view more information (the available tabs will depend upon the type of Item that is currently selected):

• Preview – view a composite depiction of the selected Item that includes graphic representations of documents and models, parameter data, associated sub-items, etc. The view is automatically set for different types of Items and whether the Classic or interpreted view modes (see above) are selected for Components and Projects.
• Lifecycle – explore the Item's revisions levels and Lifecycle state change. The Lifecycle may be progressed through the states that are assigned to the item type – for example, the Component Lifecycles states (Draft, Prototype, etc) for a Component item.
• Children – view sub elements of an Item, such as the generated fabrication documents (Gerber, NC Drill, etc) in the Fabrication package (FAB<project name>_PDB) of a released Managed Project, or the schematic document and components used in a Managed Schematic Sheet.
• Part Choices – view or add to the Part Choices (manufacturer part entries with associated supplier data) that are assigned to a component.
• Where-used – view where the selected Item revision is used by another server item, for example, a Managed Project that uses the currently selected Component Item.
• Origin – view from where the Item originated, such as a Component that has been acquired from Altium's cloud resources. Full details of the source item are shown, where possible.
• Data Sheet – view or add file-based datasheets stored with the selected Component Item.
• Parameters – view the parameter Name/Value pairs associated with an Item, such as the generated or added server based parameters of a Managed Project.

Browse different aspects of an Item revision using its associated views.

Project View

The panel's interpreted Project View displays the selected project in a process orientated view that provides direct access to the relevant project data and its releases.

Right-click Menus

Various commands are available from right-click menus in the panel. The exact listing of commands will depend on the region of the panel in which you right-click and the object currently in focus within that region. The following sections cover the commands available.

Commands for the Server Folders Region

• Add Top Level Folder – use to add a new top-level folder into the server folder structure. A sub-menu offers folder types Components, Generic Folder, and Other Folder Type. To browse and choose a different folder type, click Other Folder Type. The Add Folder dialog will appear in which you can define the new folder properties.
• Add Subfolder – use to add a new Components sub-level folder into the server folder structure. To browse and choose a different folder type, click Other Folder Type. The Add Folder dialog will appear in which you can define the new folder properties.
• Operations – use to Copy Folder Structure or Paste Folder Structure to another location.
• Move Folder – use this command to access the Move Folder dialog, which can be used to change the currently selected folder's location within the overall server folder structure.
• Delete Folder – use this command to delete the currently selected folder. Deletion can only be made provided the folder is empty (contains no sub-folders or Items).
• Add To Content Cart – use to add all Components in the selected folder to the Content Cart using the Content Cart dialog.
• Expand Subtree – use this command to fully expand the currently selected folder and all of its sub-folders.
• Expand All – use this command to fully expand all folders in the server folder structure.
• Collapse All – use this command to fully collapse all folders in the server folder structure.
• Refresh server – use this command to refresh the connection with the server currently being browsed.
• Properties – use this command to access the Edit Folder dialog in which related properties for the currently selected folder can be view and modified.
• Project Permissions – use this command to access the Share For <project> dialog in which the access permissions for the selected Project can be viewed and modified.

Commands for the Items Region

• Place – use to place an instance of the currently selected Item-Revision where such placement is supported, for example, placement of a Component Item or Managed Sheet Item onto an active schematic sheet. The symbol for the component or the managed sheet symbol will appear floating on the cursor ready for placement.
• Edit – use to open an item, such as a Component, Managed Sheet or Template, in its associated editor. Once edited it is released back to the server as a new revision of the item.
  When in the Project View (rather than Classic View) mode, the Project Edit command is available from the button menu (top right).
• Upload – use to upload a constituent object into an Item, such as a schematic document into a Managed Schematic Sheet or an OutJob file into an Output Job Template, via the Create new revision dialog.
• Add to Content Cart – use to add the currently selected Item(s) to your Content Cart using the Content Cart dialog.
• Operations – use to access a sub-menu of commands including:
  • Download – use to download the currently selected Item and save to another location using the Browse for Folder dialog.
  • Change state – use to open the Batch State Change dialog to change the state of the currently selected Item Revision.
  • Clone – use to copy the currently selected Item-Revision. A cloned component is opened for editing in its associated editor, such as the Component Editor when cloning a Component Item. A cloned Project is opened for configuration in the Clone Project dialog.
    When in the Project View (rather than Classic View) mode, the Project clone operation is invoked from the button (top right).
  • Change component Type – use to access the Component Type dialog, where the selected component's ComponentType parameter may set to a different type.
  • Export Data – use to open the Select columns for data export dialog to specify the column data to be exported. The exported, semicolon-delimited, CSV file will include the data for all items in the current list grid view.
• Create Item – use to add a new content item of the type that matches the current folder (Components, Templates, Managed Schematic Sheets, etc), which then will be opened in its associated editor. To create a different type of item, select the Other Item Type sub option and then select an alternative type from the Create New Item dialog Content Type menu.
• Move Item – use to access the *Move Item dialog to determine the new placement of Items.
• Delete Item – use to permanently delete an Item.
  When in the Project View (rather than Classic View) mode, the option is available as the Project Remove command from the button menu (top right).
• Full Item History – use to access a detailed view for the currently selected Item, opened as a new tabbed view within Altium Designer. The Item View provides a highly detailed view of the Revision and Lifecycle history of a specific Item, as well as showing all of the elements that make up that Item. The view also includes a Timeline. Use the Timeline to examine the exact time and date of any change made to the Revision level or Lifecycle State of that Item and who made the change.
• Properties – use to access the View Item dialog in which you can view the properties for the currently selected Item. If no revisions for that Item have yet been released, the properties can be modified.
• Delete Components and Models – use to remove a component and its associated symbol/footprint models from the server. Multiple components can be selected for removal. Models will not be deleted if they are in use by other components.

Commands for the Lifecycle View

• Place <Revision> – use this command to place an instance of the currently selected Item Revision, where such placement is supported. For example, placement of a revision of a Component or Managed Sheet onto an active schematic sheet. The symbol for the component, or the managed sheet symbol, will appear floating on the cursor, ready for placement.
• View Revision Properties – use this command to access the Properties for Item Revision dialog, which provides a listing of properties associated to the parent Item of the selected Revision. Other properties are also listed, such as parameters for a component Item, or the parent design and configuration for a released board design Item.
• Delete Revision – use this command to delete the selected Item Revision. Note that you must delete Items from the 'top-down'. That is, you cannot delete a child Item Revision that is used by a parent Item; you first need to delete the parent Item.
• Promote <item to State> – use this command to promote the Item revision to its next Lifecycle State, which may also transition it to the next Lifecycle Stage. The available Lifecycle States are determined by the Lifecycle Definition that applies to the type of Item. The Component Lifecycle Definition would typically apply to Components, for example.
• Rollback <item to previous State> – revert the Item revision's Lifecycle state back to its previously assigned state. Say, from Production back to Prototype when the Component Lifecycle Definition applies.
• Make <item unusable> / Abandon <item> – use this command to change the Item revision Lifecycle State to Abandoned, Obsolete, Deprecated, etc, rather than promoting it to the next higher level. This would be an Obsolete state for the Component Lifecycle definition, for example.
• Establish Planned Revision <level for Item ID> – Use this command to create the next revision level for the Item, which will be in the initial Planned Lifecycle state. The Create Revision dialog will open that provides all controls necessary to fully define the Item revision.
• Establish Planned Item – use this command to create a new Item based on the currently selected item, in the initial Planned Lifecycle state. The Create New Item dialog will open that provides all controls necessary to fully define the Item.

► See Managing Lifecycles for Items for information on working with Lifecycle Definitions.

Tips

• The Explorer panel may be docked horizontally and/or vertically. Right-click on the panel's name and configure docking as required from the Allow Dock sub-menu.