Altium Designer Documentation

RefactorSheetSymbol

Created: July 27, 2015 | Updated: April 11, 2017
Now reading version 17.1. For the latest, read: RefactorSheetSymbol for version 21
Applies to Altium Designer versions: 15.1, 16.0, 16.1, 17.0 and 17.1

Parent page: Schematic Commands

The following pre-packaged resources, derived from this base command, are available:


Applied Parameters: Target=NormalSheetSymbol

Summary

This command is used to quickly convert an existing standard schematic sheet into a Device Sheet, for reuse in other designs. Device sheets are schematic sheets designed to offer specific circuit functionality. Their use removes the risks associated with the traditional copy-and-paste approach. And they eliminate the repetition of design effort while adding to the level of design content that can be reused in future designs.

Access

This command is accessed in the Schematic Editor, with the required sheet symbol selected, by choosing the Edit » Refactor » Convert Selected Schematic Sheet To Device Sheet command from the main menus.

Use

First, ensure that a sheet symbol that references the schematic sheet that you wish to convert, is selected in the design workspace.

After launching the command, the Convert Schematic Sheet to Device Sheet dialog will appear. Use this dialog to choose the target location in which to store the newly-created device sheet, and also the scope of the conversion – whether to update the current sheet symbol, or all relevant sheet symbols in the workspace or active project. The latter is particularly useful for a multi-channel design, where the sub-circuit exists in several instances.

Upon clicking OK, each affected sheet symbol (in accordance with defined scope of the operation) will be converted to a device sheet symbol, and the schematic will be moved to the nominated device sheet location. Recompile the project (if you did not already opt to do so through the dialog) to have the new device sheet appear in the Projects panel.

Tips

  1. Unlike traditional cut and paste, refactoring maintains the Unique Identifiers of the sub-circuits (including sheet symbols and device sheet symbols), ensuring that sub-circuits in the design are always linked to their physical instances in the PCB domain.
  2. Properties of the original sheet symbol will be inherited by the device sheet symbol.
  3. For the highest integrity and optimal reusability, along with benefits including revision and lifecycle management and 'where-used' traceability, consider releasing schematic sheets of functional sub-circuitry to an Altium Vault. Available to the entire design team across the organization, these vault-based design elements – thereafter referred to as Managed Schematic Sheets – provide higher-level, high-quality building blocks for reuse across future designs. The designer, just like picking parts off a shelf, simply reuses these managed sheets of design functionality as constituent components of the bigger design project. For more information, see Managed Schematic Sheets in an Altium Vault.


Applied Parameters: Target=NormalSheetSymbol|ContextSensitive=True

Summary

This command is used to quickly convert an existing standard schematic sheet into a Device Sheet, for reuse in other designs. Device sheets are schematic sheets designed to offer specific circuit functionality. Their use removes the risks associated with the traditional copy-and-paste approach. And they eliminate the repetition of design effort while adding to the level of design content that can be reused in future designs.

Access

This command can be accessed in the Schematic Editor by:

  • (With the required sheet symbol selected) right-clicking anywhere in the workspace and choosing the Refactor » Convert Selected Schematic Sheet To Device Sheet command from the context menu.
  • Right-clicking directly over the required sheet symbol and choosing the Refactor » Convert Schematic Sheet To Device Sheet command from the context menu.

Use

After launching the command, the Convert Schematic Sheet to Device Sheet dialog will appear. Use this dialog to choose the target location in which to store the newly-created device sheet, and also the scope of the conversion – whether to update the current sheet symbol, or all relevant sheet symbols in the workspace or active project. The latter is particularly useful for a multi-channel design, where the sub-circuit exists in several instances.

Upon clicking OK, each affected sheet symbol (in accordance with defined scope of the operation) will be converted to a device sheet symbol, and the schematic will be moved to the nominated device sheet location. Recompile the project (if you did not already opt to do so through the dialog) to have the new device sheet appear in the Projects panel.

Tips

  1. Unlike traditional cut and paste, refactoring maintains the Unique Identifiers of the sub-circuits (including sheet symbols and device sheet symbols), ensuring that sub-circuits in the design are always linked to their physical instances in the PCB domain.
  2. Properties of the original sheet symbol will be inherited by the device sheet symbol.
  3. For the highest integrity and optimal reusability, along with benefits including revision and lifecycle management and 'where-used' traceability, consider releasing schematic sheets of functional sub-circuitry to an Altium Vault. Available to the entire design team across the organization, these vault-based design elements – thereafter referred to as Managed Schematic Sheets – provide higher-level, high-quality building blocks for reuse across future designs. The designer, just like picking parts off a shelf, simply reuses these managed sheets of design functionality as constituent components of the bigger design project. For more information, see Managed Schematic Sheets in an Altium Vault.


Applied Parameters: Target=DeviceSheetSymbol

Summary

This command is used to quickly 'convert' an existing device sheet into a schematic sheet. Device sheets enable functional sub-circuits to be captured and reused across designs. However, there may be a need to modify an existing sub-circuit for a particular design. Rather than modifying the device sheet itself, this command provides the ability to take a copy of the device sheet, making its circuitry available on a standard schematic sheet. This allows the designer to modify the local copy in-line with requirements for their current design, and safe in the knowledge that the original device sheet remains untouched.

Access

This command is accessed in the Schematic Editor, with the required device sheet symbol selected, by choosing the Edit » Refactor » Convert Selected Device Sheet To Schematic Sheet command from the main menus.

Use

First, ensure that a device sheet symbol that references the device sheet that you wish to 'convert', is selected in the design workspace.

After launching the command, the Convert Device Sheet to Schematic Sheet dialog will appear. Use this dialog to choose the target location in which to store the newly-created schematic sheet, and also the scope of the conversion – whether to update the current device sheet symbol, or all relevant device sheet symbols in the active project.

The default Target Schematic Sheet Location is the directory in which the active project resides. The sheet is named using the device sheet symbol's Filename. Click the button to the right of the location field to access the Open dialog, in which to change where, and under what name, the schematic is to be saved (if required).

Upon clicking OK, each affected device sheet symbol (in accordance with defined scope of the operation) will be converted to a sheet symbol, and a copy of the device sheet will be stored locally as a standard (unprotected) sheet in the nominated location. The sheet symbol will reference this local sheet. Recompile the project (if you did not already opt to do so through the dialog) to have the new schematic sheet appear in the Projects panel.

Tips

  1. Unlike traditional cut and paste, refactoring maintains the Unique Identifiers of the sub-circuits (including sheet symbols and device sheet symbols), ensuring that sub-circuits in the design are always linked to their physical instances in the PCB domain.
  2. Properties of the original device sheet symbol will be inherited by the sheet symbol.


Applied Parameters: Target=DeviceSheetSymbol|ContextSensitive=True

Summary

This command is used to quickly 'convert' an existing device sheet into a schematic sheet. Device sheets enable functional sub-circuits to be captured and reused across designs. However, there may be a need to modify an existing sub-circuit for a particular design. Rather than modifying the device sheet itself, this command provides the ability to take a copy of the device sheet, making its circuitry available on a standard schematic sheet. This allows the designer to modify the local copy in-line with requirements for their current design, and safe in the knowledge that the original device sheet remains untouched.

Access

This command can be accessed in the Schematic Editor by:

  • (With the required device sheet symbol selected) right-clicking anywhere in the workspace and choosing the Refactor » Convert Selected Device Sheet To Schematic Sheet command from the context menu.
  • Right-clicking directly over the required device sheet symbol and choosing the Refactor » Convert Device Sheet To Schematic Sheet command from the context menu.

Use

After launching the command, the Convert Device Sheet to Schematic Sheet dialog will appear. Use this dialog to choose the target location in which to store the newly-created schematic sheet, and also the scope of the conversion – whether to update the current device sheet symbol, or all relevant device sheet symbols in the active project.

The default Target Schematic Sheet Location is the directory in which the active project resides. The sheet is named using the device sheet symbol's Filename. Click the button to the right of the location field to access the Open dialog, in which to change where, and under what name, the schematic is to be saved (if required).

Upon clicking OK, each affected device sheet symbol (in accordance with defined scope of the operation) will be converted to a sheet symbol, and a copy of the device sheet will be stored locally as a standard (unprotected) sheet in the nominated location. The sheet symbol will reference this local sheet. Recompile the project (if you did not already opt to do so through the dialog) to have the new schematic sheet appear in the Projects panel.

Tips

  1. Unlike traditional cut and paste, refactoring maintains the Unique Identifiers of the sub-circuits (including sheet symbols and device sheet symbols), ensuring that sub-circuits in the design are always linked to their physical instances in the PCB domain.
  2. Properties of the original device sheet symbol will be inherited by the sheet symbol.

 

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: