Parent page: Altium Concord Pro
Altium design software, in conjunction with Altium Concord Pro, brings support for Managed Projects. Managed projects target the development stage of the project lifecycle, simplifying the creation and ongoing workflow for version controlled projects. Centralized storage under the control of Concord Pro also enables this feature to be a foundation for other collaborative services.
Some key benefits to using managed projects are:
- Simplified storage. No need to make decisions about storage locations. Backup and other basic services are taken care of.
- Foundation for collaborative features.
- Enforced version control.
- Beneficiary of a dedicated commenting system.
- Notifications and status. Document status including local modifications is visible to entire design teams.
- Concurrent PCB design works without any complex setup.
Technically a managed project is the combination of meta information stored on the server, along with tight integration with Altium Concord Pro's local Version Control service. The typical work flow is as follows:
- A user creates a new managed project (via the Create Project dialog in Altium Designer, from within Concord Pro's browser interface, or by making an existing unmanaged project available on Concord Pro (from Altium Designer)). During creation, that user defines the project's name, description, and design repository.
- In Concord Pro's browser interface, or directly within Altium Designer, access to the project is defined and managed.
- All collaborators select the project for opening (either from within Altium Designer, or from Concord Pro's browser interface) after which it is automatically checked out.
Creating a New Managed Project
There are three ways in which a managed project can be created:
- Creation of a new project within Altium Designer.
- Creation of a new project within Altium Concord Pro's browser interface.
- Making an existing, unmanaged project available to Altium Concord Pro, from within Altium Designer.
The following sections take a closer look at these three avenues of creation.
Through Altium Designer
A new managed project can be created from within Altium Designer using the Create Project dialog (File » New » Project):
Setting up the Create Project dialog to create a new managed project from within Altium Designer.
- In the Locations list, select the entry for your Concord Pro server (it will appear with the name you have specified for it, on the Admin - General page of Concord Pro's browser interface) – you must be signed in to Concord Pro to see this option in the listing.
- In the Project Type list, choose the type of project you wish to create, and choosing from the applicable templates available as required. If you have project templates created and released into your Concord Pro installation, these will appear listed as the only available templates from which to choose.
- Enter a Project Name and optionally, a project Description.
- Use the Folder field to specify where the folder for the project – within Concord Pro's folder structure – is to be created. The default path for new Concord Pro projects is specified on the Admin - Settings - Projects page of Concord Pro's browser interface (by default, this will be
Projects\<ProjectName>). Click the button to browse to and select a different server folder, if required.
- Use the Local Storage field to specify where the project will be stored on your hard drive, prior to its committal to the centralized design repository. The default location is defined in the System - Default Locations page of the Preferences dialog. Click the button to browse to and select a different folder location, if required. This is the 'working' folder for the project and the local Git repository it is committed to. The project is ultimately, or at the time of committal, Pushed to the centralized design repository in Altium Concord Pro (Versioned Storage), which is the remote Git repository.
- Use the Parameters list area to add or remove custom Name/Value parameter pairs that are associated with the project and saved in the server. Use the button to add a new parameter Name-Value pairing to the list. These managed project parameters are saved in the Concord Pro server with the new project, and can be edited within the server. By contrast, Project type parameters are saved in the project file (
*.PrjPcb), and can be edited in Altium Designer. Both parameter types may be used as Special Strings in Altium Designer - access from the Properties panel with a placed Text String selected in the design workspace. Parameters defined for the project can also be viewed on the Parameters and Server Parameters tabs of the Project Options dialog (Project » Project Options).
With the project defined as required, click the button. The new project structure will be created in the specified local and server folders. The project will be opened in the Projects panel, which will show the project and its constituent documents as being Scheduled for addition, denoted by blue cross icons ().
Right-click on the project in the Projects panel and choose either the Save to Server command, Commit Project command, or the Version Control » Commit Whole Project command. You will be presented with the Commit to Version Control dialog. Select the files you wish to commit to Concord Pro's Versioned Storage design repository and click the button. Once added, the Projects panel will reflect the fully synchronized state that exists between the files in the remote design repository (in Altium Concord Pro) and the local (working copy) repository - as indicated by the associated icons.
Commit and push the newly created project to the Versioned Storage design repository in Altium Concord Pro.
In addition, an entry for the project will appear on the Projects page of Concord Pro's browser interface.
The newly-created project, evident on the Projects page of Altium Concord Pro's browser interface.
Commit Without Push
For those unfamiliar with Git repositories, or for those just wanting to get their local design changes into Altium Concord Pro, using the button in the Commit to Version Control dialog is the cleanest and most streamlined approach.
However you also have the option to Commit to your local Git repository, ahead of pushing changes to the remote Git repository (Versioned Storage) in Altium Concord Pro. To do so, select the Commit command as above, and in the Commit to Version Control dialog choose the Commit option from the button drop-down menu. The changes will be saved to the local Git repository for that project, and the state of the files – as reflected in the Projects panel – will become Ahead of server ().
Example of committing a new project to the local Git repository.
These locally saved changes can be sent to the remote Git repository in Concord Pro at a later time by executing a Push command. This can be performed in a couple of ways:
- Right-click on the project entry in the Projects panel and choose the Commit Project command from the context menu, or choose the File » Commit Project command from the main menus. In the Commit to Version Control dialog, click the button. This will just push those files ahead of the server, and commit and push those that are not.
- Right-click on the project entry in the Projects panel (or on a specific file) and choose the Version Control » Push(n) command from the context menu - where n reflects the number of local commits that have been made (ahead of the server).
Once pushed, the Projects panel will reflect the fully synchronized state () that exists between the files in the remote repository (in Concord Pro) and the local (working copy) repository.
Through Concord Pro's Browser Interface
A managed project can be created directly from the Projects page of Altium Concord Pro's browser interface. The page lists all projects that have been made available to Concord Pro, and which are shared with the currently signed-in user. To create a new project, click the button above the project list to open the Project creation window.
Creating a new managed project through Altium Concord Pro's browser interface.
The Project creation window will initially present in simplified view. Choose a project template if available - the Templates drop-down will list all Managed Project Templates that exist in Concord Pro. Choosing a template will also define the project type. Then enter a Name and (optionally) a Description for the project.
Click the button to access more controls. The following fields will present:
- Vault Folder - use this field to specify where the folder for the project is to be created within Concord Pro's folder structure. By default, this will be Projects\<ProjectName>. The default folder path for new projects is specified on the Admin - Settings - Projects page of Concord Pro's browser interface.
- Project Type - use this field to specify the type of project from a list of all project types supported by Altium Designer. If you have selected a managed project template to use, this field will not be presented.
- Repository - this field will display Versioned Storage, the Git-based design repository available as part of Concord Pro, in which all new projects (and their files) are stored.
After defining the new project as required, click to create the new project structure. You will come back to the summary-level project list, where you will now see an entry for the newly-created project.
The newly-created project, evident back on the Projects page of Altium Concord Pro's browser interface.
Making an Existing UnManaged Project Available on Server
You can also create a managed project from an existing unmanaged one by essentially converting the former to the latter, and porting it to Altium Concord Pro. To do this, open the existing unmanaged project as normal in Altium Designer, then right-click on its entry in the Projects panel, and select Make Project Available on Server from the context menu, giving access to the Make Available On Server dialog.
Make an existing, regular project available as a managed project on the Altium Concord Pro server.
Use the Make Available On Server dialog to change the Project Name and add a Description. By default, the name will be that of the original project.
Click the Advanced link at the bottom to expose the Folder field. This field is used to specify where the folder for the project - within Concord Pro's folder structure - is to be created. The default path for new Concord Pro projects is specified on the Admin - Settings - Projects page of Concord Pro's browser interface (by default, this will be
Projects\<ProjectName>). Click the button to browse to and select a different server folder, if required.
With the properties for the managed project defined as required in the Make Available On Server dialog, click OK. The project and files will be committed and pushed to Concord Pro's Versioned Storage design repository, with the Projects panel reflecting the fully synchronized state that exists between that remote design repository and the local (working copy) repository - as indicated by the associated icons.
The newly-created and ported managed project will subsequently be available from the Projects page of Concord Pro's browser interface.
The converted and ported project is added to the list of centrally-managed projects.
Working with GitHub
Using the GitHub platform as an external version control system (VCS) is a popular way to host and share design projects, and is easily integrated with Concord Pro through Altium Designer. The existing external VCS arrangement is synchronized with Concord Pro which allows you to benefit from its advanced data management and collaboration features.
How you normally work with GitHub itself will vary depending on company practices or simply the Git tools you have at hand. In general however, a design project is created in a local Git repository and then Pushed to a GitHub (remote) repository, or an existing project is Cloned to a local repository from GitHub. Once in the local Git repository, the project can be opened in Altium Designer and made available to Concord Pro (Make Project Available on Server), as outlined above.
While there is a range of data transfer protocols offered by the Git VCS, Altium Designer currently supports the HTTP/HTTPS protocol only for connections between a local Git repository and its remote master repository. In practice, the applied protocol is set by the URL prefix specified for the remote repository connection –
git://<remote repository>, and so on.
GitHub supports both the SSH and HTTPS protocols, and recommends using HTTPS URLs for connections.
► See Which remote URL should I use? on GitHub for more information.
If your external VCS system is bound to a protocol other than HTTPS, such as a GitHub SSH connection, this will be preset in a repository that has been cloned from the remote. As this protocol is incompatible with Altium Designer, an error will be thrown when attempting to integrate the project with Concord Pro. If you are unsure of the remote URL protocol that is used for a local Git repository, this can be checked using the
git remote - v command.
Use the Git Bash command line interface to check a repository's remote URL setting.
The repository can be reconfigured for a different URL, such as the HTTPS protocol to enable compatibility with Altium Designer, by using the
git remote set-url <name> <URL> command, where the URL's prefix specifies the protocol type.
Changing the remote repository connection URL protocol and then confirming with the remote command.
Browsing Managed Projects
The projects listing on the Projects page of Altium Concord Pro's browser interface includes all projects that are shared with you, and offers a range of controls to access project management features. Use the button to switch the page to its project preview (graphical tiles) mode and the button to switch the page to its detailed list mode.
The Projects page of Concord Pro's browser interface - command central for working with your managed projects. Here, the detailed list mode for the page is shown. Hover the mouse over the image to see the project preview mode.
Each project entry in the detailed list mode includes the following information:
- Name - the name of the project.
- Author - the user who created the project.
- Kind - the type of project, which is typically PCB (PcbProject) or Multi-board (SystemDesign).
- Last Modified - the user who last modified the project. A
System entry occurs when an automated Concord Pro background process has changed the project, typically by adding computed information (such as a Preview or PCB statistics).
- Date - the date on which the project was last modified.
In the project preview mode, the tile for a managed project includes the name of the project and the last modified date. The tile also autopopulates with the 3D view of the project's PCB, where a PCB is available.
Example tile for a selected managed project when
the Projects page is set in its project preview mode.
For both project view modes (detailed list and preview) the following controls are provided (and detailed in the linked sections that follow). They act on the currently selected project in the list:
Share - click to access the Manage Permissions window, with all the controls necessary to share the project with other users.
Open - click to open the CAD-centric Projects Management view for the project. This will open on a separate tab of the browser.
Edit - click to access the Edit Project window. From here, you can change the project's Name, Description and server Parameters. All other fields are non-editable, providing information only.
More - select to access further options:
- Clone - choose this command to access the Clone Project window, providing the controls to make an identical copy of the project.
- Watch - choose this command to follow the project. You will receive applicable notifications related to the project (e.g. updated, released, permission changes) on the main Home and Stream pages of the browser interface. The creator of the project will automatically be set to watch that project.
- UnWatch - choose this command to stop following the project and cease reception of notifications for events relating to that project.
- Delete - choose this command to remove the project from Concord Pro's design repository, rendering it no longer managed. Does not affect the local working copy.
Also included is a project Search feature that can filter the project listing by a range of properties such as Name, Author and Description etc. Type any part of a search string in the field at the top of the browser interface. The list will update to include only those project entries whose attributes include the search string.
Example use of the search feature, in this case finding a project based on its Description.
The right hand pane on Concord Pro's Projects page shows detailed property information for the currently selected project.
Access more detailed information for the currently selected project in the Properties pane.
The property data that is available in the Properties pane has been extracted or generated by Concord Pro from the currently selected project. Each project data type is arranged under the following expandable headings (with example imagery to illustrate):
- General Info - high level information and current data about the project.
- Description - the description text added when the project was created. This can be modified through the project Edit feature.
- Releases - project releases presented in terms of the assembled packages (including assembly data, fabrication data for the linked/parent bare board, and source files from which both have been generated). Multiple releases are shown in sequential order, with the most recent at the top.
- Additional Info - a comprehensive collection of detailed data extracted or computed from the project design itself.
- Preview - generated thumbnail images of the project PCB 2D and 3D views, and the top-level schematic in the project structure hierarchy.
Sharing a Managed Project
Once a project is managed, you'll want to determine which users can actually access that project. This is done by sharing the project, or rather, by configuring its access permissions. Remember that a managed project - newly created or made available on the server - is shared, by default, with the following:
- The Owner of the project, which is usually the designer who created it (or made it available on the server): with full (Read/Write) access permissions.
- The Administrators role: with full (Read/Write) access permissions.
- Anyone - denoted by the presence of the Anyone entity: with Read-only access permissions.
Configuration of access permissions can be performed through Concord Pro's browser interface, and also directly from within Altium Designer.
From within the Server's Browser Interface
To configure access permissions for a project from Concord Pro's browser interface, select the project entry on the Projects page of the interface and click the Share button ().
The Manage Permissions window will appear, with all the controls necessary to share the project with other users.
With projects centrally managed in a Concord Pro server, sharing with others is simply a case of managing each project's permissions.
Things to be aware of:
- In terms of permissions, a User or Role (Group) has Read/Write access when the Can Write option is enabled. If this option is disabled, they have Read access only.
- To remove an existing user/group from having shared access to a project, click the associated Remove control (x).
- All users of the Concord Pro server will by default be able to see the project. If you want to lock access down to a specific set of users and/or group roles, you must remove the Anyone entity.
- If you remove the Anyone entity, it can be added back again using the Add Anyone control. Be aware that doing so will, by default, grant Read/Write access of the project to all Concord Pro users.
From within Altium Designer
Access for a project can be configured directly from within Altium Designer through the Share dialog - accessed by clicking the button at the top-right of the main application window. Alternatively, use the Share command, which can be accessed for the active project, or a focused project:
- Active project - with a source document for the project open as the active document, choose the Project » Share command from the main menus.
- Focused project - access is made from the Projects panel by right-clicking on the entry for the required project and choosing the Share command from the context menu.
Accessing the Share dialog - command central for sharing a design from within Altium Designer.
The following levels of sharing are supported from within Altium Designer:
- Sharing of an actual design - the live (or WIP) design itself, which can be shared only with other members of your team.
- Sharing of a design 'snapshot' - a static snapshot of the design at a particular point in time and shared:
- By link - available to anyone through a Web browser. Sharing at this level requires neither active subscription for your Altium Designer licensing, nor registration with AltiumLive. A recipient of the shared link uses Altium 365 Viewer to view (but not comment) on the design. Viewing requires no registration with AltiumLive and the link is available for 48 hours.
- With specific people - available to specified people through email invite. Sharing at this level requires registration with AltiumLive, but does not require active subscription for your Altium Designer licensing. A recipient accesses the design snapshot through the Altium 365 Platform Interface from their email invitation. Viewing requires registration with AltiumLive, but the snapshot is available permanently. Commenting of the design is also available.
Accessing the Detailed Projects Management Page
Main page: Management of a Specific Project
Altium Concord Pro provides an advanced, manufacturing orientated CAD-centric view of the project, opened by selecting the required project and clicking the control above the listing of projects, or by double-clicking directly on the required project entry in the list. The Projects Management page for that project opens in a new browser tab incorporating the CAD-centric interface, which offers Design, Manufacturing and BOM view options:
- Design - display and navigate source project design documents, view design object properties and place review comments. This view uses the Web Review interface. This view is for the latest version of the source project data, rather than a specified release from that project, and so could be considered to be a work-in-progress (WIP) view.
- Manufacturing - view the releases for the project. Access is provided for opening a release, which will be presented on a separate tab through a Manufacturing Portal. From this portal you can view and navigate the released Assembly and Fabrication data, inspect the BOM, and ultimately download the data into a manufacturing Build Package.
- BOM - view the source project's Bill Of Materials information.
Accessing the CAD-centric Projects Management page for a project. Here, the Design, Manufacturing and BOM views of the interface are shown. The Manufacturing view provides further access to a Manufacturing Portal, from which a manufacturing Build Package can be downloaded.
Opening a Managed Project in Altium Designer
To work on a managed project, you effectively check it out as a local working copy. This is performed directly from within Altium Designer using the File » Open Project command. The Open Project dialog will appear, from where you can choose which managed project to open from your Altium Concord Pro instance (when signed in to Concord Pro, the server will appear in the Locations region of the dialog, and appear with the name given to the server). Only those managed projects that have been shared with you (you have permission to access) will be listed, and from across all managed design repositories shared with you.
Once opened, the project will appear under an entry for your Concord Pro server, in the Projects panel.
Choose which managed project to open, from within Altium Designer, from those currently shared with you.
Editing a Managed Project
To edit the existing properties of a project in Altium Concord Pro, select its entry on the Projects page and then click the button. In the following Edit Project window you can change the project's Name, Description and manage server Parameter entries. Parameter Name/Value pairs my be added (), edited, or removed ().
You can edit the Name, Description and Parameters for a managed project at any stage.
Click the Show additional fields control to expose other project fields, which are non-editable and provide information only.
Additional, read-only fields provide information on where the project can be found within Concord Pro's server
folder structure, it's type, and in which design repository it is stored.
Click the button to confirm any changes you have made.
Cloning a Managed Project
To clone an existing managed project, select its entry on the Projects page, click the button, then choose the Clone command from the associated menu. The Clone Project window will appear.
You can clone a managed project to create an identical copy of it, along with its working files.
Use the window to set the naming, description and storage paths for the cloned project. By default, the original project name will be used with the suffix ' - Copy'.
After setting the fields as required, click the button. The original project will be cloned (duplicated) along with its constituent files and data, and be added as a new project entry to the Projects page listing.
Cloning a Managed Project in Altium Designer
To clone a managed project from within Altium Designer, right-click on the entry for the project in the Projects panel and choose the Clone command from the context menu. Use the Clone Project dialog to determine the Project Name, Description (which is not pre-populated), the Folder path (within Concord Pro), and the Local Storage path (to the working copy).
Clone a managed project from within Altium Designer.
Deleting a Managed Project
To delete (remove) an existing managed project from the Altium Concord Pro server, select its entry on the Projects page, click the button, then choose the Delete command from the associated menu. Click the button in the following Confirmation window to proceed with the removal.
Removing a managed project from Altium Concord Pro.
Note that when you have removed a project its host Folder and Project Item will remain in Concord Pro's folder structure, as can be viewed on the Explorer page of the browser interface. If you wish to use that project name again you will need to remove the project Item and its host folder (via the right-click context menus), in that order.
To be able to reuse a project name again, you must delete the project item for the project you have just deleted, followed by its folder.