Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 2.0
543.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... ((Dialog Reference))_AD Dialogs((A to F))_AD

WorkspaceManager_Dlg-AnnotationPropertiesFormAnnotate_AD

Created: October 11, 2017 | Updated: March 06, 2024 | Applies to versions: 1.0, 1.1, 2.0, 2.1, 3.0, 3.1 and 3.2

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

The Annotate dialogThe Annotate dialog

Summary

The Annotate dialog provides controls to systematically assign designators to all, or selected parts in selected schematic sheets of a project, and ensures that designators are unique and ordered based on their position. Annotation options can be configured to package multi-part components, set Index and Suffix options, and Reset Schematic Designators (including any duplicate designators).

Access

The Annotate dialog is accessed from the Schematic Editor by clicking Tools » Annotation » Annotate Schematics from the main menus.

Options/Controls

The dialog includes two primary regions:

  • Schematic Annotation Configuration - this region is used to configure the annotation scheme as well as the scope of annotation.
  • Proposed Change List - this region lists the proposed changes that will occur once accepted and executed using an Engineering Change Order (ECO).

Schematic Annotation Configuration

Order of Processing

Use this region to specify the required method of positional annotation. As you select a method from the drop-down list, the associated graphical representation dynamically updates to illustrate how the components will be annotated. Choose from the following methods of positional annotation:

  • Up Then Across
  • Down Then Across
  • Across Then Up
  • Across Then Down

Process Location of

Use this region to specify the reference for component locations when processing the annotation order. Choose from the following:

  • Designator - the component's designator is used as the reference for its location when determining processing order.
If the positional annotation is not performing according to your expectations, ensure that the designators are positioned correctly. It might be that the components themselves are in perfect alignment, but a misplaced designator is responsible for causing the undesirable annotation results.
  • Part - the center of the component is used as the reference for its location when determining processing order.

Matching Options

When using multi-part packages, it is often desirable to pack as many parts into the minimum number of physical parts since this minimizes the overall BOM cost of the design. The controls in this region allow you to define how components will be matched and grouped together, as well as the criteria used for determining valid groupings.

  • Complete Existing Packages - use this control to decide if and how parts that are not annotated will be included in existing packages. Use the drop-down list to choose from the following:
    • None - existing packages will not be completed and all new parts will be placed into new packages.
    • Per Sheet - existing packages will only include new parts from the same schematic sheet.
    • Whole Project - existing packages will include new parts from any of the schematic sheets in the project.
When configuring the Completing Existing Packages region, some consideration should be given to how power pins have been specified on active components. For example, many designers include VCC/GND pins on the first part of a multi-part component but then do not include those pins on subsequent parts. If the first part in a multi-part component is packed into an alternate package and has its sub-part updated, it can lead to unconnected (or floating) power connections.
  • Component Parameter - this list includes all parameters found within components in the current design. Check the box associated to a parameter to use it for matching parts into packages. If multi-part components share the same enabled parameters and a common value, they will be packaged together (provided the Complete Existing Packages option is not set to None). Any remaining components that do not have the enabled parameter(s) are also packaged together.
  • Strictly - enable this option for a Component Parameter in the list to denote that all components must have that parameter to be matched into a package. Components that do not have this parameter are annotated as individual components and are not packaged.

Right-click Menu

  • Parameter » Enable Selected Parameters - use to check the 'Include' checkbox for all parameters currently selected in the list.
  • Parameter » Enable All Parameters - use to check the 'Include' checkbox for all parameters in the list.
  • Parameter » Disable Selected Parameters - use to uncheck the 'Include' checkbox for all parameters currently selected in the list.
  • Parameter » Disable All Parameters - use to uncheck the 'Include' checkbox for all parameters in the list.
  • Match Strictly » Enable Strict Matching On Selected Parameters - use to enable the Strictly option for all parameters currently selected in the list.
  • Match Strictly » Enable Strict Matching On All Parameters - use to enable the Strictly option for all parameters in the list.
  • Match Strictly » Disable Strict Matching On Selected Parameters - use to disable the Strictly option for all parameters currently selected in the list.
  • Match Strictly » Disable Strict Matching On All Parameters - use to disable the Strictly option for all parameters in the list.
  • Selection » Select All - use to select all parameter entries in the list.
  • Selection » Deselect All - use to deselect all parameter entries in the list.
  • Selection » Invert Selection - use to select all parameters not currently selected in the list, and deselect those that are.

Schematic Sheets To Annotate

This region of the dialog lists all of the source schematic sheets in the design project. Controls available in this region are used to determine which sheets are to be included in the annotation process and the specifics of how annotation changes will be calculated. For each sheet, the following is presented:

  • Include/Exclude checkbox - enable this checkbox to include the schematic sheet in the annotation process.
  • Schematic Sheet - this field displays the name of the schematic sheet.
  • Annotation Scope - use this field to determine the scope of annotation with respect to the components on the sheet. Use the drop-down list to choose one of the following scopes:
    • All - all parts on the schematic sheet will be annotated.
    • Ignore Selected Parts - all parts, except those currently selected in the design, will be annotated.
    • Only Selected Parts - only those parts currently selected in the design will be annotated.
Using Ignore Selected Parts or Only Selected Parts requires that the components are selected in the design prior to accessing the dialog.
  • Order - use this field to specify where this sheet is to be placed in the overall order of sheet annotation. Type the desired order number directly into the field or use the arrows that appear once you click in the field to scroll to your preference.
  • Designator Index Control - use the controls in this column to enable the use of a start index (by checking the associated box) and defining a value for the index. The designator value will begin from this index value.
  • Add Suffix - use this field to specify use of a suffix to be appended to each annotated designator. Alpha (A, B, C...), numeric (1, 2, 3...), and non-alphanumeric (_ * . %...) suffixes are supported including a combination of these.
Avoid using single character suffixes such as 'A' or '1' as these can be easily confused with sub-parts and/or other designator values.

Additional Controls

  • All On - click to include all schematic sheets in the annotation process.
  • All Off - click to exclude all schematic sheets from the annotation process.
  • Right-Click Menu - the following commands are available from the region's right-click context menu:
    • Order Alphabetically - use to order the list of schematics alphabetically. This will impact the associated Order entry for each sheet.
    • Order By Project Order - use to order the list of schematics by the order in which they appear for the project (as seen on the Projects panel). This will impact the associated Order entry for each sheet.
    • All On - use to include all schematic sheets in the annotation process.
    • All Off - use to exclude all schematic sheets from the annotation process.

Proposed Change List

  • Main List - this region of the dialog lists all designators for the parts contained within the sheets selected for annotation. For each entry, details of the Current and Proposed Designator values are included, along with the component's Sub (part) and the source Location of Part. The padlock icons () are used to denote locked columns to prevent designator and sub-part changes.  
You can sort by one of these padlocked columns by clicking on the padlock. Click once to have all components whose designators and/or sub-parts are available for change listed first, click again to have all parts that are not to be touched by the annotation process appear at the top of the Proposed Change List. 

Checking the box adjacent to a designator in the Current column ('designator locked') will lock that specific designator from any changes. Similarly, checking the box adjacent to a designator's Sub field ('sub-part locked') will prevent that specific sub-part of the parent multi-part component from being updated.

The following commands are available on the region's right-click menu:

  • Designator » Lock Selected Designators - use to check the 'designator locked' checkbox for all designators currently selected in the list.
  • Designator » Lock All Designators - use to check the 'designator locked' checkbox for all designators.
  • Designator » Unlock Selected Designators - use to uncheck the 'designator locked' checkbox for all designators currently selected in the list.
  • Designator » Unlock All Designators - use to uncheck the 'designator locked' checkbox for all designators.
  • Part ID » Lock Selected Part ID - use to check the 'sub-part locked' checkbox for all designators currently selected in the list.
  • Part ID » Lock All Part ID - use to check the 'sub-part locked' checkbox for all designators.
  • Part ID » Unlock Selected Part ID - use to uncheck the 'sub-part locked' checkbox for all designators currently selected in the list.
  • Part ID » Unlock All Part ID - use to uncheck the 'sub-part locked' checkbox for all designators.
  • Selection » Select All - use to select all designator entries in the list.
  • Selection » Select All With '?' - use to select all entries whose current designator contain ? (i.e. have been reset).
  • Selection » Deselect All - use to deselect all designator entries in the list.
  • Selection » Invert Selection - use to select all designators not currently selected in the list, and deselect those that are.
Multiple designator entries can be selected using standard multi-select techniques (Ctrl+click and Shift+click).
Proposed changes are calculated based on configured annotation options and loaded after clicking the Update Changes List button (below the region).
  • Annotation Summary - this area provides a summary of the annotation in terms of the number of sheets involved and the matching options. It dynamically updates as changes are made to these areas.
  • Update Changes List - click to update the main proposed changes list with new calculated changes based on defined annotation settings on the left side of the dialog. An information dialog will present details of how many changes were made since the previous state and how many changes were made since the original state.
Only designators that have not previously been set (i.e. R?, C?, etc.,) will be affected by the changes, therefore, if the intention is to update all designators in the design, they should first be reset by clicking the Reset All button.
  • Reset All - click to reset all designators in the main list (that are not locked) back to their default component prefixes, e.g., R?, C?, D?. The changes will be loaded in the Proposed designators column. The button's drop-down allows you to change the command to Reset Duplicates. If two or more components have the same designator, all but one will be reset to their default prefixes. Again, an information dialog will present details of how many changes were made since the previous state and how many changes were made since the original state.
Note that any designators with a locked status are not reset or changed in any way.
  • Back Annotate - click to open a dialog to search for and select the file for back annotation.
  • Accept Changes (Create ECO) - after reviewing all proposed changes, click this button to access the Engineering Change Order dialog, which lists the proposed changes as modifications within the modification category Annotate Component. Use this dialog to validate and execute the ECO, completing the Annotation Process at the schematic level.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.