Altium NEXUS Documentation

BatchRenameByTemplate

Created: May 11, 2019 | Updated: May 11, 2019

Parent page: UnifiedComponent Commands

The following pre-packaged resource, derived from this base command, is available:


Applied Parameters: None

Summary

This command is used to rename one or more selected components in the active Component Library document, on-the-fly, using a different naming scheme to that defined as the default scheme for the document.

Access

This command can be accessed from the Component Library Editor, when configured in Batch Editor mode, by:

  • Selecting a single component definition (in the lower grid region) and choosing the Edit » Operations » Rename Component command from the main menus.
  • Right-clicking over a component definition (in the lower grid region), and choosing the Operations » Rename Component command from the context menu.
  • Selecting n component definitions (in the lower grid region) and choosing the Edit » Operations » Rename n Components command from the main menus.
  • Right-clicking over a component definition (in a group of n selected definitions in the lower grid region), and choosing the Operations » Rename n Components command from the context menu.
If the Component Library Editor is currently in Single Component Editor mode, switch to the Batch Editor mode using the Tools » Switch to Batch Editor command.

Use

After launching the command, the Component Name Template dialog will appear. Use this dialog to specify the required Naming Scheme, and control the Initial Index.

Note that the dialog will initially show the default naming scheme entered in the Document Options dialog. If you leave this scheme, you will not be able to change the Initial Index. The latter can only be changed if a different naming scheme is used.

After defining the scheme as required, click OK - the component definition(s) will be renamed according to this defined scheme.

Parameter-based Name Templates

The CmpLib Editor provides support 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 CmpLib file. Include a parameter into the naming template using the format [<ParameterName>]. Examples might be:

  • CMP-[Value]
  • CMP-[Part Number]
  • [Comment]
  • [Comment]-[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}

Tips

  1. The naming scheme used in the renaming process is only used for that process. It does not replace the defined default naming scheme for the document. If you want additionally-added component definitions to be named using this same scheme, ensure that you define this scheme at the document level by changing the Component Naming field in the Document Options dialog accordingly.
  2. The Item ID for an individual component definition can also be changed directly in the grid. Click once to focus the Item ID cell, then click again (or press F2) to enter in-place editing. Change the name as required. Note that the use of parameteric decalrations is not supported when directly editing the name in this way.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: