Schematic Snippet

Parent page: Workspace Content Types

Altium Designer, in conjunction with your connected Workspace, caters for the ability to create and manage schematic snippets (Schematic Snippet Items) in that Workspace. Such snippets are created directly within the Workspace. Once a schematic snippet has been created (and data saved into a revision of it), it can be reused in future board-level design projects.

Folder Type

When creating the folder in which to store schematic snippets, you can specify the folder's type. This has no bearing on the content of the folder – saving a schematic snippet will always result in a corresponding Schematic Snippet Item. It simply provides a visual 'clue' as to what is stored in a folder and can be beneficial when browsing a Workspace for particular content. To nominate a folder's use as a container for schematic snippets, set its Folder Type as Schematic Snippets, when defining the folder properties in the Edit Folder dialog.

Specifying the folder type – its intended use – gives a visual indication of the content of that folder when browsing the Workspace.

Content Type

When creating a target Schematic Snippet Item in which to store your schematic snippet, ensure that its Content Type is set to Schematic Snippet, in the Create New Item dialog. If you are creating the Item in a Schematic Snippets type folder, this content type will be available from the right-click context menu when creating the Item.

Creating a schematic snippet within a Schematic Snippets folder – the correct Content Type is available on the context menu.

Saving a Schematic Snippet

Related page: Creating and Editing Content Directly through a Workspace

So far, we've discussed the support for a schematic snippet in the Workspace, in terms of related folder and content types. Saving an actual defined schematic snippet into a revision of a Schematic Snippet Item can be performed in a streamlined way.

Direct Editing

A schematic snippet can be edited and saved into the initial revision of a newly-created Schematic Snippet Item, courtesy of the Workspace's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported content type using a temporary editor loaded with the latest source direct from the Workspace itself. And once editing is complete, the entity is saved (or re-saved) into a subsequent planned revision of its parent Item, and the temporary editor closed. There are no files on your hard drive, no questioning whether you are working with the correct or latest source, and no having to maintain separate version control software. The Workspace handles it all, with great integrity, and in a manner that greatly expedites changes to your data.

When you create a Schematic Snippet Item, you have the option to edit and save the schematic snippet into the initial revision of that Item, after creation. To do so, enable the Open for editing after creation option, at the bottom of the Create New Item dialog (which is enabled by default). The Item will be created and the temporary Schematic Editor will open, presenting a .SchDoc document as the active document in the main design window. This document will be named according to the Item-Revision, in the format: <Item><Revision>.SchDoc (e.g. SCHS-0001-1.SchDoc).

Example of editing the initial revision of a schematic snippet, directly from the Workspace – the temporary schematic editor provides the document with which to define your schematic snippet.

Use the document to define the schematic snippet as required. Because schematic snippets are stored in a Workspace, the components on them should also be stored in the Workspace. That way, you get the full benefit of the content system that the Workspace provides.

There are three relevant controls when direct editing, readily available from the Quick Access Bar (at the top-left of the main application window), or from the Schematic Standard toolbar:

• – Save Active Document. Use this button to locally save any changes made to the currently open document of the schematic snippet. This allows you to save current changes, should you wish to come back at a later stage to make further changes before ultimately saving to the Workspace.

• / – Save to Workspace. Use this button to save the defined schematic snippet to the Workspace, storing it within the initial (planned) revision of the target Schematic Snippet Item. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. The editor will close after the save. The document containing the source schematic snippet (*.SchDoc) will be stored in the revision of the Item.

  A Save to Server control is also conveniently provided to the right of the schematic snippet's entry, within the Projects panel itself.
• / – Discard Local Changes. Use this button if you wish to cancel editing and discard any changes made. The editor will close, and nothing will be saved to the target Schematic Snippet Item.

These controls are also available as commands – Save (shortcut: Ctrl+S), Save to Server (shortcut: Ctrl+Alt+S), and Discard Local Changes – from the main File menu and from the right-click menu of entries of the schematic snippet's entry in the Projects panel.

The saved data stored in the Workspace consists of the source schematic sheet, defined in the schematic document file (<Item><Revision>.SchDoc), as well as any associated harness definition files (*.Harness). In the  Explorer panel, switch to the Preview aspect view tab to see a graphical representation of the snippet.

Browse the saved revision of the schematic snippet, back in the Explorer panel. Switch to the Preview aspect view tab to see the schematic snippet's graphics.

Saving an Existing Local Schematic Snippet to the Workspace

While direct editing is the preferred approach for most design content that can be stored in a Workspace, when it comes to existing local schematic snippets, you also have the ability to save a snippet directly to the Workspace. The process is as follows:

1. Open the Design Reuse panel in Altium Designer and browse to an existing local schematic snippet.

   For access to local snippets from the Design Reuse panel, the Local Snippets option must be enabled in the  button menu.
2. Click 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.
3. In the New Schematic Snippet dialog that appears, edit Name, Description, and the Workspace folder into which the snippet will be saved as required.

Creating a Schematic Snippet from Selection

A schematic snippet can also be created based on the required circuitry placed in a schematic document. The process is as follows:

1. Select the required circuitry on the schematic editor.
2. Right-click and choose 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 dialog will appear, in which you can define Name and Description of the Schematic Snippet Item to be created. Select your connected Workspace in the Save to field and the Workspace folder into which the new snippet will be saved.
4. After clicking OK, the snippet will be saved.

Reusing a Schematic Snippet

Related pages: Controlling Access to Workspace Content

Once a schematic snippet has been saved to a Workspace, and its lifecycle state set to a level that the organization views as ready for use at the design level, that snippet can be reused in future board-level design projects. And keeping to the use of the Workspace as the source of all content in and for a design, it is good practice to reuse your schematic snippet content in Workspace Projects – which themselves are under the Workspace's wing.

Placement of a schematic snippet is performed from Altium Designer's Explorer panel or Design Reuse panel.

To place a revision of a schematic snippet from the Explorer panel:

1. Browse or search for the schematic snippet you wish to place.
2. Right-click on the specific revision of the schematic snippet required (typically the latest, in which case just right-click directly on the top-level Item entry).
3. Choose the Place command.

To place the latest revision of a schematic snippet from the Design Reuse panel:

1. Browse or search for the schematic snippet you wish to place.
2. Click within the schematic snippet tile and click the Place button. Alternatively, click the  button within the tile (or right-click anywhere on the tile).
3. Choose one of the following commands:
   • Place – select to place the schematic snippet directly on the active schematic or PCB document.
   • Place as Sheet Symbol – when a schematic document is active, select to place the schematic snippet as a Sheet Symbol on the schematic sheet. The content of the schematic snippet will be placed on an automatically created child schematic sheet referenced by the placed Sheet Symbol.

Re-Saving a Schematic Snippet

At any stage, you can come back to any revision of a schematic snippet in the Workspace, and edit it directly. Right-click on the revision in the Explorer panel and choose the Edit command from the context menu. Once again, the temporary editor will open, with the schematic sheet contained in the revision opened for editing. Make changes as required, then save the document into the next revision of the schematic snippet.

Right-clicking on the top-level entry for a schematic snippet itself will edit the latest revision of that snippet. Also, the latest revision of a schematic snippet can be opened for editing from the Design Reuse panel by clicking the button within the schematic snippet's tile (or right-click anywhere on the tile) and selecting the Edit command.

Accessing the command to launch direct editing of an existing revision of a schematic snippet from the Explorer panel.

Downloading Saved Data

Download the data stored in a revision of a schematic snippet by right-clicking on that revision and choosing the Operations » Download command from the context menu. The applicable schematic document file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision ID. The file can be found in the Released folder therein.

Soft Deletion

When connected to a Workspace, flexible functionality is available for removing a schematic snippet directly from within Altium Designer:

• From the Explorer panel – right-click on the schematic snippet's entry in the panel and choose the Delete Item command from the context menu.
• From the Design Reuse panel – click the button within the schematic snippet's tile (or right-click anywhere on the tile) and select the Delete command from the context menu.

The Delete Items dialog will appear, in which to confirm the deletion. The action is actually a 'soft delete', whereby the schematic 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.

Soft deletion of a schematic snippet from within the Explorer panel. The content will be moved to the Workspace's Trash area.

To proceed with the deletion, click the button. The content will be removed and a Deletion Summary dialog will confirm successful deletion. If there was an issue with deletion, this will be flagged to you.

The content deleted in this manner can be found on the Trash page of the Workspace's browser interface. Note that you can only view the content that you have personally soft deleted. Administrators will be able to see the full content of the Trash page – so all content that has been soft deleted.

Things to consider in relation to a soft deleted schematic snippet:

• The schematic snippet will not be available from your design software, or from within the Web interface.
• Anywhere the schematic snippet was being used will reflect that the schematic snippet has been deleted.
• A schematic snippet can be restored, or permanently deleted from the Trash page, provided you have editing rights. Permanent deletion is only possible provided it is not being used by a parent Item.