Parent page: Workspace Content Types
Altium Designer, in conjunction with your connected Workspace, caters for the ability to create and manage layerstacks (Layerstack Items) in that Workspace. Such layerstacks can be created:
- Through Direct Editing.
- Through saving of the current stack definition, in the Stackup Editor.
- By uploading the relevant Layer Stackup file (
*.stackup) to a revision of a target layerstack.
Once a layerstack has been created (and data saved/uploaded into a revision of it), it can be reused in future board-level design projects.
In addition, a Layerstack Item can be used as a configuration data item in one or more defined Environment Configurations. An environment configuration is used to constrain a designer's working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center – a service provided through the Workspace, and the facilitator of this concept of Environment Configuration Management. For more information, see Environment Configuration Management (Altium 365 Workspace, Enterprise Server Workspace).
In addition, a Layerstack Item can be used as a configuration data item in one or more defined Environment Configurations. An environment configuration is used to constrain a designer's Altium NEXUS working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center – a service provided through the Workspace, and the facilitator of this concept of Environment Configuration Management. For more information, see Environment Configuration Management (for an Altium 365 Workspace or a NEXUS Server Workspace).
Folder Type
When creating the folder in which to store a layerstack, you can specify the folder's type. This has no bearing on the content of the folder – saving a layer stackup will always result in a Layerstack 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 layerstacks, set its Folder Type as Layerstacks, 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.
Item Naming Scheme
Another important aspect of the parent folder is the Item Naming Scheme employed for it. This defines the format of the unique ID for each Item created in that particular folder. Several default example schemes are available, utilizing the short-form code for either the folder type (ALS – Altium Layerstacks) or the content type (ALS – Altium Layer Stack):
$CONTENT_TYPE_CODE-001-{0000} – for example, ALS-001-0001.$CONTENT_TYPE_CODE-001-{A00} – for example, ALS-001-A01.$FOLDER_TYPE_CODE-001-{0000} – for example, ALS-001-0001.$FOLDER_TYPE_CODE-001-{A000} – for example, ALS-001-A001.
Using a default naming scheme, the software will automatically assign the next available unique ID, based on that scheme, having scanned the entire Workspace and identifiers of existing content. This can be a great time-saver when manually creating layerstacks.
A custom scheme can also be defined for a folder, simply by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. STACK-001-{0000}).
The Item Naming Scheme of the parent folder is applied to the Unique ID for each Item created within that folder.
The Item Naming Scheme employed for the parent folder can be changed at any time. The modified scheme will then be applied to any subsequent newly-created content within that folder.
Content Type
When creating the target Layerstack Item in which to store your layer stack definition, ensure that its Content Type is set to Layerstack, in the Create New Item dialog. If you are creating the Item in a Layerstacks type folder, this content type will be available from the right-click context menu when creating the Item.
Creating a layerstack within a Layerstacks folder – the correct Content Type is available on the context menu.
Item Lifecycle Definition and Revision Naming
Related pages: Defining Revision Naming Schemes for a Workspace, Defining Lifecycle Definitions for a Workspace
When defining the Layerstack Item, in whose revisions layer stack data is saved, be sure to specify the type of lifecycle management to be used for the layerstack, and the naming scheme employed for its revisions, respectively.
Control over which content types can use a particular lifecycle definition or revision naming scheme, can be defined and enabled at a global level from within the Content Types dialog, when defining each schema. The default schemes assigned for use by a layerstack are: Generic Lifecycle and 1-Level Revision Scheme, respectively.
Once a layer stack definition has been saved into the initial revision of a Layerstack Item, these schemes cannot be changed for that particular Item.
Specify the required schemes in the Create New Item dialog, using the Lifecycle Definition and Revision Naming Scheme fields respectively.
If the option to control use of lifecycle definitions and revision naming schemes per content type is enabled for any definitions/schemes, and the Layerstack content type is not set to use a particular definition/scheme, then that definition/scheme will not be available in the applicable drop-down list.
Selecting the Lifecycle Definition and Revision Naming schemes for a manually created layerstack.
Observing standard revision naming schemes and lifecycle definitions, across the various types of design content in a Workspace ensures smooth, consistent management of this content.
It is a good idea to add a Name and Description as part of the layerstack's definition. This information is used when searching the Workspace and enables quick identification of what a layerstack offers.
Saving a Layer Stack Definition
Related page: Creating and Editing Content Directly through a Workspace
So far, we've discussed the support for a layerstack in the Workspace, in terms of related folder and content types. Saving an actual layer stack definition into the revision of a Layerstack Item can be performed in a couple of ways.
Direct Editing
A layer stackup definition can be edited and saved into the initial revision of a newly-created Layerstack 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 Layerstack Item, you have the option to edit and save a layer stackup definition 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 Stackup Editor will open, presenting a .stackup 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>.stackup (e.g. ALS-0005-1.stackup).
Example of editing the initial revision of a layerstack, directly from the Workspace – the temporary Stackup Editor provides the layer stackup document with which to define your layer stack.
Use the document to define the layer stackup as required. For more information, see Defining the Layer Stack.
There are three relevant controls when direct editing, readily available from the Quick Access Bar (at the top-left of the main application window):
-
– Save Active Document. Use this button to locally 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 saving to the Workspace.
-
/
– Save to Workspace. Use this button to save the defined layer stack document to the Workspace, storing it within the initial (planned) revision of the target Layerstack 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 save. The layer stack document, *.stackup, will be stored in the revision of the Item.
A
Save to Server control is also conveniently provided to the right of the layerstack'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 document and editor will close, and nothing will be saved to the target Layerstack 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 the layerstack's entry in the Projects panel.
The saved data stored in the Workspace consists of the layer stackup definition, defined in the Layer Stackup file (*.stackup). In the Explorer panel, switch to the Preview aspect view tab to see the layer stackup.
Browse the saved revision of the layerstack, back in the Explorer panel. Switch to the Preview aspect view tab to see the layer stackup information.
A new layerstack can also be created using the
Layerstack command from the menu of the
Add button or the context menu of the template grid on the
Templates tab of the
Data Management – Templates page of the
Preferences dialog. After selecting the command, click
OK in the
Close Preferences dialog that opens to close the
Preferences dialog and open the temporary Stackup Editor. A planned revision of the new layerstack will be created automatically in a Workspace folder of the
Layerstacks type.
Saving the Current Layer Stack
You can also save the current layer stackup defined for the active board design, to your Workspace, directly from within the Stackup Editor (from within the PCB, Design » Layer Stack Manager). To do so, choose the File » Save to Server command from the main menus. The Choose Planned Item Revision dialog will appear – use this to choose the next planned revision of an existing Layerstack Item, or create a new Layerstack Item on-the-fly.
If creating a new Layerstack Item, be sure to disable the Open for editing after creation option (in the Create New Item dialog), otherwise you'll enter direct editing mode.
After clicking OK, the Edit Revision dialog will appear, in which you can change Name, Description, and add release notes as required. Click OK when ready – the saving will proceed, with the resulting layer stackup definition, stored in the revision of the target Layerstack Item, available for preview through the Explorer panel.
Saving the layer stackup currently defined for the active board design, to a planned revision of a target Layerstack Item in the connected Workspace.
Uploading a Stackup File
A new revision of a Layerstack Item can be created by uploading a Layer Stackup file (*.stackup). This can be performed in a couple of ways - see Uploading Data into a New Revision of an Item for more information.
A Layer Stackup file can also be uploaded using the Upload command from the context menu of the selected layerstack on the Templates tab of the Data Management – Templates page of the Preferences dialog. Use the Open dialog (a standard Windows open-type dialog) that opens to browse to, and open, the required file that will be uploaded into the next revision of the Layerstack Item.
You can also create a new layerstack template using the Load from File command from the menu of the Add button or the Add context menu of the template grid on the Templates tab of the Data Management – Templates page of the Preferences dialog. In the Open dialog (a standard Windows open-type dialog) that opens, select the Layer Stack-up File (*.stackup) option in the drop-down at the right of the File name field and use the dialog to browse to, and open, the required file that will be uploaded into the initial revision of the new Layerstack Item created automatically in a Workspace folder of the Layerstacks type.
If the required layerstack file resides in the Local Template folder (denoted at the bottom of the Data Management – Templates page) and is listed under the Local entry of the template grid, it can be migrated to a new Layerstack 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 layerstack 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).
Reusing a Layerstack
Related page: Controlling Access to Workspace Content
Once a layer stackup 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 layer stackup can be reused in future board-level design projects.
When you are connected to your Workspace, you are free to manually choose a revision of a layerstack. To do so, choose the File » Load Stackup From Server command from the main menus. The Choose Item Revision dialog will appear (essentially an incarnation of the Explorer panel) – use this to load layer stackup data from a revision of a target Layerstack Item in the Workspace.
Accessing the command to load a desired revision of a Layerstack Item into the Stackup Editor.
If you do not connect to your Workspace you can still work with Altium Designer (under your valid Altium Designer license), but you will not be able to access your organization's Workspace, or any other services it provides. You will therefore not be able to reuse any Workspace-based layerstacks. You will
only be able to use file-based stackup definitions defined locally, and available from the templates folder specified on the
Data Management – Templates page of the
Preferences dialog (if the
Template visibility option is set to
Server & Local on this page).
The File » Load Stackup From File command will also remain available, should you need to use a local stackup file.
A saved layer stackup definition can also be used as a configuration data item in one or more defined
Environment Configurations. An environment configuration is used to constrain a designer's working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center – a service provided through the Workspace. Once you have connected to the Workspace, and chosen (if applicable) from the selection of environment configurations available to you, Altium Designer will be configured, with respect to use of Layerstacks. If the chosen environment configuration has one or more defined Layerstack Item revisions, then
only those will be available to you for reuse. If the chosen environment configuration applicable to you does not have any layerstack revisions specified/added, or is set to
Do Not Control, then all available saved item revisions (shared with you) will be available. You are also free to use local stackup files. For more information, see
Environment Configuration Management (
Altium 365 Workspace,
Enterprise Server Workspace).
A saved layer stackup definition can also be used as a configuration data item in one or more defined
Environment Configurations. An environment configuration is used to constrain a designer's Altium NEXUS working environment to only use company-ratified design elements. Environment configurations are defined and stored within the Team Configuration Center – a service provided through the Workspace. Once you have connected to the Workspace, and chosen (if applicable) from the selection of environment configurations available to you, Altium NEXUS will be configured, with respect to use of Layerstacks. If the chosen environment configuration has one or more defined Layerstack Item revisions, then
only those will be available to you for reuse. If the chosen environment configuration applicable to you does not have any layerstack revisions specified/added, or is set to
Do Not Control, then all available saved item revisions (shared with you) will be available. You are also free to use local stackup files. For more information, see
Environment Configuration Management (for an
Altium 365 Workspace or a
NEXUS Server Workspace).
Re-Saving a Layerstack
At any stage, you can come back to any revision of a layerstack in the Workspace, 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 layer stackup definition contained in the revision opened for editing. Make changes as required, then save the document into the next revision of the layerstack.
Right-clicking on the top-level entry for a layerstack itself, will edit the latest revision of that layerstack.
Accessing the command to launch direct editing of an existing layerstack revision.
A layerstack can also be edited using the
Edit command from the context menu of the layerstack's entry on the
Templates tab of the
Data Management – Templates page of the
Preferences dialog. After selecting the command, click
OK in the
Close Preferences dialog that opens to close the
Preferences dialog and open the temporary Stackup Editor.
Updating a Layerstack
If you need to change the layer stackup stored in a Layerstack Item, and you have the updated Layer Stackup file, you can upload that file to that Item – the new file will be stored in the next revision of that Item.
Downloading a Layer Stackup File
Downloading the Layer Stackup file stored in a revision of a layerstack can be performed from the Explorer panel in the following ways:
-
By right-clicking on that revision and choosing the Operations » Download command from the context menu. The 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.
Access the Download command from the top-level entry for a layerstack itself, to download the Layer Stackup file stored in the latest revision of that layerstack.
Click the Explore button in the Download from Server dialog, to quickly explore to the download folder.
- By selecting the file for the layerstack revision, on its Details aspect view tab, right-clicking, and choosing the Download command from the context menu. Nominate the target folder to receive the file, in the subsequent Choose destination folder dialog.
Opening a Layer Stackup File
To open a Layer Stackup file that is stored in a revision of a Layerstack Item, select that file – on the Details aspect view tab for the revision – then right-click and choose the Open command from the context menu. The file will be opened within Altium Designer.
Soft Deletion
When connected to a Workspace, flexible functionality is available for removing a layerstack directly from within Altium Designer:
- From the Explorer panel – right-click on the layerstack's entry in the panel and choose the Delete Item command from the context menu.
- From the Templates tab of the Data Management – Templates page of the Preferences dialog – right-click on the template's entry in the dialog and choose 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 layerstack 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.
With the soft-delete facility, you are able to delete a layerstack that is currently being used.
Multiple layerstacks can be deleted in a single action. Select all required layerstacks using standard multi-select controls (Shift+Click, Ctrl+Click), then right-click and choose the deletion command from the context menu.
Soft deletion of a layerstack. The layerstack will be moved to the Workspace's Trash area.
To proceed with the deletion, click the 
button. The layerstack 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.
All 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 layerstack:
- The layerstack will not be available from your design software, or from within the Web interface.
- Anywhere the layerstack was being used will reflect that the layerstack has been deleted.
- A layerstack 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.
Note that if you have soft deleted a layerstack – moving it to the Trash – you can create a new layerstack with that same name again. If you were to subsequently restore the original layerstack, and the original name is taken, an integer suffix will be used, to keep its name unique within the Workspace.
