Symbol

Parent page: Managed Domain Models

From a designer's perspective, a managed component (Component Item) gathers together all information needed to represent that component across all design domains, within a single entity. It could therefore be thought of as a container in this respect - a 'bucket' into which all domain models and parametric information is stored. In terms of its representation in the various domains, a managed component doesn't contain the domain models themselves, but rather links to these models. These links are specified when defining the component.

Altium NEXUS, in conjunction with your managed content server, caters for the ability to create and manage Symbol Items in that server. Such Items are created directly within the server. Once a Symbol Item has been created (and data released into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in the creation of one or more managed components.

Folder Type

When creating the folder in which to store Symbol Items, you can specify the folder's type. This has no bearing on the content of the folder - releasing a schematic symbol will always result in a corresponding Symbol Item. It simply provides a visual 'clue' as to what is stored in a folder and can be beneficial when browsing a server for particular content. To nominate a folder's use as a container for Symbol Items, set its Folder Type as Symbols, when defi ning the folder properties in the Edit Folder dialog.

Specifying the folder type - its intended use - gives a visual indication of the content of that folder when browsing the server.

Item Type

When creating a target Symbol Item in which to store your schematic symbol, ensure that its Content Type is set to Symbol, in the Create New Item dialog. If you are creating the Item in a Symbols type folder, this Item type will be available from the right-click context menu when creating the Item.

Creating a Symbol Item within a Symbols folder - the correct Content Type is available on the context menu.

Releasing a Schematic Symbol

Related page: Creating and Editing Items Directly through a Server

So far, we've discussed the support for a Symbol Item in the server, in terms of related folder and item types. Releasing an actual defined schematic symbol into a revision of such an item can be performed in a streamlined way.

A schematic symbol can be edited and released into the initial revision of a newly-created Symbol Item, courtesy of the server's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the server itself. And once editing is complete, the entity is released (or re-released) into a subsequent planned revision of its parent Item, and the temporary editor closed. There are no files on your hard drive, no questioning whether you are working with the correct or latest source, and no having to maintain separate version control software. The managed content server handles it all, with great integrity and in a manner that greatly expedites changes to your data.

When you create a Symbol Item, you have the option to edit and release a schematic symbol into the initial revision of that item, after creation. To do so, enable the option Open for editing after creation, at the bottom of the Create New Item dialog (which is enabled by default). The Item will be created and the temporary Schematic Library Editor will open, presenting a .SchLib document as the active document in the main design window. This document will be named according to the Item-Revision, in the format: <Item><Revision>.SchLib (e.g. SYM-001-0002-1.SchLib).

Example of editing the initial revision of a Symbol Item, directly from the managed content server - the temporary Schematic Library Editor provides the document with which to define your schematic symbol.

Use the document to define the schematic symbol as required. For more information on doing this, see Creating the Schematic Symbol.

There are three relevant controls when direct editing, readily available from the Quick Access Bar (at the top-left of the main application window), or from the Sch Lib Standard toolbar:

•  - Save Active Document. Use this button to save any changes made to the document. This allows you to save current changes, should you wish to come back at a later stage to make further changes before ultimately releasing to the managed content server.
•  - Release Document. Use this button to release (effectively save and release) the defined schematic symbol to the managed content server, storing it within the initial (planned) revision of the target Symbol Item. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. The document and editor will close after the release. The library document containing the source schematic symbol, *.SchLib, will be stored in the revision of the Item.
•  - Cancel Editing. Use this button if you wish to cancel editing. The document and editor will close, and nothing will be released to the target Symbol Item.

These controls are also available as commands - Save (Shortcut: Ctrl+S), Release to Server (Shortcut: Alt+Ctrl+S), and Cancel Edit - from the main File menu.

The released data stored in the server consists of the source schematic symbol, saved in a Schematic Library file named using the Symbol Item's Name. In the Explorer panel, switch to the Preview aspect view tab to see the symbol graphics.

Browse the released revision of the Symbol Item, back in the Explorer panel. Switch to the Preview aspect view tab to see the symbol graphics.

Reusing a Managed Symbol Item

Related page: Managed Components, Controlling Access to Server Content

Once a schematic symbol has been released to a managed content server, and its lifecycle state set to a level that the organization views as ready for use at the design level, that symbol can be reused in the creation of one or more managed components. When directly editing a revision of a Component Item from a managed content server, how a Symbol Item revision is added for use, depends on which mode of editing is being used:

• Single Component Editing - the Symbol Item revision is added to the component's Models region. Use the drop-down associated to the Add Symbol entry to choose the Existing command. An explorer-like dialog will open, with which to browse to, and choose, the required Symbol Item revision.

Example of referencing a revision of a Symbol Item as a model link, when direct editing a revision of a Component Item (managed component) using the Component Editor in its Single Component Editing mode.

You can edit a Symbol Item revision directly from the Models region by clicking the  button, at the top-right of the symbol preview.

• Batch Component Editing - the Symbol Item revision is added to the component's Model Links region. This region can be thought of in terms of a 'bucket' of domain models that can be accessed by any component definition. Assignment is a case of specifying which links are required for each definition. Click the Add control beneath the region and choose the SCHLIB entry. The Choose Models dialog will open (essentially an incarnation of the Explorer panel) with which to browse to, and choose, the required Symbol Item revision.

Example of referencing a revision of a Symbol Item as a model link, when direct editing a revision of a Component Item (managed component) using the Component Editor in its Batch Component Editing mode.

Re-Releasing a Symbol Item

At any stage, you can come back to any revision of a Symbol Item in the server, and edit it directly. From the Explorer panel, right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the library (containing the source schematic symbol) contained in the revision, opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.

Accessing the command to launch direct editing of an existing revision of a Symbol Item from within the Explorer panel.

You can also update the revision of a Symbol Item being used by a revision of a Component Item directly on-the-fly, as part of editing that revision of that Component Item. If the Component Editor is in Single Component Editing mode, edit a Symbol Item revision directly from the Models region of the editor by clicking the  button, at the top-right of the symbol preview. If the Component Editor is in Batch Component Editing mode, edit a Symbol Item revision directly from the Model Links region by right-clicking and choosing the Edit command from the context menu.

Updating Related Component Items

When you make a change to a managed domain model - be it a symbol, footprint model, or simulation model - the moment you release that change into a new revision of the model's Item, any Component Item revisions that use that model will become effectively out of date, still using the previous revision. In most cases, you will no doubt want to re-release those components, with the respective model links updated to use the latest revisions available. To streamline this process, a managed content server, in conjunction with Altium NEXUS, facilitates the ability to update related Component Item revisions - at the point of re-releasing a model Item - after having made any modifications to that model through the direct editing feature.

The option to perform this update to the parent Component Item revisions, can be found in the Create Revision dialog, that appears when releasing the modified symbol back to the target managed content server. This option - Update items related to <ModelItemRevision> - is enabled by default.

Accessing the option to update related Component Item revisions, that are referencing the Symbol Item being re-released.

Once you click OK in the Create Revision dialog, the modified symbol is released back to the server, and its associated temporary editor closed. What happens next depends on how many Component Item revisions are involved in the update:

• Single Component Item Revision - the revision of the component is opened in the Component Editor for direct editing (in Single Component Editing mode), with the latest revision of the just-released Symbol Item loaded (referenced) ready.

Example of pushing a change made to a Symbol Item, through to a single Component Item Revision that references it.

• Multiple Component Item Revisions - the revisions of the components are opened in the Component Editor for direct editing (in Batch Component Editing mode), presenting the following:
  • Definitions for all components that are associated to (reference) the Symbol Item.
  • The Model Links region shows the latest (just released) revision for that Symbol Item.
  • The entry for the linked model - in the applicable Models field of each component definition - is set to use that latest revision of the just-released Symbol Item.

Example of pushing a change made to a Symbol Item, through to multiple Component Item Revisions that reference it.

Unless you need to make any further adjustments, click the  button (on the Quick Access Bar, or from the Component Library Standard toolbar), to release the modified component(s) into new revision(s) of the corresponding Component Item(s), back in the target server:

• If only a single Component Item Revision is affected, the Edit Revision dialog will appear. Change Name, Description, and add release notes as required. After clicking OK, the release will proceed, and the temporary Component Editor then closed.
• If multiple Component Item Revisions are affected, the Release Manager dialog will appear. This lists all component Items that are scheduled to be released - by default all enabled for inclusion in the release. Make any changes - to Name, Description, and inclusion (Enable option) - as required, then click the Release Items button. View the impending release changes in the subsequent Confirm Release dialog, then click OK. Once the release process completes - indicated by Release Succeeded in the applicable Action-Status field(s) - close the dialog. The temporary Component Editor will also then be closed.

Downloading Released Data

Download the data stored in a revision of a Symbol Item by right-clicking on that revision (in the Explorer panel) and choosing the Operations » Download command from the context menu. The schematic library file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision ID. The file can be found in the Released folder therein.

Migrating Existing Model Libraries

Main page: Streamlined Migration of Existing Libraries to Your Managed Content Server

Models can also be created in the managed content server as part of migration of existing libraries of components. Altium NEXUS, in conjunction with your managed content server, provides a streamlined, simple process to quickly migrate your existing libraries to that server. The GUI to this process - the Library Migrator view - presents an intuitive flow that takes initial selected libraries, and migrates them to a target managed content server. Catering for all types of libraries relating to older component management methodologies - SCHLIB, PCBLIB, INTLIB, DBLIB, SVNDBLIB - the Library Migrator is the perfect solution to quickly building your company's set of server-based managed components, and the many benefits that such components enjoy (high-integrity, lifecycle management, centralized storage and management, where-used functionality, ease of design resuse). And while the migration process can be configured - giving you enhanced control over how that migration is performed - at its most simplistic, you can accept the default settings and set the migration in motion within a matter of clicks.

While access to the Library Migrator is available in Altium NEXUS, should you wish to access an unmanaged library to make pre-migration tweaks, or access the Available Libraries list, you will need to enable the use of legacy, unmanaged component management methodologies. Use of unmanaged content is disabled by default in Altium NEXUS, as it is not recommended. You can restore this functionality by enabling the following option in the Advanced Settings dialog - accessed by clicking the  button, on the System - General page of the Preferences dialog:

• Legacy.UnManagedLibraries

You will need to restart Altium NEXUS for the change to this settings to take effect.

All information that is present in an original source library is migrated, in order to arrive at a folder of unified components (managed components that have assigned part choices), with all referenced domain models (schematic symbols, PCB footprints, 3D models, simulation models), and parametric information. Component templates can even be created, and used to create those managed components. And if your original components have multiple PCB footprints defined, you can rest assured that the Library Migrator will bring those models across, and keep the current default footprint too.

The Library Migrator view - the user interface to the component migration process.