Altium Designer Documentation

Data Management - Templates

Modified by Tiffany Cullen on Apr 21, 2021
All Contents

Parent page: Data Management Preferences

Hover the mouse over the image to alternate between the Templates and Defaults tabs.

Summary

The Data Management – Templates page of the Preferences dialog allows you to specify the default templates used for new projects and documents and allows you to specify the path for the document template directory. This dialog allows you to manage templates from one place.

Separate columns are available between the Templates and Defaults tabs.

Access

This Data Management – Templates dialog is accessed in the following ways:

  • From the Preferences dialog (accessed by clicking the  button in the top right corner of the design space) by selecting the New Document Defaults entry under the System folder then clicking the Go to Templates button and by selecting the Templates entry under the Data Management folder. 
  • From the Explorer panel by selecting a BOM Template and selecting the Open Template Settings link.
When signed in to a connected server, a green icon () appears next to the name of the page in the folder region to denote that the page is under the server's control.

Templates Tab

This tab lists the local file-based/server-based templates and the associated revision ID, description, revision state, and note. Server-based templates and local file-based templates are separated under the <Workspace> and Local columns.

The Template Revision State is not available when connected to an Altium 365 Workspace Subscription Plan.

Options/Controls

  •  -  use the button menu to choose a new template type to be added, or loaded – templates are created and edited in their corresponding document type editor. The button provides different options that are dependent on which tab you are using:

  •  - use the icon to open the selected template in the corresponding document type editor. 

  •  - use the icon to remove the selected template. Templates may be removed in batches through multi-selection. You will be promted to confirm deletion before it is finalized. This option is also available from the right-click context menu.

Right-click Menu

The following options are available when an entry is selected and right-clicked within the Templates tab.

  • Edit - use to open a template in its associated editor. Once editing is complete, you may send the template back to the server by using the Save to Server command. After launching the command, the Create or Edit Revision (When Releasing) dialog will appear. The dialog allows you to add release notes and modify the name and description for the next revision of the item that is being released to the server. If desired, revisions of parent items related to (referencing) the current revision of the item being released can be updated also. Once editing is fully complete and the template has been sent back to the server, it will appear in the Templates tab.
  • Migrate to Server (this option is only available for local file-based templates) - local file-based templates can be migrated to the connected server through this option. Once the migration is complete, the template will be available as a server-based Managed Template of the same name, while the existing local template will be archived as a zip file in its source folder (that shown in the Local Templates Folder field).
  • Upload - use to upload a constituent object into an Item, such as a schematic document into a Managed Schematic or an OutJob file into an Output Job Template from your computer.
  • Set as Default - use to set the selected entry as your default. This will be indicated within the Default column. Once set, the chosen template will reflect My Default in the Default column.
Only schematic and draftsman document templates can be set as default templates.
 Only one default can be chosen at a time. If you'd like to change your default, another template must be chosen and set as default.
  • Operations - use to access a sub-menu of commands including:
    • Clone - use to automatically open a copy of the currently selected template in its associated editor. This copy may be altered and be send back to the server by using the Save to Server command. After launching the command, the Create or Edit Revision (When Releasing) dialog will appear. The dialog allows you to add release notes and modify the name and description for the next revision of the item that is being released to the server. If desired, revisions of parent items related to (referencing) the current revision of the item being released can be updated also. Once fully editing is complete and the template has been sent back to the server, it will appear in the Templates tab.
    • Change state - use to open the Batch State Change dialog to change the state of the currently selected template.
    • Download - use to download the currently selected Item and save it to another location using the Choose destination folder dialog. 
The Download option is only available for server-based templates.
  • Add - use to add a template of your choice. A new template will be reflected as such through exhibiting a Planned revision state and appear greyed-out in the list.
  • Delete - use to delete the selected template. Depending on whether you are deleting a server-based or local file-based template, this command will vary:
    • When deleting a server-based template, you will be asked to confirm the deletion. Once deleted, the template will be moved to the Trash area of your Workspace.
    • When deleting a local file-based template, you will be asked to confirm the deletion. Once deleted, the template will be removed from your Windows system.
  • History - use to access a detailed view for the currently selected template, opened as a new tabbed view within the software. The Item View provides a highly detailed view of the Revision and Lifecycle history of a specific template, as well as showing all of the elements that make up that template. The view also includes a Timeline. Use the Timeline to examine the exact time and date of any change made to the Revision level or Lifecycle State of that template and who made the change.
  • Properties - use to access the View Item dialog in which you can view the properties for the currently selected template. If no revisions for that template have yet been released, the properties can be modified.

Defaults Tab

Use this tab to manage, edit, or remove any of the default templates that have been specified. This tab allows you to contain your desired templates in one location. Local file-based and server-based templates are separated within the Document Type column. Only one local file-based and server-based template may be used as a default at any time. The Template Location column shows the location of the file and server location of each default template.

For a default installation, the Template Location will be: \Users\Public\Documents\Altium\<>\Templates\.

Options/Controls

  • Replace - once an entry is selected, hover over it with your mouse to reveal the Replace link. Click the link to open a trimmed-down version of the Explorer panel, where you may choose a new template from the list to replace the currently selected template.
  •  -  use the button menu to choose a new default template type to be added or loaded. The following templates may be added:
    • From Server - select from the list of server-based templates type you would like to add as your default. A trimmed-down version of the Explorer panel will open, which you can navigate to add the template of your choice. Once added, it will appear in the Defaults tab and replace the previous default template. The new template will also appear in the Templates tab. The server-based template will appear under the <Workspace>row of both the Templates and Defaults tabs.
    • From File - select from the list of local file-based template type you would like to add as your default. A Windows dialog will open, which you can navigate to add the template of your choice. Once added, it will appear in the Defaults tab and replace the previous default template. The new template will also appear in the Templates tab. The local file-based template will appear under the Local row of both the Templates and Defaults tabs.
Only schematic and draftsman document templates can be set as default templates.
 Only one default can be chosen at a time. If you'd like to change your default, another template must be chosen and set as default.
This option is also available from the right-click menu.
  •  - use the icon to revoke the selected template as a default. This template will still appear in the Templates tab.

You will not be prompted to confirm the deletion once this option is selected.
This option is also available from the right-click menu.

Additional Controls

The following controls are available in both the Templates and Defaults tabs.

  • Templates visibility - use the drop-down menu to specify whether to display both local file-based templates and server-based templates or solely server-based templatres in the Templates and Defaults tabs
  • Local Templates Folder - this field is used to find and set the path to the directory that contains your document templates. To change the location, you must be logged out of the server. To set a new path to the directory, click the icon.
  •  - click this icon to refresh either the Templates or Defaults tab to reflect changes.
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?
You are reporting an issue with the following selected text
and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.