Schematic Template

Parent page: Server Items

Altium Designer, in conjunction with your managed content server, caters for the ability to create and manage Schematic Template Items in that server. Such Items are created directly from within the server. Once a Schematic Template Item has been created (and data released into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in future board-level design projects.

Folder Type

When creating the folder in which to store Schematic Template Items, you can specify the folder's type. This has no bearing on the content of the folder - releasing a schematic template will always result in a corresponding Schematic Template Item. It simply provides a visual 'clue' as to what is stored in a folder and can be beneficial when browsing a server for particular content. To nominate a folder's use as a container for Schematic Template Items, set its Folder Type as Schematic Templates, 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 server.

Item Type

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

Creating a Schematic Template Item within a Schematic Templates folder - the correct Content Type is available on the context menu.

Releasing a Schematic Template

So far, we've discussed the support for a Schematic Template Item in the server, in terms of related folder and item types. Releasing an actual defined schematic template into a revision of such an item can be performed in a streamlined way.

A schematic template can be edited and released into the initial revision of a newly-created Schematic Template Item, courtesy of the server's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the server itself. And once editing is complete, the entity is released (or re-released) 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 managed content server handles it all, with great integrity, and in a manner that greatly expedites changes to your data.

When you create a Schematic Template Item, you have the option to edit and release a schematic template into the initial revision of that item, after creation. To do so, enable the option Open for editing after creation, 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 .SchDot 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>.SchDot (e.g. SCHDOT-0010-1.SchDot).

Example of editing the initial revision of a Schematic Template Item, directly from the managed content server - the temporary Schematic Editor provides the document with which to define your schematic template.

Use the document to define the schematic template as required.

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 save any changes made to the document. This allows you to save current changes, should you wish to come back at a later stage to make further changes before ultimately releasing to the managed content server.
•  - Release Document. Use this button to release (effectively save and release) the defined schematic template to the managed content server, storing it within the initial (planned) revision of the target Schematic Template Item. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. The document and editor will close after the release. The document containing the source schematic template, *.SchDot, will be stored in the revision of the Item.
•  - Cancel Editing. Use this button if you wish to cancel editing. The document and editor will close, and nothing will be released to the target Schematic Template Item.

These controls are also available as commands - Save (Shortcut: Ctrl+S), Release to Server (Shortcut: Alt+Ctrl+S), and Cancel Edit - from the main File menu.

The released data stored in the server consists of the source schematic template, defined in the Schematic Template file (<Item><Revision>.SchDot). In the Explorer panel, switch to the Preview aspect view tab to see the template graphics.

Browse the released revision of the Schematic Template Item, back in the Explorer panel. Switch to the Preview aspect view tab to see the template graphics.

Sending an Existing Template to Server

While direct editing is the preferred approach - and the only approach - for most design Items that can be stored in a managed content server, when it comes to existing schematic templates you also have the abiltiy to send a template directly to the server. This requires that you have a planned revision of an existing Schematic Template Item, into which the sheet will be released. The process is as follows:

1. Create a new Schematic Template Item and initial planned revision, or have a planned revision of another existing Item, as required.
2. Open the schematic template (*.SchDot) within Altium Designer.
3. Choose the File » Send to server command from the main menus.
4. The Choose Planned Item Revision dialog will appear. Use this to choose the target revision of the required Schematic Template Item (which must be in the Planned state), then click OK.

5. The Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required.
6. After clicking OK, the template will be released and stored in the revision of the Item.

Example of sending an existing schematic template to the managed content server to which you are actively signed in. The release must be to an existing revision of a Schematic Template Item, and that revision must be in the Planned state.

Reusing a Managed Schematic Template Item

Related pages: Managed Schematic Sheets, Controlling Access to Server Content

Once a schematic template has been released to a managed content server, and its lifecycle state set to a level that the organization views as ready for use at the design level, that template can be reused in future board-level design projects.

When you are signed in to your managed content server, use of available Schematic Template Items is automatic. If there are released revisions of Schematic Template Items, then only those available templates - shared with you - will be presented in the following areas of the software where a schematic template can be chosen.

If there are no released revisions of Schematic Template Items in the server, or if you sign out of your server, then you will be able to use local, file-based templates.

Re-Releasing a Schematic Template Item

At any stage, you can come back to any revision of a Schematic Template Item in the server, and edit it directly. Right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the template contained in the revision opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.

Accessing the command to launch direct editing of an existing revision of a Schematic Template Item.

Downloading Released Data

Download the data stored in a revision of a Schematic Template Item by right-clicking on that revision and choosing the Operations » Download command from the context menu. The schematic template 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.