Using Reuse Blocks & Snippets in Altium NEXUS

Parent page: Design Reuse

Working with Reuse Blocks and Snippets

If your designs often include common 'sections' of circuitry, Altium NEXUS provides a simple and easy way to save and reuse sections of design circuitry, both Workspace-based and local, file-based. Such sections can be added to any PCB design without having to start from scratch each time. This is a great feature for those often-used fragments and smaller sections of circuitry that you want to reuse. The system lets you save any selection of:

• Circuitry on a single schematic sheet (a schematic snippet).
• Circuitry in a PCB design, including the components and the routing (a PCB snippet).

When connected to an Altium 365 Workspace, you can create a single entity – a Reuse Block – that can contain both schematic circuitry and its physical representation for the PCB. When such a reuse block is placed on a schematic sheet, its physical representation will be placed automatically in the PCB document during the ECO process.

The command central for creating, managing, and using reuse blocks and snippets – both Workspace-based and local, file-based – is the Design Reuse panel.

 The panel can be accessed in the following ways:

• Click the Panels button at the bottom right of the design space then click Design Reuse.
• Select View » Panels » Design Reuse from the main menus.
• Select Place » Reuse Block from the main menus.

The panel's top drop-down menu lists all available folders currently existing in your connected Altium 365 Workspace which contain reuse blocks and Workspace-based snippets. The number next to each folder name shows how many design reuse blocks and snippets this folder and its sub-folders contain. Select a folder in the drop-down to present the reuse blocks and snippets this folder and its sub-folders contain in the main section of the panel. Select the entry of your connected Workspace in the drop-down to present all available reuse blocks and snippets.

Use filter buttons in the  icon pop-up to show/hide the content of specific types (Reuse Blocks, Schematic Snippets, PCB Snippets) in the panel. Use the Sort By control to select a preferred sorting option.

To search for available reuse blocks and snippets in the selected folder by their name or description, enter a phrase in the Search field to effectively filter and narrow the listing to your specific needs.

Each reuse block and snippet is presented in the main panel's section by the tile that contains the following data:

• preview image – can be clicked to switch between normal and full-scale states. For a reuse block, use the  button to switch between its PCB and schematic model previews;
• the type icon –  for a reuse block,  for a schematic snippet,  for a PCB snippet;
• name and description (if defined);
• the latest revision's ID, creation date, and author of a reuse block or a Workspace schematic/PCB snippet.

Creating Reuse Blocks

A new reuse block can be created in the following ways:

1. Select the command for creating a new reuse block:
   • from the Design Reuse panel, by clicking the  button at the top of the panel.
   • by using the File » New » Reuse Block command from the main menu.
   • from the Explorer panel, by clicking the  button, located at the top-right of the panel when a folder of the Design Reuse Blocks type is being browsed.
2. A temporary editable PCB project-like structure of the reuse block will be opened in the Projects panel (under an entry for the Workspace you are currently connected to), and the temporary schematic editor will be opened in the main design window, ready for defining the schematic model of the reuse block. Use the standard placement commands and techniques to define the schematic model of the reuse block.

3. When done, use the Design » Update PCB Document command and the ECO process to transfer the captured schematic to the PCB model of the reuse block then apply the changes needed to that model (defining component locations, routing, etc.).

4. When both schematic and PCB models of the reuse block are defined, save the reuse block to the Workspace using the Save to Server command from the context menu of the reuse block's entry in the Projects panel or the Save to Server control to the right of the entry.

   • Both schematic and PCB models of the reuse block must contain at least one component in order to be able to be saved to the Workspace.
   • If the reuse block's schematic and PCB documents are not synchronized (differences between the schematic and PCB documents are detected), the warning dialog will be shown when trying to save the reuse block to the Workspace. You can cancel saving to return to the reuse block and address the differences or proceed with saving.
5. The New Reuse Block dialog will appear, in which you can define Name, Description, and the Workspace Folder into which the new reuse block will be saved.
6. After clicking OK, the reuse block will be saved to the Workspace, and the temporary structure of the block will be closed.

A saved reuse block can then be found in the Design Reuse panel when the folder it has been saved into (or the entry of your connected Workspace) is selected in the top drop-down. Using the Refresh command from the  button menu may be required for the new reuse block to appear in the panel.

Creating Snippets

A new schematic or PCB snippet can be quickly created from an existing circuitry on a schematic sheet or a PCB document:

1. Select the required circuitry on the schematic or PCB editor.
2. Right-click and choose the Snippets » Create Snippet from selected objects from the context menu or select the Tools » Convert » Create Snippet from selected objects command from the main menus.

3. The New Schematic Snippet or New PCB Snippet dialog will appear, in which you can define Name, Description, saving destination (a Workspace or a local folder), and the folder into which the new snippet will be saved.

   For information about organizing the local snippets into folders, see the Local Snippet Organization section below.
4. After clicking OK, the snippet will be saved.

A saved snippet can then be found in the Design Reuse panel when the entry of your connected Workspace (or the folder it has been saved into) is selected in the top drop-down.

 Using the Refresh command from the panel's  button menu may be required for the new reuse block to appear in the panel.

For access to local snippets from the Design Reuse panel, the Local Snippets option must be enabled in the  button menu.

A Workspace-based snippet can also be created from an existing local snippet by clicking the  button within the snippet's tile (or by right-clicking anywhere on the tile) and selecting the Save to Server command from the menu. In the New Schematic Snippet or New PCB Snippet dialog that appears, define Name, Description, and the Workspace folder into which the snippet will be saved.

Local Snippet Organization

The Design Reuse panel allows local snippets to be organized into snippet folders so that related snippets can be grouped together, making it easier for you to find. Snippets folders are existing Windows folders that cannot be created from within the Design Reuse panel. Instead, they are 'opened' or 'closed' with respect to browsing the local snippets they contain. These folders can only be created directly on your hard disk or network outside of Altium NEXUS.

Snippets folders are opened and closed from the Available Snippets Folders dialog accessed by clicking the  button at the top right of the Design Reuse panel and selecting the Snippet Folders command from the menu. Click Open Folder to browse to the required folder on your hard disk or network. The selected folder will be added to the list in the dialog and subsequently appear in the drop-down at the top of the Design Reuse panel. To remove a snippets folder from the list (which is essentially closing it from a browsing perspective), select the folder in the list then click Remove Folder. Use the Move Up and Move Down buttons to change the order in which the local snippets will be presented in the Design Reuse panel when the Local entry is selected in the panel's drop-down.

Placing Reuse Blocks and Snippets

After placing the schematic model of a reuse block, its PCB model can be placed in the PCB document through the ECO process – from the schematic editor, use the Design » Update PCB Document from the main menus then validate and execute changes using the Engineering Change Order dialog. The PCB model will be placed in the PCB document as a Union, and it can be managed from the Unions mode of the PCB panel.

When a selected schematic or PCB component is part of a reuse block placed in the design, you can inspect the properties of this reuse block by clicking the Reuse Block link provided in the Component mode of the panel. The properties of the component's parent reuse block will be presented in the panel. To return to the properties of the initially selected component, use the Component link.

Access the reuse block properties from a component that is a part of this reuse block. The images above display accessing the properties from a schematic component. Hover the cursor over the image to see access from a PCB component.

Editing Reuse Blocks and Snippets

To edit a Workspace-based reuse block or snippet, click the button within its tile (or right-click anywhere on the tile) and select the Edit command from the menu.

The temporary editor will open, with the document (containing the source reuse block/snippet) contained in the latest revision of the Workspace Item, opened for editing. Make changes as required, then save the document into the next revision of the reuse block/snippet using the File » Save to Server command from the main menu or the Save to Server command from the reuse block/snippet entry's right-click menu in the Projects panel.

The properties (Name, Description, and Path) of a local snippet can be edited through the Snippet Properties dialog that is accessed by clicking the  button within the local snippet's tile (or right-clicking anywhere on the tile) and selecting the Edit Properties command from the menu.

Deleting Reuse Blocks and Snippets

To delete a reuse block or snippet, click the  button within the snippet's tile (or right-click anywhere on the tile) and select the Save to Server command from the menu.

• For a Workspace-based reuse block or snippet, the Delete Items dialog will appear, in which to confirm the deletion. The action is actually a 'soft delete', whereby the reuse block or snippet will be moved into the Trash area of the Workspace. The Trash is essentially a recycle bin into which any content within your Workspace can be moved (through a soft delete action). It is isolated from the rest of the Workspace. For a reuse block, you can also opt to delete the reuse block's related content (e.g. schematic and PCB snippets).

   

   

   

   

   

  
  Soft-delete a reuse block or snippet using the Delete command from within its tile in the panel. 

• For a local snippet, the Confirm dialog will appear to confirm the deletion. The action will remove the snippet files from your hard drive.

Snippets Panel

The Snippets panel allows to save and reuse sections of design circuitry or code in form of local snippets. The snippets system lets you save any selection of:

• Circuitry on a single schematic sheet.
• Circuitry in a PCB design, including the components and the routing.
• Code from within one of Altium NEXUS's code-aware editors.

The Snippets panel is the central point for saving, reusing, and managing design Snippets.