Saving Projects and Documents in Altium Designer

Saving a Document

The currently active document can be saved locally by:

  • Choosing the File » Save command, from the main menus.
  • Clicking the button on the Quick Access Bar.
  • Clicking the button on the editor's main toolbar.
  • Using the Ctrl+S keyboard shortcut.

The currently focused document in the Projects panel (if the document is actually open) can also be saved by right-clicking on its entry in the panel and choosing the Save command, from the context menu.

The currently focused item (document, project, or project group) in the Projects panel can be saved by clicking the button at the top of the Projects panel. When the focused item is a project, only the project document is saved. The constituent design documents are not saved by this command. When the focused item is the design project group, only the design Project Group document is saved (*.DsnWrk). The constituent projects and their design documents are not saved by this command.

A document in a modified state can also be saved by using the corresponding command from its document tab - right-click on the tab to access a context menu of commands. Note that this command will not be available if multiple documents of the same type are open and currently grouped.

For schematic documents, if the current file format is not Binary Version 5.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in SCH Binary Version 5.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.

For PCB documents, if the current file format is not Binary Version 6.0, the File Format dialog will appear, from where you can choose the format in which to save. It is recommended to choose the option to save in PCB Binary Version 6.0. If you have used features that were not available in previous versions of Altium Designer, saving in an earlier format may result in loss of data.

For a document that is a part of a Workspace project, the Save command will save the changes locally, i.e. only your local working copy of the document file will be saved. After saving changes locally, the project's VCS status will be changed to Modified, and the document's VCS status icon will be changed to . To make the changes available in the connected Workspace, the project must be saved to this Workspace - learn more.

An open project document can be saved under a new name using the File » Save As command or the Save As command from the right-click menu of the document entry in the Projects panel, which creates a copy of the document file under the nominated new name. This process automatically adds (links) the new document copy to the active project in place of the existing (source) document, which remains intact in the source folder. If the open document is not part of a project – a free document – the new copy is simply opened in the editor in place of the original document.

After launching the command, the standard Windows Save As dialog appears. Use this dialog to browse to a particular destination in which to save the file, give the file a new name (if required) and also to select the format in which to store the file (where available). The newly saved file will be opened in place of the original file as the active document.

Note that files stored in the same folder as the project file itself (or in a child/grandchild folder) are linked to the project using relative referencing, whereas files stored in a different location are linked using absolute referencing.

The parent project must be saved in order to point to the copy of the document the next time the project is opened, otherwise the project will include the original document still.

If the intention is just to make a backup copy of a document, use the Save Copy As option. This creates a named copy of the document file without affecting its host project. After launching the command, the standard Windows Save A Copy Of dialog appears. Use this dialog to browse to a particular destination in which to save the file, give the file a new name (if required) and also to select the format in which to store the file (where available). The newly saved file will not be opened in place of the original file.

If the intention is to rename a document, see the Document Renaming section.

All projects and documents that have been modified can be saved locally by:

  • Choosing the File » Save All command, from an editor's main menus.
  • Clicking the button on the Quick Access Bar.
  • Right-clicking on the entry for the design project group in the Projects panel, and choosing the Save All command, from the context menu.

If the projects are part of an existing (previously saved) Project Group, and project membership has changed (projects added or removed since last save), then the Project Group document (*.DsnWrk) will also be saved.

To save all documents that are currently open within the focused category (sub-folder) in the Projects panel or descendant folders thereof, right-click on the entry for the required category (sub-folder) and choose the Save All command, from the context menu.

Saving a Project

When you perform a change on an open project's structure or options, it becomes modified. A modified project is distinguished by an asterisk next to its entry and the  status icon in the Projects panel. To save the changes of a project document file, right-click the project entry in the Projects panel and select the Save command. The focused project in the panel can be saved by clicking the  control at the top of the panel.

For a Workspace project, the Save command will save the changes locally, i.e. only your local working copy of the project document file will be saved. After saving changes locally, the project's VCS status will be changed to Modified, and the project's VCS status icon will be changed to . To make the changes available in the connected Workspace, the project must be saved to this Workspace. To do this, use one of the following ways:

  • Click the Save to Server control next to the project entry.

    The Save to Server control is available when the UI.SaveToServerPromotion option is enabled in the Advanced Settings dialog.

  • Right-click on the project entry and select Save to Server from the context menu.

  • Click the Modified status icon () next to the project entry and select Commit Project.

This saves the project's source design documents that have been modified but not yet saved locally and opens the Save to Server dialog, in which you can select the documents to be saved to the Workspace. By default, all modified documents are selected in the dialog when accessed as described above.

After clicking OK, the documents are saved to the Workspace, and the Save to Server link disappears from the Projects panel.

  • The Save to Server dialog can also be accessed by clicking the Modified VCS status icon () next to the entry of the Workspace project's document and selecting Save to Server. Note that in this case, only that document will be selected by default in the dialog.
  • When attempting to use the Save to Server command when the project contains files in the Conflict Prevention state, with the  VCS icon in the Projects panel, the Action Required information dialog will be presented, listing the conflicting file(s) that need resolution. Such files will have the Conflict Detected state with the  VCS icon. Use the VCS content menu of a document in the Conflict Detected state to resolve the conflict by updating the document with its latest revision from the Workspace or by using the local document (or, for a PCB document, by comparing and merging changes using the PCB CoDesign functionality).

  • If the target Workspace in which the focused Workspace project resides is not currently connected, Altium Designer will connect to this Workspace automatically.
You can discard local modifications for a project document by right-clicking on the entry for the document entry and selecting the History & Version Control » Revert Local Modifications command from the right-click menu. You can also discard local modifications for the project file in a similar way or by selecting the Project » History & Version Control » Revert Local Modifications command from the main menus. All local modifications to the project document will be lost, and the file will be reverted back to its base revision (the last revision of the file checked out/updated to the working folder). The status of a file that has been reverted depends on its previous status (for example, a file showing as Modified will revert back to No modification).
  • When a user can only view a project, the Save to Server link next to the project file and the Save to Server command from the project entry's right-click menu will not be available.
  • The fully qualified file name of a project document must be less than 260 characters, and the directory name must be less than 248 characters. You can configure your Windows OS and Altium Designer to support long path names. Refer to the Support for Long Path Names page to learn more.
  • While you can add existing project-relevant documents to your Altium 365 Workspace projects, note that there is a limitation for zip, 7z and rar files larger than 256 MB. Projects containing such files cannot be saved to the Workspace – you will receive a Git Error. Refer to the How to fix project data after Git Error with status code 471 Knowledge Base article to learn how to fix this issue.
To save a copy of the project, with a new name (if required), and to a specified location on the hard disk, use the File » Save Project As command from the main menus or right-click on its entry in the Projects panel and choose the Save Project As command from the context menu. After launching the command, the standard Windows Save As dialog appears. Use this dialog to browse to a particular destination in which to save the project file, and give the file a new name (if required). The newly saved project will be opened in place of the original project.

Saving when Closing a Project

If you close a project and that project has two or more modified documents that have not yet been saved, the Confirm Save for Modified Documents dialog will open. Use this dialog to decide what to do with those documents.

The dialog will also appear when attempting to close Altium Designer and there are at least two open, modified design documents across multiple projects that have not yet been saved.

Use the Confirm Save for Modified Documents dialog to decide how to handle unsaved documents when closing one or more projects or Altium Designer itself.Use the Confirm Save for Modified Documents dialog to decide how to handle unsaved documents when closing one or more projects or Altium Designer itself.

The main area of the dialog lists all open and modified documents (by name and path to the local copy) for which you need to make a decision about whether or not to save. Documents are grouped by type (e.g., PCB Documents, PCB Projects, Schematic Documents, BOM Documents and so on).

The possible decisions are listed below. Which decisions are actually presented for a document will depend on whether that document is local or Workspace-based and, if the latter, whether or not that document has also been saved locally already.

 - this decision is available for a local document or for a Workspace document that has not already been saved locally. In the case of the latter, it allows you to save the document locally without committing changes to the connected Workspace.

 - this decision is available for a local document or for a Workspace document that has not already been saved locally. Any changes to the document will be discarded.

 - this decision is available for a Workspace document, irrespective of whether it has already been saved locally or not. Changes to the document will be saved locally (where applicable) and to the connected Workspace.

 - this decision is available for a Workspace document when it has already been saved locally. Since there is nothing to save locally, nothing will be done with this document.

Note that if a modified document is open from a Workspace and that Workspace is not the active Workspace, then the decision to Save to Server will not be available. Such a document can only be saved locally (if applicable).

The following buttons are available at the bottom of the dialog to quickly make decisions en-masse:

 - use this button to quickly set decisions for each document in a 'save locally' way. For a local document or Workspace document that has not already been save locally, its decision will be set to Save. For a Workspace document that has already been save locally, its decision will be set to Do nothing.

 - use this button to quickly set decisions for each document in a 'save none' way. For a local document or Workspace document that has not already been save locally, its decision will be set to Don't Save. For a Workspace document that has already been save locally, its decision will be set to Do nothing.

 - use this button to quickly set decisions for each document in a 'save fully' way. For a local document its decision will be set to Save. For a Workspace document its decision will be set to Save to Server.

Use standard Ctrl+click and Shift+click techniques to select multiple entries, then make a decision from the right-click context menu to apply to all in the selection. The actual decision applied will be in accordance with whether the document is local/Workspace-based, as described previously. Note that multiple selection only works across documents in the same grouped category.

Auto Save Backups

Developing an electronic product in an environment like Altium Designer results in a large number of electronic files. These files are valuable since they are your company's IP (Intellectual Property) and must be stored and maintained in an appropriate way. Altium Designer includes a number of features to ensure that your files remain safe, are backed up, and older versions can be retrieved if necessary.

Altium Designer includes the capability to automatically save multiple versions of all open files at the specified time interval. Configured in the Data Management – Backup page of the Preferences dialog, the Auto Save feature saves a copy of all currently open files that have been modified (in the Projects panel, this is indicated by an asterisk after the filename) into the specified location and at the specified time interval. Up to 10 versions of each file can be saved in the location specified by the Path entry in the Preferences dialog.

This feature is intended for disaster recovery, for example, if the power fails and your PC shuts down unexpectedly. AutoSave files are identified by the addition of .~(X) into their filename, for example, the file MySchematic.SchDoc is auto saved as MySchematic.~(1).SchDoc, then MySchematic.~(2).SchDoc, etc. Note that once the specified number of versions have been saved, the filenames are re-used. That means that the file's timestamp should be used to identify the latest file, rather than the number within the brackets in the filename.

Autosave files can also be included in the Local History by enabling the Add autosaved documents to history option in the Data Management – Local History page of the Preferences dialog. When this option is enabled the file is saved in both locations when an autosave event occurs. The copy saved to the local history has a date and timestamp included in the filename and is saved in the compressed ZIP format used by the Local History feature. Refer to the Local History section of the Storage Manager Panel page to learn more about the Local History feature.

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

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Content