Project Options - Parameters

Created: July 23, 2020 | Updated: September 15, 2021 | Applies to version: 3.2

Now reading version 3.2. For the latest, read: Project Options - Parameters for version 4

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.

The Parameter tab of the Project Options dialog.

Summary

This tab of the Project Options dialog enables you to manage parameters defined for the project, often referred to as project-level parameters. Parameters defined at the project level are available for use across all schematic sheets and PCB documents in the project through the use of special strings: =<ProjectParameterName> on a schematic (e.g., =Project) and .<ProjectParameterName> on a PCB (e.g., .Project). Parameters can be used to provide additional design information. Project-level parameters, for example, can be used in global fashion as the source for special string parametric data to be added to schematic sheets and/or the PCB document - the latter of which does not support localized parameters.

Server-side project parameters are saved in the Workspace with the project and can only be edited within the Workspace. By contrast, design-side project parameters are saved in the project file (*.PrjPcb), and can be edited in Altium NEXUS. Server-side project parameters appear in the Parameter tab of the Project Options dialog with a blue icon, while design-side project parameters appear with an orange icon.

When using the project parameter with a schematic template (*.SchDot), place the parameter as a =<ProjectParameterName> special string in the title block of the template.

Altium NEXUS supports parameters at various levels of the project - project-level parameters, document-level parameters (defined for a schematic sheet), and variant-level parameters. They also have a hierarchy, which means you can create a parameter with the same name at different levels of the project, each having different values. Altium NEXUS resolves this with the following order of precedence: Variant (highest priority) ---> Schematic Document ---> Project (lowest priority). That means the parameter value defined in the schematic document overrides the value defined in the project options, and the value defined in the variant overrides the value defined in the schematic document.

Note that schematic-level parameters are not available on the PCB or in the BOM; for these types of documents, you should use project or variant parameters.

For information about linking components to your company database, click here.

Access

This is one of multiple tabs available when configuring the options for a project – accessed from within the Project Options dialog. This dialog is accessed by:

From the PCB or schematic editor click Project » Project Options.
Right-click on the project name on the Projects panel then click Project Options from the context menu.

Options/Controls

Parameters Grid - the main region lists all of the parameters currently defined for the project, in terms of:
- Name - the name of the parameter.
- Value - the value of the parameter.

A parameter can be modified with respect to either of these attributes directly in the grid.

Add - click to open the Parameter Properties dialog, where you may add a parameter and specify the properties of a parameter when attached at the project or variant level.
Remove - click to delete the selected parameter(s) from the list of parameters. This option is unavailable for server-side project parameters due to the fact that they may only be removed or edited in the Workspace.
Edit - click to open the Parameter Properties dialog, where you may modify the contents of the currently selected parameter. This option is unavailable for server-side project parameters due to the fact that they may only be removed or edited in the Workspace.
Refresh - click to revert the last changes made to the design-side project parameter. For server-side project parameters, click to ensure you contain the latest version of the parameter. Changes made to server-side project parameters within the Workspace will not be reflected in this dialog until this option is used.

Right-Click Menu

The following commands are available on the right-click menu:

Edit - use to modify the currently selected parameter in the Parameter Properties dialog.
Add - use to add a new parameter to the list in the Parameter Properties dialog.
Remove - use to delete the selected parameter(s) from the list.
Copy - use to copy the selected parameter(s) to the Windows clipboard.
Paste - use to paste parameter(s) on the Windows clipboard into the parameters list.

The Copy and Paste commands support the ability to define a set of parameters in an external spreadsheet (such as Microsoft Excel) and paste them into the tab. If a parameter being pasted has the same name as an existing parameter in the list, the value for the existing parameter will be overwritten with the one being pasted.

Additional Option

Set To Installation Defaults - click to set all options to the installation defaults.

Printer-friendly version

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.