Batch Component Editing in Altium Designer

A Workspace component is defined/edited using the Component Editor, which can operate in two modes – Single Component Editing and Batch Component Editing. The latter provides the interface for defining/editing multiple components, but can be used to define/edit a single component, should you wish. With the Component Editor in its Single Component Editing mode, access to batch editing mode is made by choosing the Tools » Switch to Batch Editor command, from the Editor's main menus.

The Component Editor in its Batch Component Editing mode is also accessed if you have selected multiple components for editing from the Components panel or 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.

This document looks at working with the Component Editor in its Batch Component Editing mode.

Interface Overview

In its Batch Component Editing mode, the Component Editor interface is essentially divided into four main regions, illustrated in the following image and summarized thereafter.

The Component Editor, when switched to operate in its Batch Component Editing mode, can be divided into four key regions.

1. Required Models/Parameters – where you define what type of domain models are required by the component definition(s), as well as the place to craft a set of parametric data that will be applied to all component definitions.
2. Model Links – where you add links to saved domain models, for use in component definitions.
3. Preview Window – providing a preview of the currently selected model. This will be graphical for a symbol and footprint, and textual for other model types.
4. Component Definition(s) – this is where a component is defined, including its folder, name, type, referenced domain models, parametric data, and part choice(s).

The Required Models/Parameters and Model Links regions can be horizontally collapsed by clicking the control at the respective top-left. In addition, the top three regions can be collapsed, leaving just the Component Definitions region by using the control at the top-right.

Document Options

Controls for specifying the target Workspace folder in which the components will be created, and also the lifecycle definition and naming schemes to be employed for those components, are available in the Document Options dialog (Edit » Document Options). You also can define a default Component Naming scheme for components released from the Component Editor, ensuring a unique ID for each resulting component in the Workspace.

Workspace settings are defined through the Document Options dialog.

• Target Server – if creating one or more new components, the target Workspace will be the one to which you are actively connected. When editing existing components, this field will reflect the Workspace in which those components reside. Click the Server Admin button to the right of the drop-down (available if the component(s) have yet to be released) to access the Data Management – Servers page of the Preferences dialog, from where you can browse and manage your active and known Workspace.

  While you can be connected to various Workspaces, you can only be actively connected to one Workspace at a time.
• Default Folder – when creating one or more new components, use this field to specify a default folder within the target Workspace in which to store the saved component(s). Do this by clicking the Choose button to access the Choose Folder dialog – an incarnation of the Explorer panel, from where you can browse to and choose an existing folder in the Workspace, or create a new one on-the-fly. The entry here will be used by default for the FolderPath when adding a new component definition. If editing the revision of one or more existing components, this field will reflect the existing folder and will be non-editable. In this case, the Choose button will also be unavailable. Click the Show in Explorer button to quickly browse to the specified default folder in the Explorer panel.

• Lifecycle Definition and Revision Naming – use these fields to set a suitable default scheme in each case (Component Lifecycle and 1-Level Revision Scheme respectively). Use the drop-down associated with each field to choose a different scheme, from any of the currently defined schemes available for the parent Workspace.

  If the option to control use of lifecycle definitions and revision naming schemes per content type is enabled for any definitions/schemes, and the Component content type is not set to use a particular definition/scheme, then that definition/scheme will not be available in the applicable drop-down list.

• Item Naming – this field is used to define a default Item Naming Scheme for components saved from the Component Editor, ensuring a unique ID for each resulting Component Item in the Workspace. The entry here will be used as the template for automatically naming a newly-added component definition (in its associated Item ID field). The software will automatically assign the next available unique ID, based on that scheme, having scanned the entire Workspace and identifiers of existing content.

  If the parent folder in which a component resides (or is being created) has a defined naming scheme, then this will be pre-filled as the default. If not, then the default scheme – CMP-{00000} – is provided. You can of course create your own scheme by typing it within the field. Support is available for the use of parameter-based Component Name Templates. Such templates allow you to precisely name, or rather rename your components, based on the currently defined values of parameters available to those components in the Component Editor. Include a parameter into the naming template using the format [<ParameterName>]. Multiple parameters can be used in a template, and you can also add an iterator macro, specified within curly braces (e.g., {000}, {00A}).

  Alternatively, you can override the auto-assigned ID for a component by entering the ID required directly in the Item ID field for a definition. You always have full control and final say over how the Items are identified.

The dialog also provides the means to reference a defined Component Template. Choose a template using the controls available on the dialog's Template tab. A Component Template provides predefined settings for use by component definitions defined within the Component Editor. Any additional component definition that you add will be created in accordance with the associated component template.

Required Models/Parameters

This region of the editor is used to specify which domain models are required by the component definition(s), as well as the place to craft a set of parametric data that will be applied to all component definitions.

Define required models and parameters.

• Models – at the most basic level, a component used in board design requires representation in the schematic and PCB editing domains. It therefore needs schematic symbol and PCB footprint models. These then are added as required models by default and cannot be removed. Use the Add and Remove controls for the region to add/remove other model types as required.

  Specifying a model type does not mean the component definition has to use it, but rather adds a field for that model type to the component's definition.
  Notice that the PCBLIB entry is available from the list. This allows for a component to have different PCB footprint models associated with it. In addition, the PCBLIB (default) parameter allows you to specify the default footprint model for a component.
• Parameters – two default parameter entries exist – Name and Description. These are system parameters. Any number of additional parameters may also be added as required. To do so, click the Add control at the bottom of the region, then choose the Parameter entry. A new parameter will be added to the list. Click inside the Parameter Name field to change the name as required. To remove a parameter, select it and click the Remove control. The system parameters cannot be removed.

This region of the editor, through the Add menu, also facilitates the following:

• Linking to a Component Template – the Templates sub-menu lists all Component Templates currently available in the same Workspace in which the component itself resides. Click on an entry to create a link to the latest revision of that Component Template. Parameters from the template will be brought into this region, and are distinguished by use of the icon.

  Parameter List Templates

  If you are not using Component Templates, 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.

  Component Templates offer a far more powerful approach to organizing not only a set of parameters but also required models and the ability to define component types. In addition, it is only through Component Templates that you can define unit-aware parameters for your components, which are needed for the advanced component searching functionality. To this end, if you have at least one component template present in your Workspace, the parameter list templates functionality will be disabled, and you will not be able to see and load these templates into the Component Editor.

  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.

  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=1
Mounting Type=
Temperature=
Package Type=
Package Reference=
RoHS=
Temperature Coefficient=
Tolerance=
Weight=
Height=
Value=
Power=
Resistance=
Composition=

  The '=' sign is required to have the parameter added to the list of Required Models/Parameters when the template is used. If it is removed in the template file, leaving just the parameter name, it will be excluded when the parameters are added.

  Any number of parameter templates may be defined within a single template file. This can be seen in the file group.cmplib_template, which contains the templates for capacitors and diodes.

  If the same template ([<TemplateName>]) is defined more than once in the same .cmplib_template file, only the first instance will be used. The software also ensures that there is no duplication of parameters where parameters from more than one template are added. If a parameter to be added is already existing with an exact matching name, it is ignored when that template is loaded.
• Enabling the use of Datasheets – choose the Datasheet entry to do this. For more detail, see Attaching Datasheets to Component Definitions.
• Adding Part Choices – use the Part Choices sub-menu, and choose By MPN. An entry will be added – Part Choice n – to the definitions area, with two columns – Manufacturer and Part Number, with which to specify the choice. Alternatively, if your Workspace supports it and you have configured a custom database part source, choose the By Internal ID menu entry. An entry will be added – Part Choice n – to the definitions area, with two columns – Part source and Internal ID, with which to specify the choice of part from your company's internal parts database. For more information, see Part Choices.

Model Links

This region of the editor is used to add links to saved domain models, for use in component definitions. The Model Links 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.

The Model Links region, packed with functionality to streamline model link definition and assignment to the component definitions.

Use the following collapsible sections to learn more about working with model links.

Column-based Filtering

Like an Excel spreadsheet, the model links can be further filtered by the contents of each column. To do this, click the small funnel (filter) icon, located at the right-hand side of a column header (). A menu will appear containing a checkbox for each value present in that column. Enable the required checkbox(es) to reduce the list to only include model links with that value.

Alternatively, for greater filtering control select (Custom...), which displays the Custom Filter dialog. Use this dialog to setup a custom filter to meet your requirements, by specifying which rows of information you want to show based on filter criteria you apply to the data column.

Choose to apply standard or customized column filtering.

When a column filter is applied, the filter icon is displayed in blue (), indicating that there is filtering applied based on that column. Filtering can be applied to multiple data columns. Each 'column filter' becomes an ANDed condition in the overall filter. A textual representation of the filtering currently in effect will be presented at the bottom of the region.

An example of column filtering in action.

To clear filtering for a column, choose the (All) entry from the filtering drop-down. To clear filtering completely, click the button, to the left of the textual representation of the filter. To disable the filter, uncheck the check box to the left of its textual representation. To enable again, check the check box.

Within an editing session, the history of just used filters is available. Click the button to the right of the textual representation of the current filter to display the history. The history list is cleared when the temporary Component Editor is closed.

To further customize the current filter, click the button, to the far right of the textual representation of the filter, to open the Filter Builder dialog. Use this dialog to create more sophisticated and complex filters as needed.

Use the Filter Builder dialog to create more sophisticated filtering.

Commonly used filters can be saved and re-used. This is done in the Filter Builder dialog by clicking the button to save the current filter in a Filters file (*.flt). Click the button to reload a previously saved filter.

Component Definitions

Once you have specified the set of parameters, and have your 'bucket' of model links at the ready, you can proceed with definition of the required component(s). This is performed in this lower region of the document.

Define your components in a logical and intuitive way using the Component Editor.

What is actually presented in this region initially, will depend on the component(s) being edited:

• When creating a new component, and a Component Template is not referenced from the parent folder, the entry will have the FolderPath and Item ID assigned, but that's it – a blank canvas as it were.
• When creating a new component, and a Component Template is referenced from the parent folder, the entry will have prefilled definition information provided by that template.
• When editing a revision of an existing, single component, and you have switched from Single Component Editing mode, that revision will be presented, along with whatever information has been defined for it at that stage.
• When editing multiple chosen revisions of components – and thereby accessing Batch Component Editing mode directly – all of those revisions will be presented.

Each component definition appears as a single row entry containing the following information:

• Component: FolderPath – use this field to save the component to a specific folder in the target Workspace. For each newly added component to the grid, this field can be populated with a default location, if specified in the Default Folder field in the Document Options dialog (Edit » Document Options). Whether or not a default path is specified, you have full control over where in the target Workspace a component will be stored. To manually specify a target folder, click once inside the FolderPath field for a component to reveal the button, and click to access the Choose Folder dialog. Browse to, and choose an existing folder, or create a new one on-the-fly.

  Taking the time to carefully determine folder paths for your components ensures they are saved into the correct destination folders from the outset. However, content can be easily moved to any folder in the Workspace structure, post save, if need be.
  This field will be read-only if the component has already been saved to the Workspace. If you use the Clear Link To Target Item command (on the right-click Operations sub-menu), the link to the existing Item in the Workspace will be cleared. The fields of the component definition will revert back ready to create a new Item, and the FolderPath field will become available for editing.

• Component: Item ID – this field is used to determine the ID used for the saved component in the Workspace. For each newly added component to the grid, this field is populated in accordance with a default naming scheme, specified in the Item Naming field in the Document Options dialog. The software will automatically assign the next available unique ID, based on that scheme, having scanned the entire Workspace and identifiers of existing content.

  A default Item naming scheme – CMP-{00000} – is provided, but you can of course create your own scheme by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. CMP-001-{0000}). Alternatively, you can override the auto-assigned ID for a component by entering the ID required directly in the Item ID field for a definition. You always have full control and final say over how the Items are identified.

  Support is also available for the use of parameter-based Component Name Templates. Such templates allow you to precisely name, or rather rename your components, based on the currently defined values of parameters available to those components in the Component Editor.
  This field will be read-only if the component has already been saved to the Workspace. If you use the Clear Link To Target Item command (on the right-click Operations sub-menu), the link to the existing Item in the Workspace will be cleared. The fields of the component definition will revert back ready to create a new Item, and the Item ID field will become available for editing.

• Component: Name – reflects the humanly-readable name given to the component. This system parameter is available and indexed when searching within the Workspace and will provide a good means to locate specific components beyond having to remember their Item ID.

  The field will populate with any default value for the Name system parameter that has been defined in a referenced Component Template.

• Component: Type – this field supports the ability to define the type of component and is a key attribute used to facilitate targeted searching of Workspace components (and which you will use heavily when browsing your components through the Components panel). Click on this field, then click to access the Choose component type dialog. Use this dialog to select the required type of component (from all currently defined types) then click OK – the chosen type will be inserted as the value for the Type attribute in the main definitions grid.

  The field will populate with any default value for the ComponentType parameter that has been defined in a referenced Component Template, or with the component type selected through the Create new component dialog, which appears when you attempt to create a new component using the File » New » Component command. The types are defined at the preferences level. Click the button at the bottom of the Choose component type dialog to access the Data Management – Component Types page of the Preferences dialog, from where you can craft this listing to better suit your needs – either by adding new types and sub-types, or editing and removing existing types.

• Component: Description – reflects the description added to the component. This system parameter is available and indexed when searching within the Workspace.

  The field will populate with any default value for the Description system parameter that has been defined in a referenced Component Template.

• Models – these fields correspond to the entries in the Required Models/Parameters region of the document. There is one field per required model that is added, with the exception of footprint models, where multiple can be defined. Each field is used to specify which of the linked models (in the Model Links region) is to be used for the component.

  Toggle the display of model columns by enabling/disabling the associated Show option for a Required Model entry respectively. Use multi-select in combination with the right-click menu options to toggle the display state of multiple model types.
  Note that a harness wiring model can be added to a component definition only when no other models are added to this component. And vice-versa, other type models cannot be added when a harness wiring model is added to the component.

• Template Parameters – these fields correspond to user parameters brought into the Component Editor from a referenced Component Template revision. There is one field per parameter. The left-to-right ordering of the parameters in a component definition corresponds to their top-to-bottom ordering in the Required Models/Parameters region. Enter or select values for parameters as required, and where applicable. For example, parameters that have been marked Read Only in the template will not be editable, while other parameters will be. And if they have been marked as Required in the template, they must be given a value, or you will not be able to save the component definition to the Workspace.

• Parameters – these fields correspond to the additional user parameters that you have entered in the Required Models/Parameters region of the document. There is one field per additional parameter. The left-to-right ordering of the parameters in a component definition corresponds to their top-to-bottom ordering in the Required Models/Parameters region. Enter values for parameters as required.

  Dynamic (item-level) parameters are not visible when using the Component Editor in its Batch Component Editing mode but they are when using the Component Editor in its Single Component Editing mode – learn more.

• Release: Current Rev. – this non-editable field reflects the current (most recent/latest) revision of the component in the Workspace.

• Release: Next Rev. – this non-editable field reflects the next revision of the component that will be created when the component definition is next saved to the Workspace, in accordance with the chosen revision naming scheme.

• Release: Action – this field shows the action that will be taken by the release manager for this particular component definition, as part of the saving process. For a component definition that has not yet been saved to the Workspace, this entry will display Create Item. For a definition that has already been saved to the Workspace, this entry will display Create Revision. If a planned revision of a component is being targeted, then the entry will display Release To Existing Revision.

• Part Choice n – this entry corresponds to a Part Choice that you have added to the Required Models/Parameters region of the document. The left-to-right ordering of the Part Choices in a component definition corresponds to their top-to-bottom ordering in the Required Models/Parameters region. There are two fields per added Part Choice, Manufacturer and Part Number, with which to specify the choice. Alternatively, if you have configured a custom database part source, and added a Part Choice using the By Internal ID menu entry, the two fields will be Part source and Internal ID. Use these to specify the choice of part from your company's internal parts database.

Working with Component Definitions

Use the following sections to learn more about working with this region of the editor, including some cool and time-saving features and functionality.

Assigning Model Links to Existing Components

For existing component definitions, the required model links can be assigned in the following ways:

• Drag and drop a model link into the relevant column of a component definition.

  
  Assign a model to an existing component using drag and drop from the Model Links region to the corresponding model column for that component.

• Use the drop-down field for a model column to access a dedicated model link pop-up window. This presents a grid of all existing model links applicable to the model type being assigned, complete with all data columns. This can be a real time saver for finding and assigning a model, where the number of component definitions hamper drag and drop techniques, or the top section of the Component Editor – housing the Model Links region – is collapsed. And this method can be used to assign the same model link to multiple component definitions – just select the model column for each component before accessing the pop-up window.

  Resize the window as required. Click and drag the control at the bottom-right of the window to resize in both directions simultaneously. Click the column control button at the top-left of the window and disable any columns you do not want to be visible. Columns can be reordered by dragging a column header.

  Use the pop-up's search field to quickly locate the model required. Dynamic highlighting based on data across any column is applied as you start to type characters. Select the model link required and either press Enter or double-click to assign that model.

  
  Use the dedicated model link selection pop-up to search, locate and assign the model required.

Creating a New Component with a Linked Model

Where a component definition does not yet exist, one can be created, along with the required model link automatically assigned, in the following ways:

• Drag and drop a model link from the Model Links region, into free space within the Definitions region, to add a new component definition that uses that model.

  
  Assign a model and add a new component on-the-fly, using drag and drop from the Model Links region.

• Drag and drop a model directly from the Explorer panel into the Definition region. A new component definition using that model will be added. In addition, if that model does not exist in the Model Links region, an entry will be added for it.

  
  Assign a model and add a new component on-the-fly, using drag and drop from the Explorer panel. The model link will be added to the Model Links region, if it does not exist already.

Adding Multiple Components

The Component Editor facilitates addition of multiple new components in one hit. Right-click and choose the Operations » Add Components command. Then, in the Add Components dialog that is presented, enter the number of components you wish to add and click OK - new component definitions for the specified number of components will be added to the component definitions grid, at the bottom of the current list of component definitions. In concert with the grids multi-cell editing support, and copy/paste features, you can quickly build an impressive array of component definitions in quick time.

Add multiple new component definitions in two quick steps.

Generating Basic Chip Resistors

You can also quickly create a batch of chip resistor component definitions by choosing the Edit » Operations » Generate Basic Chip Resistors command from the main menus or by right-clicking over the definitions region, away from any currently defined definitions, and choosing the Operations » Generate Basic Chip Resistors command from the context menu.

After launching the command, component definitions will be automatically generated for the indicated component type.

The component definitions generated by running this command will be added to those already defined. In other words, the latter are not overwritten by generation of the former.

Creating Components from a Manufacturer Part Search

Providing a boost to the creation of components, Altium Designer supports the ability to search for a real-world part, courtesy of Manufacturer Part Search functionality, and then add that part into the Component Editor. Not only do you get a new component definition entry for the selected part, but you also get all of its parameters, any datasheets, and a part choice made based on it – leaving you to just organize some domain models, set the component type, target folder, and then save to the Workspace!

This functionality is delivered through a purpose-made extension for the Component Editor – the Component From Supplier Search extension.

The Component From Supplier Search extension.

This feature is only made available, provided the Component From Supplier Search extension is installed as part of your Altium Designer installation. This extension is installed by default when installing the software, but in case of inadvertent uninstall, can be found back on the Purchased tab of the Extensions & Updates page (click on the current user control (e.g. ) at the top-right of the design space and choose Extensions and Updates from the menu).

The feature is accessed from the Component Editor's Definitions region. Right-click and choose the Operations » Create from Part Search command from the region's context menu. Alternatively, choose the Edit » Operations » Create from Part Search command from the main menus or click within the definitions area and use the keyboard shortcut Shift+Ctrl+M.

The Manufacturer Part Search dialog will appear. Search for the required part (or parts) across databases of real-world manufactured items that are offered by currently enabled Suppliers, select an entry, then click the OK button.

Access the Manufacturer Part Search dialog, and search for a part you'd like to bring in to the Component Editor.

After clicking OK, the following will occur:

• A component entry for the selected part will be created in the definitions area of the Component Editor. The definition will:
  • Be assigned the next available unique Item ID, and in accordance with the defined Item Naming scheme employed by the Component Editor.
  • Have the value for the selected part's Manufacturer Part Number parameter assigned as the value for its Name system parameter.
  • Have the value for the selected part's Description parameter assigned as the value for its Description system parameter.
• All parameters defined for the selected part (as visible for it in the dialog) will be added to the Required Models/Parameters list. All will be made visible (associated Show option enabled). This just means a column will be displayed for each, by default, in the Definitions region.
• Parametric entries will also be added for each datasheet available for the selected part (in the form of a ComponentLinknDescription and ComponentLinknURL pairing).
• A Part Choice (Part Choice 1) will be added for the definition, with the values for the part's Manufacturer and Manufacturer Part Number parameters used to fill the Manufacturer and Part Number fields of that choice respectively.

Example of the resulting definition, and added parameters, for a selected part in the Manufacturer Part Search dialog. Highlighting is used to show the data that is brought in from the Manufacturer Part.

Setting the Component Type

The Component Editor supports the ability to define the type of component when configuring a component's definition. This facilitates targeted searching through the Workspace's powerful Search facility – a facility that not only allows you to search by component type, but allows you to search smarter, with supported unit-aware component parameters. When browsing your own Workspace library using the Components panel, the Categories grouping for components is derived from the component type defined for each component.

The type of component is specified through the Type attribute in the Component region of the definitions area. Click on the Type field then click to access the Choose component type dialog. Use this dialog to select the required type of component then click OK – the chosen type will be inserted as the value for the Type attribute in the main definitions grid.

The Choose component type dialog presents a default set of component types. The types are defined at the preferences level. Click the button at the bottom of the dialog to access the Data Management – Component Types page of the Preferences dialog, from where you can craft this listing to better suit your needs – either by adding new types and sub-types, or editing and removing existing types.

Example of setting the Type attribute for a component definition to Diode.

The Type field for multiple component definitions can be set in a single action. Select the Type field for each required component definition, then choose the type for one, to apply to all others.

Support for Unit-aware Component Parameter Data Types

The Component Editor supports unit-aware component parameter data types that are defined within a referenced Component Template. You can enter a parameter's value directly into the applicable field for a component definition using a range of formats – such as 2.2k, 2k2, 4M, 2.5GHz – with the Workspace engineered with the requisite smarts to recognize the numerical value behind those entries.

This feature of a component template facilitates targeted searching through the Workspace's Search facility – a facility that not only allows you to search by component type but allows you to search smarter, with range searches. Using the power of unit-aware component parameters, you can quickly define a search, for example, to find all capacitors with a capacitance between 47uF and 220uF.

Component parameters from a referenced component template that have unit-aware data types.

When entering a value for a component parameter that uses a unit-aware data type – as the required value in a component definition – the following are things to consider:

• You can enter the value in a range of different formats: 
  • Numerical value only (e.g. 10). Note that if the data type has a unit, this will be applied automatically. Those types with units, have the unit in brackets after their name.
  • Numerical value in scientific notation (e.g. 1e10, 1E6).
  • Numerical value and units (e.g. 10F).
  • Numerical value with prefix (e.g. 10k). The appropriate unit will automatically be added (where applicable).
  • Numerical value with prefix and units (e.g. 10kF).
  • Numerical value with prefix in typical engineering format (e.g. for a resistance: 2k2, 2K2, 10r2, 10R2). The value will automatically be normalized accordingly (e.g. 2K2 will become 2.2k).
• You can enter prefix and/or units with or without a space after the numerical value (e.g., 10uF, or 10 uF). The space will be automatically stripped.

Support for Dictionary-defined Component Parameter Data Types

The Component Editor supports dictionary-defined component parameter data types that are configured within a referenced Component Template. You can select a parameter's value from the choices defined in the dictionary by clicking in the value cell and using the drop-down. You can click in the value cell and start typing a value – the drop-down will open, and the closest value will be highlighted in the list.

Component parameters from a referenced component template that have unit-aware data types.

If you are an administrator of the Workspace, click the  icon at the right of the value field to open the Settings – Vault – Dictionaries page of the Workspace's browser interface where you can manage the dictionaries. 

Using Component Name Templates

The Component Editor (in its Batch Component Editing mode only) provides support for the use of parameter-based Component Name Templates. Such templates allow you to precisely name, or rather rename your components – their Item ID – based on the currently defined values of parameters (user/template parameters – not system parameters) available to those components in the editor. Include a parameter into the naming template using the format [<ParameterName>]. Examples might be:

• CMP-[Value]

• CMP-[Part Number]

• [Part Number]-[Value]

• [Value]

• [Part Number]

You can also use multiple parametric declarations in your templates, for example:

• CMP-[Part Number]-[Value]
• CMP-[Manufacturer Part Number]-[Value]-[Tolerance]

In addition, and purely optional, you can also add an iterator macro, specified within curly braces (e.g., {000}, {00A}), for example:

• CMP-[Value]-{001}
• CMP-[Part Number]-{00A}

At the highest level, the required naming template can simply be entered as the default naming scheme into the Item Naming field of the Document Options dialog. The initial index will always be zero in this case. For greater control, select the component(s) to be renamed and choose the Edit » Operations » Rename Component (Edit » Operations » Rename n Components) command from the main menus, or right-click and choose the Operations » Rename Component (Operations » Rename n Components) command from the context menu. You will be presented with the Component Name Template dialog. Use this dialog to specify the required Naming Scheme, and control the Initial Index (where an iterator macro has been added to the template).

An example of the use of the CompanyPrtType and Value parameters in a naming template, to quickly rename selected components being defined in the Component Editor.

Part Choices

The Component Editor can be used to specify one or more Part Choices for a component – the 'allowed' manufacturer parts that can be used to implement the component on the assembled board. The actual supply chain intelligence – comprising Manufacturer (and part number), Supplier (and part number), Description, Pricing and Availability – is sourced from the Workspace's local Part Catalog and the relevant Part Source.

Add a part choice from the Required Models/Parameters region – click the Add control and use the By MPN command from the Part Choices sub-menu. Alternatively, if you have configured a custom database part source, choose the By Internal ID menu entry. Any number of part choices can be added for use.

When you add a part choice for use with the component(s) being defined, an entry will be added – Part Choice n – to the definitions area, with two columns to specify that choice. These columns will depend on the style of part choice chosen:

• By MPN – the two columns presented are Manufacturer and Part Number.

• By Internal ID – the two columns presented are Part source and Internal ID.

Adding a part choice (By MPN) for use with the component(s) being defined. Hover to see an example part choice added By Internal ID – allowing you to hook up a part from your company's internal parts database.

Enter the Manufacturer and Manufacturer Part Number – for the real-world part you want to be used when the board is manufactured and assembled – into the Manufacturer and Part Number fields respectively.

A couple of things to be aware of:

• The addition of a part choice does not mean a component definition has to use it. But if you do enter a value in one of the two fields, the other field will appear with a red border, alerting you to the fact that a value is now required before that component can be saved to the Workspace.

  

• If you make an incorrect entry for a field value, and the part can not be retrieved by the Workspace, the text will appear greyed and in italics. Once both entries are correct, the text will appear as normal, white text. Note that values are case-insensitive.

  

Dialog-based Addition of MPN Part Choices

While you can enter the Manufacturer and Part Number information directly into the associated cells for a part choice, it is far easier to use a dialog that allows you to search for a manufacturer part. To 'get at' this functionality, after adding the initial Part Choice 1 entry to the Required Models/Parameters region, click within one of the cells for that choice (associated with the required component being defined). The Preview region of the editor will present the button. Click this to access the Add Part Choices dialog, which is used in the same was as the Manufacturer Part Search panel (refer to this page for detail on the full UI elements).

Making a part choice – use the Add Part Choices dialog to search for the required manufacturer part, select its entry and click OK.

Use the dialog to search for the required manufacturer part, select a part, then click the OK button. Click the SPNs entry for a manufacturer part – Supplier Part Numbers – to see the available suppliers of that part, and assess whether you are making the right part choice, based on availability, pricing, etc. The chosen part will be entered back into the Component Editor – both in the cells of the Part Choice 1 entry, and in the Preview region.

Example part choice – added through use of the Add Part Choices dialog – presented back in the Component Editor.

Continue to add further part choices as required by clicking the button – the associated Part Choice n entry will be created automatically.

To remove a part choice, select it in the list, then click the button.

Attaching Datasheets to Component Definitions

One or more datasheets can be attached to one or more components, while defining component(s) through the Component Editor. This, for example, allows you to quickly attach the same required datasheet(s) to all components in a particular family.

Linking various datasheets, as seen from the perspective of editing a component in the Component Editor.

Attaching datasheets to a component definition involves a sequence of steps, summarized here and detailed in the sections thereafter:

1. Enabling the use of datasheets.
2. Uploading datasheets to a selected component.
3. Assigning uploaded datasheets to other component definitions.

Validation Checking of Component Naming

The software validates the IDs of components that are being created by multiple users for saving to a Workspace, and thereby prevent duplicated Item ID issues. When a user creates a Component Item, the assigned Item ID is 'locked', preventing another user from using that ID, even if the first user has not, or does not, save that component to the Workspace. If other users change the Item ID manually as part of their component definition – to one that is currently used by an existing Item (or an intended-to-be-created Item), the ID will be changed for the next available, unused ID, in accordance with the applicable naming scheme.

Cloning a Component Definition

Facilitating the ability to quickly create component definitions that differ slightly from one another, the editor provides cloning functionality. To clone an existing definition, select it in the list of definitions and choose the Edit » Clone Component command from the main menus or right-click and choose the Clone Component command from the context menu (shortcut: Ctrl+D). The clone will be added to the bottom of the list of definitions.

The clone will be an exact replica of the original source component definition, in terms of:

• Targeting the same folder within the Workspace – the folder in which the original component exists, or targets (if not itself saved as yet).
• Referencing the same domain models.
• Having the same values for Name, Description, Type, template parameters, and any additional user-defined parameters.

It will differ in terms of:

• Not having any datasheets that were defined for the original component.
• Not having any part choices that were defined for the original component.
• Having the next available unique Item ID.
• Being set to be saved into the initial revision of a new Component Item (Action set to Create Item).

An example of cloning a component definition – once cloned, make any changes as necessary, for example to the values of one or more parameters, defining part choices, and adding any datasheets as necessary.

Once cloned, make any changes as necessary, e.g., to the values of one or more parameters.

Grouping Component Definitions

Component definitions can be grouped based on any of the visible column headings. To do this, click and hold on a column header, then drag and drop it onto the text that says Drag a column header here to group by that column.

For example, the following image illustrates the component definitions being grouped by the Case-Metric parameter. Doing so separates the component definitions into as many groups as there are different values in the grouping column – in this case, nine groups are created.

Grouping the component definitions based on the values in a column, in this case by the Case-Metric parameter.

Sorting Component Definitions

Component definitions can be sorted by a specific column by clicking on that column's header. Click once to sort in ascending order (based on the content of that column). Click again to sort in descending order.

You can sort by multiple columns. With the component definitions already sorted by a specific column, Shift+Click on another column to 'sub-sort' by the content of that column.

Column-based Filtering of Component Definitions

Like an Excel spreadsheet, the component definitions can be further filtered by the contents of each column. To do this, click the small funnel (filter) icon, located at the right-hand side of a column header (). A menu will appear containing a checkbox for each value present in that column. Enable the required checkbox(es) to reduce the list to only include component definitions with that value.

Alternatively, for greater filtering control select (Custom...), which displays the Custom Filter dialog. Use this dialog to set up a custom filter to meet your requirements, by specifying which rows of information you want to show based on filter criteria you apply to the data column.

Choose to apply standard or customized column filtering.

When a column filter is applied, the filter icon is displayed in blue (), indicating that there is filtering applied based on that column. Filtering can be applied to multiple data columns. Each 'column filter' becomes an ANDed condition in the overall filter. A textual representation of the filtering currently in effect will be presented at the bottom of the region.

An example of column filtering in action.

To clear filtering for a column, choose the (All) entry from the filtering drop-down. To clear filtering completely, click the button, to the left of the textual representation of the filter. To disable the filter, uncheck the check box to the left of its textual representation. To enable again, check the check box.

Within an editing session, the history of just used filters is available. Click the button to the right of the textual representation of the current filter to display the history. The history list is cleared when the temporary Component Editor is closed.

To further customize the current filter, click the button, to the far right of the textual representation of the filter, to open the Filter Builder dialog.

Use the Filter Builder dialog to create more sophisticated filtering.

Use this dialog to create more sophisticated and complex filters as needed:

• Filter - click to access additional filter conditions. Click Clear All to clear all filters. Choices are:
  • Add Condition - click to add a filtering condition, such as equals, between, etc.
  • Add Group - click to add a filtering group, such as AND, OR, etc.
• Links - click the various links to further define the filter.
  • Id - click the various links to choose the desired item by which to filter, for example, Description, Name, etc.
  • AND, etc. - click the various links to specify the logical operator/type, for example, OR, etc.
  • like - click the various links to specify the operator, such as equals, is blank, is greater than, etc.
  • <empty> - click the various links to add a condition value. Enter the desired value in the textbox after clicking the link.
• press the button to add a new condition - click to add an additional condition.

Commonly used filters can be saved and re-used. This is done in the Filter Builder dialog by clicking the button to save the current filter in a Filters file (*.flt). Click the button to reload a previously saved filter.

Presentation of Data

Depending on the type of components being defined, there could be a sizeable number of parameters, all of which, when added to the other columns of data, can create a veritable tangle of partially-legible content. Addressing this, a couple of display modes are available for the component definitions region. Switch between modes using the control at the bottom-right of the region.

• Best Fit – in this mode, each column of data is sized to display all data within it, in accordance with the largest data entry and adding a little padding for good measure. Since each column is sized to display its data, the columns can collectively extend beyond the currently viewable area. In support of this, a horizontal scrollbar is provided to allow ease of reading.
• Auto Width – in this mode, the software will attempt to display all data columns within the viewable area of the grid, stretching or condensing as needed. This mode works fine when there are not so many data columns, but legibility can suffer when a greater number of columns are present.

Example use of the Auto Width and Best Fit presentation modes.

Component Definitions – Editing Techniques

Depending on the components you are creating, the Component Editor may end up containing a sizable number of component definitions. In some cases, these definitions may differ only slightly and many may require similar model or parametric information. The document supports various editing features that enable you to quickly effect changes to one or more component definitions.

• Multi-cell editing is implemented for models and parameters. Multiple data cells within a column can be selected for operation using standard Ctrl+Click and Shift+Click keyboard functionality. To assign a model to multiple components, select the range of cells, then click the drop-down to display the model link pop-up window. Double-click on the required model in the pop-up, this model will then be assigned in all selected model cells.

  For parameters, select the required cells within the same column, then enter the required value for the focused cell and either click away, or press Enter. All cells in the selection will receive that same value.

  This feature can also be used for the FolderPath. Select the entries in the FolderPath column for the applicable component definitions, click the button for the focused entry, and choose the required target folder in the Choose Folder dialog. All selected definitions will have their FolderPath changed to point to this folder.

• You can cut, copy and paste data between selected data cells using Ctrl+X, Ctrl+C and Ctrl+V respectively (or the corresponding commands on the right-click menu or the main Edit menu).

  If the target cell is incompatible with the clipboard data, the paste will not happen (for example, when pasting parametric data into a model link field).

• You can clear the contents of selected data cells using the Delete key (or the Clear Contents command on the right-click menu or the Edit » Clear Contents command from the main menus).

  If the Component Library document references a Component Template, keep in mind that:

  • If a parameter is marked as Read Only in the template, you cannot clear the contents of the applicable cell for that parameter.
  • If a parameter is marked as Required in the template, clearing the contents of the applicable cell for that parameter will cause the cell to be highlighted with a red border alerting you to the fact that a value is required.

• You can copy, cut, and paste selected component definitions, using Ctrl+Shift+C, Ctrl+Shift+X and Ctrl+Shift+V respectively (or the corresponding commands on the right-click menu or the main Edit menu).

  • To quickly duplicate a single component definition, use the Clone Component command.

  • Component definitions from the clipboard can be pasted in two ways into the main grid region of the Component Editor:

    • At the end of the current list of definitions - make sure there are no definitions currently selected then launch the command.
    • Overwriting a current definition - right-click over the definition to overwrite and launch the command. A dialog will appear asking you to confirm; click Yes to proceed. Any existing defined cell data will be overwritten with that from the pasted definition. Note that overwrite only works with the focused definition. If multiple definitions exist on the clipboard, only the first will be pasted 'over' the focused definition, with the remainder pasted at the bottom of the list of definitions.
• You can remove selected component definitions completely, using the Remove Component control below the component definition grid, the Remove <ComponentName> (Remove n Components) command from the right-click menu or the main Edit menu, or the Ctrl+Del shortcut.
• You can refresh the content of the grid using the Refresh command on the main Edit or View menu or the right-click menu of the main grid region, using the F5 keyboard shortcut, or by clicking the button on the Component Library Standard toolbar.
• You can copy selected data cells to the Windows clipboard, for manipulation in an external spreadsheet application. Component definition information in an external spreadsheet can also be pasted back into the component definitions region.

It is also possible to collapse the upper region of the Component Editor by clicking the small arrow at the upper right of the editor, thereby dedicating the entire display area to the editing of component definitions.

Browsing a Saved Definition

Once saved to the Workspace, you can browse a component directly in the Workspace using the Components panel, or the Explorer panel.

For a component that has already been saved, and is currently being edited, you can jump directly to its Component Item in the Workspace from the Component Editor, by right-clicking on its entry in the definitions area and choosing the Operations » Show in Explorer command or by choosing the Edit » Operations » Show In Explorer command from the main menus.

Jump to an already saved component in the Explorer panel, directly from the Component Editor when you have that component revision oped for editing.

Targeting an Existing Component Item

For the most part, you would typically leave the creation of the components in the target Workspace to be part of the saving process. You add your component definitions, assign Item IDs and away you go – content creation 'on-the-fly' as it were. However, you may have created (or want to create) components directly in the Workspace, then link to these existing components. Alternatively, you may want to change the target Component Item associated with an existing, released component definition.

The right-click Operations sub-menu associated with a component definition (and the Edit » Operations sub-menu of the main menus) contains a couple of commands to support linking a definition to a manually-created component:

• Change Link To Target Item – use this command to access the Choose Target Item dialog, which you can use to browse for and select the required component in the Workspace.

  If the selected component definition is already linked to a component, then the dialog will present this component, already selected. If the definition is not already linked, then the dialog will present the target folder (as defined for the definition).

  Once linked to an existing component in the target Workspace, the Item ID for the component definition will become grayed-out (un-editable).

  Note that the command will only be available on the respective menu when a component definition is selected. If multiple component definitions are selected, the command operates on the focused definition - distinguished by a dotted border around its selected cell.

• Clear Link To Target Item (Clear Links To Target Items) – use this command to clear the link to existing component(s) in the Workspace. The Release-related fields of the component definition will revert back ready to create a new Item.

  The need to sever the links might arise if you need to release again to a new set of components. For example, if you have previously released but then deleted the components from the Workspace, the source library will still have defined links (although invalid as the Workspace components would no longer be found).

  If you have already saved a component definition, this procedure will effectively cause that definition and its previously linked component to lose knowledge of each other.

  Once the link to an existing component in the target Workspace is cleared, the Item ID for the component definition will become editable. The entry in the Action field in the Release region of the grid will change to Create Item reflecting that the component definition is currently not linked to a component in the target Workspace.

Running a Component Rule Check

Before saving a Workspace Library component defined/edited in the Component Editor to the connected Workspace and making the component be available for use in designs, it is essential to make sure that this component meets the requirements in accordance with the configured settings. The Component Editor runs a validation – a Component Rule Check – when you attempt to save a component back to the Workspace or run this feature manually.

A Word About Linked Simulation Models

Related page: Creating a Simulation Model

As with symbol and footprint models, a component can also reference a revision of a simulation model. Adding a model link of this type is exactly the same as for a symbol and footprint, so refer back to the previous sections for information on that. Here, we look at including component-level simulation parameters, and also configuration of pin mapping.

Adding Component-Level Simulation Parameters

When using a simulation model for a component in a design, parameters specific to that model can be specified at two different levels:

• Model-Level Parameter – specified as part of the simulation model definition itself (in the SimModel file), and saved with that definition into a revision of the linked simulation model.
• Component-Level Parameter – specified as part of the component definition (here in the Component Editor), and saved with that definition into a revision of the linked component.

Parameters are added at the component-level in the Required Models/Parameters region of the Component Editor. It is important to note that the naming of parameters must be the same as those parameters defined at the model-level. To see the model-level parameters, and therefore which parameters can be added at the component-level (and their names!), select the SIM model link and click the View Parameters control, at the bottom of the preview window.

View the model-level parameters for a Simulation Model Item to see which parameters can be added at the component-level – and how they are named!

Armed with the available model-level parameters, you can now proceed to add any of those same parameters at the component-level – to be available to any component definition. To do so, click the Add control at the bottom of the Required Models/Parameters region, and choose Parameter from the menu. A new parameter entry will be added to the list. Change the name as required – remembering to match exactly the name of the corresponding model-level parameter.

Add sim-related parameters at the component-level. Notice that one parameter is already available – Area Factor – courtesy of the Component Template referenced by this example component.

Pin Mapping

Once the link to the required SIM model has been chosen, you need to ensure that the pins of the component – when represented in the schematic domain – are correctly mapped to the pins of the simulation model. This is performed in the Pin Mapping dialog, accessed by right-clicking on the component definition's SIM model entry and choosing Operations » Edit Pin Mapping from the context menu or by selecting the cell for the SIM model, and choosing the Edit » Operations » Edit Pin Mapping command, from the main menus. For each schematic pin, use the available drop-down to change the associated Model Pin entry accordingly. If the device is multi-part, be sure to check the mapping for each part.

Ensuring correct schematic pin-to-model pin mapping.