Creating Schematic Templates in Altium NEXUS

Nexus message

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

 

Parent page: Capturing Your Design Idea as a Schematic

When applied to a schematic sheet, a schematic template defines the size, the graphics (such as title block) and the list of sheet-level parameters of this sheet. You can create your own set of schematic templates to facilitate providing consistent-looking schematics created by you or the entire team.

A number of schematic templates are provided by default in the following locations:

  • in the connected Workspace: within the Managed Content\Templates\SCH Templates Workspace folder (if you opted to include Sample Data upon the activation/installation of your Workspace);
  • locally: within the Templates sub-folder in the Shared Documents folder of your Altium NEXUS installation (C:\Users\Public\Documents\Altium\<PlatformAndVersion> for the default installation).

You can edit these default templates according to your requirements or create new ones as described below.

Creating a New Schematic Template

To create a new schematic template:

  1. Create a new document for defining the template:
    • for a Workspace template: open the Data Management – Templates page of the Preferences dialog, click the Add button and select the Schematic option from the menu;

    • for a local template: select the File » New » Schematic command from the main menus.
  2. Configure options of the design space using the General tab of the Properties panel in its Documents Options mode:

    • in the General region of the panel: select the units and configure the grid options;

    • in the Page Options region of the panel: select Standard or Custom and configure the provided options as required – set sheet size and orientation, enable or disable use of a default title block, and set margin and zones;

       

  3. Define the set of parameters on the Parameters tab of the Properties panel in its Documents Options mode. These parameters will become sheet-level parameters of the schematic sheet to which the template will be applied. Use the controls at the bottom of the panel to add and remove used-defined parameters.

  4. Using drawing objects (Line, Image, etc.), define the look of the schematic template. For example, if you opted to not include a default title block, create a custom title block using these objects.

    You can also use Text String objects to define the static text strings of the template, i.e. the text that will not be changed on a schematic sheet (e.g. Drawn By text).

    An example custom title block created using line and text objects.
    An example custom title block created using line and text objects.

  5. Use Text String objects as Special Strings to define placeholders for design or system information that will be substituted with parameter values when the template is applied to a schematic sheet. Define the Text property of a selected Text String object in the format =<ParameterName>. When applied to a schematic sheet, this Text String will show the value of the parameter with the same name. This can be a sheet-level parameter (predefined or user-defined), a project-level parameter, or a variant-level parameter.

    For example, a Text String with the =DrawnBy text will show the value of the Drawn By parameter (where, for example, the name of the designer is entered) when the template is applied to a schematic sheet.

    Learn more about Special Strings.

    An example custom title block with special strings added. These special strings will be updated with actual parameter values when the template is applied to a schematic sheet.
    An example custom title block with special strings added. These special strings will be updated with actual parameter values when the template is applied to a schematic sheet.

    When creating a schematic sheet template, it is recommended to not use spaces in names of parameters that are used as special strings - when applying such a template to a schematic sheet, and parameters with spaces in their names are not added to the sheet from the templates, an apostrophe character (') or the #NAME? string will be shown on the sheet instead of the actual parameter name.
  6. Save the template:
    • for a Workspace template: select the File » Save to Server command from the main menus. The Edit Revision dialog will appear, in which you can define the Name and Description of the Schematic Template Item being created in the Workspace, and add release notes as required.
    • for a local template: select the File » Save As command from the main menus; in the Save As dialog that appears browse to the local templates folder for your installation of Altium NEXUS (denoted in the Local Templates folder field at the bottom of the Data Management – Templates page of the Preferences dialog; C:\Users\Public\Documents\Altium\<PlatformAndVersion> for the default installation); enter a desired name of the template and select Advanced Schematic template (*.SchDot) from the Save as type drop-down.

The template can now be applied to a schematic sheet using the Template option and drop-down in the Properties panel in its Documents Options mode (active when no object is selected in the design space) when a schematic sheet is the active document.

Note that text and graphical objects defined in the schematic template cannot be selected or edited when the template is applied to a schematic sheet  – these objects become a kind of watermarks.

The only aspect in which an applied template can be changed is updating the placeholder Text Strings set as special strings with the values of the document, project, or variant parameters by changing these values in relevant locations: the Parameters tab of the Properties panel in its Documents Options mode, the Parameters tab of the Project Options dialog, and the Edit Project Variant dialog, respectively.

A schematic template was applied to a schematic sheet. Note that placeholder Special Strings have been updated with parameter values.
A schematic template was applied to a schematic sheet. Note that placeholder Special Strings have been updated with parameter values.

Saving an Existing Local Template to the Workspace

If you have an existing schematic template (*.SchDot), you also have the ability to save this template directly to the Workspace. The process is as follows:

  1. Open the schematic template within Altium NEXUS.
  2. Choose the File » Save to Server command from the main menus.
  3. The Choose Planned Item Revision dialog will appear. Use this to choose the target Schematic Template Item into the next revision (or an established revision in the Planned state) of which the sheet will be saved, then click OK.

    If the target Schematic Template Item doesn't exist, you can create it through the Choose Planned Item Revision dialog on-the-fly by right-clicking in the revision list region of the dialog and selecting the Create Item » Schematic Template command. If doing so, be sure to disable the Open for editing after creation option (in the Create New Item dialog), otherwise you'll enter direct editing mode.
  4. The Edit Revision dialog will appear, in which you can define Name, Description, and add release notes as required.
  5. After clicking OK, the template will be saved and stored in the revision of the Item.

Example of sending an existing schematic template to the Workspace to which you are currently connected.
Example of sending an existing schematic template to the Workspace to which you are currently connected.

If the required schematic template to be saved to the Workspace resides in the Local Template folder (denoted at the bottom of the Data Management – Templates page of the Preferences dialog) and is listed under the Local entry of the template grid, it can be migrated to a new Schematic Template Item by right-clicking on it and selecting the Migrate to Server command. Click the OK button in the Template migration dialog to proceed with the migration process – as stated in this dialog, the original project file will be added to a Zip archive in the local template folder (and hence it will not be visible under the Local template list).
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content