Component

Parent page: Working with Managed Components

Once all prerequisite domain models have been created and released into your managed content server, a design component can be defined and released into that Server for reuse in design projects. Revision-controlled and lifecycle-managed, a company can authorize a set of such Component Items - or Managed Components - that can be formally used by their designers.

This document focuses on bringing the required pieces together to define and release a component into a managed content server.

Component Items are created directly from within the Server. Once a Component 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 designs.

Folder Type

When creating the folder in which to store Component Items, you can specify the folder's type. This has no bearing on the content of the folder - releasing a component will always result in a corresponding Component 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 Component Items, set its Folder Type as Components, when defining 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 Component Item in which to store your component, ensure that its Content Type is set to Component, in the Create New Item dialog. If you are creating the Item in a Components type folder, this Item type will be available from the right-click context menu when creating the Item.

Creating a Component Item within a Components folder - while the correct Content Type is available on the context menu (Component command), using this will take you into
item-less component creation mode. To create a traditional Item using the Create New Item dialog, choose the Other Item Type command from the menu instead.

Releasing a Component Definition

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

A component can be edited and released into the initial revision of a newly-created Component 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 the same great integrity you've come to expect, and in a manner that greatly expedites changes to your data.

When you create a Component Item, you have the option to edit and release a component 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 Component Editor will open, in its Single Component Editing mode, with the controls to define the component presented in the main design window. The document tab for the view will reflect the Name you have assigned to the component.

Example of editing the initial revision of a Component Item, directly from the managed content server - the temporary Component Editor provides the controls with which to
define your component (shown in its default Single Component Editing mode).

Use the Component Editor to define the component as required. The Editor supports two modes of operation - Single Component Editing mode (the default), and Batch Component Editing mode. For more information see Defining the Component.

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 Component Library Standard toolbar:

•  - Save Active Document. Use this button to save any changes made to the component. 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 component to the managed content server, storing it within the initial (planned) revision of the target Component Item. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. The editor will close after the release. The source component definition will be stored in the revision of the Item.
•  - Cancel Editing. Use this button if you wish to cancel editing. The editor will close, and nothing will be released to the target Component 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 component definition. In the Explorer panel, switch to the Preview aspect view to see full definition data, including referenced models, component template (if used) and parametric information.

Browse the released revision of the Component Item, back in the Explorer panel. Switch to the Preview aspect view to see information including referenced models, component
template (if used) and parametric information.

Item-less Component Creation

The use of Component Templates provides an efficient means for creating components using ratified templates, however there is a drawback. Since the item is created first, the information in the template (i.e. naming scheme, revision scheme and lifecycle definition) are not assigned since the component item is already created. In order to alleviate this, the managed content server, in conjunction with Altium Designer, supports item-less component creation. This does not mean an item is not created, but rather an instance of the Component Editor is accessed directly, which allows the template details to be applied prior to adding and releasing the required component. The actual component item (and planned revision) is created as part of release preparation.

Item-less component creation is available from within an existing folder for Component Items (folder type must be Components). There are two ways to enter item-less component creation mode:

• By using the Create Item » Component command from the Item region's right-click menu.
• By clicking the  button, located at the top-right of the Explorer panel.

Accessing Item-less component creation mode.

On entering this mode, a temporary (direct editing) instance of the Component Editor (in its default Single Component Editing mode) will be opened, ready to define the component. The default presentation and information loaded depends on whether a component template is involved.

• If the mode is accessed from a folder of components and that folder has a component template attached, then model and parametric data, as well as defined Lifecycle Definition, Revision Naming, and Component Naming, will be brought in from that template. The Default Folder will be the folder from which the mode was launched. If a default Name has been specified in the template, this will be used to name the component, and also appear in the tab for the Component Editor's document view. If no default name has been specified, the tab will display New Component, and the component's Name will be blank.
• If the mode is accessed from a folder of components and that folder has no component template attached, then a default component with default settings will be presented. If the source folder has a defined Item Naming Scheme, then this will be used to create the component's unique ID. The Default Folder will be the folder from which the mode was launched. All other definition information (models, parameters, component type) must be manually specified. The tab for the Component Editor's document view will display New Component, and the component's Name will be blank.

By way of example we'll just consider the first scenario. After all, getting the component template used is why this mode was created. Just remember, that while the process will be very similar for the other scenario, you will just need to do more manual work if not using a template.

Example component created after launching the item-less component creation mode from a folder (Schottky) that has a component template
assigned to it. The component is defined with the information from the template. Roll over the image to see the referenced Component Template.

Make any adjustments to the component as required, including the addition of Part Choices.

With the component defined, click the  button (on the Quick Access Bar) to release the component to the Server. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. The editor will close after the release.

Your new component will be available to view in the Explorer panel.

Defining the Component

Main pages: Component Editor - Single Component Editing Mode, Component Editor - Batch Component Editing Mode

A component is defined/edited using the Component Editor. This editor provides two different modes of operation:

• Single Component Editing mode - provides a streamlined interface when defining/editing a single component. This is the default mode when creating a new Component Item, or editing a single revision of an existing Component Item.

Example showing definition of a component, with the Component Editor in its Single Component Editing mode.

• Batch Component Editing mode - provides the interface for defining/editing multiple components. You can access this mode by choosing the Tools » Switch to Batch Editor command, from the Component Editor's main menus. This mode is also accessed if you have selected multiple Component Item revisions for editing, from the Explorer panel. Each component definition will have a common set of parameters and links to required domain models. Batch editing comes into its own where it makes sense to manage components as a set, such as a set of chip resistors for example.

Example showing definition of a component, with the Component Editor in its Batch Component Editing mode. While you can use this mode to edit a single component (as shown),
its power really comes when editing multiple components that share the same parameters and models.

Referencing a Component Template

Related page: Managed Component Templates

Helping to streamline the creation of your managed components, Altium Designer, in conjunction with your managed content server, supports the use of Component Templates. Just as a schematic template can be used to predefine information on schematic sheets that reference it, a component template is referenced by a managed component, and provides predefined settings for use when defining that component.

Using a revision of a Component Template Item - or rather referencing one from the revision of a Component Item you are currently editing - can be performed in the following ways.

Manually from within the Component Editor

Reusing a revision of a Component Template Item from the Component Editor, depends on the operating mode of the Editor.

In Single Component Editing Mode

When editing a single component in this mode of the Component Editor, choose the required Component Template from the drop-down menju associated to the Template field - part of the Advanced Settings grouping, in the Component region of the Editor. All Component Template Items currently available in the same managed content server in which the Component Item itself resides are listed - by name - with their latest revisions indicated in brackets. Choose the required template to have it applied.

Quickly linking a Component Template Item from a menu of all available templates, when editing the revision of a Component Item using the Component
Editor in its Single Component Editing mode.

In Batch Component Editing Mode

There are two ways of 'hooking up' a revision of a Component Template Item, to the Component Item Revision currently being edited:

• From the Template tab of the Document Options dialog (Edit » Document Options). Click the Choose button to the right of the Item Revision field. This gives access to the Choose Item dialog (an incarnation of the Explorer panel). Use this dialog to browse to, and select the revision of the required Component Template Item. After clicking OK, a link will be created between the revision of the Component Item and the target revision of the Component Template Item. Evidence of this link can be seen back on the Template tab of the Document Options dialog.

Manually linking a component to a revision of a Component Template Item, in the target Server.

• From the Add menu associated with the Required Models/Parameters region of the Component Editor. The Templates sub-menu lists all Component Template Items - by name - currently available in the same managed content server in which the Component Item itself resides, with their latest revisions indicated in brackets. Click on an entry to create a link to the latest revision of that Component Template Item. Once again, verification of the link can be seen on the Templates tab of the Document Options dialog.

Quickly linking a Component Template Item from a menu of all available templates.

Inherited from the Components Server Folder

You can specify a Component Template Item to be automatically used for all Component Items (and revisions thereof) stored within a Components folder within the Server.

Specify the required template using the Component Template field, when defining the folder's properties, in the Edit Folder dialog. The field's associated drop-down lists all Component Template Items - by name - currently available in the same managed content server in which the Components folder itself resides, with their latest revisions indicated in brackets. Choose an entry to create a link to the latest revision of that Component Template Item, for each subsequent Component Item created within that folder.

Specify a default Component Template Item, to be applied to all Component Items created within the parent Components folder.

If a Component Template is chosen at the folder level, that same template will be used, by default, when Component Items are created in child sub-folders below. This facilitates quick template inheritance to all Items in child folders.

Impact on Component Models and Parameters when using a Component Template

When editing a revision of a Component Item, and a revision of a Component Template Item is linked to/referenced, the following happens within the Component Editor, with respect to models and parameters:

• The models defined within the referenced template are added to the Models region (Single Component Editing mode) and Model Links region (Batch Component Editing mode).
• An existing referenced model will be kept, and the component will remain using that model, unless purposefully changed manually.
• The parameters defined within the referenced template are added to the Parameters region (Single Component Editing mode) and Required Models/Parameters region (Batch Component Editing mode).

Example of parameters after linking to a revision of a Component Template Item, when using the Component Editor in
Single Component Editing mode (left) and Batch Component Editing mode (right).

All parameters originating from the referenced Component Template Item are distinguished by use of the  icon (Single Component Editing mode) and  icon (Batch Component Editing mode). In addition, and for Batch Component Editing mode only, the Show option for each template-based parameter follows the state of the corresponding Visible option in the template.

• An existing user-defined parameter that has the same name as a parameter in the linked Component Template Item, will be replaced with the template version. Any existing value for that parameter will be kept (and not overwritten with the value in the template).
• In Batch Component Editing mode only, template-based parameters that are set to be shown are grouped together in the component definitions area of the editor, with Template Parameters used as the header text.

Appearance of example template-based parameters in the area where the component definitions themselves are defined, when using the Component Editor in its Batch Component
Editing mode.

• The value fields for template-based parameters that have been marked as read-only, will be non-editable. For all other template-based parameters, that have not been marked as read-only, you are free to change the values as required.

With the Component Editor in Single Component Editing mode, a Read-only template parameter is distinguished in the Parameters region by use of the  icon.

• If a template-based parameter has been marked as required, but has not been given a value in the template, its value field will appear with a red border (in Batch Component Editing mode) or containing the  icon (in Single Component Editing mode), alerting you to the fact that a value is required for this parameter. You will not be able to release a component until values are defined for all required parameters.

With the Component Editor in Single Component Editing mode, a required template parameter is distinguished in the Parameters region by use of the  icon.

Parameter List Templates

If you are not using Component Template Items, you can still create predefined listings of parameters through the Component Editor's support for customizable Parameter List Templates. These simple, humanly-readable files can be built with a list of required parameters, that can then be loaded into the editor with a single click.

Parameter list templates can be found in the Templates sub-menu - accessed by clicking the Add control at the bottom of the Required Models/Parameters region. A number of predefined templates are available, covering parameter sets associated with capacitors (Capacitor), resistors (Resistor), diodes (Diode) and transistors (Transistor).

Access parameter templates from the menu associated to the
region's Add control.

Click on the template you wish to use - the parameters defined within that template will be added to the region.

Adding a set of parameters for use by your component(s) is
expedited through the use of parameter templates.

Template Definition

A parameter template is defined in a Component Library Template file (*.cmplib_template). To be recognized by the system, and therefore appear in the Templates sub-menu within the Component Editor, these files must reside in the Templates folder of your Altium Designer installation (\Users\Public\Documents\Altium\AD<VersionNumber>\Templates for a default installation).

The template definition is straightforward, consisting of the name for the template (as it is to appear in the sub-menu) enclosed in square brackets, followed by a listing of the required parameters, in the format <ParameterName>=. By way of example, the predefined template for resistors - resistor.cmplib_template - has the following definition:

[Resistor]
Category=
Manufacturer=
Manufacturer Part Number=
Mounting Type=
Temperature=
Package Type=
Package Reference=
RoHS=
Temperature Coefficient=
Tolerance=
Weight=
Height=
Value=
Power=
Resistance=
Composition=

Re-releasing a Component Item

At any stage, you can come back to any revision of a Component Item in the Server, and edit it directly. Right-click on the revision and choose the Edit command from the context menu. Once again, the temporary Component Editor will open - in its Single Component Editing mode - with the component definition contained in the revision opened for editing. Make changes as required, then commit the release of the component into the next revision of the item.

Accessing the command to launch direct editing of an existing revision of a Component Item.

Downloading in IntLib Format

You also have the ability to download one or more components from your managed content server, into an Integrated Library (*.IntLib). And when placing components from such an Integrated Library, the actual links are back to the Component Items in the Server. This gives you the ability to effectively use your company's managed components in an offline fashion, while ensuring the design still maintains a true connection to those components in the source managed content server.

To be able to use this functionality in Altium NEXUS, you will need to enable the use of legacy, unmanaged component management methodologies, as well as the Libraries panel. 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 options in the Advanced Settings dialog - accessed by clicking the  button, on the System - General page of the Preferences dialog:

• Legacy.UnManagedLibraries
• Legacy.LibraryPanel

You will need to restart Altium NEXUS for the changes to these settings to take effect.

From the Explorer panel, the process to download into an IntLib is as follows:

1. Browse to the folder containing the component(s) you want to download.
2. Select the revision of the Component Item(s) you want to inlcude in the download. You can only choose one revision of a particular Component Item (typically the latest revision), but can include as many different Component Items in the download as required.
3. Right-click on an entry in the selection and choose the Operations » Download command from the context menu.
4. In the Save As dialog, specify the name, and location, for the generated IntLib file. By default, the file will be named in the format Integrated_Library - <Date> - <Time>.IntLib.
5. Once ready, click the Save button to proceed with the download, and generation of the IntLib. A temporary Integrated Library Package (*.LibPkg) will be created, with source SchLib (with symbols, parameters and model links) and PcbLib (with footprint models) files generated and added. This is then compiled to produce the IntLib file, which is generated in the specified folder. An information dialog will confirm successful generation of the file.

Example download (albeit a single component!) into an Integrated Library.

Use of the IntLib

After generation, the IntLib is added to the Installed Libraries list - part of the Available Libraries for the software. It will be available for use from the Libraries panel. Place components from the IntLib into your design as required. While effectively working with the components 'offline', the links back to the original Server components ensure continuity when you come back to working 'online' directly from your managed content server.

Example generated IntLib, offering the component downloaded from your company managed content server. Once placed, the component is still linked back to the original server component.

Migrating Existing Model Libraries

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

Altium Designer, 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, as well as the Libraries panel. 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 options in the Advanced Settings dialog - accessed by clicking the  button, on the System - General page of the Preferences dialog:

• Legacy.UnManagedLibraries
• Legacy.LibraryPanel

You will need to restart Altium NEXUS for the changes to these 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 foot prints, 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.